Feature gates (#3401)
This pull request implements limits to funnels, revenue goals and custom props based on the site owner plan. It extends the current "premium feature" notice to account for the new plans, trials and the on-going private preview. Stats API is not in the context of this pull request, but will be implemented likewise.pull/3408/head r2023.10.11-209
parent
90cb7cdef8
commit
303b3509f7
@ -0,0 +1,156 @@
|
||||
defmodule Plausible.Billing.Feature do
|
||||
@moduledoc """
|
||||
This module provides an interface for managing features, e.g. Revenue Goals,
|
||||
Funnels and Custom Properties.
|
||||
|
||||
Feature modules have functions for toggling the feature on/off and checking
|
||||
whether the feature is available for a site/user.
|
||||
|
||||
When defining new features, the following options are expected by the
|
||||
`__using__` macro:
|
||||
|
||||
* `:display_name` - human-readable display name of the feature
|
||||
|
||||
* `:toggle_field` - the field in the %Plausible.Site{} schema that toggles
|
||||
the feature. If `nil` or not set, toggle/2 silently returns `:ok`
|
||||
|
||||
* `:extra_feature` - an atom representing the feature name in the plan JSON
|
||||
file (see also Plausible.Billing.Plan). If `nil` or not set,
|
||||
`check_availability/1` silently returns `:ok`
|
||||
|
||||
Functions defined by `__using__` can be overridden if needed.
|
||||
"""
|
||||
|
||||
@doc """
|
||||
Returns the human-readable display name of the feature.
|
||||
"""
|
||||
@callback display_name() :: String.t()
|
||||
|
||||
@doc """
|
||||
Returns the %Plausible.Site{} field that toggles the feature on and off.
|
||||
"""
|
||||
@callback toggle_field() :: atom()
|
||||
|
||||
@doc """
|
||||
Toggles the feature on and off for a site. Returns
|
||||
`{:error, :upgrade_required}` when toggling a feature the site owner does not
|
||||
have access to.
|
||||
"""
|
||||
@callback toggle(Plausible.Site.t(), Keyword.t()) :: :ok | {:error, :upgrade_required}
|
||||
|
||||
@doc """
|
||||
Checks whether a feature is enabled or not. Returns false when the feature is
|
||||
disabled or the user does not have access to it.
|
||||
"""
|
||||
@callback enabled?(Plausible.Site.t()) :: boolean()
|
||||
|
||||
@doc """
|
||||
Checks whether the site owner or the user plan includes the given feature.
|
||||
"""
|
||||
@callback check_availability(Plausible.Site.t() | Plausible.Auth.User.t()) ::
|
||||
:ok | {:error, :upgrade_required}
|
||||
|
||||
@features [
|
||||
Plausible.Billing.Feature.Funnels,
|
||||
Plausible.Billing.Feature.Goals,
|
||||
Plausible.Billing.Feature.Props,
|
||||
Plausible.Billing.Feature.RevenueGoals
|
||||
]
|
||||
|
||||
@doc """
|
||||
Lists all available feature modules.
|
||||
"""
|
||||
def list() do
|
||||
@features
|
||||
end
|
||||
|
||||
@doc false
|
||||
defmacro __using__(opts \\ []) do
|
||||
quote location: :keep do
|
||||
@behaviour Plausible.Billing.Feature
|
||||
alias Plausible.Billing.Quota
|
||||
|
||||
@impl true
|
||||
def display_name, do: Keyword.get(unquote(opts), :display_name)
|
||||
|
||||
@impl true
|
||||
def toggle_field, do: Keyword.get(unquote(opts), :toggle_field)
|
||||
|
||||
@impl true
|
||||
def enabled?(site) do
|
||||
cond do
|
||||
check_availability(site) !== :ok -> false
|
||||
is_nil(toggle_field()) -> true
|
||||
true -> Map.get(site, toggle_field())
|
||||
end
|
||||
end
|
||||
|
||||
@impl true
|
||||
def check_availability(site_or_user)
|
||||
|
||||
def check_availability(%Plausible.Site{} = site) do
|
||||
site = Plausible.Repo.preload(site, :owner)
|
||||
check_availability(site.owner)
|
||||
end
|
||||
|
||||
def check_availability(%Plausible.Auth.User{} = user) do
|
||||
extra_feature = Keyword.get(unquote(opts), :extra_feature)
|
||||
|
||||
cond do
|
||||
is_nil(extra_feature) -> :ok
|
||||
not FunWithFlags.enabled?(:business_tier, for: user) -> :ok
|
||||
extra_feature in Quota.extra_features_limit(user) -> :ok
|
||||
true -> {:error, :upgrade_required}
|
||||
end
|
||||
end
|
||||
|
||||
@impl true
|
||||
def toggle(site, opts \\ []) do
|
||||
with key when not is_nil(key) <- toggle_field(),
|
||||
:ok <- check_availability(site) do
|
||||
override = Keyword.get(opts, :override)
|
||||
toggle = if is_boolean(override), do: override, else: !Map.fetch!(site, toggle_field())
|
||||
|
||||
site
|
||||
|> Ecto.Changeset.change(%{toggle_field() => toggle})
|
||||
|> Plausible.Repo.update()
|
||||
else
|
||||
nil = _feature_not_togglable -> :ok
|
||||
{:error, :upgrade_required} -> {:error, :upgrade_required}
|
||||
end
|
||||
end
|
||||
|
||||
defoverridable check_availability: 1, toggle: 1, toggle: 2
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defmodule Plausible.Billing.Feature.Funnels do
|
||||
@moduledoc false
|
||||
use Plausible.Billing.Feature,
|
||||
display_name: "Funnels",
|
||||
toggle_field: :funnels_enabled,
|
||||
extra_feature: :funnels
|
||||
end
|
||||
|
||||
defmodule Plausible.Billing.Feature.RevenueGoals do
|
||||
@moduledoc false
|
||||
use Plausible.Billing.Feature,
|
||||
display_name: "Revenue Goals",
|
||||
extra_feature: :revenue_goals
|
||||
end
|
||||
|
||||
defmodule Plausible.Billing.Feature.Goals do
|
||||
@moduledoc false
|
||||
use Plausible.Billing.Feature,
|
||||
display_name: "Goals",
|
||||
toggle_field: :conversions_enabled
|
||||
end
|
||||
|
||||
defmodule Plausible.Billing.Feature.Props do
|
||||
@moduledoc false
|
||||
use Plausible.Billing.Feature,
|
||||
display_name: "Custom Properties",
|
||||
toggle_field: :props_enabled,
|
||||
extra_feature: :props
|
||||
end
|
||||
@ -0,0 +1,125 @@
|
||||
defmodule Plausible.Billing.FeatureTest do
|
||||
use Plausible.DataCase
|
||||
|
||||
@v1_plan_id "558018"
|
||||
@v4_growth_plan_id "change-me-749342"
|
||||
@v4_business_plan_id "change-me-b749342"
|
||||
|
||||
for mod <- [Plausible.Billing.Feature.Funnels, Plausible.Billing.Feature.RevenueGoals] do
|
||||
test "#{mod}.check_availability/1 returns :ok when site owner is on a enterprise plan" do
|
||||
user =
|
||||
insert(:user,
|
||||
enterprise_plan: build(:enterprise_plan, paddle_plan_id: "123321"),
|
||||
subscription: build(:subscription, paddle_plan_id: "123321")
|
||||
)
|
||||
|
||||
site = insert(:site, memberships: [build(:site_membership, user: user, role: :owner)])
|
||||
|
||||
assert :ok == unquote(mod).check_availability(user)
|
||||
assert :ok == unquote(mod).check_availability(site)
|
||||
end
|
||||
|
||||
test "#{mod}.check_availability/1 returns :ok when site owner is on a business plan" do
|
||||
user =
|
||||
insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_business_plan_id))
|
||||
|
||||
site = insert(:site, memberships: [build(:site_membership, user: user, role: :owner)])
|
||||
|
||||
assert :ok == unquote(mod).check_availability(user)
|
||||
assert :ok == unquote(mod).check_availability(site)
|
||||
end
|
||||
|
||||
test "#{mod}.check_availability/1 returns error when site owner is on a growth plan" do
|
||||
user = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_growth_plan_id))
|
||||
site = insert(:site, memberships: [build(:site_membership, user: user, role: :owner)])
|
||||
|
||||
assert {:error, :upgrade_required} == unquote(mod).check_availability(user)
|
||||
assert {:error, :upgrade_required} == unquote(mod).check_availability(site)
|
||||
end
|
||||
|
||||
test "#{mod}.check_availability/1 returns error when site owner is on an old plan" do
|
||||
user = insert(:user, subscription: build(:subscription, paddle_plan_id: @v1_plan_id))
|
||||
site = insert(:site, memberships: [build(:site_membership, user: user, role: :owner)])
|
||||
|
||||
assert {:error, :upgrade_required} == unquote(mod).check_availability(user)
|
||||
assert {:error, :upgrade_required} == unquote(mod).check_availability(site)
|
||||
end
|
||||
end
|
||||
|
||||
test "Plausible.Billing.Feature.Props.check_availability/1 applies grandfathering to old plans" do
|
||||
user = insert(:user, subscription: build(:subscription, paddle_plan_id: @v1_plan_id))
|
||||
site = insert(:site, memberships: [build(:site_membership, user: user, role: :owner)])
|
||||
|
||||
assert :ok == Plausible.Billing.Feature.Props.check_availability(user)
|
||||
assert :ok == Plausible.Billing.Feature.Props.check_availability(site)
|
||||
end
|
||||
|
||||
test "Plausible.Billing.Feature.Goals.check_availability/2 always returns :ok" do
|
||||
u1 = insert(:user, subscription: build(:subscription, paddle_plan_id: @v1_plan_id))
|
||||
u2 = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_growth_plan_id))
|
||||
u3 = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_business_plan_id))
|
||||
|
||||
u4 =
|
||||
insert(:user,
|
||||
enterprise_plan: build(:enterprise_plan, paddle_plan_id: "123321"),
|
||||
subscription: build(:subscription, paddle_plan_id: "123321")
|
||||
)
|
||||
|
||||
assert :ok == Plausible.Billing.Feature.Goals.check_availability(u1)
|
||||
assert :ok == Plausible.Billing.Feature.Goals.check_availability(u2)
|
||||
assert :ok == Plausible.Billing.Feature.Goals.check_availability(u3)
|
||||
assert :ok == Plausible.Billing.Feature.Goals.check_availability(u4)
|
||||
end
|
||||
|
||||
for {mod, property} <- [
|
||||
{Plausible.Billing.Feature.Funnels, :funnels_enabled},
|
||||
{Plausible.Billing.Feature.Props, :props_enabled}
|
||||
] do
|
||||
test "#{mod}.toggle/2 toggles #{property} on and off" do
|
||||
site = insert(:site, [{:members, [build(:user)]}, {unquote(property), false}])
|
||||
|
||||
{:ok, site} = unquote(mod).toggle(site)
|
||||
assert Map.get(site, unquote(property))
|
||||
assert unquote(mod).enabled?(site)
|
||||
|
||||
{:ok, site} = unquote(mod).toggle(site)
|
||||
refute Map.get(site, unquote(property))
|
||||
refute unquote(mod).enabled?(site)
|
||||
end
|
||||
|
||||
test "#{mod}.toggle/2 accepts an override option" do
|
||||
site = insert(:site, [{:members, [build(:user)]}, {unquote(property), false}])
|
||||
|
||||
{:ok, site} = unquote(mod).toggle(site, override: false)
|
||||
refute Map.get(site, unquote(property))
|
||||
refute unquote(mod).enabled?(site)
|
||||
end
|
||||
|
||||
test "#{mod}.toggle/2 errors when site owner does not have access to the feature" do
|
||||
user = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_growth_plan_id))
|
||||
site = insert(:site, [{:members, [user]}, {unquote(property), false}])
|
||||
{:error, :upgrade_required} = unquote(mod).toggle(site)
|
||||
refute unquote(mod).enabled?(site)
|
||||
end
|
||||
end
|
||||
|
||||
test "Plausible.Billing.Feature.Goals.toggle/2 toggles conversions_enabled on and off" do
|
||||
site = insert(:site, [{:members, [build(:user)]}, {:conversions_enabled, false}])
|
||||
|
||||
{:ok, site} = Plausible.Billing.Feature.Goals.toggle(site)
|
||||
assert Map.get(site, :conversions_enabled)
|
||||
assert Plausible.Billing.Feature.Goals.enabled?(site)
|
||||
|
||||
{:ok, site} = Plausible.Billing.Feature.Goals.toggle(site)
|
||||
refute Map.get(site, :conversions_enabled)
|
||||
refute Plausible.Billing.Feature.Goals.enabled?(site)
|
||||
end
|
||||
|
||||
for mod <- [Plausible.Billing.Feature.Funnels, Plausible.Billing.Feature.Props] do
|
||||
test "#{mod}.enabled?/1 returns false when user does not have access to the feature even when enabled" do
|
||||
user = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_growth_plan_id))
|
||||
site = insert(:site, [{:members, [user]}, {unquote(mod).toggle_field(), true}])
|
||||
refute unquote(mod).enabled?(site)
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,77 @@
|
||||
defmodule PlausibleWeb.Components.BillingTest do
|
||||
use Plausible.DataCase
|
||||
import Phoenix.LiveViewTest
|
||||
alias PlausibleWeb.Components.Billing
|
||||
|
||||
@v4_growth_plan_id "change-me-749342"
|
||||
@v4_business_plan_id "change-me-b749342"
|
||||
|
||||
test "extra_feature_notice/1 renders a message when user is on trial" do
|
||||
me = insert(:user)
|
||||
site = :site |> insert(members: [me]) |> Plausible.Repo.preload(:owner)
|
||||
|
||||
assert render_component(&Billing.extra_feature_notice/1,
|
||||
site: site,
|
||||
current_user: me,
|
||||
feature_mod: Plausible.Billing.Feature.Props
|
||||
) =~
|
||||
"Custom Properties is part of the Plausible Business plan. You can access it during your trial"
|
||||
end
|
||||
|
||||
test "extra_feature_notice/1 renders an upgrade link when user is the site owner and does not have access to the feature" do
|
||||
me = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_growth_plan_id))
|
||||
site = :site |> insert(members: [me]) |> Plausible.Repo.preload(:owner)
|
||||
|
||||
rendered =
|
||||
render_component(&Billing.extra_feature_notice/1,
|
||||
site: site,
|
||||
current_user: me,
|
||||
feature_mod: Plausible.Billing.Feature.Props
|
||||
)
|
||||
|
||||
assert rendered =~ "Custom Properties is part of the Plausible Business plan."
|
||||
assert rendered =~ "upgrade your subscription"
|
||||
assert rendered =~ "/billing/upgrade"
|
||||
end
|
||||
|
||||
test "extra_feature_notice/1 does not render an upgrade link when user is not the site owner" do
|
||||
me = insert(:user)
|
||||
owner = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_growth_plan_id))
|
||||
|
||||
site =
|
||||
:site
|
||||
|> insert(
|
||||
memberships: [
|
||||
build(:site_membership, user: owner, role: :owner),
|
||||
build(:site_membership, user: me, role: :admin)
|
||||
]
|
||||
)
|
||||
|> Plausible.Repo.preload(:owner)
|
||||
|
||||
rendered =
|
||||
render_component(&Billing.extra_feature_notice/1,
|
||||
site: site,
|
||||
current_user: me,
|
||||
feature_mod: Plausible.Billing.Feature.Funnels
|
||||
)
|
||||
|
||||
assert rendered =~
|
||||
"Funnels is part of the Plausible Business plan. To get access to it, please reach out to the site owner to upgrade your subscription to the Business plan."
|
||||
|
||||
refute rendered =~ "/billing/upgrade"
|
||||
end
|
||||
|
||||
test "extra_feature_notice/1 does not render a notice when the user has access to the feature" do
|
||||
me = insert(:user, subscription: build(:subscription, paddle_plan_id: @v4_business_plan_id))
|
||||
site = :site |> insert(members: [me]) |> Plausible.Repo.preload(:owner)
|
||||
|
||||
rendered =
|
||||
render_component(&Billing.extra_feature_notice/1,
|
||||
site: site,
|
||||
current_user: me,
|
||||
feature_mod: Plausible.Billing.Feature.Funnels
|
||||
)
|
||||
|
||||
assert rendered == ""
|
||||
end
|
||||
end
|
||||
Loading…
Reference in New Issue