-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
ReactRelayQueryRenderer.js
437 lines (396 loc) · 12 KB
/
ReactRelayQueryRenderer.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
* @format
*/
'use strict';
const React = require('react');
const ReactRelayContext = require('./ReactRelayContext');
const ReactRelayQueryFetcher = require('./ReactRelayQueryFetcher');
const areEqual = require('areEqual');
const {
createOperationDescriptor,
deepFreeze,
getRequest,
} = require('relay-runtime');
import type {FetchPolicy} from './ReactRelayTypes';
import type {
CacheConfig,
GraphQLTaggedNode,
IEnvironment,
RelayContext,
RequestParameters,
Snapshot,
Variables,
} from 'relay-runtime';
type RetryCallbacks = {
handleDataChange:
| null
| (({
error?: Error,
snapshot?: Snapshot,
}) => void),
handleRetryAfterError: null | ((error: Error) => void),
};
export type RenderProps<T> = {|
error: ?Error,
props: ?T,
retry: ?(cacheConfigOverride?: CacheConfig) => void,
|};
/**
* React may double-fire the constructor, and we call 'fetch' in the
* constructor. If a request is already in flight from a previous call to the
* constructor, just reuse the query fetcher and wait for the response.
*/
const requestCache = {};
export type Props = {|
cacheConfig?: ?CacheConfig,
fetchPolicy?: FetchPolicy,
environment: IEnvironment,
query: ?GraphQLTaggedNode,
render: (renderProps: RenderProps<Object>) => React.Node,
variables: Variables,
|};
type State = {|
error: Error | null,
prevPropsEnvironment: IEnvironment,
prevPropsVariables: Variables,
prevQuery: ?GraphQLTaggedNode,
queryFetcher: ReactRelayQueryFetcher,
relayContext: RelayContext,
renderProps: RenderProps<Object>,
retryCallbacks: RetryCallbacks,
requestCacheKey: ?string,
snapshot: Snapshot | null,
|};
/**
* @public
*
* Orchestrates fetching and rendering data for a single view or view hierarchy:
* - Fetches the query/variables using the given network implementation.
* - Normalizes the response(s) to that query, publishing them to the given
* store.
* - Renders the pending/fail/success states with the provided render function.
* - Subscribes for updates to the root data and re-renders with any changes.
*/
class ReactRelayQueryRenderer extends React.Component<Props, State> {
constructor(props: Props) {
super(props);
// Callbacks are attached to the current instance and shared with static
// lifecyles by bundling with state. This is okay to do because the
// callbacks don't change in reaction to props. However we should not
// "leak" them before mounting (since we would be unable to clean up). For
// that reason, we define them as null initially and fill them in after
// mounting to avoid leaking memory.
const retryCallbacks = {
handleDataChange: null,
handleRetryAfterError: null,
};
let queryFetcher;
let requestCacheKey;
if (props.query) {
const {query} = props;
const request = getRequest(query);
requestCacheKey = getRequestCacheKey(request.params, props.variables);
queryFetcher = requestCache[requestCacheKey]
? requestCache[requestCacheKey].queryFetcher
: new ReactRelayQueryFetcher();
} else {
queryFetcher = new ReactRelayQueryFetcher();
}
this.state = {
prevPropsEnvironment: props.environment,
prevPropsVariables: props.variables,
prevQuery: props.query,
queryFetcher,
retryCallbacks,
...fetchQueryAndComputeStateFromProps(
props,
queryFetcher,
retryCallbacks,
requestCacheKey,
),
};
}
static getDerivedStateFromProps(
nextProps: Props,
prevState: State,
): $Shape<State> | null {
if (
prevState.prevQuery !== nextProps.query ||
prevState.prevPropsEnvironment !== nextProps.environment ||
!areEqual(prevState.prevPropsVariables, nextProps.variables)
) {
const {query} = nextProps;
const prevSelectionReferences = prevState.queryFetcher.getSelectionReferences();
prevState.queryFetcher.disposeRequest();
let queryFetcher;
if (query) {
const request = getRequest(query);
const requestCacheKey = getRequestCacheKey(
request.params,
nextProps.variables,
);
queryFetcher = requestCache[requestCacheKey]
? requestCache[requestCacheKey].queryFetcher
: new ReactRelayQueryFetcher(prevSelectionReferences);
} else {
queryFetcher = new ReactRelayQueryFetcher(prevSelectionReferences);
}
return {
prevQuery: nextProps.query,
prevPropsEnvironment: nextProps.environment,
prevPropsVariables: nextProps.variables,
queryFetcher: queryFetcher,
...fetchQueryAndComputeStateFromProps(
nextProps,
queryFetcher,
prevState.retryCallbacks,
// passing no requestCacheKey will cause it to be recalculated internally
// and we want the updated requestCacheKey, since variables may have changed
),
};
}
return null;
}
componentDidMount() {
const {retryCallbacks, queryFetcher, requestCacheKey} = this.state;
if (requestCacheKey) {
delete requestCache[requestCacheKey];
}
retryCallbacks.handleDataChange = (params: {
error?: Error,
snapshot?: Snapshot,
}): void => {
const error = params.error == null ? null : params.error;
const snapshot = params.snapshot == null ? null : params.snapshot;
this.setState(prevState => {
const {requestCacheKey: prevRequestCacheKey} = prevState;
if (prevRequestCacheKey) {
delete requestCache[prevRequestCacheKey];
}
// Don't update state if nothing has changed.
if (snapshot === prevState.snapshot && error === prevState.error) {
return null;
}
return {
renderProps: getRenderProps(
error,
snapshot,
prevState.queryFetcher,
prevState.retryCallbacks,
),
snapshot,
requestCacheKey: null,
};
});
};
retryCallbacks.handleRetryAfterError = (error: Error) =>
this.setState(prevState => {
const {requestCacheKey: prevRequestCacheKey} = prevState;
if (prevRequestCacheKey) {
delete requestCache[prevRequestCacheKey];
}
return {
renderProps: getLoadingRenderProps(),
requestCacheKey: null,
};
});
// Re-initialize the ReactRelayQueryFetcher with callbacks.
// If data has changed since constructions, this will re-render.
if (this.props.query) {
queryFetcher.setOnDataChange(retryCallbacks.handleDataChange);
}
}
componentDidUpdate(): void {
// We don't need to cache the request after the component commits
const {requestCacheKey} = this.state;
if (requestCacheKey) {
delete requestCache[requestCacheKey];
// HACK
delete this.state.requestCacheKey;
}
}
componentWillUnmount(): void {
this.state.queryFetcher.dispose();
}
shouldComponentUpdate(nextProps: Props, nextState: State): boolean {
return (
nextProps.render !== this.props.render ||
nextState.renderProps !== this.state.renderProps
);
}
render(): React.Element<typeof ReactRelayContext.Provider> {
const {renderProps, relayContext} = this.state;
// Note that the root fragment results in `renderProps.props` is already
// frozen by the store; this call is to freeze the renderProps object and
// error property if set.
if (__DEV__) {
deepFreeze(renderProps);
}
return (
<ReactRelayContext.Provider value={relayContext}>
{this.props.render(renderProps)}
</ReactRelayContext.Provider>
);
}
}
function getLoadingRenderProps(): RenderProps<Object> {
return {
error: null,
props: null, // `props: null` indicates that the data is being fetched (i.e. loading)
retry: null,
};
}
function getEmptyRenderProps(): RenderProps<Object> {
return {
error: null,
props: {}, // `props: {}` indicates no data available
retry: null,
};
}
function getRenderProps(
error: ?Error,
snapshot: ?Snapshot,
queryFetcher: ReactRelayQueryFetcher,
retryCallbacks: RetryCallbacks,
): RenderProps<Object> {
return {
error: error ? error : null,
props: snapshot ? snapshot.data : null,
retry: (cacheConfigOverride?: CacheConfig) => {
const syncSnapshot = queryFetcher.retry(cacheConfigOverride);
if (
syncSnapshot &&
typeof retryCallbacks.handleDataChange === 'function'
) {
retryCallbacks.handleDataChange({snapshot: syncSnapshot});
} else if (
error &&
typeof retryCallbacks.handleRetryAfterError === 'function'
) {
// If retrying after an error and no synchronous result available,
// reset the render props
retryCallbacks.handleRetryAfterError(error);
}
},
};
}
function getRequestCacheKey(
request: RequestParameters,
variables: Variables,
): string {
const requestID = request.id || request.text;
return JSON.stringify({
id: String(requestID),
variables,
});
}
function fetchQueryAndComputeStateFromProps(
props: Props,
queryFetcher: ReactRelayQueryFetcher,
retryCallbacks: RetryCallbacks,
requestCacheKey: ?string,
): $Shape<State> {
const {environment, query, variables} = props;
const genericEnvironment = (environment: IEnvironment);
if (query) {
const request = getRequest(query);
const operation = createOperationDescriptor(request, variables);
const relayContext: RelayContext = {
environment: genericEnvironment,
};
if (typeof requestCacheKey === 'string' && requestCache[requestCacheKey]) {
// This same request is already in flight.
const {snapshot} = requestCache[requestCacheKey];
if (snapshot) {
// Use the cached response
return {
error: null,
relayContext,
renderProps: getRenderProps(
null,
snapshot,
queryFetcher,
retryCallbacks,
),
snapshot,
requestCacheKey,
};
} else {
// Render loading state
return {
error: null,
relayContext,
renderProps: getLoadingRenderProps(),
snapshot: null,
requestCacheKey,
};
}
}
try {
const storeSnapshot = queryFetcher.lookupInStore(
genericEnvironment,
operation,
props.fetchPolicy,
);
const querySnapshot = queryFetcher.fetch({
cacheConfig: props.cacheConfig,
environment: genericEnvironment,
onDataChange: retryCallbacks.handleDataChange,
operation,
});
// Use network data first, since it may be fresher
const snapshot = querySnapshot || storeSnapshot;
// cache the request to avoid duplicate requests
requestCacheKey =
requestCacheKey || getRequestCacheKey(request.params, props.variables);
requestCache[requestCacheKey] = {queryFetcher, snapshot};
if (!snapshot) {
return {
error: null,
relayContext,
renderProps: getLoadingRenderProps(),
snapshot: null,
requestCacheKey,
};
}
return {
error: null,
relayContext,
renderProps: getRenderProps(
null,
snapshot,
queryFetcher,
retryCallbacks,
),
snapshot,
requestCacheKey,
};
} catch (error) {
return {
error,
relayContext,
renderProps: getRenderProps(error, null, queryFetcher, retryCallbacks),
snapshot: null,
requestCacheKey,
};
}
} else {
queryFetcher.dispose();
const relayContext: RelayContext = {
environment: genericEnvironment,
};
return {
error: null,
relayContext,
renderProps: getEmptyRenderProps(),
requestCacheKey: null, // if there is an error, don't cache request
};
}
}
module.exports = ReactRelayQueryRenderer;