Skip to content

Commit 1b56a83

Browse files
leebyronyaacovCR
leebyron
authored and
yaacovCR
committed
Add valueToLiteral()
* Adds `valueToLiteral()` which takes an external value and translates it to a literal, allowing for custom scalars to define this behavior. This also adds important changes to Input Coercion, especially for custom scalars: * The value provided to `parseLiteral` is now `ConstValueNode` and the second `variables` argument has been removed. For all built-in scalars this has no effect, but any custom scalars which use complex literals no longer need to do variable reconciliation manually (in fact most do not -- this has been an easy subtle bug to miss). This behavior is possible with the addition of `replaceVariables`
1 parent e13091d commit 1b56a83

13 files changed

+783
-50
lines changed

‎src/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,10 @@ export {
450450
// A helper to use within recursive-descent visitors which need to be aware of the GraphQL type system.
451451
TypeInfo,
452452
visitWithTypeInfo,
453+
// Converts a value to a const value by replacing variables.
454+
replaceVariables,
455+
// Create a GraphQL literal (AST) from a JavaScript input value.
456+
valueToLiteral,
453457
// Coerces a JavaScript value to a GraphQL type, or produces errors.
454458
coerceInputValue,
455459
// Coerces a GraphQL literal (AST) to a GraphQL type, or returns undefined.

‎src/type/__tests__/definition-test.ts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { identityFunc } from '../../jsutils/identityFunc.js';
55
import { inspect } from '../../jsutils/inspect.js';
66

77
import { Kind } from '../../language/kinds.js';
8-
import { parseValue } from '../../language/parser.js';
8+
import { parseConstValue } from '../../language/parser.js';
99

1010
import type { GraphQLNullableType, GraphQLType } from '../definition.js';
1111
import {
@@ -82,15 +82,12 @@ describe('Type System: Scalars', () => {
8282
},
8383
});
8484

85-
expect(scalar.parseLiteral(parseValue('null'))).to.equal(
85+
expect(scalar.parseLiteral(parseConstValue('null'))).to.equal(
8686
'parseValue: null',
8787
);
88-
expect(scalar.parseLiteral(parseValue('{ foo: "bar" }'))).to.equal(
88+
expect(scalar.parseLiteral(parseConstValue('{ foo: "bar" }'))).to.equal(
8989
'parseValue: { foo: "bar" }',
9090
);
91-
expect(
92-
scalar.parseLiteral(parseValue('{ foo: { bar: $var } }'), { var: 'baz' }),
93-
).to.equal('parseValue: { foo: { bar: "baz" } }');
9491
});
9592

9693
it('rejects a Scalar type defining parseLiteral but not parseValue', () => {

‎src/type/__tests__/scalars-test.ts

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { expect } from 'chai';
22
import { describe, it } from 'mocha';
33

4-
import { parseValue as parseValueToAST } from '../../language/parser.js';
4+
import { parseConstValue } from '../../language/parser.js';
55

66
import {
77
GraphQLBoolean,
@@ -66,7 +66,7 @@ describe('Type System: Specified scalar types', () => {
6666

6767
it('parseLiteral', () => {
6868
function parseLiteral(str: string) {
69-
return GraphQLInt.parseLiteral(parseValueToAST(str), undefined);
69+
return GraphQLInt.parseLiteral(parseConstValue(str));
7070
}
7171

7272
expect(parseLiteral('1')).to.equal(1);
@@ -104,9 +104,6 @@ describe('Type System: Specified scalar types', () => {
104104
expect(() => parseLiteral('ENUM_VALUE')).to.throw(
105105
'Int cannot represent non-integer value: ENUM_VALUE',
106106
);
107-
expect(() => parseLiteral('$var')).to.throw(
108-
'Int cannot represent non-integer value: $var',
109-
);
110107
});
111108

112109
it('serialize', () => {
@@ -231,7 +228,7 @@ describe('Type System: Specified scalar types', () => {
231228

232229
it('parseLiteral', () => {
233230
function parseLiteral(str: string) {
234-
return GraphQLFloat.parseLiteral(parseValueToAST(str), undefined);
231+
return GraphQLFloat.parseLiteral(parseConstValue(str));
235232
}
236233

237234
expect(parseLiteral('1')).to.equal(1);
@@ -264,9 +261,6 @@ describe('Type System: Specified scalar types', () => {
264261
expect(() => parseLiteral('ENUM_VALUE')).to.throw(
265262
'Float cannot represent non numeric value: ENUM_VALUE',
266263
);
267-
expect(() => parseLiteral('$var')).to.throw(
268-
'Float cannot represent non numeric value: $var',
269-
);
270264
});
271265

272266
it('serialize', () => {
@@ -344,7 +338,7 @@ describe('Type System: Specified scalar types', () => {
344338

345339
it('parseLiteral', () => {
346340
function parseLiteral(str: string) {
347-
return GraphQLString.parseLiteral(parseValueToAST(str), undefined);
341+
return GraphQLString.parseLiteral(parseConstValue(str));
348342
}
349343

350344
expect(parseLiteral('"foo"')).to.equal('foo');
@@ -371,9 +365,6 @@ describe('Type System: Specified scalar types', () => {
371365
expect(() => parseLiteral('ENUM_VALUE')).to.throw(
372366
'String cannot represent a non string value: ENUM_VALUE',
373367
);
374-
expect(() => parseLiteral('$var')).to.throw(
375-
'String cannot represent a non string value: $var',
376-
);
377368
});
378369

379370
it('serialize', () => {
@@ -456,7 +447,7 @@ describe('Type System: Specified scalar types', () => {
456447

457448
it('parseLiteral', () => {
458449
function parseLiteral(str: string) {
459-
return GraphQLBoolean.parseLiteral(parseValueToAST(str), undefined);
450+
return GraphQLBoolean.parseLiteral(parseConstValue(str));
460451
}
461452

462453
expect(parseLiteral('true')).to.equal(true);
@@ -489,9 +480,6 @@ describe('Type System: Specified scalar types', () => {
489480
expect(() => parseLiteral('ENUM_VALUE')).to.throw(
490481
'Boolean cannot represent a non boolean value: ENUM_VALUE',
491482
);
492-
expect(() => parseLiteral('$var')).to.throw(
493-
'Boolean cannot represent a non boolean value: $var',
494-
);
495483
});
496484

497485
it('serialize', () => {
@@ -571,7 +559,7 @@ describe('Type System: Specified scalar types', () => {
571559

572560
it('parseLiteral', () => {
573561
function parseLiteral(str: string) {
574-
return GraphQLID.parseLiteral(parseValueToAST(str), undefined);
562+
return GraphQLID.parseLiteral(parseConstValue(str));
575563
}
576564

577565
expect(parseLiteral('""')).to.equal('');
@@ -604,9 +592,6 @@ describe('Type System: Specified scalar types', () => {
604592
expect(() => parseLiteral('ENUM_VALUE')).to.throw(
605593
'ID cannot represent a non-string and non-integer value: ENUM_VALUE',
606594
);
607-
expect(() => parseLiteral('$var')).to.throw(
608-
'ID cannot represent a non-string and non-integer value: $var',
609-
);
610595
});
611596

612597
it('serialize', () => {

‎src/type/definition.ts

Lines changed: 59 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ import type {
3535
ScalarTypeExtensionNode,
3636
UnionTypeDefinitionNode,
3737
UnionTypeExtensionNode,
38-
ValueNode,
3938
} from '../language/ast.js';
4039
import { Kind } from '../language/kinds.js';
4140
import { print } from '../language/printer.js';
@@ -526,22 +525,52 @@ export interface GraphQLScalarTypeExtensions {
526525
* Example:
527526
*
528527
* ```ts
528+
* function ensureOdd(value) {
529+
* if (!Number.isFinite(value)) {
530+
* throw new Error(
531+
* `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
532+
* );
533+
* }
534+
*
535+
* if (value % 2 === 0) {
536+
* throw new Error(`Scalar "Odd" cannot represent "${value}" since it is even.`);
537+
* }
538+
* }
539+
*
529540
* const OddType = new GraphQLScalarType({
530541
* name: 'Odd',
531542
* serialize(value) {
532-
* if (!Number.isFinite(value)) {
533-
* throw new Error(
534-
* `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
535-
* );
536-
* }
537-
*
538-
* if (value % 2 === 0) {
539-
* throw new Error(`Scalar "Odd" cannot represent "${value}" since it is even.`);
540-
* }
541-
* return value;
543+
* return ensureOdd(value);
544+
* },
545+
* parseValue(value) {
546+
* return ensureOdd(value);
547+
* }
548+
* valueToLiteral(value) {
549+
* return parse(`${ensureOdd(value)`);
542550
* }
543551
* });
544552
* ```
553+
*
554+
* Custom scalars behavior is defined via the following functions:
555+
*
556+
* - serialize(value): Implements "Result Coercion". Given an internal value,
557+
* produces an external value valid for this type. Returns undefined or
558+
* throws an error to indicate invalid values.
559+
*
560+
* - parseValue(value): Implements "Input Coercion" for values. Given an
561+
* external value (for example, variable values), produces an internal value
562+
* valid for this type. Returns undefined or throws an error to indicate
563+
* invalid values.
564+
*
565+
* - parseLiteral(ast): Implements "Input Coercion" for literals. Given an
566+
* GraphQL literal (AST) (for example, an argument value), produces an
567+
* internal value valid for this type. Returns undefined or throws an error
568+
* to indicate invalid values.
569+
*
570+
* - valueToLiteral(value): Converts an external value to a GraphQL
571+
* literal (AST). Returns undefined or throws an error to indicate
572+
* invalid values.
573+
*
545574
*/
546575
export class GraphQLScalarType<TInternal = unknown, TExternal = TInternal> {
547576
name: string;
@@ -550,6 +579,7 @@ export class GraphQLScalarType<TInternal = unknown, TExternal = TInternal> {
550579
serialize: GraphQLScalarSerializer<TExternal>;
551580
parseValue: GraphQLScalarValueParser<TInternal>;
552581
parseLiteral: GraphQLScalarLiteralParser<TInternal>;
582+
valueToLiteral: GraphQLScalarValueToLiteral | undefined;
553583
extensions: Readonly<GraphQLScalarTypeExtensions>;
554584
astNode: Maybe<ScalarTypeDefinitionNode>;
555585
extensionASTNodes: ReadonlyArray<ScalarTypeExtensionNode>;
@@ -566,8 +596,8 @@ export class GraphQLScalarType<TInternal = unknown, TExternal = TInternal> {
566596
config.serialize ?? (identityFunc as GraphQLScalarSerializer<TExternal>);
567597
this.parseValue = parseValue;
568598
this.parseLiteral =
569-
config.parseLiteral ??
570-
((node, variables) => parseValue(valueFromASTUntyped(node, variables)));
599+
config.parseLiteral ?? ((node) => parseValue(valueFromASTUntyped(node)));
600+
this.valueToLiteral = config.valueToLiteral;
571601
this.extensions = toObjMap(config.extensions);
572602
this.astNode = config.astNode;
573603
this.extensionASTNodes = config.extensionASTNodes ?? [];
@@ -593,6 +623,7 @@ export class GraphQLScalarType<TInternal = unknown, TExternal = TInternal> {
593623
serialize: this.serialize,
594624
parseValue: this.parseValue,
595625
parseLiteral: this.parseLiteral,
626+
valueToLiteral: this.valueToLiteral,
596627
extensions: this.extensions,
597628
astNode: this.astNode,
598629
extensionASTNodes: this.extensionASTNodes,
@@ -617,9 +648,12 @@ export type GraphQLScalarValueParser<TInternal> = (
617648
) => TInternal;
618649

619650
export type GraphQLScalarLiteralParser<TInternal> = (
620-
valueNode: ValueNode,
621-
variables?: Maybe<ObjMap<unknown>>,
622-
) => TInternal;
651+
valueNode: ConstValueNode,
652+
) => Maybe<TInternal>;
653+
654+
export type GraphQLScalarValueToLiteral = (
655+
inputValue: unknown,
656+
) => ConstValueNode | undefined;
623657

624658
export interface GraphQLScalarTypeConfig<TInternal, TExternal> {
625659
name: string;
@@ -631,6 +665,8 @@ export interface GraphQLScalarTypeConfig<TInternal, TExternal> {
631665
parseValue?: GraphQLScalarValueParser<TInternal> | undefined;
632666
/** Parses an externally provided literal value to use as an input. */
633667
parseLiteral?: GraphQLScalarLiteralParser<TInternal> | undefined;
668+
/** Translates an externally provided value to a literal (AST). */
669+
valueToLiteral?: GraphQLScalarValueToLiteral | undefined;
634670
extensions?: Maybe<Readonly<GraphQLScalarTypeExtensions>>;
635671
astNode?: Maybe<ScalarTypeDefinitionNode>;
636672
extensionASTNodes?: Maybe<ReadonlyArray<ScalarTypeExtensionNode>>;
@@ -1374,10 +1410,7 @@ export class GraphQLEnumType /* <T> */ {
13741410
return enumValue.value;
13751411
}
13761412

1377-
parseLiteral(
1378-
valueNode: ValueNode,
1379-
_variables: Maybe<ObjMap<unknown>>,
1380-
): Maybe<any> /* T */ {
1413+
parseLiteral(valueNode: ConstValueNode): Maybe<any> /* T */ {
13811414
// Note: variables will be resolved to a value before calling this function.
13821415
if (valueNode.kind !== Kind.ENUM) {
13831416
const valueStr = print(valueNode);
@@ -1400,6 +1433,12 @@ export class GraphQLEnumType /* <T> */ {
14001433
return enumValue.value;
14011434
}
14021435

1436+
valueToLiteral(value: unknown): ConstValueNode | undefined {
1437+
if (typeof value === 'string' && this.getValue(value)) {
1438+
return { kind: Kind.ENUM, value };
1439+
}
1440+
}
1441+
14031442
toConfig(): GraphQLEnumTypeNormalizedConfig {
14041443
const values = keyValMap(
14051444
this.getValues(),

‎src/type/scalars.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import { GraphQLError } from '../error/GraphQLError.js';
66
import { Kind } from '../language/kinds.js';
77
import { print } from '../language/printer.js';
88

9+
import { defaultScalarValueToLiteral } from '../utilities/valueToLiteral.js';
10+
911
import type { GraphQLNamedType } from './definition.js';
1012
import { GraphQLScalarType } from './definition.js';
1113

@@ -82,6 +84,16 @@ export const GraphQLInt = new GraphQLScalarType<number>({
8284
}
8385
return num;
8486
},
87+
valueToLiteral(value) {
88+
if (
89+
typeof value === 'number' &&
90+
Number.isInteger(value) &&
91+
value <= GRAPHQL_MAX_INT &&
92+
value >= GRAPHQL_MIN_INT
93+
) {
94+
return { kind: Kind.INT, value: String(value) };
95+
}
96+
},
8597
});
8698

8799
export const GraphQLFloat = new GraphQLScalarType<number>({
@@ -127,6 +139,12 @@ export const GraphQLFloat = new GraphQLScalarType<number>({
127139
}
128140
return parseFloat(valueNode.value);
129141
},
142+
valueToLiteral(value) {
143+
const literal = defaultScalarValueToLiteral(value);
144+
if (literal.kind === Kind.FLOAT || literal.kind === Kind.INT) {
145+
return literal;
146+
}
147+
},
130148
});
131149

132150
export const GraphQLString = new GraphQLScalarType<string>({
@@ -171,6 +189,12 @@ export const GraphQLString = new GraphQLScalarType<string>({
171189
}
172190
return valueNode.value;
173191
},
192+
valueToLiteral(value) {
193+
const literal = defaultScalarValueToLiteral(value);
194+
if (literal.kind === Kind.STRING) {
195+
return literal;
196+
}
197+
},
174198
});
175199

176200
export const GraphQLBoolean = new GraphQLScalarType<boolean>({
@@ -209,6 +233,12 @@ export const GraphQLBoolean = new GraphQLScalarType<boolean>({
209233
}
210234
return valueNode.value;
211235
},
236+
valueToLiteral(value) {
237+
const literal = defaultScalarValueToLiteral(value);
238+
if (literal.kind === Kind.BOOLEAN) {
239+
return literal;
240+
}
241+
},
212242
});
213243

214244
export const GraphQLID = new GraphQLScalarType<string>({
@@ -250,6 +280,16 @@ export const GraphQLID = new GraphQLScalarType<string>({
250280
}
251281
return valueNode.value;
252282
},
283+
valueToLiteral(value) {
284+
// ID types can use number values and Int literals.
285+
const stringValue = Number.isInteger(value) ? String(value) : value;
286+
if (typeof stringValue === 'string') {
287+
// Will parse as an IntValue.
288+
return /^-?(?:0|[1-9][0-9]*)$/.test(stringValue)
289+
? { kind: Kind.INT, value: stringValue }
290+
: { kind: Kind.STRING, value: stringValue, block: false };
291+
}
292+
},
253293
});
254294

255295
export const specifiedScalarTypes: ReadonlyArray<GraphQLScalarType> =

‎src/utilities/__tests__/coerceInputValue-test.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -631,6 +631,13 @@ describe('coerceInputLiteral', () => {
631631
});
632632

633633
test('"value"', printScalar, '~~~"value"~~~');
634+
testWithVariables(
635+
'($var: String)',
636+
{ var: 'value' },
637+
'{ field: $var }',
638+
printScalar,
639+
'~~~{ field: "value" }~~~',
640+
);
634641

635642
const throwScalar = new GraphQLScalarType({
636643
name: 'ThrowScalar',

0 commit comments

Comments
 (0)