Use the actual billing cycle dates in all usage-based Billing pages #14485

jankeromnes · 2022-11-07T16:02:32Z

Description

Use the actual billing cycle dates in all usage-based Billing pages

Related Issue(s)

Fixes #14363

How to test

Create a team called "Gitpod [Something]"
a. this enables usage-based for your user
Go to your personal billing page (/billing)
a. notice the billing cycle dates (from ~now to ~a month from now)
Upgrade by adding a credit card
a. notice the new billing cycle dates (from ~now to the last UTC millisecond of the month)

Hint: You can hover on the billing cycle dates to see their exact times.

Release Notes

NONE

Documentation

Werft options:

/werft with-local-preview
If enabled this will build install/preview
/werft with-preview
/werft with-large-vm
/werft with-integration-tests=all
Valid options are all, workspace, webapp, ide

werft-gitpod-dev-com · 2022-11-07T16:02:40Z

started the job as gitpod-build-jx-actual-billing-cycle.1 because the annotations in the pull request description changed
(with .werft/ from main)

jankeromnes · 2022-11-08T09:30:41Z

Insert coin to try again 🎰

/werft run

👍 started the job as gitpod-build-jx-actual-billing-cycle.3
(with .werft/ from main)

jankeromnes · 2022-11-08T11:04:05Z

Testing

Free Tier	After Adding Card	After Cancelling

DB state

mysql> select * from d_b_cost_center;
+-------------------------------------------+---------------+---------+----------------------------+--------------------------+-----------------+--------------------------+
| id                                        | spendingLimit | deleted | _lastModified              | creationTime             | billingStrategy | nextBillingTime          |
+-------------------------------------------+---------------+---------+----------------------------+--------------------------+-----------------+--------------------------+
| team:05b72264-1898-460f-abb2-bc0cc7711756 |             0 |       0 | 2022-11-08 09:51:53.479825 | 2022-11-08T09:51:53.474Z | other           | 2022-12-08T09:51:53.474Z |
| user:d99f1715-3c02-432b-bf5f-4326315b3fd2 |           500 |       0 | 2022-11-08 09:51:53.482185 | 2022-11-08T09:51:53.474Z | other           | 2022-12-08T09:51:53.474Z |
| user:d99f1715-3c02-432b-bf5f-4326315b3fd2 |          1000 |       0 | 2022-11-08 10:01:09.646614 | 2022-11-08T10:01:09.626Z | stripe          |                          |
| user:d99f1715-3c02-432b-bf5f-4326315b3fd2 |           500 |       0 | 2022-11-08 11:00:13.057955 | 2022-11-08T11:00:13.051Z | other           | 2022-12-08T11:00:13.051Z |
+-------------------------------------------+---------------+---------+----------------------------+--------------------------+-----------------+--------------------------+

components/dashboard/src/components/UsageBasedBillingConfig.tsx

svenefftinge

We need to add an explicit BillingCycleStart property to cost center. (see comment above)

components/usage/pkg/apiv1/usage.go

components/gitpod-protocol/src/gitpod-service.ts

jankeromnes · 2022-11-08T13:16:56Z

Need an explicit billing cycle start date in cost centers. Back to Draft 📝

components/gitpod-protocol/src/gitpod-service.ts

…Center API when it should be undefined 🙃

…e dates in usage-based Billing pages

svenefftinge

Looks good! Comments are mostly nits. The only thing we should look into soon is how to update the introduced column on the existing cost centers.

svenefftinge · 2022-11-11T11:14:14Z

components/usage/pkg/db/cost_center.go

@@ -180,6 +184,7 @@ func (c *CostCenterManager) UpdateCostCenter(ctx context.Context, newCC CostCent
 				return CostCenter{}, err
 			}

+			newCC.BillingCycleStart = NewVarcharTime(now)


Seems a little assymmetrical to have the start time but not the end time.
Do we know the end time for stripe as well?

@svenefftinge Good catch. We know the (approximate) end time for Stripe -- it's the last millisecond of the calendar month.

However, I wasn't fully sure of the implications of setting it. Will Gitpod do anything when it reaches a nextBillingTime for a Stripe CostCenter? (This would be problematic, because it's in fact Stripe's responsibility to issue and finalize an invoice, so I think Gitpod shouldn't do anything proactively on the Cost Center and instead wait for Stripe's callback.)

Yes, we wouldn't do the invoice finalization, of course. But this is clearly communicated through the billingStrategy. I just thought it seems strange that we have a starting time but no end time. One could argue that the start time is managed by stripe as well.

svenefftinge · 2022-11-11T11:18:02Z

components/usage/pkg/db/cost_center.go

