When starting a workspace but usage attribution is unclear, prompt for explicit user choice #11777

jankeromnes · 2022-08-01T15:21:43Z

Description

When starting a workspace but usage attribution is unclear, prompt for explicit user choice.

Possible unclear situations:

User is a member of multiple teams with usage-based billing enabled
User explicitly chose to attribute to a team, but they've since left this team (or the team was deleted, or its subscription was cancelled)

Related Issue(s)

Fixes #11579

How to test

Start a workspace on any repo (should work)
Create a team called "Gitpod" (or "Gitpod 1", "Gitpod 2"... whichever is available) to enable the Usage-Based Billing flag
Start a new workspace on any repo (should work)
Upgrade your team to Usage-Based Billing by adding a payment method (e.g. 4242 4242 4242 4242, 4/24, 424)
Start a new workspace on any repo (should still work)
Create a new team (called anything you want)
Start a new workspace (should work)
Upgrade your second team to usage-based billing
Start a new workspace -- this time it should fail (unclear which team to bill) and ask you for an explicit choice
Select your second team -- this should retry the workspace start, and succeed
Delete your second team
Start a new workspace -- this time it should fail again (explicit choice is no longer valid) and ask you for a new choice

Release Notes

NONE

Documentation

Werft options:

/werft with-preview
/werft with-payment

andrew-farries

PR description doesn't seem to match the code 😄

AIUI this PR just removes the automatic attribution when a team signs up for Stripe.

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

components/server/src/user/user-service.ts

jankeromnes · 2022-08-01T15:34:25Z

Whoops, this was meant to be a Draft. 😅 Thanks for the quick review though @andrew-farries! 🙏

werft-gitpod-dev-com · 2022-08-02T09:24:29Z

started the job as gitpod-build-jx-attribution-prompt.3 because the annotations in the pull request description changed
(with .werft/ from main)

components/server/src/user/user-service.ts

jankeromnes · 2022-08-03T13:10:27Z

@gtsiolis If you have some time, could you please provide some advice on the UX? 🙂

I went with a very basic, non-dismissible Modal, but it's still quite rough:

When Starting a Workspace	User Billing Settings

gtsiolis · 2022-08-04T08:39:08Z

Looking at this now! 👀

UPDATE: Posted some thoughts in a relevant discussion (internal).

AlexTugarev · 2022-08-04T08:56:11Z

components/dashboard/src/components/BillingAccountSelector.tsx

+export function BillingAccountSelector(props: { onSelected?: () => void }) {
+    const { user, setUser } = useContext(UserContext);
+    const { teams } = useContext(TeamsContext);
+    const [teamsWithBillingEnabled, setTeamsWithBillingEnabled] = useState<Team[] | undefined>();


@jankeromnes, I bet this is not the single place, where we'd need this kind of info. have you considered promoting this flag to the result of getTeams? team.isBillingEnabled would be nice and it shave off the additional requests.

@AlexTugarev I think this would be premature, because:

I can't imagine other places that will need the same information currently (note: this billing account selector component is already reusable, and in fact it's already used in two places)

I don't think it's wise to make getTeams load all the team subscriptions on every call, even when most callers don't need that currently

components/dashboard/src/components/BillingAccountSelector.tsx

components/dashboard/src/start/CreateWorkspace.tsx

AlexTugarev · 2022-08-04T09:09:29Z

components/gitpod-protocol/src/messaging/error.ts

+    export const PAYMENT_ERROR = 450;
+
+    // 455 Invalid cost center (custom status code)
+    export const INVALID_COST_CENTER = 455;


can we agree on a common prefix for everything payment related, please?

also see https://github.com/gitpod-io/gitpod/pull/11576/files#diff-3bb6d890c14ac42bf9860578a9f6a85ffd0121dbf980055baa99f8b7731c46daR45

and feel free to comment on that BTW!

