Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Accept after register via team invite (#5358)

Adrian Gruntkowski88a12055036a
diff --git a/lib/plausible/teams/invitations.ex b/lib/plausible/teams/invitations.ex
index 56ca688c9a..92826fa9f8 100644
--- a/lib/plausible/teams/invitations.ex
+++ b/lib/plausible/teams/invitations.ex
@@ -20,6 +20,29 @@ defmodule Plausible.Teams.Invitations do
end
end
+ @spec find_by_team_identifier(String.t() | nil, Plausible.Auth.User.t()) ::
+ {:ok, Teams.Invitation.t()} | {:error, :invitation_not_found}
+ def find_by_team_identifier(nil, _user), do: {:error, :invitation_not_found}
+
+ def find_by_team_identifier(team_identifier, user) do
+ invitation_query =
+ from ti in Teams.Invitation,
+ inner_join: inviter in assoc(ti, :inviter),
+ inner_join: team in assoc(ti, :team),
+ where: ti.email == ^user.email,
+ where: team.identifier == ^team_identifier,
+ where: ti.role != :guest,
+ preload: [inviter: inviter, team: team]
+
+ case Repo.one(invitation_query) do
+ nil ->
+ {:error, :invitation_not_found}
+
+ invitation ->
+ {:ok, invitation}
+ end
+ end
+
def find_for_user(invitation_or_transfer_id, user) do
with {:error, :invitation_not_found} <-
find_team_invitation_for_user(invitation_or_transfer_id, user),
diff --git a/lib/plausible_web/controllers/auth_controller.ex b/lib/plausible_web/controllers/auth_controller.ex
index 0b69318c9e..b490acc98d 100644
--- a/lib/plausible_web/controllers/auth_controller.ex
+++ b/lib/plausible_web/controllers/auth_controller.ex
@@ -94,12 +94,14 @@ defmodule PlausibleWeb.AuthController do
def activate_form(conn, params) do
user = conn.assigns.current_user
flow = params["flow"] || PlausibleWeb.Flows.register()
+ team_identifier = params["team_identifier"]
render(conn, "activate.html",
error: nil,
has_email_code?: Plausible.Users.has_email_code?(user),
has_any_memberships?: Plausible.Teams.Users.has_sites?(user),
- form_submit_url: "/activate?flow=#{flow}"
+ form_submit_url: "/activate?flow=#{flow}",
+ team_identifier: team_identifier
)
end
@@ -110,15 +112,21 @@ defmodule PlausibleWeb.AuthController do
has_any_memberships? = Plausible.Teams.Users.has_sites?(user, include_pending?: false)
flow = conn.params["flow"]
+ team_identifier = conn.params["team_identifier"]
case Auth.EmailVerification.verify_code(user, code) do
:ok ->
cond do
+ team_identifier not in ["", nil] ->
+ redirect_path = accept_team_invitation(conn, team_identifier, user, flow: flow)
+ redirect(conn, to: redirect_path)
+
has_any_memberships? ->
handle_email_updated(conn)
has_any_invitations? ->
- redirect(conn, to: Routes.site_path(conn, :index, flow: flow))
+ redirect_path = accept_team_invitation(conn, team_identifier, user, flow: flow)
+ redirect(conn, to: redirect_path)
true ->
redirect(conn, to: Routes.site_path(conn, :new, flow: flow))
@@ -242,10 +250,13 @@ defmodule PlausibleWeb.AuthController do
PlausibleWeb.Flows.invitation()
end
- Routes.auth_path(conn, :activate_form, flow: flow)
+ Routes.auth_path(conn, :activate_form,
+ flow: flow,
+ team_identifier: params["team_identifier"]
+ )
params["register_action"] == "register_from_invitation_form" ->
- Routes.site_path(conn, :index)
+ accept_team_invitation(conn, params["team_identifier"], user)
params["register_action"] == "register_form" ->
Routes.site_path(conn, :new)
@@ -286,6 +297,27 @@ defmodule PlausibleWeb.AuthController do
end
end
+ defp accept_team_invitation(conn, team_identifier, user, params \\ [])
+
+ defp accept_team_invitation(conn, no_identifier, _user, params)
+ when no_identifier in ["", nil] do
+ Routes.site_path(conn, :index, params)
+ end
+
+ defp accept_team_invitation(conn, team_identifier, user, extra_params) do
+ params = Keyword.merge([__team: team_identifier], extra_params)
+
+ # We try switching to the team no matter the invitation presence or acceptance outcome.
+ case Teams.Invitations.find_by_team_identifier(team_identifier, user) do
+ {:ok, invitation} ->
+ {_, _} = Teams.Invitations.accept_team_invitation(invitation, user)
+ Routes.site_path(conn, :index, params)
+
+ {:error, :invitation_not_found} ->
+ Routes.site_path(conn, :index, params)
+ end
+ end
+
defp check_2fa_verified(conn, user) do
if Auth.TOTP.enabled?(user) and not TwoFactor.Session.remember_2fa?(conn, user) do
{:error, {:unverified_2fa, user}}
diff --git a/lib/plausible_web/live/register_form.ex b/lib/plausible_web/live/register_form.ex
index 13c2c95657..69daed423c 100644
--- a/lib/plausible_web/live/register_form.ex
+++ b/lib/plausible_web/live/register_form.ex
@@ -11,11 +11,17 @@ defmodule PlausibleWeb.Live.RegisterForm do
def mount(params, _session, socket) do
socket =
- assign_new(socket, :invitation, fn ->
+ socket
+ |> assign_new(:invitation, fn ->
if invitation_id = params["invitation_id"] do
find_by_id_unified(invitation_id)
end
end)
+ |> assign_new(:team_identifier, fn %{invitation: invitation} ->
+ if invitation do
+ invitation.team_identifier
+ end
+ end)
if socket.assigns.live_action == :register_from_invitation_form and
socket.assigns.invitation == nil do
@@ -100,6 +106,12 @@ defmodule PlausibleWeb.Live.RegisterForm do
phx-trigger-action={@trigger_submit}
>
<input name="user[register_action]" type="hidden" value={@live_action} />
+ <input
+ :if={@team_identifier}
+ name="user[team_identifier]"
+ type="hidden"
+ value={@team_identifier}
+ />
<%= if @invitation do %>
<.email_input field={f[:email]} for_invitation={true} />
@@ -365,7 +377,7 @@ defmodule PlausibleWeb.Live.RegisterForm do
invitation =
Teams.Invitation
|> Repo.get_by(invitation_id: id)
- |> Repo.preload(:inviter)
+ |> Repo.preload(:team)
case invitation do
nil ->
@@ -375,7 +387,8 @@ defmodule PlausibleWeb.Live.RegisterForm do
{:ok,
%{
type: :team_invitation,
- email: team_invitation.email
+ email: team_invitation.email,
+ team_identifier: team_invitation.team.identifier
}}
end
end
@@ -384,7 +397,7 @@ defmodule PlausibleWeb.Live.RegisterForm do
invitation =
Teams.GuestInvitation
|> Repo.get_by(invitation_id: id)
- |> Repo.preload([:site, team_invitation: :inviter])
+ |> Repo.preload(:team_invitation)
case invitation do
nil ->
@@ -394,7 +407,8 @@ defmodule PlausibleWeb.Live.RegisterForm do
{:ok,
%{
type: :guest_invitation,
- email: guest_invitation.team_invitation.email
+ email: guest_invitation.team_invitation.email,
+ team_identifier: nil
}}
end
end
@@ -403,7 +417,6 @@ defmodule PlausibleWeb.Live.RegisterForm do
transfer =
Teams.SiteTransfer
|> Repo.get_by(transfer_id: id)
- |> Repo.preload([:site, :initiator])
case transfer do
nil ->
@@ -413,7 +426,8 @@ defmodule PlausibleWeb.Live.RegisterForm do
{:ok,
%{
type: :site_transfer,
- email: transfer.email
+ email: transfer.email,
+ team_identifier: nil
}}
end
end
diff --git a/lib/plausible_web/templates/auth/activate.html.heex b/lib/plausible_web/templates/auth/activate.html.heex
index 2cf24bca0b..c19b3cdebb 100644
--- a/lib/plausible_web/templates/auth/activate.html.heex
+++ b/lib/plausible_web/templates/auth/activate.html.heex
@@ -30,6 +30,7 @@
<div :if={@has_email_code?}>
<.form :let={f} for={@conn} action={@form_submit_url}>
+ <.input type="hidden" field={f[:team_identifier]} />
<.input
field={f[:code]}
class="tracking-widest font-medium shadow-sm focus:ring-indigo-500 focus:border-indigo-500 block w-36 px-8 border-gray-300 dark:border-gray-500 rounded-md dark:text-gray-200 dark:bg-gray-900 text-center"
diff --git a/test/plausible_web/controllers/auth_controller_test.exs b/test/plausible_web/controllers/auth_controller_test.exs
index dd4dc6d95a..61fa51133f 100644
--- a/test/plausible_web/controllers/auth_controller_test.exs
+++ b/test/plausible_web/controllers/auth_controller_test.exs
@@ -68,7 +68,7 @@ defmodule PlausibleWeb.AuthControllerTest do
}
)
- assert redirected_to(conn, 302) == "/activate?flow=register"
+ assert redirected_to(conn, 302) == "/activate?flow=register&team_identifier="
end
test "logs the user in", %{conn: conn} do
@@ -136,7 +136,8 @@ defmodule PlausibleWeb.AuthControllerTest do
password: "very-secret-and-very-long-123",
password_confirmation: "very-secret-and-very-long-123",
- register_action: "register_from_invitation_form"
+ register_action: "register_from_invitation_form",
+ team_identifier: ""
}
)
@@ -153,11 +154,31 @@ defmodule PlausibleWeb.AuthControllerTest do
password: "very-secret-and-very-long-123",
password_confirmation: "very-secret-and-very-long-123",
- register_action: "register_from_invitation_form"
+ register_action: "register_from_invitation_form",
+ team_identifier: ""
}
)
- assert redirected_to(conn, 302) == "/activate?flow=invitation"
+ assert redirected_to(conn, 302) == "/activate?flow=invitation&team_identifier="
+ end
+
+ test "user with team invite is redirected to activate page after registration", %{conn: conn} do
+ team_identifier = Ecto.UUID.generate()
+
+ conn =
+ post(conn, "/login",
+ user: %{
+ name: "Jane Doe",
+ email: "[email protected]",
+ password: "very-secret-and-very-long-123",
+ password_confirmation: "very-secret-and-very-long-123",
+ register_action: "register_from_invitation_form",
+ team_identifier: team_identifier
+ }
+ )
+
+ assert redirected_to(conn, 302) ==
+ "/activate?flow=invitation&team_identifier=#{team_identifier}"
end
test "logs the user in", %{conn: conn, user: user} do
@@ -168,12 +189,97 @@ defmodule PlausibleWeb.AuthControllerTest do
password: "very-secret-and-very-long-123",
password_confirmation: "very-secret-and-very-long-123",
- register_action: "register_from_invitation_form"
+ register_action: "register_from_invitation_form",
+ team_identifier: ""
+ }
+ )
+
+ assert %{sessions: [%{token: token}]} = user |> Repo.reload!() |> Repo.preload(:sessions)
+ assert get_session(conn, :user_token) == token
+ end
+
+ test "logs the user in and redirects to sites index when email is already verified", %{
+ conn: conn,
+ user: user
+ } do
+ user |> Ecto.Changeset.change(email_verified: true) |> Repo.update!()
+
+ conn =
+ post(conn, "/login",
+ user: %{
+ name: "Jane Doe",
+ email: "[email protected]",
+ password: "very-secret-and-very-long-123",
+ password_confirmation: "very-secret-and-very-long-123",
+ register_action: "register_from_invitation_form",
+ team_identifier: ""
+ }
+ )
+
+ assert %{sessions: [%{token: token}]} = user |> Repo.reload!() |> Repo.preload(:sessions)
+ assert get_session(conn, :user_token) == token
+ assert redirected_to(conn, 302) == Routes.site_path(conn, :index)
+ end
+
+ test "logs the user in, accepts team invite and redirects to team sites index", %{
+ conn: conn,
+ user: user
+ } do
+ owner = new_user()
+ _site = new_site(owner: owner)
+ team = team_of(owner)
+
+ invite_member(team, user, role: :viewer, inviter: owner)
+
+ user |> Ecto.Changeset.change(email_verified: true) |> Repo.update!()
+
+ conn =
+ post(conn, "/login",
+ user: %{
+ name: "Jane Doe",
+ email: "[email protected]",
+ password: "very-secret-and-very-long-123",
+ password_confirmation: "very-secret-and-very-long-123",
+ register_action: "register_from_invitation_form",
+ team_identifier: team.identifier
+ }
+ )
+
+ assert %{sessions: [%{token: token}]} = user |> Repo.reload!() |> Repo.preload(:sessions)
+ assert get_session(conn, :user_token) == token
+ assert redirected_to(conn, 302) == Routes.site_path(conn, :index, __team: team.identifier)
+
+ assert_team_membership(user, team, :viewer)
+ end
+
+ test "logs the user in and redirects to team sites index even when there's no matching team invite",
+ %{
+ conn: conn,
+ user: user
+ } do
+ owner = new_user()
+ _site = new_site(owner: owner)
+ team = team_of(owner)
+
+ add_member(team, user: user, role: :viewer)
+
+ user |> Ecto.Changeset.change(email_verified: true) |> Repo.update!()
+
+ conn =
+ post(conn, "/login",
+ user: %{
+ name: "Jane Doe",
+ email: "[email protected]",
+ password: "very-secret-and-very-long-123",
+ password_confirmation: "very-secret-and-very-long-123",
+ register_action: "register_from_invitation_form",
+ team_identifier: team.identifier
}
)
assert %{sessions: [%{token: token}]} = user |> Repo.reload!() |> Repo.preload(:sessions)
assert get_session(conn, :user_token) == token
+ assert redirected_to(conn, 302) == Routes.site_path(conn, :index, __team: team.identifier)
end
end
@@ -194,6 +300,18 @@ defmodule PlausibleWeb.AuthControllerTest do
assert html_response(conn, 200) =~ "Please enter the 4-digit code we sent to"
end
+
+ test "passes team identifier in form data", %{conn: conn, user: user} do
+ Auth.EmailVerification.issue_code(user)
+
+ team_identifier = Ecto.UUID.generate()
+
+ conn = get(conn, "/activate?team_identifier=#{team_identifier}")
+
+ assert html = html_response(conn, 200)
+
+ assert text_of_attr(html, "input[name=team_identifier]", "value") == team_identifier
+ end
end
describe "POST /activate/request-code" do
@@ -296,11 +414,51 @@ defmodule PlausibleWeb.AuthControllerTest do
verification = Repo.get_by!(Auth.EmailActivationCode, user_id: user.id)
- conn = post(conn, "/activate", %{code: verification.code})
+ conn = post(conn, "/activate", %{code: verification.code, team_identifier: ""})
assert redirected_to(conn) == "/sites?flow="
end
+ test "accepts team invite and redirects to team sites, if team provided", %{
+ conn: conn,
+ user: user
+ } do
+ owner = new_user()
+ _site = new_site(owner: owner)
+ team = team_of(owner)
+ invite_member(team, user, role: :viewer, inviter: owner)
+
+ Repo.update!(Auth.User.changeset(user, %{email_verified: false}))
+
+ {:ok, %{code: code}} = Auth.EmailVerification.issue_code(user)
+
+ conn = post(conn, "/activate", %{code: code, team_identifier: team.identifier})
+
+ assert redirected_to(conn) ==
+ Routes.site_path(conn, :index, __team: team.identifier, flow: "")
+
+ assert_team_membership(user, team, :viewer)
+ end
+
+ test "redirects to team sites if team provided, even if there's no invite", %{
+ conn: conn,
+ user: user
+ } do
+ owner = new_user()
+ _site = new_site(owner: owner)
+ team = team_of(owner)
+ add_member(team, user: user, role: :viewer)
+
+ Repo.update!(Auth.User.changeset(user, %{email_verified: false}))
+
+ {:ok, %{code: code}} = Auth.EmailVerification.issue_code(user)
+
+ conn = post(conn, "/activate", %{code: code, team_identifier: team.identifier})
+
+ assert redirected_to(conn) ==
+ Routes.site_path(conn, :index, __team: team.identifier, flow: "")
+ end
+
test "removes used up verification code", %{conn: conn, user: user} do
Repo.update!(Plausible.Auth.User.changeset(user, %{email_verified: false}))
post(conn, "/activate/request-code")
diff --git a/test/plausible_web/live/register_form_test.exs b/test/plausible_web/live/register_form_test.exs
index d500e89305..1230bbba88 100644
--- a/test/plausible_web/live/register_form_test.exs
+++ b/test/plausible_web/live/register_form_test.exs
@@ -215,6 +215,7 @@ defmodule PlausibleWeb.Live.RegisterFormTest do
assert [
csrf_input,
action_input,
+ team_input,
email_input,
name_input,
password_input,
@@ -223,6 +224,7 @@ defmodule PlausibleWeb.Live.RegisterFormTest do
assert String.length(text_of_attr(csrf_input, "value")) > 0
assert text_of_attr(action_input, "value") == "register_from_invitation_form"
+ assert text_of_attr(team_input, "value") == team.identifier
assert text_of_attr(name_input, "value") == "Mary Sue"
assert text_of_attr(email_input, "value") == "[email protected]"
assert text_of_attr(password_input, "value") == "very-long-and-very-secret-123"