[db][protocol] Implement a CostCenter entity to attribute workspace usage to

Author: jankeromnes

components/gitpod-db/src/container-module.ts

@@ -64,6 +64,8 @@ import { TypeORMInstallationAdminImpl } from "./typeorm/installation-admin-db-im
 import { InstallationAdminDB } from "./installation-admin-db";
 import { TeamSubscription2DB } from "./team-subscription-2-db";
 import { TeamSubscription2DBImpl } from "./typeorm/team-subscription-2-db-impl";
+import { CostCenterDB } from "./cost-center-db";
+import { CostCenterDBImpl } from "./typeorm/cost-center-db-impl";
 
 // THE DB container module that contains all DB implementations
 export const dbContainerModule = new ContainerModule((bind, unbind, isBound, rebind) => {
@@ -137,6 +139,9 @@ export const dbContainerModule = new ContainerModule((bind, unbind, isBound, reb
     bind(ProjectDBImpl).toSelf().inSingletonScope();
     bind(ProjectDB).toService(ProjectDBImpl);
 
+    bind(CostCenterDBImpl).toSelf().inSingletonScope();
+    bind(CostCenterDB).toService(CostCenterDBImpl);
+
     // com concerns
     bind(AccountingDB).to(TypeORMAccountingDBImpl).inSingletonScope();
     bind(TransactionalAccountingDBFactory).toFactory((ctx) => {

components/gitpod-db/src/cost-center-db.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the Gitpod Enterprise Source Code License,
+ * See License.enterprise.txt in the project root folder.
+ */
+
+import { CostCenter } from "@gitpod/gitpod-protocol";
+
+export const CostCenterDB = Symbol("CostCenterDB");
+export interface CostCenterDB {
+    storeEntry(ts: CostCenter): Promise<void>;
+    findById(id: string): Promise<CostCenter | undefined>;
+}

components/gitpod-db/src/index.ts

@@ -39,3 +39,4 @@ export * from "./typeorm/entity/db-account-entry";
 export * from "./project-db";
 export * from "./team-db";
 export * from "./installation-admin-db";
+export * from "./cost-center-db";

components/gitpod-db/src/tables.ts

@@ -268,6 +268,12 @@ export class GitpodTableDescriptionProvider implements TableDescriptionProvider
             deletionColumn: "deleted",
             timeColumn: "_lastModified",
         },
+        {
+            name: "d_b_cost_center",
+            primaryKeys: ["id"],
+            deletionColumn: "deleted",
+            timeColumn: "_lastModified",
+        },
         /**
          * BEWARE
          *

components/gitpod-db/src/typeorm/cost-center-db-impl.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the Gitpod Enterprise Source Code License,
+ * See License.enterprise.txt in the project root folder.
+ */
+
+import { injectable, inject } from "inversify";
+import { Repository } from "typeorm";
+
+import { CostCenter } from "@gitpod/gitpod-protocol";
+
+import { CostCenterDB } from "../cost-center-db";
+import { DBCostCenter } from "./entity/db-cost-center";
+import { TypeORM } from "./typeorm";
+
+@injectable()
+export class CostCenterDBImpl implements CostCenterDB {
+    @inject(TypeORM) protected readonly typeORM: TypeORM;
+
+    protected async getEntityManager() {
+        return (await this.typeORM.getConnection()).manager;
+    }
+
+    protected async getRepo(): Promise<Repository<DBCostCenter>> {
+        return (await this.getEntityManager()).getRepository(DBCostCenter);
+    }
+
+    async storeEntry(ts: CostCenter): Promise<void> {
+        const repo = await this.getRepo();
+        await repo.save(ts);
+    }
+
+    async findById(id: string): Promise<CostCenter | undefined> {
+        const repo = await this.getRepo();
+        return repo.findOne(id);
+    }
+}

components/gitpod-db/src/typeorm/deleted-entry-gc.ts

@@ -63,6 +63,7 @@ const tables: TableWithDeletion[] = [
     { deletionColumn: "deleted", name: "d_b_project_info" },
     { deletionColumn: "deleted", name: "d_b_project_usage" },
     { deletionColumn: "deleted", name: "d_b_team_subscription2" },
+    { deletionColumn: "deleted", name: "d_b_cost_center" },
 ];
 
 interface TableWithDeletion {

components/gitpod-db/src/typeorm/entity/db-cost-center.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the Gitpod Enterprise Source Code License,
+ * See License.enterprise.txt in the project root folder.
+ */
+
+import { Entity, Column, PrimaryColumn } from "typeorm";
+import { CostCenter } from "@gitpod/gitpod-protocol";
+
+@Entity()
+// on DB but not Typeorm: @Index("ind_lastModified", ["_lastModified"])   // DBSync
+export class DBCostCenter implements CostCenter {
+    @PrimaryColumn("uuid")
+    id: string;
+
+    // This column triggers the db-sync deletion mechanism. It's not intended for public consumption.
+    @Column()
+    deleted: boolean;
+}

components/gitpod-db/src/typeorm/entity/db-workspace-instance.ts

@@ -107,5 +107,5 @@ export class DBWorkspaceInstance implements WorkspaceInstance {
         default: "",
         transformer: Transformer.MAP_EMPTY_STR_TO_UNDEFINED,
     })
-    attributedTeamId?: string;
+    costCenterId?: string;
 }

components/gitpod-db/src/typeorm/migration/1655795038249-CostCenter.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { columnExists } from "./helper/helper";
+
+export class CostCenter1655795038249 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            "CREATE TABLE IF NOT EXISTS `d_b_cost_center` (`id` char(36) NOT NULL, `deleted` tinyint(4) NOT NULL DEFAULT '0', `_lastModified` timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), PRIMARY KEY (`id`), KEY `ind_dbsync` (`_lastModified`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;",
+        );
+        if (!(await columnExists(queryRunner, "d_b_workspace_instance", "costCenterId"))) {
+            await queryRunner.query(
+                "ALTER TABLE `d_b_workspace_instance` CHANGE `attributedTeamId` `costCenterId` char(36) NOT NULL DEFAULT '', ALGORITHM=INPLACE, LOCK=NONE",
+            );
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, "d_b_workspace_instance", "attributedTeamId"))) {
+            await queryRunner.query(
+                "ALTER TABLE `d_b_workspace_instance` CHANGE `costCenterId` `attributedTeamId` char(36) NOT NULL DEFAULT '', ALGORITHM=INPLACE, LOCK=NONE",
+            );
+        }
+    }
+}

