Fix skip causing loading to always be true during SSR
#7567
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
PR apollographql#7310 introduced a regression that caused skipped SSR queries to always set `loading` to `true`, which doesn't match the behavior of `useQuery()` on the client and can result in hydration mismatches. The problem is that `skip: true` was being treated as equivalent to `ssr: false`, but they're not actually equivalent. I think the correct solution is to let `this.getQueryResult()` provide a suitable result when `skip` is truthy, which ensures that skipped SSR queries will get the same result as skipped non-SSR queries. Fixes apollographql#7380
benjamn
approved these changes
Jan 14, 2021
There was a problem hiding this comment.
@rgrove Thanks for digging into this and coming up with a good solution! I pushed a commit to make sure result.networkStatus is defined in the skip: true case, but that's just because I thought it was strange you needed to test expect(networkStatus).toBeUndefined(). This PR should land in the next patch version, @apollo/client@3.3.7.
|
@benjamn Thanks for the quick review and the cleanup! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR #7310 introduced a regression that causes skipped SSR queries to always set
loadingtotrue, which doesn't match the behavior ofuseQuery()on the client and can result in hydration mismatches.The problem is that
skip: truewas being treated as equivalent tossr: false, but they're not actually equivalent. I think the correct solution is to letthis.getQueryResult()provide a suitable result whenskipis truthy, which ensures that skipped SSR queries will get the same result as skipped non-SSR queries.An alternative approach would be to simply back out the changes from PR #7310, but then we'd lose the benefit of avoiding the unnecessary
QueryPromisewhenskipis truthy.Fixes #7380 (note that this issue's title and description are inaccurate, but its comments describe the problem correctly)
Checklist: