[POC] Implement a 'Use Last Successful Prebuild' workspace creation mode

Author: jankeromnes

components/dashboard/src/start/CreateWorkspace.tsx

@@ -269,6 +269,9 @@ export default class CreateWorkspace extends React.Component<CreateWorkspaceProp
             return (
                 <RunningPrebuildView
                     runningPrebuild={result.runningWorkspacePrebuild}
+                    onUseLastSuccessfulPrebuild={() =>
+                        this.createWorkspace(CreateWorkspaceMode.UseLastSuccessfulPrebuild)
+                    }
                     onIgnorePrebuild={() => this.createWorkspace(CreateWorkspaceMode.ForceNew)}
                     onPrebuildSucceeded={() => this.createWorkspace(CreateWorkspaceMode.UsePrebuild)}
                 />
@@ -531,6 +534,7 @@ interface RunningPrebuildViewProps {
         starting: RunningWorkspacePrebuildStarting;
         sameCluster: boolean;
     };
+    onUseLastSuccessfulPrebuild: () => void;
     onIgnorePrebuild: () => void;
     onPrebuildSucceeded: () => void;
 }
@@ -565,6 +569,12 @@ function RunningPrebuildView(props: RunningPrebuildViewProps) {
             {/* TODO(gpl) Copied around in Start-/CreateWorkspace. This should properly go somewhere central. */}
             <div className="h-full mt-6 w-11/12 lg:w-3/5">
                 <PrebuildLogs workspaceId={workspaceId} onIgnorePrebuild={props.onIgnorePrebuild}>
+                    <button
+                        className="secondary"
+                        onClick={() => props.onUseLastSuccessfulPrebuild && props.onUseLastSuccessfulPrebuild()}
+                    >
+                        Use Last Successful Prebuild
+                    </button>
                     <button className="secondary" onClick={() => props.onIgnorePrebuild && props.onIgnorePrebuild()}>
                         Skip Prebuild
                     </button>

components/gitpod-protocol/src/protocol.ts

@@ -1372,6 +1372,8 @@ export enum CreateWorkspaceMode {
     UsePrebuild = "use-prebuild",
     // SelectIfRunning returns a list of currently running workspaces for the context URL if there are any, otherwise falls back to Default mode
     SelectIfRunning = "select-if-running",
+    // UseLastSuccessfulPrebuild returns ...
+    UseLastSuccessfulPrebuild = "use-last-successful-prebuild",
 }
 
 export namespace WorkspaceCreationResult {

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

@@ -47,6 +47,7 @@ import {
     TeamMemberRole,
     WORKSPACE_TIMEOUT_DEFAULT_SHORT,
     PrebuildEvent,
+    StartPrebuildContext,
 } from "@gitpod/gitpod-protocol";
 import { ResponseError } from "vscode-jsonrpc";
 import {
@@ -963,6 +964,58 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
 
             const logCtx: LogContext = { userId: user.id };
             const cloneUrl = context.repository.cloneUrl;
+            if (mode === CreateWorkspaceMode.UseLastSuccessfulPrebuild) {
+                const maxDepth = this.config.incrementalPrebuilds.commitHistory;
+                const hostContext = this.hostContextProvider.get(context.repository.host);
+                const repoProvider = hostContext?.services?.repositoryProvider;
+                if (repoProvider) {
+                    (context as any).commitHistory = await repoProvider.getCommitHistory(
+                        user,
+                        context.repository.owner,
+                        context.repository.name,
+                        context.revision,
+                        maxDepth,
+                    );
+                    log.info("findPrebuiltWorkspace: incremental workspace", {
+                        commitHistory: (context as any).commitHistory,
+                    });
+                    // {"component":"server","severity":"INFO","time":"2022-10-12T12:57:06.447Z","message":"findPrebuiltWorkspace: incremental workspace","payload":{"commitHistory":["95b666410f37b5237bf416feb748fb1e8aab8fd4","ab01b49c669ce41e0fef1cb306b1ba648ff4ea6a","b3d8f3ada8e729a99b334f75b45eacf240350afa","71d1a3cae0121b2fea14a69b97bcdddce44809ac","218dd0667a7eff7ed657f27b570431919cd87be7","feb2d8b057f751ccd13a7aec07ecfd85757cbb09","9270c10e3b1c23f0a65253cd516aae55120550e9","a70117ff7ae75de4de6c922ab9953e299c711046","24c9dcb64f582ae696797dc617b9af1352a6f01a","6f2aff3ebf94cf40a0c96e87bfd00b2917fc7adb","98b4bfb6190a3bb9fb0f513ffc2bce4009177960","35c9687543411e9e1ced865a9fcd69e1003fe3ed","61d913686e3f5ac17bcd490774097dc6302c92bf","f93921910f80c085fafc5157f6d6b7205b19a4fa"]}}
+
+                    // Note: This query returns only not-garbage-collected prebuilds in order to reduce cardinality
+                    // (e.g., at the time of writing, the Gitpod repository has 16K+ prebuilds, but only ~300 not-garbage-collected)
+                    const recentPrebuilds = await this.workspaceDb
+                        .trace(ctx)
+                        .findPrebuildsWithWorkpace(context.repository.cloneUrl);
+
+                    const { config } = await this.workspaceFactory.configProvider.fetchConfig(ctx, user, context);
+                    const imageSource = await this.workspaceFactory.imageSourceProvider.getImageSource(
+                        ctx,
+                        user,
+                        context,
+                        config,
+                    );
+
+                    for (const recentPrebuild of recentPrebuilds) {
+                        if (
+                            !(await this.workspaceFactory.isGoodBaseforIncrementalPrebuild(
+                                context as any as StartPrebuildContext,
+                                config,
+                                imageSource,
+                                recentPrebuild.prebuild,
+                                recentPrebuild.workspace,
+                            ))
+                        ) {
+                            log.info({ userId: user.id }, "Not using incremental workspace prebuild", {
+                                candidatePrebuild: recentPrebuild.prebuild,
+                            });
+                            continue;
+                        }
+                        log.info({ userId: user.id }, "Using incremental workspace prebuild", {
+                            prebuild: recentPrebuild.prebuild,
+                        });
+                    }
+                }
+            }
             const prebuiltWorkspace = await this.workspaceDb
                 .trace(ctx)
                 .findPrebuiltWorkspaceByCommit(cloneUrl, commitSHAs);

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

@@ -236,27 +236,31 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
         }
     }
 
-    private async isGoodBaseforIncrementalPrebuild(
+    public async isGoodBaseforIncrementalPrebuild(
         context: StartPrebuildContext,
         config: WorkspaceConfig,
         imageSource: WorkspaceImageSource,
         candidatePrebuild: PrebuiltWorkspace,
         candidate: Workspace,
     ): Promise<boolean> {
         if (!context.commitHistory || context.commitHistory.length === 0) {
+            log.info("Disqualified: no commitHistory");
             return false;
         }
         if (!CommitContext.is(candidate.context)) {
+            log.info("Disqualified: candiate context not a commit context");
             return false;
         }
 
         // we are only considering available prebuilds
         if (candidatePrebuild.state !== "available") {
+            log.info("Disqualified: candidate prebuild not available");
             return false;
         }
 
         // we are only considering full prebuilds
         if (!!candidate.basedOnPrebuildId) {
+            log.info("Disqualified: candidate is based on another prebuild");
             return false;
         }
 
@@ -266,10 +270,14 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
             context.additionalRepositoryCommitHistories?.length
         ) {
             // different number of repos
+            log.info(
+                "Disqualified: candidate context additional repository checkout info !== context additional repo histories",
+            );
             return false;
         }
 
         if (!context.commitHistory.some((sha) => sha === candidateCtx.revision)) {
+            log.info("Disqualified: candidate revision not in commit history");
             return false;
         }
 
@@ -279,6 +287,7 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
                 (repo) => repo.cloneUrl === subRepo.repository.cloneUrl,
             );
             if (!matchIngRepo || !matchIngRepo.commitHistory.some((sha) => sha === subRepo.revision)) {
+                log.info("Disqualified: something about matchIngRepo");
                 return false;
             }
         }
