Move LazyOrganizationService to UBP entitlement service to get rid of circ. dep. errs

Author: filiptronicek

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

@@ -15,7 +15,6 @@ import {
     BillingTier,
     MAX_PARALLEL_WORKSPACES_PAID,
     MAX_PARALLEL_WORKSPACES_FREE,
-    OrganizationSettings,
 } from "@gitpod/gitpod-protocol";
 import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
 import { inject, injectable } from "inversify";
@@ -24,6 +23,10 @@ import { CostCenter_BillingStrategy } from "@gitpod/usage-api/lib/usage/v1/usage
 import { UsageService } from "../orgs/usage-service";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { VerificationService } from "../auth/verification-service";
+import type { OrganizationService } from "../orgs/organization-service";
+
+export const LazyOrganizationService = Symbol("LazyOrganizationService");
+export type LazyOrganizationService = () => OrganizationService;
 
 /**
  * EntitlementService implementation for Usage-Based Pricing (UBP)
@@ -33,13 +36,13 @@ export class EntitlementServiceUBP implements EntitlementService {
     constructor(
         @inject(UsageService) private readonly usageService: UsageService,
         @inject(VerificationService) private readonly verificationService: VerificationService,
+        @inject(LazyOrganizationService) private readonly organizationService: LazyOrganizationService,
     ) {}
 
     async mayStartWorkspace(
         user: User,
         organizationId: string,
         runningInstances: Promise<WorkspaceInstance[]>,
-        organizationSettings?: OrganizationSettings,
     ): Promise<MayStartWorkspaceResult> {
         const verification = await this.verificationService.needsVerification(user);
         if (verification) {
@@ -49,7 +52,10 @@ export class EntitlementServiceUBP implements EntitlementService {
         }
 
         const hasHitParallelWorkspaceLimit = async (): Promise<HitParallelWorkspaceLimit | undefined> => {
-            const maxParallelRunningWorkspaces = organizationSettings?.maxParallelRunningWorkspaces;
+            const { maxParallelRunningWorkspaces } = await this.organizationService().getSettings(
+                user.id,
+                organizationId,
+            );
             const planAllowance = await this.getMaxParallelWorkspaces(user.id, organizationId);
             const max = maxParallelRunningWorkspaces
                 ? Math.min(planAllowance, maxParallelRunningWorkspaces)

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

@@ -12,18 +12,13 @@ import {
     WORKSPACE_LIFETIME_LONG,
     MAX_PARALLEL_WORKSPACES_FREE,
     MAX_PARALLEL_WORKSPACES_PAID,
-    OrganizationSettings,
 } from "@gitpod/gitpod-protocol";
 import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
 import { BillingTier } from "@gitpod/gitpod-protocol/lib/protocol";
 import { inject, injectable } from "inversify";
 import { BillingModes } from "./billing-mode";
-import { EntitlementServiceUBP } from "./entitlement-service-ubp";
+import { EntitlementServiceUBP, LazyOrganizationService } from "./entitlement-service-ubp";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
-import type { OrganizationService } from "../orgs/organization-service";
-
-export const LazyOrganizationService = Symbol("LazyOrganizationService");
-export type LazyOrganizationService = () => OrganizationService;
 
 export interface MayStartWorkspaceResult {
     hitParallelWorkspaceLimit?: HitParallelWorkspaceLimit;
@@ -53,7 +48,6 @@ export interface EntitlementService {
         user: User,
         organizationId: string,
         runningInstances: Promise<WorkspaceInstance[]>,
-        organizationSettings?: OrganizationSettings,
     ): Promise<MayStartWorkspaceResult>;
 
     /**
@@ -118,7 +112,6 @@ export class EntitlementServiceImpl implements EntitlementService {
         user: User,
         organizationId: string,
         runningInstances: Promise<WorkspaceInstance[]>,
-        organizationSettings?: OrganizationSettings,
     ): Promise<MayStartWorkspaceResult> {
         try {
             const billingMode = await this.billingModes.getBillingMode(user.id, organizationId);
@@ -127,6 +120,7 @@ export class EntitlementServiceImpl implements EntitlementService {
             switch (billingMode.mode) {
                 case "none":
                     // the default limit is MAX_PARALLEL_WORKSPACES_PAID, but organizations can set their own different limit
+                    // we use || here because the default value is 0 and we want to use the default limit if the organization limit is not set
                     const maxParallelRunningWorkspaces =
                         organizationSettings.maxParallelRunningWorkspaces || MAX_PARALLEL_WORKSPACES_PAID;
                     const current = (await runningInstances).filter((i) => i.status.phase !== "preparing").length;
@@ -141,7 +135,7 @@ export class EntitlementServiceImpl implements EntitlementService {
 
                     return {};
                 case "usage-based":
-                    return this.ubp.mayStartWorkspace(user, organizationId, runningInstances, organizationSettings);
+                    return this.ubp.mayStartWorkspace(user, organizationId, runningInstances);
                 default:
                     throw new Error("Unsupported billing mode: " + (billingMode as any).mode); // safety net
             }

components/server/src/container-module.ts

@@ -54,8 +54,8 @@ import { RelationshipUpdateJob } from "./authorization/relationship-updater-job"
 import { SpiceDBClientProvider, spiceDBConfigFromEnv } from "./authorization/spicedb";
 import { createSpiceDBAuthorizer } from "./authorization/spicedb-authorizer";
 import { BillingModes } from "./billing/billing-mode";
-import { EntitlementService, EntitlementServiceImpl, LazyOrganizationService } from "./billing/entitlement-service";
-import { EntitlementServiceUBP } from "./billing/entitlement-service-ubp";
+import { EntitlementService, EntitlementServiceImpl } from "./billing/entitlement-service";
+import { EntitlementServiceUBP, LazyOrganizationService } from "./billing/entitlement-service-ubp";
 import { StripeService } from "./billing/stripe-service";
 import { CodeSyncService } from "./code-sync/code-sync-service";
 import { Config, ConfigFile } from "./config";

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

@@ -893,10 +893,13 @@ export class WorkspaceService {
                 },
             );
         }
-        if (!!result.hitParallelWorkspaceLimit) {
+        if (result.hitParallelWorkspaceLimit) {
+            const { max } = result.hitParallelWorkspaceLimit;
             throw new ApplicationError(
                 ErrorCodes.TOO_MANY_RUNNING_WORKSPACES,
-                `You cannot run more than ${result.hitParallelWorkspaceLimit.max} workspaces at the same time. Please stop a workspace before starting another one.`,
+                `You cannot run more than ${max} workspace${
+                    max === 1 ? "" : "s"
+                } at the same time. Please stop a workspace before starting another one.`,
             );
         }
     }