PR: Migrate from heroku to fly.io issue #45

.dockerignore

@@ -0,0 +1,45 @@
+# This file excludes paths from the Docker build context.
+#
+# By default, Docker's build context includes all files (and folders) in the
+# current directory. Even if a file isn't copied into the container it is still sent to
+# the Docker daemon.
+#
+# There are multiple reasons to exclude files from the build context:
+#
+# 1. Prevent nested folders from being copied into the container (ex: exclude
+#    /assets/node_modules when copying /assets)
+# 2. Reduce the size of the build context and improve build time (ex. /build, /deps, /doc)
+# 3. Avoid sending files containing sensitive information
+#
+# More information on using .dockerignore is available here:
+# https://docs.docker.com/engine/reference/builder/#dockerignore-file
+
+.dockerignore
+
+# Ignore git, but keep git HEAD and refs to access current commit hash if needed:
+#
+# $ cat .git/HEAD | awk '{print ".git/"$2}' | xargs cat
+# d0b8727759e1e0e7aa3d41707d12376e373d5ecc
+.git
+!.git/HEAD
+!.git/refs
+
+# Common development/test artifacts
+/cover/
+/doc/
+/test/
+/tmp/
+.elixir_ls
+
+# Mix artifacts
+/_build/
+/deps/
+*.ez
+
+# Generated on crash by the VM
+erl_crash.dump
+
+# Static artifacts - These should be fetched and built inside the Docker image
+/assets/node_modules/
+/priv/static/assets/
+/priv/static/cache_manifest.json

.github/workflows/ci.yml

@@ -33,3 +33,19 @@ jobs:
         AUTH_API_KEY: 2PzB7PPnpuLsbWmWtXpGyI+kfSQSQ1zUW2Atz/+8PdZuSEJzHgzGnJWV35nTKRwx/authdev.herokuapp.com
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1
+
+  # Continuous Deployment to Fly.io
+  # https://fly.io/docs/app-guides/continuous-deployment-with-github-actions/
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    needs: build
+    # https://stackoverflow.com/questions/58139406/only-run-job-on-specific-branch-with-github-actions
+    if: github.ref == 'refs/heads/main'
+    env:
+      FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: superfly/flyctl-actions@1.1
+        with:
+          args: "deploy"

Dockerfile

