refactor MayStartWorkspaceResult

Author: AlexTugarev

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

@@ -57,8 +57,11 @@ export class EntitlementServiceChargebee implements EntitlementService {
             hasHitParallelWorkspaceLimit(),
         ]);
 
+        const result = enoughCredits && !hitParallelWorkspaceLimit;
+
         return {
-            enoughCredits: !!enoughCredits,
+            mayStart: result,
+            oufOfCredits: !enoughCredits,
             hitParallelWorkspaceLimit,
         };
     }

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

@@ -30,7 +30,7 @@ export class EntitlementServiceLicense implements EntitlementService {
         runningInstances: Promise<WorkspaceInstance[]>,
     ): Promise<MayStartWorkspaceResult> {
         // if payment is not enabled users can start as many parallel workspaces as they want
-        return { enoughCredits: true };
+        return { mayStart: true };
     }
 
     async maySetTimeout(user: User, date: Date): Promise<boolean> {

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

@@ -57,8 +57,9 @@ export class EntitlementServiceUBP implements EntitlementService {
             this.checkSpendingLimitReached(user, date),
             hasHitParallelWorkspaceLimit(),
         ]);
-
+        const result = !spendingLimitReachedOnCostCenter && !hitParallelWorkspaceLimit;
         return {
+            mayStart: result,
             spendingLimitReachedOnCostCenter,
             hitParallelWorkspaceLimit,
         };

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

@@ -39,17 +39,22 @@ export class EntitlementServiceImpl implements EntitlementService {
     ): Promise<MayStartWorkspaceResult> {
         try {
             const billingMode = await this.billingModes.getBillingModeForUser(user, date);
+            let result;
             switch (billingMode.mode) {
                 case "none":
-                    return this.license.mayStartWorkspace(user, date, runningInstances);
+                    result = await this.license.mayStartWorkspace(user, date, runningInstances);
+                    break;
                 case "chargebee":
-                    return this.chargebee.mayStartWorkspace(user, date, runningInstances);
+                    result = await this.chargebee.mayStartWorkspace(user, date, runningInstances);
+                    break;
                 case "usage-based":
-                    return this.ubp.mayStartWorkspace(user, date, runningInstances);
+                    result = await this.ubp.mayStartWorkspace(user, date, runningInstances);
+                    break;
             }
+            return result;
         } catch (err) {
             log.error({ userId: user.id }, "EntitlementService error: mayStartWorkspace", err);
-            return {};
+            throw err;
         }
     }
 

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

@@ -256,14 +256,23 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     ): Promise<void> {
         await super.mayStartWorkspace(ctx, user, runningInstances);
 
-        const result = await this.entitlementService.mayStartWorkspace(user, new Date(), runningInstances);
-        if (!result.enoughCredits) {
+        let result;
+        try {
+            result = await this.entitlementService.mayStartWorkspace(user, new Date(), runningInstances);
+        } catch (error) {
+            throw new ResponseError(ErrorCodes.INTERNAL_SERVER_ERROR, `Error in Entitlement Service.`);
+        }
+        log.info("mayStartWorkspace", { result });
+        if (result.mayStart) {
+            return; // green light from entitlement service
+        }
+        if (!!result.oufOfCredits) {
             throw new ResponseError(
                 ErrorCodes.NOT_ENOUGH_CREDIT,
                 `Not enough monthly workspace hours. Please upgrade your account to get more hours for your workspaces.`,
             );
         }
-        if (result.spendingLimitReachedOnCostCenter) {
+        if (!!result.spendingLimitReachedOnCostCenter) {
             throw new ResponseError(
                 ErrorCodes.PAYMENT_SPENDING_LIMIT_REACHED,
                 "Increase spending limit and try again.",

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

@@ -14,8 +14,11 @@ import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
 import { injectable } from "inversify";
 
 export interface MayStartWorkspaceResult {
+    mayStart: boolean;
+
     hitParallelWorkspaceLimit?: HitParallelWorkspaceLimit;
-    enoughCredits?: boolean;
+
+    oufOfCredits?: boolean;
 
     /** Usage-Based Pricing: AttributionId of the CostCenter that reached it's spending limit */
     spendingLimitReachedOnCostCenter?: AttributionId;
@@ -72,7 +75,7 @@ export class CommunityEntitlementService implements EntitlementService {
         date: Date,
         runningInstances: Promise<WorkspaceInstance[]>,
     ): Promise<MayStartWorkspaceResult> {
-        return { enoughCredits: true };
+        return { mayStart: true };
     }
 
     async maySetTimeout(user: User, date: Date): Promise<boolean> {