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
fixes to the enterprise_over_limit internal alert (#6592)
Marko Saric32d54556c46d
diff --git a/lib/plausible/teams/billing.ex b/lib/plausible/teams/billing.exindex 2074403fde..50ee474ba5 100644--- a/lib/plausible/teams/billing.ex+++ b/lib/plausible/teams/billing.ex@@ -150,10 +150,10 @@ defmodule Plausible.Teams.Billing dodefp revise_pageview_usage(team, usage_mod) docase Plausible.Workers.CheckUsage.check_pageview_usage_two_cycles(team, usage_mod) do- {:over_limit, _} ->+ {:over_limit, _, _} ->{:needs_to_upgrade, :grace_period_ended}- {:below_limit, _} ->+ {:below_limit, _, _} ->Plausible.Teams.remove_grace_period(team):no_upgrade_neededenddiff --git a/lib/plausible_web/email.ex b/lib/plausible_web/email.exindex b3b6f721d1..fe929b5b6e 100644--- a/lib/plausible_web/email.ex+++ b/lib/plausible_web/email.ex@@ -190,17 +190,14 @@ defmodule PlausibleWeb.Email do})end- def enterprise_over_limit_internal_email(user, pageview_usage, site_usage, site_allowance) do+ def enterprise_over_limit_internal_email(team, assigns) do+ assigns = Map.put(assigns, :team, team)+base_email(%{layout: nil})|> to("[email protected]")|> tag("enterprise-over-limit")- |> subject("#{user.email} has outgrown their enterprise plan")- |> render("enterprise_over_limit_internal.html", %{- user: user,- pageview_usage: pageview_usage,- site_usage: site_usage,- site_allowance: site_allowance- })+ |> subject("#{team.name} has outgrown their enterprise plan")+ |> render("enterprise_over_limit_internal.html", assigns)enddef dashboard_locked(user, team, usage, suggested_volume) dodiff --git a/lib/plausible_web/templates/email/enterprise_over_limit_internal.html.heex b/lib/plausible_web/templates/email/enterprise_over_limit_internal.html.heexindex 1372234f25..1d17bb0474 100644--- a/lib/plausible_web/templates/email/enterprise_over_limit_internal.html.heex+++ b/lib/plausible_web/templates/email/enterprise_over_limit_internal.html.heex@@ -1,14 +1,23 @@Automated notice about an enterprise account that has gone over their limits. <br /><br />-Customer email: {@user.email}<br />-Last billing cycle: {PlausibleWeb.TextHelpers.format_date_range(- @pageview_usage.last_cycle.date_range-)}<br />-Last cycle pageview usage: {PlausibleWeb.AuthView.delimit_integer(- @pageview_usage.last_cycle.total-)} billable pageviews<br />-Penultimate billing cycle: {PlausibleWeb.TextHelpers.format_date_range(- @pageview_usage.penultimate_cycle.date_range-)}<br />-Penultimate cycle pageview usage: {PlausibleWeb.AuthView.delimit_integer(- @pageview_usage.penultimate_cycle.total-)} billable pageviews<br /> Site usage: {@site_usage} / {@site_allowance} allowed sites<br />+Team name: {@team.name}<br /> Team identifier: {@team.identifier}<br />+Customer email(s): {Enum.join(@team_member_emails, ", ")}<br />+<a href={customer_support_team_url(@team)}>View in Customer Support</a>+<br /><br />+<strong>+ Monthly pageviews: {if(@exceeds_pageview_limit?, do: "EXCEEDED", else: "OK")}+</strong>+<br /><br /> Last billing cycle<br />+{PlausibleWeb.TextHelpers.format_date_range(@pageview_usage.last_cycle.date_range)}<br />+<strong>{PlausibleWeb.AuthView.delimit_integer(@pageview_usage.last_cycle.total)}</strong>+/ {format_pageview_limit(@pageview_limit)}<br />+<br /> Penultimate billing cycle<br />+{PlausibleWeb.TextHelpers.format_date_range(@pageview_usage.penultimate_cycle.date_range)}<br />+<strong>{PlausibleWeb.AuthView.delimit_integer(@pageview_usage.penultimate_cycle.total)}</strong>+/ {format_pageview_limit(@pageview_limit)}<br />+<br />+<strong>+ Sites: {if(@exceeds_site_limit?, do: "EXCEEDED", else: "OK")}+</strong>+<br /><br />+{@site_usage} / {@site_limit} allowed sites<br />+<br /> A manual lock grace period has been started for this account.diff --git a/lib/plausible_web/views/email_view.ex b/lib/plausible_web/views/email_view.exindex 7837d15697..8806a9fec0 100644--- a/lib/plausible_web/views/email_view.ex+++ b/lib/plausible_web/views/email_view.ex@@ -11,6 +11,17 @@ defmodule PlausibleWeb.EmailView do"?__team=#{team.identifier}"end+ on_ee do+ def customer_support_team_url(team) do+ PlausibleWeb.Router.Helpers.customer_support_team_url(PlausibleWeb.Endpoint, :show, team.id)+ end+ else+ def customer_support_team_url(_team), do: nil+ end++ def format_pageview_limit(:unlimited), do: "unlimited"+ def format_pageview_limit(limit), do: PlausibleWeb.AuthView.delimit_integer(limit)+def greet_recipient(%{user: %{name: name}}) when is_binary(name) do"Hey #{String.split(name) |> List.first()},"enddiff --git a/lib/workers/check_usage.ex b/lib/workers/check_usage.exindex c91431c971..af583e057f 100644--- a/lib/workers/check_usage.ex+++ b/lib/workers/check_usage.ex@@ -1,4 +1,10 @@defmodule Plausible.Workers.CheckUsage do+ @moduledoc """+ A Cron job that runs every day at 14:00, checking whether active+ subscribers have outgrown their plan limits, in which case, starts+ grace periods and notifies via email.+ """+use Plausible.Repouse Oban.Worker, queue: :check_usagerequire Plausible.Billing.Subscription.Status@@ -87,16 +93,16 @@ defmodule Plausible.Workers.CheckUsage dousage = Teams.Billing.site_usage(subscriber)- if Quota.below_limit?(usage, limit) do- {:below_limit, {usage, limit}}+ if Quota.within_limit?(usage, limit) do+ {:below_limit, usage, limit}else- {:over_limit, {usage, limit}}+ {:over_limit, usage, limit}endenddef maybe_remove_grace_period(subscriber, usage_mod) docase check_pageview_usage_last_cycle(subscriber, usage_mod) do- {:below_limit, _} ->+ {:below_limit, _, _} ->Plausible.Teams.remove_grace_period(subscriber):ok@@ -107,7 +113,7 @@ defmodule Plausible.Workers.CheckUsage dodefp check_regular_subscriber(subscriber, usage_mod) docase check_pageview_usage_two_cycles(subscriber, usage_mod) do- {:over_limit, pageview_usage} ->+ {:over_limit, pageview_usage, _} ->suggested_volume =Plausible.Billing.Plans.suggest_volume(subscriber, pageview_usage.last_cycle.total)@@ -124,25 +130,33 @@ defmodule Plausible.Workers.CheckUsage doenddef check_enterprise_subscriber(subscriber, usage_mod) do- pageview_usage = check_pageview_usage_two_cycles(subscriber, usage_mod)- site_usage = check_site_usage_for_enterprise(subscriber)-- case {pageview_usage, site_usage} do- {{:below_limit, _}, {:below_limit, _}} ->- nil-- {{_, pageview_usage}, {_, {site_usage, site_allowance}}} ->- for owner <- subscriber.owners ++ subscriber.billing_members do- PlausibleWeb.Email.enterprise_over_limit_internal_email(- owner,- pageview_usage,- site_usage,- site_allowance- )- |> Plausible.Mailer.send()- end-- Plausible.Teams.start_manual_lock_grace_period(subscriber)+ {pageview_status, pageview_usage, pageview_limit} =+ check_pageview_usage_two_cycles(subscriber, usage_mod)++ {site_status, site_usage, site_limit} =+ check_site_usage_for_enterprise(subscriber)++ exceeds_pageview_limit? = pageview_status == :over_limit+ exceeds_site_limit? = site_status == :over_limit++ if exceeds_pageview_limit? or exceeds_site_limit? do+ team_member_emails =+ (subscriber.owners ++ subscriber.billing_members)+ |> Enum.map(& &1.email)+ |> Enum.uniq()++ PlausibleWeb.Email.enterprise_over_limit_internal_email(subscriber, %{+ team_member_emails: team_member_emails,+ exceeds_pageview_limit?: exceeds_pageview_limit?,+ pageview_usage: pageview_usage,+ pageview_limit: pageview_limit,+ exceeds_site_limit?: exceeds_site_limit?,+ site_usage: site_usage,+ site_limit: site_limit+ })+ |> Plausible.Mailer.send()++ Plausible.Teams.start_manual_lock_grace_period(subscriber)endend@@ -151,9 +165,9 @@ defmodule Plausible.Workers.CheckUsage dolimit = Teams.Billing.monthly_pageview_limit(subscriber.subscription)if Quota.exceeds_last_two_usage_cycles?(usage, limit) do- {:over_limit, usage}+ {:over_limit, usage, limit}else- {:below_limit, usage}+ {:below_limit, usage, limit}endend@@ -162,9 +176,9 @@ defmodule Plausible.Workers.CheckUsage dolimit = Teams.Billing.monthly_pageview_limit(subscriber.subscription)if :last_cycle in Quota.exceeded_cycles(usage, limit) do- {:over_limit, usage}+ {:over_limit, usage, limit}else- {:below_limit, usage}+ {:below_limit, usage, limit}endendenddiff --git a/test/plausible_web/email_test.exs b/test/plausible_web/email_test.exsindex d7b2c1bf0d..b177440a00 100644--- a/test/plausible_web/email_test.exs+++ b/test/plausible_web/email_test.exs@@ -264,32 +264,73 @@ defmodule PlausibleWeb.EmailTest doendend- describe "enterprise_over_limit_internal_email/4" do+ describe "enterprise_over_limit_internal_email/2" dotest "renders pageview usage by billing cycles + sites usage/limit" do- user = build(:user)+ team = insert(:team, name: "Acme Inc", identifier: Ecto.UUID.generate())+ owner = build(:user, email: "[email protected]")+ billing_member = build(:user, email: "[email protected]")penultimate_cycle = Date.range(~D[2023-03-01], ~D[2023-03-31])last_cycle = Date.range(~D[2023-04-01], ~D[2023-04-30])pageview_usage = %{- penultimate_cycle: %{date_range: penultimate_cycle, total: 100_141_888},- last_cycle: %{date_range: last_cycle, total: 100_222_999}+ penultimate_cycle: %{date_range: penultimate_cycle, total: 123_141_888},+ last_cycle: %{date_range: last_cycle, total: 123_222_999}}%{html_body: html_body, subject: subject} =- PlausibleWeb.Email.enterprise_over_limit_internal_email(user, pageview_usage, 80, 50)+ PlausibleWeb.Email.enterprise_over_limit_internal_email(team, %{+ team_member_emails: [owner.email, billing_member.email],+ exceeds_pageview_limit?: true,+ pageview_usage: pageview_usage,+ pageview_limit: 100_000_000,+ exceeds_site_limit?: false,+ site_usage: 50,+ site_limit: 50+ })- assert subject == "#{user.email} has outgrown their enterprise plan"+ assert subject == "Acme Inc has outgrown their enterprise plan"- assert html_body =~- "Last billing cycle: #{PlausibleWeb.TextHelpers.format_date_range(last_cycle)}"+ assert html_body =~ "Team name: Acme Inc"+ assert html_body =~ "Team identifier: #{team.identifier}"+ assert html_body =~ "Customer email(s): [email protected], [email protected]"+ assert html_body =~ "Monthly pageviews: EXCEEDED"+ assert html_body =~ "Sites: OK"++ assert html_body =~ PlausibleWeb.TextHelpers.format_date_range(last_cycle)+ assert html_body =~ "123,222,999"+ assert html_body =~ "/ 100,000,000"- assert html_body =~ "Last cycle pageview usage: 100,222,999 billable pageviews"+ assert html_body =~ PlausibleWeb.TextHelpers.format_date_range(penultimate_cycle)+ assert html_body =~ "123,141,888"- assert html_body =~- "Penultimate billing cycle: #{PlausibleWeb.TextHelpers.format_date_range(penultimate_cycle)}"+ assert html_body =~ "50 / 50 allowed sites"+ end++ test "renders :unlimited pageview limit" do+ team = insert(:team, name: "Acme Inc", identifier: Ecto.UUID.generate())+ penultimate_cycle = Date.range(~D[2023-03-01], ~D[2023-03-31])+ last_cycle = Date.range(~D[2023-04-01], ~D[2023-04-30])++ pageview_usage = %{+ penultimate_cycle: %{date_range: penultimate_cycle, total: 100},+ last_cycle: %{date_range: last_cycle, total: 200}+ }++ %{html_body: html_body} =+ PlausibleWeb.Email.enterprise_over_limit_internal_email(team, %{+ team_member_emails: ["[email protected]"],+ exceeds_pageview_limit?: false,+ pageview_usage: pageview_usage,+ pageview_limit: :unlimited,+ exceeds_site_limit?: true,+ site_usage: 51,+ site_limit: 50+ })- assert html_body =~ "Penultimate cycle pageview usage: 100,141,888 billable pageviews"- assert html_body =~ "Site usage: 80 / 50 allowed sites"+ assert html_body =~ "200"+ assert html_body =~ "/ unlimited"+ assert html_body =~ "Monthly pageviews: OK"+ assert html_body =~ "Sites: EXCEEDED"endenddiff --git a/test/workers/check_usage_test.exs b/test/workers/check_usage_test.exsindex 9a012f4210..d0ec14243d 100644--- a/test/workers/check_usage_test.exs+++ b/test/workers/check_usage_test.exs@@ -385,7 +385,7 @@ defmodule Plausible.Workers.CheckUsageTest doassert Repo.reload(team_of(user)).grace_period.id == existing_grace_period.idend- test "checks billable pageview usage for enterprise customer, sends usage information to [email protected]",+ test "pageview limit exceeded -> sends internal email and starts manual lock grace period",%{user: user} do@@ -411,11 +411,16 @@ defmodule Plausible.Workers.CheckUsageTest doassert_email_delivered_with(to: [{nil, "[email protected]"}],- subject: "#{user.email} has outgrown their enterprise plan"+ subject: "#{team_of(user).name} has outgrown their enterprise plan")++ assert user+ |> team_of()+ |> Repo.reload()+ |> Plausible.Teams.GracePeriod.manual_lock_active?()end- test "will only check usage if enterprise plan matches subscription's paddle plan id",+ test "sends a single alert to [email protected] even when the team has multiple owners/billing members",%{user: user} do@@ -433,21 +438,26 @@ defmodule Plausible.Workers.CheckUsageTest domonthly_pageview_limit: 1_000_000,subscription: [last_bill_date: Date.shift(Date.utc_today(), day: -1),- status: unquote(status),- # non-matching ID- paddle_plan_id: @paddle_id_10k+ status: unquote(status)])+ team = team_of(user)+ billing_member = Plausible.Teams.Test.new_user()+ Plausible.Teams.Test.add_member(team, user: billing_member, role: :billing)+CheckUsage.perform(nil, usage_stub)- refute_email_delivered_with(+ assert_email_delivered_with(to: [{nil, "[email protected]"}],- subject: "#{user.email} has outgrown their enterprise plan"+ subject: "#{team.name} has outgrown their enterprise plan",+ html_body: ~r/#{Regex.escape(user.email)}.*#{Regex.escape(billing_member.email)}/s)++ assert_no_emails_delivered()end- test "checks site limit for enterprise customer, sends usage information to [email protected]",+ test "will only check usage if enterprise plan matches subscription's paddle plan id",%{user: user} do@@ -455,11 +465,34 @@ defmodule Plausible.Workers.CheckUsageTest doPlausible.Teams.Billing|> stub(:monthly_pageview_usage, fn _user ->%{- penultimate_cycle: %{date_range: @date_range, total: 1},- last_cycle: %{date_range: @date_range, total: 1}+ penultimate_cycle: %{date_range: @date_range, total: 1_100_000},+ last_cycle: %{date_range: @date_range, total: 1_100_000}}end)+ subscribe_to_enterprise_plan(+ user,+ monthly_pageview_limit: 1_000_000,+ subscription: [+ last_bill_date: Date.shift(Date.utc_today(), day: -1),+ status: unquote(status),+ # non-matching ID+ paddle_plan_id: @paddle_id_10k+ ]+ )++ CheckUsage.perform(nil, usage_stub)++ refute_email_delivered_with(+ to: [{nil, "[email protected]"}],+ subject: "#{team_of(user).name} has outgrown their enterprise plan"+ )+ end++ test "site limit exceeded -> sends internal email and starts manual lock grace period",+ %{+ user: user+ } dosubscribe_to_enterprise_plan(user,site_limit: 2,subscription: [@@ -468,39 +501,46 @@ defmodule Plausible.Workers.CheckUsageTest do])- new_site(owner: user)new_site(owner: user)new_site(owner: user)- CheckUsage.perform(nil, usage_stub)+ team = team_of(user)++ assert Plausible.Teams.Billing.site_usage(team) == 3++ CheckUsage.perform(nil)assert_email_delivered_with(to: [{nil, "[email protected]"}],- subject: "#{user.email} has outgrown their enterprise plan"+ subject: "#{team.name} has outgrown their enterprise plan",+ html_body: ~r/3 \/ 2/)- end- test "starts grace period when plan is outgrown", %{user: user} do- usage_stub =- Plausible.Teams.Billing- |> stub(:monthly_pageview_usage, fn _user ->- %{- penultimate_cycle: %{date_range: @date_range, total: 1_100_000},- last_cycle: %{date_range: @date_range, total: 1_100_000}- }- end)+ assert team |> Repo.reload() |> Plausible.Teams.GracePeriod.manual_lock_active?()+ end- subscribe_to_enterprise_plan(- user,- monthly_pageview_limit: 1_000_000,+ test "does not alert or start a grace period when site usage is exactly at the site limit",+ %{+ user: user+ } do+ subscribe_to_enterprise_plan(user,+ site_limit: 2,subscription: [last_bill_date: Date.shift(Date.utc_today(), day: -1),status: unquote(status)])- CheckUsage.perform(nil, usage_stub)- assert user |> team_of() |> Repo.reload() |> Plausible.Teams.GracePeriod.active?()+ new_site(owner: user)++ team = team_of(user)++ assert Plausible.Teams.Billing.site_usage(team) == 2++ CheckUsage.perform(nil)++ assert_no_emails_delivered()+ assert Repo.reload(team).grace_period == nilendendend