[prebuild] Support opening a specfic prebuild #13706

csweichel · 2022-10-10T10:21:04Z

Description

This PR enables users to open a specific prebuildm, and integrates this capability on the dashboard.

How to test

Make sure there's a prebuild and a newer commit on the same branch
Go the prebuild view
Open the specific prebuild and observe it's the correct state

Release Notes

[prebuild] Add support for opening specific prebuilds

Documentation

Werft options:

/werft with-local-preview
If enabled this will build install/preview
/werft with-preview
/werft with-integration-tests=all
Valid options are all, workspace, webapp, ide

werft-gitpod-dev-com · 2022-10-10T10:21:11Z

started the job as gitpod-build-cw-open-prebuild.3 because the annotations in the pull request description changed
(with .werft/ from main)

csweichel · 2022-10-10T11:36:42Z

/werft run

👍 started the job as gitpod-build-cw-open-prebuild.5
(with .werft/ from main)

werft-gitpod-dev-com · 2022-10-10T11:49:55Z

started the job as gitpod-build-cw-open-prebuild.6 because the annotations in the pull request description changed
(with .werft/ from main)

csweichel · 2022-10-10T13:53:43Z

/werft run

👍 started the job as gitpod-build-cw-open-prebuild.7
(with .werft/ from main)

jankeromnes · 2022-10-10T19:09:00Z

components/server/src/workspace/open-prebuild-prefix-context-parser.ts

