Provide better feedback when gitpod.yml is invalid #4844
Conversation
instead of having to use the .gitpod.yml
| @@ -47,17 +47,91 @@ export class ConfigProvider { | |||
| let configBasePath = ''; | |||
There was a problem hiding this comment.
nit: This can be moved into the try
| if (AdditionalContentContext.is(commit) && commit.additionalFiles['.gitpod.yml']) { | ||
| const customConfigString = commit.additionalFiles['.gitpod.yml']; | ||
| const parseResult = this.gitpodParser.parse(customConfigString); | ||
| customConfig = parseResult.config; | ||
| customConfig._origin = 'additional-content'; | ||
| if (parseResult.validationErrors) { | ||
| log.error(logContext, `Invalid config. Errors are ${parseResult.validationErrors.join(',')}`, { repoCloneUrl: commit.repository.cloneUrl, revision: commit.revision, customConfigString }); | ||
| const err = new InvalidGitpodYMLError(parseResult.validationErrors); |
| @@ -90,7 +164,10 @@ export class ConfigProvider { | |||
| customConfig = parseResult.config | |||
| await this.fillInDefaultLocations(customConfig, inferredConfig); | |||
| if (parseResult.validationErrors) { | |||
| log.error(logContext, `Skipping invalid config. Errors are ${parseResult.validationErrors.join(',')}`, { repoCloneUrl: commit.repository.cloneUrl, revision: commit.revision, customConfigString }); | |||
| const err = new InvalidGitpodYMLError(parseResult.validationErrors); | |||
There was a problem hiding this comment.
👍
(it's a bit hard to parse the diff, but I understood that these three changes are the only relevant ones, the rest seems to be a move)
There was a problem hiding this comment.
Indeed. Also note the demotion of log prio. If this fails here it's a user input issue, not a system error
| @@ -47,17 +47,91 @@ export class ConfigProvider { | |||
| let configBasePath = ''; | |||
| try { | |||
| let customConfig: WorkspaceConfig | undefined; | |||
|
|
|||
| if (!WithDefaultConfig.is(commit)) { | |||
| @@ -310,3 +344,17 @@ export class ConfigProvider { | |||
| } | |||
|
|
|||
| } | |||
|
|
|||
| export class InvalidGitpodYMLError extends Error { | |||
There was a problem hiding this comment.
We have quite some classes like this around. Would be awesome if we found a way to generalize this approach! 👍
|
/werft run 👍 started the job as gitpod-build-csweichel-provide-better-feedback-4828.4 |
|
LGTM label has been added. Git tree hash: 7d683b691369002e0e2b93e724ca7523ce21e6f3
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: csweichel, geropl The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
fixes #4828
This PR adds a proper failure mode for invalid gitpod.yml configuration. Instead of silently falling back to the default config, it surfaces the error and offers the choice to start with the default config.
How to test