[server] Refactor StripeService.findCustomer and .findUncancelledSubscription to only use attributionIds

Author: jankeromnes

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

@@ -50,24 +50,21 @@ class StripeServiceMock extends StripeService {
         super();
     }
 
-    async findUncancelledSubscriptionByCustomer(customerId: string): Promise<string | undefined> {
-        if (this.subscription?.customer === customerId) {
+    async findUncancelledSubscriptionByAttributionId(attributionId: string): Promise<string | undefined> {
+        const customerId = await this.findCustomerByAttributionId(attributionId);
+        if (!!customerId && this.subscription?.customer === customerId) {
             return this.subscription.id;
         }
         return undefined;
     }
 
-    async findCustomerByUserId(userId: string): Promise<string | undefined> {
+    async findCustomerByAttributionId(attributionId: string): Promise<string | undefined> {
         const customerId = this.subscription?.customer;
         if (!customerId) {
             return undefined;
         }
         return customerId;
     }
-
-    async findCustomerByTeamId(teamId: string): Promise<string | undefined> {
-        return this.findCustomerByUserId(teamId);
-    }
 }
 
 class ConfigCatClientMock implements Client {

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

@@ -41,7 +41,7 @@ export class BillingModesImpl implements BillingModes {
     @inject(Config) protected readonly config: Config;
     @inject(ConfigCatClientFactory) protected readonly configCatClientFactory: ConfigCatClientFactory;
     @inject(SubscriptionService) protected readonly subscriptionSvc: SubscriptionService;
-    @inject(StripeService) protected readonly stripeSvc: StripeService;
+    @inject(StripeService) protected readonly stripeService: StripeService;
     @inject(TeamSubscriptionDB) protected readonly teamSubscriptionDb: TeamSubscriptionDB;
     @inject(TeamSubscription2DB) protected readonly teamSubscription2Db: TeamSubscription2DB;
     @inject(TeamDB) protected readonly teamDB: TeamDB;
@@ -116,12 +116,11 @@ export class BillingModesImpl implements BillingModes {
 
         // Stripe: Active personal subsciption?
         let hasUbbPersonal = false;
-        const customerId = await this.stripeSvc.findCustomerByUserId(user.id);
-        if (customerId) {
-            const subscriptionId = await this.stripeSvc.findUncancelledSubscriptionByCustomer(customerId);
-            if (subscriptionId) {
-                hasUbbPersonal = true;
-            }
+        const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(
+            AttributionId.render({ kind: "user", userId: user.id }),
+        );
+        if (subscriptionId) {
+            hasUbbPersonal = true;
         }
 
         // 3. Check team memberships/plans
@@ -192,12 +191,11 @@ export class BillingModesImpl implements BillingModes {
 
         // 3. Now we're usage-based. We only have to figure out whether we have a plan yet or not.
         const result: BillingMode = { mode: "usage-based" };
-        const customerId = await this.stripeSvc.findCustomerByTeamId(team.id);
-        if (customerId) {
-            const subscriptionId = await this.stripeSvc.findUncancelledSubscriptionByCustomer(customerId);
-            if (subscriptionId) {
-                result.paid = true;
-            }
+        const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(
+            AttributionId.render({ kind: "team", teamId: team.id }),
+        );
+        if (subscriptionId) {
+            result.paid = true;
         }
         return result;
     }

components/server/ee/src/billing/entitlement-service-ubp.ts

@@ -114,21 +114,18 @@ export class EntitlementServiceUBP implements EntitlementService {
 
     protected async hasPaidSubscription(user: User, date: Date): Promise<boolean> {
         // Paid user?
-        const customerId = await this.stripeService.findCustomerByUserId(user.id);
-        if (customerId) {
-            const subscriptionId = await this.stripeService.findUncancelledSubscriptionByCustomer(customerId);
-            if (subscriptionId) {
-                return true;
-            }
+        const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(
+            AttributionId.render({ kind: "user", userId: user.id }),
+        );
+        if (subscriptionId) {
+            return true;
         }
         // Member of paid team?
         const teams = await this.teamDB.findTeamsByUser(user.id);
         const isTeamSubscribedPromises = teams.map(async (team: Team) => {
-            const customerId = await this.stripeService.findCustomerByTeamId(team.id);
-            if (!customerId) {
-                return false;
-            }
-            const subscriptionId = await this.stripeService.findUncancelledSubscriptionByCustomer(customerId);
+            const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(
+                AttributionId.render({ kind: "team", teamId: team.id }),
+            );
             return !!subscriptionId;
         });
         // Return the first truthy promise, or false if all the promises were falsy.

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

@@ -34,14 +34,6 @@ export class StripeService {
         return await this.getStripe().setupIntents.create({ usage: "on_session" });
     }
 
-    async findCustomerByUserId(userId: string): Promise<string | undefined> {
-        return this.findCustomerByAttributionId(AttributionId.render({ kind: "user", userId }));
-    }
-
-    async findCustomerByTeamId(teamId: string): Promise<string | undefined> {
-        return this.findCustomerByAttributionId(AttributionId.render({ kind: "team", teamId }));
-    }
-
     async findCustomerByAttributionId(attributionId: string): Promise<string | undefined> {
         const query = `metadata['attributionId']:'${attributionId}'`;
         const result = await this.getStripe().customers.search({ query });
@@ -119,7 +111,9 @@ export class StripeService {
     }
 
     async getPortalUrlForTeam(team: Team): Promise<string> {
-        const customerId = await this.findCustomerByTeamId(team.id);
+        const customerId = await this.findCustomerByAttributionId(
+            AttributionId.render({ kind: "team", teamId: team.id }),
+        );
         if (!customerId) {
             throw new Error(`No Stripe Customer ID found for team '${team.id}'`);
         }
@@ -131,7 +125,9 @@ export class StripeService {
     }
 
     async getPortalUrlForUser(user: User): Promise<string> {
-        const customerId = await this.findCustomerByUserId(user.id);
+        const customerId = await this.findCustomerByAttributionId(
+            AttributionId.render({ kind: "user", userId: user.id }),
+        );
         if (!customerId) {
             throw new Error(`No Stripe Customer ID found for user '${user.id}'`);
         }
@@ -142,7 +138,11 @@ export class StripeService {
         return session.url;
     }
 
-    async findUncancelledSubscriptionByCustomer(customerId: string): Promise<string | undefined> {
+    async findUncancelledSubscriptionByAttributionId(attributionId: string): Promise<string | undefined> {
+        const customerId = await this.findCustomerByAttributionId(attributionId);
+        if (!customerId) {
+            return undefined;
+        }
         const result = await this.getStripe().subscriptions.list({
             customer: customerId,
         });

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

@@ -1596,12 +1596,11 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
                 { teamId, chargebeeSubscriptionId },
             );
         }
-        const teamCustomerId = await this.stripeService.findCustomerByTeamId(teamId);
-        if (teamCustomerId) {
-            const subsciptionId = await this.stripeService.findUncancelledSubscriptionByCustomer(teamCustomerId);
-            if (subsciptionId) {
-                await this.stripeService.cancelSubscription(subsciptionId);
-            }
+        const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(
+            AttributionId.render({ kind: "team", teamId: teamId }),
+        );
+        if (subscriptionId) {
+            await this.stripeService.cancelSubscription(subscriptionId);
         }
     }
 
@@ -2066,12 +2065,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
             if (attrId.kind == "team") {
                 await this.guardTeamOperation(attrId.teamId, "get");
             }
-            const customerId = await this.stripeService.findCustomerByAttributionId(attributionId);
-            if (!customerId) {
-                return undefined;
-            }
-
-            const subscriptionId = await this.stripeService.findUncancelledSubscriptionByCustomer(customerId);
+            const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(attributionId);
             return subscriptionId;
         } catch (error) {
             log.error(`Failed to get Stripe Subscription ID for '${attributionId}'`, error);

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

@@ -196,11 +196,9 @@ export class UserService {
     }
 
     protected async findTeamUsageBasedSubscriptionId(team: Team): Promise<string | undefined> {
-        const customerId = await this.stripeService.findCustomerByTeamId(team.id);
-        if (!customerId) {
-            return;
-        }
-        const subscriptionId = await this.stripeService.findUncancelledSubscriptionByCustomer(customerId);
+        const subscriptionId = await this.stripeService.findUncancelledSubscriptionByAttributionId(
+            AttributionId.render({ kind: "team", teamId: team.id }),
+        );
         return subscriptionId;
     }
 
@@ -325,8 +323,8 @@ export class UserService {
             if (!membership) {
                 throw new Error("Cannot attribute to an unrelated team.");
             }
-            const teamCustomer = await this.stripeService.findCustomerByTeamId(attributionId.teamId);
-            if (!teamCustomer) {
+            const teamCustomerId = await this.stripeService.findCustomerByAttributionId(usageAttributionId);
+            if (!teamCustomerId) {
                 throw new Error("Cannot attribute to team without Stripe customer.");
             }
             user.usageAttributionId = usageAttributionId;