Skip to content

Commit 0a91e63

Browse files
leebyronleebyron
committed
Preserve defaultValue literals
Fixes #3051
1 parent 1d87c02 commit 0a91e63

22 files changed

+203
-73
lines changed

‎src/execution/values.js

+11-4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import type { GraphQLSchema } from '../type/schema';
1717
import type { GraphQLField } from '../type/definition';
1818
import type { GraphQLDirective } from '../type/directives';
1919
import { isInputType, isNonNullType } from '../type/definition';
20+
import { getCoercedDefaultValue } from '../type/defaultValues';
2021

2122
import { typeFromAST } from '../utilities/typeFromAST';
2223
import { valueFromAST } from '../utilities/valueFromAST';
@@ -173,8 +174,11 @@ export function getArgumentValues(
173174
const argumentNode = argNodeMap[name];
174175

175176
if (!argumentNode) {
176-
if (argDef.defaultValue !== undefined) {
177-
coercedValues[name] = argDef.defaultValue;
177+
if (argDef.defaultValue) {
178+
coercedValues[name] = getCoercedDefaultValue(
179+
argDef.defaultValue,
180+
argDef.type,
181+
);
178182
} else if (isNonNullType(argType)) {
179183
throw new GraphQLError(
180184
`Argument "${name}" of required type "${inspect(argType)}" ` +
@@ -194,8 +198,11 @@ export function getArgumentValues(
194198
variableValues == null ||
195199
!hasOwnProperty(variableValues, variableName)
196200
) {
197-
if (argDef.defaultValue !== undefined) {
198-
coercedValues[name] = argDef.defaultValue;
201+
if (argDef.defaultValue) {
202+
coercedValues[name] = getCoercedDefaultValue(
203+
argDef.defaultValue,
204+
argDef.type,
205+
);
199206
} else if (isNonNullType(argType)) {
200207
throw new GraphQLError(
201208
`Argument "${name}" of required type "${inspect(argType)}" ` +

‎src/index.d.ts

+4
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@ export {
126126
// Validate GraphQL schema.
127127
validateSchema,
128128
assertValidSchema,
129+
// Operate on default values.
130+
getCoercedDefaultValue,
131+
getLiteralDefaultValue,
129132
} from './type/index';
130133

131134
export {
@@ -150,6 +153,7 @@ export {
150153
GraphQLArgumentConfig,
151154
GraphQLArgumentExtensions,
152155
GraphQLInputValue,
156+
GraphQLDefaultValueUsage,
153157
GraphQLInputValueConfig,
154158
GraphQLEnumTypeConfig,
155159
GraphQLEnumTypeExtensions,

‎src/index.js

+4
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,9 @@ export {
125125
// Validate GraphQL schema.
126126
validateSchema,
127127
assertValidSchema,
128+
// Operate on default values.
129+
getCoercedDefaultValue,
130+
getLiteralDefaultValue,
128131
} from './type/index';
129132

130133
export type {
@@ -146,6 +149,7 @@ export type {
146149
GraphQLArgument,
147150
GraphQLArgumentConfig,
148151
GraphQLInputValue,
152+
GraphQLDefaultValueUsage,
149153
GraphQLInputValueConfig,
150154
GraphQLEnumTypeConfig,
151155
GraphQLEnumValue,

‎src/type/__tests__/predicate-test.js

+11-20
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ import {
6969
assertNamedType,
7070
getNullableType,
7171
getNamedType,
72+
defineInputValue,
7273
} from '../definition';
7374

7475
const ObjectType = new GraphQLObjectType({ name: 'Object', fields: {} });
@@ -562,19 +563,14 @@ describe('Type predicates', () => {
562563
});
563564

564565
describe('isRequiredInput', () => {
565-
function buildArg(config: {|
566+
function buildArg({
567+
type,
568+
defaultValue,
569+
}: {|
566570
type: GraphQLInputType,
567571
defaultValue?: mixed,
568572
|}): GraphQLArgument {
569-
return {
570-
name: 'someArg',
571-
type: config.type,
572-
description: undefined,
573-
defaultValue: config.defaultValue,
574-
deprecationReason: null,
575-
extensions: undefined,
576-
astNode: undefined,
577-
};
573+
return defineInputValue({ type, defaultValue }, 'someArg');
578574
}
579575

580576
it('returns true for required arguments', () => {
@@ -608,19 +604,14 @@ describe('Type predicates', () => {
608604
expect(isRequiredInput(optArg4)).to.equal(false);
609605
});
610606

611-
function buildInputField(config: {|
607+
function buildInputField({
608+
type,
609+
defaultValue,
610+
}: {|
612611
type: GraphQLInputType,
613612
defaultValue?: mixed,
614613
|}): GraphQLInputField {
615-
return {
616-
name: 'someInputField',
617-
type: config.type,
618-
description: undefined,
619-
defaultValue: config.defaultValue,
620-
deprecationReason: null,
621-
extensions: undefined,
622-
astNode: undefined,
623-
};
614+
return defineInputValue({ type, defaultValue }, 'someInputField');
624615
}
625616

626617
it('returns true for required input field', () => {

‎src/type/defaultValues.d.ts

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import { ConstValueNode } from '../language/ast';
2+
3+
import { GraphQLInputType, GraphQLDefaultValueUsage } from './definition';
4+
5+
export function getLiteralDefaultValue(
6+
usage: GraphQLDefaultValueUsage,
7+
type: GraphQLInputType,
8+
): ConstValueNode;
9+
10+
export function getCoercedDefaultValue(
11+
usage: GraphQLDefaultValueUsage,
12+
type: GraphQLInputType,
13+
): unknown;

‎src/type/defaultValues.js

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import { invariant } from '../jsutils/invariant';
2+
import type { ConstValueNode } from '../language/ast';
3+
4+
import { astFromValue } from '../utilities/astFromValue';
5+
import { valueFromAST } from '../utilities/valueFromAST';
6+
7+
import type { GraphQLInputType, GraphQLDefaultValueUsage } from './definition';
8+
9+
export function getLiteralDefaultValue(
10+
usage: GraphQLDefaultValueUsage,
11+
type: GraphQLInputType,
12+
): ConstValueNode {
13+
if (!usage.literal) {
14+
const literal = astFromValue(usage.value, type);
15+
invariant(literal, 'Value cannot be converted to literal for this type');
16+
usage.literal = literal;
17+
}
18+
return usage.literal;
19+
}
20+
21+
export function getCoercedDefaultValue(
22+
usage: GraphQLDefaultValueUsage,
23+
type: GraphQLInputType,
24+
): mixed {
25+
if (usage.value === undefined) {
26+
usage.value = valueFromAST(usage.literal, type);
27+
}
28+
return usage.value;
29+
}

‎src/type/definition.d.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import {
2323
FieldNode,
2424
FragmentDefinitionNode,
2525
ValueNode,
26+
ConstValueNode,
2627
ScalarTypeExtensionNode,
2728
UnionTypeExtensionNode,
2829
EnumTypeExtensionNode,
@@ -575,12 +576,17 @@ export interface GraphQLInputValue<Extensions> {
575576
name: string;
576577
description: Maybe<string>;
577578
type: GraphQLInputType;
578-
defaultValue: unknown;
579+
defaultValue: Maybe<GraphQLDefaultValueUsage>;
579580
deprecationReason: Maybe<string>;
580581
extensions: Maybe<Readonly<Extensions>>;
581582
astNode: Maybe<InputValueDefinitionNode>;
582583
}
583584

585+
export interface GraphQLDefaultValueUsage {
586+
value: unknown;
587+
literal: Maybe<ConstValueNode>;
588+
}
589+
584590
export interface GraphQLInputValueConfig<Extensions> {
585591
description?: Maybe<string>;
586592
type: GraphQLInputType;

‎src/type/definition.js

+18-3
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import type {
4141
FieldNode,
4242
FragmentDefinitionNode,
4343
ValueNode,
44+
ConstValueNode,
4445
} from '../language/ast';
4546

4647
import { valueFromASTUntyped } from '../utilities/valueFromASTUntyped';
@@ -971,11 +972,18 @@ export function defineInputValue(
971972
!('resolve' in config),
972973
`${name} has a resolve property, but inputs cannot define resolvers.`,
973974
);
975+
let defaultValue;
976+
if (config.defaultValue !== undefined || config.defaultValueLiteral) {
977+
defaultValue = {
978+
value: config.defaultValue,
979+
literal: config.defaultValueLiteral,
980+
};
981+
}
974982
return {
975983
name,
976984
description: config.description,
977985
type: config.type,
978-
defaultValue: config.defaultValue,
986+
defaultValue,
979987
deprecationReason: config.deprecationReason,
980988
extensions: config.extensions && toObjMap(config.extensions),
981989
astNode: config.astNode,
@@ -991,7 +999,8 @@ export function inputValueToConfig(
991999
return {
9921000
description: inputValue.description,
9931001
type: inputValue.type,
994-
defaultValue: inputValue.defaultValue,
1002+
defaultValue: inputValue.defaultValue?.value,
1003+
defaultValueLiteral: inputValue.defaultValue?.literal,
9951004
deprecationReason: inputValue.deprecationReason,
9961005
extensions: inputValue.extensions,
9971006
astNode: inputValue.astNode,
@@ -1002,16 +1011,22 @@ export type GraphQLInputValue = {|
10021011
name: string,
10031012
description: ?string,
10041013
type: GraphQLInputType,
1005-
defaultValue: mixed,
1014+
defaultValue: ?GraphQLDefaultValueUsage,
10061015
deprecationReason: ?string,
10071016
extensions: ?ReadOnlyObjMap<mixed>,
10081017
astNode: ?InputValueDefinitionNode,
10091018
|};
10101019

1020+
export type GraphQLDefaultValueUsage = {|
1021+
value: mixed,
1022+
literal: ?ConstValueNode,
1023+
|};
1024+
10111025
export type GraphQLInputValueConfig = {|
10121026
description?: ?string,
10131027
type: GraphQLInputType,
10141028
defaultValue?: mixed,
1029+
defaultValueLiteral?: ?ConstValueNode,
10151030
deprecationReason?: ?string,
10161031
extensions?: ?ReadOnlyObjMapLike<mixed>,
10171032
astNode?: ?InputValueDefinitionNode,

‎src/type/index.d.ts

+6
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ export {
8282
GraphQLArgumentConfig,
8383
GraphQLArgumentExtensions,
8484
GraphQLInputValue,
85+
GraphQLDefaultValueUsage,
8586
GraphQLInputValueConfig,
8687
GraphQLEnumTypeConfig,
8788
GraphQLEnumTypeExtensions,
@@ -117,6 +118,11 @@ export {
117118
GraphQLScalarLiteralParser,
118119
} from './definition';
119120

121+
export {
122+
getCoercedDefaultValue,
123+
getLiteralDefaultValue,
124+
} from './defaultValues';
125+
120126
export {
121127
// Predicate
122128
isDirective,

‎src/type/index.js

+6
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ export type {
136136
GraphQLArgument,
137137
GraphQLArgumentConfig,
138138
GraphQLInputValue,
139+
GraphQLDefaultValueUsage,
139140
GraphQLInputValueConfig,
140141
GraphQLEnumTypeConfig,
141142
GraphQLEnumValue,
@@ -162,5 +163,10 @@ export type {
162163
GraphQLScalarLiteralParser,
163164
} from './definition';
164165

166+
export {
167+
getCoercedDefaultValue,
168+
getLiteralDefaultValue,
169+
} from './defaultValues';
170+
165171
// Validate GraphQL schema.
166172
export { validateSchema, assertValidSchema } from './validate';

‎src/type/introspection.js

+10-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import { invariant } from '../jsutils/invariant';
33

44
import { print } from '../language/printer';
55
import { DirectiveLocation } from '../language/directiveLocation';
6-
import { astFromValue } from '../utilities/astFromValue';
76

87
import type { GraphQLSchema } from './schema';
98
import type { GraphQLDirective } from './directives';
@@ -31,6 +30,7 @@ import {
3130
isNonNullType,
3231
isAbstractType,
3332
} from './definition';
33+
import { getLiteralDefaultValue } from './defaultValues';
3434

3535
export const __Schema: GraphQLObjectType = new GraphQLObjectType({
3636
name: '__Schema',
@@ -382,11 +382,15 @@ export const __InputValue: GraphQLObjectType = new GraphQLObjectType({
382382
type: GraphQLString,
383383
description:
384384
'A GraphQL-formatted string representing the default value for this input value.',
385-
resolve(inputValue) {
386-
const { type, defaultValue } = inputValue;
387-
const valueAST = astFromValue(defaultValue, type);
388-
return valueAST ? print(valueAST) : null;
389-
},
385+
resolve: (inputValue) =>
386+
inputValue.defaultValue
387+
? print(
388+
getLiteralDefaultValue(
389+
inputValue.defaultValue,
390+
inputValue.type,
391+
),
392+
)
393+
: null,
390394
},
391395
isDeprecated: {
392396
type: new GraphQLNonNull(GraphQLBoolean),

‎src/utilities/TypeInfo.js

+2-4
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ export class TypeInfo {
209209
}
210210
}
211211
this._argument = argDef;
212-
this._defaultValueStack.push(argDef ? argDef.defaultValue : undefined);
212+
this._defaultValueStack.push(argDef?.defaultValue?.value);
213213
this._inputTypeStack.push(isInputType(argType) ? argType : undefined);
214214
break;
215215
}
@@ -233,9 +233,7 @@ export class TypeInfo {
233233
inputFieldType = inputField.type;
234234
}
235235
}
236-
this._defaultValueStack.push(
237-
inputField ? inputField.defaultValue : undefined,
238-
);
236+
this._defaultValueStack.push(inputField?.defaultValue?.value);
239237
this._inputTypeStack.push(
240238
isInputType(inputFieldType) ? inputFieldType : undefined,
241239
);

‎src/utilities/__tests__/astFromValue-test.js

+2
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ describe('astFromValue', () => {
5151
kind: 'BooleanValue',
5252
value: false,
5353
});
54+
55+
expect(astFromValue(null, NonNullBoolean)).to.equal(null);
5456
});
5557

5658
it('converts Int values to Int ASTs', () => {

0 commit comments

Comments
 (0)