[server] Introduce BillingMode incl. tests

Author: geropl

components/ee/payment-endpoint/src/accounting/subscription-service.ts

@@ -133,8 +133,17 @@ export class SubscriptionService {
      * @returns Whether the user has an active subscription (user-paid or team s.) at the given date
      */
     async hasActivePaidSubscription(userId: string, date: Date): Promise<boolean> {
+        return (await this.getActivePaidSubscription(userId, date)).length > 0;
+    }
+
+    /**
+     * @param userId
+     * @param date The date on which the subscription has to be active
+     * @returns The list of a active subscriptions (user-paid or team s.) at the given date
+     */
+    async getActivePaidSubscription(userId: string, date: Date): Promise<Subscription[]> {
         const subscriptions = await this.accountingDB.findActiveSubscriptionsForUser(userId, date.toISOString());
-        return subscriptions.filter((s) => Subscription.isActive(s, date.toISOString())).length > 0;
+        return subscriptions.filter((s) => Subscription.isActive(s, date.toISOString()));
     }
 
     async store(db: AccountingDB, model: SubscriptionModel) {

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

@@ -199,6 +199,9 @@ export namespace Subscription {
     export function isActive(s: Subscription, date: string): boolean {
         return s.startDate <= date && (s.endDate === undefined || date < s.endDate);
     }
+    export function isCancelled(s: Subscription, date: string): boolean {
+        return (!!s.cancellationDate && s.cancellationDate < date) || (!!s.endDate && s.endDate < date); // This edge case is meant to handle bad data: If for whatever reason cancellationDate has not been set: treat endDate as such
+    }
     export function isDowngraded(s: Subscription) {
         return s.paymentData && s.paymentData.downgradeDate;
     }

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

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+/**
+ * BillingMode is used to answer the following questions:
+ *  - Should UI piece x be displayed for this user/team? (getBillingModeForUser/Team)
+ *  - What model should be used to limit this workspace's capabilities (mayStartWorkspace, setTimeout, workspace class, etc...) (getBillingMode(workspaceInstance.attributionId))
+ *  - How is a workspace session charged for? (getBillingMode(workspaceInstance.attributionId))
+ */
+export type BillingMode = None | Chargebee | UsageBased;
+export namespace BillingMode {
+    export const NONE: None = {
+        mode: "none",
+    };
+
+    export function showChargebeeBilling(billingMode: BillingMode): boolean {
+        if (billingMode.mode === "chargebee") {
+            return true;
+        }
+        return false;
+    }
+
+    export function showChargebeeInvoices(billingMode: BillingMode): boolean {
+        if (showChargebeeBilling(billingMode)) {
+            return true;
+        }
+        // TODO(gpl) or hasBeenCustomer, so they can access invoices (edge case?)
+        return false;
+    }
+
+    /** Incl. upgrade and status */
+    export function showStripeBilling(billingMode: BillingMode): boolean {
+        return (
+            billingMode.mode === "usage-based" || (billingMode.mode === "chargebee" && !!billingMode.canUpgradeToUBB)
+        );
+    }
+
+    export function canSetWorkspaceClass(billingMode: BillingMode): boolean {
+        // if has any Stripe subscription, either directly or per team
+        return billingMode.mode === "usage-based";
+    }
+
+    export function canSetCostCenter(billingMode: BillingMode): boolean {
+        // if has any Stripe Subscription, either directly or per team
+        return billingMode.mode === "usage-based";
+    }
+}
+
+/** Payment is disabled */
+interface None {
+    mode: "none";
+}
+
+/** Sessions is handled with old subscription logic based on Chargebee */
+interface Chargebee {
+    mode: "chargebee";
+    canUpgradeToUBB?: boolean;
+}
+
+/** Session is handld with new usage-based logic */
+interface UsageBased {
+    mode: "usage-based";
+}

components/gitpod-protocol/src/team-subscription-protocol.ts

@@ -55,6 +55,9 @@ export namespace TeamSubscription2 {
     export const isActive = (ts2: TeamSubscription2, date: string): boolean => {
         return ts2.startDate <= date && (ts2.endDate === undefined || date < ts2.endDate);
     };
+    export function isCancelled(s: TeamSubscription2, date: string): boolean {
+        return (!!s.cancellationDate && s.cancellationDate < date) || (!!s.endDate && s.endDate < date); // This edge case is meant to handle bad data: If for whatever reason cancellationDate has not been set: treat endDate as such
+    }
 }
 
 /**