[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,67 @@
+/**
+ * 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?
+ *  - What model should be used to limit this workspace's capabilities (mayStartWorkspace, setTimeout, workspace class, etc...)
+ *  - How is a workspace session charged for?
+ */
+export type BillingMode =
+    | None
+    | ChargebeeFreeTier
+    | ChargebeePaidTier
+    | ChargebeePaidTierCancelled
+    | UBBFreeTier
+    | UBBPaidTier;
+
+export namespace BillingMode {
+    export const NONE: BillingMode = {
+        mode: "none",
+    };
+}
+
+/** Payment is disabled */
+interface None {
+    mode: "none";
+}
+
+/** Default case without any subscription, when UBB is disabled */
+interface ChargebeeFreeTier {
+    mode: "chargebee";
+    tier: "free";
+}
+
+/** When there is _any_ paid subscription on Chargbee that's active, either personal or team based */
+interface ChargebeePaidTier {
+    mode: "chargebee";
+    tier: "paid";
+    /** All active paid plans ids */
+    planIds: string[];
+
+    /** Whether or not the user has an active personal plan */
+    hasPersonalPlan?: boolean;
+}
+
+/** When there is any paid, active Chargebee subscription , that has already been cancelled, and UBB is enabled */
+interface ChargebeePaidTierCancelled {
+    mode: "chargebee";
+    tier: "paid_cancelled_and_ubb";
+    /** All active paid plans ids */
+    planIds: string[];
+}
+
+/** Default case without any subscription, when UBB is enabled */
+interface UBBFreeTier {
+    mode: "usage-based";
+    tier: "free";
+}
+
+/** When UBB is enabled and the user has a paid subscription */
+interface UBBPaidTier {
+    mode: "usage-based";
+    tier: "paid";
+}

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
+    }
 }
 
 /**