Skip to content

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

Finish moving /sites LV reads to team schemas behind FF (#4777)

Adrian Gruntkowski342c3e55138f
diff --git a/lib/plausible/auth/grace_period.ex b/lib/plausible/auth/grace_period.ex
index f1ab6fc37b..40c5df052f 100644
--- a/lib/plausible/auth/grace_period.ex
+++ b/lib/plausible/auth/grace_period.ex
@@ -74,7 +74,7 @@ defmodule Plausible.Auth.GracePeriod do
Ecto.Changeset.change(user, grace_period: nil)
end
- @spec active?(Plausible.Teams.Team.t() | User.t()) :: boolean()
+ @spec active?(User.t() | Plausible.Teams.Team.t()) :: boolean()
@doc """
Returns whether the grace period is still active for a User. Defaults to
false if the user is nil or there is no grace period.
@@ -91,12 +91,12 @@ defmodule Plausible.Auth.GracePeriod do
def active?(_user), do: false
- @spec expired?(User.t()) :: boolean()
+ @spec expired?(User.t() | Plausible.Teams.Team.t() | nil) :: boolean()
@doc """
Returns whether the grace period has already expired for a User. Defaults to
false if the user is nil or there is no grace period.
"""
- def expired?(user) do
- if user && user.grace_period, do: !active?(user), else: false
+ def expired?(user_or_team) do
+ if user_or_team && user_or_team.grace_period, do: !active?(user_or_team), else: false
end
end
diff --git a/lib/plausible/billing/feature.ex b/lib/plausible/billing/feature.ex
index 437d70d34c..ea699b5e8a 100644
--- a/lib/plausible/billing/feature.ex
+++ b/lib/plausible/billing/feature.ex
@@ -66,7 +66,7 @@ defmodule Plausible.Billing.Feature do
@doc """
Checks whether the site owner or the user plan includes the given feature.
"""
- @callback check_availability(Plausible.Auth.User.t()) ::
+ @callback check_availability(Plausible.Auth.User.t() | Plausible.Teams.Team.t() | nil) ::
:ok | {:error, :upgrade_required} | {:error, :not_implemented}
@features [
@@ -137,6 +137,14 @@ defmodule Plausible.Billing.Feature do
end
end
+ def check_availability(team_or_nil) do
+ cond do
+ free?() -> :ok
+ __MODULE__ in Plausible.Teams.Billing.allowed_features_for(team_or_nil) -> :ok
+ true -> {:error, :upgrade_required}
+ end
+ end
+
@impl true
def toggle(%Plausible.Site{} = site, opts \\ []) do
if toggle_field(), do: do_toggle(site, opts), else: :ok
diff --git a/lib/plausible/billing/site_locker.ex b/lib/plausible/billing/site_locker.ex
index de47bdefa0..ea0d22df35 100644
--- a/lib/plausible/billing/site_locker.ex
+++ b/lib/plausible/billing/site_locker.ex
@@ -16,6 +16,7 @@ defmodule Plausible.Billing.SiteLocker do
user = Plausible.Users.with_subscription(user)
+ # TODO: Use team version once we start switching writes.
case Plausible.Billing.check_needs_to_upgrade(user) do
{:needs_to_upgrade, :grace_period_ended} ->
set_lock_status_for(user, true)
diff --git a/lib/plausible/data_migration/backfill_teams.ex b/lib/plausible/data_migration/backfill_teams.ex
index c1a87a51e2..5ffe865a74 100644
--- a/lib/plausible/data_migration/backfill_teams.ex
+++ b/lib/plausible/data_migration/backfill_teams.ex
@@ -33,6 +33,8 @@ defmodule Plausible.DataMigration.BackfillTeams do
end
defp backfill(dry_run?) do
+ # Orphaned teams
+
orphaned_teams =
from(
t in Plausible.Teams.Team,
@@ -53,6 +55,8 @@ defmodule Plausible.DataMigration.BackfillTeams do
log("Deleted orphaned teams")
end
+ # Sites without teams
+
sites_without_teams =
from(
s in Plausible.Site,
@@ -80,6 +84,8 @@ defmodule Plausible.DataMigration.BackfillTeams do
select: 1
)
+ # Users with subscriptions without sites
+
users_with_subscriptions_without_sites =
from(
s in Plausible.Billing.Subscription,
@@ -102,6 +108,32 @@ defmodule Plausible.DataMigration.BackfillTeams do
log("Backfilled #{teams_count} teams from users with subscriptions without sites.")
end
+ # Users on trial without team
+
+ users_on_trial_without_team =
+ from(
+ u in Plausible.Auth.User,
+ as: :user,
+ where: not is_nil(u.trial_expiry_date),
+ where:
+ not exists(
+ from tm in Teams.Membership,
+ where: tm.role == :owner,
+ where: tm.user_id == parent_as(:user).id
+ )
+ )
+ |> @repo.all(timeout: :infinity)
+
+ log("Found #{length(users_on_trial_without_team)} users on trial without team...")
+
+ if not dry_run? do
+ Enum.each(users_on_trial_without_team, fn user ->
+ {:ok, _} = Teams.get_or_create(user)
+ end)
+
+ log("Created teams for all users on trial without a team.")
+ end
+
# Stale teams sync
stale_teams =
diff --git a/lib/plausible/site/memberships/invitations.ex b/lib/plausible/site/memberships/invitations.ex
index a333ea129a..ac11ecd5c1 100644
--- a/lib/plausible/site/memberships/invitations.ex
+++ b/lib/plausible/site/memberships/invitations.ex
@@ -8,7 +8,6 @@ defmodule Plausible.Site.Memberships.Invitations do
alias Plausible.Site
alias Plausible.Auth
alias Plausible.Repo
- alias Plausible.Billing.Quota
alias Plausible.Billing.Feature
@type missing_features_error() :: {:missing_features, [Feature.t()]}
@@ -65,6 +64,8 @@ defmodule Plausible.Site.Memberships.Invitations do
end
on_ee do
+ alias Plausible.Billing.Quota
+
@spec ensure_can_take_ownership(Site.t(), Auth.User.t()) ::
:ok | {:error, Quota.Limits.over_limits_error() | :no_plan}
def ensure_can_take_ownership(site, new_owner) do
@@ -88,22 +89,4 @@ defmodule Plausible.Site.Memberships.Invitations do
:ok
end
end
-
- @spec check_feature_access(Site.t(), Auth.User.t(), boolean()) ::
- :ok | {:error, missing_features_error()}
- def check_feature_access(_site, _new_owner, true = _selfhost?) do
- :ok
- end
-
- def check_feature_access(site, new_owner, false = _selfhost?) do
- missing_features =
- Quota.Usage.features_usage(nil, [site.id])
- |> Enum.filter(&(&1.check_availability(new_owner) != :ok))
-
- if missing_features == [] do
- :ok
- else
- {:error, {:missing_features, missing_features}}
- end
- end
end
diff --git a/lib/plausible/teams.ex b/lib/plausible/teams.ex
index 1b227d1670..438a0a697c 100644
--- a/lib/plausible/teams.ex
+++ b/lib/plausible/teams.ex
@@ -7,6 +7,24 @@ defmodule Plausible.Teams do
alias __MODULE__
alias Plausible.Repo
+ use Plausible
+
+ @spec on_trial?(Teams.Team.t()) :: boolean()
+ on_ee do
+ def on_trial?(%Teams.Team{trial_expiry_date: nil}), do: false
+
+ def on_trial?(team) do
+ team = with_subscription(team)
+ not Plausible.Billing.Subscriptions.active?(team.subscription) && trial_days_left(team) >= 0
+ end
+ else
+ def on_trial?(_), do: true
+ end
+
+ @spec trial_days_left(Teams.Team.t()) :: integer()
+ def trial_days_left(team) do
+ Date.diff(team.trial_expiry_date, Date.utc_today())
+ end
def read_team_schemas?(user) do
FunWithFlags.enabled?(:read_team_schemas, for: user)
@@ -54,13 +72,13 @@ defmodule Plausible.Teams do
is returned.
"""
def get_or_create(user) do
- with {:error, :no_team} <- get_owned_by_user(user) do
+ with {:error, :no_team} <- get_by_owner(user) do
case create_my_team(user) do
{:ok, team} ->
{:ok, team}
{:error, :exists_already} ->
- get_owned_by_user(user)
+ get_by_owner(user)
end
end
end
@@ -73,6 +91,25 @@ defmodule Plausible.Teams do
|> Repo.update!()
end
+ def get_by_owner(user) do
+ result =
+ from(tm in Teams.Membership,
+ inner_join: t in assoc(tm, :team),
+ where: tm.user_id == ^user.id and tm.role == :owner,
+ select: t,
+ order_by: t.id
+ )
+ |> Repo.one()
+
+ case result do
+ nil ->
+ {:error, :no_team}
+
+ team ->
+ {:ok, team}
+ end
+ end
+
defp create_my_team(user) do
team =
"My Team"
@@ -99,25 +136,6 @@ defmodule Plausible.Teams do
end
end
- defp get_owned_by_user(user) do
- result =
- from(tm in Teams.Membership,
- inner_join: t in assoc(tm, :team),
- where: tm.user_id == ^user.id and tm.role == :owner,
- select: t,
- order_by: t.id
- )
- |> Repo.one()
-
- case result do
- nil ->
- {:error, :no_team}
-
- team ->
- {:ok, team}
- end
- end
-
defp last_subscription_query() do
from(subscription in Plausible.Billing.Subscription,
order_by: [desc: subscription.inserted_at],
diff --git a/lib/plausible/teams/billing.ex b/lib/plausible/teams/billing.ex
index 2cd5aec8a0..d9d2fbdec4 100644
--- a/lib/plausible/teams/billing.ex
+++ b/lib/plausible/teams/billing.ex
@@ -9,10 +9,39 @@ defmodule Plausible.Teams.Billing do
alias Plausible.Repo
alias Plausible.Teams
+ alias Plausible.Billing.{Plan, Plans, EnterprisePlan, Feature}
+ alias Plausible.Billing.Feature.{Goals, Props, StatsAPI}
+
@team_member_limit_for_trials 3
@limit_sites_since ~D[2021-05-05]
@site_limit_for_trials 10
+ def check_needs_to_upgrade(nil), do: {:needs_to_upgrade, :no_trial}
+
+ def check_needs_to_upgrade(team) do
+ team = Teams.with_subscription(team)
+
+ trial_over? =
+ not is_nil(team.trial_expiry_date) and
+ Date.before?(team.trial_expiry_date, Date.utc_today())
+
+ subscription_active? = Subscriptions.active?(team.subscription)
+
+ cond do
+ is_nil(team.trial_expiry_date) and not subscription_active? ->
+ {:needs_to_upgrade, :no_trial}
+
+ trial_over? and not subscription_active? ->
+ {:needs_to_upgrade, :no_active_subscription}
+
+ Plausible.Auth.GracePeriod.expired?(team) ->
+ {:needs_to_upgrade, :grace_period_ended}
+
+ true ->
+ :no_upgrade_needed
+ end
+ end
+
def ensure_can_add_new_site(team) do
team = Teams.with_subscription(team)
@@ -232,4 +261,30 @@ defmodule Plausible.Teams.Billing do
|> union(^team_memberships_q)
|> union(^team_invitations_q)
end
+
+ def allowed_features_for(nil) do
+ [Goals]
+ end
+
+ def allowed_features_for(team) do
+ team = Teams.with_subscription(team)
+
+ case Plans.get_subscription_plan(team.subscription) do
+ %EnterprisePlan{features: features} ->
+ features
+
+ %Plan{features: features} ->
+ features
+
+ :free_10k ->
+ [Goals, Props, StatsAPI]
+
+ nil ->
+ if Teams.on_trial?(team) do
+ Feature.list()
+ else
+ [Goals]
+ end
+ end
+ end
end
diff --git a/lib/plausible/teams/invitations.ex b/lib/plausible/teams/invitations.ex
index 232d9bddec..717c75a26d 100644
--- a/lib/plausible/teams/invitations.ex
+++ b/lib/plausible/teams/invitations.ex
@@ -409,16 +409,9 @@ defmodule Plausible.Teams.Invitations do
:ok
end
- defp send_transfer_accepted_email(site_transfer) do
- PlausibleWeb.Email.ownership_transfer_accepted(
- site_transfer.email,
- site_transfer.initiator.email,
- site_transfer.site
- )
- |> Plausible.Mailer.send()
- end
+ def ensure_can_take_ownership(_site, nil), do: {:error, :no_plan}
- defp ensure_can_take_ownership(site, team) do
+ def ensure_can_take_ownership(site, team) do
team = Teams.with_subscription(team)
plan = Billing.Plans.get_subscription_plan(team.subscription)
active_subscription? = Billing.Subscriptions.active?(team.subscription)
@@ -432,6 +425,15 @@ defmodule Plausible.Teams.Invitations do
end
end
+ defp send_transfer_accepted_email(site_transfer) do
+ PlausibleWeb.Email.ownership_transfer_accepted(
+ site_transfer.email,
+ site_transfer.initiator.email,
+ site_transfer.site
+ )
+ |> Plausible.Mailer.send()
+ end
+
defp find_for_user(invitation_id, user) do
with {:error, :invitation_not_found} <- find_invitation(invitation_id, user) do
find_site_transfer(invitation_id, user)
diff --git a/lib/plausible/teams/users.ex b/lib/plausible/teams/users.ex
new file mode 100644
index 0000000000..e870127268
--- /dev/null
+++ b/lib/plausible/teams/users.ex
@@ -0,0 +1,113 @@
+defmodule Plausible.Teams.Users do
+ @moduledoc """
+ Users API accounting for teams.
+ """
+
+ import Ecto.Query
+
+ alias Plausible.Repo
+ alias Plausible.Teams
+
+ def has_sites?(user, opts \\ []) do
+ include_pending? = Keyword.get(opts, :include_pending?, false)
+
+ sites_query =
+ from(
+ s in Plausible.Site,
+ where: s.team_id == parent_as(:site_parent).team_id,
+ select: 1
+ )
+
+ # NOTE: Provided guest team memberships are consistently pruned,
+ # mere presence of guest team membership means there are sites
+ # associated with it, so querying for team membership alone
+ # should be enough.
+ team_member_query =
+ from(
+ tm in Teams.Membership,
+ as: :site_parent,
+ where: exists(sites_query),
+ where: tm.user_id == ^user.id,
+ select: 1
+ )
+
+ query =
+ if include_pending? do
+ site_transfer_query =
+ from(
+ st in Teams.SiteTransfer,
+ where: st.email == ^user.email,
+ select: 1
+ )
+
+ # NOTE: The same principle applies to guest team invitations,
+ # as it's pruned as well when there are no more guest invitations
+ # associated with it.
+ member_invitation_query =
+ from(
+ ti in Teams.Invitation,
+ as: :site_parent,
+ where: exists(sites_query),
+ where: ti.email == ^user.email,
+ select: 1
+ )
+
+ team_member_query
+ |> union_all(^site_transfer_query)
+ |> union_all(^member_invitation_query)
+ else
+ team_member_query
+ end
+
+ Repo.exists?(query)
+ end
+
+ def owns_sites?(user, opts \\ []) do
+ include_pending? = Keyword.get(opts, :include_pending?, false)
+
+ sites_query =
+ from(
+ s in Plausible.Site,
+ where: s.team_id == parent_as(:site_parent).team_id,
+ select: 1
+ )
+
+ owner_query =
+ from(
+ tm in Teams.Membership,
+ as: :site_parent,
+ where: exists(sites_query),
+ where: tm.user_id == ^user.id,
+ where: tm.role == :owner,
+ select: 1
+ )
+
+ query =
+ if include_pending? do
+ site_transfer_query =
+ from(
+ st in Teams.SiteTransfer,
+ where: st.email == ^user.email,
+ select: 1
+ )
+
+ owner_invitation_query =
+ from(
+ ti in Teams.Invitation,
+ as: :site_parent,
+ where: exists(sites_query),
+ where: ti.email == ^user.email,
+ where: ti.role == :owner,
+ select: 1
+ )
+
+ owner_query
+ |> union_all(^site_transfer_query)
+ |> union_all(^owner_invitation_query)
+ else
+ owner_query
+ end
+
+ Repo.exists?(query)
+ end
+end
diff --git a/lib/plausible_web/live/register_form.ex b/lib/plausible_web/live/register_form.ex
index ed65c09b20..848ac8b506 100644
--- a/lib/plausible_web/live/register_form.ex
+++ b/lib/plausible_web/live/register_form.ex
@@ -311,7 +311,22 @@ defmodule PlausibleWeb.Live.RegisterForm do
end
defp add_user(socket, user) do
- case Repo.insert(user) do
+ result =
+ Repo.transaction(fn ->
+ case Repo.insert(user) do
+ {:ok, user} when not is_nil(user.trial_expiry_date) ->
+ Plausible.Teams.get_or_create(user)
+ user
+
+ {:ok, user} ->
+ user
+
+ {:error, reason} ->
+ Repo.rollback(reason)
+ end
+ end)
+
+ case result do
{:ok, _user} ->
socket = assign(socket, disable_submit: true)
diff --git a/lib/plausible_web/live/sites.ex b/lib/plausible_web/live/sites.ex
index 93417f14f3..2a7e2427b6 100644
--- a/lib/plausible_web/live/sites.ex
+++ b/lib/plausible_web/live/sites.ex
@@ -10,6 +10,7 @@ defmodule PlausibleWeb.Live.Sites do
alias Plausible.Site
alias Plausible.Sites
alias Plausible.Site.Memberships.Invitations
+ alias Plausible.Teams
def mount(params, _session, socket) do
uri =
@@ -30,16 +31,10 @@ defmodule PlausibleWeb.Live.Sites do
|> assign(:params, params)
|> load_sites()
|> assign_new(:has_sites?, fn %{current_user: current_user} ->
- Site.Memberships.any_or_pending?(current_user)
+ has_sites?(current_user)
end)
|> assign_new(:needs_to_upgrade, fn %{current_user: current_user, sites: sites} ->
- user_owns_sites =
- Enum.any?(sites.entries, fn site ->
- length(site.invitations) > 0 && List.first(site.invitations).role == :owner
- end) ||
- Auth.user_owns_sites?(current_user)
-
- user_owns_sites && Plausible.Billing.check_needs_to_upgrade(current_user)
+ owns_sites?(current_user, sites) && check_needs_to_upgrade(current_user)
end)
{:noreply, socket}
@@ -649,6 +644,39 @@ defmodule PlausibleWeb.Live.Sites do
{:noreply, socket}
end
+ defp has_sites?(user) do
+ if Teams.read_team_schemas?(user) do
+ Teams.Users.has_sites?(user, include_pending?: true)
+ else
+ Site.Memberships.any_or_pending?(user)
+ end
+ end
+
+ defp owns_sites?(user, sites) do
+ if Teams.read_team_schemas?(user) do
+ Teams.Users.owns_sites?(user, include_pending?: true)
+ else
+ Enum.any?(sites.entries, fn site ->
+ length(site.invitations) > 0 && List.first(site.invitations).role == :owner
+ end) ||
+ Auth.user_owns_sites?(user)
+ end
+ end
+
+ defp check_needs_to_upgrade(user) do
+ if Teams.read_team_schemas?(user) do
+ team =
+ case Teams.get_by_owner(user) do
+ {:ok, team} -> team
+ {:error, _} -> nil
+ end
+
+ Teams.Billing.check_needs_to_upgrade(team)
+ else
+ Plausible.Billing.check_needs_to_upgrade(user)
+ end
+ end
+
defp load_sites(%{assigns: assigns} = socket) do
sites =
Sites.list_with_invitations(assigns.current_user, assigns.params,
@@ -683,7 +711,7 @@ defmodule PlausibleWeb.Live.Sites do
end
defp check_limits(%{role: :owner, site: site} = invitation, user) do
- case Invitations.ensure_can_take_ownership(site, user) do
+ case ensure_can_take_ownership(site, user) do
:ok ->
check_features(invitation, user)
@@ -698,8 +726,32 @@ defmodule PlausibleWeb.Live.Sites do
defp check_limits(invitation, _), do: %{invitation: invitation}
+ defp ensure_can_take_ownership(site, user) do
+ if Teams.read_team_schemas?(user) do
+ team =
+ case Teams.get_by_owner(user) do
+ {:ok, team} -> team
+ {:error, _} -> nil
+ end
+
+ Teams.Invitations.ensure_can_take_ownership(site, team)
+ else
+ Invitations.ensure_can_take_ownership(site, user)
+ end
+ end
+
defp check_features(%{role: :owner, site: site} = invitation, user) do
- case Invitations.check_feature_access(site, user, ce?()) do
+ user_or_team =
+ if Teams.read_team_schemas?(user) do
+ case Teams.get_by_owner(user) do
+ {:ok, team} -> team
+ {:error, _} -> nil
+ end
+ else
+ user
+ end
+
+ case check_feature_access(site, user_or_team) do
:ok ->
%{invitation: invitation}
@@ -713,6 +765,24 @@ defmodule PlausibleWeb.Live.Sites do
end
end
+ if ce?() do
+ defp check_feature_access(_site, _new_owner) do
+ :ok
+ end
+ else
+ defp check_feature_access(site, new_owner) do
+ missing_features =
+ Plausible.Billing.Quota.Usage.features_usage(nil, [site.id])
+ |> Enum.filter(&(&1.check_availability(new_owner) != :ok))
+
+ if missing_features == [] do
+ :ok
+ else
+ {:error, {:missing_features, missing_features}}
+ end
+ end
+ end
+
defp set_filter_text(socket, filter_text) do
uri = socket.assigns.uri
diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs
index d2b2b96a8a..f1d96e9de9 100644
--- a/test/plausible_web/controllers/site_controller_test.exs
+++ b/test/plausible_web/controllers/site_controller_test.exs
@@ -158,6 +158,7 @@ defmodule PlausibleWeb.SiteControllerTest do
user
|> Plausible.Auth.User.end_trial()
|> Repo.update!()
+ |> Plausible.Teams.sync_team()
conn = get(initial_conn, "/sites")
resp = html_response(conn, 200)
diff --git a/test/plausible_web/live/sites_test.exs b/test/plausible_web/live/sites_test.exs
index 61c1af0443..7a919c7433 100644
--- a/test/plausible_web/live/sites_test.exs
+++ b/test/plausible_web/live/sites_test.exs
@@ -60,7 +60,7 @@ defmodule PlausibleWeb.Live.SitesTest do
invitation = invite_transfer(site, user, inviter: inviter)
# fill site quota
- insert(:growth_subscription, user: user)
+ subscribe_to_growth_plan(user)
for _ <- 1..10, do: new_site(owner: user)
{:ok, _lv, html} = live(conn, "/sites")
@@ -80,7 +80,8 @@ defmodule PlausibleWeb.Live.SitesTest do
site = new_site(owner: inviter, allowed_event_props: ["dummy"])
invitation = invite_transfer(site, user, inviter: inviter)
- insert(:growth_subscription, user: user)
+
+ subscribe_to_growth_plan(user)
{:ok, _lv, html} = live(conn, "/sites")
diff --git a/test/support/teams/test.ex b/test/support/teams/test.ex
index f1f2b8fa7a..350437ff22 100644
--- a/test/support/teams/test.ex
+++ b/test/support/teams/test.ex
@@ -41,7 +41,11 @@ defmodule Plausible.Teams.Test do
def new_user(args \\ []) do
user = insert(:user, args)
- {:ok, _team} = Teams.get_or_create(user)
+
+ if user.trial_expiry_date do
+ {:ok, _team} = Teams.get_or_create(user)
+ end
+
Repo.preload(user, :team_memberships)
end
@@ -121,6 +125,12 @@ defmodule Plausible.Teams.Test do
user |> Repo.preload([:site_memberships, :team_memberships])
end
+ def subscribe_to_growth_plan(user) do
+ {:ok, team} = Teams.get_or_create(user)
+
+ insert(:growth_subscription, user: user, team: team)
+ end
+
defmacro __using__(_) do
quote do
import Plausible.Teams.Test