@@ -311,6 +318,9 @@ func (c *CostCenterManager) ResetUsage(ctx context.Context, cc CostCenter) (Cost

 	now := time.Now().UTC()

+	// Resetting the usage always resets the billing cycle start time
+	billingCycleStart := now


nit: non-needed variable

svenefftinge · 2022-11-11T11:18:24Z

components/usage/pkg/db/cost_center.go

@@ -325,11 +335,12 @@ func (c *CostCenterManager) ResetUsage(ctx context.Context, cc CostCenter) (Cost

 	// All fields on the new cost center remain the same, except for CreationTime and NextBillingTime


nit: the comment is no longer 100% correct

svenefftinge · 2022-11-11T11:20:15Z

components/usage/pkg/apiv1/usage.go

+	BillingCycleStart := timestamppb.New(c.BillingCycleStart.Time())
+	if !c.BillingCycleStart.IsSet() {
+		BillingCycleStart = nil
+	}


nit: would be good to introduce a method that does the conversion

@svenefftinge Good idea. Where should this method live? Is it possible to add it to go.Time or timestamppb somehow?

I would put it into /workspace/gitpod/components/usage/pkg/db/types.go. @easyCZ wdyt?

The DB package shouldn't have any dependency on API level packages. If we need a conversion, it should be in the API package

@easyCZ So in usage.go is fine? 😇

I'd create apiv1/time.go or apiv1/types.go and put it there. There's nothing wrong with it being in usage.go but it could make it harder to discover that the helper exists. As per go guidance, avoiding files such as util or helper or tools is recommended to avoid kitchen-sink scenarios.

types.go is fairly standard and often used for the underlying types and conversions.

Thanks for the guidance 👍

As per go guidance, avoiding files such as util or helper or tools is recommended to avoid kitchen-sink scenarios.

💯 💯 💯 (love this about Go -- util is one of my pet peeves)

components/gitpod-db/src/typeorm/migration/1667919924081-CostCenterBillingCycleStart.ts

components/dashboard/src/components/UsageBasedBillingConfig.tsx

roboquat added release-note-none do-not-merge/work-in-progress labels Nov 7, 2022

roboquat added the size/M label Nov 7, 2022

jankeromnes force-pushed the jx/actual-billing-cycle branch from 28a9896 to e6b8596 Compare November 7, 2022 16:05

jankeromnes force-pushed the jx/actual-billing-cycle branch from e6b8596 to 9bad6c3 Compare November 8, 2022 10:32

jankeromnes commented Nov 8, 2022

View reviewed changes

components/dashboard/src/components/UsageBasedBillingConfig.tsx Show resolved Hide resolved

jankeromnes marked this pull request as ready for review November 8, 2022 11:11

jankeromnes requested a review from a team November 8, 2022 11:11

roboquat removed the do-not-merge/work-in-progress label Nov 8, 2022

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

svenefftinge reviewed Nov 8, 2022

View reviewed changes

components/usage/pkg/apiv1/usage.go Outdated Show resolved Hide resolved

components/gitpod-protocol/src/gitpod-service.ts Outdated Show resolved Hide resolved

jankeromnes marked this pull request as draft November 8, 2022 13:17

roboquat added the do-not-merge/work-in-progress label Nov 8, 2022

jankeromnes force-pushed the jx/actual-billing-cycle branch from 9bad6c3 to 4893567 Compare November 8, 2022 16:39

roboquat added size/L and removed size/M labels Nov 8, 2022

jankeromnes commented Nov 8, 2022

View reviewed changes

components/gitpod-protocol/src/gitpod-service.ts Show resolved Hide resolved

jankeromnes force-pushed the jx/actual-billing-cycle branch 6 times, most recently from dc8d8a7 to e8e124c Compare November 9, 2022 14:03

[usage] Introduce an explicit CostCenter.BillingCycleStart time

da099d3

jankeromnes force-pushed the jx/actual-billing-cycle branch 2 times, most recently from de11def to 7822137 Compare November 10, 2022 20:29

jankeromnes added 2 commits November 11, 2022 10:18

[usage] Don't pass '0001-01-01T00:15:00Z' timestamps through the Cost…

9258ade

…Center API when it should be undefined 🙃

[server][dashboard] Fetch and use the actual cost center billing cycl…

e65dc3a

…e dates in usage-based Billing pages

jankeromnes force-pushed the jx/actual-billing-cycle branch from 7822137 to e65dc3a Compare November 11, 2022 10:18

jankeromnes marked this pull request as ready for review November 11, 2022 10:43

roboquat removed the do-not-merge/work-in-progress label Nov 11, 2022

jankeromnes requested a review from a team November 11, 2022 10:43

svenefftinge approved these changes Nov 11, 2022

View reviewed changes

roboquat merged commit 0d740fc into main Nov 11, 2022

roboquat deleted the jx/actual-billing-cycle branch November 11, 2022 11:32

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

jankeromnes added a commit that referenced this pull request Nov 15, 2022

[usage] Address nits from #14485

32c6638

jankeromnes mentioned this pull request Nov 15, 2022

[Usage-based] Untie paid Stripe subscriptions from calendar months #14705

Merged

7 tasks

jankeromnes added a commit that referenced this pull request Nov 15, 2022

[usage] Address nits from #14485

2dfe73d

jankeromnes added a commit that referenced this pull request Nov 16, 2022

[usage] Address nits from #14485

3a01dee

jankeromnes added a commit that referenced this pull request Nov 16, 2022

[usage] Address nits from #14485

1ecbc93

jankeromnes added a commit that referenced this pull request Nov 16, 2022

[usage] Address nits from #14485

cfdda85

roboquat pushed a commit that referenced this pull request Nov 16, 2022

[usage] Address nits from #14485

e97e8e9

gtsiolis mentioned this pull request Jan 2, 2023

Use the actual current period when visiting the usage page #15544

Closed

		@@ -325,11 +335,12 @@ func (c *CostCenterManager) ResetUsage(ctx context.Context, cc CostCenter) (Cost

		// All fields on the new cost center remain the same, except for CreationTime and NextBillingTime

Use the actual billing cycle dates in all usage-based Billing pages #14485

Use the actual billing cycle dates in all usage-based Billing pages #14485

Uh oh!

Conversation

jankeromnes commented Nov 7, 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!

werft-gitpod-dev-com bot commented Nov 7, 2022

Uh oh!

jankeromnes commented Nov 8, 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 commented Nov 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

DB state

Uh oh!

Uh oh!

svenefftinge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jankeromnes commented Nov 8, 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!

Uh oh!

svenefftinge left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jankeromnes commented Nov 7, 2022 •

edited

Loading

jankeromnes commented Nov 8, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 8, 2022 •

edited

Loading

jankeromnes commented Nov 8, 2022 •

edited by werft-gitpod-dev-com bot

Loading