WorkspaceService.getSupportedWorkspaceClasses + updateGitStatus

Author: geropl

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

@@ -12,7 +12,6 @@ import {
     TracedWorkspaceDB,
     EmailDomainFilterDB,
     TeamDB,
-    RedisPublisher,
     DBGitpodToken,
 } from "@gitpod/gitpod-db/lib";
 import { BlockedRepositoryDB } from "@gitpod/gitpod-db/lib/blocked-repository-db";
@@ -260,8 +259,6 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         @inject(EmailDomainFilterDB) private emailDomainFilterdb: EmailDomainFilterDB,
 
         @inject(RedisSubscriber) private readonly subscriber: RedisSubscriber,
-        @inject(RedisPublisher) private readonly publisher: RedisPublisher,
-        @inject(TracedWorkspaceDB) private readonly workspaceDB: DBWithTracing<WorkspaceDB>,
     ) {}
 
     /** Id the uniquely identifies this server instance */
@@ -1854,23 +1851,11 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         const user = await this.checkAndBlockUser("updateGitStatus");
 
         const workspace = await this.workspaceService.getWorkspace(user.id, workspaceId);
-        let instance = await this.workspaceDb.trace(ctx).findCurrentInstance(workspaceId);
-        if (!instance) {
-            throw new ApplicationError(ErrorCodes.NOT_FOUND, `workspace ${workspaceId} has no instance`);
-        }
+        const instance = await this.workspaceService.getCurrentInstance(user.id, workspaceId);
         traceWI(ctx, { instanceId: instance.id });
         await this.guardAccess({ kind: "workspaceInstance", subject: instance, workspace }, "update");
 
-        if (WorkspaceInstanceRepoStatus.equals(instance.gitStatus, gitStatus)) {
-            return;
-        }
-
-        instance = await this.workspaceDB.trace(ctx).updateInstancePartial(instance.id, { gitStatus });
-        await this.publisher.publishInstanceUpdate({
-            instanceID: instance.id,
-            ownerID: workspace.ownerId,
-            workspaceID: workspace.id,
-        });
+        await this.workspaceService.updateGitStatus(user.id, workspaceId, gitStatus);
     }
 
     public async openPort(
@@ -3385,16 +3370,8 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     }
 
     async getSupportedWorkspaceClasses(ctx: TraceContext): Promise<SupportedWorkspaceClass[]> {
-        await this.checkAndBlockUser("getSupportedWorkspaceClasses");
-        const classes = this.config.workspaceClasses.map((c) => ({
-            id: c.id,
-            category: c.category,
-            displayName: c.displayName,
-            description: c.description,
-            powerups: c.powerups,
-            isDefault: c.isDefault,
-        }));
-        return classes;
+        const user = await this.checkAndBlockUser("getSupportedWorkspaceClasses");
+        return this.workspaceService.getSupportedWorkspaceClasses(user.id);
     }
 
     //#region gitpod.io concerns

components/server/src/workspace/workspace-service.spec.db.ts

@@ -302,6 +302,26 @@ describe("WorkspaceService", async () => {
             "should fail on non-running workspace",
         );
     });
