Fix and refactor invitation logic (#3376)
* Make membership creation and role updates more explicit in terms of changesets * Extract invitation accept flow logic and refactor it slightly * Improve acceptation logic * Update moduledoc * Improve SiteLocker API and add typespecs * Stop naming function not returning a boolean like a predicate * Refactor rest of invitation actions and safeguard against rogue requests * Update code docs slightly * Extend `Billing.check_needs_update/1` tests * Parametrize selfhost flag and toggle SiteLocker logic on it * Add tests for newly extracted services * Add test case and a fix for locking site on grace period ended * Make invitation controller tests async as there's no more env patching * Add test cases for self-invites and fix one bug * Add and refactor tests for rejecting and removing invitations * Prevent issuing ownership transfer to existing owner * Improve name of the test * Improve `Billing.check_needs_to_upgrade/1` return value * Improve `Billing.SiteLocker.update_sites_for/1` and its tests * Fix typos Co-authored-by: hq1 <hq@mtod.org> * Make invitation removal and rejection resilient to races --------- Co-authored-by: hq1 <hq@mtod.org>pull/3382/head r2023.10.02-198
parent
082ec91c63
commit
e67850c11d
@ -0,0 +1,11 @@
|
||||
defmodule Plausible.Site.Memberships do
|
||||
@moduledoc """
|
||||
API for site memberships and invitations
|
||||
"""
|
||||
|
||||
alias Plausible.Site.Memberships
|
||||
|
||||
defdelegate accept_invitation(invitation_id, user), to: Memberships.AcceptInvitation
|
||||
defdelegate reject_invitation(invitation_id, user), to: Memberships.RejectInvitation
|
||||
defdelegate remove_invitation(invitation_id, site), to: Memberships.RemoveInvitation
|
||||
end
|
||||
@ -0,0 +1,163 @@
|
||||
defmodule Plausible.Site.Memberships.AcceptInvitation do
|
||||
@moduledoc """
|
||||
Service for accepting invitations, including ownership transfers.
|
||||
|
||||
Accepting invitation accounts for the fact that it's possible
|
||||
that accepting user has an existing membership for the site and
|
||||
acts permissively to not unnecessarily disrupt the flow while
|
||||
also maintaining integrity of site memberships. This also applies
|
||||
to cases where users update their email address between issuing
|
||||
the invitation and accepting it.
|
||||
"""
|
||||
|
||||
import Ecto.Query, only: [from: 2]
|
||||
|
||||
alias Ecto.Multi
|
||||
alias Plausible.Auth
|
||||
alias Plausible.Billing
|
||||
alias Plausible.Memberships.Invitations
|
||||
alias Plausible.Repo
|
||||
alias Plausible.Site
|
||||
alias Plausible.Site.Memberships.Invitations
|
||||
|
||||
require Logger
|
||||
|
||||
@spec accept_invitation(String.t(), Auth.User.t(), Keyword.t()) ::
|
||||
{:ok, Site.Membership.t()} | {:error, :invitation_not_found | Ecto.Changeset.t()}
|
||||
def accept_invitation(invitation_id, user, opts \\ []) do
|
||||
selfhost? = Keyword.get(opts, :selfhost?, Plausible.Release.selfhost?())
|
||||
|
||||
with {:ok, invitation} <- Invitations.find_for_user(invitation_id, user) do
|
||||
membership = get_or_create_membership(invitation, user)
|
||||
|
||||
multi =
|
||||
if invitation.role == :owner do
|
||||
add_and_transfer_ownership(invitation, membership, user, selfhost?)
|
||||
else
|
||||
add(invitation, membership, user)
|
||||
end
|
||||
|
||||
case Repo.transaction(multi) do
|
||||
{:ok, changes} ->
|
||||
if changes[:site_locker] == {:locked, :grace_period_ended_now} do
|
||||
Billing.SiteLocker.send_grace_period_end_email(changes.user)
|
||||
end
|
||||
|
||||
notify_invitation_accepted(invitation)
|
||||
|
||||
membership = Repo.preload(changes.membership, [:site, :user])
|
||||
|
||||
{:ok, membership}
|
||||
|
||||
{:error, _operation, error, _changes} ->
|
||||
{:error, error}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defp add_and_transfer_ownership(invitation, membership, user, selfhost?) do
|
||||
multi =
|
||||
Multi.new()
|
||||
|> downgrade_previous_owner(invitation.site, user)
|
||||
|> maybe_end_trial_of_new_owner(user, selfhost?)
|
||||
|> Multi.insert_or_update(:membership, membership)
|
||||
|> Multi.delete(:invitation, invitation)
|
||||
|
||||
if selfhost? do
|
||||
multi
|
||||
else
|
||||
Multi.run(multi, :site_locker, fn _, %{user: updated_user} ->
|
||||
{:ok, Billing.SiteLocker.update_sites_for(updated_user, send_email?: false)}
|
||||
end)
|
||||
end
|
||||
end
|
||||
|
||||
# If there's an existing membership, we DO NOT change the role
|
||||
# to avoid accidental role downgrade.
|
||||
defp add(invitation, membership, _user) do
|
||||
if membership.data.id do
|
||||
Multi.new()
|
||||
|> Multi.put(:membership, membership.data)
|
||||
|> Multi.delete(:invitation, invitation)
|
||||
else
|
||||
Multi.new()
|
||||
|> Multi.insert(:membership, membership)
|
||||
|> Multi.delete(:invitation, invitation)
|
||||
end
|
||||
end
|
||||
|
||||
defp get_or_create_membership(invitation, user) do
|
||||
case Repo.get_by(Site.Membership, user_id: user.id, site_id: invitation.site.id) do
|
||||
nil -> Site.Membership.new(invitation.site, user)
|
||||
membership -> membership
|
||||
end
|
||||
|> Site.Membership.set_role(invitation.role)
|
||||
end
|
||||
|
||||
# If the new owner is the same as old owner, we do not downgrade them
|
||||
# to avoid leaving site without an owner!
|
||||
defp downgrade_previous_owner(multi, site, new_owner) do
|
||||
new_owner_id = new_owner.id
|
||||
|
||||
previous_owner =
|
||||
Repo.one(
|
||||
from(
|
||||
sm in Site.Membership,
|
||||
where: sm.site_id == ^site.id,
|
||||
where: sm.role == :owner
|
||||
)
|
||||
)
|
||||
|
||||
case previous_owner do
|
||||
%{user_id: ^new_owner_id} ->
|
||||
Multi.put(multi, :previous_owner_membership, previous_owner)
|
||||
|
||||
nil ->
|
||||
Logger.warn(
|
||||
"Transferring ownership from a site with no owner: #{site.domain} " <>
|
||||
", new owner ID: #{new_owner_id}"
|
||||
)
|
||||
|
||||
Multi.put(multi, :previous_owner_membership, nil)
|
||||
|
||||
previous_owner ->
|
||||
Multi.update(
|
||||
multi,
|
||||
:previous_owner_membership,
|
||||
Site.Membership.set_role(previous_owner, :admin)
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
# If the new owner is the same as the old owner, it's a no-op
|
||||
defp maybe_end_trial_of_new_owner(multi, new_owner, selfhost?) do
|
||||
new_owner_id = new_owner.id
|
||||
|
||||
cond do
|
||||
selfhost? ->
|
||||
Multi.put(multi, :user, new_owner)
|
||||
|
||||
Billing.on_trial?(new_owner) or is_nil(new_owner.trial_expiry_date) ->
|
||||
Multi.update(multi, :user, fn
|
||||
%{previous_owner_membership: %{user_id: ^new_owner_id}} ->
|
||||
Ecto.Changeset.change(new_owner)
|
||||
|
||||
_ ->
|
||||
Auth.User.end_trial(new_owner)
|
||||
end)
|
||||
|
||||
true ->
|
||||
Multi.put(multi, :user, new_owner)
|
||||
end
|
||||
end
|
||||
|
||||
defp notify_invitation_accepted(%Auth.Invitation{role: :owner} = invitation) do
|
||||
PlausibleWeb.Email.ownership_transfer_accepted(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
|
||||
defp notify_invitation_accepted(invitation) do
|
||||
PlausibleWeb.Email.invitation_accepted(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,45 @@
|
||||
defmodule Plausible.Site.Memberships.Invitations do
|
||||
@moduledoc false
|
||||
|
||||
import Ecto.Query, only: [from: 2]
|
||||
|
||||
alias Plausible.Auth
|
||||
alias Plausible.Repo
|
||||
|
||||
@spec find_for_user(String.t(), Auth.User.t()) ::
|
||||
{:ok, Auth.Invitation.t()} | {:error, :invitation_not_found}
|
||||
def find_for_user(invitation_id, user) do
|
||||
invitation =
|
||||
Auth.Invitation
|
||||
|> Repo.get_by(invitation_id: invitation_id, email: user.email)
|
||||
|> Repo.preload([:site, :inviter])
|
||||
|
||||
if invitation do
|
||||
{:ok, invitation}
|
||||
else
|
||||
{:error, :invitation_not_found}
|
||||
end
|
||||
end
|
||||
|
||||
@spec find_for_site(String.t(), Plausible.Site.t()) ::
|
||||
{:ok, Auth.Invitation.t()} | {:error, :invitation_not_found}
|
||||
def find_for_site(invitation_id, site) do
|
||||
invitation =
|
||||
Auth.Invitation
|
||||
|> Repo.get_by(invitation_id: invitation_id, site_id: site.id)
|
||||
|> Repo.preload([:site, :inviter])
|
||||
|
||||
if invitation do
|
||||
{:ok, invitation}
|
||||
else
|
||||
{:error, :invitation_not_found}
|
||||
end
|
||||
end
|
||||
|
||||
@spec delete_invitation(Auth.Invitation.t()) :: :ok
|
||||
def delete_invitation(invitation) do
|
||||
Repo.delete_all(from(i in Auth.Invitation, where: i.id == ^invitation.id))
|
||||
|
||||
:ok
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,29 @@
|
||||
defmodule Plausible.Site.Memberships.RejectInvitation do
|
||||
@moduledoc """
|
||||
Service for rejecting invitations.
|
||||
"""
|
||||
|
||||
alias Plausible.Auth
|
||||
alias Plausible.Site.Memberships.Invitations
|
||||
|
||||
@spec reject_invitation(String.t(), Auth.User.t()) ::
|
||||
{:ok, Auth.Invitation.t()} | {:error, :invitation_not_found}
|
||||
def reject_invitation(invitation_id, user) do
|
||||
with {:ok, invitation} <- Invitations.find_for_user(invitation_id, user) do
|
||||
Invitations.delete_invitation(invitation)
|
||||
notify_invitation_rejected(invitation)
|
||||
|
||||
{:ok, invitation}
|
||||
end
|
||||
end
|
||||
|
||||
defp notify_invitation_rejected(%Auth.Invitation{role: :owner} = invitation) do
|
||||
PlausibleWeb.Email.ownership_transfer_rejected(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
|
||||
defp notify_invitation_rejected(invitation) do
|
||||
PlausibleWeb.Email.invitation_rejected(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,18 @@
|
||||
defmodule Plausible.Site.Memberships.RemoveInvitation do
|
||||
@moduledoc """
|
||||
Service for removing invitations.
|
||||
"""
|
||||
|
||||
alias Plausible.Auth
|
||||
alias Plausible.Site.Memberships.Invitations
|
||||
|
||||
@spec remove_invitation(String.t(), Plausible.Site.t()) ::
|
||||
{:ok, Auth.Invitation.t()} | {:error, :invitation_not_found}
|
||||
def remove_invitation(invitation_id, site) do
|
||||
with {:ok, invitation} <- Invitations.find_for_site(invitation_id, site) do
|
||||
Invitations.delete_invitation(invitation)
|
||||
|
||||
{:ok, invitation}
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -1,136 +1,54 @@
|
||||
defmodule PlausibleWeb.InvitationController do
|
||||
use PlausibleWeb, :controller
|
||||
use Plausible.Repo
|
||||
alias Ecto.Multi
|
||||
alias Plausible.Auth.Invitation
|
||||
alias Plausible.Site.Membership
|
||||
|
||||
plug PlausibleWeb.RequireAccountPlug
|
||||
|
||||
@require_owner [:remove_invitation]
|
||||
|
||||
plug PlausibleWeb.AuthorizeSiteAccess,
|
||||
[:owner, :admin] when action in @require_owner
|
||||
plug PlausibleWeb.AuthorizeSiteAccess, [:owner, :admin] when action in [:remove_invitation]
|
||||
|
||||
def accept_invitation(conn, %{"invitation_id" => invitation_id}) do
|
||||
invitation =
|
||||
Repo.get_by(Invitation, invitation_id: invitation_id)
|
||||
|> Repo.preload([:site, :inviter])
|
||||
|
||||
if invitation do
|
||||
user = conn.assigns[:current_user]
|
||||
existing_membership = Repo.get_by(Membership, user_id: user.id, site_id: invitation.site.id)
|
||||
|
||||
multi =
|
||||
if invitation.role == :owner do
|
||||
Multi.new()
|
||||
|> downgrade_previous_owner(invitation.site)
|
||||
|> maybe_end_trial_of_new_owner(user)
|
||||
else
|
||||
Multi.new()
|
||||
end
|
||||
|
||||
membership_changeset =
|
||||
(existing_membership ||
|
||||
%Membership{user_id: user.id, site_id: invitation.site.id})
|
||||
|> Membership.changeset(%{role: invitation.role})
|
||||
|
||||
multi =
|
||||
multi
|
||||
|> Multi.insert_or_update(:membership, membership_changeset)
|
||||
|> Multi.delete(:invitation, invitation)
|
||||
|
||||
case Repo.transaction(multi) do
|
||||
{:ok, changes} ->
|
||||
updated_user = Map.get(changes, :user, user)
|
||||
notify_invitation_accepted(invitation)
|
||||
Plausible.Billing.SiteLocker.check_sites_for(updated_user)
|
||||
|
||||
conn
|
||||
|> put_flash(:success, "You now have access to #{invitation.site.domain}")
|
||||
|> redirect(to: "/#{URI.encode_www_form(invitation.site.domain)}")
|
||||
|
||||
{:error, _operation, _value, _changes} ->
|
||||
conn
|
||||
|> put_flash(:error, "Something went wrong, please try again")
|
||||
|> redirect(to: "/sites")
|
||||
end
|
||||
else
|
||||
conn
|
||||
|> put_flash(:error, "Invitation missing or already accepted")
|
||||
|> redirect(to: "/sites")
|
||||
end
|
||||
end
|
||||
|
||||
defp downgrade_previous_owner(multi, site) do
|
||||
prev_owner =
|
||||
from(
|
||||
sm in Plausible.Site.Membership,
|
||||
where: sm.site_id == ^site.id,
|
||||
where: sm.role == :owner
|
||||
)
|
||||
|
||||
Multi.update_all(multi, :prev_owner, prev_owner, set: [role: :admin])
|
||||
end
|
||||
|
||||
defp maybe_end_trial_of_new_owner(multi, new_owner) do
|
||||
if Application.get_env(:plausible, :is_selfhost) do
|
||||
multi
|
||||
else
|
||||
end_trial_of_new_owner(multi, new_owner)
|
||||
end
|
||||
end
|
||||
|
||||
defp end_trial_of_new_owner(multi, new_owner) do
|
||||
if Plausible.Billing.on_trial?(new_owner) || is_nil(new_owner.trial_expiry_date) do
|
||||
Ecto.Multi.update(multi, :user, Plausible.Auth.User.end_trial(new_owner))
|
||||
else
|
||||
multi
|
||||
case Plausible.Site.Memberships.accept_invitation(invitation_id, conn.assigns.current_user) do
|
||||
{:ok, membership} ->
|
||||
conn
|
||||
|> put_flash(:success, "You now have access to #{membership.site.domain}")
|
||||
|> redirect(to: "/#{URI.encode_www_form(membership.site.domain)}")
|
||||
|
||||
{:error, :invitation_not_found} ->
|
||||
conn
|
||||
|> put_flash(:error, "Invitation missing or already accepted")
|
||||
|> redirect(to: "/sites")
|
||||
|
||||
{:error, _} ->
|
||||
conn
|
||||
|> put_flash(:error, "Something went wrong, please try again")
|
||||
|> redirect(to: "/sites")
|
||||
end
|
||||
end
|
||||
|
||||
def reject_invitation(conn, %{"invitation_id" => invitation_id}) do
|
||||
invitation =
|
||||
Repo.get_by!(Invitation, invitation_id: invitation_id)
|
||||
|> Repo.preload([:site, :inviter])
|
||||
|
||||
Repo.delete!(invitation)
|
||||
notify_invitation_rejected(invitation)
|
||||
|
||||
conn
|
||||
|> put_flash(:success, "You have rejected the invitation to #{invitation.site.domain}")
|
||||
|> redirect(to: "/sites")
|
||||
end
|
||||
|
||||
defp notify_invitation_accepted(%Invitation{role: :owner} = invitation) do
|
||||
PlausibleWeb.Email.ownership_transfer_accepted(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
|
||||
defp notify_invitation_accepted(invitation) do
|
||||
PlausibleWeb.Email.invitation_accepted(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
|
||||
defp notify_invitation_rejected(%Invitation{role: :owner} = invitation) do
|
||||
PlausibleWeb.Email.ownership_transfer_rejected(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
end
|
||||
|
||||
defp notify_invitation_rejected(invitation) do
|
||||
PlausibleWeb.Email.invitation_rejected(invitation)
|
||||
|> Plausible.Mailer.send()
|
||||
case Plausible.Site.Memberships.reject_invitation(invitation_id, conn.assigns.current_user) do
|
||||
{:ok, invitation} ->
|
||||
conn
|
||||
|> put_flash(:success, "You have rejected the invitation to #{invitation.site.domain}")
|
||||
|> redirect(to: "/sites")
|
||||
|
||||
{:error, :invitation_not_found} ->
|
||||
conn
|
||||
|> put_flash(:error, "Invitation missing or already accepted")
|
||||
|> redirect(to: "/sites")
|
||||
end
|
||||
end
|
||||
|
||||
def remove_invitation(conn, %{"invitation_id" => invitation_id}) do
|
||||
invitation =
|
||||
Repo.get_by!(Invitation, invitation_id: invitation_id, site_id: conn.assigns[:site].id)
|
||||
|> Repo.preload(:site)
|
||||
|
||||
Repo.delete!(invitation)
|
||||
|
||||
conn
|
||||
|> put_flash(:success, "You have removed the invitation for #{invitation.email}")
|
||||
|> redirect(to: Routes.site_path(conn, :settings_people, invitation.site.domain))
|
||||
case Plausible.Site.Memberships.remove_invitation(invitation_id, conn.assigns.site) do
|
||||
{:ok, invitation} ->
|
||||
conn
|
||||
|> put_flash(:success, "You have removed the invitation for #{invitation.email}")
|
||||
|> redirect(to: Routes.site_path(conn, :settings_people, invitation.site.domain))
|
||||
|
||||
{:error, :invitation_not_found} ->
|
||||
conn
|
||||
|> put_flash(:error, "Invitation missing or already removed")
|
||||
|> redirect(to: Routes.site_path(conn, :settings_people, conn.assigns.site.domain))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -0,0 +1,323 @@
|
||||
defmodule Plausible.Site.Memberships.AcceptInvitationTest do
|
||||
use Plausible.DataCase, async: true
|
||||
use Bamboo.Test
|
||||
|
||||
alias Plausible.Site.Memberships.AcceptInvitation
|
||||
|
||||
describe "invitations" do
|
||||
test "converts an invitation into a membership" do
|
||||
inviter = insert(:user)
|
||||
invitee = insert(:user)
|
||||
site = insert(:site, members: [inviter])
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: inviter,
|
||||
email: invitee.email,
|
||||
role: :admin
|
||||
)
|
||||
|
||||
assert {:ok, membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, invitee)
|
||||
|
||||
assert membership.site_id == site.id
|
||||
assert membership.user_id == invitee.id
|
||||
assert membership.role == :admin
|
||||
refute Repo.reload(invitation)
|
||||
|
||||
assert_email_delivered_with(
|
||||
to: [nil: inviter.email],
|
||||
subject:
|
||||
"[Plausible Analytics] #{invitee.email} accepted your invitation to #{site.domain}"
|
||||
)
|
||||
end
|
||||
|
||||
test "does not degrade role when trying to invite self as an owner" do
|
||||
site = insert(:site)
|
||||
user = insert(:user)
|
||||
membership = insert(:site_membership, user: user, site: site, role: :owner)
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: user,
|
||||
email: user.email,
|
||||
role: :admin
|
||||
)
|
||||
|
||||
assert {:ok, invited_membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, user)
|
||||
|
||||
assert invited_membership.id == membership.id
|
||||
membership = Repo.reload!(membership)
|
||||
assert membership.role == :owner
|
||||
assert membership.site_id == site.id
|
||||
assert membership.user_id == user.id
|
||||
refute Repo.reload(invitation)
|
||||
end
|
||||
|
||||
test "handles accepting invitation as already a member gracefully" do
|
||||
inviter = insert(:user)
|
||||
invitee = insert(:user)
|
||||
site = insert(:site, members: [inviter])
|
||||
existing_membership = insert(:site_membership, user: invitee, site: site, role: :admin)
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: inviter,
|
||||
email: invitee.email,
|
||||
role: :viewer
|
||||
)
|
||||
|
||||
assert {:ok, new_membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, invitee)
|
||||
|
||||
assert existing_membership.id == new_membership.id
|
||||
assert existing_membership.user_id == new_membership.user_id
|
||||
assert existing_membership.site_id == new_membership.site_id
|
||||
assert existing_membership.role == new_membership.role
|
||||
assert new_membership.role == :admin
|
||||
refute Repo.reload(invitation)
|
||||
end
|
||||
|
||||
test "returns an error on non-existent invitation" do
|
||||
invitee = insert(:user)
|
||||
|
||||
assert {:error, :invitation_not_found} =
|
||||
AcceptInvitation.accept_invitation("does_not_exist", invitee)
|
||||
end
|
||||
end
|
||||
|
||||
describe "ownership transfers" do
|
||||
for {label, opts} <- [{"cloud", []}, {"selfhosted", [selfhost?: true]}] do
|
||||
test "converts an ownership transfer into a membership on #{label} instance" do
|
||||
site = insert(:site)
|
||||
existing_owner = insert(:user)
|
||||
|
||||
existing_membership =
|
||||
insert(:site_membership, user: existing_owner, site: site, role: :owner)
|
||||
|
||||
new_owner = insert(:user)
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: existing_owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, new_membership} =
|
||||
AcceptInvitation.accept_invitation(
|
||||
invitation.invitation_id,
|
||||
new_owner,
|
||||
unquote(opts)
|
||||
)
|
||||
|
||||
assert new_membership.site_id == site.id
|
||||
assert new_membership.user_id == new_owner.id
|
||||
assert new_membership.role == :owner
|
||||
refute Repo.reload(invitation)
|
||||
|
||||
existing_membership = Repo.reload!(existing_membership)
|
||||
assert existing_membership.user_id == existing_owner.id
|
||||
assert existing_membership.site_id == site.id
|
||||
assert existing_membership.role == :admin
|
||||
|
||||
assert_email_delivered_with(
|
||||
to: [nil: existing_owner.email],
|
||||
subject:
|
||||
"[Plausible Analytics] #{new_owner.email} accepted the ownership transfer of #{site.domain}"
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
for role <- [:viewer, :admin] do
|
||||
test "upgrades existing #{role} membership into an owner" do
|
||||
site = insert(:site)
|
||||
owner = insert(:user)
|
||||
owner_membership = insert(:site_membership, user: owner, site: site, role: :owner)
|
||||
new_owner = insert(:user)
|
||||
|
||||
new_owner_membership =
|
||||
insert(:site_membership, user: new_owner, site: site, role: unquote(role))
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, new_owner)
|
||||
|
||||
assert membership.id == new_owner_membership.id
|
||||
assert membership.role == :owner
|
||||
|
||||
assert Repo.reload!(owner_membership).role == :admin
|
||||
refute Repo.reload(invitation)
|
||||
end
|
||||
end
|
||||
|
||||
test "does note degrade or alter trial when accepting ownership transfer by self" do
|
||||
site = insert(:site)
|
||||
owner = insert(:user, trial_expiry_date: nil)
|
||||
owner_membership = insert(:site_membership, user: owner, site: site, role: :owner)
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: owner,
|
||||
email: owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, owner)
|
||||
|
||||
assert membership.id == owner_membership.id
|
||||
assert membership.role == :owner
|
||||
assert Repo.reload!(owner).trial_expiry_date == nil
|
||||
|
||||
refute Repo.reload(invitation)
|
||||
end
|
||||
|
||||
test "locks the site if the new owner has no active subscription or trial" do
|
||||
site = insert(:site, locked: false)
|
||||
|
||||
existing_owner = insert(:user)
|
||||
insert(:site_membership, user: existing_owner, site: site, role: :owner)
|
||||
|
||||
new_owner = insert(:user, trial_expiry_date: Date.add(Date.utc_today(), -1))
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: existing_owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, _membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, new_owner)
|
||||
|
||||
assert Repo.reload!(site).locked
|
||||
end
|
||||
|
||||
test "does not lock the site or set trial expiry date if the instance is selfhosted" do
|
||||
site = insert(:site, locked: false)
|
||||
|
||||
existing_owner = insert(:user)
|
||||
insert(:site_membership, user: existing_owner, site: site, role: :owner)
|
||||
|
||||
new_owner = insert(:user, trial_expiry_date: nil)
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: existing_owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, _membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, new_owner,
|
||||
selfhost?: true
|
||||
)
|
||||
|
||||
assert Repo.reload!(new_owner).trial_expiry_date == nil
|
||||
refute Repo.reload!(site).locked
|
||||
end
|
||||
|
||||
test "ends trial of the new owner immediately" do
|
||||
site = insert(:site, locked: false)
|
||||
|
||||
existing_owner = insert(:user)
|
||||
insert(:site_membership, user: existing_owner, site: site, role: :owner)
|
||||
|
||||
new_owner = insert(:user, trial_expiry_date: Date.add(Date.utc_today(), 7))
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: existing_owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, _membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, new_owner)
|
||||
|
||||
assert Repo.reload!(new_owner).trial_expiry_date == Date.add(Date.utc_today(), -1)
|
||||
assert Repo.reload!(site).locked
|
||||
end
|
||||
|
||||
test "sets user's trial expiry date to yesterday if they don't have one" do
|
||||
site = insert(:site, locked: false)
|
||||
|
||||
existing_owner = insert(:user)
|
||||
insert(:site_membership, user: existing_owner, site: site, role: :owner)
|
||||
|
||||
new_owner = insert(:user, trial_expiry_date: nil)
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: existing_owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, _membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, new_owner)
|
||||
|
||||
assert Repo.reload!(new_owner).trial_expiry_date == Date.add(Date.utc_today(), -1)
|
||||
assert Repo.reload!(site).locked
|
||||
end
|
||||
|
||||
test "ends grace period and sends an email about it if new owner is past grace period" do
|
||||
site = insert(:site, locked: false)
|
||||
|
||||
existing_owner = insert(:user)
|
||||
insert(:site_membership, user: existing_owner, site: site, role: :owner)
|
||||
new_owner = insert(:user, trial_expiry_date: Date.add(Date.utc_today(), -1))
|
||||
insert(:subscription, user: new_owner, next_bill_date: Timex.today())
|
||||
|
||||
new_owner =
|
||||
new_owner
|
||||
|> Plausible.Auth.GracePeriod.start_changeset(100)
|
||||
|> then(fn changeset ->
|
||||
grace_period =
|
||||
changeset
|
||||
|> get_field(:grace_period)
|
||||
|> Map.put(:end_date, Date.add(Date.utc_today(), -1))
|
||||
|
||||
change(changeset, grace_period: grace_period)
|
||||
end)
|
||||
|> Repo.update!()
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: existing_owner,
|
||||
email: new_owner.email,
|
||||
role: :owner
|
||||
)
|
||||
|
||||
assert {:ok, _membership} =
|
||||
AcceptInvitation.accept_invitation(invitation.invitation_id, new_owner)
|
||||
|
||||
assert Repo.reload!(new_owner).grace_period.is_over
|
||||
assert Repo.reload!(site).locked
|
||||
|
||||
assert_email_delivered_with(
|
||||
to: [{"Jane Smith", new_owner.email}],
|
||||
subject: "[Action required] Your Plausible dashboard is now locked"
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,58 @@
|
||||
defmodule Plausible.Site.Memberships.RejectInvitationTest do
|
||||
use Plausible.DataCase, async: true
|
||||
use Bamboo.Test
|
||||
|
||||
alias Plausible.Site.Memberships.RejectInvitation
|
||||
|
||||
test "rejects invitation and sends email to inviter" do
|
||||
inviter = insert(:user)
|
||||
invitee = insert(:user)
|
||||
site = insert(:site, members: [inviter])
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: inviter,
|
||||
email: invitee.email,
|
||||
role: :admin
|
||||
)
|
||||
|
||||
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: "[Plausible Analytics] #{invitee.email} rejected your invitation to #{site.domain}"
|
||||
)
|
||||
end
|
||||
|
||||
test "returns error for non-existent invitation" do
|
||||
invitee = insert(:user)
|
||||
|
||||
assert {:error, :invitation_not_found} =
|
||||
RejectInvitation.reject_invitation("does_not_exist", invitee)
|
||||
end
|
||||
|
||||
test "does not allow rejecting invitation by anyone other than invitee" do
|
||||
inviter = insert(:user)
|
||||
invitee = insert(:user)
|
||||
other_user = insert(:user)
|
||||
site = insert(:site, members: [inviter])
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: inviter,
|
||||
email: invitee.email,
|
||||
role: :admin
|
||||
)
|
||||
|
||||
assert {:error, :invitation_not_found} =
|
||||
RejectInvitation.reject_invitation(invitation.invitation_id, other_user)
|
||||
|
||||
assert Repo.reload(invitation)
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,52 @@
|
||||
defmodule Plausible.Site.Memberships.RemoveInvitationTest do
|
||||
use Plausible.DataCase, async: true
|
||||
|
||||
alias Plausible.Site.Memberships.RemoveInvitation
|
||||
|
||||
test "removes invitation" do
|
||||
inviter = insert(:user)
|
||||
invitee = insert(:user)
|
||||
site = insert(:site, members: [inviter])
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: inviter,
|
||||
email: invitee.email,
|
||||
role: :admin
|
||||
)
|
||||
|
||||
assert {:ok, removed_invitation} =
|
||||
RemoveInvitation.remove_invitation(invitation.invitation_id, site)
|
||||
|
||||
assert removed_invitation.id == invitation.id
|
||||
refute Repo.reload(removed_invitation)
|
||||
end
|
||||
|
||||
test "returns error for non-existent invitation" do
|
||||
site = insert(:site)
|
||||
|
||||
assert {:error, :invitation_not_found} =
|
||||
RemoveInvitation.remove_invitation("does_not_exist", site)
|
||||
end
|
||||
|
||||
test "does not allow removing invitation from another site" do
|
||||
inviter = insert(:user)
|
||||
invitee = insert(:user)
|
||||
site = insert(:site, members: [inviter])
|
||||
other_site = insert(:site, members: [inviter])
|
||||
|
||||
invitation =
|
||||
insert(:invitation,
|
||||
site_id: site.id,
|
||||
inviter: inviter,
|
||||
email: invitee.email,
|
||||
role: :admin
|
||||
)
|
||||
|
||||
assert {:error, :invitation_not_found} =
|
||||
RemoveInvitation.remove_invitation(invitation.invitation_id, other_site)
|
||||
|
||||
assert Repo.reload(invitation)
|
||||
end
|
||||
end
|
||||
Loading…
Reference in New Issue