[prebuilds] changed prebuild semantics

- no more incremental prebuilds - always incremental workspace - never wait for running prebuilds
gitpod-io · Oct 5, 2023 · 63c3c6d · 63c3c6d
1 parent f111f23
commit 63c3c6d
Show file tree

Hide file tree

Showing 24 changed files with 318 additions and 726 deletions.
diff --git a/components/dashboard/src/admin/ProjectDetail.tsx b/components/dashboard/src/admin/ProjectDetail.tsx
@@ -45,9 +45,6 @@ export default function ProjectDetail(props: { project: Project; owner: string |
                     </Property>
                 </div>
                 <div className="flex w-full mt-6">
-                    <Property name="Incremental Prebuilds">
-                        {props.project.settings?.useIncrementalPrebuilds ? "Yes" : "No"}
-                    </Property>
                     <Property name="Marked Deleted">{props.project.markedDeleted ? "Yes" : "No"}</Property>
                 </div>
             </div>

diff --git a/components/dashboard/src/projects/ProjectSettings.tsx b/components/dashboard/src/projects/ProjectSettings.tsx
@@ -9,7 +9,6 @@ import { useCallback, useContext, useState, Fragment, useMemo, useEffect } from
 import { useHistory } from "react-router";
 import { CheckboxInputField } from "../components/forms/CheckboxInputField";
 import { PageWithSubMenu } from "../components/PageWithSubMenu";
-import PillLabel from "../components/PillLabel";
 import { getGitpodService } from "../service/service";
 import { ProjectContext, useCurrentProject } from "./project-context";
 import { getProjectSettingsMenu, getProjectTabs } from "./projects.routes";
@@ -113,6 +112,7 @@ export default function ProjectSettingsView() {
 
             await updateProjectSettings({
                 prebuilds: {
+                    ...project.settings?.prebuilds,
                     enable: value,
                 },
             });
@@ -237,13 +237,12 @@ export default function ProjectSettingsView() {
                     label="Enable prebuilds"
                     hint={
                         <span>
-                            {prebuildSettings.enable ? (
-                                <Fragment>
-                                    Prebuilds will run for any <code>before</code> or <code>init</code> tasks.
-                                </Fragment>
-                            ) : (
-                                "Requires permissions to configure repository webhooks."
-                            )}{" "}
+                            <Fragment>
+                                Prebuilds reduce wait time for new workspaces.
+                                {!prebuildSettings.enable
+                                    ? " Enabling requires permissions to configure repository webhooks."
+                                    : ""}
+                            </Fragment>{" "}
                             <a
                                 className="gp-link"
                                 target="_blank"
@@ -259,17 +258,51 @@ export default function ProjectSettingsView() {
                 />
                 {prebuildSettings.enable && (
                     <>
-                        <SelectInputField
-                            disabled={!prebuildSettings.enable}
-                            label="Build branches"
-                            value={prebuildSettings.branchStrategy || ""}
-                            containerClassName="max-w-md ml-6 text-sm"
-                            onChange={(val) => setPrebuildBranchStrategy(val as PrebuildSettings.BranchStrategy)}
-                        >
-                            <option value="default-branch">Default branch</option>
-                            <option value="all-branches">All branches</option>
-                            <option value="matched-branches">Matched by pattern</option>
-                        </SelectInputField>
+                        <div className="flex mt-4 max-w-2xl">
+                            <div className="flex flex-col ml-6">
+                                <label
+                                    htmlFor="prebuildInterval"
+                                    className={classNames(
+                                        "text-sm font-semibold cursor-pointer tracking-wide",
+                                        !prebuildSettings.enable
+                                            ? "text-gray-400 dark:text-gray-400"
+                                            : "text-gray-600 dark:text-gray-100",
+                                    )}
+                                >
+                                    Commit Interval
+                                </label>
+                                <input
+                                    type="number"
+                                    id="prebuildInterval"
+                                    min="0"
+                                    max="100"
+                                    step="5"
+                                    className="mt-2"
+                                    disabled={!prebuildSettings.enable}
+                                    value={prebuildSettings.prebuildInterval}
+                                    onChange={({ target }) => setPrebuildInterval(target.value)}
+                                />
+                                <div className="text-gray-500 dark:text-gray-400 text-sm mt-2">
+                                    The number of commits to be skipped between prebuild runs.
+                                </div>
+                            </div>
+                        </div>
+                        <div>
+                            <SelectInputField
+                                disabled={!prebuildSettings.enable}
+                                label="Branch Filter"
+                                value={prebuildSettings.branchStrategy || ""}
+                                containerClassName="max-w-md ml-6 text-sm"
+                                onChange={(val) => setPrebuildBranchStrategy(val as PrebuildSettings.BranchStrategy)}
+                            >
+                                <option value="all-branches">All branches</option>
+                                <option value="default-branch">Default branch</option>
+                                <option value="matched-branches">Match branches by pattern</option>
+                            </SelectInputField>
+                            <div className="ml-6 text-gray-500 dark:text-gray-400 text-sm mt-2">
+                                Run prebuilds on the selected branches only.
+                            </div>
+                        </div>
                         {prebuildSettings.branchStrategy === "matched-branches" && (
                             <div className="flex flex-col ml-6 mt-4">
                                 <label
@@ -298,94 +331,18 @@ export default function ProjectSettingsView() {
                         )}
                         <InputField
                             className="max-w-md ml-6 text-sm"
-                            label="Workspace machine type"
+                            label="Machine type"
                             disabled={!prebuildSettings.enable}
                         >
                             <SelectWorkspaceClassComponent
                                 disabled={!prebuildSettings.enable}
                                 selectedWorkspaceClass={prebuildSettings.workspaceClass}
                                 onSelectionChange={setWorkspaceClassForPrebuild}
                             />
-                        </InputField>
-                        <CheckboxInputField
-                            label="Enable Incremental Prebuilds"
-                            hint={
-                                <span>
-                                    When possible, use an earlier successful prebuild as a base to create new prebuilds.
-                                    This can make your prebuilds significantly faster, especially if they normally take
-                                    longer than 10 minutes.{" "}
-                                    <a
-                                        className="gp-link"
-                                        target="_blank"
-                                        rel="noreferrer"
-                                        href="https://www.gitpod.io/changelog/faster-incremental-prebuilds"
-                                    >
-                                        Learn more
-                                    </a>
-                                </span>
-                            }
-                            disabled={!prebuildSettings.enable}
-                            checked={project.settings?.useIncrementalPrebuilds ?? false}
-                            onChange={(checked) => updateProjectSettings({ useIncrementalPrebuilds: checked })}
-                        />
-                        <CheckboxInputField
-                            label="Cancel Prebuilds on Outdated Commits"
-                            hint="Cancel pending or running prebuilds on the same branch when new commits are pushed."
-                            disabled={!prebuildSettings.enable}
-                            checked={!project.settings?.keepOutdatedPrebuildsRunning}
-                            onChange={(checked) => updateProjectSettings({ keepOutdatedPrebuildsRunning: !checked })}
-                        />
-                        <CheckboxInputField
-                            label={
-                                <span>
-                                    Use Last Successful Prebuild{" "}
-                                    <PillLabel type="warn" className="font-semibold mt-2 ml-2 py-0.5 px-2 self-center">
-                                        Alpha
-                                    </PillLabel>
-                                </span>
-                            }
-                            hint="Skip waiting for prebuilds in progress and use the last successful prebuild from previous
-                    commits on the same branch."
-                            disabled={!prebuildSettings.enable}
-                            checked={!!project.settings?.allowUsingPreviousPrebuilds}
-                            onChange={(checked) =>
-                                updateProjectSettings({
-                                    allowUsingPreviousPrebuilds: checked,
-                                    // we are disabling prebuild cancellation when incremental workspaces are enabled
-                                    keepOutdatedPrebuildsRunning:
-                                        checked || project?.settings?.keepOutdatedPrebuildsRunning,
-                                })
-                            }
-                        />
-                        <div className="flex mt-4 max-w-2xl">
-                            <div className="flex flex-col ml-6">
-                                <label
-                                    htmlFor="prebuildInterval"
-                                    className={classNames(
-                                        "text-sm font-semibold cursor-pointer tracking-wide",
-                                        !prebuildSettings.enable
-                                            ? "text-gray-400 dark:text-gray-400"
-                                            : "text-gray-600 dark:text-gray-100",
-                                    )}
-                                >
-                                    Prebuild interval
-                                </label>
-                                <input
-                                    type="number"
-                                    id="prebuildInterval"
-                                    min="0"
-                                    max="100"
-                                    step="5"
-                                    className="mt-2"
-                                    disabled={!prebuildSettings.enable}
-                                    value={prebuildSettings.prebuildInterval}
-                                    onChange={({ target }) => setPrebuildInterval(target.value)}
-                                />
-                                <div className="text-gray-500 dark:text-gray-400 text-sm mt-2">
-                                    The number of commits to be skipped between prebuild runs.
-                                </div>
+                            <div className="text-gray-500 dark:text-gray-400 text-sm mt-2">
+                                Use a smaller machine type for cost optimization.
                             </div>
-                        </div>
+                        </InputField>
                     </>
                 )}
                 <div>

diff --git a/components/dashboard/src/service/public-api.ts b/components/dashboard/src/service/public-api.ts
@@ -107,9 +107,6 @@ export function projectToProtocol(project: Project): ProtocolProject {
         teamId: project.teamId,
         appInstallationId: "undefined",
         settings: {
-            allowUsingPreviousPrebuilds: project.settings?.prebuild?.usePreviousPrebuilds,
-            keepOutdatedPrebuildsRunning: project.settings?.prebuild?.keepOutdatedPrebuildsRunning,
-            useIncrementalPrebuilds: project.settings?.prebuild?.enableIncrementalPrebuilds,
             workspaceClasses: {
                 regular: project.settings?.workspace?.workspaceClass?.regular || "",
             },

diff --git a/components/dashboard/src/workspaces/CreateWorkspacePage.tsx b/components/dashboard/src/workspaces/CreateWorkspacePage.tsx
@@ -172,7 +172,6 @@ export function CreateWorkspacePage() {
 
             // we already have shown running workspaces to the user
             opts.ignoreRunningWorkspaceOnSameCommit = true;
-            opts.ignoreRunningPrebuild = true;
 
             // if user received an INVALID_GITPOD_YML yml for their contextURL they can choose to proceed using default configuration
             if (workspaceContext.error?.code === ErrorCodes.INVALID_GITPOD_YML) {

diff --git a/components/gitpod-protocol/go/gitpod-service.go b/components/gitpod-protocol/go/gitpod-service.go
@@ -1678,19 +1678,9 @@ type Repository struct {
 
 // WorkspaceCreationResult is the WorkspaceCreationResult message type
 type WorkspaceCreationResult struct {
-	CreatedWorkspaceID         string                    `json:"createdWorkspaceId,omitempty"`
-	ExistingWorkspaces         []*WorkspaceInfo          `json:"existingWorkspaces,omitempty"`
-	RunningPrebuildWorkspaceID string                    `json:"runningPrebuildWorkspaceID,omitempty"`
-	RunningWorkspacePrebuild   *RunningWorkspacePrebuild `json:"runningWorkspacePrebuild,omitempty"`
-	WorkspaceURL               string                    `json:"workspaceURL,omitempty"`
-}
-
-// RunningWorkspacePrebuild is the RunningWorkspacePrebuild message type
-type RunningWorkspacePrebuild struct {
-	PrebuildID  string `json:"prebuildID,omitempty"`
-	SameCluster bool   `json:"sameCluster,omitempty"`
-	Starting    string `json:"starting,omitempty"`
-	WorkspaceID string `json:"workspaceID,omitempty"`
+	CreatedWorkspaceID string           `json:"createdWorkspaceId,omitempty"`
+	ExistingWorkspaces []*WorkspaceInfo `json:"existingWorkspaces,omitempty"`
+	WorkspaceURL       string           `json:"workspaceURL,omitempty"`
 }
 
 // Workspace is the Workspace message type
@@ -2027,8 +2017,6 @@ type CreateWorkspaceOptions struct {
 	ContextURL                         string `json:"contextUrl,omitempty"`
 	OrganizationId                     string `json:"organizationId,omitempty"`
 	IgnoreRunningWorkspaceOnSameCommit bool   `json:"ignoreRunningWorkspaceOnSameCommit,omitemopty"`
-	IgnoreRunningPrebuild              bool   `json:"ignoreRunningPrebuild,omitemopty"`
-	AllowUsingPreviousPrebuilds        bool   `json:"allowUsingPreviousPrebuilds,omitemopty"`
 	ForceDefaultConfig                 bool   `json:"forceDefaultConfig,omitemopty"`
 }
 
@@ -2291,12 +2279,9 @@ type Project struct {
 }
 
 type ProjectSettings struct {
-	UseIncrementalPrebuilds      bool                      `json:"useIncrementalPrebuilds,omitempty"`
-	UsePersistentVolumeClaim     bool                      `json:"usePersistentVolumeClaim,omitempty"`
-	KeepOutdatedPrebuildsRunning bool                      `json:"keepOutdatedPrebuildsRunning,omitempty"`
-	AllowUsingPreviousPrebuilds  bool                      `json:"allowUsingPreviousPrebuilds,omitempty"`
-	WorkspaceClasses             *WorkspaceClassesSettings `json:"workspaceClasses,omitempty"`
-	PrebuildSettings             *PrebuildSettings         `json:"prebuilds,omitempty"`
+	UsePersistentVolumeClaim bool                      `json:"usePersistentVolumeClaim,omitempty"`
+	WorkspaceClasses         *WorkspaceClassesSettings `json:"workspaceClasses,omitempty"`
+	PrebuildSettings         *PrebuildSettings         `json:"prebuilds,omitempty"`
 }
 type PrebuildSettings struct {
 	Enable                *bool   `json:"enable,omitempty"`

diff --git a/components/gitpod-protocol/src/gitpod-service.ts b/components/gitpod-protocol/src/gitpod-service.ts
@@ -424,8 +424,6 @@ export namespace GitpodServer {
         // whether running workspaces on the same context should be ignored. If false (default) users will be asked.
         //TODO(se) remove this option and let clients do that check if they like. The new create workspace page does it already
         ignoreRunningWorkspaceOnSameCommit?: boolean;
-        ignoreRunningPrebuild?: boolean;
-        allowUsingPreviousPrebuilds?: boolean;
         forceDefaultConfig?: boolean;
     }
 

diff --git a/components/gitpod-protocol/src/protocol.ts b/components/gitpod-protocol/src/protocol.ts
@@ -1500,16 +1500,7 @@ export interface WorkspaceCreationResult {
     createdWorkspaceId?: string;
     workspaceURL?: string;
     existingWorkspaces?: WorkspaceInfo[];
-    runningWorkspacePrebuild?: {
-        prebuildID: string;
-        workspaceID: string;
-        instanceID: string;
-        starting: RunningWorkspacePrebuildStarting;
-        sameCluster: boolean;
-    };
-    runningPrebuildWorkspaceID?: string;
 }
-export type RunningWorkspacePrebuildStarting = "queued" | "starting" | "running";
 
 export namespace WorkspaceCreationResult {
     export function is(data: any): data is WorkspaceCreationResult {

diff --git a/components/gitpod-protocol/src/teams-projects-protocol.ts b/components/gitpod-protocol/src/teams-projects-protocol.ts
@@ -36,17 +36,28 @@ export interface ProjectSettings {
      * @deprecated see `Project.settings.prebuilds.branchMatchingPattern` instead.
      */
     prebuildBranchPattern?: string;
-
-    useIncrementalPrebuilds?: boolean;
-    keepOutdatedPrebuildsRunning?: boolean;
-    // whether new workspaces can start on older prebuilds and incrementally update
-    allowUsingPreviousPrebuilds?: boolean;
     /**
      * how many commits in the commit history a prebuild is good (undefined and 0 means every commit is prebuilt)
      *
      * @deprecated see `Project.settings.prebuilds.intervall` instead.
      */
     prebuildEveryNthCommit?: number;
+
+    /**
+     * @deprecated always false
+     */
+    useIncrementalPrebuilds?: boolean;
+
+    /**
+     * @deprecated always true (we should kill dangling prebuilds)
+     */
+    keepOutdatedPrebuildsRunning?: boolean;
+    // whether new workspaces can start on older prebuilds and incrementally update
+    /**
+     * @deprecated always true
+     */
+    allowUsingPreviousPrebuilds?: boolean;
+
     // preferred workspace classes
     workspaceClasses?: WorkspaceClasses;
 }
@@ -58,7 +69,7 @@ export interface PrebuildSettings {
     enable?: boolean;
 
     /**
-     * Defines an interval of commits to run new prebuilds for. Defaults to 10
+     * Defines an interval of commits to run new prebuilds for. Defaults to 20
      */
     prebuildInterval?: number;
 
@@ -113,7 +124,7 @@ export namespace Project {
     export const PREBUILD_SETTINGS_DEFAULTS: PrebuildSettingsWithDefaults = {
         enable: false,
         branchMatchingPattern: "**",
-        prebuildInterval: 10,
+        prebuildInterval: 20,
         branchStrategy: "all-branches",
     };
 

diff --git a/components/public-api-server/pkg/apiv1/project.go b/components/public-api-server/pkg/apiv1/project.go
@@ -168,14 +168,9 @@ func projectSettingsToAPIResponse(s *protocol.ProjectSettings) *v1.ProjectSettin
 	}
 
 	settings := &v1.ProjectSettings{
-		Prebuild: &v1.PrebuildSettings{
-			EnableIncrementalPrebuilds:   s.UseIncrementalPrebuilds,
-			KeepOutdatedPrebuildsRunning: s.KeepOutdatedPrebuildsRunning,
-			UsePreviousPrebuilds:         s.AllowUsingPreviousPrebuilds,
-		},
+		Prebuild: &v1.PrebuildSettings{},
 		Workspace: &v1.WorkspaceSettings{
-			EnablePersistentVolumeClaim: s.UsePersistentVolumeClaim,
-			WorkspaceClass:              workspaceClassesToAPIResponse(s.WorkspaceClasses),
+			WorkspaceClass: workspaceClassesToAPIResponse(s.WorkspaceClasses),
 		},
 	}
 	if s.PrebuildSettings != nil {

diff --git a/components/public-api-server/pkg/apiv1/project_test.go b/components/public-api-server/pkg/apiv1/project_test.go
@@ -336,10 +336,7 @@ func newProject(p *protocol.Project) *protocol.Project {
 		CloneURL:          "https://github.com/easyCZ/foobar",
 		AppInstallationID: "1337",
 		Settings: &protocol.ProjectSettings{
-			UseIncrementalPrebuilds:      true,
-			UsePersistentVolumeClaim:     true,
-			KeepOutdatedPrebuildsRunning: true,
-			AllowUsingPreviousPrebuilds:  true,
+			UsePersistentVolumeClaim: true,
 			WorkspaceClasses: &protocol.WorkspaceClassesSettings{
 				Regular:  "default",
 				Prebuild: "default",