[UBP] Add `getUsageLimit` and `setUsageLimit` methods to server #12767

andrew-farries · 2022-09-08T11:45:09Z

Description

Add two new methods to the server API for getting and setting usage limits. Both new functions take an attributionId and work for both users and teams.

For backwards compatibility, leave the getUsageLimitForTeam and setUsageLimitForTeam methods as they are still used by the dashboard, but change them to be implemented in terms of the more general get/set methods.

Related Issue(s)

Part of #12685

How to test

Create a team with Gitpod in the name in the preview environment and sign the team up for usage based pricing.
Run the following in the browser developer console:

await window._gp.gitpodService.server.setUsageLimit('team:<teamId of the new team>', 90)

Then:

await window._gp.gitpodService.server.getUsageLimit('team:<teamId of the new team>')

The team usage limit can also be updated from the team billing page.

The usage limits for the team are correctly persisted.

Setting usage limits from the the UI for individual users will be done in a later PR.

Release Notes

NONE

Documentation

Werft options:

/werft with-preview
/werft with-payment

werft-gitpod-dev-com · 2022-09-08T11:49:43Z

started the job as gitpod-build-af-usage-limit-set-get-for-users.2 because the annotations in the pull request description changed
(with .werft/ from main)

components/server/ee/src/workspace/gitpod-server-impl.ts

components/server/src/auth/rate-limiter.ts

andrew-farries · 2022-09-09T09:28:50Z

This has some conflicts to resolve now that #12776 is merged (putting costcenter access behind an API).

Moving back to draft until that's done.

andrew-farries · 2022-09-09T15:22:20Z

/hold because it's based on #12843

In particular avoid the use of `||` against an enum type that can be 0. See: #12767 (comment)

svenefftinge · 2022-09-12T06:07:53Z

components/server/ee/src/workspace/gitpod-server-impl.ts

