[server] BillingMode: Render names of Chargebee Team Plans/Subscriptions if that blocks UBP

Author: geropl

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

@@ -64,6 +64,9 @@ interface Chargebee {
     paid?: boolean;
 
     canUpgradeToUBB?: boolean;
+
+    /** Name of team(s) that block switching to usage-based */
+    teamNames?: string[];
 }
 
 /** Session is handld with new usage-based logic */

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

@@ -157,6 +157,7 @@ class BillingModeSpec {
         function user(): User {
             return {
                 id: userId,
+                name: `user-${userId}`,
                 creationDate,
                 identities: [],
             };
@@ -312,6 +313,7 @@ class BillingModeSpec {
                 expectation: {
                     mode: "chargebee",
                     canUpgradeToUBB: true,
+                    teamNames: ["Team Subscription 'Team Unleashed' (owner: user-123)"],
                 },
             },
             {
@@ -328,6 +330,7 @@ class BillingModeSpec {
                 expectation: {
                     mode: "chargebee",
                     canUpgradeToUBB: true,
+                    teamNames: ["Team Subscription 'Team Unleashed' (owner: user-123)"],
                 },
             },
             {
@@ -461,6 +464,7 @@ class BillingModeSpec {
                 expectation: {
                     mode: "chargebee",
                     paid: true,
+                    teamNames: ["team-123"],
                 },
             },
             // team: transition chargebee -> UBB
@@ -475,6 +479,7 @@ class BillingModeSpec {
                 expectation: {
                     mode: "chargebee",
                     canUpgradeToUBB: true,
+                    teamNames: ["team-123"],
                 },
             },
             {

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

@@ -110,13 +110,16 @@ export class BillingModesImpl implements BillingModes {
 
         // 2. Any personal subscriptions?
         // Chargebee takes precedence
-        function isTeamSubscription(s: Subscription): boolean {
-            return !!Plans.getById(s.planId)?.team;
+        function isPersonalSubscription(s: Subscription): boolean {
+            return !Plans.getById(s.planId)?.team;
+        }
+        function isOldTeamSubscription(s: Subscription): boolean {
+            return !!Plans.getById(s.planId)?.team && !s.teamMembershipId;
         }
         const cbSubscriptions = await this.subscriptionSvc.getActivePaidSubscription(user.id, now);
-        const cbTeamSubscriptions = cbSubscriptions.filter((s) => isTeamSubscription(s));
+        const cbTeamSubscriptions = cbSubscriptions.filter((s) => isOldTeamSubscription(s));
         const cbPersonalSubscriptions = cbSubscriptions.filter(
-            (s) => !isTeamSubscription(s) && s.planId !== Plans.FREE_OPEN_SOURCE.chargebeeId,
+            (s) => isPersonalSubscription(s) && s.planId !== Plans.FREE_OPEN_SOURCE.chargebeeId,
         );
         const cbOwnedTeamSubscriptions = (
             await this.teamSubscriptionDb.findTeamSubscriptions({ userId: user.id })
@@ -166,15 +169,50 @@ export class BillingModesImpl implements BillingModes {
             return usageBased();
         }
         if (hasCbPaidTeamMembership || hasCbPaidTeamSeat || canUpgradeToUBB) {
-            // TODO(gpl): Q: How to test the free-tier, then? A: Make sure you have no CB paid seats anymore
-            // For that we could add a new field here, which lists all seats that are "blocking" you, and display them in the UI somewhere.
-            return { mode: "chargebee", canUpgradeToUBB: true }; // UBB is enabled, but no seat nor subscription yet.
+            // Q: How to test the free-tier, then? A: Make sure you have no CB paid seats anymore
+            // For that we lists all Team Subscriptions/Team Memberships that are "blocking" you, and display them in the UI somewhere.
+            const result: BillingMode = { mode: "chargebee", canUpgradeToUBB }; // UBB is enabled, but no seat nor subscription yet.
+
+            const teamNames = [];
+            for (const tm of teamsModes) {
+                if (tm.mode === "chargebee" && tm.teamNames) {
+                    teamNames.push(`Team Membership: ${tm.teamNames}`);
+                }
+            }
+            const tsOwners = await Promise.all(cbTeamSubscriptions.map((s) => this.mapTeamSubscriptionToOwnerName(s)));
+            for (const owner of tsOwners) {
+                if (!owner) {
+                    continue;
+                }
+                const [ts, ownerName] = owner;
+                teamNames.push(`Team Subscription '${Plans.getById(ts.planId)?.name}' (owner: ${ownerName})`);
+            }
+            if (teamNames.length > 0) {
+                result.teamNames = teamNames;
+            }
+
+            return result;
         }
 
         // UBB free tier
         return usageBased();
     }
 
+    protected async mapTeamSubscriptionToOwnerName(s: Subscription): Promise<[TeamSubscription, string] | undefined> {
+        if (!s || !s.teamSubscriptionSlotId) {
+            return undefined;
+        }
+        const ts = await this.teamSubscriptionDb.findTeamSubscriptionBySlotId(s.teamSubscriptionSlotId!);
+        if (!ts) {
+            return undefined;
+        }
+        const user = await this.userDB.findUserById(ts.userId);
+        if (!user) {
+            return undefined;
+        }
+        return [ts, user.name || user.fullName || "---"];
+    }
+
     async getBillingModeForTeam(team: Team, _now: Date): Promise<BillingMode> {
         if (!this.config.enablePayment) {
             // Payment is not enabled. E.g. Self-Hosted.
@@ -200,7 +238,7 @@ export class BillingModesImpl implements BillingModes {
                 return { mode: "chargebee", canUpgradeToUBB: isUsageBasedBillingEnabled };
             }
 
-            return { mode: "chargebee", paid: true };
+            return { mode: "chargebee", teamNames: [team.name], paid: true };
         }
 
         // 2. UBB enabled at all?