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
Remove grace period if user upgrades
Uku Tahte9cb8eb4e208
diff --git a/lib/plausible/auth/user.ex b/lib/plausible/auth/user.exindex bfb3eafd27..3a9021c421 100644--- a/lib/plausible/auth/user.ex+++ b/lib/plausible/auth/user.ex@@ -4,6 +4,15 @@ defimpl Bamboo.Formatter, for: Plausible.Auth.User doendend+defmodule Plausible.Auth.GracePeriod do+ use Ecto.Schema++ embedded_schema do+ field :end_date, :date+ field :allowance_required, :integer+ end+end+defmodule Plausible.Auth.User douse Ecto.Schemaimport Ecto.Changeset@@ -17,9 +26,9 @@ defmodule Plausible.Auth.User dofield :name, :stringfield :last_seen, :naive_datetimefield :trial_expiry_date, :date- field :grace_period_end, :datefield :theme, :stringfield :email_verified, :boolean+ embeds_one :grace_period, Plausible.Auth.GracePeriod, on_replace: :updatehas_many :site_memberships, Plausible.Site.Membershiphas_many :sites, through: [:site_memberships, :site]@@ -80,8 +89,17 @@ defmodule Plausible.Auth.User dochange(user, trial_expiry_date: Timex.today() |> Timex.shift(days: -1))end- def start_grace_period(user) do- change(user, grace_period_end: Timex.today() |> Timex.shift(days: 7))+ def start_grace_period(user, allowance_required) do+ grace_period = %Plausible.Auth.GracePeriod{+ end_date: Timex.today() |> Timex.shift(days: 7),+ allowance_required: allowance_required+ }++ change(user, grace_period: grace_period)+ end++ def remove_grace_period(user) do+ change(user, grace_period: nil)enddefp trial_expiry() dodiff --git a/lib/plausible/billing/billing.ex b/lib/plausible/billing/billing.exindex e292cb06d7..bd7854f791 100644--- a/lib/plausible/billing/billing.ex+++ b/lib/plausible/billing/billing.ex@@ -17,20 +17,29 @@ defmodule Plausible.Billing dochangeset = Subscription.changeset(%Subscription{}, format_subscription(params))- Repo.insert(changeset)- |> check_lock_status- |> maybe_adjust_api_key_limits+ Repo.insert(changeset) |> after_subscription_updateenddef subscription_updated(params) dosubscription = Repo.get_by!(Subscription, paddle_subscription_id: params["subscription_id"])changeset = Subscription.changeset(subscription, format_subscription(params))- Repo.update(changeset)+ Repo.update(changeset) |> after_subscription_update+ end++ defp after_subscription_update({:ok, subscription}) do+ user =+ Repo.get(Plausible.Auth.User, subscription.user_id)+ |> Map.put(:subscription, subscription)++ {:ok, user}+ |> maybe_remove_grace_period|> check_lock_status|> maybe_adjust_api_key_limitsend+ defp after_subscription_update(err), do: err+def subscription_cancelled(params) dosubscription =Repo.get_by(Subscription, paddle_subscription_id: params["subscription_id"])@@ -114,7 +123,7 @@ defmodule Plausible.Billing dosubscription_active = subscription_is_active?(user.subscription)grace_period_ended =- user.grace_period_end && Timex.before?(user.grace_period_end, Timex.today())+ user.grace_period && Timex.before?(user.grace_period.end_date, Timex.today())cond dotrial_is_over && !subscription_active -> {true, :no_active_subscription}@@ -225,31 +234,48 @@ defmodule Plausible.Billing dodefp present?(nil), do: falsedefp present?(_), do: true- defp check_lock_status({:ok, subscription}) do- user =- Repo.get(Plausible.Auth.User, subscription.user_id)- |> Map.put(:subscription, subscription)+ defp maybe_remove_grace_period({:ok, user}) do+ alias Plausible.Auth.GracePeriod++ case user.grace_period do+ %GracePeriod{allowance_required: allowance_required} ->+ new_allowance = Plausible.Billing.Plans.allowance(user.subscription)++ if new_allowance > allowance_required do+ Plausible.Auth.User.remove_grace_period(user)+ |> Repo.update()+ else+ {:ok, user}+ end++ _ ->+ {:ok, user}+ end+ end++ defp maybe_remove_grace_period(err), do: err+ defp check_lock_status({:ok, user}) doPlausible.Billing.SiteLocker.check_sites_for(user)- {:ok, subscription}+ {:ok, user}enddefp check_lock_status(err), do: err- defp maybe_adjust_api_key_limits({:ok, subscription}) do+ defp maybe_adjust_api_key_limits({:ok, user}) doplan =Repo.get_by(Plausible.Billing.EnterprisePlan,- user_id: subscription.user_id,- paddle_plan_id: subscription.paddle_plan_id+ user_id: user.id,+ paddle_plan_id: user.subscription.paddle_plan_id)if plan do- user_id = subscription.user_id+ user_id = user.idapi_keys = from(key in Plausible.Auth.ApiKey, where: key.user_id == ^user_id)Repo.update_all(api_keys, set: [hourly_request_limit: plan.hourly_api_request_limit])end- {:ok, subscription}+ {:ok, user}enddefp maybe_adjust_api_key_limits(err), do: errdiff --git a/lib/workers/check_usage.ex b/lib/workers/check_usage.exindex 41abcb2b7f..ca0193025f 100644--- a/lib/workers/check_usage.ex+++ b/lib/workers/check_usage.ex@@ -96,7 +96,7 @@ defmodule Plausible.Workers.CheckUsage do)Plausible.Mailer.send_email_safe(template)- Plausible.Auth.User.start_grace_period(subscriber) |> Repo.update()+ Plausible.Auth.User.start_grace_period(subscriber, last_cycle_usage) |> Repo.update()_ ->nildiff --git a/priv/repo/migrations/20211028122202_grace_period_end.exs b/priv/repo/migrations/20211028122202_grace_period_end.exsindex c0b6a64cad..e86400b0de 100644--- a/priv/repo/migrations/20211028122202_grace_period_end.exs+++ b/priv/repo/migrations/20211028122202_grace_period_end.exs@@ -3,7 +3,7 @@ defmodule Plausible.Repo.Migrations.GracePeriodEnd dodef change doalter table(:users) do- add :grace_period_end, :date+ add :grace_period, :mapendendenddiff --git a/test/plausible/billing/billing_test.exs b/test/plausible/billing/billing_test.exsindex 998addde50..8e5499f56b 100644--- a/test/plausible/billing/billing_test.exs+++ b/test/plausible/billing/billing_test.exs@@ -229,7 +229,8 @@ defmodule Plausible.BillingTest doend@subscription_id "subscription-123"- @plan_id "plan-123"+ @plan_id_10k "654177"+ @plan_id_100k "654178"describe "subscription_created" dotest "creates a subscription" do@@ -238,7 +239,7 @@ defmodule Plausible.BillingTest doBilling.subscription_created(%{"alert_name" => "subscription_created","subscription_id" => @subscription_id,- "subscription_plan_id" => @plan_id,+ "subscription_plan_id" => @plan_id_10k,"update_url" => "update_url.com","cancel_url" => "cancel_url.com","passthrough" => user.id,@@ -263,7 +264,7 @@ defmodule Plausible.BillingTest do"email" => user.email,"alert_name" => "subscription_created","subscription_id" => @subscription_id,- "subscription_plan_id" => @plan_id,+ "subscription_plan_id" => @plan_id_10k,"update_url" => "update_url.com","cancel_url" => "cancel_url.com","status" => "active",@@ -285,7 +286,7 @@ defmodule Plausible.BillingTest doBilling.subscription_created(%{"alert_name" => "subscription_created","subscription_id" => @subscription_id,- "subscription_plan_id" => @plan_id,+ "subscription_plan_id" => @plan_id_10k,"update_url" => "update_url.com","cancel_url" => "cancel_url.com","passthrough" => user.id,@@ -304,7 +305,7 @@ defmodule Plausible.BillingTest doplan =insert(:enterprise_plan,user: user,- paddle_plan_id: @plan_id,+ paddle_plan_id: @plan_id_10k,hourly_api_request_limit: 10_000)@@ -313,7 +314,7 @@ defmodule Plausible.BillingTest doBilling.subscription_created(%{"alert_name" => "subscription_created","subscription_id" => @subscription_id,- "subscription_plan_id" => @plan_id,+ "subscription_plan_id" => @plan_id_10k,"update_url" => "update_url.com","cancel_url" => "cancel_url.com","passthrough" => user.id,@@ -401,6 +402,66 @@ defmodule Plausible.BillingTest doassert Repo.reload!(api_key).hourly_request_limit == plan.hourly_api_request_limitend++ test "if user's grace period has ended, upgrading to the proper plan will unlock sites and remove grace period" do+ user =+ insert(:user,+ grace_period: %Plausible.Auth.GracePeriod{+ end_date: Timex.shift(Timex.today(), days: -1),+ allowance_required: 11_000+ }+ )++ subscription = insert(:subscription, user: user)+ site = insert(:site, locked: true, members: [user])++ Billing.subscription_updated(%{+ "alert_name" => "subscription_updated",+ "subscription_id" => subscription.paddle_subscription_id,+ "subscription_plan_id" => @plan_id_100k,+ "update_url" => "update_url.com",+ "cancel_url" => "cancel_url.com",+ "passthrough" => user.id,+ "old_status" => "past_due",+ "status" => "active",+ "next_bill_date" => "2019-06-01",+ "new_unit_price" => "12.00",+ "currency" => "EUR"+ })++ assert Repo.reload!(site).locked == false+ assert Repo.reload!(user).grace_period == nil+ end++ test "does not remove grace period if upgraded plan allowance is too low" do+ user =+ insert(:user,+ grace_period: %Plausible.Auth.GracePeriod{+ end_date: Timex.shift(Timex.today(), days: -1),+ allowance_required: 11_000+ }+ )++ subscription = insert(:subscription, user: user)+ site = insert(:site, locked: true, members: [user])++ Billing.subscription_updated(%{+ "alert_name" => "subscription_updated",+ "subscription_id" => subscription.paddle_subscription_id,+ "subscription_plan_id" => @plan_id_10k,+ "update_url" => "update_url.com",+ "cancel_url" => "cancel_url.com",+ "passthrough" => user.id,+ "old_status" => "past_due",+ "status" => "active",+ "next_bill_date" => "2019-06-01",+ "new_unit_price" => "12.00",+ "currency" => "EUR"+ })++ assert Repo.reload!(site).locked == true+ assert Repo.reload!(user).grace_period.allowance_required == 11_000+ endenddescribe "subscription_cancelled" dodiff --git a/test/plausible/billing/site_locker_test.exs b/test/plausible/billing/site_locker_test.exsindex e42a2e0d4a..8b92304f9e 100644--- a/test/plausible/billing/site_locker_test.exs+++ b/test/plausible/billing/site_locker_test.exs@@ -50,7 +50,14 @@ defmodule Plausible.Billing.SiteLockerTest doendtest "does not lock user who has an active subscription and is on grace period" do- user = insert(:user, grace_period_end: Timex.shift(Timex.today(), days: 1))+ user =+ insert(:user,+ grace_period: %Plausible.Auth.GracePeriod{+ end_date: Timex.shift(Timex.today(), days: 1),+ allowance_required: 10_000+ }+ )+insert(:subscription, status: "active", user: user)user = Repo.preload(user, :subscription)site = insert(:site, members: [user])@@ -79,7 +86,14 @@ defmodule Plausible.Billing.SiteLockerTest doendtest "locks all sites if user has active subscription but grace period has ended" do- user = insert(:user, grace_period_end: Timex.shift(Timex.today(), days: -1))+ user =+ insert(:user,+ grace_period: %Plausible.Auth.GracePeriod{+ end_date: Timex.shift(Timex.today(), days: -1),+ allowance_required: 10_000+ }+ )+insert(:subscription, status: "active", user: user)user = Repo.preload(user, :subscription)site = insert(:site, members: [user])@@ -90,7 +104,14 @@ defmodule Plausible.Billing.SiteLockerTest doendtest "sends email if grace period has ended" do- user = insert(:user, grace_period_end: Timex.shift(Timex.today(), days: -1))+ user =+ insert(:user,+ grace_period: %Plausible.Auth.GracePeriod{+ end_date: Timex.shift(Timex.today(), days: -1),+ allowance_required: 10_000+ }+ )+insert(:subscription, status: "active", user: user)user = Repo.preload(user, :subscription)insert(:site, members: [user])diff --git a/test/workers/check_usage_test.exs b/test/workers/check_usage_test.exsindex c545845830..3dc6418576 100644--- a/test/workers/check_usage_test.exs+++ b/test/workers/check_usage_test.exs@@ -24,7 +24,7 @@ defmodule Plausible.Workers.CheckUsageTest doCheckUsage.perform(nil)assert_no_emails_delivered()- assert Repo.reload(user).grace_period_end == nil+ assert Repo.reload(user).grace_period == nilendtest "does not send an email if account has been over the limit for one billing month", %{@@ -46,7 +46,7 @@ defmodule Plausible.Workers.CheckUsageTest doCheckUsage.perform(nil, billing_stub)assert_no_emails_delivered()- assert Repo.reload(user).grace_period_end == nil+ assert Repo.reload(user).grace_period == nilendtest "sends an email when an account is over their limit for two consecutive billing months", %{@@ -72,7 +72,7 @@ defmodule Plausible.Workers.CheckUsageTest dosubject: "[Action required] You have outgrown your Plausible subscription tier")- assert Repo.reload(user).grace_period_end == Timex.shift(Timex.today(), days: 7)+ assert Repo.reload(user).grace_period.end_date == Timex.shift(Timex.today(), days: 7)enddescribe "enterprise customers" do