Set up SES mail delivery and harden the mailing list (#120)

* setup basic SES email sending

* basic honeypot form form submission
This commit is contained in:
2026-11-09 16:38:55 +01:00
committed by GitHub
parent 5b3241ae1f
commit cae4e35a70
23 changed files with 731 additions and 64 deletions
+7
View File
@@ -0,0 +1,7 @@
SECRET_KEY_BASE=...
DATABASE_URL=...
PHX_HOST=innersquare.app
PORT=4000
SES_REGION=eu-north-1
SES_ACCESS_KEY_ID=AKIA...
SES_SECRET_ACCESS_KEY=...
+1
View File
@@ -17,6 +17,7 @@
.mailing-list-copy p { margin-top: 16px; color: var(--color-on-deep-muted); font-size: 14px; line-height: 1.65; } .mailing-list-copy p { margin-top: 16px; color: var(--color-on-deep-muted); font-size: 14px; line-height: 1.65; }
.mailing-list-form { width: min(420px, 100%); flex-shrink: 0; } .mailing-list-form { width: min(420px, 100%); flex-shrink: 0; }
.mailing-list-honeypot { position: absolute; left: -10000px; width: 1px; height: 1px; overflow: hidden; }
.mailing-list-form label { display: block; margin-bottom: 8px; color: var(--color-on-deep-faint); font-size: 11px; font-weight: 700; text-transform: uppercase; letter-spacing: .11em; } .mailing-list-form label { display: block; margin-bottom: 8px; color: var(--color-on-deep-faint); font-size: 11px; font-weight: 700; text-transform: uppercase; letter-spacing: .11em; }
.mailing-list-row { display: flex; gap: 10px; } .mailing-list-row { display: flex; gap: 10px; }
.mailing-list-row input { flex: 1; min-width: 0; padding: 15px 17px; border: 1px solid rgba(255, 255, 255, .22); border-radius: 8px; background: rgba(255, 255, 255, .1); color: var(--color-on-deep); font-size: 14px; } .mailing-list-row input { flex: 1; min-width: 0; padding: 15px 17px; border: 1px solid rgba(255, 255, 255, .22); border-radius: 8px; background: rgba(255, 255, 255, .1); color: var(--color-on-deep); font-size: 14px; }
+2 -1
View File
@@ -14,7 +14,8 @@ config :chesstrainer, :branding,
name: "Inner Square Chess", name: "Inner Square Chess",
wordmark: "INNERSQUARE", wordmark: "INNERSQUARE",
tagline: "Endgame Trainer", tagline: "Endgame Trainer",
support_email: "support@lucidchess.app" support_email: "support@innersquare.app",
mail_from: "no-reply@innersquare.app"
config :chesstrainer, :scopes, config :chesstrainer, :scopes,
user: [ user: [
+12
View File
@@ -101,6 +101,18 @@ if config_env() == :prod do
maybe_ipv6 = if System.get_env("ECTO_IPV6") in ~w(true 1), do: [:inet6], else: [] maybe_ipv6 = if System.get_env("ECTO_IPV6") in ~w(true 1), do: [:inet6], else: []
config :chesstrainer, Chesstrainer.Mailer,
adapter: Swoosh.Adapters.AmazonSES,
region:
System.get_env("SES_REGION") ||
raise("environment variable SES_REGION is missing"),
access_key:
System.get_env("SES_ACCESS_KEY_ID") ||
raise("environment variable SES_ACCESS_KEY_ID is missing"),
secret:
System.get_env("SES_SECRET_ACCESS_KEY") ||
raise("environment variable SES_SECRET_ACCESS_KEY is missing")
config :chesstrainer, Chesstrainer.Repo, config :chesstrainer, Chesstrainer.Repo,
# ssl: true, # ssl: true,
url: database_url, url: database_url,
+2
View File
@@ -7,6 +7,7 @@ defmodule Chesstrainer.Accounts do
alias Chesstrainer.Repo alias Chesstrainer.Repo
alias Chesstrainer.Accounts.{User, UserToken, UserNotifier} alias Chesstrainer.Accounts.{User, UserToken, UserNotifier}
alias Chesstrainer.MailingList
## Database getters ## Database getters
@@ -207,6 +208,7 @@ defmodule Chesstrainer.Accounts do
with {:ok, query} <- UserToken.verify_change_email_token_query(token, context), with {:ok, query} <- UserToken.verify_change_email_token_query(token, context),
%UserToken{sent_to: email} <- Repo.one(query), %UserToken{sent_to: email} <- Repo.one(query),
{:ok, user} <- Repo.update(User.email_changeset(user, %{email: email})), {:ok, user} <- Repo.update(User.email_changeset(user, %{email: email})),
{:ok, _subscription} <- MailingList.update_subscriber_email(user, email),
{_count, _result} <- {_count, _result} <-
Repo.delete_all(from(UserToken, where: [user_id: ^user.id, context: ^context])) do Repo.delete_all(from(UserToken, where: [user_id: ^user.id, context: ^context])) do
{:ok, user} {:ok, user}
+1 -1
View File
@@ -9,7 +9,7 @@ defmodule Chesstrainer.Accounts.UserNotifier do
email = email =
new() new()
|> to(recipient) |> to(recipient)
|> from({Branding.name(), Branding.support_email()}) |> from({Branding.name(), Branding.mail_from()})
|> subject(subject) |> subject(subject)
|> text_body(body) |> text_body(body)
+8 -4
View File
@@ -8,10 +8,11 @@ defmodule Chesstrainer.Branding do
""" """
@defaults [ @defaults [
name: "Lucid Chess", name: "Inner Square Chess",
wordmark: "LUCID", wordmark: "INNERSQUARE",
tagline: "Endgame Trainer", tagline: "Endgame Trainer",
support_email: "support@lucidchess.app" support_email: "support@innersquare.app",
mail_from: "no-reply@innersquare.app"
] ]
@doc "The display name, e.g. `\"Lucid Chess\"`." @doc "The display name, e.g. `\"Lucid Chess\"`."
@@ -23,9 +24,12 @@ defmodule Chesstrainer.Branding do
@doc "The tagline appended to the home title, e.g. `\"Endgame Trainer\"`." @doc "The tagline appended to the home title, e.g. `\"Endgame Trainer\"`."
def tagline, do: get(:tagline) def tagline, do: get(:tagline)
@doc "The address shown in legal pages and used as the mailer `from`." @doc "The support address shown in legal pages and used as the mailer reply-to."
def support_email, do: get(:support_email) def support_email, do: get(:support_email)
@doc "The From address used for outgoing mail."
def mail_from, do: get(:mail_from)
@doc "The home-page title, e.g. `\"Lucid Chess — Endgame Trainer\"`." @doc "The home-page title, e.g. `\"Lucid Chess — Endgame Trainer\"`."
def home_title, do: "#{name()} — #{tagline()}" def home_title, do: "#{name()} — #{tagline()}"
+153 -14
View File
@@ -9,6 +9,9 @@ defmodule Chesstrainer.MailingList do
confirmed when the user's account is. A subscriber created from the landing confirmed when the user's account is. A subscriber created from the landing
page has no user; one created from registration is linked to the user so page has no user; one created from registration is linked to the user so
deleting the account also removes their address. deleting the account also removes their address.
Unsubscribing sets `unsubscribed_at` instead of deleting the row, so the
address stays suppressed and is never emailed again unless it opts back in.
""" """
import Ecto.Query, warn: false import Ecto.Query, warn: false
@@ -17,6 +20,8 @@ defmodule Chesstrainer.MailingList do
alias Chesstrainer.MailingList.Subscriber alias Chesstrainer.MailingList.Subscriber
alias Chesstrainer.Repo alias Chesstrainer.Repo
@confirmation_cooldown_seconds 10 * 60
@doc """ @doc """
Requests a subscription from the landing-page form. Requests a subscription from the landing-page form.
@@ -42,7 +47,8 @@ defmodule Chesstrainer.MailingList do
email = Ecto.Changeset.get_field(changeset, :email) email = Ecto.Changeset.get_field(changeset, :email)
case Repo.get_by(Subscriber, email: email) do case Repo.get_by(Subscriber, email: email) do
%Subscriber{confirmed_at: confirmed_at} when not is_nil(confirmed_at) -> %Subscriber{confirmed_at: confirmed_at, unsubscribed_at: nil}
when not is_nil(confirmed_at) ->
{:ok, :already_subscribed} {:ok, :already_subscribed}
%Subscriber{} -> %Subscriber{} ->
@@ -75,20 +81,92 @@ defmodule Chesstrainer.MailingList do
@doc """ @doc """
Confirms a subscription by email address. Confirms a subscription by email address.
Confirming also clears a previous unsubscribe, so an address that opted out
can rejoin only by going through a fresh confirmation.
Returns `{:error, :not_found}` when the address is not on the list. Returns `{:error, :not_found}` when the address is not on the list.
""" """
def confirm(email) when is_binary(email) do def confirm(email) when is_binary(email) do
case Repo.get_by(Subscriber, email: String.trim(email)) do case Repo.get_by(Subscriber, email: String.trim(email)) do
nil -> nil -> {:error, :not_found}
{:error, :not_found} %Subscriber{} = subscriber -> confirm_subscriber(subscriber)
end
end
%Subscriber{confirmed_at: nil} = subscriber -> @doc """
subscriber Unsubscribes an address from the mailing list.
|> Ecto.Changeset.change(confirmed_at: DateTime.utc_now(:second))
|> Repo.update() The row is kept so the address remains suppressed. Idempotent.
"""
def unsubscribe(email) when is_binary(email) do
case Repo.get_by(Subscriber, email: String.trim(email)) do
nil -> {:error, :not_found}
%Subscriber{} = subscriber -> mark_unsubscribed(subscriber)
end
end
@doc """
Unsubscribes the address linked to the given user account.
"""
def unsubscribe_user(%User{} = user) do
case Repo.get_by(Subscriber, user_id: user.id) do
nil -> {:error, :not_found}
%Subscriber{} = subscriber -> mark_unsubscribed(subscriber)
end
end
@doc "Returns true when the user has an active mailing-list subscription."
def user_subscribed?(%User{} = user) do
Subscriber
|> where(
[s],
s.user_id == ^user.id and not is_nil(s.confirmed_at) and is_nil(s.unsubscribed_at)
)
|> Repo.exists?()
end
@doc """
Keeps a user's linked subscription in step with their account email.
Returns `{:ok, :no_subscription}` when the user was not on the list.
"""
def update_subscriber_email(%User{} = user, new_email) when is_binary(new_email) do
case Repo.get_by(Subscriber, user_id: user.id) do
nil ->
{:ok, :no_subscription}
%Subscriber{} = subscriber -> %Subscriber{} = subscriber ->
{:ok, subscriber} new_email = String.trim(new_email)
case Repo.get_by(Subscriber, email: new_email) do
# An anonymous row may already hold the new address. Remove it so the
# unique email constraint does not block the account email change,
# but keep its unsubscribe so moving an account email cannot opt an
# address back in.
%Subscriber{user_id: nil, unsubscribed_at: anonymous_unsubscribed_at} =
anonymous ->
Repo.delete!(anonymous)
changeset = Subscriber.changeset(subscriber, %{email: new_email})
changeset =
if anonymous_unsubscribed_at do
Ecto.Changeset.put_change(
changeset,
:unsubscribed_at,
subscriber.unsubscribed_at || anonymous_unsubscribed_at
)
else
changeset
end
Repo.update(changeset)
_other ->
subscriber
|> Subscriber.changeset(%{email: new_email})
|> Repo.update()
end
end end
end end
@@ -103,16 +181,71 @@ defmodule Chesstrainer.MailingList do
Subscriber Subscriber
|> where([s], s.user_id == ^user.id and is_nil(s.confirmed_at)) |> where([s], s.user_id == ^user.id and is_nil(s.confirmed_at))
|> Repo.update_all(set: [confirmed_at: now, updated_at: now]) |> Repo.update_all(set: [confirmed_at: now, unsubscribed_at: nil, updated_at: now])
end end
@doc "Returns the number of confirmed addresses on the mailing list." @doc "Returns the number of active addresses on the mailing list."
def count_confirmed_subscribers do def count_confirmed_subscribers do
Subscriber Subscriber
|> where([s], not is_nil(s.confirmed_at)) |> where([s], not is_nil(s.confirmed_at) and is_nil(s.unsubscribed_at))
|> Repo.aggregate(:count) |> Repo.aggregate(:count)
end end
@doc """
Returns true when a confirmation email may be sent to this address.
Addresses without a subscriber row are allowed, as are addresses that have
not received a confirmation recently. This stops a repeated submission from
turning into an email flood.
"""
def confirmation_allowed?(email) when is_binary(email) do
case Repo.get_by(Subscriber, email: String.trim(email)) do
nil ->
true
%Subscriber{confirmation_sent_at: nil} ->
true
%Subscriber{confirmation_sent_at: sent_at} ->
DateTime.diff(DateTime.utc_now(:second), sent_at, :second) >=
@confirmation_cooldown_seconds
end
end
@doc "Records that a confirmation email was sent to this address."
def mark_confirmation_sent(email) when is_binary(email) do
case Repo.get_by(Subscriber, email: String.trim(email)) do
nil ->
:ok
%Subscriber{} = subscriber ->
subscriber
|> Ecto.Changeset.change(confirmation_sent_at: DateTime.utc_now(:second))
|> Repo.update()
end
end
defp confirm_subscriber(%Subscriber{} = subscriber) do
attrs =
if is_nil(subscriber.confirmed_at) do
%{confirmed_at: DateTime.utc_now(:second), unsubscribed_at: nil}
else
%{unsubscribed_at: nil}
end
subscriber
|> Ecto.Changeset.change(attrs)
|> Repo.update()
end
defp mark_unsubscribed(%Subscriber{unsubscribed_at: nil} = subscriber) do
subscriber
|> Ecto.Changeset.change(unsubscribed_at: DateTime.utc_now(:second))
|> Repo.update()
end
defp mark_unsubscribed(%Subscriber{} = subscriber), do: {:ok, subscriber}
defp insert_subscription(changeset, email) do defp insert_subscription(changeset, email) do
case Repo.insert(changeset) do case Repo.insert(changeset) do
{:ok, _subscriber} -> {:ok, _subscriber} ->
@@ -123,9 +256,15 @@ defmodule Chesstrainer.MailingList do
# above and this insert; the unique constraint decides, so re-read it. # above and this insert; the unique constraint decides, so re-read it.
if email_taken?(changeset) do if email_taken?(changeset) do
case Repo.get_by(Subscriber, email: email) do case Repo.get_by(Subscriber, email: email) do
%Subscriber{confirmed_at: nil} -> {:ok, :confirmation_required} %Subscriber{confirmed_at: confirmed_at, unsubscribed_at: nil}
%Subscriber{} -> {:ok, :already_subscribed} when not is_nil(confirmed_at) ->
nil -> {:error, changeset} {:ok, :already_subscribed}
%Subscriber{} ->
{:ok, :confirmation_required}
nil ->
{:error, changeset}
end end
else else
{:error, changeset} {:error, changeset}
+2 -1
View File
@@ -33,7 +33,8 @@ defmodule Chesstrainer.MailingList.Notifier do
email = email =
new() new()
|> to(recipient) |> to(recipient)
|> from({Branding.name(), Branding.support_email()}) |> from({Branding.name(), Branding.mail_from()})
|> reply_to(Branding.support_email())
|> subject(subject) |> subject(subject)
|> text_body(body) |> text_body(body)
@@ -10,6 +10,8 @@ defmodule Chesstrainer.MailingList.Subscriber do
field :email, :string field :email, :string
field :source, Ecto.Enum, values: [:home, :registration], default: :home field :source, Ecto.Enum, values: [:home, :registration], default: :home
field :confirmed_at, :utc_datetime field :confirmed_at, :utc_datetime
field :unsubscribed_at, :utc_datetime
field :confirmation_sent_at, :utc_datetime
belongs_to :user, User belongs_to :user, User
timestamps(type: :utc_datetime) timestamps(type: :utc_datetime)
@@ -13,6 +13,7 @@ defmodule ChesstrainerWeb.LandingComponents do
alias Chesstrainer.FEN alias Chesstrainer.FEN
alias Chesstrainer.Themes alias Chesstrainer.Themes
alias ChesstrainerWeb.Board.PositionText alias ChesstrainerWeb.Board.PositionText
alias ChesstrainerWeb.MailingListFormToken
@button_variants %{ @button_variants %{
nav: "nav-cta", nav: "nav-cta",
@@ -93,6 +94,19 @@ defmodule ChesstrainerWeb.LandingComponents do
<form action="/mailing-list" method="post" id="mailing-list-form" class="mailing-list-form"> <form action="/mailing-list" method="post" id="mailing-list-form" class="mailing-list-form">
<input type="hidden" name="_csrf_token" value={get_csrf_token()} /> <input type="hidden" name="_csrf_token" value={get_csrf_token()} />
<input type="hidden" name="subscriber[form_token]" value={MailingListFormToken.sign()} />
<div class="mailing-list-honeypot" aria-hidden="true">
<label for="mailing-list-company">Company</label>
<input
id="mailing-list-company"
type="text"
name="subscriber[company]"
tabindex="-1"
autocomplete="off"
/>
</div>
<label for="mailing-list-email">Email address</label> <label for="mailing-list-email">Email address</label>
<div class="mailing-list-row"> <div class="mailing-list-row">
<input <input
@@ -3,45 +3,31 @@ defmodule ChesstrainerWeb.MailingListController do
alias Chesstrainer.MailingList alias Chesstrainer.MailingList
alias Chesstrainer.MailingList.Notifier alias Chesstrainer.MailingList.Notifier
alias ChesstrainerWeb.MailingListFormToken
@return_to "/#mailing-list" @return_to "/#mailing-list"
@token_salt "mailing_list_confirm" @token_salt "mailing_list_confirm"
@token_max_age 7 * 24 * 60 * 60 @token_max_age 7 * 24 * 60 * 60
def create(conn, %{"subscriber" => %{"email" => email}}) when is_binary(email) do def create(conn, %{"subscriber" => params}) when is_map(params) do
email = String.trim(email) email = params["email"]
case MailingList.subscribe(email) do cond do
{:ok, :already_subscribed} -> honeypot_filled?(params) ->
conn fake_success(conn)
|> put_flash(:info, "You're already on the mailing list.")
|> redirect(to: @return_to)
{:ok, :confirmation_required} -> not is_binary(email) ->
case send_confirmation(email) do invalid_email(conn)
:ok ->
conn
|> put_flash(:info, "Check your inbox to confirm your subscription.")
|> redirect(to: @return_to)
:error -> MailingListFormToken.verify(params["form_token"]) != :ok ->
conn form_error(conn)
|> put_flash(:error, "We couldn't send the confirmation email. Please try again.")
|> redirect(to: @return_to)
end
{:error, %Ecto.Changeset{}} -> true ->
conn subscribe(conn, email)
|> put_flash(:error, "Enter a valid email address.")
|> redirect(to: @return_to)
end end
end end
def create(conn, _params) do def create(conn, _params), do: invalid_email(conn)
conn
|> put_flash(:error, "Enter a valid email address.")
|> redirect(to: @return_to)
end
def confirm(conn, %{"token" => token}) do def confirm(conn, %{"token" => token}) do
case Phoenix.Token.verify( case Phoenix.Token.verify(
@@ -77,13 +63,63 @@ defmodule ChesstrainerWeb.MailingListController do
end end
end end
defp send_confirmation(email) do defp subscribe(conn, email) do
email = String.trim(email)
case MailingList.subscribe(email) do
{:ok, :already_subscribed} ->
conn
|> put_flash(:info, "You're already on the mailing list.")
|> redirect(to: @return_to)
{:ok, :confirmation_required} ->
if MailingList.confirmation_allowed?(email) do
send_confirmation(conn, email)
else
fake_success(conn)
end
{:error, %Ecto.Changeset{}} ->
invalid_email(conn)
end
end
defp send_confirmation(conn, email) do
token = Phoenix.Token.sign(ChesstrainerWeb.Endpoint, @token_salt, email) token = Phoenix.Token.sign(ChesstrainerWeb.Endpoint, @token_salt, email)
url = url(~p"/mailing-list/confirm/#{token}") url = url(~p"/mailing-list/confirm/#{token}")
case Notifier.deliver_confirmation_instructions(email, url) do case Notifier.deliver_confirmation_instructions(email, url) do
{:ok, _email} -> :ok {:ok, _email} ->
{:error, _reason} -> :error _ = MailingList.mark_confirmation_sent(email)
conn
|> put_flash(:info, "Check your inbox to confirm your subscription.")
|> redirect(to: @return_to)
{:error, _reason} ->
conn
|> put_flash(:error, "We couldn't send the confirmation email. Please try again.")
|> redirect(to: @return_to)
end end
end end
defp honeypot_filled?(params), do: params["company"] not in [nil, ""]
defp fake_success(conn) do
conn
|> put_flash(:info, "Check your inbox to confirm your subscription.")
|> redirect(to: @return_to)
end
defp form_error(conn) do
conn
|> put_flash(:error, "Please refresh the page and try again.")
|> redirect(to: @return_to)
end
defp invalid_email(conn) do
conn
|> put_flash(:error, "Enter a valid email address.")
|> redirect(to: @return_to)
end
end end
@@ -4,6 +4,7 @@ defmodule ChesstrainerWeb.UserLive.Profile do
alias Chesstrainer.Accounts alias Chesstrainer.Accounts
alias Chesstrainer.Accounts.Scope alias Chesstrainer.Accounts.Scope
alias Chesstrainer.Attempts alias Chesstrainer.Attempts
alias Chesstrainer.MailingList
@recent_attempts 25 @recent_attempts 25
@@ -159,6 +160,27 @@ defmodule ChesstrainerWeb.UserLive.Profile do
</p> </p>
</section> </section>
<section id="mailing-list-settings" class="space-y-3 rounded-lg border border-base-300 p-4">
<h2 class="settings-header">Mailing list</h2>
<p :if={@mailing_list_subscribed?} class="settings-subtitle">
You're subscribed to occasional endgame tips and site news.
</p>
<p :if={!@mailing_list_subscribed?} class="settings-subtitle">
You're not subscribed to the mailing list.
</p>
<.button
:if={@mailing_list_subscribed?}
id="unsubscribe-mailing-list"
variant="secondary"
phx-click="unsubscribe_mailing_list"
>
Unsubscribe
</.button>
</section>
<p id="settings-empty-state" class="text-sm text-base-content/60"> <p id="settings-empty-state" class="text-sm text-base-content/60">
More site settings will appear here as they become available. More site settings will appear here as they become available.
</p> </p>
@@ -332,6 +354,24 @@ defmodule ChesstrainerWeb.UserLive.Profile do
end end
end end
def handle_event("unsubscribe_mailing_list", _params, socket) do
user = socket.assigns.current_scope.user
case MailingList.unsubscribe_user(user) do
{:ok, _subscriber} ->
{:noreply,
socket
|> assign(:mailing_list_subscribed?, false)
|> put_flash(:info, "You've been removed from the mailing list.")}
{:error, :not_found} ->
{:noreply,
socket
|> assign(:mailing_list_subscribed?, false)
|> put_flash(:info, "You're not on the mailing list.")}
end
end
def handle_event("delete_account", _params, socket) do def handle_event("delete_account", _params, socket) do
user = socket.assigns.current_scope.user user = socket.assigns.current_scope.user
true = Accounts.sudo_mode?(user) true = Accounts.sudo_mode?(user)
@@ -348,10 +388,16 @@ defmodule ChesstrainerWeb.UserLive.Profile do
case socket.assigns.live_action do case socket.assigns.live_action do
:account -> assign_account(socket) :account -> assign_account(socket)
:data -> assign_data(socket) :data -> assign_data(socket)
:settings -> assign_settings(socket)
_ -> socket _ -> socket
end end
end end
defp assign_settings(socket) do
user = socket.assigns.current_scope.user
assign(socket, :mailing_list_subscribed?, MailingList.user_subscribed?(user))
end
defp assign_account(socket) do defp assign_account(socket) do
user = socket.assigns.current_scope.user user = socket.assigns.current_scope.user
email_changeset = Accounts.change_user_email(user, %{}, validate_unique: false) email_changeset = Accounts.change_user_email(user, %{}, validate_unique: false)
@@ -0,0 +1,38 @@
defmodule ChesstrainerWeb.MailingListFormToken do
@moduledoc """
Signed timestamp hidden in the mailing-list signup form.
Used as a timing check: submissions that arrive faster than a human could
plausibly fill the form are rejected. The timestamp is signed so a bot
cannot simply make one up.
"""
@salt "mailing_list_form"
@max_age 2 * 60 * 60
@min_seconds 2
@type verify_result :: :ok | :too_fast | :expired | :invalid
@doc "Signs the current time for the hidden form field."
def sign, do: sign(System.system_time(:second))
@doc false
def sign(signed_at) when is_integer(signed_at) do
Phoenix.Token.sign(ChesstrainerWeb.Endpoint, @salt, signed_at, signed_at: signed_at)
end
@doc "Checks a submitted form token."
@spec verify(term()) :: verify_result()
def verify(token) when is_binary(token) do
now = System.system_time(:second)
case Phoenix.Token.verify(ChesstrainerWeb.Endpoint, @salt, token, max_age: @max_age) do
{:ok, signed_at} when is_integer(signed_at) and now - signed_at >= @min_seconds -> :ok
{:ok, _signed_at} -> :too_fast
{:error, :expired} -> :expired
{:error, _reason} -> :invalid
end
end
def verify(_token), do: :invalid
end
+1
View File
@@ -62,6 +62,7 @@ defmodule Chesstrainer.MixProject do
depth: 1}, depth: 1},
{:swoosh, "~> 1.16"}, {:swoosh, "~> 1.16"},
{:req, "~> 0.5"}, {:req, "~> 0.5"},
{:gen_smtp, "~> 1.2"},
{:telemetry_metrics, "~> 1.0"}, {:telemetry_metrics, "~> 1.0"},
{:telemetry_poller, "~> 1.0"}, {:telemetry_poller, "~> 1.0"},
{:gettext, "~> 1.0"}, {:gettext, "~> 1.0"},
+2
View File
@@ -17,6 +17,7 @@
"file_system": {:hex, :file_system, "1.1.1", "31864f4685b0148f25bd3fbef2b1228457c0c89024ad67f7a81a3ffbc0bbad3a", [:mix], [], "hexpm", "7a15ff97dfe526aeefb090a7a9d3d03aa907e100e262a0f8f7746b78f8f87a5d"}, "file_system": {:hex, :file_system, "1.1.1", "31864f4685b0148f25bd3fbef2b1228457c0c89024ad67f7a81a3ffbc0bbad3a", [:mix], [], "hexpm", "7a15ff97dfe526aeefb090a7a9d3d03aa907e100e262a0f8f7746b78f8f87a5d"},
"finch": {:hex, :finch, "0.23.0", "e3f9287ac25a8832f848b144c2b57346aac65b205e2e0629a52adfe6507fd837", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.8", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "80e58d3f936f57e3fdf404f83a3642897ae6d9fb642934e46da4d8fe761b99d5"}, "finch": {:hex, :finch, "0.23.0", "e3f9287ac25a8832f848b144c2b57346aac65b205e2e0629a52adfe6507fd837", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.8", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "80e58d3f936f57e3fdf404f83a3642897ae6d9fb642934e46da4d8fe761b99d5"},
"fine": {:hex, :fine, "0.1.6", "4bf7151493443c454aac9f2fa2f34f5fefd0346a83fb5586a016c4a135c63247", [:mix], [], "hexpm", "5638eb4495488e885ebec167fa57973e5c35e1a50c344eb7666c90ec1c4e3b12"}, "fine": {:hex, :fine, "0.1.6", "4bf7151493443c454aac9f2fa2f34f5fefd0346a83fb5586a016c4a135c63247", [:mix], [], "hexpm", "5638eb4495488e885ebec167fa57973e5c35e1a50c344eb7666c90ec1c4e3b12"},
"gen_smtp": {:hex, :gen_smtp, "1.3.0", "62c3d91f0dcf6ce9db71bcb6881d7ad0d1d834c7f38c13fa8e952f4104a8442e", [:rebar3], [{:ranch, ">= 1.8.0", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm", "0b73fbf069864ecbce02fe653b16d3f35fd889d0fdd4e14527675565c39d84e6"},
"gettext": {:hex, :gettext, "1.0.2", "5457e1fd3f4abe47b0e13ff85086aabae760497a3497909b8473e0acee57673b", [:mix], [{:expo, "~> 0.5.1 or ~> 1.0", [hex: :expo, repo: "hexpm", optional: false]}], "hexpm", "eab805501886802071ad290714515c8c4a17196ea76e5afc9d06ca85fb1bfeb3"}, "gettext": {:hex, :gettext, "1.0.2", "5457e1fd3f4abe47b0e13ff85086aabae760497a3497909b8473e0acee57673b", [:mix], [{:expo, "~> 0.5.1 or ~> 1.0", [hex: :expo, repo: "hexpm", optional: false]}], "hexpm", "eab805501886802071ad290714515c8c4a17196ea76e5afc9d06ca85fb1bfeb3"},
"glicko": {:hex, :glicko, "0.8.1", "3f038a9b1022116d19e33f03b95641d8a199882d718592f9b03bbdc63d55215c", [:mix], [], "hexpm", "86dc0c86f3ef442d8c0b977d377a8aed50bc732ebf4582eb1bf19b87d7bd5b1c"}, "glicko": {:hex, :glicko, "0.8.1", "3f038a9b1022116d19e33f03b95641d8a199882d718592f9b03bbdc63d55215c", [:mix], [], "hexpm", "86dc0c86f3ef442d8c0b977d377a8aed50bc732ebf4582eb1bf19b87d7bd5b1c"},
"heroicons": {:git, "https://github.com/tailwindlabs/heroicons.git", "0435d4ca364a608cc75e2f8683d374e55abbae26", [tag: "v2.2.0", sparse: "optimized", depth: 1]}, "heroicons": {:git, "https://github.com/tailwindlabs/heroicons.git", "0435d4ca364a608cc75e2f8683d374e55abbae26", [tag: "v2.2.0", sparse: "optimized", depth: 1]},
@@ -40,6 +41,7 @@
"plug": {:hex, :plug, "1.19.2", "e4950525b22c6789dfb38a3f95d47171ba159da3fc5a33be9643b43d5e8adb98", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "b6fce20a56af5e60fa5dfecf3f907bb98ec981be43c79a3809a499bc3d133de0"}, "plug": {:hex, :plug, "1.19.2", "e4950525b22c6789dfb38a3f95d47171ba159da3fc5a33be9643b43d5e8adb98", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "b6fce20a56af5e60fa5dfecf3f907bb98ec981be43c79a3809a499bc3d133de0"},
"plug_crypto": {:hex, :plug_crypto, "2.1.1", "19bda8184399cb24afa10be734f84a16ea0a2bc65054e23a62bb10f06bc89491", [:mix], [], "hexpm", "6470bce6ffe41c8bd497612ffde1a7e4af67f36a15eea5f921af71cf3e11247c"}, "plug_crypto": {:hex, :plug_crypto, "2.1.1", "19bda8184399cb24afa10be734f84a16ea0a2bc65054e23a62bb10f06bc89491", [:mix], [], "hexpm", "6470bce6ffe41c8bd497612ffde1a7e4af67f36a15eea5f921af71cf3e11247c"},
"postgrex": {:hex, :postgrex, "0.22.2", "4aec14df2a72722aee92492566edbeeb44e233ecb86b1915d03136297ef1385d", [:mix], [{:db_connection, "~> 2.9", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0 or ~> 3.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "8946382ddb06294f56026ac4278b3cc212bac8a2c82ed68b4087819ed1abc53b"}, "postgrex": {:hex, :postgrex, "0.22.2", "4aec14df2a72722aee92492566edbeeb44e233ecb86b1915d03136297ef1385d", [:mix], [{:db_connection, "~> 2.9", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0 or ~> 3.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "8946382ddb06294f56026ac4278b3cc212bac8a2c82ed68b4087819ed1abc53b"},
"ranch": {:hex, :ranch, "2.3.0", "7de7b041a9a6a5091a3aa5898d66c0564be671d87db4f9d63b1b5ee775b097df", [:make, :rebar3], [], "hexpm", "6168ec49409d982f7cfbd83dd083144f6cbe67caa4036551d2f0a3ad67c9d023"},
"req": {:hex, :req, "0.6.2", "b9b2024f35bcf60a92cc8cad2eaaf9d4e7aace463ff74be1afe5986830184413", [:mix], [{:brotli, "~> 0.3.1", [hex: :brotli, repo: "hexpm", optional: true]}, {:ezstd, "~> 1.0", [hex: :ezstd, repo: "hexpm", optional: true]}, {:finch, "~> 0.21", [hex: :finch, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mime, "~> 2.0.6 or ~> 2.1", [hex: :mime, repo: "hexpm", optional: false]}, {:nimble_csv, "~> 1.0", [hex: :nimble_csv, repo: "hexpm", optional: true]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: true]}], "hexpm", "cc9cd30a2ddd04989929b887178e1610c940456d962c6c3a52df6146d2eef9bf"}, "req": {:hex, :req, "0.6.2", "b9b2024f35bcf60a92cc8cad2eaaf9d4e7aace463ff74be1afe5986830184413", [:mix], [{:brotli, "~> 0.3.1", [hex: :brotli, repo: "hexpm", optional: true]}, {:ezstd, "~> 1.0", [hex: :ezstd, repo: "hexpm", optional: true]}, {:finch, "~> 0.21", [hex: :finch, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mime, "~> 2.0.6 or ~> 2.1", [hex: :mime, repo: "hexpm", optional: false]}, {:nimble_csv, "~> 1.0", [hex: :nimble_csv, repo: "hexpm", optional: true]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: true]}], "hexpm", "cc9cd30a2ddd04989929b887178e1610c940456d962c6c3a52df6146d2eef9bf"},
"rustler": {:hex, :rustler, "0.38.0", "7a8906998ff0d28e3021c0a73264abcda719bda344b2e58307c6805b0f87c9b4", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "704c03c1bf66be12b031c5a389347b91c81c5cb819a24b068b0de36fe4a5652a"}, "rustler": {:hex, :rustler, "0.38.0", "7a8906998ff0d28e3021c0a73264abcda719bda344b2e58307c6805b0f87c9b4", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "704c03c1bf66be12b031c5a389347b91c81c5cb819a24b068b0de36fe4a5652a"},
"swoosh": {:hex, :swoosh, "1.26.1", "2989f1089e3cf1a938bbd3908c11d7dba8c8a4fe78801a7762d26f01bdbb32b4", [:mix], [{:bandit, ">= 1.0.0", [hex: :bandit, repo: "hexpm", optional: true]}, {:cowboy, "~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:ex_aws, "~> 2.1", [hex: :ex_aws, repo: "hexpm", optional: true]}, {:finch, "~> 0.6", [hex: :finch, repo: "hexpm", optional: true]}, {:gen_smtp, "~> 0.13 or ~> 1.0", [hex: :gen_smtp, repo: "hexpm", optional: true]}, {:hackney, ">= 1.9.0 and < 5.0.0", [hex: :hackney, repo: "hexpm", optional: true]}, {:idna, ">= 6.0.0 and < 8.0.0", [hex: :idna, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mail, "~> 0.2", [hex: :mail, repo: "hexpm", optional: true]}, {:mime, "~> 1.1 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mua, "~> 0.2.3", [hex: :mua, repo: "hexpm", optional: true]}, {:multipart, "~> 0.4", [hex: :multipart, repo: "hexpm", optional: true]}, {:plug, "~> 1.9", [hex: :plug, repo: "hexpm", optional: true]}, {:plug_cowboy, ">= 1.0.0", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:req, "~> 0.5.10 or ~> 0.6 or ~> 1.0", [hex: :req, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.2 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "8ad197c025102bbcbaffcd67c10ff7b390746c32f534ff5158891b149460118e"}, "swoosh": {:hex, :swoosh, "1.26.1", "2989f1089e3cf1a938bbd3908c11d7dba8c8a4fe78801a7762d26f01bdbb32b4", [:mix], [{:bandit, ">= 1.0.0", [hex: :bandit, repo: "hexpm", optional: true]}, {:cowboy, "~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:ex_aws, "~> 2.1", [hex: :ex_aws, repo: "hexpm", optional: true]}, {:finch, "~> 0.6", [hex: :finch, repo: "hexpm", optional: true]}, {:gen_smtp, "~> 0.13 or ~> 1.0", [hex: :gen_smtp, repo: "hexpm", optional: true]}, {:hackney, ">= 1.9.0 and < 5.0.0", [hex: :hackney, repo: "hexpm", optional: true]}, {:idna, ">= 6.0.0 and < 8.0.0", [hex: :idna, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mail, "~> 0.2", [hex: :mail, repo: "hexpm", optional: true]}, {:mime, "~> 1.1 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mua, "~> 0.2.3", [hex: :mua, repo: "hexpm", optional: true]}, {:multipart, "~> 0.4", [hex: :multipart, repo: "hexpm", optional: true]}, {:plug, "~> 1.9", [hex: :plug, repo: "hexpm", optional: true]}, {:plug_cowboy, ">= 1.0.0", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:req, "~> 0.5.10 or ~> 0.6 or ~> 1.0", [hex: :req, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.2 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "8ad197c025102bbcbaffcd67c10ff7b390746c32f534ff5158891b149460118e"},
@@ -0,0 +1,9 @@
defmodule Chesstrainer.Repo.Migrations.AddUnsubscribedAtToMailingListSubscribers do
use Ecto.Migration
def change do
alter table(:mailing_list_subscribers) do
add :unsubscribed_at, :utc_datetime
end
end
end
@@ -0,0 +1,9 @@
defmodule Chesstrainer.Repo.Migrations.AddConfirmationSentAtToMailingListSubscribers do
use Ecto.Migration
def change do
alter table(:mailing_list_subscribers) do
add :confirmation_sent_at, :utc_datetime
end
end
end
+15
View File
@@ -9,6 +9,8 @@ defmodule Chesstrainer.AccountsTest do
alias Chesstrainer.Attempts alias Chesstrainer.Attempts
alias Chesstrainer.Attempts.Attempt alias Chesstrainer.Attempts.Attempt
alias Chesstrainer.Accounts.Scope alias Chesstrainer.Accounts.Scope
alias Chesstrainer.MailingList
alias Chesstrainer.MailingList.Subscriber
describe "get_user_by_email/1" do describe "get_user_by_email/1" do
test "does not return the user if the email does not exist" do test "does not return the user if the email does not exist" do
@@ -340,6 +342,19 @@ defmodule Chesstrainer.AccountsTest do
refute Repo.get_by(UserToken, user_id: user.id) refute Repo.get_by(UserToken, user_id: user.id)
end end
test "updates the linked mailing-list address", %{
user: user,
token: token,
email: email
} do
{:ok, _subscriber} = MailingList.subscribe_user(user)
MailingList.confirm_user_subscription(user)
assert {:ok, %{email: ^email}} = Accounts.update_user_email(user, token)
assert %Subscriber{email: ^email} = Repo.get_by(Subscriber, user_id: user.id)
end
test "does not update email with invalid token", %{user: user} do test "does not update email with invalid token", %{user: user} do
assert Accounts.update_user_email(user, "oops") == assert Accounts.update_user_email(user, "oops") ==
{:error, :transaction_aborted} {:error, :transaction_aborted}
+168
View File
@@ -127,4 +127,172 @@ defmodule Chesstrainer.MailingListTest do
Repo.get_by(Subscriber, email: "player@example.com") Repo.get_by(Subscriber, email: "player@example.com")
end end
end end
describe "unsubscribe/1" do
test "marks a confirmed address as unsubscribed" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.confirm("player@example.com")
assert {:ok, %Subscriber{unsubscribed_at: unsubscribed_at}} =
MailingList.unsubscribe("player@example.com")
assert unsubscribed_at
assert MailingList.count_confirmed_subscribers() == 0
end
test "is idempotent" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.confirm("player@example.com")
{:ok, first} = MailingList.unsubscribe("player@example.com")
{:ok, second} = MailingList.unsubscribe("player@example.com")
assert first.unsubscribed_at == second.unsubscribed_at
end
test "returns not found for an unknown address" do
assert {:error, :not_found} = MailingList.unsubscribe("nobody@example.com")
end
end
describe "unsubscribe_user/1" do
test "unsubscribes the address linked to the user" do
user = user_fixture()
{:ok, _subscriber} = MailingList.subscribe_user(user)
MailingList.confirm_user_subscription(user)
assert {:ok, %Subscriber{unsubscribed_at: unsubscribed_at}} =
MailingList.unsubscribe_user(user)
assert unsubscribed_at
refute MailingList.user_subscribed?(user)
end
test "returns not found when the user is not on the list" do
assert {:error, :not_found} = MailingList.unsubscribe_user(user_fixture())
end
end
describe "user_subscribed?/1" do
test "is true only for a confirmed, active subscription" do
user = user_fixture()
{:ok, _subscriber} = MailingList.subscribe_user(user)
refute MailingList.user_subscribed?(user)
MailingList.confirm_user_subscription(user)
assert MailingList.user_subscribed?(user)
{:ok, _subscriber} = MailingList.unsubscribe_user(user)
refute MailingList.user_subscribed?(user)
end
end
describe "re-subscribing after unsubscribe" do
test "requires a fresh confirmation and clears the unsubscribe" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.confirm("player@example.com")
{:ok, _subscriber} = MailingList.unsubscribe("player@example.com")
assert {:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
assert {:ok, %Subscriber{confirmed_at: confirmed_at, unsubscribed_at: nil}} =
MailingList.confirm("player@example.com")
assert confirmed_at
assert MailingList.count_confirmed_subscribers() == 1
end
end
describe "update_subscriber_email/2" do
test "moves the linked subscription to the new address" do
user = user_fixture()
{:ok, _subscriber} = MailingList.subscribe_user(user)
MailingList.confirm_user_subscription(user)
new_email = unique_user_email()
assert {:ok, %Subscriber{email: ^new_email}} =
MailingList.update_subscriber_email(user, new_email)
assert Repo.get_by(Subscriber, user_id: user.id).email == new_email
end
test "removes an anonymous row that already holds the new address" do
user = user_fixture()
{:ok, _subscriber} = MailingList.subscribe_user(user)
new_email = unique_user_email()
{:ok, :confirmation_required} = MailingList.subscribe(new_email)
assert {:ok, _subscriber} = MailingList.update_subscriber_email(user, new_email)
assert Repo.aggregate(Subscriber, :count) == 1
assert %Subscriber{user_id: user_id} = Repo.get_by(Subscriber, email: new_email)
assert user_id == user.id
end
test "keeps an unsubscribe from an anonymous row at the new address" do
user = user_fixture()
{:ok, _subscriber} = MailingList.subscribe_user(user)
MailingList.confirm_user_subscription(user)
new_email = unique_user_email()
{:ok, :confirmation_required} = MailingList.subscribe(new_email)
{:ok, _subscriber} = MailingList.confirm(new_email)
{:ok, _subscriber} = MailingList.unsubscribe(new_email)
assert {:ok, %Subscriber{unsubscribed_at: unsubscribed_at}} =
MailingList.update_subscriber_email(user, new_email)
assert unsubscribed_at
refute MailingList.user_subscribed?(user)
end
test "does nothing when the user is not on the list" do
user = user_fixture()
assert {:ok, :no_subscription} =
MailingList.update_subscriber_email(user, unique_user_email())
end
end
describe "confirmation cooldown" do
test "allows an address that has never received a confirmation" do
assert MailingList.confirmation_allowed?("player@example.com")
end
test "blocks a recently sent confirmation" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.mark_confirmation_sent("player@example.com")
refute MailingList.confirmation_allowed?("player@example.com")
end
test "allows another send after the cooldown" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
Repo.get_by(Subscriber, email: "player@example.com")
|> Ecto.Changeset.change(
confirmation_sent_at: DateTime.add(DateTime.utc_now(:second), -11, :minute)
)
|> Repo.update!()
assert MailingList.confirmation_allowed?("player@example.com")
end
test "allows a confirmed address" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.confirm("player@example.com")
assert MailingList.confirmation_allowed?("player@example.com")
end
test "still applies after an unsubscribe" do
{:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
{:ok, _subscriber} = MailingList.confirm("player@example.com")
{:ok, _subscriber} = MailingList.unsubscribe("player@example.com")
{:ok, _subscriber} = MailingList.mark_confirmation_sent("player@example.com")
refute MailingList.confirmation_allowed?("player@example.com")
end
end
end end
@@ -1,14 +1,19 @@
defmodule ChesstrainerWeb.MailingListControllerTest do defmodule ChesstrainerWeb.MailingListControllerTest do
use ChesstrainerWeb.ConnCase, async: true use ChesstrainerWeb.ConnCase, async: true
alias Chesstrainer.MailingList
alias Chesstrainer.MailingList.Subscriber alias Chesstrainer.MailingList.Subscriber
alias Chesstrainer.Repo alias Chesstrainer.Repo
alias ChesstrainerWeb.MailingListFormToken
@salt "mailing_list_confirm" @salt "mailing_list_confirm"
describe "POST /mailing-list" do describe "POST /mailing-list" do
test "sends a confirmation email for a new address", %{conn: conn} do test "sends a confirmation email for a new address", %{conn: conn} do
conn = post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"}) conn =
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert redirected_to(conn) == "/#mailing-list" assert redirected_to(conn) == "/#mailing-list"
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox" assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox"
@@ -17,32 +22,140 @@ defmodule ChesstrainerWeb.MailingListControllerTest do
assert_received {:email, email} assert_received {:email, email}
assert email.subject == "Confirm your mailing list subscription" assert email.subject == "Confirm your mailing list subscription"
assert email.text_body =~ "/mailing-list/confirm/" assert email.text_body =~ "/mailing-list/confirm/"
assert email.reply_to == {"", "support@innersquare.app"}
end end
test "resends confirmation for an address that has not confirmed yet", %{conn: conn} do test "re-confirms an address that previously unsubscribed", %{conn: conn} do
post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"}) {:ok, :confirmation_required} = MailingList.subscribe("player@example.com")
assert_received {:email, _email} {:ok, _subscriber} = MailingList.confirm("player@example.com")
{:ok, _subscriber} = MailingList.unsubscribe("player@example.com")
conn = post(build_conn(), ~p"/mailing-list", subscriber: %{email: "player@example.com"}) conn =
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox" 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} assert_received {:email, email}
get(build_conn(), "/mailing-list/confirm/#{extract_token(email)}") get(build_conn(), "/mailing-list/confirm/#{extract_token(email)}")
conn = post(build_conn(), ~p"/mailing-list", subscriber: %{email: "player@example.com"}) subscriber = Repo.get_by(Subscriber, email: "player@example.com")
assert subscriber.confirmed_at
assert subscriber.unsubscribed_at == nil
assert MailingList.count_confirmed_subscribers() == 1
end
test "does not resend confirmation while the cooldown is active", %{conn: conn} do
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert_received {:email, _email}
conn =
post(build_conn(), ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox"
refute_received {:email, _email}
assert Repo.aggregate(Subscriber, :count) == 1
end
test "resends confirmation after the cooldown", %{conn: conn} do
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert_received {:email, _email}
subscriber = Repo.get_by(Subscriber, email: "player@example.com")
subscriber
|> Ecto.Changeset.change(
confirmation_sent_at: DateTime.add(DateTime.utc_now(:second), -11, :minute)
)
|> Repo.update!()
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert_received {:email, _email}
end
test "silently accepts a honeypot submission", %{conn: conn} do
conn =
post(conn, ~p"/mailing-list",
subscriber: %{
email: "player@example.com",
company: "spam.example",
form_token: form_token()
}
)
assert redirected_to(conn) == "/#mailing-list"
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "Check your inbox"
refute_received {:email, _email}
assert Repo.aggregate(Subscriber, :count) == 0
end
test "rejects a form token submitted too quickly", %{conn: conn} do
conn =
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: MailingListFormToken.sign()}
)
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "refresh the page"
refute_received {:email, _email}
assert Repo.aggregate(Subscriber, :count) == 0
end
test "rejects an expired form token", %{conn: conn} do
token = MailingListFormToken.sign(System.system_time(:second) - 3 * 60 * 60)
conn =
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: token}
)
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "refresh the page"
refute_received {:email, _email}
end
test "rejects an invalid form token", %{conn: conn} do
conn =
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: "oops"}
)
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "refresh the page"
refute_received {:email, _email}
end
test "does not email an address that has already confirmed", %{conn: conn} do
post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
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", form_token: form_token()}
)
assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "already on the mailing list" assert Phoenix.Flash.get(conn.assigns.flash, :info) =~ "already on the mailing list"
refute_received {:email, _email} refute_received {:email, _email}
end end
test "reports an invalid address", %{conn: conn} do test "reports an invalid address", %{conn: conn} do
conn = post(conn, ~p"/mailing-list", subscriber: %{email: "not an email"}) conn =
post(conn, ~p"/mailing-list",
subscriber: %{email: "not an email", form_token: form_token()}
)
assert redirected_to(conn) == "/#mailing-list" assert redirected_to(conn) == "/#mailing-list"
assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "valid email address" assert Phoenix.Flash.get(conn.assigns.flash, :error) =~ "valid email address"
@@ -60,7 +173,10 @@ defmodule ChesstrainerWeb.MailingListControllerTest do
describe "GET /mailing-list/confirm/:token" do describe "GET /mailing-list/confirm/:token" do
test "confirms the subscription from the emailed link", %{conn: conn} do test "confirms the subscription from the emailed link", %{conn: conn} do
post(conn, ~p"/mailing-list", subscriber: %{email: "player@example.com"}) post(conn, ~p"/mailing-list",
subscriber: %{email: "player@example.com", form_token: form_token()}
)
assert_received {:email, email} assert_received {:email, email}
conn = get(build_conn(), "/mailing-list/confirm/#{extract_token(email)}") conn = get(build_conn(), "/mailing-list/confirm/#{extract_token(email)}")
@@ -107,4 +223,8 @@ defmodule ChesstrainerWeb.MailingListControllerTest do
[_, token] = Regex.run(~r{/mailing-list/confirm/(\S+)}, email.text_body) [_, token] = Regex.run(~r{/mailing-list/confirm/(\S+)}, email.text_body)
token token
end end
defp form_token do
MailingListFormToken.sign(System.system_time(:second) - 5)
end
end end
@@ -194,6 +194,9 @@ defmodule ChesstrainerWeb.PageControllerTest do
assert html =~ "Join the list" assert html =~ "Join the list"
assert html =~ ~s(name="_csrf_token") assert html =~ ~s(name="_csrf_token")
assert html =~ ~s(name="subscriber[form_token]")
assert html =~ ~s(id="mailing-list-company")
assert html =~ ~s(class="mailing-list-honeypot")
end end
test "guest navbar links to log in and register", %{conn: conn} do test "guest navbar links to log in and register", %{conn: conn} do
@@ -4,6 +4,9 @@ defmodule ChesstrainerWeb.UserLive.ProfileTest do
alias Chesstrainer.Accounts alias Chesstrainer.Accounts
alias Chesstrainer.Accounts.Scope alias Chesstrainer.Accounts.Scope
alias Chesstrainer.Attempts alias Chesstrainer.Attempts
alias Chesstrainer.MailingList
alias Chesstrainer.MailingList.Subscriber
alias Chesstrainer.Repo
import Phoenix.LiveViewTest import Phoenix.LiveViewTest
import Chesstrainer.AccountsFixtures import Chesstrainer.AccountsFixtures
import Chesstrainer.EndgamesFixtures import Chesstrainer.EndgamesFixtures
@@ -303,4 +306,38 @@ defmodule ChesstrainerWeb.UserLive.ProfileTest do
assert message == "You must log in to access this page." assert message == "You must log in to access this page."
end end
end end
describe "mailing list settings" do
setup %{conn: conn} do
user = user_fixture()
%{conn: log_in_user(conn, user), user: user}
end
test "shows the not-subscribed state", %{conn: conn} do
{:ok, view, html} = live(conn, ~p"/users/profile/settings")
assert has_element?(view, "#mailing-list-settings")
assert html =~ "not subscribed"
refute has_element?(view, "#unsubscribe-mailing-list")
end
test "unsubscribes a subscribed user", %{conn: conn, user: user} do
{:ok, _subscriber} = MailingList.subscribe_user(user)
MailingList.confirm_user_subscription(user)
{:ok, view, _html} = live(conn, ~p"/users/profile/settings")
assert has_element?(view, "#unsubscribe-mailing-list")
html = view |> element("#unsubscribe-mailing-list") |> render_click()
assert html =~ "removed from the mailing list"
refute has_element?(view, "#unsubscribe-mailing-list")
assert %Subscriber{unsubscribed_at: unsubscribed_at} =
Repo.get_by(Subscriber, user_id: user.id)
assert unsubscribed_at
end
end
end end