Stop excluding observerless queries from refetchQueries selection
#8825
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
benjamn
commented
Sep 22, 2021
Comment on lines
-770
to
+772
| if (fetchPolicy === "standby" || !oq.hasObservers()) { | ||
| // Skip inactive queries unless include === "all". | ||
| if ( | ||
| fetchPolicy === "standby" || | ||
| (include === "active" && !oq.hasObservers()) |
There was a problem hiding this comment.
The include: "active" shorthand still excludes observerless queries, as before.
benjamn
added a commit
that referenced
this pull request
Sep 22, 2021
benjamn
force-pushed
the
issue-5419-stop-ignoring-observerless-queries
branch
from
6771746
to
a2d121f
Compare
brainkim
reviewed
Sep 23, 2021
| include: ["A", abQuery], | ||
|
|
||
| onQueryUpdated(obs, diff) { | ||
| if (obs === aObs) { |
There was a problem hiding this comment.
A mock function call to assert how many times onQueryUpdated() is called would help us out in the future.
| ]); | ||
|
|
||
| subs.push(abObs.subscribe({ | ||
| next(result) { |
There was a problem hiding this comment.
Same thing about mock functions.
benjamn
added a commit
that referenced
this pull request
Apr 21, 2022
This PR is a follow-up to PR #8825, which was first released in Apollo Client v3.4.14. As a number of commenters have reported in issue #5419, it appears we did not completely fix the problem, so this PR attempts to finish that work. Since ObservableQuery redelivers the most recent result/error to new subscribers, it is not completely pointless to refetch an ObservableQuery that (currently) has no subscribers. However, putting the ObservableQuery in "standby" mode by setting the obsQuery.options.fetchPolicy to "standby" should still exclude the ObservableQuery from "active" status as far as refetchQueries is concerned. This logic handles useLazyQuery queries that have not yet been executed, since they start out in "standby" mode until called.
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.
The example code I provided in #5419 (comment) should work even if
QueryIWantToRefreshcurrently has no observers:I suspect the
oq.hasObservers()check removed by this PR explains at least some instances of issue #5419, but I also believe there's value in refetching observerless queries (at the developer's explicit request), so future subscribers can immediately receive the most recent result or error.Alternatively, when performing a mutation, this same line of reasoning applies to the
refetchQueries: [...]option:If you really want to put an
ObservableQueryout of commission (except wheninclude: "all"is used), you can set its.options.fetchPolicyto"standby".