relay-compiler 10.0.1 → 10.1.3
Sign up to get free protection for your applications and to get access to all the features.
- package/bin/relay-compiler +1538 -975
- package/codegen/NormalizationCodeGenerator.js.flow +12 -4
- package/codegen/ReaderCodeGenerator.js.flow +38 -3
- package/codegen/RelayFileWriter.js.flow +2 -0
- package/codegen/writeRelayGeneratedFile.js.flow +1 -1
- package/core/ASTCache.js.flow +1 -0
- package/core/CompilerContext.js.flow +1 -0
- package/core/CompilerError.js.flow +6 -1
- package/core/IR.js.flow +0 -1
- package/core/IRPrinter.js.flow +3 -8
- package/core/RelayIRTransforms.js.flow +7 -0
- package/core/Schema.js.flow +55 -1
- package/index.js +1 -1
- package/language/javascript/FindGraphQLTags.js.flow +2 -97
- package/language/javascript/RelayFlowBabelFactories.js.flow +11 -15
- package/language/javascript/RelayFlowGenerator.js.flow +76 -19
- package/language/javascript/RelayFlowTypeTransformers.js.flow +4 -4
- package/lib/bin/RelayCompilerMain.js +8 -14
- package/lib/codegen/CodegenRunner.js +5 -9
- package/lib/codegen/NormalizationCodeGenerator.js +21 -13
- package/lib/codegen/ReaderCodeGenerator.js +44 -13
- package/lib/codegen/RelayFileWriter.js +3 -7
- package/lib/codegen/compileRelayArtifacts.js +4 -8
- package/lib/codegen/sortObjectByKey.js +3 -5
- package/lib/codegen/writeRelayGeneratedFile.js +3 -7
- package/lib/core/ASTCache.js +1 -0
- package/lib/core/CompilerContext.js +1 -0
- package/lib/core/CompilerError.js +8 -8
- package/lib/core/IRPrinter.js +3 -4
- package/lib/core/IRTransformer.js +3 -7
- package/lib/core/RelayGraphQLEnumsGenerator.js +3 -7
- package/lib/core/RelayIRTransforms.js +10 -4
- package/lib/core/RelayParser.js +7 -15
- package/lib/core/Schema.js +50 -13
- package/lib/core/getFieldDefinition.js +3 -5
- package/lib/core/inferRootArgumentDefinitions.js +6 -14
- package/lib/language/javascript/FindGraphQLTags.js +3 -69
- package/lib/language/javascript/RelayFlowBabelFactories.js +5 -5
- package/lib/language/javascript/RelayFlowGenerator.js +85 -34
- package/lib/runner/Artifacts.js +13 -17
- package/lib/runner/BufferedFilesystem.js +6 -10
- package/lib/runner/GraphQLASTNodeGroup.js +10 -14
- package/lib/runner/GraphQLNodeMap.js +3 -7
- package/lib/runner/Sources.js +27 -17
- package/lib/runner/StrictMap.js +5 -7
- package/lib/runner/getChangedNodeNames.js +6 -8
- package/lib/transforms/ApplyFragmentArgumentTransform.js +16 -25
- package/lib/transforms/ClientExtensionsTransform.js +8 -9
- package/lib/transforms/ConnectionTransform.js +9 -14
- package/lib/transforms/DeclarativeConnectionMutationTransform.js +115 -64
- package/lib/transforms/DeferStreamTransform.js +3 -7
- package/lib/transforms/DisallowTypenameOnRoot.js +3 -5
- package/lib/transforms/FieldHandleTransform.js +3 -7
- package/lib/transforms/FilterCompilerDirectivesTransform.js +29 -0
- package/lib/transforms/FlattenTransform.js +14 -17
- package/lib/transforms/GenerateIDFieldTransform.js +3 -7
- package/lib/transforms/GenerateTypeNameTransform.js +4 -8
- package/lib/transforms/InlineDataFragmentTransform.js +3 -7
- package/lib/transforms/MaskTransform.js +4 -12
- package/lib/transforms/MatchTransform.js +8 -8
- package/lib/transforms/ReactFlightComponentTransform.js +158 -0
- package/lib/transforms/RefetchableFragmentTransform.js +5 -9
- package/lib/transforms/RelayDirectiveTransform.js +3 -7
- package/lib/transforms/RequiredFieldTransform.js +369 -0
- package/lib/transforms/SkipHandleFieldTransform.js +2 -6
- package/lib/transforms/SkipRedundantNodesTransform.js +4 -6
- package/lib/transforms/SkipUnreachableNodeTransform.js +2 -6
- package/lib/transforms/SkipUnusedVariablesTransform.js +4 -12
- package/lib/transforms/TestOperationTransform.js +3 -7
- package/lib/transforms/ValidateGlobalVariablesTransform.js +4 -6
- package/lib/transforms/ValidateRequiredArgumentsTransform.js +3 -5
- package/lib/transforms/ValidateServerOnlyDirectivesTransform.js +4 -6
- package/lib/transforms/ValidateUnusedVariablesTransform.js +4 -6
- package/lib/transforms/query-generators/FetchableQueryGenerator.js +2 -6
- package/lib/transforms/query-generators/NodeQueryGenerator.js +2 -6
- package/lib/transforms/query-generators/index.js +3 -5
- package/lib/transforms/query-generators/utils.js +3 -5
- package/package.json +3 -3
- package/relay-compiler.js +4 -4
- package/relay-compiler.min.js +4 -4
- package/runner/Sources.js.flow +14 -0
- package/transforms/ClientExtensionsTransform.js.flow +3 -0
- package/transforms/ConnectionTransform.js.flow +0 -1
- package/transforms/DeclarativeConnectionMutationTransform.js.flow +140 -48
- package/transforms/FieldHandleTransform.js.flow +0 -1
- package/transforms/FilterCompilerDirectivesTransform.js.flow +33 -0
- package/transforms/FlattenTransform.js.flow +3 -2
- package/transforms/MatchTransform.js.flow +6 -0
- package/transforms/ReactFlightComponentTransform.js.flow +195 -0
- package/transforms/RequiredFieldTransform.js.flow +415 -0
- package/transforms/SkipRedundantNodesTransform.js.flow +3 -0
@@ -12,14 +12,10 @@
|
|
12
12
|
|
13
13
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
14
14
|
|
15
|
-
var
|
15
|
+
var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
|
16
16
|
|
17
17
|
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
|
18
18
|
|
19
|
-
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
|
20
|
-
|
21
|
-
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
22
|
-
|
23
19
|
var IRTransformer = require('../core/IRTransformer');
|
24
20
|
|
25
21
|
var getLiteralArgumentValues = require('../core/getLiteralArgumentValues');
|
@@ -64,7 +60,7 @@ function matchTransform(context) {
|
|
64
60
|
}
|
65
61
|
|
66
62
|
function visitInlineFragment(node, state) {
|
67
|
-
return this.traverse(node,
|
63
|
+
return this.traverse(node, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, state), {}, {
|
68
64
|
parentType: node.typeCondition
|
69
65
|
}));
|
70
66
|
}
|
@@ -111,7 +107,7 @@ function visitLinkedField(node, state) {
|
|
111
107
|
}
|
112
108
|
|
113
109
|
state.path.push(node);
|
114
|
-
var transformedNode = this.traverse(node,
|
110
|
+
var transformedNode = this.traverse(node, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, state), {}, {
|
115
111
|
moduleKey: moduleKey,
|
116
112
|
parentType: node.type
|
117
113
|
}));
|
@@ -135,6 +131,10 @@ function visitLinkedField(node, state) {
|
|
135
131
|
});
|
136
132
|
|
137
133
|
if (supportedArgumentDefinition == null) {
|
134
|
+
if (moduleKey == null) {
|
135
|
+
throw createUserError('@match on a field without the `supported` argument is a no-op, please remove the `@match`.', [node.loc]);
|
136
|
+
}
|
137
|
+
|
138
138
|
return transformedNode;
|
139
139
|
}
|
140
140
|
|
@@ -418,7 +418,7 @@ function visitFragmentSpread(spread, _ref2) {
|
|
418
418
|
module: moduleName,
|
419
419
|
sourceDocument: documentName,
|
420
420
|
name: spread.name,
|
421
|
-
selections: [
|
421
|
+
selections: [(0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, spread), {}, {
|
422
422
|
directives: spread.directives.filter(function (directive) {
|
423
423
|
return directive !== moduleDirective;
|
424
424
|
})
|
@@ -0,0 +1,158 @@
|
|
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
|
+
*
|
8
|
+
* @format
|
9
|
+
* @emails oncall+relay
|
10
|
+
*/
|
11
|
+
'use strict';
|
12
|
+
|
13
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
14
|
+
|
15
|
+
var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
|
16
|
+
|
17
|
+
var IRTransformer = require('../core/IRTransformer');
|
18
|
+
|
19
|
+
var _require = require('../core/CompilerError'),
|
20
|
+
createUserError = _require.createUserError,
|
21
|
+
createCompilerError = _require.createCompilerError;
|
22
|
+
|
23
|
+
var _require2 = require('relay-runtime'),
|
24
|
+
RelayFeatureFlags = _require2.RelayFeatureFlags;
|
25
|
+
|
26
|
+
var FLIGHT_FIELD_COMPONENT_ARGUMENT_TYPE = 'String';
|
27
|
+
var FLIGHT_FIELD_COMPONENT_ARGUMENT_NAME = 'component';
|
28
|
+
var FLIGHT_FIELD_PROPS_ARGUMENT_NAME = 'props';
|
29
|
+
var FLIGHT_FIELD_PROPS_TYPE = 'ReactFlightProps';
|
30
|
+
var FLIGHT_FIELD_RETURN_TYPE = 'ReactFlightComponent';
|
31
|
+
|
32
|
+
/**
|
33
|
+
* Experimental transform for React Flight.
|
34
|
+
*/
|
35
|
+
function reactFlightComponentTransform(context) {
|
36
|
+
var schema = context.getSchema();
|
37
|
+
var propsType = schema.getTypeFromString(FLIGHT_FIELD_PROPS_TYPE);
|
38
|
+
propsType = propsType ? schema.asInputType(propsType) : null;
|
39
|
+
var componentType = schema.getTypeFromString(FLIGHT_FIELD_RETURN_TYPE);
|
40
|
+
componentType = componentType ? schema.asScalarFieldType(componentType) : null;
|
41
|
+
|
42
|
+
if (!RelayFeatureFlags.ENABLE_REACT_FLIGHT_COMPONENT_FIELD || propsType == null || componentType == null) {
|
43
|
+
return context;
|
44
|
+
}
|
45
|
+
|
46
|
+
var types = {
|
47
|
+
propsType: propsType,
|
48
|
+
componentType: componentType
|
49
|
+
};
|
50
|
+
return IRTransformer.transform(context, {
|
51
|
+
ScalarField: visitScalarField,
|
52
|
+
LinkedField: visitLinkedField,
|
53
|
+
InlineFragment: visitInlineFragment
|
54
|
+
}, function (node) {
|
55
|
+
return {
|
56
|
+
parentType: node.type,
|
57
|
+
types: types
|
58
|
+
};
|
59
|
+
});
|
60
|
+
}
|
61
|
+
|
62
|
+
function visitInlineFragment(fragment, state) {
|
63
|
+
var _fragment$typeConditi;
|
64
|
+
|
65
|
+
return this.traverse(fragment, {
|
66
|
+
parentType: (_fragment$typeConditi = fragment.typeCondition) !== null && _fragment$typeConditi !== void 0 ? _fragment$typeConditi : state.parentType,
|
67
|
+
types: state.types
|
68
|
+
});
|
69
|
+
}
|
70
|
+
|
71
|
+
function visitLinkedField(field, state) {
|
72
|
+
return this.traverse(field, {
|
73
|
+
parentType: field.type,
|
74
|
+
types: state.types
|
75
|
+
});
|
76
|
+
}
|
77
|
+
|
78
|
+
function visitScalarField(field, state) {
|
79
|
+
// use the return type to quickly determine if this is a flight field
|
80
|
+
var schema = this.getContext().getSchema();
|
81
|
+
|
82
|
+
if (schema.getRawType(field.type) !== state.types.componentType) {
|
83
|
+
return field;
|
84
|
+
} // get the name of the component that provides this field
|
85
|
+
|
86
|
+
|
87
|
+
var clientField = schema.getFieldByName(state.parentType, field.name);
|
88
|
+
|
89
|
+
if (clientField == null) {
|
90
|
+
throw createCompilerError("Definition not found for field '".concat(schema.getTypeString(state.parentType), ".").concat(field.name, "'"), [field.loc]);
|
91
|
+
}
|
92
|
+
|
93
|
+
var componentDirective = clientField.directives.find(function (directive) {
|
94
|
+
return directive.name === 'react_flight_component';
|
95
|
+
});
|
96
|
+
var componentNameArg = componentDirective === null || componentDirective === void 0 ? void 0 : componentDirective.args.find(function (arg) {
|
97
|
+
return arg.name === 'name';
|
98
|
+
});
|
99
|
+
|
100
|
+
if (componentNameArg == null || componentNameArg.value.kind !== 'StringValue' || typeof componentNameArg.value.value !== 'string') {
|
101
|
+
throw createUserError('Invalid Flight field, expected the schema extension to specify ' + "the component's module name with the '@react_flight_component' directive", [field.loc]);
|
102
|
+
}
|
103
|
+
|
104
|
+
var componentName = componentNameArg.value.value; // validate that the parent type has a `flight(component, props)` field
|
105
|
+
|
106
|
+
var flightField = schema.getFieldByName(state.parentType, 'flight');
|
107
|
+
|
108
|
+
if (flightField == null) {
|
109
|
+
throw createUserError("Invalid Flight field, expected the parent type '".concat(schema.getTypeString(state.parentType), "' ") + "to define a 'flight(component: String, props: ReactFlightProps): ReactFlightComponent' field", [field.loc]);
|
110
|
+
}
|
111
|
+
|
112
|
+
var componentArg = flightField.args.get(FLIGHT_FIELD_COMPONENT_ARGUMENT_NAME);
|
113
|
+
var propsArg = flightField.args.get(FLIGHT_FIELD_PROPS_ARGUMENT_NAME);
|
114
|
+
|
115
|
+
if (componentArg == null || propsArg == null || schema.getRawType(componentArg.type) !== schema.getTypeFromString(FLIGHT_FIELD_COMPONENT_ARGUMENT_TYPE) || schema.getRawType(propsArg.type) !== state.types.propsType || schema.getRawType(flightField.type) !== state.types.componentType) {
|
116
|
+
throw createUserError("Invalid Flight field, expected the parent type '".concat(schema.getTypeString(state.parentType), "' ") + "to define a 'flight(component: String, props: ReactFlightProps): ReactFlightComponent' field", [field.loc]);
|
117
|
+
}
|
118
|
+
|
119
|
+
return (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, field), {}, {
|
120
|
+
name: 'flight',
|
121
|
+
args: [{
|
122
|
+
kind: 'Argument',
|
123
|
+
loc: field.loc,
|
124
|
+
name: FLIGHT_FIELD_COMPONENT_ARGUMENT_NAME,
|
125
|
+
type: schema.getTypeFromString(FLIGHT_FIELD_COMPONENT_ARGUMENT_TYPE),
|
126
|
+
value: {
|
127
|
+
kind: 'Literal',
|
128
|
+
value: componentName,
|
129
|
+
loc: field.loc
|
130
|
+
}
|
131
|
+
}, {
|
132
|
+
kind: 'Argument',
|
133
|
+
loc: field.loc,
|
134
|
+
name: FLIGHT_FIELD_PROPS_ARGUMENT_NAME,
|
135
|
+
type: state.types.propsType,
|
136
|
+
value: {
|
137
|
+
kind: 'ObjectValue',
|
138
|
+
fields: field.args.map(function (arg) {
|
139
|
+
return {
|
140
|
+
kind: 'ObjectFieldValue',
|
141
|
+
loc: arg.loc,
|
142
|
+
name: arg.name,
|
143
|
+
value: arg.value
|
144
|
+
};
|
145
|
+
}),
|
146
|
+
loc: field.loc
|
147
|
+
}
|
148
|
+
}],
|
149
|
+
metadata: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, field.metadata || {}), {}, {
|
150
|
+
flight: true
|
151
|
+
}),
|
152
|
+
type: state.types.componentType
|
153
|
+
});
|
154
|
+
}
|
155
|
+
|
156
|
+
module.exports = {
|
157
|
+
transform: reactFlightComponentTransform
|
158
|
+
};
|
@@ -12,11 +12,7 @@
|
|
12
12
|
|
13
13
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
14
14
|
|
15
|
-
var
|
16
|
-
|
17
|
-
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
|
18
|
-
|
19
|
-
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
15
|
+
var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
|
20
16
|
|
21
17
|
var IRVisitor = require('../core/IRVisitor');
|
22
18
|
|
@@ -64,8 +60,8 @@ function refetchableFragmentTransform(context) {
|
|
64
60
|
transformedFragment = _buildRefetchOperatio.transformedFragment;
|
65
61
|
|
66
62
|
var connectionMetadata = extractConnectionMetadata(context.getSchema(), transformedFragment);
|
67
|
-
nextContext = nextContext.replace(
|
68
|
-
metadata:
|
63
|
+
nextContext = nextContext.replace((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, transformedFragment), {}, {
|
64
|
+
metadata: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, transformedFragment.metadata || {}), {}, {
|
69
65
|
refetch: {
|
70
66
|
connection: connectionMetadata !== null && connectionMetadata !== void 0 ? connectionMetadata : null,
|
71
67
|
operation: refetchName,
|
@@ -74,8 +70,8 @@ function refetchableFragmentTransform(context) {
|
|
74
70
|
}
|
75
71
|
})
|
76
72
|
}));
|
77
|
-
nextContext = nextContext.add(
|
78
|
-
metadata:
|
73
|
+
nextContext = nextContext.add((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, node), {}, {
|
74
|
+
metadata: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, node.metadata || {}), {}, {
|
79
75
|
derivedFrom: transformedFragment.name,
|
80
76
|
isRefetchableQuery: true
|
81
77
|
})
|
@@ -12,11 +12,7 @@
|
|
12
12
|
|
13
13
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
14
14
|
|
15
|
-
var
|
16
|
-
|
17
|
-
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
|
18
|
-
|
19
|
-
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
15
|
+
var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
|
20
16
|
|
21
17
|
var IRTransformer = require('../core/IRTransformer');
|
22
18
|
|
@@ -51,12 +47,12 @@ function visitRelayMetadata(metadataFn) {
|
|
51
47
|
|
52
48
|
var argValues = getLiteralArgumentValues(relayDirective.args);
|
53
49
|
var metadata = metadataFn(argValues);
|
54
|
-
return this.traverse(
|
50
|
+
return this.traverse((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, node), {}, {
|
55
51
|
directives: node.directives.filter(function (directive) {
|
56
52
|
return directive !== relayDirective;
|
57
53
|
}),
|
58
54
|
// $FlowFixMe[cannot-spread-indexer]
|
59
|
-
metadata:
|
55
|
+
metadata: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, node.metadata || {}), metadata)
|
60
56
|
}));
|
61
57
|
};
|
62
58
|
}
|
@@ -0,0 +1,369 @@
|
|
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
|
+
*
|
8
|
+
* @format
|
9
|
+
*/
|
10
|
+
// flowlint ambiguous-object-type:error
|
11
|
+
'use strict';
|
12
|
+
|
13
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
14
|
+
|
15
|
+
var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
|
16
|
+
|
17
|
+
var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
|
18
|
+
|
19
|
+
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
|
20
|
+
|
21
|
+
var IRTransformer = require('../core/IRTransformer');
|
22
|
+
|
23
|
+
var partitionArray = require('../util/partitionArray');
|
24
|
+
|
25
|
+
var _require = require('../core/CompilerError'),
|
26
|
+
createUserError = _require.createUserError,
|
27
|
+
createCompilerError = _require.createCompilerError;
|
28
|
+
|
29
|
+
var _require2 = require('relay-runtime'),
|
30
|
+
RelayFeatureFlags = _require2.RelayFeatureFlags;
|
31
|
+
|
32
|
+
var SCHEMA_EXTENSION = "\n enum RequiredFieldAction {\n NONE\n LOG\n THROW\n }\n directive @required(\n action: RequiredFieldAction!\n ) on FIELD\n";
|
33
|
+
/**
|
34
|
+
* This transform rewrites ScalarField and LinkedField nodes with a @required
|
35
|
+
* directive into fields with the directives stripped and sets the `required`
|
36
|
+
* and `path` metadata values.
|
37
|
+
*/
|
38
|
+
|
39
|
+
function requiredFieldTransform(context) {
|
40
|
+
var schema = context.getSchema();
|
41
|
+
return IRTransformer.transform(context, {
|
42
|
+
LinkedField: visitLinkedField,
|
43
|
+
ScalarField: vistitScalarField,
|
44
|
+
InlineFragment: visitInlineFragment,
|
45
|
+
Fragment: visitFragment,
|
46
|
+
Root: visitRoot
|
47
|
+
}, function (node) {
|
48
|
+
return {
|
49
|
+
schema: schema,
|
50
|
+
documentName: node.name,
|
51
|
+
path: [],
|
52
|
+
pathRequiredMap: new Map(),
|
53
|
+
currentNodeRequiredChildren: new Map(),
|
54
|
+
requiredChildrenMap: new Map(),
|
55
|
+
parentAbstractInlineFragment: null
|
56
|
+
};
|
57
|
+
});
|
58
|
+
}
|
59
|
+
|
60
|
+
function visitFragment(fragment, state) {
|
61
|
+
return addChildrenCanBubbleMetadata(this.traverse(fragment, state), state);
|
62
|
+
}
|
63
|
+
|
64
|
+
function visitRoot(root, state) {
|
65
|
+
return addChildrenCanBubbleMetadata(this.traverse(root, state), state);
|
66
|
+
}
|
67
|
+
|
68
|
+
function visitInlineFragment(fragment, state) {
|
69
|
+
var _state$parentAbstract;
|
70
|
+
|
71
|
+
// Ideally we could allow @required when the direct parent inline fragment was
|
72
|
+
// on a concrete type, but we would need to solve this bug in our Flow type
|
73
|
+
// generation first: T65695438
|
74
|
+
var parentAbstractInlineFragment = (_state$parentAbstract = state.parentAbstractInlineFragment) !== null && _state$parentAbstract !== void 0 ? _state$parentAbstract : getAbstractInlineFragment(fragment, state.schema);
|
75
|
+
return this.traverse(fragment, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, state), {}, {
|
76
|
+
parentAbstractInlineFragment: parentAbstractInlineFragment
|
77
|
+
}));
|
78
|
+
}
|
79
|
+
|
80
|
+
function getAbstractInlineFragment(fragment, schema) {
|
81
|
+
var typeCondition = fragment.typeCondition;
|
82
|
+
|
83
|
+
if (schema.isAbstractType(typeCondition)) {
|
84
|
+
return fragment;
|
85
|
+
}
|
86
|
+
|
87
|
+
return null;
|
88
|
+
} // Convert action to a number so that we can numerically compare their severity.
|
89
|
+
|
90
|
+
|
91
|
+
function getActionSeverity(action) {
|
92
|
+
switch (action) {
|
93
|
+
case 'NONE':
|
94
|
+
return 0;
|
95
|
+
|
96
|
+
case 'LOG':
|
97
|
+
return 1;
|
98
|
+
|
99
|
+
case 'THROW':
|
100
|
+
return 2;
|
101
|
+
|
102
|
+
default:
|
103
|
+
action;
|
104
|
+
throw createCompilerError("Unhandled action type ".concat(action));
|
105
|
+
}
|
106
|
+
}
|
107
|
+
|
108
|
+
function visitLinkedField(field, state) {
|
109
|
+
var path = [].concat((0, _toConsumableArray2["default"])(state.path), [field.alias]);
|
110
|
+
var newState = (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, state), {}, {
|
111
|
+
currentNodeRequiredChildren: new Map(),
|
112
|
+
path: path,
|
113
|
+
parentAbstractInlineFragment: null
|
114
|
+
});
|
115
|
+
var newField = this.traverse(field, newState);
|
116
|
+
var pathName = path.join('.');
|
117
|
+
assertCompatibleRequiredChildren(field, pathName, newState);
|
118
|
+
newField = applyDirectives(newField, pathName, state.documentName);
|
119
|
+
assertCompatibleNullability(newField, pathName, newState.pathRequiredMap);
|
120
|
+
var directiveMetadata = getRequiredDirectiveMetadata(newField);
|
121
|
+
|
122
|
+
if (directiveMetadata != null) {
|
123
|
+
assertParentIsNotInvalidInlineFragmet(state.schema, directiveMetadata, state.parentAbstractInlineFragment);
|
124
|
+
state.currentNodeRequiredChildren.set(field.alias, newField);
|
125
|
+
var severity = getActionSeverity(directiveMetadata.action); // Assert that all @required children have at least this severity.
|
126
|
+
|
127
|
+
newState.currentNodeRequiredChildren.forEach(function (childField) {
|
128
|
+
var childMetadata = getRequiredDirectiveMetadata(childField);
|
129
|
+
|
130
|
+
if (childMetadata == null) {
|
131
|
+
return;
|
132
|
+
}
|
133
|
+
|
134
|
+
if (getActionSeverity(childMetadata.action) < severity) {
|
135
|
+
throw createUserError("The @required field [1] may not have an `action` less severe than that of its @required parent [2]. [1] should probably be `action: ".concat(directiveMetadata.action, "`."), [childMetadata.actionLoc, directiveMetadata.actionLoc]);
|
136
|
+
}
|
137
|
+
});
|
138
|
+
}
|
139
|
+
|
140
|
+
state.requiredChildrenMap.set(pathName, newState.currentNodeRequiredChildren);
|
141
|
+
return addChildrenCanBubbleMetadata(newField, newState);
|
142
|
+
}
|
143
|
+
|
144
|
+
function vistitScalarField(field, state) {
|
145
|
+
var pathName = [].concat((0, _toConsumableArray2["default"])(state.path), [field.alias]).join('.');
|
146
|
+
var newField = applyDirectives(field, pathName, state.documentName);
|
147
|
+
var directiveMetadata = getRequiredDirectiveMetadata(newField);
|
148
|
+
|
149
|
+
if (directiveMetadata != null) {
|
150
|
+
assertParentIsNotInvalidInlineFragmet(state.schema, directiveMetadata, state.parentAbstractInlineFragment);
|
151
|
+
state.currentNodeRequiredChildren.set(field.alias, newField);
|
152
|
+
}
|
153
|
+
|
154
|
+
assertCompatibleNullability(newField, pathName, state.pathRequiredMap);
|
155
|
+
return newField;
|
156
|
+
}
|
157
|
+
|
158
|
+
function addChildrenCanBubbleMetadata(node, state) {
|
159
|
+
var _iterator = (0, _createForOfIteratorHelper2["default"])(state.currentNodeRequiredChildren.values()),
|
160
|
+
_step;
|
161
|
+
|
162
|
+
try {
|
163
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
164
|
+
var child = _step.value;
|
165
|
+
var requiredMetadata = getRequiredDirectiveMetadata(child);
|
166
|
+
|
167
|
+
if (requiredMetadata != null && requiredMetadata.action !== 'THROW') {
|
168
|
+
var metadata = (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, node.metadata), {}, {
|
169
|
+
childrenCanBubbleNull: true
|
170
|
+
});
|
171
|
+
return (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, node), {}, {
|
172
|
+
metadata: metadata
|
173
|
+
});
|
174
|
+
}
|
175
|
+
}
|
176
|
+
} catch (err) {
|
177
|
+
_iterator.e(err);
|
178
|
+
} finally {
|
179
|
+
_iterator.f();
|
180
|
+
}
|
181
|
+
|
182
|
+
return node;
|
183
|
+
}
|
184
|
+
|
185
|
+
function assertParentIsNotInvalidInlineFragmet(schema, directiveMetadata, parentAbstractInlineFragment) {
|
186
|
+
if (parentAbstractInlineFragment == null) {
|
187
|
+
return;
|
188
|
+
}
|
189
|
+
|
190
|
+
var typeCondition = parentAbstractInlineFragment.typeCondition;
|
191
|
+
|
192
|
+
if (schema.isUnion(typeCondition)) {
|
193
|
+
throw createUserError('The @required directive [1] may not be used anywhere within an inline fragment on a union type [2].', [directiveMetadata.directiveLoc, parentAbstractInlineFragment.loc]);
|
194
|
+
} else if (schema.isInterface(typeCondition)) {
|
195
|
+
throw createUserError('The @required directive [1] may not be used anywhere within an inline fragment on an interface type [2].', [directiveMetadata.directiveLoc, parentAbstractInlineFragment.loc]);
|
196
|
+
} else {
|
197
|
+
throw createCompilerError('Unexpected abstract inline fragment type.', [parentAbstractInlineFragment.loc]);
|
198
|
+
}
|
199
|
+
} // Check that this field's nullability matches all other instances.
|
200
|
+
|
201
|
+
|
202
|
+
function assertCompatibleNullability(field, pathName, pathRequiredMap) {
|
203
|
+
var existingField = pathRequiredMap.get(pathName);
|
204
|
+
|
205
|
+
if (existingField == null) {
|
206
|
+
pathRequiredMap.set(pathName, field);
|
207
|
+
return;
|
208
|
+
}
|
209
|
+
|
210
|
+
var requiredMetadata = getRequiredDirectiveMetadata(field);
|
211
|
+
var existingRequiredMetadata = getRequiredDirectiveMetadata(existingField);
|
212
|
+
|
213
|
+
if ((requiredMetadata === null || requiredMetadata === void 0 ? void 0 : requiredMetadata.action) === (existingRequiredMetadata === null || existingRequiredMetadata === void 0 ? void 0 : existingRequiredMetadata.action)) {
|
214
|
+
return;
|
215
|
+
}
|
216
|
+
|
217
|
+
if (requiredMetadata == null) {
|
218
|
+
throw createUserError("The field \"".concat(field.alias, "\" is @required in [1] but not in [2]."), [existingField.loc, field.loc]);
|
219
|
+
}
|
220
|
+
|
221
|
+
if (existingRequiredMetadata == null) {
|
222
|
+
throw createUserError("The field \"".concat(field.alias, "\" is @required in [1] but not in [2]."), [field.loc, existingField.loc]);
|
223
|
+
}
|
224
|
+
|
225
|
+
throw createUserError("The field \"".concat(field.alias, "\" has a different @required action in [1] than in [2]."), [requiredMetadata.actionLoc, existingRequiredMetadata.actionLoc]);
|
226
|
+
} // Metadata is untyped, so we use this utility function to do the type coersion.
|
227
|
+
|
228
|
+
|
229
|
+
function getRequiredDirectiveMetadata(field) {
|
230
|
+
var _field$metadata;
|
231
|
+
|
232
|
+
return (_field$metadata = field.metadata) === null || _field$metadata === void 0 ? void 0 : _field$metadata.required;
|
233
|
+
} // Check that this field has the same required children as all other instances.
|
234
|
+
|
235
|
+
|
236
|
+
function assertCompatibleRequiredChildren(field, fieldPath, _ref) {
|
237
|
+
var currentNodeRequiredChildren = _ref.currentNodeRequiredChildren,
|
238
|
+
pathRequiredMap = _ref.pathRequiredMap,
|
239
|
+
requiredChildrenMap = _ref.requiredChildrenMap;
|
240
|
+
var previouslyRequiredChildren = requiredChildrenMap.get(fieldPath);
|
241
|
+
|
242
|
+
if (previouslyRequiredChildren == null) {
|
243
|
+
return;
|
244
|
+
} // Check if this field has a required child field which was previously omitted.
|
245
|
+
|
246
|
+
|
247
|
+
var _iterator2 = (0, _createForOfIteratorHelper2["default"])(currentNodeRequiredChildren),
|
248
|
+
_step2;
|
249
|
+
|
250
|
+
try {
|
251
|
+
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
|
252
|
+
var _step2$value = _step2.value,
|
253
|
+
path = _step2$value[0],
|
254
|
+
childField = _step2$value[1];
|
255
|
+
|
256
|
+
if (!previouslyRequiredChildren.has(path)) {
|
257
|
+
var otherParent = pathRequiredMap.get(fieldPath);
|
258
|
+
|
259
|
+
if (otherParent == null) {
|
260
|
+
throw createCompilerError("Could not find other parent node at path \"".concat(fieldPath, "\"."), [childField.loc]);
|
261
|
+
}
|
262
|
+
|
263
|
+
throw createMissingRequiredFieldError(childField, otherParent);
|
264
|
+
}
|
265
|
+
} // Check if a previous reference to this field had a required child field which we are missing.
|
266
|
+
|
267
|
+
} catch (err) {
|
268
|
+
_iterator2.e(err);
|
269
|
+
} finally {
|
270
|
+
_iterator2.f();
|
271
|
+
}
|
272
|
+
|
273
|
+
var _iterator3 = (0, _createForOfIteratorHelper2["default"])(previouslyRequiredChildren),
|
274
|
+
_step3;
|
275
|
+
|
276
|
+
try {
|
277
|
+
for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
|
278
|
+
var _step3$value = _step3.value,
|
279
|
+
_path = _step3$value[0],
|
280
|
+
_childField = _step3$value[1];
|
281
|
+
|
282
|
+
if (!currentNodeRequiredChildren.has(_path)) {
|
283
|
+
throw createMissingRequiredFieldError(_childField, field);
|
284
|
+
}
|
285
|
+
}
|
286
|
+
} catch (err) {
|
287
|
+
_iterator3.e(err);
|
288
|
+
} finally {
|
289
|
+
_iterator3.f();
|
290
|
+
}
|
291
|
+
}
|
292
|
+
|
293
|
+
function createMissingRequiredFieldError(requiredChild, missingParent) {
|
294
|
+
var alias = requiredChild.alias;
|
295
|
+
return createUserError("The field \"".concat(alias, "\" is marked as @required in [1] but is missing in [2]."), [requiredChild.loc, missingParent.loc]);
|
296
|
+
} // TODO T74397896: Remove prefix gating once @required is rolled out more broadly.
|
297
|
+
|
298
|
+
|
299
|
+
function featureIsEnabled(documentName) {
|
300
|
+
var featureFlag = RelayFeatureFlags.ENABLE_REQUIRED_DIRECTIVES;
|
301
|
+
|
302
|
+
if (typeof featureFlag === 'boolean') {
|
303
|
+
return featureFlag;
|
304
|
+
} else if (featureFlag === 'LIMITED') {
|
305
|
+
return documentName.startsWith('RelayRequiredTest');
|
306
|
+
} else if (typeof featureFlag === 'string') {
|
307
|
+
return featureFlag.split('|').some(function (prefix) {
|
308
|
+
return documentName.startsWith(prefix);
|
309
|
+
});
|
310
|
+
}
|
311
|
+
|
312
|
+
return false;
|
313
|
+
} // Strip and validate @required directives, and convert them to metadata.
|
314
|
+
|
315
|
+
|
316
|
+
function applyDirectives(field, pathName, documentName) {
|
317
|
+
var _partitionArray = partitionArray(field.directives, function (directive) {
|
318
|
+
return directive.name === 'required';
|
319
|
+
}),
|
320
|
+
requiredDirectives = _partitionArray[0],
|
321
|
+
otherDirectives = _partitionArray[1];
|
322
|
+
|
323
|
+
if (requiredDirectives.length === 0) {
|
324
|
+
return field;
|
325
|
+
}
|
326
|
+
|
327
|
+
if (!featureIsEnabled(documentName)) {
|
328
|
+
throw new createUserError( // Purposefully don't include details in this error message, since we
|
329
|
+
// don't want folks adopting this feature until it's been tested more.
|
330
|
+
'The @required directive is experimental and not yet supported for use in product code', requiredDirectives.map(function (x) {
|
331
|
+
return x.loc;
|
332
|
+
}));
|
333
|
+
}
|
334
|
+
|
335
|
+
if (requiredDirectives.length > 1) {
|
336
|
+
throw new createUserError('Did not expect multiple @required directives.', requiredDirectives.map(function (x) {
|
337
|
+
return x.loc;
|
338
|
+
}));
|
339
|
+
}
|
340
|
+
|
341
|
+
var requiredDirective = requiredDirectives[0];
|
342
|
+
var arg = requiredDirective.args[0]; // I would expect this check to be handled by the schema validation, but...
|
343
|
+
|
344
|
+
if (arg == null) {
|
345
|
+
throw createUserError('The @required directive requires an `action` argument.', [requiredDirective.loc]);
|
346
|
+
}
|
347
|
+
|
348
|
+
if (arg.value.kind !== 'Literal') {
|
349
|
+
throw createUserError('Expected @required `action` argument to be a literal.', [arg.value.loc]);
|
350
|
+
}
|
351
|
+
|
352
|
+
return (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, field), {}, {
|
353
|
+
directives: otherDirectives,
|
354
|
+
metadata: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, field.metadata), {}, {
|
355
|
+
required: {
|
356
|
+
action: arg.value.value,
|
357
|
+
actionLoc: arg.loc,
|
358
|
+
directiveLoc: requiredDirective.loc,
|
359
|
+
path: pathName
|
360
|
+
}
|
361
|
+
})
|
362
|
+
});
|
363
|
+
} // Transform @required directive to metadata
|
364
|
+
|
365
|
+
|
366
|
+
module.exports = {
|
367
|
+
SCHEMA_EXTENSION: SCHEMA_EXTENSION,
|
368
|
+
transform: requiredFieldTransform
|
369
|
+
};
|
@@ -12,11 +12,7 @@
|
|
12
12
|
|
13
13
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
14
14
|
|
15
|
-
var
|
16
|
-
|
17
|
-
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
|
18
|
-
|
19
|
-
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
15
|
+
var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
|
20
16
|
|
21
17
|
var IRTransformer = require('../core/IRTransformer');
|
22
18
|
|
@@ -35,7 +31,7 @@ function visitField(field) {
|
|
35
31
|
var transformedNode = this.traverse(field);
|
36
32
|
|
37
33
|
if (transformedNode.handles) {
|
38
|
-
return
|
34
|
+
return (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, transformedNode), {}, {
|
39
35
|
handles: null
|
40
36
|
});
|
41
37
|
}
|