Make RelayStore Contextual

[devknoll]

This is a cleaner shot at #570.

• RelayGarbageCollection hasn't been updated yet (needs clarification)
• RelayRenderer takes RelayContext as a prop (instead of as context from RelayRootContainer).
• Not using Joe's newest GraphQLStoreQueryResolver changes.
• Adds Relay.Store deprecation calls.
• Fixes RelayStore mock.

This ignores the clean up of interdependencies in RelayStoreData, since the discussion on that is ongoing.

[denvned]

ReactDOM.unstable_batchedUpdates is not suitable for server-side rendering. And generally, I believe RelayRenderer should not be responsible for defining the batching strategy, and should not override it either. It may cause problems such as: denvned/isomorphic-relay-router#5 (comment). Still, ReactDOM.unstable_batchedUpdates might be the default injected by the constructor of RelayContext.

[denvned]

Or even better, do not inject ReactDOM.unstable_batchedUpdates at all. The user can inject that himself if he needs it.

[devknoll]

I think it might be good for Relay to have a sensible default here... Maybe we could introduce a BatchingStrategyLayer that by default injects ReactDOM.unstable_batchedUpdates on the client side, etc. Then you can override this if you'd like.

(In this particular case, the change was made to keep the same behavior as master.)

[denvned]

I think the following can solve the problem temporarily, and be compatible with master:

RelayStore.injectBatchingStrategy(
  ReactDOM.unstable_batchedUpdates
);

But, since you are deprecating RelayStore the following might be better:

const defaultContext = RelayContext.getDefaultInstance();
defaultContext.injectBatchingStrategy(
  ReactDOM.unstable_batchedUpdates
);
RelayRenderer.defaultProps = {
  context: defaultContext,
}

[denvned]

But the later approach have a problem that only the default instance will have the batching strategy injected. Injecting ReactDOM.unstable_batchedUpdates to every new RelayContext by default is also bad, because in couples Relay to ReactDOM too much.

I think, that could be solved by subclassing RelayContext with ReactDOMRelayContext, so only the later will inject ReactDOM.unstable_batchedUpdates. And make ReactDOMRelayContext the default for the context property of RelayRenderer:

RelayRenderer.defaultProps = {
  context: ReactDOMRelayContext.getDefaultInstance(),
}

And make RelayStore an alias of ReactDOMRelayContext.getDefaultInstance() for backward compatibility.

cc @josephsavona

[denvned]

RelayRenderer should abort the pending request and run new queries when the Relay context is replaced.

RelayContainer should also react to the change of the context.

[devknoll]

Good catch 👍 Thanks for the feedback!

[denvned]

Since you are deprecating RelayStore, may be RelayContext.getDefaultInstance() is better?

[josephsavona]

relayContext is a required prop, there's no need for a default

[devknoll]

Default was added here because tons of tests are shallow rendering a RelayRenderer. Will update those when I get a chance 👍