relay-compiler 0.0.0-main-4d287de9 → 0.0.0-main-9a79039d

Sign up to get free protection for your applications and to get access to all the features.
Files changed (259) 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 -26
  6. package/win-x64/relay.exe +0 -0
  7. package/bin/RelayCompilerBin.js.flow +0 -168
  8. package/bin/RelayCompilerMain.js.flow +0 -513
  9. package/bin/__fixtures__/plugin-module.js.flow +0 -17
  10. package/bin/relay-compiler +0 -19066
  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 -565
  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 -1731
  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 -486
  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/transforms/ApplyFragmentArgumentTransform.js +0 -393
  130. package/lib/transforms/ClientExtensionsTransform.js +0 -221
  131. package/lib/transforms/ConnectionTransform.js +0 -639
  132. package/lib/transforms/DeclarativeConnectionMutationTransform.js +0 -218
  133. package/lib/transforms/DeferStreamTransform.js +0 -246
  134. package/lib/transforms/DisallowIdAsAlias.js +0 -40
  135. package/lib/transforms/DisallowTypenameOnRoot.js +0 -53
  136. package/lib/transforms/FieldHandleTransform.js +0 -79
  137. package/lib/transforms/FilterCompilerDirectivesTransform.js +0 -29
  138. package/lib/transforms/FilterDirectivesTransform.js +0 -42
  139. package/lib/transforms/FlattenTransform.js +0 -306
  140. package/lib/transforms/GenerateIDFieldTransform.js +0 -135
  141. package/lib/transforms/GenerateTypeNameTransform.js +0 -149
  142. package/lib/transforms/InlineDataFragmentTransform.js +0 -100
  143. package/lib/transforms/InlineFragmentsTransform.js +0 -61
  144. package/lib/transforms/MaskTransform.js +0 -117
  145. package/lib/transforms/MatchTransform.js +0 -434
  146. package/lib/transforms/ReactFlightComponentTransform.js +0 -158
  147. package/lib/transforms/RefetchableFragmentTransform.js +0 -249
  148. package/lib/transforms/RelayDirectiveTransform.js +0 -83
  149. package/lib/transforms/RequiredFieldTransform.js +0 -369
  150. package/lib/transforms/SkipClientExtensionsTransform.js +0 -46
  151. package/lib/transforms/SkipHandleFieldTransform.js +0 -45
  152. package/lib/transforms/SkipRedundantNodesTransform.js +0 -261
  153. package/lib/transforms/SkipSplitOperationTransform.js +0 -32
  154. package/lib/transforms/SkipUnreachableNodeTransform.js +0 -158
  155. package/lib/transforms/SkipUnusedVariablesTransform.js +0 -75
  156. package/lib/transforms/SplitModuleImportTransform.js +0 -82
  157. package/lib/transforms/TestOperationTransform.js +0 -144
  158. package/lib/transforms/TransformUtils.js +0 -21
  159. package/lib/transforms/ValidateGlobalVariablesTransform.js +0 -92
  160. package/lib/transforms/ValidateRequiredArgumentsTransform.js +0 -114
  161. package/lib/transforms/ValidateServerOnlyDirectivesTransform.js +0 -108
  162. package/lib/transforms/ValidateUnusedVariablesTransform.js +0 -96
  163. package/lib/transforms/query-generators/FetchableQueryGenerator.js +0 -157
  164. package/lib/transforms/query-generators/NodeQueryGenerator.js +0 -166
  165. package/lib/transforms/query-generators/QueryQueryGenerator.js +0 -48
  166. package/lib/transforms/query-generators/ViewerQueryGenerator.js +0 -77
  167. package/lib/transforms/query-generators/index.js +0 -60
  168. package/lib/transforms/query-generators/utils.js +0 -92
  169. package/lib/util/CodeMarker.js +0 -80
  170. package/lib/util/DefaultHandleKey.js +0 -15
  171. package/lib/util/RelayCompilerCache.js +0 -97
  172. package/lib/util/Rollout.js +0 -40
  173. package/lib/util/TimeReporter.js +0 -83
  174. package/lib/util/areEqualArgValues.js +0 -135
  175. package/lib/util/argumentContainsVariables.js +0 -37
  176. package/lib/util/dedupeJSONStringify.js +0 -160
  177. package/lib/util/generateAbstractTypeRefinementKey.js +0 -24
  178. package/lib/util/getDefinitionNodeHash.js +0 -22
  179. package/lib/util/getModuleName.js +0 -32
  180. package/lib/util/joinArgumentDefinitions.js +0 -67
  181. package/lib/util/md5.js +0 -17
  182. package/lib/util/murmurHash.js +0 -86
  183. package/lib/util/nullthrowsOSS.js +0 -23
  184. package/lib/util/orList.js +0 -36
  185. package/lib/util/partitionArray.js +0 -35
  186. package/relay-compiler.js +0 -17
  187. package/relay-compiler.min.js +0 -22
  188. package/reporters/ConsoleReporter.js.flow +0 -81
  189. package/reporters/MultiReporter.js.flow +0 -43
  190. package/reporters/Reporter.js.flow +0 -19
  191. package/runner/Artifacts.js.flow +0 -215
  192. package/runner/BufferedFilesystem.js.flow +0 -194
  193. package/runner/GraphQLASTNodeGroup.js.flow +0 -174
  194. package/runner/GraphQLASTUtils.js.flow +0 -26
  195. package/runner/GraphQLNodeMap.js.flow +0 -55
  196. package/runner/Sources.js.flow +0 -227
  197. package/runner/StrictMap.js.flow +0 -96
  198. package/runner/compileArtifacts.js.flow +0 -75
  199. package/runner/extractAST.js.flow +0 -98
  200. package/runner/getChangedNodeNames.js.flow +0 -48
  201. package/runner/getSchemaInstance.js.flow +0 -36
  202. package/runner/types.js.flow +0 -37
  203. package/transforms/ApplyFragmentArgumentTransform.js.flow +0 -524
  204. package/transforms/ClientExtensionsTransform.js.flow +0 -224
  205. package/transforms/ConnectionTransform.js.flow +0 -850
  206. package/transforms/DeclarativeConnectionMutationTransform.js.flow +0 -245
  207. package/transforms/DeferStreamTransform.js.flow +0 -263
  208. package/transforms/DisallowIdAsAlias.js.flow +0 -46
  209. package/transforms/DisallowTypenameOnRoot.js.flow +0 -44
  210. package/transforms/FieldHandleTransform.js.flow +0 -77
  211. package/transforms/FilterCompilerDirectivesTransform.js.flow +0 -33
  212. package/transforms/FilterDirectivesTransform.js.flow +0 -45
  213. package/transforms/FlattenTransform.js.flow +0 -458
  214. package/transforms/GenerateIDFieldTransform.js.flow +0 -151
  215. package/transforms/GenerateTypeNameTransform.js.flow +0 -159
  216. package/transforms/InlineDataFragmentTransform.js.flow +0 -123
  217. package/transforms/InlineFragmentsTransform.js.flow +0 -70
  218. package/transforms/MaskTransform.js.flow +0 -124
  219. package/transforms/MatchTransform.js.flow +0 -587
  220. package/transforms/ReactFlightComponentTransform.js.flow +0 -194
  221. package/transforms/RefetchableFragmentTransform.js.flow +0 -266
  222. package/transforms/RelayDirectiveTransform.js.flow +0 -96
  223. package/transforms/RequiredFieldTransform.js.flow +0 -413
  224. package/transforms/SkipClientExtensionsTransform.js.flow +0 -54
  225. package/transforms/SkipHandleFieldTransform.js.flow +0 -44
  226. package/transforms/SkipRedundantNodesTransform.js.flow +0 -255
  227. package/transforms/SkipSplitOperationTransform.js.flow +0 -37
  228. package/transforms/SkipUnreachableNodeTransform.js.flow +0 -148
  229. package/transforms/SkipUnusedVariablesTransform.js.flow +0 -59
  230. package/transforms/SplitModuleImportTransform.js.flow +0 -97
  231. package/transforms/TestOperationTransform.js.flow +0 -142
  232. package/transforms/TransformUtils.js.flow +0 -26
  233. package/transforms/ValidateGlobalVariablesTransform.js.flow +0 -80
  234. package/transforms/ValidateRequiredArgumentsTransform.js.flow +0 -126
  235. package/transforms/ValidateServerOnlyDirectivesTransform.js.flow +0 -111
  236. package/transforms/ValidateUnusedVariablesTransform.js.flow +0 -88
  237. package/transforms/query-generators/FetchableQueryGenerator.js.flow +0 -188
  238. package/transforms/query-generators/NodeQueryGenerator.js.flow +0 -217
  239. package/transforms/query-generators/QueryQueryGenerator.js.flow +0 -57
  240. package/transforms/query-generators/ViewerQueryGenerator.js.flow +0 -97
  241. package/transforms/query-generators/index.js.flow +0 -89
  242. package/transforms/query-generators/utils.js.flow +0 -76
  243. package/util/CodeMarker.js.flow +0 -79
  244. package/util/DefaultHandleKey.js.flow +0 -17
  245. package/util/RelayCompilerCache.js.flow +0 -86
  246. package/util/Rollout.js.flow +0 -39
  247. package/util/TimeReporter.js.flow +0 -79
  248. package/util/areEqualArgValues.js.flow +0 -126
  249. package/util/argumentContainsVariables.js.flow +0 -38
  250. package/util/dedupeJSONStringify.js.flow +0 -152
  251. package/util/generateAbstractTypeRefinementKey.js.flow +0 -29
  252. package/util/getDefinitionNodeHash.js.flow +0 -24
  253. package/util/getModuleName.js.flow +0 -39
  254. package/util/joinArgumentDefinitions.js.flow +0 -105
  255. package/util/md5.js.flow +0 -19
  256. package/util/murmurHash.js.flow +0 -94
  257. package/util/nullthrowsOSS.js.flow +0 -25
  258. package/util/orList.js.flow +0 -37
  259. package/util/partitionArray.js.flow +0 -37
