Set ratelimited prebuild to aborted

Author: easyCZ

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

@@ -8,8 +8,6 @@ import { DBWithTracing, TracedWorkspaceDB, WorkspaceDB } from '@gitpod/gitpod-db
 import { CommitContext, Project, ProjectEnvVar, StartPrebuildContext, StartPrebuildResult, TaskConfig, User, WorkspaceConfig, WorkspaceInstance } from '@gitpod/gitpod-protocol';
 import { log } from '@gitpod/gitpod-protocol/lib/util/logging';
 import { TraceContext } from '@gitpod/gitpod-protocol/lib/util/tracing';
-import { inject, injectable } from 'inversify';
-import { URL } from 'url';
 import { HostContextProvider } from '../../../src/auth/host-context-provider';
 import { WorkspaceFactory } from '../../../src/workspace/workspace-factory';
 import { ConfigProvider } from '../../../src/workspace/config-provider';
@@ -18,6 +16,10 @@ import { Config } from '../../../src/config';
 import { ProjectsService } from '../../../src/projects/projects-service';
 import { secondsBefore } from '@gitpod/gitpod-protocol/lib/util/timeutil';
 
+import { inject, injectable } from 'inversify';
+import * as opentracing from 'opentracing';
+import { URL } from 'url';
+
 export class WorkspaceRunningError extends Error {
     constructor(msg: string, public instance: WorkspaceInstance) {
         super(msg);
@@ -116,33 +118,32 @@ export class PrebuildManager {
                 prebuildContext.commitHistory = await contextParser.fetchCommitHistory({ span }, user, contextURL, commit, maxDepth);
             }
 
-            const now = new Date()
-            const runningCount = await this.workspaceDB.trace({span}).countUnabortedPrebuildsSince(cloneURL, new Date(secondsBefore(now.toISOString(), 300)))
-            log.info("Created prebuild context with running count", prebuildContext, runningCount);
-            if (runningCount > 10) {
-                log.info("Would rate limit prebuild for ", cloneURL)
-                await this.workspaceFactory.createAbortedWorkspace({span}, user, prebuildContext, contextURL)
-                const id = await this.generateWorkspaceID(context);
-
-                await this.db.trace({span}).store(newWs);
 
-            }
 
             const projectEnvVarsPromise = project ? this.projectService.getProjectEnvironmentVariables(project.id) : [];
             const workspace = await this.workspaceFactory.createForContext({span}, user, prebuildContext, contextURL);
-            const prebuildPromise = this.workspaceDB.trace({span}).findPrebuildByWorkspaceID(workspace.id)!;
+            const prebuild = await this.workspaceDB.trace({span}).findPrebuildByWorkspaceID(workspace.id)!;
+            if (!prebuild) {
+                throw new Error(`Failed to create a prebuild for: ${contextURL}`);
+            }
 
-            // const canBuildNow = await this.prebuildRateLimiter.canBuildNow({ span }, user, cloneURL);
-            // if (!canBuildNow) {
-            //     // we cannot start building now because the rate limiter prevents it.
-            //     span.setTag("starting", false);
-            //     return { wsid: workspace.id, done: false };;
-            // }
+            if (await this.shouldRateLimitPrebuild(span, cloneURL)) {
+                prebuild.state = "aborted";
+                prebuild.error = "Prebuild is rate limited. Please contact Gitpod if you believe this happened in error.";
+
+                await this.workspaceDB.trace({ span }).storePrebuiltWorkspace(prebuild)
+                span.setTag("starting", false);
+                span.setTag("ratelimited", true)
+                return {
+                    wsid: workspace.id,
+                    prebuildId: prebuild.id,
+                    done: false,
+                }
+            }
 
             span.setTag("starting", true);
             const projectEnvVars = await projectEnvVarsPromise;
             await this.workspaceStarter.startWorkspace({ span }, workspace, user, [], projectEnvVars, {excludeFeatureFlags: ['full_workspace_backup']});
-            const prebuild = await prebuildPromise;
             if (!prebuild) {
                 throw new Error(`Failed to create a prebuild for: ${contextURL}`);
             }
@@ -241,4 +242,10 @@ export class PrebuildManager {
         }
         return hostContext.contextParser;
     }
+
+    private async shouldRateLimitPrebuild(span: opentracing.Span, cloneURL: string): Promise<boolean> {
+        const now = new Date()
+        const runningCount = await this.workspaceDB.trace({span}).countUnabortedPrebuildsSince(cloneURL, new Date(secondsBefore(now.toISOString(), 300)))
+        return runningCount > 10
+    }
 }