@@ -289,6 +298,7 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
                 imageSource,
                 parentImageSource: candidate.imageSource,
             });
+            log.info("Disqualified: image source has changed");
             return false;
         }
 
@@ -309,6 +319,7 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
                 prebuildTasks,
                 parentPrebuildTasks,
             });
+            log.info("Disqualified: prebuild tasks have changed");
             return false;
         }
 

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

@@ -9,13 +9,17 @@ import {
     AdditionalContentContext,
     CommitContext,
     IssueContext,
+    PrebuiltWorkspace,
     PrebuiltWorkspaceContext,
     PullRequestContext,
     Repository,
     SnapshotContext,
+    StartPrebuildContext,
     User,
     Workspace,
+    WorkspaceConfig,
     WorkspaceContext,
+    WorkspaceImageSource,
 } from "@gitpod/gitpod-protocol";
 import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { generateWorkspaceID } from "@gitpod/gitpod-protocol/lib/util/generate-workspace-id";
@@ -32,8 +36,8 @@ export class WorkspaceFactory {
     @inject(TracedWorkspaceDB) protected readonly db: DBWithTracing<WorkspaceDB>;
     @inject(ProjectDB) protected readonly projectDB: ProjectDB;
     @inject(TeamDB) protected readonly teamDB: TeamDB;
-    @inject(ConfigProvider) protected configProvider: ConfigProvider;
-    @inject(ImageSourceProvider) protected imageSourceProvider: ImageSourceProvider;
+    @inject(ConfigProvider) public configProvider: ConfigProvider;
+    @inject(ImageSourceProvider) public imageSourceProvider: ImageSourceProvider;
 
     public async createForContext(
         ctx: TraceContext,
@@ -50,6 +54,16 @@ export class WorkspaceFactory {
         throw new Error("Couldn't create workspace for context");
     }
 
+    public async isGoodBaseforIncrementalPrebuild(
+        context: StartPrebuildContext,
+        config: WorkspaceConfig,
+        imageSource: WorkspaceImageSource,
+        candidatePrebuild: PrebuiltWorkspace,
+        candidate: Workspace,
+    ): Promise<boolean> {
+        throw new Error("Not implemented in this version");
+    }
+
     protected async createForSnapshot(ctx: TraceContext, user: User, context: SnapshotContext): Promise<Workspace> {
         const span = TraceContext.startSpan("createForSnapshot", ctx);