Add custom double opt-in message + double opt-in redirect URL

Author: wmnnd

lib/keila/contacts/schemas/form_settings.ex

@@ -9,6 +9,8 @@ defmodule Keila.Contacts.Form.Settings do
     field(:double_opt_in_required, :boolean, default: false)
     field(:double_opt_in_subject, :string)
     field(:double_opt_in_markdown_body, :string)
+    field(:double_opt_in_message, :string)
+    field(:double_opt_in_url, :string)
     field(:csrf_disabled, :boolean, default: true)
     field(:intro_text, :string)
     field(:fine_print, :string)
@@ -32,6 +34,8 @@ defmodule Keila.Contacts.Form.Settings do
       :double_opt_in_required,
       :double_opt_in_subject,
       :double_opt_in_markdown_body,
+      :double_opt_in_message,
+      :double_opt_in_url,
       :csrf_disabled,
       :intro_text,
       :fine_print,

lib/keila_web/controllers/public_form_controller.ex

@@ -39,7 +39,7 @@ defmodule KeilaWeb.PublicFormController do
       {:ok, form_params = %FormParams{}} ->
         conn
         |> assign(:email, form_params.params[:email])
-        |> render("double_opt_in_required.html")
+        |> render_double_opt_in_required_or_redirect()
 
       {:error, changeset} ->
         render_form(conn, 400, changeset, form)
@@ -88,7 +88,7 @@ defmodule KeilaWeb.PublicFormController do
       {:ok, form_params = %FormParams{}} ->
         conn
         |> assign(:email, form_params.params[:email])
-        |> render("double_opt_in_required.html")
+        |> render_double_opt_in_required_or_redirect()
 
       {:error, changeset} ->
         render_form(conn, 400, changeset, form)
@@ -102,6 +102,13 @@ defmodule KeilaWeb.PublicFormController do
     end
   end
 
+  defp render_double_opt_in_required_or_redirect(conn) do
+    case conn.assigns.form.settings.double_opt_in_url do
+      url when url not in [nil, ""] -> redirect(conn, external: url)
+      _other -> render(conn, "double_opt_in_required.html")
+    end
+  end
+
   def cancel_double_opt_in(conn, %{"hmac" => hmac}) do
     form = conn.assigns.form
     form_params = conn.assigns.form_params

lib/keila_web/templates/form/edit_live.html.heex

@@ -101,18 +101,6 @@
             <%= text_input(fs, :intro_text, class: "text-black") %>
           <% end %>
         </div>
-        <div class="flex flex-col">
-          <%= label(fs, :success_text, gettext("Thank you message")) %>
-          <%= with_validation(fs, :success_text) do %>
-            <%= text_input(fs, :success_text, class: "text-black") %>
-          <% end %>
-        </div>
-        <div class="flex flex-col">
-          <%= label(fs, :success_text, gettext("Success redirect URL")) %>
-          <%= with_validation(fs, :success_url) do %>
-            <%= url_input(fs, :success_url, class: "text-black") %>
-          <% end %>
-        </div>
         <div class="flex flex-col">
           <%= label(fs, :fine_print, gettext("Fine print")) %>
           <%= with_validation(fs, :fine_print) do %>
@@ -125,6 +113,18 @@
             <%= gettext("Require captcha") %>
           <% end %>
         <% end %>
+        <div class="flex flex-col">
+          <%= label(fs, :success_text, gettext("Thank you message")) %>
+          <%= with_validation(fs, :success_text) do %>
+            <%= text_input(fs, :success_text, class: "text-black") %>
+          <% end %>
+        </div>
+        <div class="flex flex-col">
+          <%= label(fs, :success_text, gettext("Thank you redirect URL")) %>
+          <%= with_validation(fs, :success_url) do %>
+            <%= url_input(fs, :success_url, class: "text-black") %>
+          <% end %>
+        </div>
         <%= with_validation(fs, :csrf_disabled) do %>
           <%= label(fs, :csrf_disabled) do %>
             <%= checkbox(fs, :csrf_disabled, class: "text-emerald-500") %>
@@ -392,7 +392,7 @@
 
             <template x-if="enable">
               <div class="form-row">
-                <%= label(fs, :double_opt_in_subject, "Custom email text") %>
+                <%= label(fs, :double_opt_in_markdown_body, "Custom email text") %>
                 <div class="text-xs">
                   <%= gettext_md("""
                     You may use Liquid and Markdown in the email body.
@@ -401,7 +401,7 @@
                   """) %>
                 </div>
                 <br />
