Never fetch recycled queries on network interface #531

jacobk · 2017-03-13T17:51:08Z

See discussion in apollographql/apollo-client#1319

apollo-cla · 2017-03-13T17:51:11Z

@jacobk: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Meteor Contributor Agreement here: https://contribute.meteor.com/

calebmer

Looks great 👍

I’d just like to see a few changes to increase test completeness 😊

calebmer · 2017-03-13T17:52:59Z

src/graphql.tsx

@@ -636,6 +636,9 @@ class ObservableQueryRecycler {
    // Stop the query from polling when we recycle. Polling may resume when we
    // reuse it and call `setOptions`.
    observableQuery.stopPolling();
+    observableQuery.setOptions({
+      fetchPolicy: 'cache-only',


Let’s remove stopPolling for pollInterval: 0 in setOptions. It does the same thing: https://github.com/apollographql/apollo-client/blob/1e986c57e12d98f2831616005ef0211d4c9689d1/src/core/ObservableQuery.ts#L307-L311

calebmer · 2017-03-13T17:54:36Z

test/react-web/client/graphql/queries.test.tsx

+      </ApolloProvider>
+    );
+
+    expect(Object.keys((client as any).queryManager.observableQueries)).toEqual(['1']);


Could we check that this observable query still exists after we unmount as well?

calebmer · 2017-03-13T17:56:06Z

test/react-web/client/graphql/queries.test.tsx

+    client.resetStore();
+
+    // The query should only have been invoked when first mounting and not when resetting store
+    expect(networkInterface.query).toHaveBeenCalledTimes(1);


Let’s also check that this method was called once before we unmounted.

You should also duplicate this test and assert that query is called twice if we do not unmount, but we still call resetStore.

calebmer

I thought of another edge case.

calebmer · 2017-03-17T15:00:56Z

src/graphql.tsx

@@ -635,7 +635,10 @@ class ObservableQueryRecycler {
  public recycle (observableQuery: ObservableQuery<any>): void {
    // Stop the query from polling when we recycle. Polling may resume when we
    // reuse it and call `setOptions`.
-    observableQuery.stopPolling();
+    observableQuery.setOptions({
+      fetchPolicy: 'cache-only',


On second thought, I’m not ready to merge this because if an observable query gets reused the fetchPolicy will stay as cache-only which is undesirable. Could you write a test to show this doesn’t happen? If it does could you make sure it does not?

I think the solution is to update line 672 so that it sets the default fetch policy if no other fetch policy was found. So:

observableQuery.setOptions({ ...options, fetchPolicy: options.fetchPolicy || 'xyz', });

Where 'xyz' is the default fetchPolicy. This should guarantee that the cache-only policy is reset.

Sure!
I thought that setOptions where strictly overriding the old options but I just noticed that it doesn't. As far as I can tell there's no explicit default for fetchPolicy and the current setOptions implementation doesn't allow removing previously set properties:

const oldOptions = this.options; this.options = { ...this.options, ...opts, } as WatchQueryOptions;

Ideally I'd like to remove both the pollInterval and fetchPolicy completely before applying options inside reuse.

Any ideas? I'll commit the new breaking test case for now (which is testing for strict equality of options before and after recycle).

I've pushed a possible fix for reverting the options changed when recycling. IMHO it's a little on the hacky side since I need to manually overwrite the ObservableQuery's options to fully remove the altered options.

Maybe setOptions should be updated to allow for options to be removed completely?

Let’s try instead saving the old options in recycle() and then merging those options with the new options in reuse(). Do you think that would work?

But perhaps this isn’t the right thing to do at all. Perhaps what we really need to do is create some kind of light-weight subscribe in apollo-client that will only allow receiving updateQueries and refetchQueries instead of writing workarounds in the recycler…

The issue with merging options is that you cannot remove any - only update and add. I think fetchPolicy is omitted by default. Maybe it's enough to set it to undefined instead? But then it's a less straight forward procedure to store the old options and later restore them if the values needs to be reasoned about.

But if it's a sound approach to simply override the observableQ.options before calling setOptions (like I do now, that could be done with the snapshotted options too of course).

I haven't studied the whole thing to fully reason about the recycler. However, the current issue with fetchPolicy and refetching onresetStore is giving us real trouble. Given the issue at hand the limitations of apollo-client's setOptions are my only concern.

Setting to undefined should be the equivalent of removing. Does this make the implementation easier?

I don’t like the idea of setting options manually mainly because we haven’t yet considered all of the implications 😣

jacobk · 2017-03-17T20:30:53Z

The last commit sets the altered options to undefined instead. I think this is symmetric enough compared to keeping a copy of the old options around and still do the same manual handling of the options that should be set to undefined if they weren't initially set.

jacobk · 2017-03-27T08:31:32Z

@calebmer happy with last version or do you have doubts about this approach?

jacobk · 2017-04-01T16:49:16Z

@helfer, any thoughts on this PR, anything else needs changing? (@calebmer asked me to poke you in is absence)

helfer · 2017-04-01T17:15:59Z

Thanks @jacobk! I'm away for the weekend, but I'll take a look on Monday. 🙂

jacobk · 2017-04-01T18:14:36Z

Great, thanks!

helfer · 2017-04-07T05:32:36Z

Thanks @jacobk, I think this looks good now, and it might fix the resetStore issue, so I'll release a new patch version with this change before the weekend! 🙂

Adressed

helfer

ship it.

never fetch recycled queries on network interface

9722637

calebmer added 2 commits March 13, 2017 13:53

Update queries.test.tsx

9777716

Update queries.test.tsx

d39b3c1

calebmer suggested changes Mar 13, 2017

View reviewed changes

Jacob Kristhammar added 2 commits March 13, 2017 19:10

only use setOptions when recycling ObservableQuerys

82aa79f

Add more tests

e1bbde9

calebmer approved these changes Mar 13, 2017

View reviewed changes

calebmer added 2 commits March 17, 2017 10:14

Merge branch 'master' into master

278fdce

Update Changelog.md

2190a23

calebmer previously requested changes Mar 17, 2017

View reviewed changes

Jacob Kristhammar added 3 commits March 17, 2017 19:17

Update test case to detect option change after recycle

b6ff87f

Restore ObserableQuery options when reusing after recycled

f653cd3

Set options to undefined instead of overriding directly

b452ebe

Fix typo

aa6795f

jacobk added 2 commits March 30, 2017 08:28

Merge branch 'master' into master

c9d20c0

Merge branch 'master' into master

897f0e4

abergenw mentioned this pull request Apr 6, 2017

Query is not cleaned up after component is unmounted in afterware apollographql/apollo-client#1319

Closed

Merge branch 'master' into master

965a395

helfer mentioned this pull request Apr 7, 2017

unmounting ApolloProvider not clearing cache #600

Closed

helfer approved these changes Apr 7, 2017

View reviewed changes

helfer merged commit ed456a2 into apollographql:master Apr 7, 2017

BlooJeans mentioned this pull request Apr 7, 2017

resetStore() refetches queries that are still "active", even after those queries' components were unmounted apollographql/apollo-client#1560

Closed

cyrilepinat mentioned this pull request Apr 13, 2017

fetchPolicy set to cache-only after unmount #622

Closed

jacobk mentioned this pull request Apr 19, 2017

client.resetStore() doesn't reset the store apollographql/apollo-client#1552

Closed

helfer mentioned this pull request Apr 30, 2017

Recycler standby apollographql/apollo-client#1636

Merged

6 tasks

jacobk mentioned this pull request May 1, 2017

Use standby fetchPolicy for recycled queries #671

Merged

4 tasks

rtymchyk mentioned this pull request May 20, 2017

Container stuck in loading state when fetchPolicy is not default #678

Closed

helfer mentioned this pull request May 30, 2017

networkStatus gets stuck on "2" (setVariables) #667

Closed

jvbianchi mentioned this pull request Aug 15, 2017

It's not possible to reset store without query refetching vuejs/apollo#53

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Never fetch recycled queries on network interface #531

Never fetch recycled queries on network interface #531

jacobk commented Mar 13, 2017

apollo-cla commented Mar 13, 2017

calebmer left a comment

calebmer Mar 13, 2017

jacobk Mar 13, 2017

calebmer Mar 13, 2017

jacobk Mar 13, 2017

calebmer Mar 13, 2017

jacobk Mar 13, 2017

calebmer left a comment

calebmer Mar 17, 2017

calebmer Mar 17, 2017

jacobk Mar 17, 2017

jacobk Mar 17, 2017

calebmer Mar 17, 2017

jacobk Mar 17, 2017

calebmer Mar 17, 2017

jacobk commented Mar 17, 2017

jacobk commented Mar 27, 2017

jacobk commented Apr 1, 2017

helfer commented Apr 1, 2017

jacobk commented Apr 1, 2017

helfer commented Apr 7, 2017

helfer left a comment

Never fetch recycled queries on network interface #531

Never fetch recycled queries on network interface #531

Conversation

jacobk commented Mar 13, 2017

apollo-cla commented Mar 13, 2017

calebmer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calebmer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobk commented Mar 17, 2017

jacobk commented Mar 27, 2017

jacobk commented Apr 1, 2017

helfer commented Apr 1, 2017

jacobk commented Apr 1, 2017

helfer commented Apr 7, 2017

helfer left a comment

Choose a reason for hiding this comment