[server] Make PrebuildManager use WorkspaceService.startWorkspace (to remove code duplication) (#18653)

Author: geropl

components/server/src/prebuilds/prebuild-manager.ts

@@ -22,7 +22,6 @@ import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
 import { getCommitInfo, HostContextProvider } from "../auth/host-context-provider";
 import { ConfigProvider } from "../workspace/config-provider";
-import { WorkspaceStarter } from "../workspace/workspace-starter";
 import { Config } from "../config";
 import { ProjectsService } from "../projects/projects-service";
 import { secondsBefore } from "@gitpod/gitpod-protocol/lib/util/timeutil";
@@ -37,7 +36,6 @@ import { ErrorCodes, ApplicationError } from "@gitpod/gitpod-protocol/lib/messag
 import { UserAuthentication } from "../user/user-authentication";
 import { EntitlementService, MayStartWorkspaceResult } from "../billing/entitlement-service";
 import { WorkspaceService } from "../workspace/workspace-service";
-import { EnvVarService } from "../user/env-var-service";
 
 export class WorkspaceRunningError extends Error {
     constructor(msg: string, public instance: WorkspaceInstance) {
@@ -57,7 +55,6 @@ export interface StartPrebuildParams {
 export class PrebuildManager {
     @inject(TracedWorkspaceDB) protected readonly workspaceDB: DBWithTracing<WorkspaceDB>;
     @inject(WorkspaceService) protected readonly workspaceService: WorkspaceService;
-    @inject(WorkspaceStarter) protected readonly workspaceStarter: WorkspaceStarter;
     @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
     @inject(ConfigProvider) protected readonly configProvider: ConfigProvider;
     @inject(Config) protected readonly config: Config;
@@ -66,7 +63,6 @@ export class PrebuildManager {
     @inject(UserAuthentication) protected readonly userService: UserAuthentication;
     @inject(TeamDB) protected readonly teamDB: TeamDB;
     @inject(EntitlementService) protected readonly entitlementService: EntitlementService;
-    @inject(EnvVarService) private readonly envVarService: EnvVarService;
 
     async abortPrebuildsForBranch(ctx: TraceContext, project: Project, user: User, branch: string): Promise<void> {
         const span = TraceContext.startSpan("abortPrebuildsForBranch", ctx);
@@ -230,13 +226,6 @@ export class PrebuildManager {
                 context.normalizedContextURL!,
             );
 
-            const envVarsPromise = this.envVarService.resolveEnvVariables(
-                workspace.ownerId,
-                workspace.projectId,
-                workspace.type,
-                workspace.context,
-            );
-
             const prebuild = await this.workspaceDB.trace({ span }).findPrebuildByWorkspaceID(workspace.id)!;
             if (!prebuild) {
                 throw new Error(`Failed to create a prebuild for: ${context.normalizedContextURL}`);
@@ -280,10 +269,15 @@ export class PrebuildManager {
                 await this.workspaceDB.trace({ span }).storePrebuiltWorkspace(prebuild);
             } else {
                 span.setTag("starting", true);
-                const envVars = await envVarsPromise;
-                await this.workspaceStarter.startWorkspace({ span }, workspace, user, project, envVars, {
-                    excludeFeatureFlags: ["full_workspace_backup"],
-                });
+                await this.workspaceService.startWorkspace(
+                    { span },
+                    user,
+                    workspace.id,
+                    {
+                        excludeFeatureFlags: ["full_workspace_backup"],
+                    },
+                    false,
+                );
             }
 
             return { prebuildId: prebuild.id, wsid: workspace.id, done: false };
@@ -339,13 +333,7 @@ export class PrebuildManager {
             if (!prebuild) {
                 throw new Error("No prebuild found for workspace " + workspaceId);
             }
-            const envVars = await this.envVarService.resolveEnvVariables(
-                workspace.ownerId,
-                workspace.projectId,
-                workspace.type,
-                workspace.context,
-            );
-            await this.workspaceStarter.startWorkspace({ span }, workspace, user, project, envVars);
+            await this.workspaceService.startWorkspace({ span }, user, workspaceId, {}, false);
             return { prebuildId: prebuild.id, wsid: workspace.id, done: false };
         } catch (err) {
             TraceContext.setError({ span }, err);

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

@@ -45,7 +45,7 @@ import {
     AdmissionLevel,
     ControlAdmissionRequest,
 } from "@gitpod/ws-manager/lib";
-import { WorkspaceStarter } from "./workspace-starter";
+import { WorkspaceStarter, StartWorkspaceOptions as StarterStartWorkspaceOptions } from "./workspace-starter";
 import { LogContext, log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { EntitlementService, MayStartWorkspaceResult } from "../billing/entitlement-service";
 import * as crypto from "crypto";
@@ -62,7 +62,7 @@ import { HeadlessLogEndpoint, HeadlessLogService } from "./headless-log-service"
 import { Deferred } from "@gitpod/gitpod-protocol/lib/util/deferred";
 import { OrganizationService } from "../orgs/organization-service";
 
-export interface StartWorkspaceOptions extends GitpodServer.StartWorkspaceOptions {
+export interface StartWorkspaceOptions extends StarterStartWorkspaceOptions {
     /**
      * This field is used to guess the workspace location using the RegionService
      */
@@ -437,10 +437,21 @@ export class WorkspaceService {
         user: User,
         workspaceId: string,
         options: StartWorkspaceOptions = {},
+        restrictToRegular = true,
     ): Promise<StartWorkspaceResult> {
         await this.auth.checkPermissionOnWorkspace(user.id, "start", workspaceId);
 
-        const workspace = await this.doGetWorkspace(user.id, workspaceId);
+        const { workspace, latestInstance } = await this.getWorkspace(user.id, workspaceId);
+        if (latestInstance) {
+            if (latestInstance.status.phase !== "stopped") {
+                // We already have a running workspace instance
+                return {
+                    instanceID: latestInstance.id,
+                    workspaceURL: latestInstance.ideUrl,
+                };
+            }
+        }
+
         const mayStartPromise = this.mayStartWorkspace(
             ctx,
             user,
@@ -456,7 +467,7 @@ export class WorkspaceService {
             };
         }
 
-        if (workspace.type !== "regular") {
+        if (restrictToRegular && workspace.type !== "regular") {
             throw new ApplicationError(ErrorCodes.BAD_REQUEST, "Cannot (re-)start irregular workspace.");
         }
 

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

@@ -140,10 +140,8 @@ export async function getWorkspaceClassForInstance(
     ctx: TraceContext,
     workspace: Workspace,
     previousInstance: WorkspaceInstance | undefined,
-    user: User,
     project: Project | undefined,
     workspaceClassOverride: string | undefined,
-    entitlementService: EntitlementService,
     config: WorkspaceClassesConfig,
 ): Promise<string> {
     const span = TraceContext.startSpan("getWorkspaceClassForInstance", ctx);
@@ -900,10 +898,8 @@ export class WorkspaceStarter {
                 ctx,
                 workspace,
                 previousInstance,
-                user,
                 project,
                 workspaceClassOverride,
-                this.entitlementService,
                 this.config.workspaceClasses,
             );