Add "spending limit is reached" notification

Author: AlexTugarev

components/gitpod-protocol/src/gitpod-service.ts

@@ -302,6 +302,11 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     trackEvent(event: RemoteTrackMessage): Promise<void>;
     trackLocation(event: RemotePageMessage): Promise<void>;
     identifyUser(event: RemoteIdentifyMessage): Promise<void>;
+
+    /**
+     * Frontend notifications
+     */
+    getNotifications(): Promise<string[]>;
 }
 
 export interface RateLimiterError {

components/server/ee/src/workspace/gitpod-server-impl.ts

@@ -2096,6 +2096,26 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         });
     }
 
+    async getNotifications(ctx: TraceContext): Promise<string[]> {
+        const result = await super.getNotifications(ctx);
+        const user = this.checkAndBlockUser("getNotifications");
+        if (user.usageAttributionId) {
+            const allSessions = await this.listBilledUsage(ctx, user.usageAttributionId);
+            const totalUsage = allSessions.map((s) => s.credits).reduce((a, b) => a + b, 0);
+            const costCenter = await this.costCenterDB.findById(user.usageAttributionId);
+            if (costCenter) {
+                if (totalUsage > costCenter.spendingLimit) {
+                    result.unshift("The spending limit is reached.");
+                } else if (totalUsage > 0.8 * costCenter.spendingLimit * 0.8) {
+                    result.unshift("The spending limit is almost reached.");
+                }
+            } else {
+                log.warn("No costcenter found.", { userId: user.id, attributionId: user.usageAttributionId });
+            }
+        }
+        return result;
+    }
+
     async listBilledUsage(ctx: TraceContext, attributionId: string): Promise<BillableSession[]> {
         traceAPIParams(ctx, { attributionId });
         const user = this.checkAndBlockUser("listBilledUsage");

components/server/src/auth/rate-limiter.ts

@@ -219,6 +219,7 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         setUsageAttribution: { group: "default", points: 1 },
         getSpendingLimitForTeam: { group: "default", points: 1 },
         setSpendingLimitForTeam: { group: "default", points: 1 },
+        getNotifications: { group: "default", points: 1 },
     };
 
     return {

components/server/src/workspace/gitpod-server-impl.ts

@@ -3243,4 +3243,9 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             return this.imagebuilderClientProvider.getClient(user, workspace, instance);
         }
     }
+
+    async getNotifications(ctx: TraceContext): Promise<string[]> {
+        this.checkAndBlockUser("getNotifications");
+        return [];
+    }
 }