Introduce BillingMode (1/4) #11812

geropl · 2022-08-02T15:56:40Z

Description

This PR introduces BiIllingMode, which at it's core is an enum which tells you how a given user (and their usage) is billed. We use this abstraction to guide the (gradual) rollout of Usage-based Pricing, and later to phase out Chargebee.

This changeset does not change any behavior, but rather adds the interface, methods to derive the current state for a given User/Team and tests for said implementation. It's 1 of 4 in a stack.

Related Issue(s)

Context: #11402

How to test

(cd components/server && leeway build .:dbtest)

Release Notes

NONE

Documentation

Werft options:

/werft with-preview
/werft with-payment

geropl · 2022-08-02T15:56:51Z

/werft run

👍 started the job as gitpod-build-gpl-billing-mode.1
(with .werft/ from main)

geropl · 2022-08-02T16:05:37Z

/werft run

👍 started the job as gitpod-build-gpl-billing-mode.2
(with .werft/ from main)

🤞 test timeouts...

jankeromnes

Many thanks @geropl for powering through the first implementation and then the cleaner split! 💯

The code looks good to me (modulo some minor comments, please take a look and either address or dismiss), and the tests really build a ton of confidence here. Another thank you for always diligently adding lots of tests alongside your PRs 💯 I think these play a major role in Gitpod not falling apart as complexity grows. 💪

Would have been nice to be able to test this manually as well (e.g. with preview & payment & chargebee enabled, and double-checking the billing mode in various scenarii) but I guess we can do that in follow-up PRs too, so not a blocker.

/hold

components/gitpod-protocol/src/billing-mode.ts

components/gitpod-protocol/src/team-subscription-protocol.ts

jankeromnes · 2022-08-03T07:48:30Z

components/server/ee/src/billing/billing-mode.spec.db.ts