components/server/src/workspace/config-provider.ts

@@ -372,4 +372,4 @@ export namespace InvalidGitpodYMLError {
     export function is(obj: object): obj is InvalidGitpodYMLError {
         return 'errorType' in obj && (obj as any).errorType === "invalidGitpodYML" && 'validationErrors' in obj;
     }
-}
+}

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

@@ -4,9 +4,8 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import * as opentracing from 'opentracing';
 import { DBWithTracing, TracedWorkspaceDB, WorkspaceDB, ProjectDB, TeamDB } from '@gitpod/gitpod-db/lib';
-import { AdditionalContentContext, CommitContext, IssueContext, PrebuiltWorkspaceContext, StartPrebuildContext, PullRequestContext, Repository, SnapshotContext, User, Workspace, WorkspaceConfig, WorkspaceContext, WorkspaceProbeContext, WorkspaceType } from '@gitpod/gitpod-protocol';
+import { AdditionalContentContext, CommitContext, IssueContext, PrebuiltWorkspaceContext, PullRequestContext, Repository, SnapshotContext, User, Workspace, WorkspaceConfig, WorkspaceContext, WorkspaceProbeContext } from '@gitpod/gitpod-protocol';
 import { ErrorCodes } from '@gitpod/gitpod-protocol/lib/messaging/error';
 import { generateWorkspaceID } from '@gitpod/gitpod-protocol/lib/util/generate-workspace-id';
 import { log } from '@gitpod/gitpod-protocol/lib/util/logging';
@@ -135,8 +134,11 @@ export class WorkspaceFactory {
         }
     }
 
-    private async buildWorkspaceFromContext(span: opentracing.Span, ctx: TraceContext, user: User, context: CommitContext, normalizedContextURL: string, workspaceType: WorkspaceType): Promise<Workspace> {
-        // TODO(janx): We potentially fetch the same Project twice in this flow (once here, and once in `configProvider`,
+    protected async createForCommit(ctx: TraceContext, user: User, context: CommitContext, normalizedContextURL: string) {
+        const span = TraceContext.startSpan("createForCommit", ctx);
+
+        try {
+            // TODO(janx): We potentially fetch the same Project twice in this flow (once here, and once in `configProvider`,
             // to parse a potential custom config from the Project DB). It would be cool to fetch the Project only once (and
             // e.g. pass it to `configProvider.fetchConfig` here).
             const [ { config, literalConfig} , project ] = await Promise.all([
@@ -169,9 +171,9 @@ export class WorkspaceFactory {
             }
 
             const id = await this.generateWorkspaceID(context);
-            return {
+            const newWs: Workspace = {
                 id,
-                type: workspaceType,
+                type: "regular",
                 creationTime: new Date().toISOString(),
                 contextURL: normalizedContextURL,
                 projectId,
@@ -181,13 +183,6 @@ export class WorkspaceFactory {
                 imageSource,
                 config
             };
-    }
-
-    protected async createForCommit(ctx: TraceContext, user: User, context: CommitContext, normalizedContextURL: string) {
-        const span = TraceContext.startSpan("createForCommit", ctx);
-
-        try {
-            const newWs = await this.buildWorkspaceFromContext(span, ctx, user, context, normalizedContextURL, "regular")
             await this.db.trace({span}).store(newWs);
             return newWs;
         } catch (e) {
@@ -228,13 +223,4 @@ export class WorkspaceFactory {
         return await generateWorkspaceID();
     }
 
-    public async createAbortedWorkspace(ctx: TraceContext, user: User, context: StartPrebuildContext, normalizedContextURL: string): Promise<Workspace> {
-        const span = TraceContext.startSpan("createForCommit", ctx);
-
-        const newWs = await this.buildWorkspaceFromContext(span, ctx, user, context, normalizedContextURL, "aborted")
-
-        await this.db.trace({span}).store(newWs);
-        return newWs;
-    }
-
 }