relay-compiler 7.0.0 → 9.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (242) hide show
  1. package/bin/RelayCompilerBin.js.flow +169 -0
  2. package/bin/RelayCompilerMain.js.flow +508 -0
  3. package/bin/__fixtures__/plugin-module.js.flow +17 -0
  4. package/bin/relay-compiler +8554 -8142
  5. package/codegen/CodegenDirectory.js.flow +375 -0
  6. package/codegen/CodegenRunner.js.flow +431 -0
  7. package/codegen/CodegenTypes.js.flow +28 -0
  8. package/codegen/CodegenWatcher.js.flow +254 -0
  9. package/codegen/NormalizationCodeGenerator.js.flow +499 -0
  10. package/codegen/ReaderCodeGenerator.js.flow +453 -0
  11. package/codegen/RelayCodeGenerator.js.flow +76 -0
  12. package/codegen/RelayFileWriter.js.flow +366 -0
  13. package/codegen/SourceControl.js.flow +58 -0
  14. package/codegen/compileRelayArtifacts.js.flow +182 -0
  15. package/codegen/createPrintRequireModuleDependency.js.flow +21 -0
  16. package/codegen/writeRelayGeneratedFile.js.flow +194 -0
  17. package/core/ASTCache.js.flow +73 -0
  18. package/core/ASTConvert.js.flow +233 -0
  19. package/core/CompilerContext.js.flow +190 -0
  20. package/core/CompilerError.js.flow +250 -0
  21. package/core/DotGraphQLParser.js.flow +39 -0
  22. package/core/GraphQLCompilerProfiler.js.flow +341 -0
  23. package/core/GraphQLDerivedFromMetadata.js.flow +48 -0
  24. package/core/GraphQLWatchmanClient.js.flow +111 -0
  25. package/core/IR.js.flow +329 -0
  26. package/core/IRPrinter.js.flow +488 -0
  27. package/core/IRTransformer.js.flow +377 -0
  28. package/core/IRValidator.js.flow +260 -0
  29. package/core/IRVisitor.js.flow +150 -0
  30. package/core/JSModuleParser.js.flow +24 -0
  31. package/core/RelayCompilerScope.js.flow +199 -0
  32. package/core/RelayFindGraphQLTags.js.flow +119 -0
  33. package/core/RelayGraphQLEnumsGenerator.js.flow +55 -0
  34. package/core/RelayIRTransforms.js.flow +130 -0
  35. package/core/RelayParser.js.flow +1759 -0
  36. package/core/RelaySourceModuleParser.js.flow +135 -0
  37. package/core/Schema.js.flow +1985 -0
  38. package/core/SchemaUtils.js.flow +109 -0
  39. package/core/filterContextForNode.js.flow +50 -0
  40. package/core/getFieldDefinition.js.flow +156 -0
  41. package/core/getIdentifierForArgumentValue.js.flow +49 -0
  42. package/core/getIdentifierForSelection.js.flow +69 -0
  43. package/core/getLiteralArgumentValues.js.flow +32 -0
  44. package/core/getNormalizationOperationName.js.flow +19 -0
  45. package/core/inferRootArgumentDefinitions.js.flow +323 -0
  46. package/index.js +1 -1
  47. package/index.js.flow +202 -0
  48. package/language/RelayLanguagePluginInterface.js.flow +283 -0
  49. package/language/javascript/FindGraphQLTags.js.flow +233 -0
  50. package/language/javascript/RelayFlowBabelFactories.js.flow +180 -0
  51. package/language/javascript/RelayFlowGenerator.js.flow +1040 -0
  52. package/language/javascript/RelayFlowTypeTransformers.js.flow +184 -0
  53. package/language/javascript/RelayLanguagePluginJavaScript.js.flow +34 -0
  54. package/language/javascript/formatGeneratedModule.js.flow +65 -0
  55. package/lib/bin/RelayCompilerBin.js +25 -7
  56. package/lib/bin/RelayCompilerMain.js +134 -125
  57. package/lib/bin/__fixtures__/plugin-module.js +1 -0
  58. package/lib/codegen/CodegenDirectory.js +14 -8
  59. package/lib/codegen/CodegenRunner.js +35 -75
  60. package/lib/codegen/CodegenTypes.js +1 -0
  61. package/lib/codegen/CodegenWatcher.js +14 -21
  62. package/lib/codegen/NormalizationCodeGenerator.js +80 -127
  63. package/lib/codegen/ReaderCodeGenerator.js +85 -111
  64. package/lib/codegen/RelayCodeGenerator.js +9 -6
  65. package/lib/codegen/RelayFileWriter.js +22 -41
  66. package/lib/codegen/SourceControl.js +1 -0
  67. package/lib/codegen/compileRelayArtifacts.js +18 -31
  68. package/lib/codegen/createPrintRequireModuleDependency.js +1 -0
  69. package/lib/codegen/writeRelayGeneratedFile.js +62 -90
  70. package/lib/core/ASTCache.js +4 -4
  71. package/lib/core/ASTConvert.js +1 -0
  72. package/lib/core/{GraphQLCompilerContext.js → CompilerContext.js} +10 -11
  73. package/lib/core/{RelayCompilerError.js → CompilerError.js} +29 -55
  74. package/lib/core/DotGraphQLParser.js +1 -0
  75. package/lib/core/GraphQLCompilerProfiler.js +9 -12
  76. package/lib/core/GraphQLDerivedFromMetadata.js +1 -0
  77. package/lib/core/GraphQLWatchmanClient.js +5 -12
  78. package/lib/core/{GraphQLIR.js → IR.js} +1 -0
  79. package/lib/core/{GraphQLIRPrinter.js → IRPrinter.js} +39 -17
  80. package/lib/core/{GraphQLIRTransformer.js → IRTransformer.js} +21 -16
  81. package/lib/core/{GraphQLIRValidator.js → IRValidator.js} +18 -10
  82. package/lib/core/{GraphQLIRVisitor.js → IRVisitor.js} +1 -2
  83. package/lib/core/JSModuleParser.js +18 -0
  84. package/lib/core/RelayCompilerScope.js +6 -5
  85. package/lib/core/RelayFindGraphQLTags.js +1 -0
  86. package/lib/core/RelayGraphQLEnumsGenerator.js +26 -12
  87. package/lib/core/RelayIRTransforms.js +12 -9
  88. package/lib/core/RelayParser.js +113 -75
  89. package/lib/core/RelaySourceModuleParser.js +4 -3
  90. package/lib/core/Schema.js +808 -317
  91. package/lib/core/SchemaUtils.js +1 -0
  92. package/lib/core/filterContextForNode.js +5 -4
  93. package/lib/core/getFieldDefinition.js +14 -16
  94. package/lib/core/getIdentifierForArgumentValue.js +18 -0
  95. package/lib/core/getIdentifierForSelection.js +4 -5
  96. package/lib/core/getLiteralArgumentValues.js +1 -0
  97. package/lib/core/getNormalizationOperationName.js +1 -0
  98. package/lib/core/inferRootArgumentDefinitions.js +79 -99
  99. package/lib/index.js +69 -19
  100. package/lib/language/RelayLanguagePluginInterface.js +1 -0
  101. package/lib/language/javascript/FindGraphQLTags.js +1 -0
  102. package/lib/language/javascript/RelayFlowBabelFactories.js +15 -0
  103. package/lib/language/javascript/RelayFlowGenerator.js +94 -173
  104. package/lib/language/javascript/RelayFlowTypeTransformers.js +2 -3
  105. package/lib/language/javascript/RelayLanguagePluginJavaScript.js +7 -4
  106. package/lib/language/javascript/formatGeneratedModule.js +14 -4
  107. package/lib/reporters/ConsoleReporter.js +2 -3
  108. package/lib/reporters/MultiReporter.js +2 -3
  109. package/lib/reporters/Reporter.js +1 -0
  110. package/lib/runner/Artifacts.js +327 -0
  111. package/lib/runner/BufferedFilesystem.js +265 -0
  112. package/lib/runner/GraphQLASTNodeGroup.js +260 -0
  113. package/lib/runner/GraphQLASTUtils.js +23 -0
  114. package/lib/runner/GraphQLNodeMap.js +85 -0
  115. package/lib/runner/Sources.js +266 -0
  116. package/lib/runner/StrictMap.js +136 -0
  117. package/lib/runner/compileArtifacts.js +39 -0
  118. package/lib/runner/extractAST.js +77 -0
  119. package/lib/runner/getChangedNodeNames.js +84 -0
  120. package/lib/runner/getSchemaInstance.js +30 -0
  121. package/lib/runner/types.js +12 -0
  122. package/lib/transforms/ApplyFragmentArgumentTransform.js +49 -55
  123. package/lib/transforms/ClientExtensionsTransform.js +11 -17
  124. package/lib/transforms/ConnectionTransform.js +35 -28
  125. package/lib/transforms/DeferStreamTransform.js +26 -74
  126. package/lib/transforms/DisallowIdAsAlias.js +5 -4
  127. package/lib/transforms/DisallowTypenameOnRoot.js +55 -0
  128. package/lib/transforms/FieldHandleTransform.js +8 -3
  129. package/lib/transforms/FilterDirectivesTransform.js +4 -3
  130. package/lib/transforms/FlattenTransform.js +23 -47
  131. package/lib/transforms/GenerateIDFieldTransform.js +9 -4
  132. package/lib/transforms/GenerateTypeNameTransform.js +8 -3
  133. package/lib/transforms/InlineDataFragmentTransform.js +11 -6
  134. package/lib/transforms/InlineFragmentsTransform.js +3 -2
  135. package/lib/transforms/MaskTransform.js +20 -19
  136. package/lib/transforms/MatchTransform.js +113 -34
  137. package/lib/transforms/RefetchableFragmentTransform.js +25 -41
  138. package/lib/transforms/RelayDirectiveTransform.js +13 -4
  139. package/lib/transforms/SkipClientExtensionsTransform.js +11 -2
  140. package/lib/transforms/SkipHandleFieldTransform.js +8 -3
  141. package/lib/transforms/SkipRedundantNodesTransform.js +9 -6
  142. package/lib/transforms/SkipSplitOperationTransform.js +32 -0
  143. package/lib/transforms/SkipUnreachableNodeTransform.js +12 -12
  144. package/lib/transforms/SkipUnusedVariablesTransform.js +19 -17
  145. package/lib/transforms/SplitModuleImportTransform.js +4 -3
  146. package/lib/transforms/TestOperationTransform.js +9 -6
  147. package/lib/transforms/TransformUtils.js +1 -0
  148. package/lib/transforms/ValidateGlobalVariablesTransform.js +20 -31
  149. package/lib/transforms/ValidateRequiredArgumentsTransform.js +17 -20
  150. package/lib/transforms/ValidateServerOnlyDirectivesTransform.js +20 -33
  151. package/lib/transforms/ValidateUnusedVariablesTransform.js +20 -31
  152. package/lib/transforms/query-generators/FetchableQueryGenerator.js +161 -0
  153. package/lib/transforms/query-generators/NodeQueryGenerator.js +9 -3
  154. package/lib/transforms/query-generators/QueryQueryGenerator.js +2 -0
  155. package/lib/transforms/query-generators/ViewerQueryGenerator.js +6 -3
  156. package/lib/transforms/query-generators/index.js +25 -7
  157. package/lib/transforms/query-generators/utils.js +13 -15
  158. package/lib/util/CodeMarker.js +1 -0
  159. package/lib/util/DefaultHandleKey.js +1 -0
  160. package/lib/util/RelayCompilerCache.js +2 -3
  161. package/lib/util/Rollout.js +1 -0
  162. package/lib/util/TimeReporter.js +83 -0
  163. package/lib/util/areEqualOSS.js +1 -0
  164. package/lib/util/dedupeJSONStringify.js +16 -12
  165. package/lib/util/getDefinitionNodeHash.js +22 -0
  166. package/lib/util/getModuleName.js +4 -5
  167. package/lib/util/joinArgumentDefinitions.js +2 -1
  168. package/lib/util/md5.js +17 -0
  169. package/lib/util/murmurHash.js +1 -0
  170. package/lib/util/nullthrowsOSS.js +1 -0
  171. package/lib/util/orList.js +2 -1
  172. package/lib/util/partitionArray.js +1 -0
  173. package/package.json +4 -4
  174. package/relay-compiler.js +4 -4
  175. package/relay-compiler.min.js +4 -4
  176. package/reporters/ConsoleReporter.js.flow +81 -0
  177. package/reporters/MultiReporter.js.flow +43 -0
  178. package/reporters/Reporter.js.flow +19 -0
  179. package/runner/Artifacts.js.flow +219 -0
  180. package/runner/BufferedFilesystem.js.flow +194 -0
  181. package/runner/GraphQLASTNodeGroup.js.flow +176 -0
  182. package/runner/GraphQLASTUtils.js.flow +26 -0
  183. package/runner/GraphQLNodeMap.js.flow +55 -0
  184. package/runner/Sources.js.flow +218 -0
  185. package/runner/StrictMap.js.flow +96 -0
  186. package/runner/compileArtifacts.js.flow +76 -0
  187. package/runner/extractAST.js.flow +100 -0
  188. package/runner/getChangedNodeNames.js.flow +48 -0
  189. package/runner/getSchemaInstance.js.flow +36 -0
  190. package/runner/types.js.flow +37 -0
  191. package/transforms/ApplyFragmentArgumentTransform.js.flow +474 -0
  192. package/transforms/ClientExtensionsTransform.js.flow +220 -0
  193. package/transforms/ConnectionTransform.js.flow +869 -0
  194. package/transforms/DeferStreamTransform.js.flow +258 -0
  195. package/transforms/DisallowIdAsAlias.js.flow +47 -0
  196. package/transforms/DisallowTypenameOnRoot.js.flow +45 -0
  197. package/transforms/FieldHandleTransform.js.flow +80 -0
  198. package/transforms/FilterDirectivesTransform.js.flow +45 -0
  199. package/transforms/FlattenTransform.js.flow +456 -0
  200. package/transforms/GenerateIDFieldTransform.js.flow +134 -0
  201. package/transforms/GenerateTypeNameTransform.js.flow +81 -0
  202. package/transforms/InlineDataFragmentTransform.js.flow +124 -0
  203. package/transforms/InlineFragmentsTransform.js.flow +71 -0
  204. package/transforms/MaskTransform.js.flow +126 -0
  205. package/transforms/MatchTransform.js.flow +583 -0
  206. package/transforms/RefetchableFragmentTransform.js.flow +272 -0
  207. package/transforms/RelayDirectiveTransform.js.flow +99 -0
  208. package/transforms/SkipClientExtensionsTransform.js.flow +54 -0
  209. package/transforms/SkipHandleFieldTransform.js.flow +44 -0
  210. package/transforms/SkipRedundantNodesTransform.js.flow +253 -0
  211. package/transforms/SkipSplitOperationTransform.js.flow +37 -0
  212. package/transforms/SkipUnreachableNodeTransform.js.flow +149 -0
  213. package/transforms/SkipUnusedVariablesTransform.js.flow +59 -0
  214. package/transforms/SplitModuleImportTransform.js.flow +98 -0
  215. package/transforms/TestOperationTransform.js.flow +138 -0
  216. package/transforms/TransformUtils.js.flow +26 -0
  217. package/transforms/ValidateGlobalVariablesTransform.js.flow +81 -0
  218. package/transforms/ValidateRequiredArgumentsTransform.js.flow +127 -0
  219. package/transforms/ValidateServerOnlyDirectivesTransform.js.flow +112 -0
  220. package/transforms/ValidateUnusedVariablesTransform.js.flow +89 -0
  221. package/transforms/query-generators/FetchableQueryGenerator.js.flow +190 -0
  222. package/transforms/query-generators/NodeQueryGenerator.js.flow +206 -0
  223. package/transforms/query-generators/QueryQueryGenerator.js.flow +57 -0
  224. package/transforms/query-generators/ViewerQueryGenerator.js.flow +97 -0
  225. package/transforms/query-generators/index.js.flow +90 -0
  226. package/transforms/query-generators/utils.js.flow +72 -0
  227. package/util/CodeMarker.js.flow +79 -0
  228. package/util/DefaultHandleKey.js.flow +17 -0
  229. package/util/RelayCompilerCache.js.flow +88 -0
  230. package/util/Rollout.js.flow +39 -0
  231. package/util/TimeReporter.js.flow +79 -0
  232. package/util/areEqualOSS.js.flow +123 -0
  233. package/util/dedupeJSONStringify.js.flow +152 -0
  234. package/util/getDefinitionNodeHash.js.flow +25 -0
  235. package/util/getModuleName.js.flow +39 -0
  236. package/util/joinArgumentDefinitions.js.flow +99 -0
  237. package/util/md5.js.flow +22 -0
  238. package/util/murmurHash.js.flow +94 -0
  239. package/util/nullthrowsOSS.js.flow +25 -0
  240. package/util/orList.js.flow +37 -0
  241. package/util/partitionArray.js.flow +37 -0
  242. package/lib/transforms/ConnectionFieldTransform.js +0 -275
