[server] Map IDE image as part of workspace config

Christian Weichel · Christian Weichel · commit b71f68fc1aae · 2020-09-14T10:01:00.000+02:00
diff --git a/chart/templates/server-deployment.yaml b/chart/templates/server-deployment.yaml
@@ -125,6 +125,8 @@ spec:
           value: "{{ template "gitpod.comp.imageRepo" (dict "root" . "gp" $.Values "comp" .Values.components.workspace.codeImage) }}"
         - name: WORKSPACE_DEFAULT_IMAGE
           value: "{{ template "gitpod.comp.imageFull" (dict "root" . "gp" $.Values "comp" .Values.components.workspace.defaultImage) }}"
+        - name: IDE_IMAGE_ALIASES
+          value: {{ (dict "code" (include "gitpod.comp.imageFull" (dict "root" . "gp" $.Values "comp" .Values.components.workspace.codeImage))) | toJson | quote }}
     {{- if $comp.blockNewUsers }}
         - name: BLOCK_NEW_USERS
           value: {{ $comp.blockNewUsers | quote }}
diff --git a/components/gitpod-protocol/src/protocol.ts b/components/gitpod-protocol/src/protocol.ts
@@ -511,7 +511,7 @@ export interface WorkspaceConfig {
     gitConfig?: { [config: string]: string };
     github?: GithubAppConfig;
     vscode?: VSCodeConfig;
-    ide?: 'theia' | 'code';
+    ide?: 'theia' | 'code' | string;
 
     /**
      * Where the config object originates from.
diff --git a/components/server/src/dev/dev-data.ts b/components/server/src/dev/dev-data.ts
@@ -4,10 +4,9 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { IssueContext, Workspace, User, PullRequestContext, Repository, Token } from "@gitpod/gitpod-protocol";
+import { IssueContext, User, PullRequestContext, Repository, Token } from "@gitpod/gitpod-protocol";
 import { GitHubScope } from "../github/scopes";
 import { GitLabScope } from "../gitlab/scopes";
-import { ConfigProvider } from "../workspace/config-provider";
 import { TokenService } from "../user/token-service";
 
 export namespace DevData {
@@ -99,7 +98,7 @@ export namespace DevData {
         };
     }
 
-    function createPrContext(user: User): PullRequestContext {
+    export function createPrContext(user: User): PullRequestContext {
         const repository: Repository = {
             host: 'github.com',
             owner: user.identities[0].authName,
@@ -119,21 +118,7 @@ export namespace DevData {
         }
     };
 
-    export function createTestWorkspacePR(user: User): Workspace {
-        const config = ConfigProvider.defaultConfig()
-        return {
-            id: "a12-345",
-            type: "regular",
-            creationTime: new Date().toISOString(),
-            contextURL: 'github.com/TypeFox/gitpod-test-repo',
-            description: "Test Workspace, connecting to local Theia",
-            ownerId: user.id,
-            context: createPrContext(user),
-            config
-        }
-    };
-
-    function createIssueContext(user: User): IssueContext {
+    export function createIssueContext(user: User): IssueContext {
         const repository: Repository = {
             host: 'github.com',
             owner: user.identities[0].authName,
@@ -149,18 +134,4 @@ export namespace DevData {
         }
     };
 
-    export function createTestWorkspaceISSUE(user: User): Workspace {
-        const config = ConfigProvider.defaultConfig();
-        return {
-            id: "a12-321",
-            type: "regular",
-            creationTime: new Date().toISOString(),
-            contextURL: 'github.com/TypeFox/gitpod-test-repo',
-            description: "Test Workspace, connecting to local Theia",
-            ownerId: user.id,
-            context: createIssueContext(user),
-            config
-        }
-    };
-
 }
diff --git a/components/server/src/env.ts b/components/server/src/env.ts
@@ -32,11 +32,18 @@ export class Env extends AbstractComponentEnv {
         return envValue ? parseInt(envValue, 10) : 5 * this.theiaHeartbeatInterval;
     }
 
-    readonly codeImageRepo = process.env.CODE_IMAGE_REPO || 'unknown';
-    
     readonly theiaVersion = process.env.THEIA_VERSION || this.serverVersion;
     readonly theiaImageRepo = process.env.THEIA_IMAGE_REPO || 'unknown';
     readonly theiaMounted = process.env.THEIA_MOUNTED === "true";
+    readonly ideDefaultImage = `${this.theiaImageRepo}:${this.theiaVersion}`;
+    readonly workspaceDefaultImage = process.env.WORKSPACE_DEFAULT_IMAGE || "gitpod/workspace-full:latest";
+
+    readonly ideImageAliases: { [index: string]: string } = (() => {
+        const envValue = process.env.IDE_IMAGE_ALIASES;
+        let res = !!envValue ? JSON.parse(envValue) : {};
+        res["theia"] = this.ideDefaultImage;
+        return res;
+    })()
 
     readonly gitpodRegion: string = process.env.GITPOD_REGION || 'unknown';
 
diff --git a/components/server/src/workspace/config-inference-provider.ts b/components/server/src/workspace/config-inference-provider.ts
@@ -7,13 +7,14 @@
 import { inject, injectable, postConstruct } from "inversify";
 import { CommitContext, User, WorkspaceConfig } from "@gitpod/gitpod-protocol";
 import { HostContextProvider } from "../auth/host-context-provider";
-import { ConfigProvider } from "./config-provider";
+import { Env } from "../env";
 
 export type LanguageConfigProvider = (language: string, user: User, commit: CommitContext) => Promise<WorkspaceConfig | undefined>;
 
 @injectable()
 export class ConfigInferenceProvider {
     @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
+    @inject(Env) protected readonly env: Env;
 
     protected readonly languageConfigProvider = new Map<string, LanguageConfigProvider>();
 
@@ -64,7 +65,7 @@ export class ConfigInferenceProvider {
                     init: `test -f go.mod && go get -v ./...`
                 }
             ],
-            image: ConfigProvider.DEFAULT_IMAGE
+            image: this.env.workspaceDefaultImage
         } as WorkspaceConfig;
     }
 
diff --git a/components/server/src/workspace/config-provider.ts b/components/server/src/workspace/config-provider.ts
@@ -18,6 +18,7 @@ import { HostContextProvider } from "../auth/host-context-provider";
 import { AuthorizationService } from "../user/authorization-service";
 import { TheiaPluginService } from "../theia-plugin/theia-plugin-service";
 import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
+import { Env } from "../env";
 
 const POD_PATH_WORKSPACE_BASE = "/workspace";
 
@@ -35,6 +36,7 @@ export class ConfigProvider {
     @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
     @inject(AuthorizationService) protected readonly authService: AuthorizationService;
     @inject(TheiaPluginService) protected readonly pluginService: TheiaPluginService;
+    @inject(Env) protected readonly env: Env;
 
     public async fetchConfig(ctx: TraceContext, user: User, commit: CommitContext): Promise<WorkspaceConfig> {
         const span = TraceContext.startSpan("fetchConfig", ctx);
@@ -93,7 +95,7 @@ export class ConfigProvider {
 
             if (!customConfig) {
                 log.debug(logContext, 'Config string undefined, using default config', { repoCloneUrl: commit.repository.cloneUrl, revision: commit.revision });
-                const config = ConfigProvider.defaultConfig();
+                const config = this.defaultConfig();
                 if (!ImageConfigString.is(config.image)) {
                     throw new Error(`Default config must contain a base image!`);
                 }
@@ -103,7 +105,7 @@ export class ConfigProvider {
 
             const config = customConfig;
             if (!config.image) {
-                config.image = ConfigProvider.DEFAULT_IMAGE;
+                config.image = this.env.workspaceDefaultImage;
             } else if (ImageConfigFile.is(config.image)) {
                 let dockerfilePath = [configBasePath, config.image.file].filter(s => !!s).join('/');
                 let repo = commit.repository;
@@ -137,6 +139,13 @@ export class ConfigProvider {
                 config._featureFlags = workspacePersistedFlags.filter(f => (user.featureFlags!.permanentWSFeatureFlags || []).includes(f));
             }
 
+            if (!!config.ide) {
+                const mapped = this.env.ideImageAliases[config.ide];
+                if (!!mapped) {
+                    config.ide = mapped;
+                }
+            }
+
             return config;
         } catch (e) {
             TraceContext.logError({span}, e);
@@ -146,6 +155,17 @@ export class ConfigProvider {
         }
     }
 
+    public defaultConfig(): WorkspaceConfig {
+        return {
+            ports: [{
+                port: 3000
+            }],
+            tasks: [],
+            ide: this.env.ideDefaultImage,
+            image: this.env.workspaceDefaultImage
+        };
+    }
+
     protected async fetchWorkspaceImageSourceDocker(ctx: TraceContext, repository: Repository, revisionOrTagOrBranch: string, user: User, dockerFilePath: string): Promise<Commit> {
         const span = TraceContext.startSpan("fetchWorkspaceImageSourceDocker", ctx);
         span.addTags({
@@ -279,18 +299,3 @@ export class ConfigProvider {
     }
 
 }
-
-export namespace ConfigProvider {
-    export const DEFAULT_IMAGE = process.env.WORKSPACE_DEFAULT_IMAGE || "gitpod/workspace-full:latest";
-
-    export function defaultConfig(): WorkspaceConfig {
-        return {
-            ports: [{
-                port: 3000
-            }],
-            tasks: [],
-            image: DEFAULT_IMAGE
-        };
-    }
-
-}
diff --git a/components/server/src/workspace/workspace-starter.ts b/components/server/src/workspace/workspace-starter.ts
@@ -28,7 +28,6 @@ import { UserService } from "../user/user-service";
 import { HeadlessLogEvent, HeadlessWorkspaceEventType } from "@gitpod/gitpod-protocol/lib/headless-workspace-log";
 import { TheiaPluginService } from "../theia-plugin/theia-plugin-service";
 import { OneTimeSecretServer } from "../one-time-secret-server";
-import { ConfigProvider } from "./config-provider";
 
 @injectable()
 export class WorkspaceStarter {
@@ -65,7 +64,7 @@ export class WorkspaceStarter {
 
             if (options.forceDefaultImage) {
                 const req = new ResolveBaseImageRequest();
-                req.setRef(ConfigProvider.DEFAULT_IMAGE);
+                req.setRef(this.env.workspaceDefaultImage);
                 const allowAll = new BuildRegistryAuthTotal();
                 allowAll.setAllowAll(true);
                 const auth = new BuildRegistryAuth();
@@ -534,11 +533,7 @@ export class WorkspaceStarter {
         spec.setGit(this.createGitSpec(workspace, user));
         spec.setPortsList(ports);
         spec.setInitializer(await initializerPromise);
-        if (workspace.config.ide === 'code') {
-            spec.setIdeImage(`${this.env.codeImageRepo}:${instance.configuration!.theiaVersion}`);
-        } else {
-            spec.setIdeImage(`${this.env.theiaImageRepo}:${instance.configuration!.theiaVersion}`);
-        }
+        spec.setIdeImage(workspace.config.ide || `${this.env.theiaImageRepo}:${instance.configuration!.theiaVersion}`);
         spec.setWorkspaceImage(instance.workspaceImage);
         spec.setWorkspaceLocation(workspace.config.workspaceLocation || spec.getCheckoutLocation());
         spec.setFeatureFlagsList(this.toWorkspaceFeatureFlags(instance.configuration!.featureFlags || []));
