-
-
Notifications
You must be signed in to change notification settings - Fork 560
/
SchemaExtender.php
662 lines (572 loc) · 23.1 KB
/
SchemaExtender.php
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
<?php
declare(strict_types=1);
namespace GraphQL\Utils;
use GraphQL\Error\Error;
use GraphQL\Language\AST\DirectiveDefinitionNode;
use GraphQL\Language\AST\DocumentNode;
use GraphQL\Language\AST\EnumTypeExtensionNode;
use GraphQL\Language\AST\InputObjectTypeExtensionNode;
use GraphQL\Language\AST\InterfaceTypeExtensionNode;
use GraphQL\Language\AST\Node;
use GraphQL\Language\AST\ObjectTypeExtensionNode;
use GraphQL\Language\AST\SchemaDefinitionNode;
use GraphQL\Language\AST\SchemaTypeExtensionNode;
use GraphQL\Language\AST\TypeDefinitionNode;
use GraphQL\Language\AST\TypeExtensionNode;
use GraphQL\Language\AST\UnionTypeExtensionNode;
use GraphQL\Type\Definition\CustomScalarType;
use GraphQL\Type\Definition\Directive;
use GraphQL\Type\Definition\EnumType;
use GraphQL\Type\Definition\EnumValueDefinition;
use GraphQL\Type\Definition\FieldArgument;
use GraphQL\Type\Definition\ImplementingType;
use GraphQL\Type\Definition\InputObjectType;
use GraphQL\Type\Definition\InterfaceType;
use GraphQL\Type\Definition\ListOfType;
use GraphQL\Type\Definition\NamedType;
use GraphQL\Type\Definition\NonNull;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\ScalarType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\UnionType;
use GraphQL\Type\Introspection;
use GraphQL\Type\Schema;
use GraphQL\Validator\DocumentValidator;
use function array_keys;
use function array_map;
use function array_merge;
use function count;
class SchemaExtender
{
public const SCHEMA_EXTENSION = 'SchemaExtension';
/** @var Type[] */
protected static $extendTypeCache;
/** @var mixed[] */
protected static $typeExtensionsMap;
/** @var ASTDefinitionBuilder */
protected static $astBuilder;
/**
* @return TypeExtensionNode[]|null
*/
protected static function getExtensionASTNodes(NamedType $type): ?array
{
if (! $type instanceof Type) {
return null;
}
$name = $type->name;
if ($type->extensionASTNodes !== null) {
if (isset(static::$typeExtensionsMap[$name])) {
return array_merge($type->extensionASTNodes, static::$typeExtensionsMap[$name]);
}
return $type->extensionASTNodes;
}
return static::$typeExtensionsMap[$name] ?? null;
}
/**
* @throws Error
*/
protected static function checkExtensionNode(Type $type, Node $node): void
{
switch (true) {
case $node instanceof ObjectTypeExtensionNode:
if (! ($type instanceof ObjectType)) {
throw new Error(
'Cannot extend non-object type "' . $type->name . '".',
[$node]
);
}
break;
case $node instanceof InterfaceTypeExtensionNode:
if (! ($type instanceof InterfaceType)) {
throw new Error(
'Cannot extend non-interface type "' . $type->name . '".',
[$node]
);
}
break;
case $node instanceof EnumTypeExtensionNode:
if (! ($type instanceof EnumType)) {
throw new Error(
'Cannot extend non-enum type "' . $type->name . '".',
[$node]
);
}
break;
case $node instanceof UnionTypeExtensionNode:
if (! ($type instanceof UnionType)) {
throw new Error(
'Cannot extend non-union type "' . $type->name . '".',
[$node]
);
}
break;
case $node instanceof InputObjectTypeExtensionNode:
if (! ($type instanceof InputObjectType)) {
throw new Error(
'Cannot extend non-input object type "' . $type->name . '".',
[$node]
);
}
break;
}
}
protected static function extendScalarType(ScalarType $type): CustomScalarType
{
return new CustomScalarType([
'name' => $type->name,
'description' => $type->description,
'astNode' => $type->astNode,
'serialize' => $type->config['serialize'] ?? null,
'parseValue' => $type->config['parseValue'] ?? null,
'parseLiteral' => $type->config['parseLiteral'] ?? null,
'extensionASTNodes' => static::getExtensionASTNodes($type),
]);
}
protected static function extendUnionType(UnionType $type): UnionType
{
return new UnionType([
'name' => $type->name,
'description' => $type->description,
'types' => static function () use ($type): array {
return static::extendPossibleTypes($type);
},
'astNode' => $type->astNode,
'resolveType' => $type->config['resolveType'] ?? null,
'extensionASTNodes' => static::getExtensionASTNodes($type),
]);
}
protected static function extendEnumType(EnumType $type): EnumType
{
return new EnumType([
'name' => $type->name,
'description' => $type->description,
'values' => static::extendValueMap($type),
'astNode' => $type->astNode,
'extensionASTNodes' => static::getExtensionASTNodes($type),
]);
}
protected static function extendInputObjectType(InputObjectType $type): InputObjectType
{
return new InputObjectType([
'name' => $type->name,
'description' => $type->description,
'fields' => static function () use ($type): array {
return static::extendInputFieldMap($type);
},
'astNode' => $type->astNode,
'extensionASTNodes' => static::getExtensionASTNodes($type),
]);
}
/**
* @return mixed[]
*/
protected static function extendInputFieldMap(InputObjectType $type): array
{
$newFieldMap = [];
$oldFieldMap = $type->getFields();
foreach ($oldFieldMap as $fieldName => $field) {
$newFieldMap[$fieldName] = [
'description' => $field->description,
'type' => static::extendType($field->getType()),
'astNode' => $field->astNode,
];
if (! $field->defaultValueExists()) {
continue;
}
$newFieldMap[$fieldName]['defaultValue'] = $field->defaultValue;
}
$extensions = static::$typeExtensionsMap[$type->name] ?? null;
if ($extensions !== null) {
foreach ($extensions as $extension) {
foreach ($extension->fields as $field) {
$fieldName = $field->name->value;
if (isset($oldFieldMap[$fieldName])) {
throw new Error('Field "' . $type->name . '.' . $fieldName . '" already exists in the schema. It cannot also be defined in this type extension.', [$field]);
}
$newFieldMap[$fieldName] = static::$astBuilder->buildInputField($field);
}
}
}
return $newFieldMap;
}
/**
* @return mixed[]
*/
protected static function extendValueMap(EnumType $type): array
{
$newValueMap = [];
/** @var EnumValueDefinition[] $oldValueMap */
$oldValueMap = [];
foreach ($type->getValues() as $value) {
$oldValueMap[$value->name] = $value;
}
foreach ($oldValueMap as $key => $value) {
$newValueMap[$key] = [
'name' => $value->name,
'description' => $value->description,
'value' => $value->value,
'deprecationReason' => $value->deprecationReason,
'astNode' => $value->astNode,
];
}
$extensions = static::$typeExtensionsMap[$type->name] ?? null;
if ($extensions !== null) {
foreach ($extensions as $extension) {
foreach ($extension->values as $value) {
$valueName = $value->name->value;
if (isset($oldValueMap[$valueName])) {
throw new Error('Enum value "' . $type->name . '.' . $valueName . '" already exists in the schema. It cannot also be defined in this type extension.', [$value]);
}
$newValueMap[$valueName] = static::$astBuilder->buildEnumValue($value);
}
}
}
return $newValueMap;
}
/**
* @return ObjectType[]
*/
protected static function extendPossibleTypes(UnionType $type): array
{
$possibleTypes = array_map(
[static::class, 'extendNamedType'],
$type->getTypes()
);
$extensions = static::$typeExtensionsMap[$type->name] ?? null;
if ($extensions !== null) {
foreach ($extensions as $extension) {
foreach ($extension->types as $namedType) {
$possibleTypes[] = static::$astBuilder->buildType($namedType);
}
}
}
return $possibleTypes;
}
/**
* @param ObjectType|InterfaceType $type
*
* @return array<int, InterfaceType>
*/
protected static function extendImplementedInterfaces(ImplementingType $type): array
{
$interfaces = array_map(
[static::class, 'extendNamedType'],
$type->getInterfaces()
);
$extensions = static::$typeExtensionsMap[$type->name] ?? null;
if ($extensions !== null) {
/** @var ObjectTypeExtensionNode|InterfaceTypeExtensionNode $extension */
foreach ($extensions as $extension) {
foreach ($extension->interfaces as $namedType) {
$interfaces[] = static::$astBuilder->buildType($namedType);
}
}
}
return $interfaces;
}
protected static function extendType($typeDef)
{
if ($typeDef instanceof ListOfType) {
return Type::listOf(static::extendType($typeDef->getOfType()));
}
if ($typeDef instanceof NonNull) {
return Type::nonNull(static::extendType($typeDef->getWrappedType()));
}
return static::extendNamedType($typeDef);
}
/**
* @param FieldArgument[] $args
*
* @return mixed[]
*/
protected static function extendArgs(array $args): array
{
return Utils::keyValMap(
$args,
static function (FieldArgument $arg): string {
return $arg->name;
},
static function (FieldArgument $arg): array {
$def = [
'type' => static::extendType($arg->getType()),
'description' => $arg->description,
'astNode' => $arg->astNode,
];
if ($arg->defaultValueExists()) {
$def['defaultValue'] = $arg->defaultValue;
}
return $def;
}
);
}
/**
* @param InterfaceType|ObjectType $type
*
* @return mixed[]
*
* @throws Error
*/
protected static function extendFieldMap($type): array
{
$newFieldMap = [];
$oldFieldMap = $type->getFields();
foreach (array_keys($oldFieldMap) as $fieldName) {
$field = $oldFieldMap[$fieldName];
$newFieldMap[$fieldName] = [
'name' => $fieldName,
'description' => $field->description,
'deprecationReason' => $field->deprecationReason,
'type' => static::extendType($field->getType()),
'args' => static::extendArgs($field->args),
'astNode' => $field->astNode,
'resolve' => $field->resolveFn,
];
}
$extensions = static::$typeExtensionsMap[$type->name] ?? null;
if ($extensions !== null) {
foreach ($extensions as $extension) {
foreach ($extension->fields as $field) {
$fieldName = $field->name->value;
if (isset($oldFieldMap[$fieldName])) {
throw new Error('Field "' . $type->name . '.' . $fieldName . '" already exists in the schema. It cannot also be defined in this type extension.', [$field]);
}
$newFieldMap[$fieldName] = static::$astBuilder->buildField($field);
}
}
}
return $newFieldMap;
}
protected static function extendObjectType(ObjectType $type): ObjectType
{
return new ObjectType([
'name' => $type->name,
'description' => $type->description,
'interfaces' => static function () use ($type): array {
return static::extendImplementedInterfaces($type);
},
'fields' => static function () use ($type): array {
return static::extendFieldMap($type);
},
'astNode' => $type->astNode,
'extensionASTNodes' => static::getExtensionASTNodes($type),
'isTypeOf' => $type->config['isTypeOf'] ?? null,
'resolveField' => $type->resolveFieldFn ?? null,
]);
}
protected static function extendInterfaceType(InterfaceType $type): InterfaceType
{
return new InterfaceType([
'name' => $type->name,
'description' => $type->description,
'interfaces' => static function () use ($type): array {
return static::extendImplementedInterfaces($type);
},
'fields' => static function () use ($type): array {
return static::extendFieldMap($type);
},
'astNode' => $type->astNode,
'extensionASTNodes' => static::getExtensionASTNodes($type),
'resolveType' => $type->config['resolveType'] ?? null,
]);
}
protected static function isSpecifiedScalarType(Type $type): bool
{
return $type instanceof NamedType &&
(
$type->name === Type::STRING ||
$type->name === Type::INT ||
$type->name === Type::FLOAT ||
$type->name === Type::BOOLEAN ||
$type->name === Type::ID
);
}
protected static function extendNamedType(Type $type)
{
if (Introspection::isIntrospectionType($type) || static::isSpecifiedScalarType($type)) {
return $type;
}
$name = $type->name;
if (! isset(static::$extendTypeCache[$name])) {
if ($type instanceof ScalarType) {
static::$extendTypeCache[$name] = static::extendScalarType($type);
} elseif ($type instanceof ObjectType) {
static::$extendTypeCache[$name] = static::extendObjectType($type);
} elseif ($type instanceof InterfaceType) {
static::$extendTypeCache[$name] = static::extendInterfaceType($type);
} elseif ($type instanceof UnionType) {
static::$extendTypeCache[$name] = static::extendUnionType($type);
} elseif ($type instanceof EnumType) {
static::$extendTypeCache[$name] = static::extendEnumType($type);
} elseif ($type instanceof InputObjectType) {
static::$extendTypeCache[$name] = static::extendInputObjectType($type);
}
}
return static::$extendTypeCache[$name];
}
/**
* @return mixed|null
*/
protected static function extendMaybeNamedType(?NamedType $type = null)
{
if ($type !== null) {
return static::extendNamedType($type);
}
return null;
}
/**
* @param DirectiveDefinitionNode[] $directiveDefinitions
*
* @return Directive[]
*/
protected static function getMergedDirectives(Schema $schema, array $directiveDefinitions): array
{
$directives = array_map(
[static::class, 'extendDirective'],
$schema->getDirectives()
);
Utils::invariant(count($directives) > 0, 'schema must have default directives');
foreach ($directiveDefinitions as $directive) {
$directives[] = static::$astBuilder->buildDirective($directive);
}
return $directives;
}
protected static function extendDirective(Directive $directive): Directive
{
return new Directive([
'name' => $directive->name,
'description' => $directive->description,
'locations' => $directive->locations,
'args' => static::extendArgs($directive->args),
'astNode' => $directive->astNode,
'isRepeatable' => $directive->isRepeatable,
]);
}
/**
* @param array<string, bool> $options
*/
public static function extend(
Schema $schema,
DocumentNode $documentAST,
array $options = [],
?callable $typeConfigDecorator = null
): Schema {
if (! (isset($options['assumeValid']) || isset($options['assumeValidSDL']))) {
DocumentValidator::assertValidSDLExtension($documentAST, $schema);
}
/** @var array<string, Node&TypeDefinitionNode> $typeDefinitionMap */
$typeDefinitionMap = [];
static::$typeExtensionsMap = [];
$directiveDefinitions = [];
/** @var SchemaDefinitionNode|null $schemaDef */
$schemaDef = null;
/** @var array<int, SchemaTypeExtensionNode> $schemaExtensions */
$schemaExtensions = [];
$definitionsCount = count($documentAST->definitions);
for ($i = 0; $i < $definitionsCount; $i++) {
/** @var Node $def */
$def = $documentAST->definitions[$i];
if ($def instanceof SchemaDefinitionNode) {
$schemaDef = $def;
} elseif ($def instanceof SchemaTypeExtensionNode) {
$schemaExtensions[] = $def;
} elseif ($def instanceof TypeDefinitionNode) {
$typeName = isset($def->name) ? $def->name->value : null;
try {
$type = $schema->getType($typeName);
} catch (Error $error) {
$type = null;
}
if ($type !== null) {
throw new Error('Type "' . $typeName . '" already exists in the schema. It cannot also be defined in this type definition.', [$def]);
}
$typeDefinitionMap[$typeName] = $def;
} elseif ($def instanceof TypeExtensionNode) {
$extendedTypeName = isset($def->name) ? $def->name->value : null;
$existingType = $schema->getType($extendedTypeName);
if ($existingType === null) {
throw new Error('Cannot extend type "' . $extendedTypeName . '" because it does not exist in the existing schema.', [$def]);
}
static::checkExtensionNode($existingType, $def);
$existingTypeExtensions = static::$typeExtensionsMap[$extendedTypeName] ?? null;
static::$typeExtensionsMap[$extendedTypeName] = $existingTypeExtensions !== null ? array_merge($existingTypeExtensions, [$def]) : [$def];
} elseif ($def instanceof DirectiveDefinitionNode) {
$directiveName = $def->name->value;
$existingDirective = $schema->getDirective($directiveName);
if ($existingDirective !== null) {
throw new Error('Directive "' . $directiveName . '" already exists in the schema. It cannot be redefined.', [$def]);
}
$directiveDefinitions[] = $def;
}
}
if (
count(static::$typeExtensionsMap) === 0
&& count($typeDefinitionMap) === 0
&& count($directiveDefinitions) === 0
&& count($schemaExtensions) === 0
&& $schemaDef === null
) {
return $schema;
}
static::$astBuilder = new ASTDefinitionBuilder(
$typeDefinitionMap,
$options,
static function (string $typeName) use ($schema) {
/** @var ScalarType|ObjectType|InterfaceType|UnionType|EnumType|InputObjectType $existingType */
$existingType = $schema->getType($typeName);
if ($existingType !== null) {
return static::extendNamedType($existingType);
}
throw new Error('Unknown type: "' . $typeName . '". Ensure that this type exists either in the original schema, or is added in a type definition.', [$typeName]);
},
$typeConfigDecorator
);
static::$extendTypeCache = [];
$operationTypes = [
'query' => static::extendMaybeNamedType($schema->getQueryType()),
'mutation' => static::extendMaybeNamedType($schema->getMutationType()),
'subscription' => static::extendMaybeNamedType($schema->getSubscriptionType()),
];
if ($schemaDef !== null) {
foreach ($schemaDef->operationTypes as $operationType) {
$operation = $operationType->operation;
$type = $operationType->type;
if (isset($operationTypes[$operation])) {
throw new Error('Must provide only one ' . $operation . ' type in schema.');
}
$operationTypes[$operation] = static::$astBuilder->buildType($type);
}
}
foreach ($schemaExtensions as $schemaExtension) {
if (! isset($schemaExtension->operationTypes)) {
continue;
}
foreach ($schemaExtension->operationTypes as $operationType) {
$operation = $operationType->operation;
if (isset($operationTypes[$operation])) {
throw new Error('Must provide only one ' . $operation . ' type in schema.');
}
$operationTypes[$operation] = static::$astBuilder->buildType($operationType->type);
}
}
$schemaExtensionASTNodes = array_merge($schema->extensionASTNodes, $schemaExtensions);
$types = [];
// Iterate through all types, getting the type definition for each, ensuring
// that any type not directly referenced by a field will get created.
foreach ($schema->getTypeMap() as $type) {
$types[] = static::extendNamedType($type);
}
// Do the same with new types.
foreach ($typeDefinitionMap as $type) {
$types[] = static::$astBuilder->buildType($type);
}
return new Schema([
'query' => $operationTypes['query'],
'mutation' => $operationTypes['mutation'],
'subscription' => $operationTypes['subscription'],
'types' => $types,
'directives' => static::getMergedDirectives($schema, $directiveDefinitions),
'astNode' => $schema->getAstNode(),
'extensionASTNodes' => $schemaExtensionASTNodes,
]);
}
}