+
+    it("should updateGitStatus", async () => {
+        const svc = container.get(WorkspaceService);
+        const ws = await createTestWorkspace(svc, org, owner, project);
+
+        await expectError(
+            ErrorCodes.NOT_FOUND,
+            svc.updateGitStatus(owner.id, ws.id, {
+                branch: "main",
+                uncommitedFiles: ["new-unit.ts"],
+                latestCommit: "asdf",
+                totalUncommitedFiles: 1,
+                totalUntrackedFiles: 1,
+                unpushedCommits: [],
+                untrackedFiles: ["new-unit.ts"],
+                totalUnpushedCommits: 0,
+            }),
+            "should fail on non-running workspace",
+        );
+    });
 });
 
 async function createTestWorkspace(svc: WorkspaceService, org: Organization, owner: User, project: Project) {

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

@@ -6,7 +6,7 @@
 
 import { inject, injectable } from "inversify";
 import * as grpc from "@grpc/grpc-js";
-import { WorkspaceDB } from "@gitpod/gitpod-db/lib";
+import { RedisPublisher, WorkspaceDB } from "@gitpod/gitpod-db/lib";
 import {
     GitpodServer,
     PortProtocol,
@@ -18,6 +18,7 @@ import {
     WorkspaceContext,
     WorkspaceInstance,
     WorkspaceInstancePort,
+    WorkspaceInstanceRepoStatus,
     WorkspaceSoftDeletion,
 } from "@gitpod/gitpod-protocol";
 import { ErrorCodes, ApplicationError } from "@gitpod/gitpod-protocol/lib/messaging/error";
@@ -42,6 +43,8 @@ import { RegionService } from "./region-service";
 import { ProjectsService } from "../projects/projects-service";
 import { EnvVarService } from "../user/env-var-service";
 import { WorkspaceManagerClientProvider } from "@gitpod/ws-manager/lib/client-provider";
+import { SupportedWorkspaceClass } from "@gitpod/gitpod-protocol/lib/workspace-class";
+import { Config } from "../config";
 
 export interface StartWorkspaceOptions extends GitpodServer.StartWorkspaceOptions {
     /**
@@ -53,13 +56,15 @@ export interface StartWorkspaceOptions extends GitpodServer.StartWorkspaceOption
 @injectable()
 export class WorkspaceService {
     constructor(
+        @inject(Config) private readonly config: Config,
         @inject(WorkspaceFactory) private readonly factory: WorkspaceFactory,
         @inject(WorkspaceStarter) private readonly workspaceStarter: WorkspaceStarter,
         @inject(WorkspaceManagerClientProvider) private readonly clientProvider: WorkspaceManagerClientProvider,
         @inject(WorkspaceDB) private readonly db: WorkspaceDB,
         @inject(EntitlementService) private readonly entitlementService: EntitlementService,
         @inject(EnvVarService) private readonly envVarService: EnvVarService,
         @inject(ProjectsService) private readonly projectsService: ProjectsService,
+        @inject(RedisPublisher) private readonly publisher: RedisPublisher,
         @inject(Authorizer) private readonly auth: Authorizer,
     ) {}
 
@@ -539,6 +544,40 @@ export class WorkspaceService {
         await this.auth.checkPermissionOnWorkspace(userId, "access", workspaceId);
         await this.db.updatePartial(workspaceId, { description });
     }
+
+    public async updateGitStatus(
+        userId: string,
+        workspaceId: string,
+        gitStatus: Required<WorkspaceInstanceRepoStatus> | undefined,
+    ) {
+        await this.auth.checkPermissionOnWorkspace(userId, "access", workspaceId);
+
+        let instance = await this.getCurrentInstance(userId, workspaceId);
+        if (WorkspaceInstanceRepoStatus.equals(instance.gitStatus, gitStatus)) {
+            return;
+        }
+
+        const workspace = await this.getWorkspace(userId, workspaceId);
+        instance = await this.db.updateInstancePartial(instance.id, { gitStatus });
+        await this.publisher.publishInstanceUpdate({
+            instanceID: instance.id,
+            ownerID: workspace.ownerId,
+            workspaceID: workspace.id,
+        });
+    }
+
+    public async getSupportedWorkspaceClasses(userId: string): Promise<SupportedWorkspaceClass[]> {
+        // No access check required, valid session/user is enough
+        const classes = this.config.workspaceClasses.map((c) => ({
+            id: c.id,
+            category: c.category,
+            displayName: c.displayName,
+            description: c.description,
+            powerups: c.powerups,
+            isDefault: c.isDefault,
+        }));
+        return classes;
+    }
 }
 
 // TODO(gpl) Make private after FGA rollout