Allow ApolloProvider Prop Updates #479

wmcbain · 2017-02-24T03:01:52Z

We have a use case in React Native where we switch the GraphQL endpoint dynamically while the app is running. This PR changes the ApolloProvider API by updating it's client and store when new props are delivered to the provider.

TODO:

Make sure all of the significant new logic is covered by tests
Rebase your changes on master so that they can be merged easily
Make sure all tests and linter rules pass
Update CHANGELOG.md with your change

apollo-cla · 2017-02-24T03:01:53Z

@wmcbain: 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/

stubailo · 2017-02-24T04:09:41Z

Nice! This looks like a great change.

jbaxleyiii · 2017-02-24T08:01:24Z

@wmcbain if you can add a couple tests for this, we can merge it and release it! Thanks!

calebmer

A couple of comments, looks good though 👍

Also needs some tests so we can make sure that this behavior never regresses 😊

calebmer · 2017-02-24T15:21:00Z

src/ApolloProvider.tsx

+    this._init(props);
+  }
+
+  componentWillReceiveProps(nextProps) {


I think this should be componentDidUpdate. We also wouldn’t need to pass in props in that case.

Also, we should probably put this in an if that checks if we actually have a new client.

calebmer · 2017-02-24T15:23:22Z

src/ApolloProvider.tsx

@@ -61,7 +69,6 @@ export default class ApolloProvider extends Component<ProviderProps, any> {
    // intialize the built in store if none is passed in
    props.client.initStore();
    this.store = props.client.store;


Shouldn’t the client and store be state instead of class properties? Or better yet, why do we even need them to be class properties? We can just call initStore on them when they change.

wmcbain · 2017-02-24T16:50:24Z

src/ApolloProvider.tsx

@@ -10,7 +10,9 @@ import {
  Store,
 } from 'redux';

-import ApolloClient from 'apollo-client';
+/* tslint:disable:no-unused-variable */
+import ApolloClient, { ApolloStore } from 'apollo-client';


TS compiler was throwing an error without ApolloStore not being in scope when potentially returning an ApolloStore in getChildContext.

Yeah this is one weird edge case in TS

stubailo · 2017-02-24T16:51:15Z

Changelog.md

@@ -3,6 +3,7 @@
 Expect active development and potentially significant breaking changes in the `0.x` track. We'll try to be diligent about releasing a `1.0` version in a timely fashion (ideally within 1 or 2 months), so that we can take advantage of SemVer to signify breaking changes from that point on.

 ### vNext
+- ApolloProvider now changes it's client and store when those props change. [PR #479](https://github.com/apollographql/react-apollo/pull/479)


It's -> its

wmcbain · 2017-02-24T18:25:44Z

Ready for review

calebmer

Looks good to me. I’d just like to see one or two more tests that assert GraphQL container components query the correct client and/or when the client changes re-queries (or not) against the new client.

wmcbain · 2017-02-27T16:49:23Z

test/react-web/client/ApolloProvider.test.tsx

+    expect(initStoreMock).not.toHaveBeenCalled();
+  });
+
+  it('child component should be able to query new client and store when props change', () => {


@calebmer Test added

helfer · 2017-02-28T04:39:58Z

@calebmer I'll let you finish reviewing this and include it in the next release.

calebmer · 2017-03-01T15:46:57Z

The new test is good, but I really want to see something that uses the graphql HOC 😊

When the client changes, does the HOC make a new request to the new client? When the client changes and then refetch is called from the HOC, is the request executed with the new client?

These are behaviors I’d like to see asserted with tests.

wmcbain · 2017-03-01T16:14:25Z

@calebmer I'm not sure if I'm familiar enough with this library to provide the depth of tests that you are looking for. I'm struggling to provide these tests within reasonable time as a result.

Is there an example that you can point to that would help me see what you're looking for?

* Change client and store when new props are passed to the ApolloProvider * Update Changelog

* Requested ApolloProvider changes * Add tests

wmcbain · 2017-03-16T20:36:53Z

test/react-web/client/ApolloProvider.test.tsx

+
+    // Both cases fail
+    expect(initialInterface.query).not.toHaveBeenCalled();
+    expect(nextInterface.query).toHaveBeenCalled();


Hey @calebmer, revisited this problem after learning a bit more and running into a bug that fit the test case you described exactly in this PR. I'm wondering now if you foresaw this being an issue?

Any help/insight is appreciated.

I added a better test and fixed the bugs the test revealed. I’ll merge once CI passes 👍

calebmer · 2017-03-17T15:08:17Z

Released in 1.0.0-rc.3 🎉

wmcbain · 2017-03-17T15:11:02Z

Thanks!

wmcbain force-pushed the allow-provider-prop-updates branch from 530a883 to 8138b99 Compare February 24, 2017 03:08

calebmer suggested changes Feb 24, 2017

View reviewed changes

wmcbain commented Feb 24, 2017

View reviewed changes

stubailo reviewed Feb 24, 2017

View reviewed changes

wmcbain force-pushed the allow-provider-prop-updates branch 2 times, most recently from b964e63 to 0a36251 Compare February 24, 2017 20:58

calebmer suggested changes Feb 27, 2017

View reviewed changes

wmcbain force-pushed the allow-provider-prop-updates branch from 0a36251 to 70fa2ec Compare February 27, 2017 16:48

wmcbain commented Feb 27, 2017

View reviewed changes

Wyatt McBain and others added 5 commits March 15, 2017 20:54

Allow ApolloProvider Prop Updates

455d847

* Change client and store when new props are passed to the ApolloProvider * Update Changelog

Update ApolloProvider.tsx

df218b9

Requested PR changes

1614971

* Requested ApolloProvider changes * Add tests

Add child test

c36f3aa

Revert snapshot

7d91e47

wmcbain force-pushed the allow-provider-prop-updates branch from 4a70834 to 7d91e47 Compare March 16, 2017 02:43

Failing tests for refetch

c18528c

wmcbain force-pushed the allow-provider-prop-updates branch from 7e8a9b9 to c18528c Compare March 16, 2017 20:31

wmcbain commented Mar 16, 2017

View reviewed changes

calebmer added 2 commits March 17, 2017 10:57

add better test and fix errors

0729a03

Merge branch 'master' into allow-provider-prop-updates

3709c7d

calebmer approved these changes Mar 17, 2017

View reviewed changes

calebmer merged commit af53290 into apollographql:master Mar 17, 2017

wmcbain mentioned this pull request Apr 24, 2017

ApolloProvider's shouldComponentUpdate causes silent issues when used with other providers, such as react router's #557

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow ApolloProvider Prop Updates #479

Allow ApolloProvider Prop Updates #479

wmcbain commented Feb 24, 2017 •

edited

Loading

apollo-cla commented Feb 24, 2017

stubailo commented Feb 24, 2017

jbaxleyiii commented Feb 24, 2017

calebmer left a comment

calebmer Feb 24, 2017

calebmer Feb 24, 2017

calebmer Feb 24, 2017

wmcbain Feb 24, 2017

stubailo Feb 24, 2017

stubailo Feb 24, 2017

wmcbain commented Feb 24, 2017

calebmer left a comment

wmcbain Feb 27, 2017

helfer commented Feb 28, 2017

calebmer commented Mar 1, 2017

wmcbain commented Mar 1, 2017

wmcbain Mar 16, 2017

calebmer Mar 17, 2017

calebmer commented Mar 17, 2017

wmcbain commented Mar 17, 2017

Allow ApolloProvider Prop Updates #479

Allow ApolloProvider Prop Updates #479

Conversation

wmcbain commented Feb 24, 2017 • edited Loading

apollo-cla commented Feb 24, 2017

stubailo commented Feb 24, 2017

jbaxleyiii commented Feb 24, 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

wmcbain commented Feb 24, 2017

calebmer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

helfer commented Feb 28, 2017

calebmer commented Mar 1, 2017

wmcbain commented Mar 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calebmer commented Mar 17, 2017

wmcbain commented Mar 17, 2017

wmcbain commented Feb 24, 2017 •

edited

Loading