analytics/lib/workers/check_usage.ex
RobertJoonas 3d2f356ba7
Refactor enterprise plan upgrade and change-plan actions (#3397)
* rename enterprise?/1 function

* change link text to Upgrade when subscription deleted

* extract paddle_button and paddle_script components

* create a new upgrade-to-enterprise-plan page

* extract upgrade_link component

* rename function

* link to enterprise plan upgrade page from settings

...if the user has an enterprise plan configured

* fetch enterprise plan price on the new page

* add change_enterprise_plan functionality on the new page

* render existing change_enterprise_plan_contact_us.html

...when subscribed to latest configured enterprise plan

* rename vars and extract resumable? fn

* remove dead billing route

* small test refactor: extract convenience fn

* add tests for...

...restricting paused and past_due subscription access to the new
enterprise plan page.

1. redirect to /settings from the controller action
2. hiding the change-plan link from the user settings

* implement redirect to /settings

* hide the enterprise upgrade/change-plan link

* add tests for a deleted enterprise subscription

* plug in the new controller action and delete dead code

* optimize for dark mode

* fix compile warning

* credo fix

* display N/A instead of crash when price nil

* change subscription.status type to Ecto.Enum

Also, create a new `Subscription.Status` module that exposes macros to
return the used atom values (prevent typos at compiletime).

* fix bug (@conn not available anymore)

* use Routes.billing_path where applicable

* add a status() type

* silence credo

* refactor suggestion from review

Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>

* Remove the __using__ macro from Subscription.Status

... instead be explicit about requires and aliases and also order
the use, import, require, and alias clauses according to
https://github.com/christopheradams/elixir_style_guide#module-attribute-ordering

* drop the virtual Enteprise 'price_per_interval' field

* apply review suggestion to make the code more DRY

* use dot syntax to fetch current user in new controller actions

* fix formatting

---------

Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
2023-10-10 20:35:17 +03:00

152 lines
4.4 KiB
Elixir

defmodule Plausible.Workers.CheckUsage do
use Plausible.Repo
use Oban.Worker, queue: :check_usage
require Plausible.Billing.Subscription.Status
alias Plausible.Billing.Subscription
defmacro yesterday() do
quote do
fragment("now() - INTERVAL '1 day'")
end
end
defmacro last_day_of_month(day) do
quote do
fragment(
"(date_trunc('month', ?::date) + interval '1 month' - interval '1 day')::date",
unquote(day)
)
end
end
defmacro day_of_month(date) do
quote do
fragment("EXTRACT(day from ?::date)", unquote(date))
end
end
defmacro least(left, right) do
quote do
fragment("least(?, ?)", unquote(left), unquote(right))
end
end
@impl Oban.Worker
def perform(_job, billing_mod \\ Plausible.Billing, today \\ Timex.today()) do
yesterday = today |> Timex.shift(days: -1)
active_subscribers =
Repo.all(
from(u in Plausible.Auth.User,
join: s in Plausible.Billing.Subscription,
on: s.user_id == u.id,
left_join: ep in Plausible.Billing.EnterprisePlan,
on: ep.user_id == u.id,
where: is_nil(u.grace_period),
where: s.status == ^Subscription.Status.active(),
where: not is_nil(s.last_bill_date),
# Accounts for situations like last_bill_date==2021-01-31 AND today==2021-03-01. Since February never reaches the 31st day, the account is checked on 2021-03-01.
where:
least(day_of_month(s.last_bill_date), day_of_month(last_day_of_month(^yesterday))) ==
day_of_month(^yesterday),
preload: [subscription: s, enterprise_plan: ep]
)
)
for subscriber <- active_subscribers do
if subscriber.enterprise_plan do
check_enterprise_subscriber(subscriber, billing_mod)
else
check_regular_subscriber(subscriber, billing_mod)
end
end
:ok
end
def check_enterprise_subscriber(subscriber, billing_mod) do
pageview_limit = check_pageview_limit(subscriber, billing_mod)
site_limit = check_site_limit_for_enterprise(subscriber)
case {pageview_limit, site_limit} do
{{:within_limit, _}, {:within_limit, _}} ->
nil
{{_, {last_cycle, last_cycle_usage}}, {_, {site_usage, site_allowance}}} ->
template =
PlausibleWeb.Email.enterprise_over_limit_internal_email(
subscriber,
last_cycle_usage,
last_cycle,
site_usage,
site_allowance
)
Plausible.Mailer.send(template)
subscriber
|> Plausible.Auth.GracePeriod.start_manual_lock_changeset(last_cycle_usage)
|> Repo.update()
end
end
defp check_regular_subscriber(subscriber, billing_mod) do
case check_pageview_limit(subscriber, billing_mod) do
{:over_limit, {last_cycle, last_cycle_usage}} ->
suggested_plan = Plausible.Billing.Plans.suggest(subscriber, last_cycle_usage)
template =
PlausibleWeb.Email.over_limit_email(
subscriber,
last_cycle_usage,
last_cycle,
suggested_plan
)
Plausible.Mailer.send(template)
subscriber
|> Plausible.Auth.GracePeriod.start_changeset(last_cycle_usage)
|> Repo.update()
_ ->
nil
end
end
defp check_pageview_limit(subscriber, billing_mod) do
limit =
subscriber.subscription
|> Plausible.Billing.Quota.monthly_pageview_limit()
|> Kernel.*(1.1)
|> ceil()
{_, last_cycle} = billing_mod.last_two_billing_cycles(subscriber)
{last_last_cycle_usage, last_cycle_usage} =
billing_mod.last_two_billing_months_usage(subscriber)
exceeded_last_cycle? = not Plausible.Billing.Quota.within_limit?(last_cycle_usage, limit)
exceeded_last_last_cycle? =
not Plausible.Billing.Quota.within_limit?(last_last_cycle_usage, limit)
if exceeded_last_last_cycle? && exceeded_last_cycle? do
{:over_limit, {last_cycle, last_cycle_usage}}
else
{:within_limit, {last_cycle, last_cycle_usage}}
end
end
defp check_site_limit_for_enterprise(subscriber) do
limit = subscriber.enterprise_plan.site_limit
usage = Plausible.Billing.Quota.site_usage(subscriber)
if Plausible.Billing.Quota.within_limit?(usage, limit) do
{:within_limit, {usage, limit}}
else
{:over_limit, {usage, limit}}
end
end
end