Unmounting a component before a query is resolved via useLazyQuery lets the promise resolve instead of aborting the promise.
#10698
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
🦋 Changeset detectedLatest commit: 18be640 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for apollo-client-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
jerelmiller
added
🐞 bug
⚛️ React-related
🥚 backwards-compatible
|
/release:pr |
|
A new release has been made for this PR. You can install it with |
jerelmiller
changed the title
useLazyQuery let the promise resolve instead of aborting the promise.useLazyQuery lets the promise resolve instead of aborting the promise.
jerelmiller
commented
Mar 31, 2023
jerelmiller
commented
Mar 31, 2023
…ther than aborting them when unmounting the component
… in the right resolved data.
… intended behavior
jerelmiller
force-pushed
the
resolve-vs-abort-lazy-query
branch
from
167d5f4 to
18be640
Compare
alessbell
approved these changes
Mar 31, 2023
Comment on lines
+36
to
+37
| // Use refs to track options and the used query to ensure the `execute` | ||
| // function remains referentially stable between renders. |
|
Also not sure why Netlify is deploying in the first place (no docs changes) but it rebuilt just fine here, the PR check just isn't picking that up... |
Merged
This was referenced Apr 3, 2023
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.
Fixes #9755
Fixes #10174
Fixes #10198
Fixes #10520
Fixes #10533
This PR addresses a few outstanding
useLazyQueryissues and changes the behavior introduced in #10427 when a component unmounts before a query is fully resolved.Prior to #10427, components that unmounted before the query was resolved were stuck awaiting the promise indefinitely since promise resolution was dependent on the
useQueryrender cycle to resolve the promise. #10427 attempted to fix this by aborting the promise any time the component unmounted. This change however was a bit too spicy 🌶️ . Aborting the promise also made it impossible for some use cases that relied upon promise resolution to work correctly.This PR changes the behavior so that unmounting a component will no longer cause the promise to abort, but rather let the promise resolve naturally with the result from the server. This change had a number of positive side effects that resolved a number of other issues, for example, the ability to run the execution function multiple times with different variables in parallel will now resolve each of the promises with the correct data (#9755).
This PR also makes it possible to dynamically change the query document passed to
useLazyQueryand ensure the execute function will use the latest set document (#10198). Some additional tests were added to ensure rerendering with new variables before executing the query would use the proper option set.Checklist: