[server] derive configuration when no explicit one

Fixes #6921

Author: svenefftinge

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

@@ -203,7 +203,7 @@ export class PrebuildManager {
                 return undefined;
             }
             const context = await contextParser!.handle({ span }, user, contextURL);
-            return await this.configProvider.fetchConfig({ span }, user, context as CommitContext);
+            return (await this.configProvider.fetchConfig({ span }, user, context as CommitContext)).config;
         } catch (err) {
             TraceContext.setError({ span }, err);
             throw err;

components/server/ee/src/workspace/workspace-factory.ts

@@ -60,7 +60,7 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
                 }
             }
 
-            const config = await this.configProvider.fetchConfig({span}, user, context.actual);
+            const { config } = await this.configProvider.fetchConfig({span}, user, context.actual);
             const imageSource = await this.imageSourceProvider.getImageSource(ctx, user, context.actual, config);
 
             // Walk back the commit history to find suitable parent prebuild to start an incremental prebuild on.

components/server/src/projects/config-inferrer.spec.ts renamed to components/server/src/config/config-inferrer.spec.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { CommitContext, User, WorkspaceConfig } from "@gitpod/gitpod-protocol";
+import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
+import { inject, injectable } from "inversify";
+import { HostContextProvider } from "../auth/host-context-provider";
+import { FileProvider } from "../repohost";
+import { ContextParser } from "../workspace/context-parser-service";
+import { ConfigInferrer } from "./config-inferrer";
+
+
+@injectable()
+export class ConfigurationService {
+
+    @inject(ContextParser) protected contextParser: ContextParser;
+    @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
+
+    // a static cache used to prefetch inferrer related files in parallel in advance
+    private requestedPaths = new Set<string>();
+
+    async guessRepositoryConfiguration(ctx: TraceContext, user: User, contextURLOrContext: string | CommitContext): Promise<string | undefined> {
+        const { fileProvider, commitContext } = await this.getRepositoryFileProviderAndCommitContext(ctx, user, contextURLOrContext);
+        const cache: { [path: string]: Promise<string | undefined> } = {};
+        const readFile = async (path: string) => {
+            if (path in cache) {
+                return await cache[path];
+            }
+            this.requestedPaths.add(path);
+            const content = fileProvider.getFileContent(commitContext, user, path);
+            cache[path] = content;
+            return await content;
+        }
+        // eagerly fetch for all files that the inferrer usually asks for.
+        this.requestedPaths.forEach(path => !(path in cache) && readFile(path));
+        const config: WorkspaceConfig = await new ConfigInferrer().getConfig({
+            config: {},
+            read: readFile,
+            exists: async (path: string) => !!(await readFile(path)),
+        });
+        if (!config.tasks) {
+            return;
+        }
+        const configString = `tasks:\n  - ${config.tasks.map(task => Object.entries(task).map(([phase, command]) => `${phase}: ${command}`).join('\n    ')).join('\n  - ')}`;
+        return configString;
+    }
+
+    async fetchRepositoryConfiguration(ctx: TraceContext, user: User, contextURL: string): Promise<string | undefined> {
+        const { fileProvider, commitContext } = await this.getRepositoryFileProviderAndCommitContext(ctx, user, contextURL);
+        const configString = await fileProvider.getGitpodFileContent(commitContext, user);
+        return configString;
+    }
+
+
+    protected async getRepositoryFileProviderAndCommitContext(ctx: TraceContext, user: User, contextURLOrContext: string | CommitContext): Promise<{fileProvider: FileProvider, commitContext: CommitContext}> {
+        let commitContext: CommitContext;
+        if (typeof contextURLOrContext === 'string') {
+            const normalizedContextUrl = this.contextParser.normalizeContextURL(contextURLOrContext);
+            commitContext = (await this.contextParser.handle(ctx, user, normalizedContextUrl)) as CommitContext;
+        } else {
+            commitContext = contextURLOrContext;
+        }
+        const { host } = commitContext.repository;
+        const hostContext = this.hostContextProvider.get(host);
+        if (!hostContext || !hostContext.services) {
+            throw new Error(`Cannot fetch repository configuration for host: ${host}`);
+        }
+        const fileProvider = hostContext.services.fileProvider;
+        return { fileProvider, commitContext };
+    }
+}

components/server/src/projects/config-inferrer.ts renamed to components/server/src/config/config-inferrer.ts

@@ -17,7 +17,7 @@ import { ConfigProvider } from './workspace/config-provider';
 import { MessageBusIntegration } from './workspace/messagebus-integration';
 import { MessageBusHelper, MessageBusHelperImpl } from '@gitpod/gitpod-messagebus/lib';
 import { IClientDataPrometheusAdapter, ClientDataPrometheusAdapterImpl } from './workspace/client-data-prometheus-adapter';
