[server] Move regionCode handling into WorkspaceService.startWorkspace

Author: geropl

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

@@ -190,8 +190,8 @@ import { OrganizationService } from "../orgs/organization-service";
 import { RedisSubscriber } from "../messaging/redis-subscriber";
 import { UsageService } from "../orgs/usage-service";
 import { UserService } from "../user/user-service";
-import { WorkspaceService } from "./workspace-service";
 import { SSHKeyService } from "../user/sshkey-service";
+import { StartWorkspaceOptions, WorkspaceService } from "./workspace-service";
 
 // shortcut
 export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi); // userId is already taken care of in WebsocketConnectionManager
@@ -935,13 +935,11 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         // no matter if the workspace is shared or not, you cannot create a new instance
         await this.guardAccess({ kind: "workspaceInstance", subject: undefined, workspace }, "create");
 
-        options.region = await this.workspaceService.determineWorkspaceRegion(
-            user.id,
-            workspaceId,
-            options.region || "",
-            this.clientHeaderFields.clientRegion,
-        );
-        const result = await this.workspaceService.startWorkspace(ctx, user, workspaceId, options);
+        const opts: StartWorkspaceOptions = {
+            ...options,
+            clientRegionCode: this.clientHeaderFields?.clientRegion,
+        };
+        const result = await this.workspaceService.startWorkspace(ctx, user, workspaceId, opts);
         traceWI(ctx, { instanceId: result.instanceID });
         return result;
     }
@@ -1417,13 +1415,11 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             logContext.workspaceId = workspace.id;
             traceWI(ctx, { workspaceId: workspace.id });
 
-            options.region = await this.workspaceService.determineWorkspaceRegion(
-                user.id,
-                workspace.id,
-                options.region || "",
-                this.clientHeaderFields.clientRegion,
-            );
-            const startWorkspaceResult = await this.workspaceService.startWorkspace(ctx, user, workspace.id, options);
+            const opts: StartWorkspaceOptions = {
+                ...options,
+                clientRegionCode: this.clientHeaderFields?.clientRegion,
+            };
+            const startWorkspaceResult = await this.workspaceService.startWorkspace(ctx, user, workspace.id, opts);
             ctx.span?.log({ event: "startWorkspaceComplete", ...startWorkspaceResult });
 
             return {

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

@@ -31,6 +31,13 @@ import { RegionService } from "./region-service";
 import { ProjectsService } from "../projects/projects-service";
 import { EnvVarService } from "./env-var-service";
 
+export interface StartWorkspaceOptions extends GitpodServer.StartWorkspaceOptions {
+    /**
+     * This field is used to guess the workspace location using the RegionService
+     */
+    clientRegionCode?: string;
+}
+
 @injectable()
 export class WorkspaceService {
     constructor(
@@ -228,7 +235,7 @@ export class WorkspaceService {
         ctx: TraceContext,
         user: User,
         workspaceId: string,
-        options?: GitpodServer.StartWorkspaceOptions,
+        options: StartWorkspaceOptions = {},
     ): Promise<StartWorkspaceResult> {
         await this.auth.checkPermissionOnWorkspace(user.id, "start", workspaceId);
 
@@ -259,6 +266,13 @@ export class WorkspaceService {
 
         await mayStartPromise;
 
+        options.region = await this.determineWorkspaceRegion(
+            user.id,
+            workspaceId,
+            options.region || "",
+            options.clientRegionCode,
+        );
+
         // at this point we're about to actually start a new workspace
         const result = await this.workspaceStarter.startWorkspace(
             ctx,
@@ -314,7 +328,7 @@ export class WorkspaceService {
         }
     }
 
-    async determineWorkspaceRegion(
+    private async determineWorkspaceRegion(
         userId: string,
         workspaceId: string,
         preference: WorkspaceRegion,