create status page #176

nelsonic · nelsonic · commit e89a6bb1cb69 · 2022-02-03T21:14:42.000Z
diff --git a/Dockerfile b/Dockerfile
@@ -30,6 +30,10 @@ RUN mix local.hex --force && \
 
 # set build ENV
 ENV MIX_ENV="prod"
+
+# copy the .env_sample file to read environment variable keys:
+COPY .env_sample ./
+
 ENV AUTH_API_KEY=$AUTH_API_KEY
 # install mix dependencies
 COPY mix.exs mix.lock ./
diff --git a/README.md b/README.md
@@ -275,6 +275,41 @@ Phoenix has a built-in mechanism for sessions:
 
 This project _uses_ and _extends_ it to support several 3rd party auth services.
 
+<br /><br />
+
+### Troubleshooting
+
+If you see the following error error 
+when visiting the status (_or any other page_):
+http://localhost:4000/status
+![image](https://user-images.githubusercontent.com/194400/152191803-e7127118-7107-40aa-aaa7-a4618726b689.png)
+
+You forgot to create and export the 
+`SECRET_KEY_BASE`
+environment variable.
+
+Create a [secret](https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Secret.html)
+by running the following command in your terminal:
+
+```sh
+mix phx.gen.secret
+```
+
+Copy the output and export it, e.g:
+
+```sh
+export SECRET_KEY_BASE=mAfe8fGd3CgpiwKCnnulAhO2RjcSxuFlw6BGjBhRJCYo2Mthtmu/cdIvO3Mz1QU8
+```
+
+Where the long string 
+is whatever was generated above.
+Once the 
+`SECRET_KEY_BASE`
+environment variable is exported
+and you restart the app,
+it should work as expected.
+
+
 
 ## Background Reading
 
diff --git a/assets/static/images/false.png b/assets/static/images/false.png
diff --git a/assets/static/images/true.png b/assets/static/images/true.png
diff --git a/lib/auth/init/init.ex b/lib/auth/init/init.ex
@@ -23,7 +23,6 @@ defmodule Auth.Init do
 
   def main do
     Logger.info("Initialising the Auth Database ...")
-    Auth.Application.start(:type, :args)
     # check required environment variables:
     Envar.is_set_all?(~w/ADMIN_EMAIL AUTH_URL ENCRYPTION_KEYS SECRET_KEY_BASE/)
 
diff --git a/lib/auth/release.ex b/lib/auth/release.ex
@@ -11,17 +11,6 @@ defmodule Auth.Release do
     for repo <- repos() do
       {:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :up, all: true))
     end
-
-    # Run Seeds in Prod: https://github.com/dwyl/auth/issues/172#issuecomment-1005194147
-    IO.inspect(File.cwd!(), label: "cwd")
-    # IO.inspect(File.ls!(File.cwd!()), label: "File.ls!(cwd)")
-    # IO.inspect(__ENV__.file, label: "__ENV__.file")
-    
-    IO.puts(" - - - - - - - - - - - - - - - - - - - - - - - ")
-    IO.inspect("attempting to run Auth.Init.main() ... ")
-    Auth.Init.main()
-
-    IO.puts(" - - - - - - - - - - - - - - - - - - - - - - - ")
   end
 
   def rollback(repo, version) do
diff --git a/lib/auth_web/controllers/status_controller.ex b/lib/auth_web/controllers/status_controller.ex
@@ -0,0 +1,18 @@
+defmodule AuthWeb.StatusController do
+  use AuthWeb, :controller
+
+  def index(conn, _params) do
+    conn
+    # |> assign(:env, check_env())
+    |> render(:index,
+      layout: {AuthWeb.StatusView, "status_layout.html"}, 
+      env: check_env()
+      )
+  end
+
+  defp check_env() do
+    Enum.reduce(Envar.keys(".env_sample"), %{}, fn key, acc ->
+      Map.put(acc, key, Envar.is_set?(key))
+    end)
+  end
+end
diff --git a/lib/auth_web/router.ex b/lib/auth_web/router.ex
@@ -30,6 +30,7 @@ defmodule AuthWeb.Router do
     post "/auth/password/verify", AuthController, :password_prompt
     # https://github.com/dwyl/ping
     get "/ping", PingController, :ping
+    get "/status", StatusController, :index
   end
 
   pipeline :auth do