alternative way to approach this, we could use just PAYMENT_ERROR (in similar cases) and encode specific conditions into the payload. it feels like we'll have the needs to extends for more error modes. wdyt?

I don't see much value in aligning every payment-related error around a single prefix or error code range (apart from readability of the error codes list -- which we arguably don't read that often).

Personally, I'd prefer to leave this as is (unless you have a strong opinion towards a different error name or code), and you can use whichever convention seems best in your PR. We can always align later if you think it's valuable, but I suspect that aligning these is not important in the grand scheme of things. 😇

jankeromnes · 2022-08-05T08:27:39Z

Thanks for the reviews!

I guess this is now ready to be merged, unless you have any final requests. 🙂

geropl · 2022-08-05T10:19:18Z

components/server/src/user/user-service.ts

+        }
+    }
+
+    protected async findSingleTeamWithUsageBasedBilling(user: User): Promise<Team | undefined> {


FYI: This can also come out of BillingMode: we already gather the data there, and only need to loop it through.

But that's improvement after both got merged.

geropl · 2022-08-05T10:20:55Z

components/server/src/user/user-service.ts

@@ -231,12 +294,18 @@ export class UserService {
    async getWorkspaceUsageAttributionId(user: User, projectId?: string): Promise<string | undefined> {


nit, and out-of-scope here: It feels like this method (and it's descendants) do not necessarily belong into UserService, but more into usage/Attribution or so. But that's sth for later. 🙃

geropl · 2022-08-05T10:34:20Z

@jankeromnes testing this now...

geropl · 2022-08-05T10:39:50Z

On re-start, the chooser is not shown, but instead I see the plain error:

I think that's what we discussed earlier, and part of a follow-up PR.

geropl

Code LGTM, tested and works 🛹

Error message is not nice, but does not harm prod, and can be a follow-up. 💯

…s unclear, prompt for explicit user choice

jankeromnes requested a review from a team August 1, 2022 15:21

roboquat added release-note-none size/S labels Aug 1, 2022

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

jankeromnes mentioned this pull request Aug 1, 2022

Adjust usage attribution to prompt users when attribution is ambiguous #11579

Closed

andrew-farries reviewed Aug 1, 2022

View reviewed changes

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

components/server/src/user/user-service.ts Outdated Show resolved Hide resolved

jankeromnes marked this pull request as draft August 1, 2022 15:34

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

jankeromnes force-pushed the jx/attribution-prompt branch from d916294 to e02252a Compare August 2, 2022 08:18

roboquat added size/M and removed size/S labels Aug 2, 2022

jankeromnes force-pushed the jx/attribution-prompt branch from e02252a to c335b08 Compare August 2, 2022 08:43

jankeromnes force-pushed the jx/attribution-prompt branch from c335b08 to da75c99 Compare August 2, 2022 13:19

roboquat added size/L and removed size/M labels Aug 2, 2022

jankeromnes force-pushed the jx/attribution-prompt branch 2 times, most recently from 270cfbb to 76098d7 Compare August 2, 2022 14:42

roboquat added size/XL and removed size/L labels Aug 2, 2022

jankeromnes commented Aug 3, 2022

View reviewed changes

components/server/src/user/user-service.ts Show resolved Hide resolved

jankeromnes force-pushed the jx/attribution-prompt branch from 76098d7 to 546e9da Compare August 3, 2022 10:05

jankeromnes marked this pull request as ready for review August 3, 2022 12:55

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

jankeromnes requested a review from a team August 4, 2022 06:54

jankeromnes changed the title ~~[server] When starting a workspace but usage attribution is unclear, prompt for explicit user choice~~ When starting a workspace but usage attribution is unclear, prompt for explicit user choice Aug 4, 2022

AlexTugarev reviewed Aug 4, 2022

View reviewed changes

components/dashboard/src/components/BillingAccountSelector.tsx Outdated Show resolved Hide resolved

AlexTugarev reviewed Aug 4, 2022

View reviewed changes

components/dashboard/src/start/CreateWorkspace.tsx Outdated Show resolved Hide resolved

AlexTugarev reviewed Aug 4, 2022

View reviewed changes

jankeromnes force-pushed the jx/attribution-prompt branch from 546e9da to eaffa7a Compare August 4, 2022 09:59

gtsiolis mentioned this pull request Aug 4, 2022

Improve usage attribution in user settings #11498

Closed

jankeromnes force-pushed the jx/attribution-prompt branch from eaffa7a to cb12e4f Compare August 5, 2022 08:01

jankeromnes requested a review from a team August 5, 2022 08:42

geropl reviewed Aug 5, 2022

View reviewed changes

geropl approved these changes Aug 5, 2022

View reviewed changes

[server][dashboard] When starting a workspace but usage attribution i…

8e11724

…s unclear, prompt for explicit user choice

geropl force-pushed the jx/attribution-prompt branch from cb12e4f to 8e11724 Compare August 5, 2022 10:55

roboquat merged commit 1e909ba into main Aug 5, 2022

roboquat deleted the jx/attribution-prompt branch August 5, 2022 11:12

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

This was referenced Aug 5, 2022

Improve usage attribution in workspace start #11926

Open

Fix active state for the selected billing team in billing settings #11962

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

When starting a workspace but usage attribution is unclear, prompt for explicit user choice #11777

When starting a workspace but usage attribution is unclear, prompt for explicit user choice #11777

jankeromnes commented Aug 1, 2022 •

edited

andrew-farries left a comment

jankeromnes commented Aug 1, 2022 •

edited by werft-gitpod-dev-com bot

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

jankeromnes commented Aug 3, 2022 •

edited

gtsiolis commented Aug 4, 2022 •

edited

AlexTugarev Aug 4, 2022

jankeromnes Aug 5, 2022

AlexTugarev Aug 4, 2022

jankeromnes Aug 5, 2022

jankeromnes commented Aug 5, 2022 •

edited by werft-gitpod-dev-com bot

geropl Aug 5, 2022

geropl Aug 5, 2022

geropl commented Aug 5, 2022

geropl commented Aug 5, 2022

geropl left a comment

		@@ -231,12 +294,18 @@ export class UserService {
		async getWorkspaceUsageAttributionId(user: User, projectId?: string): Promise<string \| undefined> {

When starting a workspace but usage attribution is unclear, prompt for explicit user choice #11777

When starting a workspace but usage attribution is unclear, prompt for explicit user choice #11777

Conversation

jankeromnes commented Aug 1, 2022 • edited

Description

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

andrew-farries left a comment

Choose a reason for hiding this comment

jankeromnes commented Aug 1, 2022 • edited by werft-gitpod-dev-com bot

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

jankeromnes commented Aug 3, 2022 • edited

gtsiolis commented Aug 4, 2022 • edited

AlexTugarev Aug 4, 2022

Choose a reason for hiding this comment

jankeromnes Aug 5, 2022

Choose a reason for hiding this comment

AlexTugarev Aug 4, 2022

Choose a reason for hiding this comment

jankeromnes Aug 5, 2022

Choose a reason for hiding this comment

jankeromnes commented Aug 5, 2022 • edited by werft-gitpod-dev-com bot

geropl Aug 5, 2022

Choose a reason for hiding this comment

geropl Aug 5, 2022

Choose a reason for hiding this comment

geropl commented Aug 5, 2022

geropl commented Aug 5, 2022

geropl left a comment

Choose a reason for hiding this comment

jankeromnes commented Aug 1, 2022 •

edited

jankeromnes commented Aug 1, 2022 •

edited by werft-gitpod-dev-com bot

jankeromnes commented Aug 3, 2022 •

edited

gtsiolis commented Aug 4, 2022 •

edited

jankeromnes commented Aug 5, 2022 •

edited by werft-gitpod-dev-com bot