feat(gatsby): improve error messages at runtime #29970
Merged
Conversation
This file contains 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
gatsbot
bot
added
the
status: triage needed
wardpeet
removed
the
status: triage needed
wardpeet
commented
Mar 3, 2021
| @@ -103,6 +78,12 @@ const runSuiteForPage = (label, pagePath) => { | |||
| filter: `page-data`, | |||
| }) | |||
| }) | |||
| describe(`Missing "${label}" static query results`, () => { | |||
There was a problem hiding this comment.
We weren't tested static-query blocked
wardpeet
commented
Mar 3, 2021
| asyncRequires.components[chunkName]() | ||
| .then(preferDefault) | ||
| // loader will handle the case when component is error | ||
| .catch(err => err) |
There was a problem hiding this comment.
Return the error instead of throwing
wardpeet
commented
Mar 3, 2021
Comment on lines
+30
to
+32
| throw new Error( | ||
| `We couldn't find the correct component chunk with the name "${chunkName}"` | ||
| ) |
There was a problem hiding this comment.
We silently fail, now we don't
|
Probably good to backport this to v2, it will need small change in the cherry-pick PR. Develop wasn't using async-requires |
LekoArts
approved these changes
Mar 4, 2021
There was a problem hiding this comment.
Overall LGTM. Non blocking (maybe as follow-up): Can we give clearer instructions on how people might solve their issue? We're outputting more detailed errors now, but they are the nitty gritty details. I could imagine a link to a specific docs page for example
|
I agree but the issue is that I don't know yet why they happen. |
pieh
pushed a commit
that referenced
this pull request
Mar 5, 2021
(cherry picked from commit d37f275)
pieh
pushed a commit
that referenced
this pull request
Mar 5, 2021
(cherry picked from commit d37f275)
pieh
pushed a commit
that referenced
this pull request
Mar 5, 2021
(cherry picked from commit d37f275)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Adding some better error messages in our runtime code so people can actually see what's going wrong in their error trackers.
It should help us solve #19618
When you have a runtime error in your page component before React kicks in
When Static Query fails we got an unexpected JSON error, now we get:
When Page Query fails, it's still the same:
Related Issues
Related to #19618