relay-compiler 9.0.0 → 9.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/bin/RelayCompilerBin.js.flow +169 -0
- package/bin/RelayCompilerMain.js.flow +508 -0
- package/bin/__fixtures__/plugin-module.js.flow +17 -0
- package/bin/relay-compiler +2002 -1733
- package/codegen/CodegenDirectory.js.flow +375 -0
- package/codegen/CodegenRunner.js.flow +431 -0
- package/codegen/CodegenTypes.js.flow +28 -0
- package/codegen/CodegenWatcher.js.flow +254 -0
- package/codegen/NormalizationCodeGenerator.js.flow +499 -0
- package/codegen/ReaderCodeGenerator.js.flow +453 -0
- package/codegen/RelayCodeGenerator.js.flow +76 -0
- package/codegen/RelayFileWriter.js.flow +366 -0
- package/codegen/SourceControl.js.flow +58 -0
- package/codegen/compileRelayArtifacts.js.flow +182 -0
- package/codegen/createPrintRequireModuleDependency.js.flow +21 -0
- package/codegen/writeRelayGeneratedFile.js.flow +194 -0
- package/core/ASTCache.js.flow +73 -0
- package/core/ASTConvert.js.flow +233 -0
- package/core/CompilerContext.js.flow +190 -0
- package/core/CompilerError.js.flow +250 -0
- package/core/DotGraphQLParser.js.flow +39 -0
- package/core/GraphQLCompilerProfiler.js.flow +341 -0
- package/core/GraphQLDerivedFromMetadata.js.flow +48 -0
- package/core/GraphQLWatchmanClient.js.flow +111 -0
- package/core/IR.js.flow +329 -0
- package/core/IRPrinter.js.flow +488 -0
- package/core/IRTransformer.js.flow +377 -0
- package/core/IRValidator.js.flow +260 -0
- package/core/IRVisitor.js.flow +150 -0
- package/core/JSModuleParser.js.flow +24 -0
- package/core/RelayCompilerScope.js.flow +199 -0
- package/core/RelayFindGraphQLTags.js.flow +119 -0
- package/core/RelayGraphQLEnumsGenerator.js.flow +55 -0
- package/core/RelayIRTransforms.js.flow +130 -0
- package/core/RelayParser.js.flow +1759 -0
- package/core/RelaySourceModuleParser.js.flow +135 -0
- package/core/Schema.js.flow +1985 -0
- package/core/SchemaUtils.js.flow +109 -0
- package/core/filterContextForNode.js.flow +50 -0
- package/core/getFieldDefinition.js.flow +156 -0
- package/core/getIdentifierForArgumentValue.js.flow +49 -0
- package/core/getIdentifierForSelection.js.flow +69 -0
- package/core/getLiteralArgumentValues.js.flow +32 -0
- package/core/getNormalizationOperationName.js.flow +19 -0
- package/core/inferRootArgumentDefinitions.js.flow +323 -0
- package/index.js +1 -1
- package/index.js.flow +202 -0
- package/language/RelayLanguagePluginInterface.js.flow +283 -0
- package/language/javascript/FindGraphQLTags.js.flow +233 -0
- package/language/javascript/RelayFlowBabelFactories.js.flow +180 -0
- package/language/javascript/RelayFlowGenerator.js.flow +1040 -0
- package/language/javascript/RelayFlowTypeTransformers.js.flow +184 -0
- package/language/javascript/RelayLanguagePluginJavaScript.js.flow +34 -0
- package/language/javascript/formatGeneratedModule.js.flow +65 -0
- package/lib/bin/RelayCompilerBin.js +10 -0
- package/lib/bin/RelayCompilerMain.js +113 -119
- package/lib/codegen/CodegenDirectory.js +2 -6
- package/lib/codegen/CodegenRunner.js +34 -75
- package/lib/codegen/CodegenWatcher.js +13 -21
- package/lib/codegen/NormalizationCodeGenerator.js +43 -40
- package/lib/codegen/ReaderCodeGenerator.js +43 -35
- package/lib/codegen/RelayCodeGenerator.js +7 -5
- package/lib/codegen/RelayFileWriter.js +15 -36
- package/lib/codegen/compileRelayArtifacts.js +16 -30
- package/lib/codegen/writeRelayGeneratedFile.js +56 -98
- package/lib/core/ASTCache.js +1 -3
- package/lib/core/CompilerContext.js +1 -3
- package/lib/core/CompilerError.js +27 -54
- package/lib/core/GraphQLCompilerProfiler.js +8 -12
- package/lib/core/GraphQLWatchmanClient.js +4 -12
- package/lib/core/IRPrinter.js +5 -5
- package/lib/core/IRTransformer.js +8 -6
- package/lib/core/IRValidator.js +1 -3
- package/lib/core/RelayCompilerScope.js +4 -4
- package/lib/core/RelayGraphQLEnumsGenerator.js +12 -15
- package/lib/core/RelayIRTransforms.js +9 -5
- package/lib/core/RelayParser.js +44 -56
- package/lib/core/RelaySourceModuleParser.js +1 -3
- package/lib/core/Schema.js +78 -65
- package/lib/core/getFieldDefinition.js +12 -15
- package/lib/core/getIdentifierForSelection.js +1 -1
- package/lib/core/inferRootArgumentDefinitions.js +27 -36
- package/lib/language/javascript/RelayFlowGenerator.js +49 -78
- package/lib/language/javascript/RelayFlowTypeTransformers.js +1 -3
- package/lib/reporters/ConsoleReporter.js +1 -3
- package/lib/reporters/MultiReporter.js +1 -3
- package/lib/runner/Artifacts.js +69 -170
- package/lib/runner/BufferedFilesystem.js +32 -66
- package/lib/runner/GraphQLASTNodeGroup.js +54 -120
- package/lib/runner/GraphQLNodeMap.js +14 -19
- package/lib/runner/Sources.js +49 -78
- package/lib/runner/StrictMap.js +20 -36
- package/lib/runner/getChangedNodeNames.js +30 -62
- package/lib/transforms/ApplyFragmentArgumentTransform.js +33 -28
- package/lib/transforms/ClientExtensionsTransform.js +7 -12
- package/lib/transforms/ConnectionTransform.js +26 -24
- package/lib/transforms/DeferStreamTransform.js +20 -16
- package/lib/transforms/DisallowTypenameOnRoot.js +55 -0
- package/lib/transforms/FieldHandleTransform.js +6 -2
- package/lib/transforms/FlattenTransform.js +19 -14
- package/lib/transforms/GenerateIDFieldTransform.js +7 -3
- package/lib/transforms/GenerateTypeNameTransform.js +6 -2
- package/lib/transforms/InlineDataFragmentTransform.js +7 -3
- package/lib/transforms/MaskTransform.js +17 -17
- package/lib/transforms/MatchTransform.js +110 -32
- package/lib/transforms/RefetchableFragmentTransform.js +21 -17
- package/lib/transforms/RelayDirectiveTransform.js +11 -3
- package/lib/transforms/SkipClientExtensionsTransform.js +8 -0
- package/lib/transforms/SkipHandleFieldTransform.js +6 -2
- package/lib/transforms/SkipRedundantNodesTransform.js +6 -2
- package/lib/transforms/SkipSplitOperationTransform.js +32 -0
- package/lib/transforms/SkipUnreachableNodeTransform.js +9 -2
- package/lib/transforms/SkipUnusedVariablesTransform.js +18 -17
- package/lib/transforms/SplitModuleImportTransform.js +2 -2
- package/lib/transforms/TestOperationTransform.js +7 -3
- package/lib/transforms/ValidateGlobalVariablesTransform.js +18 -30
- package/lib/transforms/ValidateRequiredArgumentsTransform.js +12 -15
- package/lib/transforms/ValidateServerOnlyDirectivesTransform.js +16 -30
- package/lib/transforms/ValidateUnusedVariablesTransform.js +18 -30
- package/lib/transforms/query-generators/FetchableQueryGenerator.js +161 -0
- package/lib/transforms/query-generators/NodeQueryGenerator.js +7 -2
- package/lib/transforms/query-generators/QueryQueryGenerator.js +1 -0
- package/lib/transforms/query-generators/ViewerQueryGenerator.js +1 -0
- package/lib/transforms/query-generators/index.js +23 -6
- package/lib/transforms/query-generators/utils.js +12 -15
- package/lib/util/RelayCompilerCache.js +1 -3
- package/lib/util/dedupeJSONStringify.js +15 -12
- package/lib/util/getModuleName.js +1 -1
- package/package.json +2 -2
- package/relay-compiler.js +4 -4
- package/relay-compiler.min.js +4 -4
- package/reporters/ConsoleReporter.js.flow +81 -0
- package/reporters/MultiReporter.js.flow +43 -0
- package/reporters/Reporter.js.flow +19 -0
- package/runner/Artifacts.js.flow +219 -0
- package/runner/BufferedFilesystem.js.flow +194 -0
- package/runner/GraphQLASTNodeGroup.js.flow +176 -0
- package/runner/GraphQLASTUtils.js.flow +26 -0
- package/runner/GraphQLNodeMap.js.flow +55 -0
- package/runner/Sources.js.flow +218 -0
- package/runner/StrictMap.js.flow +96 -0
- package/runner/compileArtifacts.js.flow +76 -0
- package/runner/extractAST.js.flow +100 -0
- package/runner/getChangedNodeNames.js.flow +48 -0
- package/runner/getSchemaInstance.js.flow +36 -0
- package/runner/types.js.flow +37 -0
- package/transforms/ApplyFragmentArgumentTransform.js.flow +474 -0
- package/transforms/ClientExtensionsTransform.js.flow +220 -0
- package/transforms/ConnectionTransform.js.flow +869 -0
- package/transforms/DeferStreamTransform.js.flow +258 -0
- package/transforms/DisallowIdAsAlias.js.flow +47 -0
- package/transforms/DisallowTypenameOnRoot.js.flow +45 -0
- package/transforms/FieldHandleTransform.js.flow +80 -0
- package/transforms/FilterDirectivesTransform.js.flow +45 -0
- package/transforms/FlattenTransform.js.flow +456 -0
- package/transforms/GenerateIDFieldTransform.js.flow +134 -0
- package/transforms/GenerateTypeNameTransform.js.flow +81 -0
- package/transforms/InlineDataFragmentTransform.js.flow +124 -0
- package/transforms/InlineFragmentsTransform.js.flow +71 -0
- package/transforms/MaskTransform.js.flow +126 -0
- package/transforms/MatchTransform.js.flow +583 -0
- package/transforms/RefetchableFragmentTransform.js.flow +272 -0
- package/transforms/RelayDirectiveTransform.js.flow +99 -0
- package/transforms/SkipClientExtensionsTransform.js.flow +54 -0
- package/transforms/SkipHandleFieldTransform.js.flow +44 -0
- package/transforms/SkipRedundantNodesTransform.js.flow +253 -0
- package/transforms/SkipSplitOperationTransform.js.flow +37 -0
- package/transforms/SkipUnreachableNodeTransform.js.flow +149 -0
- package/transforms/SkipUnusedVariablesTransform.js.flow +59 -0
- package/transforms/SplitModuleImportTransform.js.flow +98 -0
- package/transforms/TestOperationTransform.js.flow +138 -0
- package/transforms/TransformUtils.js.flow +26 -0
- package/transforms/ValidateGlobalVariablesTransform.js.flow +81 -0
- package/transforms/ValidateRequiredArgumentsTransform.js.flow +127 -0
- package/transforms/ValidateServerOnlyDirectivesTransform.js.flow +112 -0
- package/transforms/ValidateUnusedVariablesTransform.js.flow +89 -0
- package/transforms/query-generators/FetchableQueryGenerator.js.flow +190 -0
- package/transforms/query-generators/NodeQueryGenerator.js.flow +206 -0
- package/transforms/query-generators/QueryQueryGenerator.js.flow +57 -0
- package/transforms/query-generators/ViewerQueryGenerator.js.flow +97 -0
- package/transforms/query-generators/index.js.flow +90 -0
- package/transforms/query-generators/utils.js.flow +72 -0
- package/util/CodeMarker.js.flow +79 -0
- package/util/DefaultHandleKey.js.flow +17 -0
- package/util/RelayCompilerCache.js.flow +88 -0
- package/util/Rollout.js.flow +39 -0
- package/util/TimeReporter.js.flow +79 -0
- package/util/areEqualOSS.js.flow +123 -0
- package/util/dedupeJSONStringify.js.flow +152 -0
- package/util/getDefinitionNodeHash.js.flow +25 -0
- package/util/getModuleName.js.flow +39 -0
- package/util/joinArgumentDefinitions.js.flow +99 -0
- package/util/md5.js.flow +22 -0
- package/util/murmurHash.js.flow +94 -0
- package/util/nullthrowsOSS.js.flow +25 -0
- package/util/orList.js.flow +37 -0
- package/util/partitionArray.js.flow +37 -0
@@ -0,0 +1,583 @@
|
|
1
|
+
/**
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
3
|
+
*
|
4
|
+
* This source code is licensed under the MIT license found in the
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
6
|
+
*
|
7
|
+
* @flow strict-local
|
8
|
+
* @format
|
9
|
+
*/
|
10
|
+
|
11
|
+
// flowlint ambiguous-object-type:error
|
12
|
+
|
13
|
+
'use strict';
|
14
|
+
|
15
|
+
const IRTransformer = require('../core/IRTransformer');
|
16
|
+
|
17
|
+
const getLiteralArgumentValues = require('../core/getLiteralArgumentValues');
|
18
|
+
const getNormalizationOperationName = require('../core/getNormalizationOperationName');
|
19
|
+
|
20
|
+
const {createCompilerError, createUserError} = require('../core/CompilerError');
|
21
|
+
const {getModuleComponentKey, getModuleOperationKey} = require('relay-runtime');
|
22
|
+
|
23
|
+
import type CompilerContext from '../core/CompilerContext';
|
24
|
+
import type {
|
25
|
+
InlineFragment,
|
26
|
+
FragmentSpread,
|
27
|
+
LinkedField,
|
28
|
+
Location,
|
29
|
+
ScalarField,
|
30
|
+
} from '../core/IR';
|
31
|
+
import type {TypeID} from '../core/Schema';
|
32
|
+
|
33
|
+
const SUPPORTED_ARGUMENT_NAME = 'supported';
|
34
|
+
|
35
|
+
const JS_FIELD_TYPE = 'JSDependency';
|
36
|
+
const JS_FIELD_MODULE_ARG = 'module';
|
37
|
+
const JS_FIELD_ID_ARG = 'id';
|
38
|
+
const JS_FIELD_NAME = 'js';
|
39
|
+
|
40
|
+
const SCHEMA_EXTENSION = `
|
41
|
+
directive @match(key: String) on FIELD
|
42
|
+
|
43
|
+
directive @module(
|
44
|
+
name: String!
|
45
|
+
) on FRAGMENT_SPREAD
|
46
|
+
`;
|
47
|
+
|
48
|
+
type State = {|
|
49
|
+
+documentName: string,
|
50
|
+
+parentType: TypeID,
|
51
|
+
+path: Array<LinkedField>,
|
52
|
+
+moduleKey: ?string,
|
53
|
+
+matchesForPath: Map<
|
54
|
+
string,
|
55
|
+
{|
|
56
|
+
+key: string,
|
57
|
+
+location: Location,
|
58
|
+
+types: Map<
|
59
|
+
string,
|
60
|
+
{|+location: Location, +fragment: string, +module: string|},
|
61
|
+
>,
|
62
|
+
|},
|
63
|
+
>,
|
64
|
+
|};
|
65
|
+
|
66
|
+
/**
|
67
|
+
* This transform rewrites LinkedField nodes with @match and rewrites them
|
68
|
+
* into `LinkedField` nodes with a `supported` argument.
|
69
|
+
*/
|
70
|
+
function matchTransform(context: CompilerContext): CompilerContext {
|
71
|
+
return IRTransformer.transform(
|
72
|
+
context,
|
73
|
+
{
|
74
|
+
// TODO: type IRTransformer to allow changing result type
|
75
|
+
FragmentSpread: (visitFragmentSpread: $FlowFixMe),
|
76
|
+
LinkedField: visitLinkedField,
|
77
|
+
InlineFragment: visitInlineFragment,
|
78
|
+
ScalarField: visitScalarField,
|
79
|
+
},
|
80
|
+
node => ({
|
81
|
+
documentName: node.name,
|
82
|
+
matchesForPath: new Map(),
|
83
|
+
moduleKey: null,
|
84
|
+
parentType: node.type,
|
85
|
+
path: [],
|
86
|
+
}),
|
87
|
+
);
|
88
|
+
}
|
89
|
+
|
90
|
+
function visitInlineFragment(
|
91
|
+
node: InlineFragment,
|
92
|
+
state: State,
|
93
|
+
): InlineFragment {
|
94
|
+
return this.traverse(node, {
|
95
|
+
...state,
|
96
|
+
parentType: node.typeCondition,
|
97
|
+
});
|
98
|
+
}
|
99
|
+
|
100
|
+
function visitScalarField(field: ScalarField): ScalarField {
|
101
|
+
const context: CompilerContext = this.getContext();
|
102
|
+
const schema = context.getSchema();
|
103
|
+
|
104
|
+
if (field.name === JS_FIELD_NAME) {
|
105
|
+
const jsModuleType = schema.getTypeFromString(JS_FIELD_TYPE);
|
106
|
+
if (jsModuleType == null || !schema.isServerType(jsModuleType)) {
|
107
|
+
throw new createUserError(
|
108
|
+
`'${JS_FIELD_NAME}' should be defined on the server schema.`,
|
109
|
+
[field.loc],
|
110
|
+
);
|
111
|
+
}
|
112
|
+
|
113
|
+
if (
|
114
|
+
schema.isScalar(jsModuleType) &&
|
115
|
+
schema.areEqualTypes(schema.getRawType(field.type), jsModuleType)
|
116
|
+
) {
|
117
|
+
throw new createUserError(
|
118
|
+
`Direct use of the '${JS_FIELD_NAME}' field is not allowed, use ` +
|
119
|
+
'@match/@module instead.',
|
120
|
+
[field.loc],
|
121
|
+
);
|
122
|
+
}
|
123
|
+
}
|
124
|
+
return field;
|
125
|
+
}
|
126
|
+
|
127
|
+
function visitLinkedField(node: LinkedField, state: State): LinkedField {
|
128
|
+
const context: CompilerContext = this.getContext();
|
129
|
+
const schema = context.getSchema();
|
130
|
+
|
131
|
+
const matchDirective = node.directives.find(
|
132
|
+
directive => directive.name === 'match',
|
133
|
+
);
|
134
|
+
let moduleKey = null;
|
135
|
+
if (matchDirective != null) {
|
136
|
+
({key: moduleKey} = getLiteralArgumentValues(matchDirective.args));
|
137
|
+
if (
|
138
|
+
moduleKey != null &&
|
139
|
+
(typeof moduleKey !== 'string' ||
|
140
|
+
!moduleKey.startsWith(state.documentName))
|
141
|
+
) {
|
142
|
+
throw createUserError(
|
143
|
+
"Expected the 'key' argument of @match to be a literal string starting " +
|
144
|
+
`with the document name, e.g. '${state.documentName}_<localName>'.`,
|
145
|
+
[
|
146
|
+
(
|
147
|
+
matchDirective.args.find(arg => arg.name === 'key') ??
|
148
|
+
matchDirective
|
149
|
+
).loc,
|
150
|
+
],
|
151
|
+
);
|
152
|
+
}
|
153
|
+
}
|
154
|
+
|
155
|
+
state.path.push(node);
|
156
|
+
const transformedNode: LinkedField = this.traverse(node, {
|
157
|
+
...state,
|
158
|
+
moduleKey,
|
159
|
+
parentType: node.type,
|
160
|
+
});
|
161
|
+
state.path.pop();
|
162
|
+
|
163
|
+
if (matchDirective == null) {
|
164
|
+
return transformedNode;
|
165
|
+
}
|
166
|
+
|
167
|
+
const {parentType} = state;
|
168
|
+
const rawType = schema.getRawType(parentType);
|
169
|
+
if (!(schema.isInterface(rawType) || schema.isObject(rawType))) {
|
170
|
+
throw createUserError(
|
171
|
+
`@match used on incompatible field '${transformedNode.name}'.` +
|
172
|
+
'@match may only be used with fields whose parent type is an ' +
|
173
|
+
`interface or object, got invalid type '${schema.getTypeString(
|
174
|
+
parentType,
|
175
|
+
)}'.`,
|
176
|
+
[node.loc],
|
177
|
+
);
|
178
|
+
}
|
179
|
+
|
180
|
+
const currentField = schema.getFieldConfig(
|
181
|
+
schema.expectField(
|
182
|
+
schema.assertCompositeType(rawType),
|
183
|
+
transformedNode.name,
|
184
|
+
),
|
185
|
+
);
|
186
|
+
|
187
|
+
const supportedArgumentDefinition = currentField.args.find(
|
188
|
+
({name}) => name === SUPPORTED_ARGUMENT_NAME,
|
189
|
+
);
|
190
|
+
if (supportedArgumentDefinition == null) {
|
191
|
+
return transformedNode;
|
192
|
+
}
|
193
|
+
|
194
|
+
const supportedArgType = schema.getNullableType(
|
195
|
+
supportedArgumentDefinition.type,
|
196
|
+
);
|
197
|
+
const supportedArgOfType =
|
198
|
+
supportedArgType != null && schema.isList(supportedArgType)
|
199
|
+
? schema.getListItemType(supportedArgType)
|
200
|
+
: null;
|
201
|
+
if (
|
202
|
+
supportedArgType == null ||
|
203
|
+
supportedArgOfType == null ||
|
204
|
+
!schema.isString(schema.getNullableType(supportedArgOfType))
|
205
|
+
) {
|
206
|
+
throw createUserError(
|
207
|
+
`@match used on incompatible field '${transformedNode.name}'. ` +
|
208
|
+
'@match may only be used with fields that accept a ' +
|
209
|
+
"'supported: [String!]!' argument.",
|
210
|
+
[node.loc],
|
211
|
+
);
|
212
|
+
}
|
213
|
+
|
214
|
+
const rawFieldType = schema.getRawType(transformedNode.type);
|
215
|
+
|
216
|
+
if (!schema.isAbstractType(rawFieldType)) {
|
217
|
+
throw createUserError(
|
218
|
+
`@match used on incompatible field '${transformedNode.name}'.` +
|
219
|
+
'@match may only be used with fields that return a union or interface.',
|
220
|
+
[node.loc],
|
221
|
+
);
|
222
|
+
}
|
223
|
+
|
224
|
+
const seenTypes: Map<TypeID, InlineFragment> = new Map();
|
225
|
+
const selections = [];
|
226
|
+
transformedNode.selections.forEach(matchSelection => {
|
227
|
+
if (
|
228
|
+
matchSelection.kind === 'ScalarField' &&
|
229
|
+
matchSelection.name === '__typename'
|
230
|
+
) {
|
231
|
+
selections.push(matchSelection);
|
232
|
+
return;
|
233
|
+
}
|
234
|
+
const moduleImport =
|
235
|
+
matchSelection.kind === 'InlineFragment'
|
236
|
+
? matchSelection.selections[0]
|
237
|
+
: null;
|
238
|
+
if (
|
239
|
+
matchSelection.kind !== 'InlineFragment' ||
|
240
|
+
moduleImport == null ||
|
241
|
+
moduleImport.kind !== 'ModuleImport'
|
242
|
+
) {
|
243
|
+
throw createUserError(
|
244
|
+
'Invalid @match selection: all selections should be ' +
|
245
|
+
'fragment spreads with @module.',
|
246
|
+
[matchSelection.loc],
|
247
|
+
);
|
248
|
+
}
|
249
|
+
const matchedType = matchSelection.typeCondition;
|
250
|
+
seenTypes.set(matchedType, matchSelection);
|
251
|
+
selections.push(matchSelection);
|
252
|
+
});
|
253
|
+
|
254
|
+
if (seenTypes.size === 0) {
|
255
|
+
throw createUserError(
|
256
|
+
'Invalid @match selection: expected at least one @module selection. ' +
|
257
|
+
"Remove @match or add a '...Fragment @module()' selection.",
|
258
|
+
[matchDirective.loc],
|
259
|
+
);
|
260
|
+
}
|
261
|
+
|
262
|
+
const supportedArg = transformedNode.args.find(
|
263
|
+
arg => arg.name === SUPPORTED_ARGUMENT_NAME,
|
264
|
+
);
|
265
|
+
if (supportedArg != null) {
|
266
|
+
throw createUserError(
|
267
|
+
`Invalid @match selection: the '${SUPPORTED_ARGUMENT_NAME}' argument ` +
|
268
|
+
'is automatically added and cannot be supplied explicitly.',
|
269
|
+
[supportedArg.loc],
|
270
|
+
);
|
271
|
+
}
|
272
|
+
|
273
|
+
return {
|
274
|
+
kind: 'LinkedField',
|
275
|
+
alias: transformedNode.alias,
|
276
|
+
args: [
|
277
|
+
...transformedNode.args,
|
278
|
+
{
|
279
|
+
kind: 'Argument',
|
280
|
+
name: SUPPORTED_ARGUMENT_NAME,
|
281
|
+
type: supportedArgumentDefinition.type,
|
282
|
+
value: {
|
283
|
+
kind: 'Literal',
|
284
|
+
loc: node.loc,
|
285
|
+
value: Array.from(seenTypes.keys()).map(type =>
|
286
|
+
schema.getTypeString(type),
|
287
|
+
),
|
288
|
+
},
|
289
|
+
loc: node.loc,
|
290
|
+
},
|
291
|
+
],
|
292
|
+
connection: false,
|
293
|
+
directives: [],
|
294
|
+
handles: null,
|
295
|
+
loc: node.loc,
|
296
|
+
metadata: null,
|
297
|
+
name: transformedNode.name,
|
298
|
+
type: transformedNode.type,
|
299
|
+
selections,
|
300
|
+
};
|
301
|
+
}
|
302
|
+
|
303
|
+
// Transform @module
|
304
|
+
function visitFragmentSpread(
|
305
|
+
spread: FragmentSpread,
|
306
|
+
{documentName, path, matchesForPath, moduleKey: moduleKeyFromParent}: State,
|
307
|
+
): FragmentSpread | InlineFragment {
|
308
|
+
const transformedNode: FragmentSpread = this.traverse(spread);
|
309
|
+
|
310
|
+
const moduleDirective = transformedNode.directives.find(
|
311
|
+
directive => directive.name === 'module',
|
312
|
+
);
|
313
|
+
if (moduleDirective == null) {
|
314
|
+
return transformedNode;
|
315
|
+
}
|
316
|
+
if (spread.args.length !== 0) {
|
317
|
+
throw createUserError(
|
318
|
+
'@module does not support @arguments.',
|
319
|
+
[spread.args[0]?.loc].filter(Boolean),
|
320
|
+
);
|
321
|
+
}
|
322
|
+
|
323
|
+
const context: CompilerContext = this.getContext();
|
324
|
+
const schema = context.getSchema();
|
325
|
+
|
326
|
+
const jsModuleType = schema.asScalarFieldType(
|
327
|
+
schema.getTypeFromString(JS_FIELD_TYPE),
|
328
|
+
);
|
329
|
+
if (jsModuleType == null || !schema.isServerType(jsModuleType)) {
|
330
|
+
throw new createUserError(
|
331
|
+
`'${JS_FIELD_NAME}' should be defined on the server schema.`,
|
332
|
+
[spread.loc],
|
333
|
+
);
|
334
|
+
}
|
335
|
+
|
336
|
+
if (!schema.isScalar(jsModuleType)) {
|
337
|
+
throw createUserError(
|
338
|
+
'Using @module requires the schema to define a scalar ' +
|
339
|
+
`'${JS_FIELD_TYPE}' type.`,
|
340
|
+
);
|
341
|
+
}
|
342
|
+
|
343
|
+
const fragment = context.getFragment(spread.name, spread.loc);
|
344
|
+
if (!schema.isObject(fragment.type)) {
|
345
|
+
throw createUserError(
|
346
|
+
`@module used on invalid fragment spread '...${spread.name}'. @module ` +
|
347
|
+
'may only be used with fragments on a concrete (object) type, ' +
|
348
|
+
`but the fragment has abstract type '${schema.getTypeString(
|
349
|
+
fragment.type,
|
350
|
+
)}'.`,
|
351
|
+
[spread.loc, fragment.loc],
|
352
|
+
);
|
353
|
+
}
|
354
|
+
const field = schema.getFieldByName(fragment.type, JS_FIELD_NAME);
|
355
|
+
if (!field) {
|
356
|
+
throw createUserError(
|
357
|
+
`@module used on invalid fragment spread '...${spread.name}'. @module ` +
|
358
|
+
`requires the fragment type '${schema.getTypeString(
|
359
|
+
fragment.type,
|
360
|
+
)}' to have a ` +
|
361
|
+
`'${JS_FIELD_NAME}(${JS_FIELD_MODULE_ARG}: String! ` +
|
362
|
+
`[${JS_FIELD_ID_ARG}: String]): ${JS_FIELD_TYPE}' field (your ` +
|
363
|
+
"schema may choose to omit the 'id' argument but if present it " +
|
364
|
+
"must accept a 'String').",
|
365
|
+
[moduleDirective.loc],
|
366
|
+
);
|
367
|
+
}
|
368
|
+
const jsField = schema.getFieldConfig(field);
|
369
|
+
|
370
|
+
const jsFieldModuleArg = jsField
|
371
|
+
? jsField.args.find(arg => arg.name === JS_FIELD_MODULE_ARG)
|
372
|
+
: null;
|
373
|
+
const jsFieldIdArg = jsField
|
374
|
+
? jsField.args.find(arg => arg.name === JS_FIELD_ID_ARG)
|
375
|
+
: null;
|
376
|
+
if (
|
377
|
+
jsFieldModuleArg == null ||
|
378
|
+
!schema.isString(schema.getNullableType(jsFieldModuleArg.type)) ||
|
379
|
+
(jsFieldIdArg != null && !schema.isString(jsFieldIdArg.type)) ||
|
380
|
+
jsField.type !== jsModuleType
|
381
|
+
) {
|
382
|
+
throw createUserError(
|
383
|
+
`@module used on invalid fragment spread '...${spread.name}'. @module ` +
|
384
|
+
`requires the fragment type '${schema.getTypeString(
|
385
|
+
fragment.type,
|
386
|
+
)}' to have a ` +
|
387
|
+
`'${JS_FIELD_NAME}(${JS_FIELD_MODULE_ARG}: String! ` +
|
388
|
+
`[${JS_FIELD_ID_ARG}: String]): ${JS_FIELD_TYPE}' field (your ` +
|
389
|
+
"schema may choose to omit the 'id' argument but if present it " +
|
390
|
+
"must accept a 'String').",
|
391
|
+
[moduleDirective.loc],
|
392
|
+
);
|
393
|
+
}
|
394
|
+
|
395
|
+
if (spread.directives.length !== 1) {
|
396
|
+
throw createUserError(
|
397
|
+
`@module used on invalid fragment spread '...${spread.name}'. @module ` +
|
398
|
+
'may not have additional directives.',
|
399
|
+
[spread.loc],
|
400
|
+
);
|
401
|
+
}
|
402
|
+
const {name: moduleName} = getLiteralArgumentValues(moduleDirective.args);
|
403
|
+
if (typeof moduleName !== 'string') {
|
404
|
+
throw createUserError(
|
405
|
+
"Expected the 'name' argument of @module to be a literal string",
|
406
|
+
[(moduleDirective.args.find(arg => arg.name === 'name') ?? spread).loc],
|
407
|
+
);
|
408
|
+
}
|
409
|
+
const parentField = path[path.length - 1];
|
410
|
+
const moduleKey = moduleKeyFromParent ?? documentName;
|
411
|
+
const aliasPath = path.map(x => x.alias).join('.');
|
412
|
+
const moduleId =
|
413
|
+
aliasPath === '' ? documentName : `${documentName}.${aliasPath}`;
|
414
|
+
const typeName = schema.getTypeString(fragment.type);
|
415
|
+
|
416
|
+
let matches = matchesForPath.get(aliasPath);
|
417
|
+
if (matches == null) {
|
418
|
+
if (matchesForPath.size !== 0) {
|
419
|
+
const existingMatchWithKey = Array.from(matchesForPath.values()).find(
|
420
|
+
entry => entry.key === moduleKey,
|
421
|
+
);
|
422
|
+
if (existingMatchWithKey != null) {
|
423
|
+
if (parentField == null) {
|
424
|
+
throw createCompilerError(
|
425
|
+
'Cannot have @module selections at multiple paths unless the selections are within fields.',
|
426
|
+
[spread.loc],
|
427
|
+
);
|
428
|
+
}
|
429
|
+
throw createUserError(
|
430
|
+
'Invalid @module selection: documents with multiple fields ' +
|
431
|
+
"containing 3D selections must specify a unique 'key' value " +
|
432
|
+
`for each field: use '${parentField.alias} @match(key: "${documentName}_<localName>")'.`,
|
433
|
+
[parentField.loc],
|
434
|
+
);
|
435
|
+
}
|
436
|
+
}
|
437
|
+
|
438
|
+
matches = {
|
439
|
+
key: moduleKey,
|
440
|
+
location: parentField?.loc ?? spread.loc,
|
441
|
+
types: new Map(),
|
442
|
+
};
|
443
|
+
matchesForPath.set(aliasPath, matches);
|
444
|
+
}
|
445
|
+
if (moduleKey !== matches.key) {
|
446
|
+
// The user can't override the key locally (per @module),
|
447
|
+
// so this is just an internal sanity check
|
448
|
+
throw createCompilerError(
|
449
|
+
'Invalid @module selection: expected all selections at path ' +
|
450
|
+
`'${aliasPath} to have the same 'key', got '${moduleKey}' and '${matches.key}'.`,
|
451
|
+
[parentField?.loc ?? spread.loc],
|
452
|
+
);
|
453
|
+
}
|
454
|
+
const previousMatchForType = matches.types.get(typeName);
|
455
|
+
if (
|
456
|
+
previousMatchForType != null &&
|
457
|
+
(previousMatchForType.fragment !== spread.name ||
|
458
|
+
previousMatchForType.module !== moduleName)
|
459
|
+
) {
|
460
|
+
throw createUserError(
|
461
|
+
'Invalid @module selection: concrete type ' +
|
462
|
+
`'${typeName}' was matched multiple times at path ` +
|
463
|
+
`'${aliasPath}' but with a different fragment or module name.`,
|
464
|
+
[spread.loc, previousMatchForType.location],
|
465
|
+
);
|
466
|
+
}
|
467
|
+
matches.types.set(typeName, {
|
468
|
+
location: spread.loc,
|
469
|
+
fragment: spread.name,
|
470
|
+
module: moduleName,
|
471
|
+
});
|
472
|
+
|
473
|
+
const normalizationName =
|
474
|
+
getNormalizationOperationName(spread.name) + '.graphql';
|
475
|
+
const componentKey = getModuleComponentKey(moduleKey);
|
476
|
+
const componentField: ScalarField = {
|
477
|
+
alias: componentKey,
|
478
|
+
args: [
|
479
|
+
{
|
480
|
+
kind: 'Argument',
|
481
|
+
name: JS_FIELD_MODULE_ARG,
|
482
|
+
type: jsFieldModuleArg.type,
|
483
|
+
value: {
|
484
|
+
kind: 'Literal',
|
485
|
+
loc: moduleDirective.args[0]?.loc ?? moduleDirective.loc,
|
486
|
+
value: moduleName,
|
487
|
+
},
|
488
|
+
loc: moduleDirective.loc,
|
489
|
+
},
|
490
|
+
jsFieldIdArg != null
|
491
|
+
? {
|
492
|
+
kind: 'Argument',
|
493
|
+
name: JS_FIELD_ID_ARG,
|
494
|
+
type: jsFieldIdArg.type,
|
495
|
+
value: {
|
496
|
+
kind: 'Literal',
|
497
|
+
loc: moduleDirective.args[0]?.loc ?? moduleDirective.loc,
|
498
|
+
value: moduleId,
|
499
|
+
},
|
500
|
+
loc: moduleDirective.loc,
|
501
|
+
}
|
502
|
+
: null,
|
503
|
+
].filter(Boolean),
|
504
|
+
directives: [],
|
505
|
+
handles: null,
|
506
|
+
kind: 'ScalarField',
|
507
|
+
loc: moduleDirective.loc,
|
508
|
+
metadata: {skipNormalizationNode: true},
|
509
|
+
name: JS_FIELD_NAME,
|
510
|
+
type: jsModuleType,
|
511
|
+
};
|
512
|
+
const operationKey = getModuleOperationKey(moduleKey);
|
513
|
+
const operationField: ScalarField = {
|
514
|
+
alias: operationKey,
|
515
|
+
args: [
|
516
|
+
{
|
517
|
+
kind: 'Argument',
|
518
|
+
name: JS_FIELD_MODULE_ARG,
|
519
|
+
type: jsFieldModuleArg.type,
|
520
|
+
value: {
|
521
|
+
kind: 'Literal',
|
522
|
+
loc: moduleDirective.loc,
|
523
|
+
value: normalizationName,
|
524
|
+
},
|
525
|
+
loc: moduleDirective.loc,
|
526
|
+
},
|
527
|
+
jsFieldIdArg != null
|
528
|
+
? {
|
529
|
+
kind: 'Argument',
|
530
|
+
name: JS_FIELD_ID_ARG,
|
531
|
+
type: jsFieldIdArg.type,
|
532
|
+
value: {
|
533
|
+
kind: 'Literal',
|
534
|
+
loc: moduleDirective.args[0]?.loc ?? moduleDirective.loc,
|
535
|
+
value: moduleId,
|
536
|
+
},
|
537
|
+
loc: moduleDirective.loc,
|
538
|
+
}
|
539
|
+
: null,
|
540
|
+
].filter(Boolean),
|
541
|
+
directives: [],
|
542
|
+
handles: null,
|
543
|
+
kind: 'ScalarField',
|
544
|
+
loc: moduleDirective.loc,
|
545
|
+
metadata: {skipNormalizationNode: true},
|
546
|
+
name: JS_FIELD_NAME,
|
547
|
+
type: jsModuleType,
|
548
|
+
};
|
549
|
+
|
550
|
+
return {
|
551
|
+
kind: 'InlineFragment',
|
552
|
+
directives: [],
|
553
|
+
loc: moduleDirective.loc,
|
554
|
+
metadata: null,
|
555
|
+
selections: [
|
556
|
+
{
|
557
|
+
kind: 'ModuleImport',
|
558
|
+
loc: moduleDirective.loc,
|
559
|
+
key: moduleKey,
|
560
|
+
id: moduleId,
|
561
|
+
module: moduleName,
|
562
|
+
sourceDocument: documentName,
|
563
|
+
name: spread.name,
|
564
|
+
selections: [
|
565
|
+
{
|
566
|
+
...spread,
|
567
|
+
directives: spread.directives.filter(
|
568
|
+
directive => directive !== moduleDirective,
|
569
|
+
),
|
570
|
+
},
|
571
|
+
operationField,
|
572
|
+
componentField,
|
573
|
+
],
|
574
|
+
},
|
575
|
+
],
|
576
|
+
typeCondition: fragment.type,
|
577
|
+
};
|
578
|
+
}
|
579
|
+
|
580
|
+
module.exports = {
|
581
|
+
SCHEMA_EXTENSION,
|
582
|
+
transform: matchTransform,
|
583
|
+
};
|