File size: 17,444 Bytes
6778ee0 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 | defmodule Plausible.Workers.CheckUsageTest do
use Plausible.DataCase, async: true
use Bamboo.Test
import Double
alias Plausible.Workers.CheckUsage
require Plausible.Billing.Subscription.Status
setup [:create_user, :create_site]
@paddle_id_10k "558018"
@date_range Date.range(Date.utc_today(), Date.utc_today())
@accepted_status_values [
Plausible.Billing.Subscription.Status.active(),
Plausible.Billing.Subscription.Status.past_due(),
Plausible.Billing.Subscription.Status.deleted()
]
test "ignores user without subscription" do
CheckUsage.perform(nil)
assert_no_emails_delivered()
end
test "operates on the current subscription",
%{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: :active
)
subscribe_to_plan(
user,
"wont-exist-should-crash",
last_bill_date: Date.shift(Date.utc_today(), day: -1),
inserted_at: DateTime.shift(DateTime.utc_now(), day: -2),
status: :deleted
)
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [user],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
end
test "sends more than one email", %{user: user} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
user2 = new_user()
new_site(owner: user2)
for u <- [user, user2] do
subscribe_to_plan(
u,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
next_bill_date: Date.shift(Date.utc_today(), day: +5),
status: :active
)
end
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [user],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
assert_email_delivered_with(
to: [user2],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
end
test "sends emails to billing members if available", %{user: user} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
user2 = new_user()
user3 = new_user()
new_site(owner: user)
team = team_of(user)
add_member(team, user: user2, role: :billing)
add_member(team, user: user3, role: :viewer)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
next_bill_date: Date.shift(Date.utc_today(), day: +5),
status: :active
)
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [user],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
assert_email_delivered_with(
to: [user2],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
refute_email_delivered_with(
to: [user3],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
end
test "ignores user with paused subscription", %{user: user} do
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: Plausible.Billing.Subscription.Status.paused()
)
CheckUsage.perform(nil)
assert_no_emails_delivered()
end
for status <- @accepted_status_values do
describe "#{status} subscription, regular customers" do
test "ignores user with subscription but no usage", %{user: user} do
subscribe_to_plan(user, @paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil)
assert_no_emails_delivered()
assert Repo.reload(team_of(user)).grace_period == nil
end
test "does not send an email if account has been over the limit for one billing month", %{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 9_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(user, @paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil, usage_stub)
assert_no_emails_delivered()
assert Repo.reload(team_of(user)).grace_period == nil
end
test "does not send an email if account is over the limit by less than 10%", %{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 10_999},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(user, @paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil, usage_stub)
assert_no_emails_delivered()
assert Repo.reload(team_of(user)).grace_period == nil
end
test "sends an email when an account is over their limit for two consecutive billing months",
%{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [user],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
assert Repo.reload(team_of(user)).grace_period.end_date ==
Date.shift(Date.utc_today(), day: 7)
end
test "sends an email suggesting enterprise plan when usage is greater than 10M ", %{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000_000},
last_cycle: %{date_range: @date_range, total: 11_000_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil, usage_stub)
assert_delivered_email_matches(%{html_body: html_body})
assert html_body =~
"Your usage exceeds our standard plans, so please reply back to this email for a tailored quote"
end
test "skips checking users who already have a grace period", %{user: user} do
%{grace_period: existing_grace_period} = Plausible.Teams.start_grace_period(team_of(user))
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(user, @paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil, usage_stub)
assert_no_emails_delivered()
assert Repo.reload(team_of(user)).grace_period.id == existing_grace_period.id
end
test "recommends a plan to upgrade to", %{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
)
CheckUsage.perform(nil, usage_stub)
assert_delivered_email_matches(%{
html_body: html_body
})
assert html_body =~ "We recommend you upgrade to the 100k pageviews/month plan"
end
test "clears grace period when plan is applicable again", %{user: user} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
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?()
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 9_000}
}
end)
CheckUsage.perform(nil, usage_stub)
refute user |> team_of() |> Repo.reload() |> Plausible.Teams.GracePeriod.active?()
end
end
end
for status <- @accepted_status_values do
describe "#{status} subscription, enterprise customers" do
test "skips checking enterprise users who already have a grace period", %{user: user} do
%{grace_period: existing_grace_period} =
Plausible.Teams.start_manual_lock_grace_period(team_of(user))
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)
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)
]
)
CheckUsage.perform(nil, usage_stub)
assert_no_emails_delivered()
assert Repo.reload(team_of(user)).grace_period.id == existing_grace_period.id
end
test "checks billable pageview usage for enterprise customer, sends usage information to enterprise@plausible.io",
%{
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)
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)
]
)
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [{nil, "enterprise@plausible.io"}],
subject: "#{user.email} has outgrown their enterprise plan"
)
end
test "will only check usage if enterprise plan matches subscription's paddle plan id",
%{
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)
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, "enterprise@plausible.io"}],
subject: "#{user.email} has outgrown their enterprise plan"
)
end
test "checks site limit for enterprise customer, sends usage information to enterprise@plausible.io",
%{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 1},
last_cycle: %{date_range: @date_range, total: 1}
}
end)
subscribe_to_enterprise_plan(user,
site_limit: 2,
subscription: [
last_bill_date: Date.shift(Date.utc_today(), day: -1),
status: unquote(status)
]
)
new_site(owner: user)
new_site(owner: user)
new_site(owner: user)
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [{nil, "enterprise@plausible.io"}],
subject: "#{user.email} has outgrown their enterprise plan"
)
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)
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)
]
)
CheckUsage.perform(nil, usage_stub)
assert user |> team_of() |> Repo.reload() |> Plausible.Teams.GracePeriod.active?()
end
end
end
describe "timing" do
test "checks usage one day after the last_bill_date", %{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: Date.shift(Date.utc_today(), day: -1)
)
CheckUsage.perform(nil, usage_stub)
assert_email_delivered_with(
to: [user],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
end
test "does not check exactly one month after last_bill_date", %{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(user, @paddle_id_10k, last_bill_date: ~D[2021-03-28])
CheckUsage.perform(nil, usage_stub, ~D[2021-03-28])
assert_no_emails_delivered()
end
test "for yearly subscriptions, checks usage multiple months + one day after the last_bill_date",
%{
user: user
} do
usage_stub =
Plausible.Teams.Billing
|> stub(:monthly_pageview_usage, fn _user ->
%{
penultimate_cycle: %{date_range: @date_range, total: 11_000},
last_cycle: %{date_range: @date_range, total: 11_000}
}
end)
subscribe_to_plan(
user,
@paddle_id_10k,
last_bill_date: ~D[2021-06-29]
)
CheckUsage.perform(nil, usage_stub, ~D[2021-08-30])
assert_email_delivered_with(
to: [user],
subject: "[Action required] You have outgrown your Plausible subscription tier"
)
end
end
end
|