From e4230db2d9890ca3ca0565199c67132494308e04 Mon Sep 17 00:00:00 2001
From: Vinicius Brasil
Date: Thu, 7 Dec 2023 09:05:07 -0300
Subject: [PATCH] Improve subscription status checking code (#3598)
* Improve subscription status checking code
This commit improves the subscription status checking in code, and
creates convinience functions to work with it, including nil-checking
and in?/2 function.
* Change in?/2 to macro
---
lib/plausible/auth/user_admin.ex | 3 +-
lib/plausible/billing/subscription/status.ex | 15 ++++++
lib/plausible/billing/subscriptions.ex | 22 ++++-----
lib/plausible_web/components/billing.ex | 4 +-
.../controllers/billing_controller.ex | 11 ++---
lib/plausible_web/live/choose_plan.ex | 13 +++---
.../templates/auth/user_settings.html.heex | 6 +--
test/plausible/billing/billing_test.exs | 2 +-
.../billing/subscription/status_test.exs | 46 +++++++++++++++++++
9 files changed, 88 insertions(+), 34 deletions(-)
create mode 100644 test/plausible/billing/subscription/status_test.exs
diff --git a/lib/plausible/auth/user_admin.ex b/lib/plausible/auth/user_admin.ex
index 866dd273a..2cd6c3c94 100644
--- a/lib/plausible/auth/user_admin.ex
+++ b/lib/plausible/auth/user_admin.ex
@@ -89,8 +89,7 @@ defmodule Plausible.Auth.UserAdmin do
end
defp subscription_plan(user) do
- if user.subscription && user.subscription.status == Subscription.Status.active() &&
- user.subscription.paddle_subscription_id do
+ if Subscription.Status.active?(user.subscription) && user.subscription.paddle_subscription_id do
quota = PlausibleWeb.AuthView.subscription_quota(user.subscription)
interval = PlausibleWeb.AuthView.subscription_interval(user.subscription)
diff --git a/lib/plausible/billing/subscription/status.ex b/lib/plausible/billing/subscription/status.ex
index 8e63468ec..882d1cb53 100644
--- a/lib/plausible/billing/subscription/status.ex
+++ b/lib/plausible/billing/subscription/status.ex
@@ -37,6 +37,21 @@ defmodule Plausible.Billing.Subscription.Status do
for status <- @statuses do
defmacro unquote(status)(), do: unquote(status)
+
+ def unquote(:"#{status}?")(nil), do: false
+ def unquote(:"#{status}?")(subscription), do: subscription.status == unquote(status)
+ end
+
+ defmacro in?(subscription, expected) do
+ expected_expanded = Enum.map(expected, &Macro.expand(&1, __CALLER__))
+
+ if expected_expanded -- Plausible.Billing.Subscription.Status.valid_statuses() != [] do
+ raise ArgumentError, "Invalid subscription statuses provided: #{inspect(expected_expanded)}"
+ end
+
+ quote bind_quoted: [subscription: subscription, expected: expected] do
+ if is_nil(subscription), do: false, else: Map.get(subscription, :status) in expected
+ end
end
def valid_statuses() do
diff --git a/lib/plausible/billing/subscriptions.ex b/lib/plausible/billing/subscriptions.ex
index 13cfc4d61..2e2d8ca19 100644
--- a/lib/plausible/billing/subscriptions.ex
+++ b/lib/plausible/billing/subscriptions.ex
@@ -14,29 +14,25 @@ defmodule Plausible.Billing.Subscriptions do
def expired?(%Subscription{paddle_plan_id: "free_10k"}), do: false
- def expired?(%Subscription{status: status, next_bill_date: next_bill_date}) do
- cancelled? = status == Subscription.Status.deleted()
+ def expired?(%Subscription{next_bill_date: next_bill_date} = subscription) do
+ deleted? = Subscription.Status.deleted?(subscription)
expired? = Timex.compare(next_bill_date, Timex.today()) < 0
- cancelled? && expired?
+ deleted? && expired?
end
- def resumable?(nil), do: false
-
- def resumable?(%Subscription{status: status}) do
- status in [
+ def resumable?(subscription) do
+ Subscription.Status.in?(subscription, [
Subscription.Status.active(),
Subscription.Status.past_due(),
Subscription.Status.paused()
- ]
+ ])
end
- def halted?(nil), do: false
-
- def halted?(%Subscription{status: status}) do
- status in [
+ def halted?(subscription) do
+ Subscription.Status.in?(subscription, [
Subscription.Status.past_due(),
Subscription.Status.paused()
- ]
+ ])
end
end
diff --git a/lib/plausible_web/components/billing.ex b/lib/plausible_web/components/billing.ex
index 65cf04c4a..ee925bd01 100644
--- a/lib/plausible_web/components/billing.ex
+++ b/lib/plausible_web/components/billing.ex
@@ -302,7 +302,7 @@ defmodule PlausibleWeb.Components.Billing do
<.styled_link
- :if={@subscription.status == Subscription.Status.active()}
+ :if={Subscription.Status.active?(@subscription)}
href={Routes.billing_path(PlausibleWeb.Endpoint, :change_plan_form)}
class="text-sm font-medium"
>
@@ -310,7 +310,7 @@ defmodule PlausibleWeb.Components.Billing do
diff --git a/lib/plausible_web/controllers/billing_controller.ex b/lib/plausible_web/controllers/billing_controller.ex
index 253d21c2d..6273a9f4e 100644
--- a/lib/plausible_web/controllers/billing_controller.ex
+++ b/lib/plausible_web/controllers/billing_controller.ex
@@ -23,7 +23,7 @@ defmodule PlausibleWeb.BillingController do
FunWithFlags.enabled?(:business_tier, for: user) ->
redirect(conn, to: Routes.billing_path(conn, :choose_plan))
- user.subscription && user.subscription.status == Subscription.Status.active() ->
+ Subscription.Status.active?(user.subscription) ->
redirect(conn, to: Routes.billing_path(conn, :change_plan_form))
true ->
@@ -70,11 +70,10 @@ defmodule PlausibleWeb.BillingController do
user.subscription.paddle_plan_id == latest_enterprise_plan.paddle_plan_id
cond do
- user.subscription &&
- user.subscription.status in [
- Subscription.Status.past_due(),
- Subscription.Status.paused()
- ] ->
+ Subscription.Status.in?(user.subscription, [
+ Subscription.Status.past_due(),
+ Subscription.Status.paused()
+ ]) ->
redirect(conn, to: Routes.auth_path(conn, :user_settings))
subscribed_to_latest? ->
diff --git a/lib/plausible_web/live/choose_plan.ex b/lib/plausible_web/live/choose_plan.ex
index f6fb0b3cc..8f6c89c6d 100644
--- a/lib/plausible_web/live/choose_plan.ex
+++ b/lib/plausible_web/live/choose_plan.ex
@@ -352,17 +352,16 @@ defmodule PlausibleWeb.Live.ChoosePlan do
subscription = assigns.user.subscription
billing_details_expired =
- subscription &&
- subscription.status in [
- Subscription.Status.paused(),
- Subscription.Status.past_due()
- ]
+ Subscription.Status.in?(subscription, [
+ Subscription.Status.paused(),
+ Subscription.Status.past_due()
+ ])
- subscription_cancelled = subscription && subscription.status == Subscription.Status.deleted()
+ subscription_deleted = Subscription.Status.deleted?(subscription)
{checkout_disabled, disabled_message} =
cond do
- change_plan_link_text == "Currently on this plan" && not subscription_cancelled ->
+ change_plan_link_text == "Currently on this plan" && not subscription_deleted ->
{true, nil}
assigns.available && !usage_within_limits ->
diff --git a/lib/plausible_web/templates/auth/user_settings.html.heex b/lib/plausible_web/templates/auth/user_settings.html.heex
index 4a6117d05..516958bec 100644
--- a/lib/plausible_web/templates/auth/user_settings.html.heex
+++ b/lib/plausible_web/templates/auth/user_settings.html.heex
@@ -42,7 +42,7 @@
style="width: 11.75rem;"
>
Next bill amount
- <%= if @subscription && @subscription.status in [Plausible.Billing.Subscription.Status.active(), Plausible.Billing.Subscription.Status.past_due()] do %>
+ <%= if Plausible.Billing.Subscription.Status.in?(@subscription, [Plausible.Billing.Subscription.Status.active(), Plausible.Billing.Subscription.Status.past_due()]) do %>
<%= PlausibleWeb.BillingView.present_currency(@subscription.currency_code) %><%= @subscription.next_bill_amount %>
@@ -59,7 +59,7 @@
>
Next bill date
- <%= if @subscription && @subscription.next_bill_date && @subscription.status in [Plausible.Billing.Subscription.Status.active(), Plausible.Billing.Subscription.Status.past_due()] do %>
+ <%= if @subscription && @subscription.next_bill_date && Plausible.Billing.Subscription.Status.in?(@subscription, [Plausible.Billing.Subscription.Status.active(), Plausible.Billing.Subscription.Status.past_due()]) do %>
<%= Timex.format!(@subscription.next_bill_date, "{Mshort} {D}, {YYYY}") %>
@@ -394,7 +394,7 @@
Deleting your account removes all sites and stats you've collected
- <%= if @subscription && @subscription.status == Plausible.Billing.Subscription.Status.active() do %>
+ <%= if Plausible.Billing.Subscription.Status.active?(@subscription) do %>
Delete my account
diff --git a/test/plausible/billing/billing_test.exs b/test/plausible/billing/billing_test.exs
index ce3347bd4..47b0f7d10 100644
--- a/test/plausible/billing/billing_test.exs
+++ b/test/plausible/billing/billing_test.exs
@@ -355,7 +355,7 @@ defmodule Plausible.BillingTest do
})
subscription = Repo.get_by(Plausible.Billing.Subscription, user_id: user.id)
- assert subscription.status == Subscription.Status.deleted()
+ assert Subscription.Status.deleted?(subscription)
end
test "ignores if the subscription cannot be found" do
diff --git a/test/plausible/billing/subscription/status_test.exs b/test/plausible/billing/subscription/status_test.exs
new file mode 100644
index 000000000..4575457b5
--- /dev/null
+++ b/test/plausible/billing/subscription/status_test.exs
@@ -0,0 +1,46 @@
+defmodule Plausible.Billing.Subscription.StatusTest do
+ use ExUnit.Case, async: true
+ import Plausible.Billing.Subscription.Status
+
+ for status <- valid_statuses() do
+ test "#{status}?/1 returns true when subscription status is #{status}" do
+ assert unquote(:"#{status}?")(%Plausible.Billing.Subscription{status: unquote(status)})
+ end
+
+ test "#{status}?/1 returns false when subscription is nil" do
+ refute unquote(:"#{status}?")(nil)
+ end
+
+ test "#{status}?/1 returns false when subscription status is not #{status}" do
+ [current | _] = valid_statuses() -- [unquote(status)]
+ refute unquote(:"#{status}?")(%Plausible.Billing.Subscription{status: current})
+ end
+ end
+
+ test "in?/2 returns true when subscription status is in list" do
+ assert in?(%Plausible.Billing.Subscription{status: past_due()}, [active(), past_due()])
+ end
+
+ test "in?/2 returns false when subscription status is not in list" do
+ refute in?(%Plausible.Billing.Subscription{status: paused()}, [active(), past_due()])
+ end
+
+ test "in?/2 returns false when subscription is nil" do
+ refute in?(nil, [active(), past_due()])
+ end
+
+ test "in?/2 raises ArgumentError when list includes invalid statuses" do
+ assert_raise ArgumentError, fn ->
+ Macro.expand(
+ quote do
+ in?(%Plausible.Billing.Subscription{status: past_due()}, [
+ active(),
+ past_due(),
+ :invalid
+ ])
+ end,
+ __ENV__
+ )
+ end
+ end
+end