fix(core): throw error for invalid URL in config file #8159
Conversation
* Also add unit test to check error is thrown
|
Hi @forgeRW! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
✅ [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
|
packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts
Outdated
Show resolved
Hide resolved
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
* Throw error for invalid URL in Docusaurus config file * Perform error check in configValidation.ts * Undo error check in createSitemap.ts
Josh-Cena
added
the
pr: polish
Josh-Cena
changed the title
slorber
added
the
to backport
| try { | ||
| const {pathname} = new URL(value); | ||
| if (pathname !== '/') { | ||
| helpers.warn('docusaurus.configValidationWarning', { |
There was a problem hiding this comment.
Thanks
in case you want to follow-up, I think we should make this other case an error instead of a warning
There was a problem hiding this comment.
Thanks for the suggestion! I'll work on this and make a new PR.
* fix: throw error for invalid URL in Docusaurus config file * Also add unit test to check error is thrown * fix: perform error check for invalid URL to configValidation.ts * Throw error for invalid URL in Docusaurus config file * Perform error check in configValidation.ts * Undo error check in createSitemap.ts * Better message Co-authored-by: Joshua Chen <[email protected]>
slorber
added
backported
Pre-flight checklist
Motivation
The error is uncleared that an invalid URL is provided in the Docusaurus config file. The error is thrown by the normalizeURL function (/path/node_modules/sitemap/dist/lib/utils.js:274:15) so this PR adds code to catch the TypeError from the normalizeURL function and throw an error for an invalid URL.
Test Plan
Test links
I added a unit test to verify my code.
Related issues/PRs
Related to #8116