[server] Attribute workspace usage to either the project's team, or default to the workspace owner

Author: jankeromnes

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

@@ -646,9 +646,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;
@@ -722,6 +722,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(),
@@ -735,6 +737,7 @@ export class WorkspaceStarter {
                 phase: "preparing",
             },
             configuration,
+            attributedTeamId,
         };
         if (WithReferrerContext.is(workspace.context)) {
             this.analytics.track({