/
buildASTSchema-test.js
869 lines (752 loc) · 19.2 KB
/
buildASTSchema-test.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict
*/
import { expect } from 'chai';
import { describe, it } from 'mocha';
import invariant from '../../jsutils/invariant';
import { parse, print } from '../../language';
import { printSchema } from '../schemaPrinter';
import { buildASTSchema, buildSchema } from '../buildASTSchema';
import dedent from '../../jsutils/dedent';
import { Kind } from '../../language/kinds';
import {
assertDirective,
assertObjectType,
assertInputObjectType,
assertEnumType,
assertUnionType,
assertInterfaceType,
assertScalarType,
graphqlSync,
validateSchema,
GraphQLID,
GraphQLInt,
GraphQLFloat,
GraphQLString,
GraphQLBoolean,
GraphQLSkipDirective,
GraphQLIncludeDirective,
GraphQLDeprecatedDirective,
} from '../../';
/**
* This function does a full cycle of going from a string with the contents of
* the SDL, parsed in a schema AST, materializing that schema AST into an
* in-memory GraphQLSchema, and then finally printing that object into the SDL
*/
function cycleSDL(sdl, options = {}) {
const commentDescriptions = options.commentDescriptions || false;
const ast = parse(sdl);
const schema = buildASTSchema(ast, options);
return printSchema(schema, { commentDescriptions });
}
function printNode(node) {
invariant(node);
return print(node);
}
describe('Schema Builder', () => {
it('can use built schema for limited execution', () => {
const schema = buildASTSchema(
parse(`
type Query {
str: String
}
`),
);
const result = graphqlSync(schema, '{ str }', { str: 123 });
expect(result.data).to.deep.equal({ str: '123' });
});
it('can build a schema directly from the source', () => {
const schema = buildSchema(`
type Query {
add(x: Int, y: Int): Int
}
`);
const root = {
add: ({ x, y }) => x + y,
};
expect(graphqlSync(schema, '{ add(x: 34, y: 55) }', root)).to.deep.equal({
data: { add: 89 },
});
});
it('Empty type', () => {
const sdl = dedent`
type EmptyType
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple type', () => {
const sdl = dedent`
type Query {
str: String
int: Int
float: Float
id: ID
bool: Boolean
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
const schema = buildSchema(sdl);
// Built-ins are used
expect(schema.getType('Int')).to.equal(GraphQLInt);
expect(schema.getType('Float')).to.equal(GraphQLFloat);
expect(schema.getType('String')).to.equal(GraphQLString);
expect(schema.getType('Boolean')).to.equal(GraphQLBoolean);
expect(schema.getType('ID')).to.equal(GraphQLID);
});
it('include standard type only if it is used', () => {
const schema = buildSchema(`
type Query {
str: String
}
`);
expect(schema.getType('Int')).to.equal(undefined);
expect(schema.getType('Float')).to.equal(undefined);
expect(schema.getType('ID')).to.equal(undefined);
});
it('With directives', () => {
const sdl = dedent`
directive @foo(arg: Int) on FIELD
type Query {
str: String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Supports descriptions', () => {
const sdl = dedent`
"""This is a directive"""
directive @foo(
"""It has an argument"""
arg: Int
) on FIELD
"""With an enum"""
enum Color {
RED
"""Not a creative color"""
GREEN
BLUE
}
"""What a great type"""
type Query {
"""And a field to boot"""
str: String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Supports option for comment descriptions', () => {
const sdl = dedent`
# This is a directive
directive @foo(
# It has an argument
arg: Int
) on FIELD
# With an enum
enum Color {
RED
# Not a creative color
GREEN
BLUE
}
# What a great type
type Query {
# And a field to boot
str: String
}
`;
expect(cycleSDL(sdl, { commentDescriptions: true })).to.equal(sdl);
});
it('Maintains @skip & @include', () => {
const sdl = `
type Query {
str: String
}
`;
const schema = buildSchema(sdl);
expect(schema.getDirectives()).to.have.lengthOf(3);
expect(schema.getDirective('skip')).to.equal(GraphQLSkipDirective);
expect(schema.getDirective('include')).to.equal(GraphQLIncludeDirective);
expect(schema.getDirective('deprecated')).to.equal(
GraphQLDeprecatedDirective,
);
});
it('Overriding directives excludes specified', () => {
const sdl = `
directive @skip on FIELD
directive @include on FIELD
directive @deprecated on FIELD_DEFINITION
type Query {
str: String
}
`;
const schema = buildSchema(sdl);
expect(schema.getDirectives()).to.have.lengthOf(3);
expect(schema.getDirective('skip')).to.not.equal(GraphQLSkipDirective);
expect(schema.getDirective('include')).to.not.equal(
GraphQLIncludeDirective,
);
expect(schema.getDirective('deprecated')).to.not.equal(
GraphQLDeprecatedDirective,
);
});
it('Adding directives maintains @skip & @include', () => {
const sdl = `
directive @foo(arg: Int) on FIELD
type Query {
str: String
}
`;
const schema = buildSchema(sdl);
expect(schema.getDirectives()).to.have.lengthOf(4);
expect(schema.getDirective('skip')).to.not.equal(undefined);
expect(schema.getDirective('include')).to.not.equal(undefined);
expect(schema.getDirective('deprecated')).to.not.equal(undefined);
});
it('Type modifiers', () => {
const sdl = dedent`
type Query {
nonNullStr: String!
listOfStrs: [String]
listOfNonNullStrs: [String!]
nonNullListOfStrs: [String]!
nonNullListOfNonNullStrs: [String!]!
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Recursive type', () => {
const sdl = dedent`
type Query {
str: String
recurse: Query
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Two types circular', () => {
const sdl = dedent`
schema {
query: TypeOne
}
type TypeOne {
str: String
typeTwo: TypeTwo
}
type TypeTwo {
str: String
typeOne: TypeOne
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Single argument field', () => {
const sdl = dedent`
type Query {
str(int: Int): String
floatToStr(float: Float): String
idToStr(id: ID): String
booleanToStr(bool: Boolean): String
strToStr(bool: String): String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple type with multiple arguments', () => {
const sdl = dedent`
type Query {
str(int: Int, bool: Boolean): String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Empty interface', () => {
const sdl = dedent`
interface EmptyInterface
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple type with interface', () => {
const sdl = dedent`
type Query implements WorldInterface {
str: String
}
interface WorldInterface {
str: String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Empty enum', () => {
const sdl = dedent`
enum EmptyEnum
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple output enum', () => {
const sdl = dedent`
enum Hello {
WORLD
}
type Query {
hello: Hello
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple input enum', () => {
const sdl = dedent`
enum Hello {
WORLD
}
type Query {
str(hello: Hello): String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Multiple value enum', () => {
const sdl = dedent`
enum Hello {
WO
RLD
}
type Query {
hello: Hello
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Empty union', () => {
const sdl = dedent`
union EmptyUnion
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple Union', () => {
const sdl = dedent`
union Hello = World
type Query {
hello: Hello
}
type World {
str: String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Multiple Union', () => {
const sdl = dedent`
union Hello = WorldOne | WorldTwo
type Query {
hello: Hello
}
type WorldOne {
str: String
}
type WorldTwo {
str: String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Can build recursive Union', () => {
const schema = buildSchema(`
union Hello = Hello
type Query {
hello: Hello
}
`);
const errors = validateSchema(schema);
expect(errors).to.have.lengthOf.above(0);
});
it('Specifying Union type using __typename', () => {
const schema = buildSchema(`
type Query {
fruits: [Fruit]
}
union Fruit = Apple | Banana
type Apple {
color: String
}
type Banana {
length: Int
}
`);
const query = `
{
fruits {
... on Apple {
color
}
... on Banana {
length
}
}
}
`;
const root = {
fruits: [
{
color: 'green',
__typename: 'Apple',
},
{
length: 5,
__typename: 'Banana',
},
],
};
expect(graphqlSync(schema, query, root)).to.deep.equal({
data: {
fruits: [
{
color: 'green',
},
{
length: 5,
},
],
},
});
});
it('Specifying Interface type using __typename', () => {
const schema = buildSchema(`
type Query {
characters: [Character]
}
interface Character {
name: String!
}
type Human implements Character {
name: String!
totalCredits: Int
}
type Droid implements Character {
name: String!
primaryFunction: String
}
`);
const query = `
{
characters {
name
... on Human {
totalCredits
}
... on Droid {
primaryFunction
}
}
}
`;
const root = {
characters: [
{
name: 'Han Solo',
totalCredits: 10,
__typename: 'Human',
},
{
name: 'R2-D2',
primaryFunction: 'Astromech',
__typename: 'Droid',
},
],
};
expect(graphqlSync(schema, query, root)).to.deep.equal({
data: {
characters: [
{
name: 'Han Solo',
totalCredits: 10,
},
{
name: 'R2-D2',
primaryFunction: 'Astromech',
},
],
},
});
});
it('Custom Scalar', () => {
const sdl = dedent`
scalar CustomScalar
type Query {
customScalar: CustomScalar
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Empty Input Object', () => {
const sdl = dedent`
input EmptyInputObject
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple Input Object', () => {
const sdl = dedent`
input Input {
int: Int
}
type Query {
field(in: Input): String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple argument field with default', () => {
const sdl = dedent`
type Query {
str(int: Int = 2): String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Custom scalar argument field with default', () => {
const sdl = dedent`
scalar CustomScalar
type Query {
str(int: CustomScalar = 2): String
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple type with mutation', () => {
const sdl = dedent`
schema {
query: HelloScalars
mutation: Mutation
}
type HelloScalars {
str: String
int: Int
bool: Boolean
}
type Mutation {
addHelloScalars(str: String, int: Int, bool: Boolean): HelloScalars
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Simple type with subscription', () => {
const sdl = dedent`
schema {
query: HelloScalars
subscription: Subscription
}
type HelloScalars {
str: String
int: Int
bool: Boolean
}
type Subscription {
subscribeHelloScalars(str: String, int: Int, bool: Boolean): HelloScalars
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Unreferenced type implementing referenced interface', () => {
const sdl = dedent`
type Concrete implements Iface {
key: String
}
interface Iface {
key: String
}
type Query {
iface: Iface
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Unreferenced type implementing referenced union', () => {
const sdl = dedent`
type Concrete {
key: String
}
type Query {
union: Union
}
union Union = Concrete
`;
expect(cycleSDL(sdl)).to.equal(sdl);
});
it('Supports @deprecated', () => {
const sdl = dedent`
enum MyEnum {
VALUE
OLD_VALUE @deprecated
OTHER_VALUE @deprecated(reason: "Terrible reasons")
}
type Query {
field1: String @deprecated
field2: Int @deprecated(reason: "Because I said so")
enum: MyEnum
}
`;
expect(cycleSDL(sdl)).to.equal(sdl);
const schema = buildSchema(sdl);
const myEnum = assertEnumType(schema.getType('MyEnum'));
const value = myEnum.getValue('VALUE');
expect(value).to.include({ isDeprecated: false });
const oldValue = myEnum.getValue('OLD_VALUE');
expect(oldValue).to.include({
isDeprecated: true,
deprecationReason: 'No longer supported',
});
const otherValue = myEnum.getValue('OTHER_VALUE');
expect(otherValue).to.include({
isDeprecated: true,
deprecationReason: 'Terrible reasons',
});
const rootFields = assertObjectType(schema.getType('Query')).getFields();
expect(rootFields.field1).to.include({
isDeprecated: true,
deprecationReason: 'No longer supported',
});
expect(rootFields.field2).to.include({
isDeprecated: true,
deprecationReason: 'Because I said so',
});
});
it('Correctly assign AST nodes', () => {
const sdl = dedent`
schema {
query: Query
}
type Query {
testField(testArg: TestInput): TestUnion
}
input TestInput {
testInputField: TestEnum
}
enum TestEnum {
TEST_VALUE
}
union TestUnion = TestType
interface TestInterface {
interfaceField: String
}
type TestType implements TestInterface {
interfaceField: String
}
scalar TestScalar
directive @test(arg: TestScalar) on FIELD
`;
const ast = parse(sdl, { noLocation: true });
const schema = buildASTSchema(ast);
const query = assertObjectType(schema.getType('Query'));
const testInput = assertInputObjectType(schema.getType('TestInput'));
const testEnum = assertEnumType(schema.getType('TestEnum'));
const testUnion = assertUnionType(schema.getType('TestUnion'));
const testInterface = assertInterfaceType(schema.getType('TestInterface'));
const testType = assertObjectType(schema.getType('TestType'));
const testScalar = assertScalarType(schema.getType('TestScalar'));
const testDirective = assertDirective(schema.getDirective('test'));
const restoredSchemaAST = {
kind: Kind.DOCUMENT,
definitions: [
schema.astNode,
query.astNode,
testInput.astNode,
testEnum.astNode,
testUnion.astNode,
testInterface.astNode,
testType.astNode,
testScalar.astNode,
testDirective.astNode,
],
loc: undefined,
};
expect(restoredSchemaAST).to.be.deep.equal(ast);
const testField = query.getFields().testField;
expect(printNode(testField.astNode)).to.equal(
'testField(testArg: TestInput): TestUnion',
);
expect(printNode(testField.args[0].astNode)).to.equal('testArg: TestInput');
expect(printNode(testInput.getFields().testInputField.astNode)).to.equal(
'testInputField: TestEnum',
);
const testEnumValue = testEnum.getValue('TEST_VALUE');
invariant(testEnumValue);
expect(printNode(testEnumValue.astNode)).to.equal('TEST_VALUE');
expect(
printNode(testInterface.getFields().interfaceField.astNode),
).to.equal('interfaceField: String');
expect(printNode(testType.getFields().interfaceField.astNode)).to.equal(
'interfaceField: String',
);
expect(printNode(testDirective.args[0].astNode)).to.equal(
'arg: TestScalar',
);
});
it('Root operation types with custom names', () => {
const schema = buildSchema(`
schema {
query: SomeQuery
mutation: SomeMutation
subscription: SomeSubscription
}
type SomeQuery { str: String }
type SomeMutation { str: String }
type SomeSubscription { str: String }
`);
expect(schema.getQueryType()).to.include({ name: 'SomeQuery' });
expect(schema.getMutationType()).to.include({ name: 'SomeMutation' });
expect(schema.getSubscriptionType()).to.include({
name: 'SomeSubscription',
});
});
it('Default root operation type names', () => {
const schema = buildSchema(`
type Query { str: String }
type Mutation { str: String }
type Subscription { str: String }
`);
expect(schema.getQueryType()).to.include({ name: 'Query' });
expect(schema.getMutationType()).to.include({ name: 'Mutation' });
expect(schema.getSubscriptionType()).to.include({ name: 'Subscription' });
});
it('can build invalid schema', () => {
const schema = buildSchema(`
# Invalid schema, because it is missing query root type
type Mutation {
str: String
}
`);
const errors = validateSchema(schema);
expect(errors).to.have.lengthOf.above(0);
});
it('Accepts legacy names', () => {
const sdl = `
type Query {
__badName: String
}
`;
const schema = buildSchema(sdl, { allowedLegacyNames: ['__badName'] });
const errors = validateSchema(schema);
expect(errors).to.have.lengthOf(0);
});
it('Rejects invalid SDL', () => {
const sdl = `
type Query {
foo: String @unknown
}
`;
expect(() => buildSchema(sdl)).to.throw('Unknown directive "unknown".');
});
it('Allows to disable SDL validation', () => {
const sdl = `
type Query {
foo: String @unknown
}
`;
buildSchema(sdl, { assumeValid: true });
buildSchema(sdl, { assumeValidSDL: true });
});
});