[server] Introduce an explicit per-user 'usageAttributionId' and use it to implement 'billing-based attribution'

Author: jankeromnes

components/gitpod-protocol/src/protocol.ts

@@ -150,9 +150,10 @@ export interface AdditionalUserData {
     oauthClientsApproved?: { [key: string]: string };
     // to remember GH Orgs the user installed/updated the GH App for
     knownGitHubOrgs?: string[];
-
     // Git clone URL pointing to the user's dotfile repo
     dotfileRepo?: string;
+    // Identifies an explicit team or user ID to which all the user's workspace usage should be attributed to (e.g. for billing purposes)
+    usageAttributionId?: string;
 }
 
 export interface EmailNotificationSettings {

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

@@ -210,10 +210,31 @@ export class UserService {
      * 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).
      *
+     * A. Billing-based attribution: If payments are enabled, we attribute all the user's usage to:
+     *   - An explicitly selected billing account (e.g. a team with usage-based billing enabled)
+     *   - Or, we default to the user for all usage (e.g. free tier or individual billing, regardless of project/team)
+     *
+     * B. Project-based attribution: If payments are not enabled (e.g. Self-Hosted), we attribute:
+     *   - To the owner of the project (user or team), if the workspace is linked to a project
+     *   - To the user, iff the workspace is not linked to a project
+     *
      * @param user
      * @param projectId
      */
     async getWorkspaceUsageAttributionId(user: User, projectId?: string): Promise<string | undefined> {
+        // A. Billing-based attribution
+        if (this.config.enablePayment) {
+            if (!user.additionalData?.usageAttributionId) {
+                // No explicit user attribution ID yet -- attribute all usage to the user by default (regardless of project/team).
+                user.additionalData = user.additionalData || {};
+                user.additionalData.usageAttributionId = `user:${user.id}`;
+                await this.userDb.updateUserPartial(user);
+            }
+            // Return the user's explicit attribution ID.
+            return user.additionalData.usageAttributionId;
+        }
+
+        // B. Project-based attribution
         if (!projectId) {
             // No project -- attribute to the user.
             return `user:${user.id}`;