[Usage-based] Attribute workspace instances to a Team on start

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

@@ -102,4 +102,10 @@ export class DBWorkspaceInstance implements WorkspaceInstance {
         transformer: Transformer.MAP_EMPTY_STR_TO_UNDEFINED,
     })
     workspaceClass?: string;
+
+    @Column({
+        default: "",
+        transformer: Transformer.MAP_EMPTY_STR_TO_UNDEFINED,
+    })
+    attributedTeamId?: string;
 }

components/gitpod-db/src/typeorm/migration/1654847406624-WorkspaceInstanceAttributedTeam.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";
+
+const TABLE_NAME = "d_b_workspace_instance";
+const COLUMN_NAME = "attributedTeamId";
+
+export class WorkspaceInstanceAttributedTeam1654847406624 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, TABLE_NAME, COLUMN_NAME))) {
+            await queryRunner.query(
+                `ALTER TABLE ${TABLE_NAME} ADD COLUMN ${COLUMN_NAME} char(36) NOT NULL DEFAULT '', ALGORITHM=INPLACE, LOCK=NONE`,
+            );
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        if (await columnExists(queryRunner, TABLE_NAME, COLUMN_NAME)) {
+            await queryRunner.query(
+                `ALTER TABLE ${TABLE_NAME} DROP COLUMN ${COLUMN_NAME}, ALGORITHM=INPLACE, LOCK=NONE`,
+            );
+        }
+    }
+}

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

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

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

@@ -62,6 +62,13 @@ export interface WorkspaceInstance {
      * resources that are provided to the workspace.
      */
     workspaceClass?: string;
+
+    /**
+     * Identifies the team 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;
 }
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance

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

@@ -16,7 +16,7 @@ import {
     WORKSPACE_TIMEOUT_EXTENDED,
     WORKSPACE_TIMEOUT_EXTENDED_ALT,
 } from "@gitpod/gitpod-protocol";
-import { TermsAcceptanceDB, UserDB } from "@gitpod/gitpod-db/lib";
+import { 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";
@@ -63,6 +63,7 @@ export class UserService {
     @inject(Config) protected readonly config: Config;
     @inject(TermsAcceptanceDB) protected readonly termsAcceptanceDb: TermsAcceptanceDB;
     @inject(TermsProvider) protected readonly termsProvider: TermsProvider;
+    @inject(ProjectDB) protected readonly projectDb: ProjectDB;
 
     /**
      * Takes strings in the form of <authHost>/<authName> and returns the matching User
@@ -205,6 +206,28 @@ export class UserService {
         return false;
     }
 
+    /**
+     * Identifies the team 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.
+            return undefined;
+        }
+        const project = await this.projectDb.findProjectById(projectId);
+        if (!project?.teamId) {
+            // The project doesn't exist, or it isn't owned by a team -- attribute to the user.
+            return undefined;
+        }
+        // Attribute workspace usage to the team that currently owns this project.
+        return project.teamId;
+    }
+
     /**
      * This might throw `AuthException`s.
      *

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

@@ -633,9 +633,9 @@ export class WorkspaceStarter {
         delete ideConfig.ideOptions.options["code-latest"];
         delete ideConfig.ideOptions.options["code-desktop-insiders"];
 
-        const migratted = migrationIDESettings(user);
-        if (user.additionalData?.ideSettings && migratted) {
-            user.additionalData.ideSettings = migratted;
+        const migrated = migrationIDESettings(user);
+        if (user.additionalData?.ideSettings && migrated) {
+            user.additionalData.ideSettings = migrated;
         }
 
         const ideChoice = user.additionalData?.ideSettings?.defaultIde;
@@ -709,6 +709,8 @@ export class WorkspaceStarter {
             configuration.featureFlags = featureFlags;
         }
 
+        const attributedTeamId = await this.userService.getWorkspaceUsageAttributionTeamId(user, workspace.projectId);
+
         const now = new Date().toISOString();
         const instance: WorkspaceInstance = {
             id: uuidv4(),
@@ -722,6 +724,7 @@ export class WorkspaceStarter {
                 phase: "preparing",
             },
             configuration,
+            attributedTeamId,
         };
         if (WithReferrerContext.is(workspace.context)) {
             this.analytics.track({