+        switch (attrId.kind) {
+            case "team":
+                const team = await this.guardTeamOperation(attrId.teamId, "update");
+                await this.ensureStripeApiIsAllowed({ team });


This checks for m.mode === "usage-based" || (m.mode === "chargebee" && !!m.canUpgradeToUBB) which seems like I could then change my spendinglimit although I haven't put my credit card into stripe, yet.
Maybe we should reconsider the special 'chargebee' case? What was the idea of it? cc @geropl

Let's remove the ensureStripeApiIsAllowed checks here as well. The check below testing the billingStrategy !== "stripe" is doing what we need and is more explicit.

@svenefftinge Originally, Chargebee and Usage-Limit was strictly independent. After last weeks discussion, they are not anymore.

Let's remove the ensureStripeApiIsAllowed checks here as well.

💯 Agreed!

@andrew-farries do you agree to remove the calls to ensureStripeApiIsAllowed?

Yes; I've removed them in a650ae7

components/server/ee/src/workspace/gitpod-server-impl.ts

andrew-farries · 2022-09-12T07:21:50Z

/unhold because #12843 is merged.

svenefftinge · 2022-09-12T07:38:14Z

components/server/ee/src/workspace/gitpod-server-impl.ts

+        const user = this.checkAndBlockUser("getUsageLimit");
+        if (attrId.kind === "team") {
+            const team = await this.guardTeamOperation(attrId.teamId, "get");
+            await this.ensureStripeApiIsAllowed({ team });


Sorry if I wasn't clear. I meant to remove these calls for both attribution kinds (user and team).

Removed this check aswell.

andrew-farries · 2022-09-13T14:21:39Z

Needs rebased again now that #12903 landed 😅

Add two new methods to the server API for getting and setting usage limits. Both new functions take an attributionId and work for both users and teams. For backwards compatibility, leave the `getUsageLimitForTeam` and `setUsageLimitForTeam` methods as they are still used by the dashboard, but change them to be implemented in terms of the more general `get/set` methods.

Also the `guardTeamOperation` call as both are not needed given the `guardCostCenterAccess` call below.

svenefftinge

👍

In particular avoid the use of `||` against an enum type that can be 0. See: #12767 (comment)

andrew-farries requested a review from a team September 8, 2022 11:45

roboquat added release-note-none size/M labels Sep 8, 2022

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

andrew-farries mentioned this pull request Sep 8, 2022

[UBP for individuals] Configure usage-based billing in personal settings #12685

Closed

17 tasks

geropl reviewed Sep 8, 2022

View reviewed changes

components/server/ee/src/workspace/gitpod-server-impl.ts Outdated Show resolved Hide resolved

andrew-farries marked this pull request as draft September 8, 2022 14:43

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

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 1b147ee to 150fcd2 Compare September 9, 2022 06:01

roboquat added size/L and removed size/M labels Sep 9, 2022

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 150fcd2 to 791eea4 Compare September 9, 2022 06:31

roboquat added size/M and removed size/L labels Sep 9, 2022

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 791eea4 to 3a73019 Compare September 9, 2022 06:42

andrew-farries changed the title ~~[UBP] Add (get|set)UsageLimitForUser methods to server~~ [UBP] Add getUsageLimitFor and setUsageLimitFor methods to server Sep 9, 2022

andrew-farries marked this pull request as ready for review September 9, 2022 07:02

roboquat removed the do-not-merge/work-in-progress label Sep 9, 2022

andrew-farries requested a review from geropl September 9, 2022 07:02

geropl reviewed Sep 9, 2022

View reviewed changes

components/server/ee/src/workspace/gitpod-server-impl.ts Outdated Show resolved Hide resolved

geropl reviewed Sep 9, 2022

View reviewed changes

components/server/ee/src/workspace/gitpod-server-impl.ts Outdated Show resolved Hide resolved

geropl reviewed Sep 9, 2022

View reviewed changes

components/server/ee/src/workspace/gitpod-server-impl.ts Outdated Show resolved Hide resolved

geropl reviewed Sep 9, 2022

View reviewed changes

components/server/src/auth/rate-limiter.ts Outdated Show resolved Hide resolved

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 5d9e40f to d7fbf86 Compare September 9, 2022 07:52

andrew-farries requested a review from geropl September 9, 2022 07:53

andrew-farries changed the title ~~[UBP] Add getUsageLimitFor and setUsageLimitFor methods to server~~ [UBP] Add getUsageLimit and setUsageLimit methods to server Sep 9, 2022

andrew-farries marked this pull request as draft September 9, 2022 09:28

roboquat added the do-not-merge/work-in-progress label Sep 9, 2022

roboquat added the do-not-merge/hold label Sep 9, 2022

Base automatically changed from af/fix-usage-sugar-file to main September 12, 2022 06:00

roboquat pushed a commit that referenced this pull request Sep 12, 2022

Use correct return type rather than casting

2d3f0c3

In particular avoid the use of `||` against an enum type that can be 0. See: #12767 (comment)

roboquat added size/L and removed size/M labels Sep 12, 2022

svenefftinge reviewed Sep 12, 2022

View reviewed changes

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 850610e to 568f5f2 Compare September 12, 2022 06:30

roboquat added size/M and removed size/L labels Sep 12, 2022

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 568f5f2 to b86fba1 Compare September 12, 2022 07:31

svenefftinge reviewed Sep 12, 2022

View reviewed changes

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from b86fba1 to a1b0c95 Compare September 12, 2022 07:53

andrew-farries removed the do-not-merge/hold label Sep 12, 2022

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from a1b0c95 to f02cdb4 Compare September 13, 2022 09:11

andrew-farries requested a review from svenefftinge September 13, 2022 09:44

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from f02cdb4 to 35e207c Compare September 13, 2022 14:43

andrew-farries force-pushed the af/usage-limit-set-get-for-users branch from 35e207c to 6d9c770 Compare September 14, 2022 05:54

Remove ensureStripeApiIsAllowed calls

a650ae7

Also the `guardTeamOperation` call as both are not needed given the `guardCostCenterAccess` call below.

svenefftinge approved these changes Sep 14, 2022

View reviewed changes

roboquat merged commit 5350b91 into main Sep 14, 2022

roboquat deleted the af/usage-limit-set-get-for-users branch September 14, 2022 06:58

andrew-farries mentioned this pull request Sep 14, 2022

[UBP] Allow individual users to sign up for usage based pricing #12942

Merged

2 tasks

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

andrew-farries mentioned this pull request Sep 14, 2022

[UBP] Remove team specific Stripe APIs from server JSON-RPC API #12957

Merged

2 tasks

iQQBot pushed a commit that referenced this pull request Sep 14, 2022

Use correct return type rather than casting

3a6f195

In particular avoid the use of `||` against an enum type that can be 0. See: #12767 (comment)

[UBP] Add getUsageLimit and setUsageLimit methods to server #12767

[UBP] Add getUsageLimit and setUsageLimit methods to server #12767

Uh oh!

Conversation

andrew-farries commented Sep 8, 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 Sep 8, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrew-farries commented Sep 9, 2022

Uh oh!

andrew-farries commented Sep 9, 2022

Uh oh!

svenefftinge Sep 12, 2022

Choose a reason for hiding this comment

Uh oh!

svenefftinge Sep 12, 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!

geropl Sep 12, 2022

Choose a reason for hiding this comment

Uh oh!

svenefftinge Sep 14, 2022

Choose a reason for hiding this comment

Uh oh!

andrew-farries Sep 14, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrew-farries commented Sep 12, 2022

Uh oh!

svenefftinge Sep 12, 2022

Choose a reason for hiding this comment

Uh oh!

andrew-farries Sep 12, 2022

Choose a reason for hiding this comment

Uh oh!

andrew-farries commented Sep 13, 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!

svenefftinge left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[UBP] Add `getUsageLimit` and `setUsageLimit` methods to server #12767

[UBP] Add `getUsageLimit` and `setUsageLimit` methods to server #12767

andrew-farries commented Sep 8, 2022 •

edited

Loading

svenefftinge Sep 12, 2022 •

edited

Loading

andrew-farries commented Sep 13, 2022 •

edited by werft-gitpod-dev-com bot

Loading