relay-compiler 0.0.0-main-8ff54d69 → 0.0.0-main-4467ae84

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