@@ -1,194 +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
- * @emails oncall+relay
10
- */
11
-
12
- 'use strict';
13
-
14
- import type CompilerContext from '../core/CompilerContext';
15
- import type {ScalarField} from '../core/IR';
16
- import type {InputTypeID, ScalarFieldTypeID, TypeID} from '../core/Schema';
17
-
18
- const {createCompilerError, createUserError} = require('../core/CompilerError');
19
- const IRTransformer = require('../core/IRTransformer');
20
- const {RelayFeatureFlags} = require('relay-runtime');
21
-
22
- const FLIGHT_FIELD_COMPONENT_ARGUMENT_TYPE = 'String';
23
- const FLIGHT_FIELD_COMPONENT_ARGUMENT_NAME = 'component';
24
- const FLIGHT_FIELD_PROPS_ARGUMENT_NAME = 'props';
25
- const FLIGHT_FIELD_PROPS_TYPE = 'ReactFlightProps';
26
- const FLIGHT_FIELD_RETURN_TYPE = 'ReactFlightComponent';
27
-
28
- type State = {
29
- parentType: TypeID,
30
- types: {
31
- propsType: InputTypeID,
32
- componentType: ScalarFieldTypeID,
33
- },
34
- };
35
-
36
- /**
37
- * Experimental transform for React Flight.
38
- */
39
- function reactFlightComponentTransform(
40
- context: CompilerContext,
41
- ): CompilerContext {
42
- const schema = context.getSchema();
43
- let propsType = schema.getTypeFromString(FLIGHT_FIELD_PROPS_TYPE);
44
- propsType = propsType ? schema.asInputType(propsType) : null;
45
- let componentType = schema.getTypeFromString(FLIGHT_FIELD_RETURN_TYPE);
46
- componentType = componentType
47
- ? schema.asScalarFieldType(componentType)
48
- : null;
49
- if (
50
- !RelayFeatureFlags.ENABLE_REACT_FLIGHT_COMPONENT_FIELD ||
51
- propsType == null ||
52
- componentType == null
53
- ) {
54
- return context;
55
- }
56
- const types = {propsType, componentType};
57
- return IRTransformer.transform(
58
- context,
59
- {
60
- ScalarField: visitScalarField,
61
- LinkedField: visitLinkedField,
62
- InlineFragment: visitInlineFragment,
63
- },
64
- node => ({
65
- parentType: node.type,
66
- types,
67
- }),
68
- );
69
- }
70
-
71
- function visitInlineFragment(fragment, state) {
72
- return this.traverse(fragment, {
73
- parentType: fragment.typeCondition ?? state.parentType,
74
- types: state.types,
75
- });
76
- }
77
-
78
- function visitLinkedField(field, state) {
79
- return this.traverse(field, {parentType: field.type, types: state.types});
80
- }
81
-
82
- function visitScalarField(field: ScalarField, state: State): ScalarField {
83
- // use the return type to quickly determine if this is a flight field
84
- const schema = this.getContext().getSchema();
85
- if (schema.getRawType(field.type) !== state.types.componentType) {
86
- return field;
87
- }
88
-
89
- // get the name of the component that provides this field
90
- const clientField = schema.getFieldByName(state.parentType, field.name);
91
- if (clientField == null) {
92
- throw createCompilerError(
93
- `Definition not found for field '${schema.getTypeString(
94
- state.parentType,
95
- )}.${field.name}'`,
96
- [field.loc],
97
- );
98
- }
99
- const componentDirective = clientField.directives.find(
100
- directive => directive.name === 'react_flight_component',
101
- );
102
- const componentNameArg = componentDirective?.args.find(
103
- arg => arg.name === 'name',
104
- );
105
- if (
106
- componentNameArg == null ||
107
- componentNameArg.value.kind !== 'StringValue' ||
108
- typeof componentNameArg.value.value !== 'string'
109
- ) {
110
- throw createUserError(
111
- 'Invalid Flight field, expected the schema extension to specify ' +
112
- "the component's module name with the '@react_flight_component' directive",
113
- [field.loc],
114
- );
115
- }
116
- const componentName = componentNameArg.value.value;
117
-
118
- // validate that the parent type has a `flight(component, props)` field
119
- const flightField = schema.getFieldByName(state.parentType, 'flight');
120
- if (flightField == null) {
121
- throw createUserError(
122
- `Invalid Flight field, expected the parent type '${schema.getTypeString(
123
- state.parentType,
124
- )}' ` +
125
- "to define a 'flight(component: String, props: ReactFlightProps): ReactFlightComponent' field",
126
- [field.loc],
127
- );
128
- }
129
- const componentArg = flightField.args.get(
130
- FLIGHT_FIELD_COMPONENT_ARGUMENT_NAME,
131
- );
132
- const propsArg = flightField.args.get(FLIGHT_FIELD_PROPS_ARGUMENT_NAME);
133
- if (
134
- componentArg == null ||
135
- propsArg == null ||
136
- schema.getRawType(componentArg.type) !==
137
- schema.getTypeFromString(FLIGHT_FIELD_COMPONENT_ARGUMENT_TYPE) ||
138
- schema.getRawType(propsArg.type) !== state.types.propsType ||
139
- schema.getRawType(flightField.type) !== state.types.componentType
140
- ) {
141
- throw createUserError(
142
- `Invalid Flight field, expected the parent type '${schema.getTypeString(
143
- state.parentType,
144
- )}' ` +
145
- "to define a 'flight(component: String, props: ReactFlightProps): ReactFlightComponent' field",
146
- [field.loc],
147
- );
148
- }
149
-
150
- return {
151
- ...field,
152
- name: 'flight',
153
- args: [
154
- {
155
- kind: 'Argument',
156
- loc: field.loc,
157
- name: FLIGHT_FIELD_COMPONENT_ARGUMENT_NAME,
158
- type: schema.getTypeFromString(FLIGHT_FIELD_COMPONENT_ARGUMENT_TYPE),
159
- value: {
160
- kind: 'Literal',
161
- value: componentName,
162
- loc: field.loc,
163
- },
164
- },
165
- {
166
- kind: 'Argument',
167
- loc: field.loc,
168
- name: FLIGHT_FIELD_PROPS_ARGUMENT_NAME,
169
- type: state.types.propsType,
170
- value: {
171
- kind: 'ObjectValue',
172
- fields: field.args.map(arg => {
173
- return {
174
- kind: 'ObjectFieldValue',
175
- loc: arg.loc,
176
- name: arg.name,
177
- value: arg.value,
178
- };
179
- }),
180
- loc: field.loc,
181
- },
182
- },
183
- ],
184
- metadata: {
185
- ...(field.metadata || {}),
186
- flight: true,
187
- },
188
- type: state.types.componentType,
189
- };
190
- }
191
-
192
- module.exports = {
193
- transform: reactFlightComponentTransform,
194
- };
@@ -1,266 +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 {Argument, Field, Fragment} from '../core/IR';
17
- import type {Schema} from '../core/Schema';
18
- import type {ReaderPaginationMetadata} from 'relay-runtime';
19
-
20
- const {
21
- createUserError,
22
- eachWithCombinedError,
23
- } = require('../core/CompilerError');
24
- const getLiteralArgumentValues = require('../core/getLiteralArgumentValues');
25
- const inferRootArgumentDefinitions = require('../core/inferRootArgumentDefinitions');
26
- const IRVisitor = require('../core/IRVisitor');
27
- const {buildRefetchOperation} = require('./query-generators');
28
-
29
- const SCHEMA_EXTENSION = `
30
- directive @refetchable(
31
- queryName: String!
32
- ) on FRAGMENT_DEFINITION
33
- `;
34
-
35
- /**
36
- * This transform synthesizes "refetch" queries for fragments that
37
- * are trivially refetchable. This is comprised of three main stages:
38
- *
39
- * 1. Validating that fragments marked with @refetchable qualify for
40
- * refetch query generation; mainly this means that the fragment
41
- * type is able to be refetched in some canonical way.
42
- * 2. Determining the variable definitions to use for each generated
43
- * query. GraphQL does not have a notion of fragment-local variables
44
- * at all, and although Relay adds this concept developers are still
45
- * allowed to reference global variables. This necessitates a
46
- * visiting all reachable fragments for each @refetchable fragment,
47
- * and finding the union of all global variables expceted to be defined.
48
- * 3. Building the refetch queries, a straightforward copying transform from
49
- * Fragment to Root IR nodes.
50
- */
51
- function refetchableFragmentTransform(
52
- context: CompilerContext,
53
- ): CompilerContext {
54
- const schema = context.getSchema();
55
-
56
- const refetchOperations = buildRefetchMap(context);
57
- let nextContext = context;
58
- eachWithCombinedError(refetchOperations, ([refetchName, fragment]) => {
59
- const {identifierField, path, node, transformedFragment} =
60
- buildRefetchOperation(schema, fragment, refetchName);
61
- const connectionMetadata = extractConnectionMetadata(
62
- context.getSchema(),
63
- transformedFragment,
64
- );
65
- nextContext = nextContext.replace({
66
- ...transformedFragment,
67
- metadata: {
68
- ...(transformedFragment.metadata || {}),
69
- refetch: {
70
- connection: connectionMetadata ?? null,
71
- operation: refetchName,
72
- fragmentPathInResult: path,
73
- identifierField,
74
- },
75
- },
76
- });
77
- nextContext = nextContext.add({
78
- ...node,
79
- metadata: {
80
- ...(node.metadata || {}),
81
- derivedFrom: transformedFragment.name,
82
- isRefetchableQuery: true,
83
- },
84
- });
85
- });
86
- return nextContext;
87
- }
88
-
89
- /**
90
- * Walk the documents of a compiler context and create a mapping of
91
- * refetch operation names to the source fragment from which the refetch
92
- * operation should be derived.
93
- */
94
- function buildRefetchMap(context: CompilerContext): Map<string, Fragment> {
95
- const refetchOperations = new Map();
96
- eachWithCombinedError(context.documents(), node => {
97
- if (node.kind !== 'Fragment') {
98
- return;
99
- }
100
- const refetchName = getRefetchQueryName(node);
101
- if (refetchName === null) {
102
- return;
103
- }
104
- const previousOperation = refetchOperations.get(refetchName);
105
- if (previousOperation != null) {
106
- throw createUserError(
107
- `Duplicate definition for @refetchable operation '${refetchName}' from fragments '${node.name}' and '${previousOperation.name}'`,
108
- [node.loc, previousOperation.loc],
109
- );
110
- }
111
- refetchOperations.set(refetchName, node);
112
- });
113
- const transformed = inferRootArgumentDefinitions(context);
114
- return new Map(
115
- Array.from(refetchOperations.entries(), ([name, fragment]) => {
116
- return [name, transformed.getFragment(fragment.name)];
117
- }),
118
- );
119
- }
120
-
121
- /**
122
- * Validate that any @connection usage is valid for refetching:
123
- * - Variables are used for both the "count" and "cursor" arguments
124
- * (after/first or before/last)
125
- * - Exactly one connection
126
- * - Has a stable path to the connection data
127
- *
128
- * Returns connection metadata to add to the transformed fragment or undefined
129
- * if there is no connection.
130
- */
131
- function extractConnectionMetadata(
132
- schema: Schema,
133
- fragment: Fragment,
134
- ): ReaderPaginationMetadata | void {
135
- const fields = [];
136
- let connectionField = null;
137
- let path = null;
138
- IRVisitor.visit(fragment, {
139
- LinkedField: {
140
- enter(field) {
141
- fields.push(field);
142
- if (
143
- field.connection === true ||
144
- (field.handles &&
145
- field.handles.some(handle => handle.name === 'connection'))
146
- ) {
147
- // Disallow multiple @connections
148
- if (connectionField != null) {
149
- throw createUserError(
150
- `Invalid use of @refetchable with @connection in fragment '${fragment.name}', at most once @connection can appear in a refetchable fragment.`,
151
- [field.loc],
152
- );
153
- }
154
- // Disallow connections within plurals
155
- const pluralOnPath = fields.find(pathField =>
156
- schema.isList(schema.getNullableType(pathField.type)),
157
- );
158
- if (pluralOnPath) {
159
- throw createUserError(
160
- `Invalid use of @refetchable with @connection in fragment '${fragment.name}', refetchable connections cannot appear inside plural fields.`,
161
- [field.loc, pluralOnPath.loc],
162
- );
163
- }
164
- connectionField = field;
165
- path = fields.map(pathField => pathField.alias);
166
- }
167
- },
168
- leave() {
169
- fields.pop();
170
- },
171
- },
172
- });
173
- if (connectionField == null || path == null) {
174
- return;
175
- }
176
- // Validate arguments: if either of before/last appear they must both appear
177
- // and use variables (not scalar values)
178
- let backward = null;
179
- const before = findArgument(connectionField, 'before');
180
- const last = findArgument(connectionField, 'last');
181
- if (before || last) {
182
- if (
183
- !before ||
184
- !last ||
185
- before.value.kind !== 'Variable' ||
186
- last.value.kind !== 'Variable'
187
- ) {
188
- throw createUserError(
189
- `Invalid use of @refetchable with @connection in fragment '${fragment.name}', refetchable connections must use variables for the before and last arguments.`,
190
- [
191
- connectionField.loc,
192
- before && before.value.kind !== 'Variable' ? before.value.loc : null,
193
- last && last.value.kind !== 'Variable' ? last.value.loc : null,
194
- ].filter(Boolean),
195
- );
196
- }
197
- backward = {
198
- count: last.value.variableName,
199
- cursor: before.value.variableName,
200
- };
201
- }
202
- // Validate arguments: if either of after/first appear they must both appear
203
- // and use variables (not scalar values)
204
- let forward = null;
205
- const after = findArgument(connectionField, 'after');
206
- const first = findArgument(connectionField, 'first');
207
- if (after || first) {
208
- if (
209
- !after ||
210
- !first ||
211
- after.value.kind !== 'Variable' ||
212
- first.value.kind !== 'Variable'
213
- ) {
214
- throw createUserError(
215
- `Invalid use of @refetchable with @connection in fragment '${fragment.name}', refetchable connections must use variables for the after and first arguments.`,
216
- [
217
- connectionField.loc,
218
- after && after.value.kind !== 'Variable' ? after.value.loc : null,
219
- first && first.value.kind !== 'Variable' ? first.value.loc : null,
220
- ].filter(Boolean),
221
- );
222
- }
223
- forward = {
224
- count: first.value.variableName,
225
- cursor: after.value.variableName,
226
- };
227
- }
228
- return {forward, backward, path};
229
- }
230
-
231
- function getRefetchQueryName(fragment: Fragment): string | null {
232
- const refetchableDirective = fragment.directives.find(
233
- directive => directive.name === 'refetchable',
234
- );
235
- if (refetchableDirective == null) {
236
- return null;
237
- }
238
- const refetchArguments = getLiteralArgumentValues(refetchableDirective.args);
239
- const queryName = refetchArguments.queryName;
240
- if (queryName == null) {
241
- throw createUserError(
242
- "Expected the 'queryName' argument of @refetchable to be provided",
243
- [refetchableDirective.loc],
244
- );
245
- } else if (typeof queryName !== 'string') {
246
- const queryNameArg = refetchableDirective.args.find(
247
- arg => arg.name === 'queryName',
248
- );
249
- throw createUserError(
250
- `Expected the 'queryName' argument of @refetchable to be a string, got '${String(
251
- queryName,
252
- )}'.`,
253
- [queryNameArg?.loc ?? refetchableDirective.loc],
254
- );
255
- }
256
- return queryName;
257
- }
258
-
259
- function findArgument(field: Field, argumentName: string): Argument | null {
260
- return field.args.find(arg => arg.name === argumentName) ?? null;
261
- }
262
-
263
- module.exports = {
264
- SCHEMA_EXTENSION,
265
- transform: refetchableFragmentTransform,
266
- };
@@ -1,96 +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 {Fragment, FragmentSpread} from '../core/IR';
17
-
18
- const getLiteralArgumentValues = require('../core/getLiteralArgumentValues');
19
- const IRTransformer = require('../core/IRTransformer');
20
- const invariant = require('invariant');
21
-
22
- const RELAY = 'relay';
23
- const SCHEMA_EXTENSION = `
24
- directive @relay(
25
- # Marks a fragment as being backed by a GraphQLList.
26
- plural: Boolean,
27
-
28
- # Marks a fragment spread which should be unmasked if provided false
29
- mask: Boolean = true,
30
- ) on FRAGMENT_DEFINITION | FRAGMENT_SPREAD
31
- `;
32
-
33
- /**
34
- * A transform that extracts `@relay(plural: Boolean)` directives and converts
35
- * them to metadata that can be accessed at runtime.
36
- */
37
- function relayDirectiveTransform(context: CompilerContext): CompilerContext {
38
- return IRTransformer.transform(context, {
39
- Fragment: visitRelayMetadata(fragmentMetadata),
40
- FragmentSpread: visitRelayMetadata(fragmentSpreadMetadata),
41
- });
42
- }
43
-
44
- type MixedObj = {[key: string]: mixed, ...};
45
- function visitRelayMetadata<T: Fragment | FragmentSpread>(
46
- metadataFn: MixedObj => MixedObj,
47
- ): T => T {
48
- return function (node) {
49
- const relayDirective = node.directives.find(({name}) => name === RELAY);
50
- if (!relayDirective) {
51
- return this.traverse(node);
52
- }
53
- const argValues = getLiteralArgumentValues(relayDirective.args);
54
- const metadata = metadataFn(argValues);
55
- return this.traverse({
56
- ...node,
57
- directives: node.directives.filter(
58
- directive => directive !== relayDirective,
59
- ),
60
- // $FlowFixMe[cannot-spread-indexer]
61
- metadata: {
62
- ...(node.metadata || {}),
63
- ...metadata,
64
- },
65
- });
66
- };
67
- }
68
-
69
- function fragmentMetadata({mask, plural}): MixedObj {
70
- invariant(
71
- plural === undefined || typeof plural === 'boolean',
72
- 'RelayDirectiveTransform: Expected the "plural" argument to @relay ' +
73
- 'to be a boolean literal if specified.',
74
- );
75
- invariant(
76
- mask === undefined || typeof mask === 'boolean',
77
- 'RelayDirectiveTransform: Expected the "mask" argument to @relay ' +
78
- 'to be a boolean literal if specified.',
79
- );
80
- return {mask, plural};
81
- }
82
-
83
- function fragmentSpreadMetadata({mask}): MixedObj {
84
- invariant(
85
- mask === undefined || typeof mask === 'boolean',
86
- 'RelayDirectiveTransform: Expected the "mask" argument to @relay ' +
87
- 'to be a boolean literal if specified.',
88
- );
89
- return {mask};
90
- }
91
-
92
- module.exports = {
93
- RELAY,
94
- SCHEMA_EXTENSION,
95
- transform: relayDirectiveTransform,
96
- };