relay-compiler 9.0.0 → 10.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 +515 -0
- package/bin/__fixtures__/plugin-module.js.flow +17 -0
- package/bin/relay-compiler +3862 -2505
- package/codegen/CodegenDirectory.js.flow +375 -0
- package/codegen/CodegenRunner.js.flow +432 -0
- package/codegen/CodegenTypes.js.flow +28 -0
- package/codegen/CodegenWatcher.js.flow +254 -0
- package/codegen/NormalizationCodeGenerator.js.flow +571 -0
- package/codegen/ReaderCodeGenerator.js.flow +512 -0
- package/codegen/RelayCodeGenerator.js.flow +85 -0
- package/codegen/RelayFileWriter.js.flow +367 -0
- package/codegen/SourceControl.js.flow +58 -0
- package/codegen/compileRelayArtifacts.js.flow +182 -0
- package/codegen/createPrintRequireModuleDependency.js.flow +21 -0
- package/codegen/sortObjectByKey.js.flow +25 -0
- package/codegen/writeRelayGeneratedFile.js.flow +223 -0
- package/core/ASTCache.js.flow +74 -0
- package/core/ASTConvert.js.flow +233 -0
- package/core/CompilerContext.js.flow +191 -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 +36 -0
- package/core/GraphQLWatchmanClient.js.flow +111 -0
- package/core/IR.js.flow +326 -0
- package/core/IRPrinter.js.flow +477 -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 +138 -0
- package/core/RelayParser.js.flow +1731 -0
- package/core/RelaySourceModuleParser.js.flow +135 -0
- package/core/Schema.js.flow +2037 -0
- package/core/SchemaUtils.js.flow +120 -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 +200 -0
- package/language/RelayLanguagePluginInterface.js.flow +283 -0
- package/language/javascript/FindGraphQLTags.js.flow +137 -0
- package/language/javascript/RelayFlowBabelFactories.js.flow +176 -0
- package/language/javascript/RelayFlowGenerator.js.flow +1099 -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 +127 -130
- package/lib/codegen/CodegenDirectory.js +2 -6
- package/lib/codegen/CodegenRunner.js +37 -76
- package/lib/codegen/CodegenWatcher.js +13 -21
- package/lib/codegen/NormalizationCodeGenerator.js +131 -50
- package/lib/codegen/ReaderCodeGenerator.js +116 -49
- package/lib/codegen/RelayCodeGenerator.js +17 -6
- package/lib/codegen/RelayFileWriter.js +15 -37
- package/lib/codegen/compileRelayArtifacts.js +16 -30
- package/lib/codegen/sortObjectByKey.js +43 -0
- package/lib/codegen/writeRelayGeneratedFile.js +86 -96
- package/lib/core/ASTCache.js +3 -4
- package/lib/core/CompilerContext.js +3 -4
- package/lib/core/CompilerError.js +27 -54
- package/lib/core/GraphQLCompilerProfiler.js +8 -12
- package/lib/core/GraphQLDerivedFromMetadata.js +1 -10
- package/lib/core/GraphQLWatchmanClient.js +4 -12
- package/lib/core/IRPrinter.js +16 -21
- 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 +23 -13
- package/lib/core/RelayParser.js +53 -89
- package/lib/core/RelaySourceModuleParser.js +1 -3
- package/lib/core/Schema.js +106 -77
- package/lib/core/SchemaUtils.js +15 -1
- package/lib/core/getFieldDefinition.js +12 -15
- package/lib/core/getIdentifierForSelection.js +1 -1
- package/lib/core/inferRootArgumentDefinitions.js +27 -36
- package/lib/index.js +1 -3
- package/lib/language/javascript/FindGraphQLTags.js +7 -72
- package/lib/language/javascript/RelayFlowBabelFactories.js +5 -5
- package/lib/language/javascript/RelayFlowGenerator.js +131 -108
- 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 +70 -85
- package/lib/runner/StrictMap.js +21 -37
- package/lib/runner/getChangedNodeNames.js +30 -62
- package/lib/transforms/ApplyFragmentArgumentTransform.js +71 -31
- package/lib/transforms/ClientExtensionsTransform.js +15 -15
- package/lib/transforms/ConnectionTransform.js +26 -38
- package/lib/transforms/DeclarativeConnectionMutationTransform.js +225 -0
- package/lib/transforms/DeferStreamTransform.js +27 -17
- package/lib/transforms/DisallowTypenameOnRoot.js +55 -0
- package/lib/transforms/FieldHandleTransform.js +7 -3
- package/lib/transforms/FilterCompilerDirectivesTransform.js +29 -0
- package/lib/transforms/FlattenTransform.js +23 -19
- package/lib/transforms/GenerateIDFieldTransform.js +56 -35
- package/lib/transforms/GenerateTypeNameTransform.js +84 -10
- package/lib/transforms/InlineDataFragmentTransform.js +9 -4
- package/lib/transforms/MaskTransform.js +17 -17
- package/lib/transforms/MatchTransform.js +114 -32
- package/lib/transforms/ReactFlightComponentTransform.js +162 -0
- package/lib/transforms/RefetchableFragmentTransform.js +21 -17
- package/lib/transforms/RelayDirectiveTransform.js +8 -3
- package/lib/transforms/RequiredFieldTransform.js +380 -0
- package/lib/transforms/SkipClientExtensionsTransform.js +8 -0
- package/lib/transforms/SkipHandleFieldTransform.js +6 -2
- package/lib/transforms/SkipRedundantNodesTransform.js +9 -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 +26 -20
- 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 +22 -3
- package/lib/transforms/query-generators/QueryQueryGenerator.js +2 -1
- 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 +17 -16
- package/lib/util/RelayCompilerCache.js +2 -4
- package/lib/util/argumentContainsVariables.js +37 -0
- package/lib/util/dedupeJSONStringify.js +15 -12
- package/lib/util/generateAbstractTypeRefinementKey.js +24 -0
- package/lib/util/getModuleName.js +1 -1
- package/lib/util/joinArgumentDefinitions.js +3 -1
- package/package.json +7 -7
- 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 +228 -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 +526 -0
- package/transforms/ClientExtensionsTransform.js.flow +224 -0
- package/transforms/ConnectionTransform.js.flow +855 -0
- package/transforms/DeclarativeConnectionMutationTransform.js.flow +246 -0
- package/transforms/DeferStreamTransform.js.flow +265 -0
- package/transforms/DisallowIdAsAlias.js.flow +47 -0
- package/transforms/DisallowTypenameOnRoot.js.flow +45 -0
- package/transforms/FieldHandleTransform.js.flow +79 -0
- package/transforms/FilterCompilerDirectivesTransform.js.flow +33 -0
- package/transforms/FilterDirectivesTransform.js.flow +45 -0
- package/transforms/FlattenTransform.js.flow +454 -0
- package/transforms/GenerateIDFieldTransform.js.flow +152 -0
- package/transforms/GenerateTypeNameTransform.js.flow +161 -0
- package/transforms/InlineDataFragmentTransform.js.flow +125 -0
- package/transforms/InlineFragmentsTransform.js.flow +71 -0
- package/transforms/MaskTransform.js.flow +126 -0
- package/transforms/MatchTransform.js.flow +589 -0
- package/transforms/ReactFlightComponentTransform.js.flow +195 -0
- package/transforms/RefetchableFragmentTransform.js.flow +272 -0
- package/transforms/RelayDirectiveTransform.js.flow +97 -0
- package/transforms/RequiredFieldTransform.js.flow +415 -0
- package/transforms/SkipClientExtensionsTransform.js.flow +54 -0
- package/transforms/SkipHandleFieldTransform.js.flow +44 -0
- package/transforms/SkipRedundantNodesTransform.js.flow +257 -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 +142 -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 +189 -0
- package/transforms/query-generators/NodeQueryGenerator.js.flow +219 -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 +76 -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/argumentContainsVariables.js.flow +38 -0
- package/util/dedupeJSONStringify.js.flow +152 -0
- package/util/generateAbstractTypeRefinementKey.js.flow +29 -0
- package/util/getDefinitionNodeHash.js.flow +25 -0
- package/util/getModuleName.js.flow +39 -0
- package/util/joinArgumentDefinitions.js.flow +105 -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,415 @@
|
|
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 partitionArray = require('../util/partitionArray');
|
18
|
+
|
19
|
+
const {createUserError, createCompilerError} = require('../core/CompilerError');
|
20
|
+
const {RelayFeatureFlags} = require('relay-runtime');
|
21
|
+
|
22
|
+
import type CompilerContext from '../core/CompilerContext';
|
23
|
+
import type {
|
24
|
+
LinkedField,
|
25
|
+
ScalarField,
|
26
|
+
Field,
|
27
|
+
Location,
|
28
|
+
InlineFragment,
|
29
|
+
Fragment,
|
30
|
+
Root,
|
31
|
+
Metadata,
|
32
|
+
} from '../core/IR';
|
33
|
+
import type {Schema} from '../core/Schema';
|
34
|
+
import type {RequiredFieldAction} from 'relay-runtime';
|
35
|
+
|
36
|
+
type Path = string;
|
37
|
+
type Alias = string;
|
38
|
+
|
39
|
+
type PathRequiredMap = Map<Path, Field>;
|
40
|
+
|
41
|
+
export type RequiredDirectiveMetadata = {|
|
42
|
+
action: RequiredFieldAction,
|
43
|
+
actionLoc: Location,
|
44
|
+
directiveLoc: Location,
|
45
|
+
path: string,
|
46
|
+
|};
|
47
|
+
|
48
|
+
type State = {|
|
49
|
+
schema: Schema,
|
50
|
+
documentName: string,
|
51
|
+
path: Array<string>,
|
52
|
+
pathRequiredMap: PathRequiredMap,
|
53
|
+
currentNodeRequiredChildren: Map<Alias, Field>,
|
54
|
+
requiredChildrenMap: Map<Path, Map<Alias, Field>>,
|
55
|
+
parentAbstractInlineFragment: ?InlineFragment,
|
56
|
+
|};
|
57
|
+
|
58
|
+
const SCHEMA_EXTENSION = `
|
59
|
+
enum RequiredFieldAction {
|
60
|
+
NONE
|
61
|
+
LOG
|
62
|
+
THROW
|
63
|
+
}
|
64
|
+
directive @required(
|
65
|
+
action: RequiredFieldAction!
|
66
|
+
) on FIELD
|
67
|
+
`;
|
68
|
+
|
69
|
+
/**
|
70
|
+
* This transform rewrites ScalarField and LinkedField nodes with a @required
|
71
|
+
* directive into fields with the directives stripped and sets the `required`
|
72
|
+
* and `path` metadata values.
|
73
|
+
*/
|
74
|
+
function requiredFieldTransform(context: CompilerContext): CompilerContext {
|
75
|
+
const schema = context.getSchema();
|
76
|
+
return IRTransformer.transform(
|
77
|
+
context,
|
78
|
+
{
|
79
|
+
LinkedField: visitLinkedField,
|
80
|
+
ScalarField: vistitScalarField,
|
81
|
+
InlineFragment: visitInlineFragment,
|
82
|
+
Fragment: visitFragment,
|
83
|
+
Root: visitRoot,
|
84
|
+
},
|
85
|
+
node => ({
|
86
|
+
schema,
|
87
|
+
documentName: node.name,
|
88
|
+
path: [],
|
89
|
+
pathRequiredMap: new Map(),
|
90
|
+
currentNodeRequiredChildren: new Map(),
|
91
|
+
requiredChildrenMap: new Map(),
|
92
|
+
parentAbstractInlineFragment: null,
|
93
|
+
}),
|
94
|
+
);
|
95
|
+
}
|
96
|
+
|
97
|
+
function visitFragment(fragment: Fragment, state: State) {
|
98
|
+
return addChildrenCanBubbleMetadata(this.traverse(fragment, state), state);
|
99
|
+
}
|
100
|
+
|
101
|
+
function visitRoot(root: Root, state: State) {
|
102
|
+
return addChildrenCanBubbleMetadata(this.traverse(root, state), state);
|
103
|
+
}
|
104
|
+
|
105
|
+
function visitInlineFragment(fragment: InlineFragment, state: State) {
|
106
|
+
// Ideally we could allow @required when the direct parent inline fragment was
|
107
|
+
// on a concrete type, but we would need to solve this bug in our Flow type
|
108
|
+
// generation first: T65695438
|
109
|
+
const parentAbstractInlineFragment =
|
110
|
+
state.parentAbstractInlineFragment ??
|
111
|
+
getAbstractInlineFragment(fragment, state.schema);
|
112
|
+
|
113
|
+
return this.traverse(fragment, {...state, parentAbstractInlineFragment});
|
114
|
+
}
|
115
|
+
|
116
|
+
function getAbstractInlineFragment(
|
117
|
+
fragment: InlineFragment,
|
118
|
+
schema: Schema,
|
119
|
+
): ?InlineFragment {
|
120
|
+
const {typeCondition} = fragment;
|
121
|
+
if (schema.isAbstractType(typeCondition)) {
|
122
|
+
return fragment;
|
123
|
+
}
|
124
|
+
return null;
|
125
|
+
}
|
126
|
+
|
127
|
+
// Convert action to a number so that we can numerically compare their severity.
|
128
|
+
function getActionSeverity(action: RequiredFieldAction): number {
|
129
|
+
switch (action) {
|
130
|
+
case 'NONE':
|
131
|
+
return 0;
|
132
|
+
case 'LOG':
|
133
|
+
return 1;
|
134
|
+
case 'THROW':
|
135
|
+
return 2;
|
136
|
+
default:
|
137
|
+
(action: empty);
|
138
|
+
throw createCompilerError(`Unhandled action type ${action}`);
|
139
|
+
}
|
140
|
+
}
|
141
|
+
|
142
|
+
function visitLinkedField(field: LinkedField, state: State): LinkedField {
|
143
|
+
const path = [...state.path, field.alias];
|
144
|
+
const newState = {
|
145
|
+
...state,
|
146
|
+
currentNodeRequiredChildren: new Map(),
|
147
|
+
path,
|
148
|
+
parentAbstractInlineFragment: null,
|
149
|
+
};
|
150
|
+
|
151
|
+
let newField = this.traverse(field, newState);
|
152
|
+
|
153
|
+
const pathName = path.join('.');
|
154
|
+
assertCompatibleRequiredChildren(field, pathName, newState);
|
155
|
+
newField = applyDirectives(newField, pathName, state.documentName);
|
156
|
+
assertCompatibleNullability(newField, pathName, newState.pathRequiredMap);
|
157
|
+
|
158
|
+
const directiveMetadata = getRequiredDirectiveMetadata(newField);
|
159
|
+
if (directiveMetadata != null) {
|
160
|
+
assertParentIsNotInvalidInlineFragmet(
|
161
|
+
state.schema,
|
162
|
+
directiveMetadata,
|
163
|
+
state.parentAbstractInlineFragment,
|
164
|
+
);
|
165
|
+
state.currentNodeRequiredChildren.set(field.alias, newField);
|
166
|
+
|
167
|
+
const severity = getActionSeverity(directiveMetadata.action);
|
168
|
+
|
169
|
+
// Assert that all @required children have at least this severity.
|
170
|
+
newState.currentNodeRequiredChildren.forEach(childField => {
|
171
|
+
const childMetadata = getRequiredDirectiveMetadata(childField);
|
172
|
+
if (childMetadata == null) {
|
173
|
+
return;
|
174
|
+
}
|
175
|
+
if (getActionSeverity(childMetadata.action) < severity) {
|
176
|
+
throw createUserError(
|
177
|
+
`The @required field [1] may not have an \`action\` less severe than that of its @required parent [2]. [1] should probably be \`action: ${directiveMetadata.action}\`.`,
|
178
|
+
[childMetadata.actionLoc, directiveMetadata.actionLoc],
|
179
|
+
);
|
180
|
+
}
|
181
|
+
});
|
182
|
+
}
|
183
|
+
|
184
|
+
state.requiredChildrenMap.set(pathName, newState.currentNodeRequiredChildren);
|
185
|
+
return addChildrenCanBubbleMetadata(newField, newState);
|
186
|
+
}
|
187
|
+
|
188
|
+
function vistitScalarField(field: ScalarField, state: State): ScalarField {
|
189
|
+
const pathName = [...state.path, field.alias].join('.');
|
190
|
+
const newField = applyDirectives(field, pathName, state.documentName);
|
191
|
+
const directiveMetadata = getRequiredDirectiveMetadata(newField);
|
192
|
+
if (directiveMetadata != null) {
|
193
|
+
assertParentIsNotInvalidInlineFragmet(
|
194
|
+
state.schema,
|
195
|
+
directiveMetadata,
|
196
|
+
state.parentAbstractInlineFragment,
|
197
|
+
);
|
198
|
+
state.currentNodeRequiredChildren.set(field.alias, newField);
|
199
|
+
}
|
200
|
+
assertCompatibleNullability(newField, pathName, state.pathRequiredMap);
|
201
|
+
return newField;
|
202
|
+
}
|
203
|
+
|
204
|
+
function addChildrenCanBubbleMetadata<T: {|+metadata: Metadata|}>(
|
205
|
+
node: T,
|
206
|
+
state: State,
|
207
|
+
): T {
|
208
|
+
for (const child of state.currentNodeRequiredChildren.values()) {
|
209
|
+
const requiredMetadata = getRequiredDirectiveMetadata(child);
|
210
|
+
if (requiredMetadata != null && requiredMetadata.action !== 'THROW') {
|
211
|
+
const metadata = {...node.metadata, childrenCanBubbleNull: true};
|
212
|
+
return {...node, metadata};
|
213
|
+
}
|
214
|
+
}
|
215
|
+
|
216
|
+
return node;
|
217
|
+
}
|
218
|
+
|
219
|
+
function assertParentIsNotInvalidInlineFragmet(
|
220
|
+
schema: Schema,
|
221
|
+
directiveMetadata: RequiredDirectiveMetadata,
|
222
|
+
parentAbstractInlineFragment: ?InlineFragment,
|
223
|
+
) {
|
224
|
+
if (parentAbstractInlineFragment == null) {
|
225
|
+
return;
|
226
|
+
}
|
227
|
+
const {typeCondition} = parentAbstractInlineFragment;
|
228
|
+
if (schema.isUnion(typeCondition)) {
|
229
|
+
throw createUserError(
|
230
|
+
'The @required directive [1] may not be used anywhere within an inline fragment on a union type [2].',
|
231
|
+
[directiveMetadata.directiveLoc, parentAbstractInlineFragment.loc],
|
232
|
+
);
|
233
|
+
} else if (schema.isInterface(typeCondition)) {
|
234
|
+
throw createUserError(
|
235
|
+
'The @required directive [1] may not be used anywhere within an inline fragment on an interface type [2].',
|
236
|
+
[directiveMetadata.directiveLoc, parentAbstractInlineFragment.loc],
|
237
|
+
);
|
238
|
+
} else {
|
239
|
+
throw createCompilerError('Unexpected abstract inline fragment type.', [
|
240
|
+
parentAbstractInlineFragment.loc,
|
241
|
+
]);
|
242
|
+
}
|
243
|
+
}
|
244
|
+
|
245
|
+
// Check that this field's nullability matches all other instances.
|
246
|
+
function assertCompatibleNullability(
|
247
|
+
field: Field,
|
248
|
+
pathName: string,
|
249
|
+
pathRequiredMap: PathRequiredMap,
|
250
|
+
): void {
|
251
|
+
const existingField = pathRequiredMap.get(pathName);
|
252
|
+
if (existingField == null) {
|
253
|
+
pathRequiredMap.set(pathName, field);
|
254
|
+
return;
|
255
|
+
}
|
256
|
+
|
257
|
+
const requiredMetadata = getRequiredDirectiveMetadata(field);
|
258
|
+
const existingRequiredMetadata = getRequiredDirectiveMetadata(existingField);
|
259
|
+
|
260
|
+
if (requiredMetadata?.action === existingRequiredMetadata?.action) {
|
261
|
+
return;
|
262
|
+
}
|
263
|
+
|
264
|
+
if (requiredMetadata == null) {
|
265
|
+
throw createUserError(
|
266
|
+
`The field "${field.alias}" is @required in [1] but not in [2].`,
|
267
|
+
[existingField.loc, field.loc],
|
268
|
+
);
|
269
|
+
}
|
270
|
+
if (existingRequiredMetadata == null) {
|
271
|
+
throw createUserError(
|
272
|
+
`The field "${field.alias}" is @required in [1] but not in [2].`,
|
273
|
+
[field.loc, existingField.loc],
|
274
|
+
);
|
275
|
+
}
|
276
|
+
throw createUserError(
|
277
|
+
`The field "${field.alias}" has a different @required action in [1] than in [2].`,
|
278
|
+
[requiredMetadata.actionLoc, existingRequiredMetadata.actionLoc],
|
279
|
+
);
|
280
|
+
}
|
281
|
+
|
282
|
+
// Metadata is untyped, so we use this utility function to do the type coersion.
|
283
|
+
function getRequiredDirectiveMetadata(
|
284
|
+
field: Field,
|
285
|
+
): ?RequiredDirectiveMetadata {
|
286
|
+
return (field.metadata?.required: $FlowFixMe);
|
287
|
+
}
|
288
|
+
|
289
|
+
// Check that this field has the same required children as all other instances.
|
290
|
+
function assertCompatibleRequiredChildren(
|
291
|
+
field: LinkedField,
|
292
|
+
fieldPath: string,
|
293
|
+
{currentNodeRequiredChildren, pathRequiredMap, requiredChildrenMap}: State,
|
294
|
+
) {
|
295
|
+
const previouslyRequiredChildren = requiredChildrenMap.get(fieldPath);
|
296
|
+
|
297
|
+
if (previouslyRequiredChildren == null) {
|
298
|
+
return;
|
299
|
+
}
|
300
|
+
|
301
|
+
// Check if this field has a required child field which was previously omitted.
|
302
|
+
for (const [path, childField] of currentNodeRequiredChildren) {
|
303
|
+
if (!previouslyRequiredChildren.has(path)) {
|
304
|
+
const otherParent = pathRequiredMap.get(fieldPath);
|
305
|
+
if (otherParent == null) {
|
306
|
+
throw createCompilerError(
|
307
|
+
`Could not find other parent node at path "${fieldPath}".`,
|
308
|
+
[childField.loc],
|
309
|
+
);
|
310
|
+
}
|
311
|
+
throw createMissingRequiredFieldError(childField, otherParent);
|
312
|
+
}
|
313
|
+
}
|
314
|
+
|
315
|
+
// Check if a previous reference to this field had a required child field which we are missing.
|
316
|
+
for (const [path, childField] of previouslyRequiredChildren) {
|
317
|
+
if (!currentNodeRequiredChildren.has(path)) {
|
318
|
+
throw createMissingRequiredFieldError(childField, field);
|
319
|
+
}
|
320
|
+
}
|
321
|
+
}
|
322
|
+
|
323
|
+
function createMissingRequiredFieldError(
|
324
|
+
requiredChild: Field,
|
325
|
+
missingParent: Field,
|
326
|
+
) {
|
327
|
+
const {alias} = requiredChild;
|
328
|
+
return createUserError(
|
329
|
+
`The field "${alias}" is marked as @required in [1] but is missing in [2].`,
|
330
|
+
[requiredChild.loc, missingParent.loc],
|
331
|
+
);
|
332
|
+
}
|
333
|
+
|
334
|
+
// TODO T74397896: Remove prefix gating once @required is rolled out more broadly.
|
335
|
+
function featureIsEnabled(documentName: string): boolean {
|
336
|
+
const featureFlag = RelayFeatureFlags.ENABLE_REQUIRED_DIRECTIVES;
|
337
|
+
if (typeof featureFlag === 'boolean') {
|
338
|
+
return featureFlag;
|
339
|
+
} else if (featureFlag === 'LIMITED') {
|
340
|
+
return documentName.startsWith('RelayRequiredTest');
|
341
|
+
} else if (typeof featureFlag === 'string') {
|
342
|
+
return featureFlag
|
343
|
+
.split('|')
|
344
|
+
.some(prefix => documentName.startsWith(prefix));
|
345
|
+
}
|
346
|
+
return false;
|
347
|
+
}
|
348
|
+
|
349
|
+
// Strip and validate @required directives, and convert them to metadata.
|
350
|
+
function applyDirectives<T: ScalarField | LinkedField>(
|
351
|
+
field: T,
|
352
|
+
pathName: string,
|
353
|
+
documentName: string,
|
354
|
+
): T {
|
355
|
+
const [requiredDirectives, otherDirectives] = partitionArray(
|
356
|
+
field.directives,
|
357
|
+
directive => directive.name === 'required',
|
358
|
+
);
|
359
|
+
|
360
|
+
if (requiredDirectives.length === 0) {
|
361
|
+
return field;
|
362
|
+
}
|
363
|
+
|
364
|
+
if (!featureIsEnabled(documentName)) {
|
365
|
+
throw new createUserError(
|
366
|
+
// Purposefully don't include details in this error message, since we
|
367
|
+
// don't want folks adopting this feature until it's been tested more.
|
368
|
+
'The @required directive is experimental and not yet supported for use in product code',
|
369
|
+
requiredDirectives.map(x => x.loc),
|
370
|
+
);
|
371
|
+
}
|
372
|
+
|
373
|
+
if (requiredDirectives.length > 1) {
|
374
|
+
throw new createUserError(
|
375
|
+
'Did not expect multiple @required directives.',
|
376
|
+
requiredDirectives.map(x => x.loc),
|
377
|
+
);
|
378
|
+
}
|
379
|
+
|
380
|
+
const requiredDirective = requiredDirectives[0];
|
381
|
+
const arg = requiredDirective.args[0];
|
382
|
+
// I would expect this check to be handled by the schema validation, but...
|
383
|
+
if (arg == null) {
|
384
|
+
throw createUserError(
|
385
|
+
'The @required directive requires an `action` argument.',
|
386
|
+
[requiredDirective.loc],
|
387
|
+
);
|
388
|
+
}
|
389
|
+
if (arg.value.kind !== 'Literal') {
|
390
|
+
throw createUserError(
|
391
|
+
'Expected @required `action` argument to be a literal.',
|
392
|
+
[arg.value.loc],
|
393
|
+
);
|
394
|
+
}
|
395
|
+
|
396
|
+
return {
|
397
|
+
...field,
|
398
|
+
directives: otherDirectives,
|
399
|
+
metadata: {
|
400
|
+
...field.metadata,
|
401
|
+
required: {
|
402
|
+
action: arg.value.value,
|
403
|
+
actionLoc: arg.loc,
|
404
|
+
directiveLoc: requiredDirective.loc,
|
405
|
+
path: pathName,
|
406
|
+
},
|
407
|
+
},
|
408
|
+
};
|
409
|
+
}
|
410
|
+
|
411
|
+
// Transform @required directive to metadata
|
412
|
+
module.exports = {
|
413
|
+
SCHEMA_EXTENSION,
|
414
|
+
transform: requiredFieldTransform,
|
415
|
+
};
|
@@ -0,0 +1,54 @@
|
|
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
|
+
import type CompilerContext from '../core/CompilerContext';
|
18
|
+
import type {ClientExtension, Fragment, FragmentSpread} from '../core/IR';
|
19
|
+
|
20
|
+
function skipClientExtensionTransform(
|
21
|
+
context: CompilerContext,
|
22
|
+
): CompilerContext {
|
23
|
+
return IRTransformer.transform(context, {
|
24
|
+
Fragment: visitFragment,
|
25
|
+
FragmentSpread: vistFragmentSpread,
|
26
|
+
ClientExtension: visitClientExtension,
|
27
|
+
});
|
28
|
+
}
|
29
|
+
|
30
|
+
function visitFragment(node: Fragment): ?Fragment {
|
31
|
+
const context: CompilerContext = this.getContext();
|
32
|
+
if (context.getSchema().isServerType(node.type)) {
|
33
|
+
return this.traverse(node);
|
34
|
+
}
|
35
|
+
return null;
|
36
|
+
}
|
37
|
+
|
38
|
+
function vistFragmentSpread(node: FragmentSpread): ?FragmentSpread {
|
39
|
+
const context: CompilerContext = this.getContext();
|
40
|
+
const fragment = context.getFragment(node.name, node.loc);
|
41
|
+
const isServer = context.getSchema().isServerType(fragment.type);
|
42
|
+
return isServer ? node : null;
|
43
|
+
}
|
44
|
+
|
45
|
+
function visitClientExtension(
|
46
|
+
node: ClientExtension,
|
47
|
+
state: void,
|
48
|
+
): ?ClientExtension {
|
49
|
+
return null;
|
50
|
+
}
|
51
|
+
|
52
|
+
module.exports = {
|
53
|
+
transform: skipClientExtensionTransform,
|
54
|
+
};
|
@@ -0,0 +1,44 @@
|
|
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
|
+
import type CompilerContext from '../core/CompilerContext';
|
18
|
+
import type {Field} from '../core/IR';
|
19
|
+
|
20
|
+
/**
|
21
|
+
* A transform that removes field `handles`. Intended for use when e.g.
|
22
|
+
* printing queries to send to a GraphQL server.
|
23
|
+
*/
|
24
|
+
function skipHandleFieldTransform(context: CompilerContext): CompilerContext {
|
25
|
+
return IRTransformer.transform(context, {
|
26
|
+
LinkedField: visitField,
|
27
|
+
ScalarField: visitField,
|
28
|
+
});
|
29
|
+
}
|
30
|
+
|
31
|
+
function visitField<F: Field>(field: F): ?F {
|
32
|
+
const transformedNode = this.traverse(field);
|
33
|
+
if (transformedNode.handles) {
|
34
|
+
return {
|
35
|
+
...transformedNode,
|
36
|
+
handles: null,
|
37
|
+
};
|
38
|
+
}
|
39
|
+
return transformedNode;
|
40
|
+
}
|
41
|
+
|
42
|
+
module.exports = {
|
43
|
+
transform: skipHandleFieldTransform,
|
44
|
+
};
|