+            },
+            // user: transition chargebee -> UBB
+            {
+                name: "user: chargbee paid personal (cancelled) + team seat",


The endDate in the future threw me off a bit. Maybe you could clarify this comment a bit?

chargebee paid personal (cancelled but still active)

(Had forgotten about the two dimensions "cancelled" vs "active")

cancellationDate is the date when we click "cancel"

endDate is when the subscription is no longer effective (currently: end of billing period)

Instead of setting endDate to "end of billing period", I think should prorate and set it to "cancellationDate + 24h", to give room for a safe transition period from Chargebee to Stripe (as discussed here internally).

☁️ I'm just realizing that the current implementation here does not support that use-case very well, though. 😢
If you are still on a team seat, and deliberately want to upgrade to "personal usage-based", then you also want to ripe the benefits of that. @jankeromnes Would be awesome if we can find 10mins of sync time on this and adjust.

Addressed here.

jankeromnes · 2022-08-03T08:13:29Z

One follow-up remark: As a sanity check, I tried to make your tests fail on purpose, by making a random change in the expectations: 89cde61

However, it seems that my build went through without complaining. 😬 How can we be certain that the tests are actually executed?

werft-gitpod-dev-com · 2022-08-04T09:18:43Z

started the job as gitpod-build-gpl-billing-mode.3 because the annotations in the pull request description changed
(with .werft/ from main)

AlexTugarev · 2022-08-04T09:19:57Z

/werft run

👍 started the job as gitpod-build-gpl-billing-mode.4
(with .werft/ from main)

werft-gitpod-dev-com · 2022-08-04T09:21:27Z

started the job as gitpod-build-gpl-billing-mode.5 because the annotations in the pull request description changed
(with .werft/ from main)

geropl · 2022-08-04T09:28:17Z

@AlexTugarev After discussing with @jankeromnes I'm actively working on further simplyfing this. sorry for not communicating earlier on the PR 😕

geropl · 2022-08-04T09:55:59Z

@jankeromnes I came up with a new approach which addresses all of your comments here (complexity), here (cleared modifiers: cmp. canUpgradeToUBB) and here.

The core change is that UBB now is "gready": If you have at least one UBB team Seat, or a personal UBB subscription, that "overrides" your Chargebee one. This way we can ensure you receive the benefits of UBB (workspace classes) immediately.
In the end this makes the code far nicer as well. 🧘 🙃

geropl · 2022-08-04T09:59:43Z

components/gitpod-protocol/src/billing-mode.ts

+        mode: "none",
+    };
+
+    export function showChargebeeBilling(billingMode: BillingMode): boolean {


These functions are not used nor tested, yet, but helped me greatly when thinking about how we want to used BillingMode later on. Left them in for reference and to ensure our usage is in line with the implementation/derivation logic.

jankeromnes · 2022-08-04T14:25:08Z

components/server/ee/src/billing/billing-mode.ts

+
+        // 1. UBB enabled?
+        if (!isUsageBasedBillingEnabled) {
+            // No Chargebee subscription, and UBB is not enabled: chargebee (free)


Nit: This comment is inaccurate (we don't know that here are no chargebee subscriptions because we didn't check yet)

jankeromnes · 2022-08-04T14:31:45Z

components/server/ee/src/billing/billing-mode.ts

+        // 2. Any Chargbee TeamSubscription2 (old Team Subscriptions are not relevant here, as they are not associated with a team)
+        const teamSubscription = await this.teamSubscription2Db.findForTeam(team.id, now);
+        if (teamSubscription && TeamSubscription2.isActive(teamSubscription, now)) {
+            if (isUsageBasedBillingEnabled && TeamSubscription2.isCancelled(teamSubscription, now)) {


Nit: I think you don't need to check isUsageBasedBillingEnabled here (we know it's true, because otherwise we would have already bailed out in the UBB check above)

jankeromnes · 2022-08-04T14:35:31Z

How to test

(cd components/server && leeway build .:db-test)

Oops:

$ cd components/server

$ leeway build .:db-test
FATA[0000] package "components/server:db-test" does not exist

geropl · 2022-08-04T14:36:46Z

@jankeromnes Sorry, it's: leeway build .:dbtest 🙄

jankeromnes · 2022-08-04T14:39:50Z

Thanks!

Cannot double-approve: Please fix the two conflicts and feel free to merge! 🛹 😁

geropl · 2022-08-04T14:40:55Z

Cannot double-approve: Please fix the two conflicts and feel free to merge! skateboard grin

Thank you, @jankeromnes! 🚀 🙏

geropl · 2022-08-04T15:11:27Z

/unhold

Did rebase, and ran tests again 🙃

geropl requested a review from a team August 2, 2022 15:56

roboquat added the release-note-none label Aug 2, 2022

roboquat added the size/XXL label Aug 2, 2022

geropl requested a review from jankeromnes August 2, 2022 15:56

github-actions bot added the team: webapp Issue belongs to the WebApp team label Aug 2, 2022

This was referenced Aug 2, 2022

BillingMode: add Json RPC API methods (2/4) #11813

Merged

Introduce BillingModes #11601

Closed

jankeromnes self-assigned this Aug 3, 2022

jankeromnes approved these changes Aug 3, 2022

View reviewed changes

roboquat added the do-not-merge/hold label Aug 3, 2022

geropl marked this pull request as draft August 4, 2022 09:27

roboquat added the do-not-merge/work-in-progress label Aug 4, 2022

geropl force-pushed the gpl/billing-mode branch from 9b1097f to ccc20fa Compare August 4, 2022 09:51

geropl marked this pull request as ready for review August 4, 2022 09:56

roboquat removed the do-not-merge/work-in-progress label Aug 4, 2022

geropl requested a review from jankeromnes August 4, 2022 09:56

geropl commented Aug 4, 2022

View reviewed changes

jankeromnes reviewed Aug 4, 2022

View reviewed changes

geropl added 4 commits August 4, 2022 14:42

[server] Format commit

a331b2f

[server] Install dev dependency "deep-equal-in-any-order"

a335165

[server] Make ConfigCatClientFactory injectable

74b3146

[server] Introduce BillingMode incl. tests

a1435e3

geropl force-pushed the gpl/billing-mode branch from ccc20fa to a1435e3 Compare August 4, 2022 14:43

roboquat removed the do-not-merge/hold label Aug 4, 2022

roboquat merged commit 5c1074b into main Aug 4, 2022

roboquat deleted the gpl/billing-mode branch August 4, 2022 15:11

roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Aug 5, 2022

Introduce BillingMode (1/4) #11812

Introduce BillingMode (1/4) #11812

Uh oh!

Conversation

geropl commented Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

Uh oh!

geropl commented Aug 2, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

geropl commented Aug 2, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jankeromnes Aug 3, 2022

Choose a reason for hiding this comment

Uh oh!

geropl Aug 3, 2022

Choose a reason for hiding this comment

Uh oh!

geropl Aug 4, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes commented Aug 3, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

werft-gitpod-dev-com bot commented Aug 4, 2022

Uh oh!

AlexTugarev commented Aug 4, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

werft-gitpod-dev-com bot commented Aug 4, 2022

Uh oh!

geropl commented Aug 4, 2022

Uh oh!

geropl commented Aug 4, 2022

Uh oh!

geropl Aug 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jankeromnes Aug 4, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes Aug 4, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes commented Aug 4, 2022

How to test

Uh oh!

geropl commented Aug 4, 2022

Uh oh!

jankeromnes commented Aug 4, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

geropl commented Aug 4, 2022

Uh oh!

geropl commented Aug 4, 2022

Uh oh!

Uh oh!

geropl commented Aug 2, 2022 •

edited

Loading

geropl commented Aug 2, 2022 •

edited by werft-gitpod-dev-com bot

Loading

geropl commented Aug 2, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Aug 3, 2022 •

edited by werft-gitpod-dev-com bot

Loading

AlexTugarev commented Aug 4, 2022 •

edited by werft-gitpod-dev-com bot

Loading

geropl Aug 4, 2022 •

edited

Loading

jankeromnes commented Aug 4, 2022 •

edited by werft-gitpod-dev-com bot

Loading