-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
intersectRelayQuery.js
137 lines (121 loc) · 4.16 KB
/
intersectRelayQuery.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
/**
* 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 RelayQuery = require('../query/RelayQuery');
const RelayQueryTransform = require('../query/RelayQueryTransform');
const invariant = require('invariant');
const {ConnectionInterface} = require('relay-runtime');
type UnterminatedRangeFilter = (node: RelayQuery.Field) => boolean;
/**
* @internal
*
* `intersectRelayQuery(subjectNode, patternNode)` returns a node with fields in
* `subjectNode` that also exist in `patternNode`. `patternNode` is expected to
* be flattened (and not contain fragments).
*
* If any field in `patternNode` is unterminated (i.e. has no sub-fields), we
* treat the field as though it contains every descendant sub-field.
*
* If `filterUnterminatedRange` is supplied, it will be invoked with any fields
* from `subjectNode` that are connections and unterminated in `patternNode`. If
* it returns true, the `edges` and `page_info` fields will be filtered out.
*/
function intersectRelayQuery<Tn: RelayQuery.Node>(
subjectNode: Tn,
patternNode: RelayQuery.Node,
filterUnterminatedRange?: UnterminatedRangeFilter,
): ?Tn {
filterUnterminatedRange = filterUnterminatedRange || returnsFalse;
const visitor = new RelayQueryIntersector(filterUnterminatedRange);
return visitor.traverse(subjectNode, patternNode);
}
class RelayQueryIntersector extends RelayQueryTransform<RelayQuery.Node> {
_filterUnterminatedRange: UnterminatedRangeFilter;
constructor(filterUnterminatedRange: UnterminatedRangeFilter) {
super();
this._filterUnterminatedRange = filterUnterminatedRange;
}
traverse<Tn: RelayQuery.Node>(
subjectNode: Tn,
patternNode: RelayQuery.Node,
): ?Tn {
if (!subjectNode.canHaveSubselections()) {
// Since `patternNode` exists, `subjectNode` must be in the intersection.
return subjectNode;
}
if (!hasChildren(patternNode)) {
if (
subjectNode instanceof RelayQuery.Field &&
subjectNode.isConnection() &&
this._filterUnterminatedRange(subjectNode)
) {
return filterRangeFields(subjectNode);
}
// Unterminated `patternNode` is the same as containing every descendant
// sub-field, so `subjectNode` must be in the intersection.
return subjectNode;
}
return subjectNode.clone(
subjectNode.getChildren().map(subjectChild => {
if (subjectChild instanceof RelayQuery.Fragment) {
return this.visit(subjectChild, patternNode);
}
if (subjectChild instanceof RelayQuery.Field) {
const schemaName = subjectChild.getSchemaName();
let patternChild;
const patternChildren = patternNode.getChildren();
for (let ii = 0; ii < patternChildren.length; ii++) {
const child = patternChildren[ii];
invariant(
child instanceof RelayQuery.Field,
'intersectRelayQuery(): Nodes in `patternNode` must be fields.',
);
if (child.getSchemaName() === schemaName) {
patternChild = child;
break;
}
}
if (patternChild) {
return this.visit(subjectChild, patternChild);
}
}
return null;
}),
);
}
}
/**
* @private
*/
class RelayQueryRangeFilter extends RelayQueryTransform<void> {
visitField(node: RelayQuery.Field): ?RelayQuery.Node {
const {EDGES, PAGE_INFO} = ConnectionInterface.get();
const schemaName = node.getSchemaName();
if (schemaName === EDGES || schemaName === PAGE_INFO) {
return null;
} else {
return node;
}
}
}
const rangeFilter = new RelayQueryRangeFilter();
function filterRangeFields<Tn: RelayQuery.Field>(node: Tn): ?Tn {
return rangeFilter.traverse(node, undefined);
}
function returnsFalse(): boolean {
return false;
}
function hasChildren(node: RelayQuery.Node): boolean {
return !node.getChildren().every(isGenerated);
}
function isGenerated(node: RelayQuery.Node): boolean {
return node.isGenerated();
}
module.exports = intersectRelayQuery;