@@ -0,0 +1,150 @@
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
8
+ * @format
9
+ */
10
+
11
+ // flowlint ambiguous-object-type:error
12
+
13
+ 'use strict';
14
+
15
+ const {visit} = require('graphql');
16
+
17
+ import type {
18
+ Argument,
19
+ ClientExtension,
20
+ Condition,
21
+ Defer,
22
+ Directive,
23
+ Fragment,
24
+ FragmentSpread,
25
+ InlineDataFragmentSpread,
26
+ InlineFragment,
27
+ LinkedField,
28
+ Literal,
29
+ LocalArgumentDefinition,
30
+ ModuleImport,
31
+ Request,
32
+ Root,
33
+ RootArgumentDefinition,
34
+ ScalarField,
35
+ SplitOperation,
36
+ Stream,
37
+ Variable,
38
+ } from './IR';
39
+
40
+ const NodeKeys = {
41
+ Argument: ['value'],
42
+ ClientExtension: ['selections'],
43
+ Condition: ['condition', 'selections'],
44
+ Defer: ['selections', 'if'],
45
+ Directive: ['args'],
46
+ Fragment: ['argumentDefinitions', 'directives', 'selections'],
47
+ FragmentSpread: ['args', 'directives'],
48
+ InlineDataFragmentSpread: ['selections'],
49
+ InlineFragment: ['directives', 'selections'],
50
+ LinkedField: ['args', 'directives', 'selections'],
51
+ Literal: [],
52
+ LocalArgumentDefinition: [],
53
+ ModuleImport: ['selections'],
54
+ Request: ['fragment', 'root'],
55
+ Root: ['argumentDefinitions', 'directives', 'selections'],
56
+ RootArgumentDefinition: [],
57
+ ScalarField: ['args', 'directives'],
58
+ SplitOperation: ['selections'],
59
+ Stream: ['selections', 'if', 'initialCount'],
60
+ Variable: [],
61
+ };
62
+
63
+ export type VisitNode =
64
+ | Argument
65
+ | ClientExtension
66
+ | Condition
67
+ | Defer
68
+ | Directive
69
+ | Fragment
70
+ | FragmentSpread
71
+ | InlineDataFragmentSpread
72
+ | InlineFragment
73
+ | LinkedField
74
+ | Literal
75
+ | LocalArgumentDefinition
76
+ | ModuleImport
77
+ | Request
78
+ | Root
79
+ | RootArgumentDefinition
80
+ | ScalarField
81
+ | SplitOperation
82
+ | Stream
83
+ | Variable;
84
+
85
+ type EnterLeave<T> = {|+enter?: T, +leave?: T|};
86
+
87
+ export type VisitFn<T: VisitNode> = (
88
+ node: T, // node we're visiting
89
+ key?: $FlowFixMe, // index/key to node from parent array/object
90
+ parent?: ?(VisitNode | Array<VisitNode>), // Object immediately above node
91
+ path?: Array<$FlowFixMe>, // keys to get from root: [keyForChild, ..., keyForParent]
92
+ ancestors?: Array<VisitNode | Array<VisitNode>>, // [root, child1, ..., grandparent]
93
+ // Note: ancestors includes arrays which contain the visited node
94
+ // These correspond to array indices in `path`.
95
+ ) => $FlowFixMe;
96
+
97
+ export type NodeVisitorObject<T: VisitNode> =
98
+ | EnterLeave<VisitFn<T>>
99
+ | VisitFn<T>;
100
+
101
+ export type NodeVisitor =
102
+ | EnterLeave<{|
103
+ Argument?: VisitFn<Argument>,
104
+ ClientExtension?: VisitFn<ClientExtension>,
105
+ Condition?: VisitFn<Condition>,
106
+ Defer?: VisitFn<Defer>,
107
+ Directive?: VisitFn<Directive>,
108
+ Fragment?: VisitFn<Fragment>,
109
+ FragmentSpread?: VisitFn<FragmentSpread>,
110
+ InlineFragment?: VisitFn<InlineFragment>,
111
+ LinkedField?: VisitFn<LinkedField>,
112
+ Literal?: VisitFn<Literal>,
113
+ LocalArgumentDefinition?: VisitFn<LocalArgumentDefinition>,
114
+ ModuleImport?: VisitFn<ModuleImport>,
115
+ Request?: VisitFn<Request>,
116
+ Root?: VisitFn<Root>,
117
+ RootArgumentDefinition?: VisitFn<RootArgumentDefinition>,
118
+ ScalarField?: VisitFn<ScalarField>,
119
+ SplitOperation?: VisitFn<SplitOperation>,
120
+ Stream?: VisitFn<Stream>,
121
+ Variable?: VisitFn<Variable>,
122
+ |}>
123
+ | {|
124
+ Argument?: NodeVisitorObject<Argument>,
125
+ ClientExtension?: VisitFn<ClientExtension>,
126
+ Condition?: NodeVisitorObject<Condition>,
127
+ Defer?: NodeVisitorObject<Defer>,
128
+ Directive?: NodeVisitorObject<Directive>,
129
+ Fragment?: NodeVisitorObject<Fragment>,
130
+ FragmentSpread?: NodeVisitorObject<FragmentSpread>,
131
+ InlineDataFragmentSpread?: NodeVisitorObject<InlineDataFragmentSpread>,
132
+ InlineFragment?: NodeVisitorObject<InlineFragment>,
133
+ LinkedField?: NodeVisitorObject<LinkedField>,
134
+ Literal?: NodeVisitorObject<Literal>,
135
+ LocalArgumentDefinition?: NodeVisitorObject<LocalArgumentDefinition>,
136
+ ModuleImport?: NodeVisitorObject<ModuleImport>,
137
+ Request?: NodeVisitorObject<Request>,
138
+ Root?: NodeVisitorObject<Root>,
139
+ RootArgumentDefinition?: NodeVisitorObject<RootArgumentDefinition>,
140
+ ScalarField?: NodeVisitorObject<ScalarField>,
141
+ SplitOperation?: NodeVisitorObject<SplitOperation>,
142
+ Stream?: NodeVisitorObject<Stream>,
143
+ Variable?: NodeVisitorObject<Variable>,
144
+ |};
145
+
146
+ function visitIR(root: VisitNode, visitor: NodeVisitor): $FlowFixMe {
147
+ return (visit: $FlowFixMe)(root, visitor, NodeKeys);
148
+ }
149
+
150
+ module.exports = {visit: visitIR};
@@ -0,0 +1,24 @@
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 FindGraphQLTags = require('../language/javascript/FindGraphQLTags');
16
+ const RelaySourceModuleParser = require('./RelaySourceModuleParser');
17
+
18
+ import type {SourceModuleParser} from './RelaySourceModuleParser';
19
+
20
+ const JSModuleParser: SourceModuleParser = RelaySourceModuleParser(
21
+ FindGraphQLTags.find,
22
+ );
23
+
24
+ module.exports = JSModuleParser;
@@ -0,0 +1,199 @@
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 {createUserError, eachWithCombinedError} = require('./CompilerError');
16
+
17
+ import type {
18
+ Argument,
19
+ ArgumentDefinition,
20
+ ArgumentValue,
21
+ FragmentSpread,
22
+ LocalArgumentDefinition,
23
+ Variable,
24
+ } from './IR';
25
+ import type {Schema} from './Schema';
26
+ /**
27
+ * A scope is a mapping of the values for each argument defined by the nearest
28
+ * ancestor root or fragment of a given IR selection. A scope maps argument
29
+ * names to the argument's statically determined value, which can be either a
30
+ * variable or a literal.
31
+ *
32
+ * There are two categories of scopes: root scopes and fragment scopes.
33
+ *
34
+ * Root scopes apply to `Root` IR and their subselections, up until any fragment
35
+ * spreads. Root scopes have the property that any argument may be provided at
36
+ * runtime: even where a default value is defined, the compiler must consider
37
+ * the value to be variable. Therefore, root scopes are a mapping of argument
38
+ * name to variables of the same name:
39
+ *
40
+ * Map {
41
+ * foo: $foo
42
+ * }
43
+ *
44
+ * Fragment scopes apply to `Fragment` IR nodes and their subselections, up
45
+ * until any fragment spreads. Fragment scopes differ from root scopes in
46
+ * several ways:
47
+ * - Arguments may be overridden by the including fragment spread.
48
+ * - Arguments may import values from the root scope.
49
+ * - All other arguments must have their default values, or be null.
50
+ *
51
+ * Fragment scopes are also a mapping of argument name to value, but the value
52
+ * may also be a literal:
53
+ *
54
+ * Map {
55
+ * foo: $foo
56
+ * bar: 42
57
+ * }
58
+ */
59
+ export type Scope = {[key: string]: ArgumentValue, ...};
60
+
61
+ /**
62
+ * Creates a scope for a `Root`, with each argument mapped to a variable of the
63
+ * same name. Example:
64
+ *
65
+ * Query:
66
+ * query Foo($id: ID, $size: Int = 42) { ... }
67
+ *
68
+ * Scope:
69
+ * {
70
+ * id: $id,
71
+ * size: $size,
72
+ * }
73
+ *
74
+ * Note that even though a default value is defined for $size, the scope must
75
+ * assume that this could be overridden at runtime. The value cannot be decided
76
+ * statically and therefore is set to a variable.
77
+ */
78
+ function getRootScope(
79
+ definitions: $ReadOnlyArray<LocalArgumentDefinition>,
80
+ ): Scope {
81
+ const scope = {};
82
+ definitions.forEach(definition => {
83
+ scope[definition.name] = ({
84
+ kind: 'Variable',
85
+ loc: definition.loc,
86
+ variableName: definition.name,
87
+ type: definition.type,
88
+ }: Variable);
89
+ });
90
+ return scope;
91
+ }
92
+
93
+ /**
94
+ * Creates a scope for a `Fragment` by translating fragment spread arguments in
95
+ * the context of a parent scope into a new scope and validating them against
96
+ * the argument definitions.
97
+ *
98
+ *
99
+ * Parent Scope:
100
+ * {
101
+ * active: $parentActive
102
+ * }
103
+ *
104
+ * Fragment Spread:
105
+ * ...Bar(size: 42, enabled: $active)
106
+ *
107
+ * Fragment:
108
+ * fragment Bar on Foo @argumentDefinitions(
109
+ * id: {type: "ID"}
110
+ * size: {type: "Int"}
111
+ * enabled: {type: "Boolean}
112
+ * scale: {type: "Int", imports: "pixelRatio"}
113
+ * )
114
+ *
115
+ * Scope:
116
+ * {
117
+ * // No argument is provided for $id, it gets the default value which in this
118
+ * // case is `null`:
119
+ * id: null,
120
+ *
121
+ * // The parent passes 42 as a literal value for $size:
122
+ * size: 42,
123
+ *
124
+ * // The parent passes a variable as the value of $enabled. This variable is
125
+ * // resolved in the parent scope to the value $parentActive, which becomes
126
+ * // the value of $enabled:
127
+ * $enabled: $parentActive,
128
+ *
129
+ * // $scale imports pixelRatio from the root scope. Since any argument in a
130
+ * // root scope maps to a variable of the same name, that means the value of
131
+ * // pixelRatio in the root is $pixelRatio:
132
+ * $scale: $pixelRatio,
133
+ * }
134
+ */
135
+ function getFragmentScope(
136
+ schema: Schema,
137
+ definitions: $ReadOnlyArray<ArgumentDefinition>,
138
+ args: $ReadOnlyArray<Argument>,
139
+ parentScope: Scope,
140
+ spread: FragmentSpread,
141
+ ): Scope {
142
+ const argMap = new Map();
143
+ args.forEach(arg => {
144
+ if (arg.value.kind === 'Literal') {
145
+ argMap.set(arg.name, arg.value);
146
+ } else if (arg.value.kind === 'Variable') {
147
+ argMap.set(arg.name, parentScope[arg.value.variableName]);
148
+ }
149
+ });
150
+
151
+ const fragmentScope = {};
152
+ eachWithCombinedError(definitions, definition => {
153
+ if (definition.kind === 'RootArgumentDefinition') {
154
+ if (argMap.has(definition.name)) {
155
+ const argNode = args.find(a => a.name === definition.name);
156
+ throw createUserError(
157
+ `Unexpected argument '${definition.name}' supplied to fragment '${spread.name}'. @arguments may only be provided for variables defined in the fragment's @argumentDefinitions.`,
158
+ [argNode?.loc ?? spread.loc],
159
+ );
160
+ }
161
+ fragmentScope[definition.name] = ({
162
+ kind: 'Variable',
163
+ loc: definition.loc,
164
+ variableName: definition.name,
165
+ type: definition.type,
166
+ }: Variable);
167
+ } else {
168
+ const arg = argMap.get(definition.name);
169
+ if (arg == null || (arg.kind === 'Literal' && arg.value == null)) {
170
+ // No variable or literal null was passed, fall back to default
171
+ // value.
172
+ if (
173
+ definition.defaultValue == null &&
174
+ schema.isNonNull(definition.type)
175
+ ) {
176
+ const argNode = args.find(a => a.name === definition.name);
177
+ throw createUserError(
178
+ `No value found for required argument '${
179
+ definition.name
180
+ }: ${schema.getTypeString(definition.type)}' on fragment '${
181
+ spread.name
182
+ }'.`,
183
+ [argNode?.loc ?? spread.loc],
184
+ );
185
+ }
186
+ fragmentScope[definition.name] = {
187
+ kind: 'Literal',
188
+ value: definition.defaultValue,
189
+ };
190
+ } else {
191
+ // Variable or non-null literal.
192
+ fragmentScope[definition.name] = arg;
193
+ }
194
+ }
195
+ });
196
+ return fragmentScope;
197
+ }
198
+
199
+ module.exports = {getFragmentScope, getRootScope};
@@ -0,0 +1,119 @@
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 RelayCompilerCache = require('../util/RelayCompilerCache');
16
+
17
+ const getModuleName = require('../util/getModuleName');
18
+ const graphql = require('graphql');
19
+ const path = require('path');
20
+ const util = require('util');
21
+
22
+ import type {File} from '../codegen/CodegenTypes';
23
+ import type {
24
+ GraphQLTag,
25
+ GraphQLTagFinder,
26
+ } from '../language/RelayLanguagePluginInterface';
27
+
28
+ const cache = new RelayCompilerCache('RelayFindGraphQLTags', 'v1');
29
+
30
+ function memoizedFind(
31
+ tagFinder: GraphQLTagFinder,
32
+ text: string,
33
+ baseDir: string,
34
+ file: File,
35
+ ): $ReadOnlyArray<string> {
36
+ invariant(
37
+ file.exists,
38
+ 'RelayFindGraphQLTags: Called with non-existent file `%s`',
39
+ file.relPath,
40
+ );
41
+ return cache.getOrCompute(
42
+ file.hash,
43
+ find.bind(null, tagFinder, text, path.join(baseDir, file.relPath)),
44
+ );
45
+ }
46
+
47
+ function find(
48
+ tagFinder: GraphQLTagFinder,
49
+ text: string,
50
+ absPath: string,
51
+ ): $ReadOnlyArray<string> {
52
+ const tags = tagFinder(text, absPath);
53
+ const moduleName = getModuleName(absPath);
54
+ tags.forEach(tag => validateTemplate(tag, moduleName, absPath));
55
+ return tags.map(tag => tag.template);
56
+ }
57
+
58
+ function validateTemplate(
59
+ {template, keyName, sourceLocationOffset}: GraphQLTag,
60
+ moduleName: string,
61
+ filePath: string,
62
+ ) {
63
+ const ast = graphql.parse(
64
+ new graphql.Source(template, filePath, sourceLocationOffset),
65
+ );
66
+ ast.definitions.forEach(def => {
67
+ if (def.kind === 'OperationDefinition') {
68
+ invariant(
69
+ def.name != null,
70
+ 'RelayFindGraphQLTags: In module `%s`, an operation requires a name.',
71
+ moduleName,
72
+ def.kind,
73
+ );
74
+ const definitionName = def.name.value;
75
+ const operationNameParts = definitionName.match(
76
+ /^(.*)(Mutation|Query|Subscription)$/,
77
+ );
78
+ invariant(
79
+ operationNameParts && definitionName.startsWith(moduleName),
80
+ 'RelayFindGraphQLTags: Operation names in graphql tags must be prefixed ' +
81
+ 'with the module name and end in "Mutation", "Query", or ' +
82
+ '"Subscription". Got `%s` in module `%s`.',
83
+ definitionName,
84
+ moduleName,
85
+ );
86
+ } else if (def.kind === 'FragmentDefinition') {
87
+ const definitionName = def.name.value;
88
+ if (keyName != null) {
89
+ invariant(
90
+ definitionName === moduleName + '_' + keyName,
91
+ 'RelayFindGraphQLTags: Container fragment names must be ' +
92
+ '`<ModuleName>_<propName>`. Got `%s`, expected `%s`.',
93
+ definitionName,
94
+ moduleName + '_' + keyName,
95
+ );
96
+ } else {
97
+ invariant(
98
+ definitionName.startsWith(moduleName),
99
+ 'RelayFindGraphQLTags: Fragment names in graphql tags must be prefixed ' +
100
+ 'with the module name. Got `%s` in module `%s`.',
101
+ definitionName,
102
+ moduleName,
103
+ );
104
+ }
105
+ }
106
+ });
107
+ }
108
+
109
+ // TODO: Not sure why this is defined here rather than imported, is it so that it doesn’t get stripped in prod?
110
+ function invariant(condition, msg, ...args) {
111
+ if (!condition) {
112
+ throw new Error(util.format(msg, ...args));
113
+ }
114
+ }
115
+
116
+ module.exports = {
117
+ find, // Exported for testing only.
118
+ memoizedFind,
119
+ };
@@ -0,0 +1,55 @@
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
8
+ * @format
9
+ */
10
+
11
+ // flowlint ambiguous-object-type:error
12
+
13
+ 'use strict';
14
+
15
+ const SignedSource = require('signedsource');
16
+
17
+ import type CodegenDirectory from '../codegen/CodegenDirectory';
18
+ import type {Schema} from '../core/Schema';
19
+
20
+ function writeForSchema(
21
+ schema: Schema,
22
+ licenseHeader: $ReadOnlyArray<string>,
23
+ codegenDir: CodegenDirectory,
24
+ getModuleName: (enumName: string) => string,
25
+ ): void {
26
+ const header =
27
+ '/**\n' +
28
+ licenseHeader.map(line => ` * ${line}\n`).join('') +
29
+ ' *\n' +
30
+ ` * ${SignedSource.getSigningToken()}\n` +
31
+ ' * @flow strict\n' +
32
+ ' */\n' +
33
+ '\n';
34
+
35
+ const enumTypes = schema.getTypes().filter(type => schema.isEnum(type));
36
+
37
+ for (const type of enumTypes) {
38
+ const enumType = schema.assertEnumType(type);
39
+ const name = schema.getTypeString(type);
40
+ const values = [...schema.getEnumValues(enumType)].sort();
41
+ const enumFileContent =
42
+ header +
43
+ `export type ${name} =\n | '` +
44
+ values.join("'\n | '") +
45
+ "'\n | '%future added value';\n";
46
+ codegenDir.writeFile(
47
+ `${getModuleName(name)}.js`,
48
+ SignedSource.signFile(enumFileContent),
49
+ );
50
+ }
51
+ }
52
+
53
+ module.exports = {
54
+ writeForSchema,
55
+ };
@@ -0,0 +1,130 @@
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 ApplyFragmentArgumentTransform = require('../transforms/ApplyFragmentArgumentTransform');
16
+ const ClientExtensionsTransform = require('../transforms/ClientExtensionsTransform');
17
+ const ConnectionTransform = require('../transforms/ConnectionTransform');
18
+ const DeferStreamTransform = require('../transforms/DeferStreamTransform');
19
+ const DisallowIdAsAlias = require('../transforms/DisallowIdAsAlias');
20
+ const DisallowTypenameOnRoot = require('../transforms/DisallowTypenameOnRoot');
21
+ const FieldHandleTransform = require('../transforms/FieldHandleTransform');
22
+ const FilterDirectivesTransform = require('../transforms/FilterDirectivesTransform');
23
+ const FlattenTransform = require('../transforms/FlattenTransform');
24
+ const GenerateIDFieldTransform = require('../transforms/GenerateIDFieldTransform');
25
+ const GenerateTypeNameTransform = require('../transforms/GenerateTypeNameTransform');
26
+ const InlineDataFragmentTransform = require('../transforms/InlineDataFragmentTransform');
27
+ const InlineFragmentsTransform = require('../transforms/InlineFragmentsTransform');
28
+ const MaskTransform = require('../transforms/MaskTransform');
29
+ const MatchTransform = require('../transforms/MatchTransform');
30
+ const RefetchableFragmentTransform = require('../transforms/RefetchableFragmentTransform');
31
+ const RelayDirectiveTransform = require('../transforms/RelayDirectiveTransform');
32
+ const RelayFlowGenerator = require('../language/javascript/RelayFlowGenerator');
33
+ const SkipClientExtensionsTransform = require('../transforms/SkipClientExtensionsTransform');
34
+ const SkipHandleFieldTransform = require('../transforms/SkipHandleFieldTransform');
35
+ const SkipRedundantNodesTransform = require('../transforms/SkipRedundantNodesTransform');
36
+ const SkipSplitOperationTransform = require('../transforms/SkipSplitOperationTransform');
37
+ const SkipUnreachableNodeTransform = require('../transforms/SkipUnreachableNodeTransform');
38
+ const SkipUnusedVariablesTransform = require('../transforms/SkipUnusedVariablesTransform');
39
+ const SplitModuleImportTransform = require('../transforms/SplitModuleImportTransform');
40
+ const TestOperationTransform = require('../transforms/TestOperationTransform');
41
+ const ValidateGlobalVariablesTransform = require('../transforms/ValidateGlobalVariablesTransform');
42
+ const ValidateRequiredArgumentsTransform = require('../transforms/ValidateRequiredArgumentsTransform');
43
+ const ValidateServerOnlyDirectivesTransform = require('../transforms/ValidateServerOnlyDirectivesTransform');
44
+ const ValidateUnusedVariablesTransform = require('../transforms/ValidateUnusedVariablesTransform');
45
+
46
+ import type {IRTransform} from './CompilerContext';
47
+
48
+ // Transforms applied to the code used to process a query response.
49
+ const relaySchemaExtensions: $ReadOnlyArray<string> = [
50
+ ConnectionTransform.SCHEMA_EXTENSION,
51
+ MatchTransform.SCHEMA_EXTENSION,
52
+ RelayDirectiveTransform.SCHEMA_EXTENSION,
53
+ RefetchableFragmentTransform.SCHEMA_EXTENSION,
54
+ TestOperationTransform.SCHEMA_EXTENSION,
55
+ InlineDataFragmentTransform.SCHEMA_EXTENSION,
56
+ RelayFlowGenerator.SCHEMA_EXTENSION,
57
+ ValidateUnusedVariablesTransform.SCHEMA_EXTENSION,
58
+ ];
59
+
60
+ // Transforms applied to both operations and fragments for both reading and
61
+ // writing from the store.
62
+ const relayCommonTransforms: $ReadOnlyArray<IRTransform> = [
63
+ DisallowIdAsAlias.transform,
64
+ ConnectionTransform.transform,
65
+ RelayDirectiveTransform.transform,
66
+ MaskTransform.transform,
67
+ MatchTransform.transform,
68
+ RefetchableFragmentTransform.transform,
69
+ DeferStreamTransform.transform,
70
+ ];
71
+
72
+ // Transforms applied to fragments used for reading data from a store
73
+ const relayFragmentTransforms: $ReadOnlyArray<IRTransform> = [
74
+ ClientExtensionsTransform.transform,
75
+ FieldHandleTransform.transform,
76
+ InlineDataFragmentTransform.transform,
77
+ FlattenTransform.transformWithOptions({isForCodegen: true}),
78
+ SkipRedundantNodesTransform.transform,
79
+ ];
80
+
81
+ // Transforms applied to queries/mutations/subscriptions that are used for
82
+ // fetching data from the server and parsing those responses.
83
+ const relayQueryTransforms: $ReadOnlyArray<IRTransform> = [
84
+ SplitModuleImportTransform.transform,
85
+ DisallowTypenameOnRoot.transform,
86
+ ValidateUnusedVariablesTransform.transform,
87
+ ApplyFragmentArgumentTransform.transform,
88
+ ValidateGlobalVariablesTransform.transform,
89
+ GenerateIDFieldTransform.transform,
90
+ TestOperationTransform.transform,
91
+ ];
92
+
93
+ // Transforms applied to the code used to process a query response.
94
+ const relayCodegenTransforms: $ReadOnlyArray<IRTransform> = [
95
+ SkipUnreachableNodeTransform.transform,
96
+ InlineFragmentsTransform.transform,
97
+ // NOTE: For the codegen context, we make sure to run ClientExtensions
98
+ // transform after we've inlined fragment spreads (i.e. InlineFragmentsTransform)
99
+ // This will ensure that we don't generate nested ClientExtension nodes
100
+ ClientExtensionsTransform.transform,
101
+ FlattenTransform.transformWithOptions({isForCodegen: true}),
102
+ SkipRedundantNodesTransform.transform,
103
+ GenerateTypeNameTransform.transform,
104
+ ValidateServerOnlyDirectivesTransform.transform,
105
+ ];
106
+
107
+ // Transforms applied before printing the query sent to the server.
108
+ const relayPrintTransforms: $ReadOnlyArray<IRTransform> = [
109
+ SkipSplitOperationTransform.transform,
110
+ // NOTE: Skipping client extensions might leave empty selections, which we
111
+ // skip by running SkipUnreachableNodeTransform immediately after.
112
+ ClientExtensionsTransform.transform,
113
+ SkipClientExtensionsTransform.transform,
114
+ SkipUnreachableNodeTransform.transform,
115
+ FlattenTransform.transformWithOptions({}),
116
+ GenerateTypeNameTransform.transform,
117
+ SkipHandleFieldTransform.transform,
118
+ FilterDirectivesTransform.transform,
119
+ SkipUnusedVariablesTransform.transform,
120
+ ValidateRequiredArgumentsTransform.transform,
121
+ ];
122
+
123
+ module.exports = {
124
+ commonTransforms: relayCommonTransforms,
125
+ codegenTransforms: relayCodegenTransforms,
126
+ fragmentTransforms: relayFragmentTransforms,
127
+ printTransforms: relayPrintTransforms,
128
+ queryTransforms: relayQueryTransforms,
129
+ schemaExtensions: relaySchemaExtensions,
130
+ };