-import { ConfigInferenceProvider } from './workspace/config-inference-provider';
+import { ConfigurationService } from './config/configuration-service';
 import { IContextParser, IPrefixContextParser } from './workspace/context-parser';
 import { ContextParser } from './workspace/context-parser-service';
 import { SnapshotContextParser } from './workspace/snapshot-context-parser';
@@ -103,7 +103,7 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo
     bind(GitpodFileParser).toSelf().inSingletonScope();
 
     bind(ConfigProvider).toSelf().inSingletonScope();
-    bind(ConfigInferenceProvider).toSelf().inSingletonScope();
+    bind(ConfigurationService).toSelf().inSingletonScope();
 
     bind(WorkspaceFactory).toSelf().inSingletonScope();
     bind(WorkspaceDeletionService).toSelf().inSingletonScope();

components/server/src/config/configuration-service.ts

@@ -6,13 +6,10 @@
 
 import { inject, injectable } from "inversify";
 import { DBWithTracing, ProjectDB, TeamDB, TracedWorkspaceDB, UserDB, WorkspaceDB } from "@gitpod/gitpod-db/lib";
-import { Branch, CommitContext, PrebuildWithStatus, CreateProjectParams, FindPrebuildsParams, Project, User, WorkspaceConfig } from "@gitpod/gitpod-protocol";
-import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
+import { Branch, PrebuildWithStatus, CreateProjectParams, FindPrebuildsParams, Project, User } from "@gitpod/gitpod-protocol";
 import { HostContextProvider } from "../auth/host-context-provider";
-import { FileProvider, RepoURL } from "../repohost";
+import { RepoURL } from "../repohost";
 import { log } from '@gitpod/gitpod-protocol/lib/util/logging';
-import { ContextParser } from "../workspace/context-parser-service";
-import { ConfigInferrer } from "./config-inferrer";
 import { PartialProject } from "@gitpod/gitpod-protocol/src/teams-projects-protocol";
 
 @injectable()
@@ -23,7 +20,6 @@ export class ProjectsService {
     @inject(UserDB) protected readonly userDB: UserDB;
     @inject(TracedWorkspaceDB) protected readonly workspaceDb: DBWithTracing<WorkspaceDB>;
     @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
-    @inject(ContextParser) protected contextParser: ContextParser;
 
     async getProject(projectId: string): Promise<Project | undefined> {
         return this.projectDB.findProjectById(projectId);
@@ -179,53 +175,6 @@ export class ProjectsService {
         return result;
     }
 
-    protected async getRepositoryFileProviderAndCommitContext(ctx: TraceContext, user: User, cloneUrl: string): Promise<{fileProvider: FileProvider, commitContext: CommitContext}> {
-        const normalizedContextUrl = this.contextParser.normalizeContextURL(cloneUrl);
-        const commitContext = (await this.contextParser.handle(ctx, user, normalizedContextUrl)) as CommitContext;
-        const { host } = commitContext.repository;
-        const hostContext = this.hostContextProvider.get(host);
-        if (!hostContext || !hostContext.services) {
-            throw new Error(`Cannot fetch repository configuration for host: ${host}`);
-        }
-        const fileProvider = hostContext.services.fileProvider;
-        return { fileProvider, commitContext };
-    }
-
-    async fetchRepositoryConfiguration(ctx: TraceContext, user: User, cloneUrl: string): Promise<string | undefined> {
-        const { fileProvider, commitContext } = await this.getRepositoryFileProviderAndCommitContext(ctx, user, cloneUrl);
-        const configString = await fileProvider.getGitpodFileContent(commitContext, user);
-        return configString;
-    }
-
-    // a static cache used to prefetch inferrer related files in parallel in advance
-    private requestedPaths = new Set<string>();
-
-    async guessRepositoryConfiguration(ctx: TraceContext, user: User, cloneUrl: string): Promise<string | undefined> {
-        const { fileProvider, commitContext } = await this.getRepositoryFileProviderAndCommitContext(ctx, user, cloneUrl);
-        const cache: { [path: string]: Promise<string | undefined> } = {};
-        const readFile = async (path: string) => {
-            if (path in cache) {
-                return await cache[path];
-            }
-            this.requestedPaths.add(path);
-            const content = fileProvider.getFileContent(commitContext, user, path);
-            cache[path] = content;
-            return await content;
-        }
-        // eagerly fetch for all files that the inferrer usually asks for.
-        this.requestedPaths.forEach(path => !(path in cache) && readFile(path));
-        const config: WorkspaceConfig = await new ConfigInferrer().getConfig({
-            config: {},
-            read: readFile,
-            exists: async (path: string) => !!(await readFile(path)),
-        });
-        if (!config.tasks) {
-            return;
-        }
-        const configString = `tasks:\n  - ${config.tasks.map(task => Object.entries(task).map(([phase, command]) => `${phase}: ${command}`).join('\n    ')).join('\n  - ')}`;
-        return configString;
-    }
-
     async updateProjectPartial(partialProject: PartialProject): Promise<void> {
         return this.projectDB.updateProject(partialProject);
     }