generate confirmation liveview

lib/mix/tasks/phx.gen.auth.ex

@@ -238,11 +238,6 @@ defmodule Mix.Tasks.Phx.Gen.Auth do
           {:eex, "schema_token.ex", Path.join([context.dir, "#{schema.singular}_token.ex"])},
           {:eex, "auth.ex", Path.join([web_prefix, web_path, "#{schema.singular}_auth.ex"])},
           {:eex, "auth_test.exs", Path.join([web_test_prefix, web_path, "#{schema.singular}_auth_test.exs"])},
-          {:eex, "confirmation_view.ex", Path.join([web_prefix, "views", web_path, "#{schema.singular}_confirmation_view.ex"])},
-          {:eex, "confirmation_new.html.heex", Path.join([web_prefix, "templates", web_path, "#{schema.singular}_confirmation", "new.html.heex"])},
-          {:eex, "confirmation_edit.html.heex", Path.join([web_prefix, "templates", web_path, "#{schema.singular}_confirmation", "edit.html.heex"])},
-          {:eex, "confirmation_controller.ex", Path.join([web_prefix, "controllers", web_path, "#{schema.singular}_confirmation_controller.ex"])},
-          {:eex, "confirmation_controller_test.exs", Path.join([web_test_prefix, "controllers", web_path, "#{schema.singular}_confirmation_controller_test.exs"])},
           {:eex, "session_view.ex", Path.join([web_prefix, "views", web_path, "#{schema.singular}_session_view.ex"])},
           {:eex, "session_controller.ex", Path.join([web_prefix, "controllers", web_path, "#{schema.singular}_session_controller.ex"])},
           {:eex, "session_controller_test.exs", Path.join([web_test_prefix, "controllers", web_path, "#{schema.singular}_session_controller_test.exs"])},
@@ -256,7 +251,9 @@ defmodule Mix.Tasks.Phx.Gen.Auth do
           {:eex, "reset_password_live.ex", Path.join([web_prefix, "live", web_path, "#{schema.singular}_reset_password_live.ex"])},
           {:eex, "reset_password_live_test.exs", Path.join([web_test_prefix, "live", web_path, "#{schema.singular}_reset_password_live_test.exs"])},
           {:eex, "settings_live.ex", Path.join([web_prefix, "live", web_path, "#{schema.singular}_settings_live.ex"])},
