add mailing list signup with email confirmation (#67)

This commit is contained in:
2026-11-06 22:37:40 +01:00
parent b54fb0a6d7
commit 924a3e08dc
20 changed files with 761 additions and 2 deletions
+130
View File
@@ -0,0 +1,130 @@
defmodule Chesstrainer.MailingListTest do
use Chesstrainer.DataCase, async: true
import Chesstrainer.AccountsFixtures
alias Chesstrainer.Accounts
alias Chesstrainer.MailingList
alias Chesstrainer.MailingList.Subscriber
describe "subscribe/2" do
test "requests confirmation for a new address from the landing page" do
assert {:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
subscriber = Repo.get_by(Subscriber, email: "player@example.com")
assert subscriber.source == :home
assert subscriber.user_id == nil
assert subscriber.confirmed_at == nil
assert MailingList.count_confirmed_subscribers() == 0
end
test "trims surrounding whitespace" do
assert {:ok, :confirmation_required} = MailingList.subscribe(" player@example.com ")
assert %Subscriber{email: "player@example.com"} =
Repo.get_by(Subscriber, email: "player@example.com")
end
test "asks again instead of duplicating an unconfirmed address" do
assert {:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
assert {:ok, :confirmation_required} = MailingList.subscribe("Player@Example.com")
assert Repo.aggregate(Subscriber, :count) == 1
end
test "reports an address that is already confirmed" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.confirm("player@example.com")
assert {:ok, :already_subscribed} = MailingList.subscribe("Player@Example.com")
assert MailingList.count_confirmed_subscribers() == 1
end
test "rejects an invalid address" do
assert {:error, changeset} = MailingList.subscribe("not an email")
assert %{email: ["must have the @ sign and no spaces"]} = errors_on(changeset)
assert Repo.aggregate(Subscriber, :count) == 0
end
end
describe "confirm/1" do
test "confirms a pending subscription" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
assert {:ok, %Subscriber{} = subscriber} = MailingList.confirm("player@example.com")
assert subscriber.confirmed_at
assert MailingList.count_confirmed_subscribers() == 1
end
test "is idempotent" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, confirmed} = MailingList.confirm("player@example.com")
assert {:ok, %Subscriber{confirmed_at: confirmed_at}} =
MailingList.confirm("player@example.com")
assert confirmed_at == confirmed.confirmed_at
end
test "returns not found for an unknown address" do
assert {:error, :not_found} = MailingList.confirm("nobody@example.com")
end
end
describe "subscribe_user/1" do
test "links an unconfirmed subscription to the user" do
user = user_fixture()
assert {:ok, %Subscriber{} = subscriber} = MailingList.subscribe_user(user)
assert subscriber.email == user.email
assert subscriber.source == :registration
assert subscriber.user_id == user.id
assert subscriber.confirmed_at == nil
end
test "upgrades an anonymous subscription with the same address" do
user = user_fixture()
{:ok, :confirmation_required} = MailingList.subscribe(user.email)
assert {:ok, %Subscriber{}} = MailingList.subscribe_user(user)
assert Repo.aggregate(Subscriber, :count) == 1
subscriber = Repo.get_by(Subscriber, email: user.email)
assert subscriber.user_id == user.id
assert subscriber.source == :registration
end
test "deleting the user removes their linked subscription" do
user = user_fixture()
{:ok, _} = MailingList.subscribe_user(user)
assert {:ok, _} = Accounts.delete_user(user)
assert Repo.aggregate(Subscriber, :count) == 0
end
end
describe "confirm_user_subscription/1" do
test "confirms the subscription linked to the user" do
user = user_fixture()
{:ok, _} = MailingList.subscribe_user(user)
MailingList.confirm_user_subscription(user)
assert %Subscriber{confirmed_at: confirmed_at} =
Repo.get_by(Subscriber, user_id: user.id)
assert confirmed_at
end
test "leaves anonymous subscriptions alone" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
user = user_fixture()
MailingList.confirm_user_subscription(user)
assert %Subscriber{confirmed_at: nil} =
Repo.get_by(Subscriber, email: "player@example.com")
end
end
end
@@ -0,0 +1,110 @@
defmodule ChesstrainerWeb.MailingListControllerTest do
use ChesstrainerWeb.ConnCase, async: true
alias Chesstrainer.MailingList.Subscriber
alias Chesstrainer.Repo
@salt "mailing_list_confirm"
describe "POST /mailing-list" do
test "sends a confirmation email for a new address", %{conn: conn} do
conn = post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"})
assert redirected_to(conn) == "/#mailing-list"
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox"
assert %Subscriber{confirmed_at: nil} = Repo.get_by(Subscriber, email: "player@example.com")
assert_received {:email, email}
assert email.subject == "Confirm your mailing list subscription"
assert email.text_body =~ "/mailing-list/confirm/"
end
test "resends confirmation for an address that has not confirmed yet", %{conn: conn} do
post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"})
assert_received {:email, _email}
conn = post(build_conn(), ~p"/mailing-list", subscriber: %{email: "player@example.com"})
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox"
assert_received {:email, _email}
assert Repo.aggregate(Subscriber, :count) == 1
end
test "does not email an address that has already confirmed", %{conn: conn} do
post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"})
assert_received {:email, email}
get(build_conn(), "/mailing-list/confirm/#{extract_token(email)}")
conn = post(build_conn(), ~p"/mailing-list", subscriber: %{email: "player@example.com"})
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "already on the mailing list"
refute_received {:email, _email}
end
test "reports an invalid address", %{conn: conn} do
conn = post(conn, ~p"/mailing-list", subscriber: %{email: "not an email"})
assert redirected_to(conn) == "/#mailing-list"
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "valid email address"
refute_received {:email, _email}
assert Repo.aggregate(Subscriber, :count) == 0
end
test "reports a missing email", %{conn: conn} do
conn = post(conn, ~p"/mailing-list", %{})
assert redirected_to(conn) == "/#mailing-list"
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "valid email address"
end
end
describe "GET /mailing-list/confirm/:token" do
test "confirms the subscription from the emailed link", %{conn: conn} do
post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"})
assert_received {:email, email}
conn = get(build_conn(), "/mailing-list/confirm/#{extract_token(email)}")
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "subscription is confirmed"
assert redirected_to(conn) == "/#mailing-list"
assert %Subscriber{confirmed_at: confirmed_at} =
Repo.get_by(Subscriber, email: "player@example.com")
assert confirmed_at
end
test "rejects an invalid token", %{conn: conn} do
conn = get(conn, "/mailing-list/confirm/oops")
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "invalid or has expired"
assert redirected_to(conn) == "/#mailing-list"
end
test "rejects an expired token", %{conn: conn} do
signed_at = System.system_time(:second) - 8 * 24 * 60 * 60
token =
Phoenix.Token.sign(ChesstrainerWeb.Endpoint, @salt, "player@example.com",
signed_at: signed_at
)
conn = get(conn, "/mailing-list/confirm/#{token}")
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "invalid or has expired"
end
test "reports an address that is no longer on the list", %{conn: conn} do
token = Phoenix.Token.sign(ChesstrainerWeb.Endpoint, @salt, "nobody@example.com")
conn = get(conn, "/mailing-list/confirm/#{token}")
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "no longer on the mailing list"
end
end
defp extract_token(email) do
[_, token] = Regex.run(~r{/mailing-list/confirm/(\S+)}, email.text_body)
token
end
end
@@ -180,6 +180,22 @@ defmodule ChesstrainerWeb.PageControllerTest do
assert LazyHTML.text(LazyHTML.query(document, ".rating-note strong")) == "0"
end
test "renders the mailing list signup form", %{conn: conn} do
html = conn |> get(~p"/") |> html_response(200)
document = LazyHTML.from_document(html)
form = LazyHTML.query(document, "#mailing-list-form")
assert LazyHTML.attribute(form, "action") == ["/mailing-list"]
assert LazyHTML.attribute(form, "method") == ["post"]
input = LazyHTML.query(document, "#mailing-list-email")
assert LazyHTML.attribute(input, "type") == ["email"]
assert LazyHTML.attribute(input, "name") == ["subscriber[email]"]
assert html =~ "Join the list"
assert html =~ ~s(name="_csrf_token")
end
test "guest navbar links to log in and register", %{conn: conn} do
html = conn |> get(~p"/") |> html_response(200)
@@ -5,6 +5,8 @@ defmodule ChesstrainerWeb.UserConfirmationControllerTest do
alias Chesstrainer.Accounts
alias Chesstrainer.Accounts.User
alias Chesstrainer.MailingList
alias Chesstrainer.MailingList.Subscriber
alias Chesstrainer.Repo
setup do
@@ -33,5 +35,21 @@ defmodule ChesstrainerWeb.UserConfirmationControllerTest do
assert redirected_to(conn) == ~p"/users/register"
end
test "confirms a linked mailing-list opt-in", %{conn: conn, user: user} do
{:ok, _subscriber} = MailingList.subscribe_user(user)
token =
extract_user_token(fn url ->
Accounts.deliver_user_confirmation_instructions(user, url)
end)
get(conn, ~p"/users/confirm/#{token}")
assert %Subscriber{confirmed_at: confirmed_at} =
Repo.get_by(Subscriber, user_id: user.id)
assert confirmed_at
end
end
end
@@ -5,6 +5,8 @@ defmodule ChesstrainerWeb.UserLive.RegistrationTest do
import Chesstrainer.AccountsFixtures
import Swoosh.TestAssertions
alias Chesstrainer.MailingList.Subscriber
describe "Registration page" do
test "renders registration page", %{conn: conn} do
{:ok, _lv, html} = live(conn, ~p"/users/register")
@@ -34,6 +36,16 @@ defmodule ChesstrainerWeb.UserLive.RegistrationTest do
assert result =~ "Register"
assert result =~ "must have the @ sign and no spaces"
end
test "renders the mailing list opt-in unchecked", %{conn: conn} do
{:ok, lv, html} = live(conn, ~p"/users/register")
assert html =~ "Send me occasional endgame tips and site news by email"
refute lv
|> element("#registration_form input[name=\"user[mailing_list]\"][checked]")
|> has_element?()
end
end
describe "register user" do
@@ -63,6 +75,45 @@ defmodule ChesstrainerWeb.UserLive.RegistrationTest do
assert_email_sent(subject: "Confirmation instructions")
end
test "subscribes to the mailing list when the box is checked", %{conn: conn} do
{:ok, lv, _html} = live(conn, ~p"/users/register")
email = unique_user_email()
lv
|> form("#registration_form",
user: %{
"username" => unique_username(),
"email" => email,
"password" => valid_user_password(),
"password_confirmation" => valid_user_password(),
"mailing_list" => "true"
}
)
|> render_submit()
subscriber = Chesstrainer.Repo.get_by(Subscriber, email: email)
assert subscriber
assert subscriber.confirmed_at == nil
end
test "does not subscribe when the box is unchecked", %{conn: conn} do
{:ok, lv, _html} = live(conn, ~p"/users/register")
lv
|> form("#registration_form",
user: %{
"username" => unique_username(),
"email" => unique_user_email(),
"password" => valid_user_password(),
"password_confirmation" => valid_user_password()
}
)
|> render_submit()
assert Chesstrainer.Repo.aggregate(Subscriber, :count) == 0
end
test "renders errors for duplicated email", %{conn: conn} do
{:ok, lv, _html} = live(conn, ~p"/users/register")