-                <%= with_validation(fs, :double_opt_in_text_body) do %>
+                <%= with_validation(fs, :double_opt_in_markdown_body) do %>
                   <%= textarea(fs, :double_opt_in_markdown_body,
                     class: "text-black",
                     rows: 6,
@@ -415,6 +415,36 @@
                 <% end %>
               </div>
             </template>
+
+            <template x-if="enable">
+              <div class="form-row">
+                <%= label(fs, :double_opt_in_message, gettext("Double Opt-in Info Message")) %>
+                <%= with_validation(fs, :double_opt_in_message) do %>
+                  <div class="text-xs">
+                    <%= gettext_md("""
+                      Custom message that is shown when a user submits the form and double opt-in
+                      is required.
+                    """) %>
+                  </div>
+                  <%= text_input(fs, :double_opt_in_message, class: "text-black") %>
+                <% end %>
+              </div>
+            </template>
+
+            <template x-if="enable">
+              <div class="form-row">
+                <%= label(fs, :success_text, gettext("Double Opt-in Info Redirect URL")) %>
+                <%= with_validation(fs, :double_opt_in_url) do %>
+                  <div class="text-xs">
+                    <%= gettext_md("""
+                      Custom URL to which users are redirected when they submit the form and double opt-in
+                      is required.
+                    """) %>
+                  </div>
+                  <%= url_input(fs, :double_opt_in_url, class: "text-black") %>
+                <% end %>
+              </div>
+            </template>
           <% end) %>
         </div>
       <% else %>

lib/keila_web/templates/public_form/double_opt_in_required.html.heex

@@ -1,13 +1 @@
-<div style={form_style_attr(@form)} class={form_class_attr(@form)}>
-  <%= render_h1(@form) %>
-  <h2 class="text-xl">
-    <%= gettext("Please confirm your email") %>
-  </h2>
-  <p>
-    <%= gettext(
-      "We’ve just sent an email to %{email}. Please click the link in that email to confirm your subscription.",
-      email: @email
-    ) %>
-  </p>
-  <%= render_fine_print(@form) %>
-</div>
+<%= render_form_double_opt_in_required(@form, @email) %>

lib/keila_web/views/public_form_view.ex

@@ -7,13 +7,6 @@ defmodule KeilaWeb.PublicFormView do
 
   @form_classes "contact-form container bg-white rounded py-4 md:py-8 flex flex-col gap-4"
 
-  defp form_class_attr(_form) do
-    @form_classes
-  end
-
-  defp form_style_attr(form) do
-    build_form_styles(form)
-  end
 
   defp input_styles(form) do
     build_styles(%{
@@ -276,10 +269,40 @@ defmodule KeilaWeb.PublicFormView do
     end
   end
 
+  def render_form_double_opt_in_required(form, email) do
+    content_tag(:div, class: @form_classes, style: build_form_styles(form)) do
+      [
+        render_h1(form),
+        render_double_opt_in_required(form, email),
+        render_fine_print(form)
+      ]
+    end
+  end
+
   defp render_success(form) do
     content_tag(:div, form.settings.success_text || gettext("Thank you!"), class: "text-xl")
   end
 
+  defp render_double_opt_in_required(form, email) do
+    case form.settings.double_opt_in_message do
+      message when message not in [nil, ""] ->
+        content_tag(:p, message)
+
+      _other ->
+        [
+          content_tag(:h2, class: "text-xl") do
+            gettext("Please confirm your email")
+          end,
+          content_tag(:p) do
+            gettext(
+              "We’ve just sent an email to %{email}. Please click the link in that email to confirm your subscription.",
+              email: email
+            )
+          end
+        ]
+    end
+  end
+
   def render_unsubscribe_form(form) do
     form_styles = build_form_styles(form)
 

test/keila_web/controllers/public_form_controller_double_opt_in_test.exs

@@ -29,6 +29,24 @@ defmodule KeilaWeb.PublicFormControllerDoubleOptInTest do
         args: %{"form_params_id" => form_params.id}
       )
     end
+
+    test "redirects to double_opt_in_url if set", %{conn: conn} do
+      {conn, project} = with_login_and_project(conn)
+
+      form =
+        insert!(:contacts_form,
+          project_id: project.id,
+          settings: %{
+            captcha_required: false,
+            double_opt_in_required: true,
+            double_opt_in_url: "https://example.com"
+          }
+        )
+
+      params = params(:contact) |> Map.delete(:project_id)
+      conn = post(conn, Routes.public_form_path(conn, :show, form.id), contact: params)
+      assert redirected_to(conn, 302) == form.settings.double_opt_in_url
+    end
   end
 
   @tag :double_opt_in