-          {:eex, "settings_live_test.exs", Path.join([web_test_prefix, "live", web_path, "#{schema.singular}_settings_live_test.exs"])}
+          {:eex, "settings_live_test.exs", Path.join([web_test_prefix, "live", web_path, "#{schema.singular}_settings_live_test.exs"])},
+          {:eex, "confirmation_live.ex", Path.join([web_prefix, "live", web_path, "#{schema.singular}_confirmation_live.ex"])},
+          {:eex, "confirmation_live_test.exs", Path.join([web_test_prefix, "live", web_path, "#{schema.singular}_confirmation_live_test.exs"])}
         ]
       _ ->
         [

priv/templates/phx.gen.auth/confirmation_live.ex

@@ -0,0 +1,102 @@
+defmodule <%= inspect context.web_module %>.<%= inspect Module.concat(schema.web_namespace, schema.alias) %>ConfirmationLive do
+  use <%= inspect context.web_module %>, :live_view
+
+  alias <%= inspect context.module %>
+
+  on_mount {<%= inspect auth_module %>, :mount_current_<%= schema.singular %>}
+
+  def render(%{live_action: :new} = assigns) do
+    ~H"""
+    <h1>Resend confirmation instructions</h1>
+
+    <.form id="resend_confirmation_form" let={f} for={:<%= schema.singular %>} phx-submit="send_instructions">
+      <%%= label f, :email %>
+      <%%= email_input f, :email, required: true %>
+
+      <div>
+        <%%= submit "Resend confirmation instructions" %>
+      </div>
+    </.form>
+
+    <p>
+      <.link href={Routes.<%= schema.route_helper %>_registration_path(@socket, :new)}>Register</.link> |
+      <.link href={Routes.<%= schema.route_helper %>_login_path(@socket, :new)}>Log in</.link>
+    </p>
+    """
+  end
+
+  def render(%{live_action: :edit} = assigns) do
+    ~H"""
+    <h1>Confirm account</h1>
+
+    <.form id="confirmation_form" let={_f} for={:<%= schema.singular %>} phx-submit="confirm_account"}>
+      <div>
+        <%%= submit "Confirm my account" %>
+      </div>
+    </.form>
+
+    <p>
+      <.link href={Routes.<%= schema.route_helper %>_registration_path(@socket, :new)}>Register</.link> |
+      <.link href={Routes.<%= schema.route_helper %>_login_path(@socket, :new)}>Log in</.link>
+    </p>
+    """
+  end
+
+  def mount(_params, _session, socket) do
+    {:ok, socket}
+  end
+
+  def handle_params(%{"token" => token}, _uri, socket),
+    do: {:noreply, assign(socket, :token, token)}
+
+  def handle_params(_params, _uri, socket), do: {:noreply, socket}
+
+  # Do not log in the <%= schema.singular %> after confirmation to avoid a
+  # leaked token giving the <%= schema.singular %> access to the account.
+  def handle_event("confirm_account", _params, socket) do
+    socket =
+      case Accounts.confirm_<%= schema.singular %>(socket.assigns.token) do
+        {:ok, _} ->
+          socket
+          |> put_flash(:info, "User confirmed successfully.")
+          |> redirect(to: "/")
+
+        :error ->
+          # If there is a current <%= schema.singular %> and the account was already confirmed,
+          # then odds are that the confirmation link was already visited, either
+          # by some automation or by the <%= schema.singular %> themselves, so we redirect without
+          # a warning message.
+          case socket.assigns do
+            %{current_<%= schema.singular %>: %{confirmed_at: confirmed_at}} when not is_nil(confirmed_at) ->
+              redirect(socket, to: "/")
+
+            %{} ->
+              socket
+              |> put_flash(:error, "User confirmation link is invalid or it has expired.")
+              |> redirect(to: "/")
+          end
+      end
+
+    {:noreply, socket}
+  end
+
+  def handle_event("send_instructions", %{"<%= schema.singular %>" => %{"email" => email}}, socket) do
+    if <%= schema.singular %> = <%= inspect context.alias %>.get_<%= schema.singular %>_by_email(email) do
+      <%= inspect context.alias %>.deliver_<%= schema.singular %>_confirmation_instructions(
+        <%= schema.singular %>,
+        &Routes.<%= schema.route_helper %>_confirmation_url(socket, :edit, &1)
+      )
+    end
+
+    socket =
+      socket
+      |> put_flash(
+        :info,
+        "If your email is in our system and it has not been confirmed yet, " <>
+          "you will receive an email with instructions shortly."
+      )
+      |> redirect(to: "/")
+
+    {:noreply, socket}
+  end
+end

priv/templates/phx.gen.auth/confirmation_live_test.exs

@@ -0,0 +1,129 @@
+defmodule <%= inspect context.web_module %>.<%= inspect Module.concat(schema.web_namespace, schema.alias) %>ConfirmationLiveTest do
+  use <%= inspect context.web_module %>.ConnCase
+
+  import Phoenix.LiveViewTest
+  import <%= inspect context.module %>Fixtures
+
+  alias <%= inspect context.module %>
+  alias <%= inspect schema.repo %>
+
+  setup do
+    %{<%= schema.singular %>: <%= schema.singular %>_fixture()}
+  end
+
+  describe "Confirm <%= schema.singular %>" do
+    test "renders confirmation page", %{conn: conn} do
+      {:ok, _lv, html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :edit, "some-token"))
+      assert html =~ "<h1>Confirm account</h1>"
+    end
+
+    test "confirms the given token once", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
+      token =
+        extract_<%= schema.singular %>_token(fn url ->
+          <%= inspect context.alias %>.deliver_<%= schema.singular %>_confirmation_instructions(<%= schema.singular %>, url)
+        end)
+
+      {:ok, lv, _html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :edit, token))
+
+      result =
+        lv
+        |> form("#confirmation_form")
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert {:ok, conn} = result
+      assert get_flash(conn, :info) =~ "User confirmed successfully"
+      assert <%= inspect context.alias %>.get_<%= schema.singular %>!(<%= schema.singular %>.id).confirmed_at
+      refute get_session(conn, :<%= schema.singular %>_token)
+      assert Repo.all(<%= inspect context.alias %>.<%= inspect schema.alias %>Token) == []
+
+      # when not logged in
+      {:ok, lv, _html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :edit, token))
+
+      result =
+        lv
+        |> form("#confirmation_form")
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert {:ok, conn} = result
+      assert get_flash(conn, :error) =~ "User confirmation link is invalid or it has expired"
+
+      # when logged in
+      {:ok, lv, _html} =
+        build_conn()
+        |> log_in_<%= schema.singular %>(<%= schema.singular %>)
+        |> live(Routes.<%= schema.route_helper %>_confirmation_path(conn, :edit, token))
+
+      result =
+        lv
+        |> form("#confirmation_form")
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert {:ok, conn} = result
+      refute get_flash(conn, :error)
+    end
+
+    test "does not confirm email with invalid token", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
+      {:ok, lv, _html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :edit, "invalid-token"))
+
+      {:ok, conn} =
+        lv
+        |> form("#confirmation_form")
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert get_flash(conn, :error) =~ "User confirmation link is invalid or it has expired"
+      refute <%= inspect context.alias %>.get_<%= schema.singular %>!(<%= schema.singular %>.id).confirmed_at
+    end
+  end
+
+  describe "Resend confirmation" do
+    test "renders the resend confirmation page", %{conn: conn} do
+      {:ok, _lv, html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :new))
+      assert html =~ "<h1>Resend confirmation instructions</h1>"
+    end
+
+    test "sends a new confirmation token", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
+      {:ok, lv, _html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :new))
+
+      {:ok, conn} =
+        lv
+        |> form("#resend_confirmation_form", <%= schema.singular %>: %{email: <%= schema.singular %>.email})
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert get_flash(conn, :info) =~ "If your email is in our system"
+      assert Repo.get_by!(<%= inspect context.alias %>.<%= inspect schema.alias %>Token, <%= schema.singular %>_id: <%= schema.singular %>.id).context == "confirm"
+    end
+
+    test "does not send confirmation token if <%= schema.singular %> is confirmed", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
+      Repo.update!(<%= inspect context.alias %>.<%= inspect schema.alias %>.confirm_changeset(<%= schema.singular %>))
+
+      {:ok, lv, _html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :new))
+
+      {:ok, conn} =
+        lv
+        |> form("#resend_confirmation_form", <%= schema.singular %>: %{email: <%= schema.singular %>.email})
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert get_flash(conn, :info) =~ "If your email is in our system"
+      refute Repo.get_by(<%= inspect context.alias %>.<%= inspect schema.alias %>Token, <%= schema.singular %>_id: <%= schema.singular %>.id)
+    end
+
+    test "does not send confirmation token if email is invalid", %{conn: conn} do
+      {:ok, lv, _html} = live(conn, Routes.<%= schema.route_helper %>_confirmation_path(conn, :new))
+
+      {:ok, conn} =
+        lv
+        |> form("#resend_confirmation_form", <%= schema.singular %>: %{email: "[email protected]"})
+        |> render_submit()
+        |> follow_redirect(conn, "/")
+
+      assert get_flash(conn, :info) =~ "If your email is in our system"
+      assert Repo.all(<%= inspect context.alias %>.<%= inspect schema.alias %>Token) == []
+    end
+  end
+end

priv/templates/phx.gen.auth/routes.ex

@@ -35,9 +35,11 @@
   scope <%= router_scope %> do
     pipe_through [:browser]
 
-    delete "/<%= schema.plural %>/log_out", <%= inspect schema.alias %>SessionController, :delete
+    delete "/<%= schema.plural %>/log_out", <%= inspect schema.alias %>SessionController, :delete<%= if live? do %>
+    live "/users/confirm/:token", UserConfirmationLive, :edit
+    live "/users/confirm", UserConfirmationLive, :new<% else %>
     get "/<%= schema.plural %>/confirm", <%= inspect schema.alias %>ConfirmationController, :new
     post "/<%= schema.plural %>/confirm", <%= inspect schema.alias %>ConfirmationController, :create
     get "/<%= schema.plural %>/confirm/:token", <%= inspect schema.alias %>ConfirmationController, :edit
-    post "/<%= schema.plural %>/confirm/:token", <%= inspect schema.alias %>ConfirmationController, :update
+    post "/<%= schema.plural %>/confirm/:token", <%= inspect schema.alias %>ConfirmationController, :update<% end %>
   end