components/gitpod-db/src/workspace-db.spec.db.ts

@@ -66,7 +66,7 @@ class WorkspaceDBSpec {
             ideImage: "unknown",
         },
         deleted: false,
-        attributedTeamId: undefined,
+        costCenterId: undefined,
     };
     readonly wsi2: WorkspaceInstance = {
         workspaceId: this.ws.id,
@@ -89,7 +89,7 @@ class WorkspaceDBSpec {
             ideImage: "unknown",
         },
         deleted: false,
-        attributedTeamId: undefined,
+        costCenterId: undefined,
     };
     readonly ws2: Workspace = {
         id: "2",
@@ -127,7 +127,7 @@ class WorkspaceDBSpec {
             ideImage: "unknown",
         },
         deleted: false,
-        attributedTeamId: undefined,
+        costCenterId: undefined,
     };
 
     readonly ws3: Workspace = {
@@ -165,7 +165,7 @@ class WorkspaceDBSpec {
             ideImage: "unknown",
         },
         deleted: false,
-        attributedTeamId: undefined,
+        costCenterId: undefined,
     };
 
     async before() {

components/gitpod-protocol/src/protocol.ts

@@ -1350,3 +1350,7 @@ export interface Terms {
     readonly content: string;
     readonly formElements?: object;
 }
+
+export interface CostCenter {
+    readonly id: string;
+}

components/gitpod-protocol/src/workspace-instance.ts

@@ -64,11 +64,10 @@ export interface WorkspaceInstance {
     workspaceClass?: string;
 
     /**
-     * Identifies the team to which this instance's runtime should be attributed to
+     * Identifies the team or user to which this instance's runtime should be attributed to
      * (e.g. for usage analytics or billing purposes).
-     * If unset, the usage should be attributed to the workspace's owner (ws.ownerId).
      */
-    attributedTeamId?: string;
+    costCenterId?: string;
 }
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance

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

@@ -15,8 +15,9 @@ import {
     WORKSPACE_TIMEOUT_DEFAULT_LONG,
     WORKSPACE_TIMEOUT_EXTENDED,
     WORKSPACE_TIMEOUT_EXTENDED_ALT,
+    Workspace,
 } from "@gitpod/gitpod-protocol";
-import { ProjectDB, TermsAcceptanceDB, UserDB } from "@gitpod/gitpod-db/lib";
+import { CostCenterDB, ProjectDB, TermsAcceptanceDB, UserDB } from "@gitpod/gitpod-db/lib";
 import { HostContextProvider } from "../auth/host-context-provider";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { Config } from "../config";
@@ -64,6 +65,7 @@ export class UserService {
     @inject(TermsAcceptanceDB) protected readonly termsAcceptanceDb: TermsAcceptanceDB;
     @inject(TermsProvider) protected readonly termsProvider: TermsProvider;
     @inject(ProjectDB) protected readonly projectDb: ProjectDB;
+    @inject(CostCenterDB) protected readonly costCenterDb: CostCenterDB;
 
     /**
      * Takes strings in the form of <authHost>/<authName> and returns the matching User
@@ -207,21 +209,20 @@ export class UserService {
     }
 
     /**
-     * Identifies the team to which a workspace instance's running time should be attributed to
+     * Identifies the team or user to which a workspace instance's running time should be attributed to
      * (e.g. for usage analytics or billing purposes).
-     * If no specific team is identified, the usage will be attributed to the user instead (default).
      *
      * @param user
      * @param projectId
      */
-    async getWorkspaceUsageAttributionTeamId(user: User, projectId?: string): Promise<string | undefined> {
-        if (!projectId) {
-            // No project -- attribute to the user.
+    async getCostCenterId(user: User, workspace: Workspace): Promise<string | undefined> {
+        if (!workspace.projectId) {
+            // No project -- no cost center.
             return undefined;
         }
-        const project = await this.projectDb.findProjectById(projectId);
+        const project = await this.projectDb.findProjectById(workspace.projectId);
         if (!project?.teamId) {
-            // The project doesn't exist, or it isn't owned by a team -- attribute to the user.
+            // The project doesn't exist, or it isn't owned by a team -- no cost center.
             return undefined;
         }
         // Attribute workspace usage to the team that currently owns this project.

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

@@ -722,7 +722,7 @@ export class WorkspaceStarter {
             configuration.featureFlags = featureFlags;
         }
 
-        const attributedTeamId = await this.userService.getWorkspaceUsageAttributionTeamId(user, workspace.projectId);
+        const costCenterId = await this.userService.getCostCenterId(user, workspace);
 
         const now = new Date().toISOString();
         const instance: WorkspaceInstance = {
@@ -737,7 +737,7 @@ export class WorkspaceStarter {
                 phase: "preparing",
             },
             configuration,
-            attributedTeamId,
+            costCenterId,
         };
         if (WithReferrerContext.is(workspace.context)) {
             this.analytics.track({