Do not do client-side checks in production #6292
Comments
|
I don't understand 😅 |
|
For example, our tabs component does this check: if (defaultValue !== null && !values.some((a) => a.value === defaultValue)) {
throw new Error(
`Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values
.map((a) => a.value)
.join(
', ',
)}. If you intend to show no default tab, use defaultValue={null} instead.`,
);
}That's a lot of code and an error message that can't be minified at all. Do we need this to be bundled into production JS? Probably not, because we only serve static content. React also has different error messages during prod and dev right? Only "Minified React error: ..." in prod, and things like "invalid hooks call" in dev. My grep demonstrates that this error message is actually leaked into our production bundle, which technically can never be thrown. |
|
Oh I see, you mean https://reactjs.org/docs/error-decoder.html/ Definitively planned, but low-priority as it's just an optimization, not sure the impact would be huge Actually marked this as planned here last week 🤪 https://docusaurus.canny.io/admin/feedback/feature-requests/p/error-messages-integration |
Josh-Cena
added
the
domain: performance
Have you read the Contributing Guidelines on issues?
Motivation
We shouldn't do too many client-side checks in production. For example, we have a lot of fail-fast checks for Tabs to prevent bad configurations, which are still present in the production build and the error messages bloat up the bundle. In the spirit of bundle size optimization, we should only throw if
process.env.NODE_ENV === 'development', and let it display whatever can be displayed in production.Alternatively, we can have some minified error messages and have an error decoder? I'm actually not sure what solutions there are out there!
Just ran a search in our site's build output:
All occurrences of "Docusaurus error" (standardized prefix of our browser error message)
Self-service
The text was updated successfully, but these errors were encountered: