fix(core): throw error for invalid URL in config file #8192
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* fix: throw error for site URL in sub-path format
* Also update unit tests to check error is thrown
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
slorber
requested changes
Oct 12, 2022
Collaborator
slorber
left a comment
slorber
left a comment
There was a problem hiding this comment.
Thanks 👍
Not ready to be merged yet
Comment on lines
118
to
126
| expect(() => | ||
| normalizeConfig({ | ||
| // This shouldn't happen | ||
| url: 'https://mysite.com/foo/', | ||
| }).url, | ||
| ).toBe('https://mysite.com/foo'); | ||
|
|
||
| expect(consoleMock.mock.calls[0][0]).toMatchInlineSnapshot( | ||
| `"[WARNING] Docusaurus config validation warning. Field "url": The url is not supposed to contain a sub-path like '/foo/'. Please use the baseUrl field for sub-paths."`, | ||
| ); | ||
| }), | ||
| ).toThrowErrorMatchingInlineSnapshot(` | ||
| "The url is not supposed to contain a sub-path like "". Please use the baseUrl field for sub-paths. | ||
| " | ||
| `); |
Collaborator
There was a problem hiding this comment.
I'm not sure we need this anymore, at least not in this test group, because here it's not testing URL normalization but URL rejection so this feels weird
| helpers.warn('docusaurus.configValidationWarning', { | ||
| warningMessage: `The url is not supposed to contain a sub-path like '${pathname}'. Please use the baseUrl field for sub-paths.`, | ||
| }); | ||
| return helpers.error('docusaurus.configValidationWarning'); |
Collaborator
There was a problem hiding this comment.
I don't think we should use configValidationWarning for something that is an error. Also pathname used to be interpolated but it's not anymore
Unfortunately I can't really guide you to the correct solution: Joi is really a pain to do anything basic such as returning a custom error message 😅
Josh-Cena
changed the title
…acebook#8192) * fix: throw custom error for site URL with sub-path * Also update unit test to check error is thrown
Collaborator
|
LGTM thanks 👍 |
slorber
added
the
to backport
slorber
pushed a commit
that referenced
this pull request
Oct 28, 2022
slorber
added
backported
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pre-flight checklist
Motivation
Currently, a warning is displayed when the URL contains a sub-path but as mentioned at the end of #8159, it makes more sense to display an error. So, I updated the code to display an error instead of a warning.
Test Plan
Test links
I updated unit tests to verify my code.
Related issues/PRs
Related to #8159 and #8116