diff --git a/lib/auth_web/templates/status/index.html.eex b/lib/auth_web/templates/status/index.html.eex
@@ -0,0 +1,20 @@
+<h1 class="tc">Status</h1>
+
+<table class="w-80 mw5 mw7-ns center">
+  <thead>
+    <tr class="bb b--silver">
+      <th class="tl pv3 f3">Environment Variable</th>
+      <th class="tl pv3 f3">Defined?</th>
+    </tr>
+  </thead>
+  <tbody>
+    
+<%= for {key, value} <- @env do %>
+  <tr class="bb b--moon-gray">
+    <td class=""><pre class="mono"><%= key %></pre></td>
+    <td class="center pl4"><img width="40px" src="/images/<%=value%>.png"></td>
+  </tr>
+<% end %>
+  </tbody>
+</table>
+
diff --git a/lib/auth_web/templates/status/status_layout.html.eex b/lib/auth_web/templates/status/status_layout.html.eex
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8"/>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+    <title><%= assigns[:page_title] || "Auth App" %></title>
+    <%= csrf_meta_tag() %>
+    <link rel="stylesheet" href="<%= Routes.static_path(@conn, "/assets/app.css") %>"/>
+    <link rel="stylesheet" href="https://unpkg.com/tachyons@4.12.0/css/tachyons.min.css"/>
+  </head>
+  <body class="w-100 helvetica dark-gray">
+    <main role="main" class="container pt1">
+      <p class="alert alert-info f4 mh3"
+        role="alert"><%= get_flash(@conn, :info) %></p>
+      <p class="alert alert-danger" role="alert"><%= get_flash(@conn, :error) %></p>
+      <%= @inner_content %>
+    </main>
+    <script type="text/javascript" src="<%= Routes.static_path(@conn, "/assets/app.js") %>"></script>
+  </body>
+</html>
diff --git a/lib/auth_web/views/status_view.ex b/lib/auth_web/views/status_view.ex
@@ -0,0 +1,3 @@
+defmodule AuthWeb.StatusView do
+  use AuthWeb, :view
+end
diff --git a/mix.exs b/mix.exs
@@ -71,7 +71,7 @@ defmodule Auth.Mixfile do
       {:elixir_auth_google, "~> 1.6.2"},
 
       # Check/get Environment Variables: https://github.com/dwyl/envar
-      {:envar, "~> 1.0.4"},
+      {:envar, "~> 1.0.5"},
 
       # https://github.com/dwyl/auth_plug
       {:auth_plug, "~> 1.4.11"},
diff --git a/mix.lock b/mix.lock
@@ -20,7 +20,7 @@
   "elixir_auth_github": {:hex, :elixir_auth_github, "1.6.0", "f100dd3917b2395219d533e5a834eb450abff3e0a53eab36632d53335e1beb92", [:mix], [{:httpoison, "~> 1.8.0", [hex: :httpoison, repo: "hexpm", optional: false]}, {:jason, "~> 1.2", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "abc700b484bc5dfd4d6a2aa2acbbe79a7fd8ce112ca28d2c864ede169790ab1f"},
   "elixir_auth_google": {:hex, :elixir_auth_google, "1.6.2", "bef167fc8b32d3e30bf39217a40508af538f5f1cca987239e3a67f4efa74d7a3", [:mix], [{:httpoison, "~> 1.8.0", [hex: :httpoison, repo: "hexpm", optional: false]}, {:jason, "~> 1.2", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "deafaf9ca84bd900ab55a192c0cd0ca2301107c7cbcc9c35a0c89083bb7d2ef4"},
   "elixir_make": {:hex, :elixir_make, "0.6.3", "bc07d53221216838d79e03a8019d0839786703129599e9619f4ab74c8c096eac", [:mix], [], "hexpm", "f5cbd651c5678bcaabdbb7857658ee106b12509cd976c2c2fca99688e1daf716"},
-  "envar": {:hex, :envar, "1.0.4", "3264a6b13d5f9bca9a16e82ed2311c0efd08f3371d3c6b42dc5abe9d01da59aa", [:mix], [], "hexpm", "d7856849080745b907e39b33b825448810bc2348e3f5982ee32f8007d9b3226e"},
+  "envar": {:hex, :envar, "1.0.5", "64ed87d6ccd6b4a73d9c4907bd84b6e8073c253bab138ead20a64362675c5c11", [:mix], [], "hexpm", "79408fed523c9f7ba9508529047fd464498d09050454e8b092a0233ee2d02a7e"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "esbuild": {:hex, :esbuild, "0.4.0", "9f17db148aead4cf1e6e6a584214357287a93407b5fb51a031f122b61385d4c2", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}], "hexpm", "b61e4e6b92ffe45e4ee4755a22de6211a67c67987dc02afb35a425a0add1d447"},
   "ex_doc": {:hex, :ex_doc, "0.25.5", "ac3c5425a80b4b7c4dfecdf51fa9c23a44877124dd8ca34ee45ff608b1c6deb9", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "688cfa538cdc146bc4291607764a7f1fcfa4cce8009ecd62de03b27197528350"},

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+defmodule AuthWeb.StatusView do`
	`2`	`+ use AuthWeb, :view`
	`3`	`+end`