[server] Introduce EntitlementService.getBillingTier

Author: geropl

components/gitpod-protocol/src/experiments/configcat.ts

@@ -15,6 +15,7 @@ export const TEAM_ID_ATTRIBUTE = "team_id";
 export const TEAM_IDS_ATTRIBUTE = "team_ids";
 export const TEAM_NAME_ATTRIBUTE = "team_name";
 export const TEAM_NAMES_ATTRIBUTE = "team_names";
+export const BILLING_TIER_ATTRIBUTE = "billing_tier";
 
 export class ConfigCatClient implements Client {
     private client: IConfigCatClient;
@@ -53,6 +54,9 @@ export function attributesToUser(attributes: Attributes): ConfigCatUser {
         custom[TEAM_NAMES_ATTRIBUTE] = attributes.teams.map((t) => t.name).join(",");
         custom[TEAM_IDS_ATTRIBUTE] = attributes.teams.map((t) => t.id).join(",");
     }
+    if (attributes.billingTier) {
+        custom[BILLING_TIER_ATTRIBUTE] = attributes.billingTier;
+    }
 
     return new ConfigCatUser(userId, email, "", custom);
 }

components/gitpod-protocol/src/experiments/types.ts

@@ -4,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { User } from "../protocol";
+import { BillingTier, User } from "../protocol";
 import { Team } from "../teams-projects-protocol";
 
 export const Client = Symbol("Client");
@@ -15,6 +15,9 @@ export interface Attributes {
     // user.id is mapped to ConfigCat's "identifier" + "custom.user_id"
     user?: User | { id: string; email?: string };
 
+    // The BillingTier of this particular user
+    billingTier?: BillingTier;
+
     // Currently selected Gitpod Project ID (mapped to "custom.project_id")
     projectId?: string;
 

components/gitpod-protocol/src/protocol.ts

@@ -286,6 +286,8 @@ export interface UserFeatureSettings {
     permanentWSFeatureFlags?: NamedWorkspaceFeatureFlag[];
 }
 
+export type BillingTier = "paid" | "free";
+
 /**
  * The values of this type MUST MATCH enum values in WorkspaceFeatureFlag from ws-manager/client/core_pb.d.ts
  * If they don't we'll break things during workspace startup.

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

@@ -7,6 +7,7 @@
 import { TeamDB, TeamSubscription2DB, TeamSubscriptionDB } from "@gitpod/gitpod-db/lib";
 import { Accounting, SubscriptionService } from "@gitpod/gitpod-payment-endpoint/lib/accounting";
 import {
+    BillingTier,
     User,
     WorkspaceInstance,
     WorkspaceTimeoutDuration,
@@ -188,8 +189,17 @@ export class EntitlementServiceChargebee implements EntitlementService {
      * @param user
      */
     async limitNetworkConnections(user: User, date: Date = new Date()): Promise<boolean> {
-        const subscriptions = await this.subscriptionService.getNotYetCancelledSubscriptions(user, date.toISOString());
-        const hasPaidPlan = subscriptions.some((s) => !Plans.isFreeTier(s.planId));
+        const hasPaidPlan = this.hasPaidSubscription(user, date);
         return !hasPaidPlan;
     }
+
+    protected async hasPaidSubscription(user: User, date: Date): Promise<boolean> {
+        const subscriptions = await this.subscriptionService.getNotYetCancelledSubscriptions(user, date.toISOString());
+        return subscriptions.some((s) => !Plans.isFreeTier(s.planId));
+    }
+
+    async getBillingTier(user: User): Promise<BillingTier> {
+        const hasPaidPlan = await this.hasPaidSubscription(user, new Date());
+        return hasPaidPlan ? "paid" : "free";
+    }
 }

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

@@ -6,6 +6,7 @@
 
 import { UserDB } from "@gitpod/gitpod-db/lib";
 import {
+    BillingTier,
     User,
     WorkspaceInstance,
     WorkspaceTimeoutDuration,
@@ -61,4 +62,9 @@ export class EntitlementServiceLicense implements EntitlementService {
     async limitNetworkConnections(user: User, date: Date): Promise<boolean> {
         return false;
     }
+
+    async getBillingTier(user: User): Promise<BillingTier> {
+        // TODO(gpl) Is this true? Cross-check this whole interface with Self-Hosted before next release!
+        return "paid";
+    }
 }

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

@@ -6,6 +6,7 @@
 
 import { TeamDB, UserDB } from "@gitpod/gitpod-db/lib";
 import {
+    BillingTier,
     Team,
     User,
     WorkspaceInstance,
@@ -146,4 +147,9 @@ export class EntitlementServiceUBP implements EntitlementService {
                 .catch(reject);
         });
     }
+
+    async getBillingTier(user: User): Promise<BillingTier> {
+        const hasPaidPlan = await this.hasPaidSubscription(user, new Date());
+        return hasPaidPlan ? "paid" : "free";
+    }
 }

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

@@ -5,6 +5,7 @@
  */
 
 import {
+    BillingTier,
     User,
     WorkspaceInstance,
     WorkspaceTimeoutDuration,
@@ -134,4 +135,26 @@ export class EntitlementServiceImpl implements EntitlementService {
             return false;
         }
     }
+
+    /**
+     * Returns true if network connections should be limited
+     * @param user
+     */
+    async getBillingTier(user: User): Promise<BillingTier> {
+        try {
+            const now = new Date();
+            const billingMode = await this.billingModes.getBillingModeForUser(user, now);
+            switch (billingMode.mode) {
+                case "none":
+                    return this.license.getBillingTier(user);
+                case "chargebee":
+                    return this.chargebee.getBillingTier(user);
+                case "usage-based":
+                    return this.ubp.getBillingTier(user);
+            }
+        } catch (err) {
+            log.error({ userId: user.id }, "EntitlementService error: getBillingTier", err);
+            return "paid";
+        }
+    }
 }

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

@@ -11,6 +11,7 @@ import {
     WORKSPACE_TIMEOUT_DEFAULT_SHORT,
 } from "@gitpod/gitpod-protocol";
 import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
+import { BillingTier } from "@gitpod/gitpod-protocol/src/protocol";
 import { injectable } from "inversify";
 
 export interface MayStartWorkspaceResult {
@@ -68,6 +69,13 @@ export interface EntitlementService {
      * @param user
      */
     limitNetworkConnections(user: User, date: Date): Promise<boolean>;
+
+    /**
+     * Returns BillingTier of this particular user
+     *
+     * @param user
+     */
+    getBillingTier(user: User): Promise<BillingTier>;
 }
 
 /**
@@ -98,4 +106,8 @@ export class CommunityEntitlementService implements EntitlementService {
     async limitNetworkConnections(user: User): Promise<boolean> {
         return false;
     }
+
+    async getBillingTier(user: User): Promise<BillingTier> {
+        return "free";
+    }
 }