@@ -0,0 +1,90 @@
+# Find eligible builder and runner images on Docker Hub. We use Ubuntu/Debian instead of
+# Alpine to avoid DNS resolution issues in production.
+#
+# https://hub.docker.com/r/hexpm/elixir/tags?page=1&name=ubuntu
+# https://hub.docker.com/_/ubuntu?tab=tags
+#
+#
+# This file is based on these images:
+#
+#   - https://hub.docker.com/r/hexpm/elixir/tags - for the build image
+#   - https://hub.docker.com/_/debian?tab=tags&page=1&name=bullseye-20220801-slim - for the release image
+#   - https://pkgs.org/ - resource for finding needed packages
+#   - Ex: hexpm/elixir:1.14.1-erlang-25.1.1-debian-bullseye-20220801-slim
+#
+ARG ELIXIR_VERSION=1.14.1
+ARG OTP_VERSION=25.1.1
+ARG DEBIAN_VERSION=bullseye-20220801-slim
+
+ARG BUILDER_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
+ARG RUNNER_IMAGE="debian:${DEBIAN_VERSION}"
+
+FROM ${BUILDER_IMAGE} as builder
+
+# install build dependencies
+RUN apt-get update -y && apt-get install -y build-essential git \
+    && apt-get clean && rm -f /var/lib/apt/lists/*_*
+
+# prepare build dir
+WORKDIR /app
+
+# install hex + rebar
+RUN mix local.hex --force && \
+    mix local.rebar --force
+
+# set build ENV
+ENV MIX_ENV="prod"
+
+# install mix dependencies
+COPY mix.exs mix.lock ./
+RUN mix deps.get --only $MIX_ENV
+RUN mkdir config
+
+# copy compile-time config files before we compile dependencies
+# to ensure any relevant config change will trigger the dependencies
+# to be re-compiled.
+COPY config/config.exs config/${MIX_ENV}.exs config/
+RUN mix deps.compile
+
+COPY priv priv
+
+COPY lib lib
+
+# Compile the release
+RUN mix compile
+
+# Changes to config/runtime.exs don't require recompiling the code
+COPY config/runtime.exs config/
+
+COPY rel rel
+RUN mix release
+
+# start a new build stage so that the final image will only contain
+# the compiled release and other runtime necessities
+FROM ${RUNNER_IMAGE}
+
+RUN apt-get update -y && apt-get install -y libstdc++6 openssl libncurses5 locales \
+  && apt-get clean && rm -f /var/lib/apt/lists/*_*
+
+# Set the locale
+RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && locale-gen
+
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+WORKDIR "/app"
+RUN chown nobody /app
+
+# set runner ENV
+ENV MIX_ENV="prod"
+
+# Only copy the final release from the build stage
+COPY --from=builder --chown=nobody:root /app/_build/${MIX_ENV}/rel/app ./
+
+USER nobody
+
+CMD ["/app/bin/server"]
+# Appended by flyctl
+ENV ECTO_IPV6 true
+ENV ERL_AFLAGS "-proto_dist inet6_tcp"

README.md

@@ -12,8 +12,8 @@ in your Phoenix App!
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dwyl/auth_plug_example/Elixir%20CI?label=build&style=flat-square)
 [![codecov.io](https://img.shields.io/codecov/c/github/dwyl/auth_plug_example/master.svg?style=flat-square)](http://codecov.io/github/dwyl/auth_plug_example?branch=master)
 [![Hex.pm](https://img.shields.io/hexpm/v/auth_plug?color=brightgreen&style=flat-square)](https://hex.pm/packages/auth_plug)
-[![Libraries.io dependency status](https://img.shields.io/librariesio/release/hex/auth_plug?logoColor=brightgreen&style=flat-square)](https://github.com/dwyl/auth_plug/blob/master/mix.exs)
 [![HitCount](http://hits.dwyl.com/dwyl/auth_plug_example.svg)](http://hits.dwyl.com/dwyl/auth_plug_example)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/auth_plug/issues)
 </div>
 <br />
 
@@ -33,12 +33,16 @@ and showcase a protected route.
 
 Before you attempt to use the **`auth_plug`**,
 try the Heroku example version so you know what to expect:
-https://auth-plug-example.herokuapp.com/admin
-![wake-sleeping-heroku-app](http://auth-plug-example.herokuapp.com/ping)
+https://auth-plug.fly.dev/admin
 
 You will be redirected to:
 
-![auth_plug_example](https://user-images.githubusercontent.com/194400/80765920-154eb600-8b3c-11ea-90d4-a64224d31a5b.png)
+![auth_demo](https://user-images.githubusercontent.com/194400/202489883-16d727f4-8f18-4fba-9e27-00ea01329482.png)
+
+Once you have logged in, you will be redirected back:
+
+
+![auth_plug_example-logged-in](https://user-images.githubusercontent.com/194400/202489177-47c53d17-d4e4-44eb-a923-c64e14ad214c.png)
 
 
 
@@ -56,9 +60,10 @@ to add Auth to _any_ app in less than 2 minutes!
 
 ### 1. Create New Phoenix App
 
-```
+```sh
 mix phx.new app --no-ecto --no-webpack
 ```
+
 When asked if you want to `Fetch and install dependencies? [Yn]`
 Type <kbd>Y</kbd> followed by the <kbd>Enter</kbd> key.
 
@@ -84,7 +89,7 @@ and locate the `defp deps do` section.
 Add the line:
 
 ```
-{:auth_plug, "~> 1.2.1"}
+{:auth_plug, "~> 1.4"}
 ```
 
 > E.g:
@@ -105,7 +110,7 @@ Open the `lib/app_web/router.ex` file and locate the section:
 Immediately below this add the following lines of code:
 
 ```elixir
-  pipeline :auth, do: plug(AuthPlug, %{auth_url: "https://dwylauth.herokuapp.com"})
+  pipeline :auth, do: plug(AuthPlug)
 
   scope "/", AppWeb do
     pipe_through :browser
@@ -183,11 +188,12 @@ And paste the following code into it:
 
 ### 6. Get and Set the `AUTH_API_KEY` Environment Variable
 
-Visit: https://dwylauth.herokuapp.com
+Visit: 
+[authdemo.fly.dev](https://authdemo.fly.dev/apps/new)
 and create a New App:
 
 
-![dwyl-auth-app-api-key-setup](https://user-images.githubusercontent.com/194400/93143513-0712c800-f6e0-11ea-9020-c253805d66df.gif)
+![dwyl-auth-app-api-key-setup](https://user-images.githubusercontent.com/194400/202491060-6c2d015b-1313-4f94-8a8c-cdb52bd8aa5f.png)
 
 
 Save the key as an environment variable named `AUTH_API_KEY`.
@@ -211,7 +217,7 @@ Now open your web browser to: http://localhost:4000/admin
 
 Given that you are not yet authenticated,
 your request will be redirected to
-https://dwylauth.herokuapp.com/?referer=http://localhost:4000/admin&auth_client_id=etc
+https://authdemo.fly.dev/?referer=http://localhost:4000/admin&auth_client_id=etc
 
 Once you have successfully authenticated with your GitHub or Google account,
 you will be redirected back to `localhost:4000/admin`

config/config.exs

@@ -5,7 +5,7 @@
 # is restricted to this project.
 
 # General application configuration
-use Mix.Config
+import Mix.Config
 
 # Configures the endpoint
 config :app, AppWeb.Endpoint,
@@ -29,4 +29,4 @@ config :phoenix, :json_library, Jason
 import_config "#{Mix.env()}.exs"
 
 config :auth_plug,
-  api_key: System.get_env("AUTH_API_KEY")
+  api_key: System.get_env("AUTH_API_KEY")

config/dev.exs

@@ -1,4 +1,4 @@
-use Mix.Config
+import Mix.Config
 
 # For development, we disable any cache and enable
 # debugging and code reloading.

config/prod.exs

@@ -1,4 +1,4 @@
-use Mix.Config
+import Mix.Config
 
 # For production, don't forget to configure the url host
 # to something meaningful, Phoenix uses this information

config/prod.secret.exs

@@ -2,7 +2,7 @@
 # from environment variables. You can also hardcode secrets,
 # although such is generally not recommended and you have to
 # remember to add this file to your .gitignore.
-use Mix.Config
+import Mix.Config
 
 secret_key_base =
   System.get_env("SECRET_KEY_BASE") ||

config/runtime.exs

@@ -0,0 +1,58 @@
+import Config
+
+# config/runtime.exs is executed for all environments, including
+# during releases. It is executed after compilation and before the
+# system starts, so it is typically used to load production configuration
+# and secrets from environment variables or elsewhere. Do not define
+# any compile-time configuration in here, as it won't be applied.
+# The block below contains prod specific runtime configuration.
+
+# ## Using releases
+#
+# If you use `mix release`, you need to explicitly enable the server
+# by passing the PHX_SERVER=true when you start it:
+#
+#     PHX_SERVER=true bin/app start
+#
+# Alternatively, you can use `mix phx.gen.release` to generate a `bin/server`
+# script that automatically sets the env var above.
+if System.get_env("PHX_SERVER") do
+  config :app, AppWeb.Endpoint, server: true
+end
+
+if config_env() == :prod do
+
+  maybe_ipv6 = if System.get_env("ECTO_IPV6"), do: [:inet6], else: []
+
+  config :app, App.Repo,
+    # ssl: true,
+    pool_size: String.to_integer(System.get_env("POOL_SIZE") || "10"),
+    socket_options: maybe_ipv6
+
+  # The secret key base is used to sign/encrypt cookies and other secrets.
+  # A default value is used in config/dev.exs and config/test.exs but you
+  # want to use a different value for prod and you most likely don't want
+  # to check this value into version control, so we use an environment
+  # variable instead.
+  secret_key_base =
+    System.get_env("SECRET_KEY_BASE") ||
+      raise """
+      environment variable SECRET_KEY_BASE is missing.
+      You can generate one by calling: mix phx.gen.secret
+      """
+
+  host = System.get_env("PHX_HOST") || "example.com"
+  port = String.to_integer(System.get_env("PORT") || "4000")
+
+  config :app, AppWeb.Endpoint,
+    url: [host: host, port: 443, scheme: "https"],
+    http: [
+      # Enable IPv6 and bind on all interfaces.
+      # Set it to  {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
+      # See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html
+      # for details about using IPv6 vs IPv4 and loopback vs public addresses.
+      ip: {0, 0, 0, 0, 0, 0, 0, 0},
+      port: port
+    ],
+    secret_key_base: secret_key_base
+end

config/test.exs

@@ -1,4 +1,4 @@
-use Mix.Config
+import Mix.Config
 
 # We don't run a server during test. If one is required,
 # you can enable the server option below.
@@ -10,4 +10,4 @@ config :app, AppWeb.Endpoint,
 config :logger, level: :warn
 
 config :auth_plug,
-  httpoison_mock: true
+  httpoison_mock: true

coveralls.json

@@ -7,6 +7,7 @@
     "lib/app.ex",
     "lib/app_web.ex",
     "lib/app/application.ex",
-    "lib/app_web/views/error_helpers.ex"
+    "lib/app_web/views/error_helpers.ex",
+    "lib/app_web/channels/user_socket.ex"
   ]
 }