+@injectable()
+export class OpenPrebuildPrefixContextParser implements IPrefixContextParser {
+    @inject(Config) protected readonly config: Config;
+    static PREFIX = /^\/?open-prebuild\/([^\/]*)\//;


Wow, many thanks @csweichel for implementing a new context URL prefix for this!

However, I'm curious why a new prefix is more beneficial than "just" pointing a Prebuild view's "New Workspace" button to the (already-supported) fully-qualified commit context URL -- if you open the exact commit that was used to create the prebuild, you're guaranteed to get this prebuild, right? 💭

If you open the exact commit that was used to create the prebuild, you're guaranteed to get this prebuild, right?

Aye. Two reasons not to build it this way:

I did not see a clean way to construct the commit context URL for all SCM provider

It relies on the behaviour that we do actually open the prebuild for that commit given the correct context URL. Given the reliability of this feature I wanted to make this rock solid and identify the prebuild directly.

Another question would be: why use a prefix context parser rather than a regular context parser. This also has a couple of reasons:

regular context parser are tied to the SCM system, i.e. assume they're part of the SCM inversify container. A PrebuildContextParser would break this assumption.

permission checks can only happen in the server - if we wanted this to be a context parser, we'd need to make the permission checks part of that flow. Using a prefix context parser we can just rely on the permission checks already present in the SCM context parsing flow. This is an indicator to me that the current authorisation model has deficits we need to fix.

Thanks! Makes sense. (I guess to achieve the commit context URL trick, we'd need to always store the commit's treeURL in our metadata. But I'm happy to go with your approach that identifies prebuilds directly. 👍)

jankeromnes · 2022-10-11T12:30:53Z

Note: I'll give this PR a quick rebase, in the hopes of getting it to build. 🤞

jankeromnes · 2022-10-11T12:44:11Z

Insert coin to try again 🎰

/werft run

👍 started the job as gitpod-build-cw-open-prebuild.9
(with .werft/ from main)

jankeromnes · 2022-10-11T12:53:10Z

And again

/werft run

👍 started the job as gitpod-build-cw-open-prebuild.10
(with .werft/ from main)

csweichel · 2022-10-11T12:54:41Z

@jankeromnes this might need a clean slate 🍽️ 😄

jankeromnes · 2022-10-11T13:00:13Z

Indeed:

/werft run with-clean-slate-deployment

👍 started the job as gitpod-build-cw-open-prebuild.11
(with .werft/ from main)

jankeromnes · 2022-10-11T13:08:28Z

I guess that luck is permanently stuck. Maybe let's move this work to a different branch. Happy to do this now. 🚚

jankeromnes · 2022-10-11T13:42:29Z

components/dashboard/src/projects/Prebuild.tsx

-                            href={gitpodHostUrl.withContext(`${prebuild?.info.changeUrl}`).toString()}
+                            href={gitpodHostUrl
+                                .withContext(`open-prebuild/${prebuild?.info.id}/${prebuild?.info.changeUrl}`)
+                                .toString()}
                        >
                            <button>New Workspace ({prebuild?.info.branch})</button>


I guess the (branch) part of the button label no longer makes sense when we're opening the prebuild.

Maybe let's remove it?

Suggested change

<button>New Workspace ({prebuild?.info.branch})</button>

<button>New Workspace</button>

Or clarify it?

Suggested change

<button>New Workspace ({prebuild?.info.branch})</button>

<button>New Workspace With This Prebuild</button>

jankeromnes · 2022-10-11T13:45:38Z

Okay, I've tested this (over in #13768), but it doesn't see to do what I expected:

Added a repository as a new Project
Created a branch with a new "commit A" (and waited for the prebuild to be finished successfully)
Added a second "commit B" on top, in the same branch (also waited for successful prebuild)
When I navigate to "Prebuilds", I see two successful commits on my branch 👍
However, whichever I choose to open, I also seem to get the latest prebuild (with "commit B")

But, clicking on "New Workspace" in the prebuild of "commit A" should give me a workspace based on "commit A", right?

csweichel · 2022-10-13T08:22:53Z

Let's move the conversation over to #13768. Will pick it up from there.

roboquat added do-not-merge/work-in-progress release-note labels Oct 10, 2022

roboquat added the size/M label Oct 10, 2022

csweichel force-pushed the cw/open-prebuild branch from 22044b9 to 5ccb4b1 Compare October 10, 2022 10:21

jankeromnes reviewed Oct 10, 2022

View reviewed changes

[prebuild] Support opening a specfic prebuild

a2712f0

jankeromnes force-pushed the cw/open-prebuild branch from 5ccb4b1 to a2712f0 Compare October 11, 2022 12:34

jankeromnes mentioned this pull request Oct 11, 2022

[prebuild] Support opening a specfic prebuild #13768

Merged

3 tasks

jankeromnes reviewed Oct 11, 2022

View reviewed changes

jankeromnes mentioned this pull request Oct 12, 2022

Epic: Improve workspace starts with prebuilds on busy repos #13754

Closed

3 tasks

csweichel closed this Oct 13, 2022

jankeromnes deleted the cw/open-prebuild branch December 8, 2022 16:45

	<button>New Workspace ({prebuild?.info.branch})</button>
	<button>New Workspace</button>

	<button>New Workspace ({prebuild?.info.branch})</button>
	<button>New Workspace With This Prebuild</button>

[prebuild] Support opening a specfic prebuild #13706

[prebuild] Support opening a specfic prebuild #13706

Uh oh!

Conversation

csweichel commented Oct 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How to test

Release Notes

Documentation

Werft options:

Uh oh!

werft-gitpod-dev-com bot commented Oct 10, 2022

Uh oh!

csweichel commented Oct 10, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

werft-gitpod-dev-com bot commented Oct 10, 2022

Uh oh!

csweichel commented Oct 10, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

csweichel Oct 11, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes Oct 11, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

csweichel commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes Oct 11, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes commented Oct 11, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

csweichel commented Oct 13, 2022

Uh oh!

Uh oh!

csweichel commented Oct 10, 2022 •

edited

Loading

csweichel commented Oct 10, 2022 •

edited by werft-gitpod-dev-com bot

Loading

csweichel commented Oct 10, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading

csweichel commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Oct 11, 2022 •

edited by werft-gitpod-dev-com bot

Loading