Ignore option callbacks when deciding to update a query #6588
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
hwillson
commented
Jul 13, 2020
benjamn
reviewed
Jul 13, 2020
benjamn
force-pushed
the
issue-6301
branch
2 times, most recently
from
d7dedc9 to
46d2c01
Compare
|
Thanks for the |
`QueryData` stores last used options to help decide when it should re-run. If new options (when compared against the previously stored last options) are found, `QueryData` will make sure the new options are passed into Apollo Client for processing. When `onCompleted` and/or `onError` options are set however, `QueryData` thinks the options received on each render are new as these callback functions don't have a stable identity. This can then lead to infinite re-renders. This commit adjusts the `QueryData` option equality check to ignore option callbacks. During normal use of `useQuery` it should be okay to ignore callbacks like this, as they don't normally change between renders. Fixes #6301
1 task
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.
QueryDatastores last used options to help decide when it should re-run. If new options (when compared against the previously stored last options) are found,QueryDatawill make sure the new options are passed into Apollo Client for processing. WhenonCompletedand/oronErroroptions are set however,QueryDatathinks the options received on each render are new as these callback functions don't have a stable identity. This can then lead to infinite re-renders.This commit adjusts the
QueryDataoption equality check to ignore option callbacks. During normal use ofuseQueryit should be okay to ignore callbacks like this, as they don't normally change between renders.Fixes #6301