Disable running prebuilds without a project #15026

jankeromnes · 2022-11-29T10:07:40Z

Description

Throw an error when attempting to start a prebuild on a repository without a corresponding project.

Also (reviving #15024) disable the deprecated #prebuild/ context URL prefix, because it doesn't know about projects (and thus ignores any project details, settings, or safeguards).

The supported ways to start a prebuild are:

Creating a Project
Pushing commits to a Project branch
Clicking on a Run Prebuild button in the UI

Related Issue(s)

Fixes #9898 and fixes #4353

How to test

Should build
Using the deprecated #prebuild/ URL prefix should no longer work

Release Notes

Disable running prebuilds without a project + disable the deprecated '#prebuild/' URL prefix

Documentation

Werft options:

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

werft-gitpod-dev-com · 2022-11-29T10:07:48Z

started the job as gitpod-build-jx-remove-prefix.1 because the annotations in the pull request description changed
(with .werft/ from main)

jankeromnes · 2022-11-29T10:39:59Z

/werft run with-clean-slate-deployment cert-issuer=letsencrypt

👍 started the job as gitpod-build-jx-remove-prefix.2
(with .werft/ from main)

jankeromnes · 2022-11-29T13:57:39Z

Okay, this is what using the #prebuild/ URL prefix looks like now (with this PR):

Maybe it could be nicer to actually redirect to some docs page? I wonder if this prefix is still being used. Maybe I should get some data on this. 🔍

EDIT: When looking at how many workspaces are being started with the prebuild/ prefix in their context URL, we see that it's still being used a few times every day:

SELECT substr(creationTime, 1, 10) day, count(id) FROM d_b_workspace where contextUrl like 'prebuild/%' group by day order by day desc;

New question: Why?

jankeromnes · 2022-11-29T15:37:52Z

Alright, I think that throwing this more helpful error is a better approach:

Try for yourself: https://jx-remove-prefix.preview.gitpod-dev.com/#prebuild/https://github.com/gitpod-io/gitpod

easyCZ

LGTM

/hold for error type discussion

easyCZ · 2022-11-29T15:40:50Z

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

@@ -128,6 +128,11 @@ export class PrebuildManager {
            if (user.blocked) {
                throw new Error(`Blocked users cannot start prebuilds (${user.name})`);
            }
+            if (!project) {
+                throw new Error(


Can we throw a User Error (Invalid Argument) here?

Good idea! I think this can be done. Let me try.

easyCZ · 2022-11-29T15:41:19Z

components/server/ee/src/prebuilds/start-prebuild-context-parser.ts

-            actual: context,
-        };
-        return result;
+        throw new Error(


Simlarly here, is it possible to throw an InvalidArgument error?

In this case, it's more a case of a no-longer-valid route (gitpod.io/#prebuild/ URL prefix is deprecated), so it's not really an invalid argument. 🤔 Also, I'm not exactly sure a specific error would bubble correctly all the way to the user.

Let's see, I'll give this a quick try, but leave as is if it turns out too complicated for now.

Given this is the API, and you supplied something which is not valid anymore, I think it would be an Invalid Argument. You could also go with Not Found, but I think that doens't communicate the fact that the client to this API specified something which is no longer valid.

Interesting. I guess this could also be a 400 Bad Request, or a 410 Gone?

shaal · 2022-11-29T17:09:43Z

my 2 cents -
While I do like the instructions - "Please add your project as a repository in a Gitpod team", I think it's important to add a link to the appropriate documentations, or at least a link to "projects" page of the user.

jankeromnes · 2022-11-30T08:44:33Z

Thanks for the feedback @easyCZ and @shaal! 🚀 Your ideas make sense to me. I'll give them a try, but given how little visibility this code path has nowadays, if implementing them here turns out too complicated, I think I might just ship this PR as is and leave any improvements as potential follow-up items for the future. 💭

easyCZ · 2022-11-30T08:46:54Z

Thanks for the feedback @easyCZ and @shaal! 🚀 Your ideas make sense to me. I'll give them a try, but given how little visibility this code path has nowadays, if implementing them here turns out too complicated, I think I might just ship this PR as is and leave any improvements as potential follow-up items for the future. 💭

I think the particular code doesn't matter as much, as long as it does not show up as a 5xx error which would eat into our SLO but wasn't actually something we'd have control over.

jankeromnes · 2022-11-30T09:24:53Z

[Ensure VM Readiness|PHASE] Ensuring VM is ready for deployment
[Waiting for VM readiness] Wait for VM readiness
[Waiting for VM readiness] Timeout while waiting for VM to get ready. Timeout: 600. Stderr: error: timed out waiting for the condition on pods/virt-launcher-jx-remove-prefix-gfdct
. Stdout: 
Error Error: VM didn't reach 'Ready' status before the timeout.

/werft run

👍 started the job as gitpod-build-jx-remove-prefix.9
(with .werft/ from main)

jankeromnes · 2022-11-30T09:38:12Z

🙄

/werft run with-clean-slate-deployment

👍 started the job as gitpod-build-jx-remove-prefix.10
(with .werft/ from main)

jankeromnes · 2022-11-30T10:01:59Z

Maybe 4th time's the charm!

/werft run

👍 started the job as gitpod-build-jx-remove-prefix.11
(with .werft/ from main)

jankeromnes · 2022-11-30T10:16:43Z

/werft run cert-issuer=letsencrypt

👍 started the job as gitpod-build-jx-remove-prefix.12
(with .werft/ from main)

jankeromnes · 2022-11-30T10:36:12Z

/werft run cert-issuer=letsencrypt recreate-preview

👍 started the job as gitpod-build-jx-remove-prefix.13
(with .werft/ from main)

jankeromnes · 2022-11-30T13:07:58Z

New UX: https://jx-remove-prefix.preview.gitpod-dev.com/#prebuild/https://github.com/gitpod-io/gitpod

Should be easy to introduce a new custom error type and make the UI display a link. 🙂

jankeromnes · 2022-11-30T14:28:46Z

Latest UX:

I'm guessing this is now good to go! 🚀

/unhold

gtsiolis · 2022-11-30T14:35:06Z

Thanks for shipping this, @jankeromnes!

Shall we open any follow up issues from the outstanding tasks in the epic (#9898) to consider this DONE? Cc @jldec

Change documentation to explain that prebuilds require a project

Post announcement about new prebuild requirement in changelog

jankeromnes · 2022-12-05T08:21:45Z

Follow-up issue: Now that the #prebuild/ URL prefix is no more, users no longer have a reliable way to re-trigger a Prebuild (other than pushing a new commit to a branch), because the 'Run Prebuild' UI button only works for "failed" or "cancelled" prebuilds.

To fix this, we plan to make the 'Run Prebuild' button do what it says 100% of the time: #15144

roboquat added release-note do-not-merge/work-in-progress labels Nov 29, 2022

roboquat added the size/M label Nov 29, 2022

jankeromnes mentioned this pull request Nov 29, 2022

Remove deprecated '#prebuild/' context URL prefix #15024

Closed

4 tasks

jankeromnes force-pushed the jx/remove-prefix branch 2 times, most recently from 5e54ed3 to 0e4ccf1 Compare November 29, 2022 13:28

jankeromnes force-pushed the jx/remove-prefix branch from 0e4ccf1 to f8d3bde Compare November 29, 2022 14:58

jankeromnes changed the title ~~Remove deprecated '#prebuild/' context URL prefix~~ Disable running prebuilds without a project Nov 29, 2022

jankeromnes force-pushed the jx/remove-prefix branch 2 times, most recently from b1260d4 to 154891d Compare November 29, 2022 15:25

jankeromnes marked this pull request as ready for review November 29, 2022 15:38

jankeromnes requested a review from a team November 29, 2022 15:38

roboquat removed the do-not-merge/work-in-progress label Nov 29, 2022

github-actions bot added the team: webapp Issue belongs to the WebApp team label Nov 29, 2022

easyCZ approved these changes Nov 29, 2022

View reviewed changes

roboquat added the do-not-merge/hold label Nov 29, 2022

jankeromnes force-pushed the jx/remove-prefix branch from 9fa3ec0 to ddd7a0d Compare November 30, 2022 13:41

jankeromnes added 3 commits November 30, 2022 14:10

Disable running prebuilds without a project

134c975

Disable the deprecated '#prebuild/' context URL prefix

8270af1

Show more semantic errors when trying to run prebuilds without a project

fbc46cd

jankeromnes force-pushed the jx/remove-prefix branch from ddd7a0d to fbc46cd Compare November 30, 2022 14:10

roboquat removed the do-not-merge/hold label Nov 30, 2022

roboquat merged commit ff78e51 into main Nov 30, 2022

roboquat deleted the jx/remove-prefix branch November 30, 2022 14:29

roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Dec 1, 2022

gtsiolis mentioned this pull request Feb 6, 2023

Stop consuming prebuilds when you have no access to the project #16250

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Disable running prebuilds without a project #15026

Disable running prebuilds without a project #15026

jankeromnes commented Nov 29, 2022 •

edited

Loading

werft-gitpod-dev-com bot commented Nov 29, 2022

jankeromnes commented Nov 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 29, 2022 •

edited

Loading

jankeromnes commented Nov 29, 2022

easyCZ left a comment

easyCZ Nov 29, 2022

jankeromnes Nov 30, 2022

easyCZ Nov 29, 2022

jankeromnes Nov 30, 2022

easyCZ Nov 30, 2022

jankeromnes Nov 30, 2022 •

edited

Loading

shaal commented Nov 29, 2022

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

easyCZ commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis commented Nov 30, 2022 •

edited

Loading

jankeromnes commented Dec 5, 2022 •

edited

Loading

Disable running prebuilds without a project #15026

Disable running prebuilds without a project #15026

Conversation

jankeromnes commented Nov 29, 2022 • edited Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

werft-gitpod-dev-com bot commented Nov 29, 2022

jankeromnes commented Nov 29, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 29, 2022 • edited Loading

jankeromnes commented Nov 29, 2022

easyCZ left a comment

Choose a reason for hiding this comment

easyCZ Nov 29, 2022

Choose a reason for hiding this comment

jankeromnes Nov 30, 2022

Choose a reason for hiding this comment

easyCZ Nov 29, 2022

Choose a reason for hiding this comment

jankeromnes Nov 30, 2022

Choose a reason for hiding this comment

easyCZ Nov 30, 2022

Choose a reason for hiding this comment

jankeromnes Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

shaal commented Nov 29, 2022

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

easyCZ commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

jankeromnes commented Nov 30, 2022 • edited Loading

jankeromnes commented Nov 30, 2022 • edited by werft-gitpod-dev-com bot Loading

gtsiolis commented Nov 30, 2022 • edited Loading

jankeromnes commented Dec 5, 2022 • edited Loading

jankeromnes commented Nov 29, 2022 •

edited

Loading

jankeromnes commented Nov 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 29, 2022 •

edited

Loading

jankeromnes Nov 30, 2022 •

edited

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

easyCZ commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Nov 30, 2022 •

edited

Loading

jankeromnes commented Nov 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

gtsiolis commented Nov 30, 2022 •

edited

Loading

jankeromnes commented Dec 5, 2022 •

edited

Loading