Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Extend existing invite accept and reject flows to support team invitations (#4953)
Adrian Gruntkowski71d442a9a27f
diff --git a/lib/plausible/site/memberships/accept_invitation.ex b/lib/plausible/site/memberships/accept_invitation.exindex 8c4136d0dc..b03ec97ec3 100644--- a/lib/plausible/site/memberships/accept_invitation.ex+++ b/lib/plausible/site/memberships/accept_invitation.ex@@ -28,6 +28,7 @@ defmodule Plausible.Site.Memberships.AcceptInvitation do@type accept_error() :::invitation_not_found+ | :already_other_team_member| Billing.Quota.Limits.over_limits_error()| Ecto.Changeset.t()| :no_plan@@ -59,8 +60,11 @@ defmodule Plausible.Site.Memberships.AcceptInvitation do%Teams.SiteTransfer{} = site_transfer ->do_accept_ownership_transfer(site_transfer, user)+ %Teams.Invitation{} = team_invitation ->+ do_accept_team_invitation(team_invitation, user)+%Teams.GuestInvitation{} = guest_invitation ->- do_accept_invitation(guest_invitation, user)+ do_accept_guest_invitation(guest_invitation, user)endendend@@ -103,7 +107,21 @@ defmodule Plausible.Site.Memberships.AcceptInvitation doendend- defp do_accept_invitation(guest_invitation, user) do+ defp do_accept_guest_invitation(guest_invitation, user) doTeams.Invitations.accept_guest_invitation(guest_invitation, user)end++ defp do_accept_team_invitation(team_invitation, user) do+ with :ok <- ensure_no_other_team_membership(team_invitation.team, user) do+ Teams.Invitations.accept_team_invitation(team_invitation, user)+ end+ end++ defp ensure_no_other_team_membership(team, user) do+ if Teams.Users.team_member?(user, except: [team.id]) do+ {:error, :already_other_team_member}+ else+ :ok+ end+ endenddiff --git a/lib/plausible/site/memberships/reject_invitation.ex b/lib/plausible/site/memberships/reject_invitation.exindex d1cca277f8..2ecff342a6 100644--- a/lib/plausible/site/memberships/reject_invitation.ex+++ b/lib/plausible/site/memberships/reject_invitation.ex@@ -17,6 +17,12 @@ defmodule Plausible.Site.Memberships.RejectInvitation doendend+ defp do_reject(%Teams.Invitation{} = team_invitation) do+ Teams.Invitations.remove_team_invitation(team_invitation)++ notify_team_invitation_rejected(team_invitation)+ end+defp do_reject(%Teams.GuestInvitation{} = guest_invitation) doTeams.Invitations.remove_guest_invitation(guest_invitation)@@ -35,7 +41,12 @@ defmodule Plausible.Site.Memberships.RejectInvitation doenddefp notify_guest_invitation_rejected(guest_invitation) do- PlausibleWeb.Email.invitation_rejected(guest_invitation)+ PlausibleWeb.Email.guest_invitation_rejected(guest_invitation)+ |> Plausible.Mailer.send()+ end++ defp notify_team_invitation_rejected(team_invitation) do+ PlausibleWeb.Email.team_invitation_rejected(team_invitation)|> Plausible.Mailer.send()endenddiff --git a/lib/plausible/teams/invitations.ex b/lib/plausible/teams/invitations.exindex 9f5129ca12..9d3cd32d60 100644--- a/lib/plausible/teams/invitations.ex+++ b/lib/plausible/teams/invitations.ex@@ -11,7 +11,9 @@ defmodule Plausible.Teams.Invitations dodef find_for_user(invitation_or_transfer_id, user) dowith {:error, :invitation_not_found} <-- find_invitation_for_user(invitation_or_transfer_id, user) do+ find_team_invitation_for_user(invitation_or_transfer_id, user),+ {:error, :invitation_not_found} <-+ find_guest_invitation_for_user(invitation_or_transfer_id, user) dofind_transfer_for_user(invitation_or_transfer_id, user)endend@@ -23,7 +25,26 @@ defmodule Plausible.Teams.Invitations doendend- defp find_invitation_for_user(guest_invitation_id, user) do+ defp find_team_invitation_for_user(team_invitation_id, 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.invitation_id == ^team_invitation_id,+ where: ti.email == ^user.email,+ 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++ defp find_guest_invitation_for_user(guest_invitation_id, user) doinvitation_query =from gi in Teams.GuestInvitation,inner_join: s in assoc(gi, :site),@@ -110,6 +131,15 @@ defmodule Plausible.Teams.Invitations doendend+ def remove_team_invitation(team_invitation) do+ Repo.delete_all(+ from ti in Teams.Invitation,+ where: ti.id == ^team_invitation.id+ )++ :ok+ end+def remove_guest_invitation(guest_invitation) dosite = Repo.preload(guest_invitation, site: :team).site@@ -162,11 +192,14 @@ defmodule Plausible.Teams.Invitations donow = NaiveDateTime.utc_now(:second)- with {:ok, team_membership} <-- do_accept(team_invitation, user, now, guest_invitations: [guest_invitation]) do- prune_guest_invitations(team_invitation.team)- {:ok, team_membership}- end+ do_accept(team_invitation, user, now, guest_invitations: [guest_invitation])+ end++ def accept_team_invitation(team_invitation, user) do+ team_invitation = Repo.preload(team_invitation, [:team, :inviter])+ now = NaiveDateTime.utc_now(:second)++ do_accept(team_invitation, user, now, guest_invitations: [])end@doc false@@ -232,8 +265,17 @@ defmodule Plausible.Teams.Invitations do# Clean up guest invitations after acceptingguest_invitation_ids = Enum.map(guest_invitations, & &1.id)Repo.delete_all(from gi in Teams.GuestInvitation, where: gi.id in ^guest_invitation_ids)++ if team_membership.role != :guest do+ Repo.delete_all(from ti in Teams.Invitation, where: ti.id == ^team_invitation.id)+ end+prune_guest_invitations(team_invitation.team)+ # Prune guest memberships if any exist when team membership role+ # is other than guest+ maybe_prune_guest_memberships(team_membership)+if send_email? dosend_invitation_accepted_email(team_invitation, guest_invitations)end@@ -245,6 +287,16 @@ defmodule Plausible.Teams.Invitations doend)end+ defp maybe_prune_guest_memberships(%Teams.Membership{role: :guest}), do: :ok++ defp maybe_prune_guest_memberships(%Teams.Membership{} = team_membership) do+ team_membership+ |> Ecto.assoc(:guest_memberships)+ |> Repo.delete_all()++ :ok+ end+defp transfer_site_ownership(site, team, now) dosite =Repo.preload(site, [@@ -577,11 +629,29 @@ defmodule Plausible.Teams.Invitations doPlausible.Mailer.send(email)end+ @team_role_type Plausible.Teams.Membership.__schema__(:type, :role)+defp create_team_membership(team, role, user, now) do+ conflict_query =+ from(tm in Teams.Membership,+ update: [+ set: [+ updated_at: ^now,+ role:+ fragment(+ "CASE WHEN ? = 'guest' THEN ? ELSE ? END",+ tm.role,+ type(^role, ^@team_role_type),+ tm.role+ )+ ]+ ]+ )+team|> Teams.Membership.changeset(user, role)|> Repo.insert(- on_conflict: [set: [updated_at: now]],+ on_conflict: conflict_query,conflict_target: [:team_id, :user_id],returning: true)@@ -613,14 +683,15 @@ defmodule Plausible.Teams.Invitations doend)end- defp send_invitation_accepted_email(_team_invitation, []) do- # NOOP for now- :ok+ defp send_invitation_accepted_email(team_invitation, []) do+ team_invitation.inviter.email+ |> PlausibleWeb.Email.team_invitation_accepted(team_invitation.email, team_invitation.team)+ |> Plausible.Mailer.send()enddefp send_invitation_accepted_email(team_invitation, [guest_invitation | _]) doteam_invitation.inviter.email- |> PlausibleWeb.Email.invitation_accepted(team_invitation.email, guest_invitation.site)+ |> PlausibleWeb.Email.guest_invitation_accepted(team_invitation.email, guest_invitation.site)|> Plausible.Mailer.send()enddiff --git a/lib/plausible/teams/users.ex b/lib/plausible/teams/users.exindex e870127268..bd2144bde8 100644--- a/lib/plausible/teams/users.ex+++ b/lib/plausible/teams/users.ex@@ -8,6 +8,19 @@ defmodule Plausible.Teams.Users doalias Plausible.Repoalias Plausible.Teams+ def team_member?(user, opts \\ []) do+ excluded_team_ids = Keyword.get(opts, :except, [])++ Repo.exists?(+ from(+ tm in Teams.Membership,+ where: tm.user_id == ^user.id,+ where: tm.role != :guest,+ where: tm.team_id not in ^excluded_team_ids+ )+ )+ end+def has_sites?(user, opts \\ []) doinclude_pending? = Keyword.get(opts, :include_pending?, false)diff --git a/lib/plausible_web/controllers/invitation_controller.ex b/lib/plausible_web/controllers/invitation_controller.exindex 4fc675e49b..34a45b05a5 100644--- a/lib/plausible_web/controllers/invitation_controller.ex+++ b/lib/plausible_web/controllers/invitation_controller.ex@@ -27,6 +27,11 @@ defmodule PlausibleWeb.InvitationController do|> put_flash(:error, "Invitation missing or already accepted")|> redirect(to: "/sites")+ {:error, :already_other_team_member} ->+ conn+ |> put_flash(:error, "You already are a team member in another team")+ |> redirect(to: "/sites")+{:error, :no_plan} ->conn|> put_flash(:error, "No existing subscription")diff --git a/lib/plausible_web/email.ex b/lib/plausible_web/email.exindex af0bc5f8a1..260c5f23cc 100644--- a/lib/plausible_web/email.ex+++ b/lib/plausible_web/email.ex@@ -299,32 +299,56 @@ defmodule PlausibleWeb.Email do)end- def invitation_accepted(inviter_email, invitee_email, site) do+ def guest_invitation_accepted(inviter_email, invitee_email, site) dopriority_email()|> to(inviter_email)- |> tag("invitation-accepted")+ |> tag("guest-invitation-accepted")|> subject("[#{Plausible.product_name()}] #{invitee_email} accepted your invitation to #{site.domain}")- |> render("invitation_accepted.html",+ |> render("guest_invitation_accepted.html",invitee_email: invitee_email,site: site)end- def invitation_rejected(guest_invitation) do+ def team_invitation_accepted(inviter_email, invitee_email, team) do+ priority_email()+ |> to(inviter_email)+ |> tag("team-invitation-accepted")+ |> subject(+ "[#{Plausible.product_name()}] #{invitee_email} accepted your invitation to \"#{team.name}\" team"+ )+ |> render("team_invitation_accepted.html",+ invitee_email: invitee_email,+ team: team+ )+ end++ def guest_invitation_rejected(guest_invitation) dopriority_email()|> to(guest_invitation.team_invitation.inviter.email)- |> tag("invitation-rejected")+ |> tag("guest-invitation-rejected")|> subject("[#{Plausible.product_name()}] #{guest_invitation.team_invitation.email} rejected your invitation to #{guest_invitation.site.domain}")- |> render("invitation_rejected.html",- user: guest_invitation.team_invitation.inviter,+ |> render("guest_invitation_rejected.html",guest_invitation: guest_invitation)end+ def team_invitation_rejected(team_invitation) do+ priority_email()+ |> to(team_invitation.inviter.email)+ |> tag("team-invitation-rejected")+ |> subject(+ "[#{Plausible.product_name()}] #{team_invitation.email} rejected your invitation to \"#{team_invitation.team.name}\" team"+ )+ |> render("team_invitation_rejected.html",+ team_invitation: team_invitation+ )+ end+def ownership_transfer_accepted(new_owner_email, inviter_email, site) dopriority_email()|> to(inviter_email)diff --git a/lib/plausible_web/templates/email/invitation_accepted.html.heex b/lib/plausible_web/templates/email/guest_invitation_accepted.html.heexsimilarity index 100%rename from lib/plausible_web/templates/email/invitation_accepted.html.heexrename to lib/plausible_web/templates/email/guest_invitation_accepted.html.heexdiff --git a/lib/plausible_web/templates/email/invitation_rejected.html.heex b/lib/plausible_web/templates/email/guest_invitation_rejected.html.heexsimilarity index 100%rename from lib/plausible_web/templates/email/invitation_rejected.html.heexrename to lib/plausible_web/templates/email/guest_invitation_rejected.html.heexdiff --git a/lib/plausible_web/templates/email/team_invitation_accepted.html.heex b/lib/plausible_web/templates/email/team_invitation_accepted.html.heexnew file mode 100644index 0000000000..d608ac8a8c--- /dev/null+++ b/lib/plausible_web/templates/email/team_invitation_accepted.html.heex@@ -0,0 +1,2 @@+<%= @invitee_email %> has accepted your invitation to "<%= @team.name %>" team.+<a href={Routes.settings_url(PlausibleWeb.Endpoint, :team_general)}>Click here</a> to view team settings.diff --git a/lib/plausible_web/templates/email/team_invitation_rejected.html.heex b/lib/plausible_web/templates/email/team_invitation_rejected.html.heexnew file mode 100644index 0000000000..980f5dcccc--- /dev/null+++ b/lib/plausible_web/templates/email/team_invitation_rejected.html.heex@@ -0,0 +1,2 @@+<%= @team_invitation.email %> has rejected your invitation to \"<%= @team_invitation.team.name %>\" team.+<a href={Routes.settings_url(PlausibleWeb.Endpoint, :team_general)}>Click here</a> to view team settings.diff --git a/test/plausible/site/memberships/accept_invitation_test.exs b/test/plausible/site/memberships/accept_invitation_test.exsindex 2c84c16ae2..2814e2f335 100644--- a/test/plausible/site/memberships/accept_invitation_test.exs+++ b/test/plausible/site/memberships/accept_invitation_test.exs@@ -103,7 +103,106 @@ defmodule Plausible.Site.Memberships.AcceptInvitationTest doendend- describe "accept_invitation/3 - invitations" do+ describe "accept_invitation/3 - team invitations" do+ @roles Plausible.Teams.Membership.roles() -- [:guest]++ for role <- @roles do+ test "converts an invitation into a #{role} membership" do+ inviter = new_user()+ invitee = new_user()+ _site = new_site(owner: inviter)+ team = team_of(inviter)++ invitation = invite_member(team, invitee, inviter: inviter, role: unquote(role))++ assert {:ok, _} =+ AcceptInvitation.accept_invitation(invitation.invitation_id, invitee)++ assert_team_membership(invitee, team, unquote(role))++ assert_email_delivered_with(+ to: [nil: inviter.email],+ subject:+ @subject_prefix <>+ "#{invitee.email} accepted your invitation to \"#{team.name}\" team"+ )++ refute Repo.reload(invitation)+ end+ end++ @roles_with_downgrades @roles+ |> Enum.zip([nil] ++ @roles)+ |> Enum.drop(1)++ for {old_role, new_role} <- @roles_with_downgrades do+ test "does not degrade role when trying to invite existing #{old_role} as a(n) #{new_role}" do+ user = new_user()+ _site = new_site(owner: user)+ team = team_of(user)+ member = add_member(team, role: unquote(old_role))++ existing_team_membership =+ Plausible.Teams.Membership+ |> Repo.get_by(user_id: member.id)++ invitation = invite_member(team, member, inviter: user, role: unquote(new_role))++ assert {:ok, %{team_membership: new_team_membership, guest_memberships: []}} =+ AcceptInvitation.accept_invitation(invitation.invitation_id, member)++ new_team_membership = Repo.reload!(new_team_membership)+ assert existing_team_membership.id == new_team_membership.id+ assert existing_team_membership.user_id == new_team_membership.user_id+ assert new_team_membership.role == unquote(old_role)+ refute Repo.reload(invitation)+ end+ end++ for role <- @roles do+ test "does not allow accepting invite by a member of another team (role: #{role})" do+ user = new_user()+ _site = new_site(owner: user)+ team = team_of(user)+ another_site = new_site()+ member = add_member(another_site.team, role: unquote(role))++ invitation = invite_member(team, member, inviter: user, role: unquote(role))++ assert {:error, :already_other_team_member} =+ AcceptInvitation.accept_invitation(invitation.invitation_id, member)+ end+ end++ test "prunes guest memberships when promoting guest membership to full team membership" do+ user = new_user()+ member = new_user()+ site1 = new_site(owner: user)+ site2 = new_site(owner: user)+ team = team_of(user)++ add_guest(site1, user: member, role: :viewer)+ add_guest(site2, user: member, role: :editor)++ existing_team_membership =+ Plausible.Teams.Membership+ |> Repo.get_by(user_id: member.id)++ invitation = invite_member(team, member, inviter: user, role: :editor)++ assert {:ok, %{team_membership: new_team_membership, guest_memberships: []}} =+ AcceptInvitation.accept_invitation(invitation.invitation_id, member)++ new_team_membership = Repo.reload!(new_team_membership)+ assert existing_team_membership.id == new_team_membership.id+ assert existing_team_membership.user_id == new_team_membership.user_id+ assert new_team_membership.role == :editor+ assert [] = Repo.preload(new_team_membership, :guest_memberships).guest_memberships+ refute Repo.reload(invitation)+ end+ end++ describe "accept_invitation/3 - guest invitations" dotest "converts an invitation into a membership" doinviter = new_user()invitee = new_user()@@ -114,7 +213,7 @@ defmodule Plausible.Site.Memberships.AcceptInvitationTest doassert {:ok, _} =AcceptInvitation.accept_invitation(invitation.invitation_id, invitee)- assert_team_membership(invitee, site.team, :editor)+ assert_guest_membership(site.team, site, invitee, :editor)assert_email_delivered_with(to: [nil: inviter.email],diff --git a/test/plausible/site/memberships/reject_invitation_test.exs b/test/plausible/site/memberships/reject_invitation_test.exsindex 2c436fea3f..3d17da6ead 100644--- a/test/plausible/site/memberships/reject_invitation_test.exs+++ b/test/plausible/site/memberships/reject_invitation_test.exs@@ -8,7 +8,7 @@ defmodule Plausible.Site.Memberships.RejectInvitationTest doalias Plausible.Site.Memberships.RejectInvitation- test "rejects invitation and sends email to inviter" do+ test "rejects guest invitation and sends email to inviter" doinviter = new_user()invitee = new_user()site = new_site(owner: inviter)@@ -27,6 +27,47 @@ defmodule Plausible.Site.Memberships.RejectInvitationTest do)end+ test "rejects team invitation and sends email to inviter" do+ inviter = new_user()+ invitee = new_user()+ _site = new_site(owner: inviter)+ team = team_of(inviter)++ invitation = invite_member(team, invitee, inviter: inviter, role: :editor)++ assert {:ok, rejected_invitation} =+ RejectInvitation.reject_invitation(invitation.invitation_id, invitee)++ assert rejected_invitation.id == invitation.id+ refute Repo.reload(rejected_invitation)++ assert_email_delivered_with(+ to: [nil: inviter.email],+ subject:+ @subject_prefix <> "#{invitee.email} rejected your invitation to \"#{team.name}\" team"+ )+ end++ test "rejects site transfer and sends email to inviter" do+ inviter = new_user()+ invitee = new_user()+ site = new_site(owner: inviter)++ site_transfer = invite_transfer(site, invitee, inviter: inviter)++ assert {:ok, rejected_transfer} =+ RejectInvitation.reject_invitation(site_transfer.transfer_id, invitee)++ assert rejected_transfer.id == site_transfer.id+ refute Repo.reload(rejected_transfer)++ assert_email_delivered_with(+ to: [nil: inviter.email],+ subject:+ @subject_prefix <> "#{invitee.email} rejected the ownership transfer of #{site.domain}"+ )+ end+test "returns error for non-existent invitation" doinvitee = new_user()diff --git a/test/plausible_web/controllers/site/membership_controller_test.exs b/test/plausible_web/controllers/site/membership_controller_test.exsindex e4a7df5801..45a73ed6e8 100644--- a/test/plausible_web/controllers/site/membership_controller_test.exs+++ b/test/plausible_web/controllers/site/membership_controller_test.exs@@ -293,11 +293,11 @@ defmodule PlausibleWeb.Site.MembershipControllerTest dotest "updates a site member's role by user id", %{conn: conn, user: user} dosite = new_site(owner: user)collaborator = add_guest(site, role: :editor)- assert_team_membership(collaborator, site.team, :editor)+ assert_guest_membership(site.team, site, collaborator, :editor)put(conn, "/sites/#{site.domain}/memberships/u/#{collaborator.id}/role/viewer")- assert_team_membership(collaborator, site.team, :viewer)+ assert_guest_membership(site.team, site, collaborator, :viewer)endtest "can downgrade yourself from admin to viewer, redirects to stats", %{@@ -323,7 +323,7 @@ defmodule PlausibleWeb.Site.MembershipControllerTest doconn = put(conn, "/sites/#{site.domain}/memberships/u/#{admin.id}/role/owner")- assert_team_membership(user, site.team, :editor)+ assert_guest_membership(site.team, site, user, :editor)assert Phoenix.Flash.get(conn.assigns.flash, :error) =="You are not allowed to grant the owner role"@@ -356,7 +356,7 @@ defmodule PlausibleWeb.Site.MembershipControllerTest doconn = put(conn, "/sites/#{site.domain}/memberships/u/#{viewer.id}/role/editor")- assert_team_membership(viewer, site.team, :editor)+ assert_guest_membership(site.team, site, viewer, :editor)assert redirected_to(conn) == "/#{URI.encode_www_form(site.domain)}/settings/people"end@@ -366,7 +366,7 @@ defmodule PlausibleWeb.Site.MembershipControllerTest doconn = put(conn, "/sites/#{site.domain}/memberships/u/#{user.id}/role/owner")- assert_team_membership(user, site.team, :editor)+ assert_guest_membership(site.team, site, user, :editor)assert Phoenix.Flash.get(conn.assigns.flash, :error) =="You are not allowed to grant the owner role"diff --git a/test/support/teams/test.ex b/test/support/teams/test.exindex ef420db9ad..3e744fbdb9 100644--- a/test/support/teams/test.ex+++ b/test/support/teams/test.ex@@ -281,31 +281,14 @@ defmodule Plausible.Teams.Test doenddef assert_team_membership(user, team, role \\ :owner) do- if role == :owner do- assert membership =- Repo.get_by(Teams.Membership,- team_id: team.id,- user_id: user.id,- role: role- )-- membership- else- assert team_membership =- Repo.get_by(Teams.Membership,- team_id: team.id,- user_id: user.id,- role: :guest- )-- assert membership =- Repo.get_by(Teams.GuestMembership,- team_membership_id: team_membership.id,- role: role- )-- membership- end+ assert membership =+ Repo.get_by(Teams.Membership,+ team_id: team.id,+ user_id: user.id,+ role: role+ )++ membershipenddef assert_team_attached(site, team_id \\ nil) do