Repository navigation
Expand file tree
/
Copy pathGraphQLSchema.java
More file actions
1474 lines (1325 loc) · 61.9 KB
/
Copy pathGraphQLSchema.java
File metadata and controls
1474 lines (1325 loc) · 61.9 KB
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
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package graphql.schema;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import graphql.Assert;
import graphql.AssertException;
import graphql.Directives;
import graphql.Scalars;
import graphql.DirectivesUtil;
import graphql.ExperimentalApi;
import graphql.Internal;
import graphql.PublicApi;
import graphql.collect.ImmutableKit;
import graphql.introspection.Introspection;
import graphql.language.SchemaDefinition;
import graphql.language.SchemaExtensionDefinition;
import graphql.schema.impl.GraphQLTypeCollectingVisitor;
import graphql.schema.impl.SchemaUtil;
import graphql.schema.validation.InvalidSchemaException;
import graphql.schema.validation.SchemaValidationError;
import graphql.schema.validation.SchemaValidator;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.NullUnmarked;
import org.jspecify.annotations.Nullable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
import static graphql.Assert.assertNotNull;
import static graphql.Assert.assertShouldNeverHappen;
import static graphql.Assert.assertTrue;
import static graphql.collect.ImmutableKit.emptyList;
import static graphql.collect.ImmutableKit.map;
import static graphql.collect.ImmutableKit.nonNullCopyOf;
import static graphql.schema.GraphqlTypeComparators.byNameAsc;
import static graphql.schema.GraphqlTypeComparators.sortTypes;
import static java.util.Collections.singletonList;
/**
* The schema represents the combined type system of the graphql engine. This is how the engine knows
* what graphql queries represent what data.
* <p>
* See <a href="https://graphql.org/learn/schema/#type-language">https://graphql.org/learn/schema/#type-language</a> for more details
*/
@PublicApi
@NullMarked
public class GraphQLSchema {
private final GraphQLObjectType queryType;
private final @Nullable GraphQLObjectType mutationType;
private final @Nullable GraphQLObjectType subscriptionType;
private final GraphQLObjectType introspectionSchemaType;
private final ImmutableSet<GraphQLNamedType> additionalTypes;
private final GraphQLFieldDefinition introspectionSchemaField;
private final GraphQLFieldDefinition introspectionTypeField;
// we don't allow modification of "__typename" - it's a scalar
private final GraphQLFieldDefinition __typename = Introspection.TypeNameMetaFieldDef;
private final DirectivesUtil.DirectivesHolder directiveDefinitionsHolder;
private final DirectivesUtil.DirectivesHolder schemaAppliedDirectivesHolder;
private final @Nullable SchemaDefinition definition;
private final ImmutableList<SchemaExtensionDefinition> extensionDefinitions;
private final @Nullable String description;
private final GraphQLCodeRegistry codeRegistry;
private final ImmutableMap<String, GraphQLNamedType> typeMap;
private final ImmutableMap<String, ImmutableList<GraphQLObjectType>> interfaceNameToObjectTypes;
private final ImmutableMap<String, ImmutableList<String>> interfaceNameToObjectTypeNames;
/*
* This constructs partial GraphQL schema object which has the schema (query / mutation / subscription) trees
* in it but it does not have the collected types, the correct code registry nor the type references replaced
*
* But it can be traversed to discover all that and filled out later via another constructor.
*
*/
@Internal
private GraphQLSchema(Builder builder) {
assertNotNull(builder.additionalTypes, "additionalTypes can't be null");
assertNotNull(builder.queryType, "queryType can't be null");
assertNotNull(builder.additionalDirectives, "directives can't be null");
assertNotNull(builder.codeRegistry, "codeRegistry can't be null");
this.queryType = builder.queryType;
this.mutationType = builder.mutationType;
this.subscriptionType = builder.subscriptionType;
this.additionalTypes = ImmutableSet.copyOf(builder.additionalTypes);
this.introspectionSchemaType = builder.introspectionSchemaType;
this.introspectionSchemaField = Introspection.buildSchemaField(builder.introspectionSchemaType);
this.introspectionTypeField = Introspection.buildTypeField(builder.introspectionSchemaType);
this.directiveDefinitionsHolder = new DirectivesUtil.DirectivesHolder(builder.additionalDirectives, emptyList());
this.schemaAppliedDirectivesHolder = new DirectivesUtil.DirectivesHolder(builder.schemaDirectives, builder.schemaAppliedDirectives);
this.definition = builder.definition;
this.extensionDefinitions = nonNullCopyOf(builder.extensionDefinitions);
this.description = builder.description;
this.codeRegistry = builder.codeRegistry;
this.typeMap = ImmutableKit.emptyMap();
this.interfaceNameToObjectTypes = ImmutableKit.emptyMap();
this.interfaceNameToObjectTypeNames = ImmutableKit.emptyMap();
}
/*
* This constructs a fully fledged graphql schema object that has not yet had its type references replaced
* but it's otherwise complete
*/
@Internal
public GraphQLSchema(GraphQLSchema existingSchema,
GraphQLCodeRegistry codeRegistry,
ImmutableMap<String, GraphQLNamedType> typeMap,
ImmutableMap<String, ImmutableList<GraphQLObjectType>> interfaceNameToObjectTypes
) {
assertNotNull(codeRegistry, "codeRegistry can't be null");
this.queryType = existingSchema.queryType;
this.mutationType = existingSchema.mutationType;
this.subscriptionType = existingSchema.subscriptionType;
this.additionalTypes = ImmutableSet.copyOf(existingSchema.additionalTypes);
this.introspectionSchemaType = existingSchema.introspectionSchemaType;
this.introspectionSchemaField = Introspection.buildSchemaField(existingSchema.introspectionSchemaType);
this.introspectionTypeField = Introspection.buildTypeField(existingSchema.introspectionSchemaType);
this.directiveDefinitionsHolder = existingSchema.directiveDefinitionsHolder;
this.schemaAppliedDirectivesHolder = existingSchema.schemaAppliedDirectivesHolder;
this.definition = existingSchema.definition;
this.extensionDefinitions = existingSchema.extensionDefinitions;
this.description = existingSchema.description;
this.codeRegistry = codeRegistry;
this.typeMap = typeMap;
this.interfaceNameToObjectTypes = interfaceNameToObjectTypes;
this.interfaceNameToObjectTypeNames = buildInterfacesToObjectName(interfaceNameToObjectTypes);
}
/*
* a constructor aimed at the simple builder - the type tree can be taken as is!
*/
@Internal
public GraphQLSchema(BuilderWithoutTypes builder) {
assertNotNull(builder.codeRegistry, "codeRegistry can't be null");
GraphQLSchema existingSchema = builder.existingSchema;
this.queryType = existingSchema.queryType;
this.mutationType = existingSchema.mutationType;
this.subscriptionType = existingSchema.subscriptionType;
this.additionalTypes = existingSchema.additionalTypes;
this.introspectionSchemaType = existingSchema.introspectionSchemaType;
this.introspectionSchemaField = existingSchema.introspectionSchemaField;
this.introspectionTypeField = existingSchema.introspectionTypeField;
this.directiveDefinitionsHolder = existingSchema.directiveDefinitionsHolder;
this.schemaAppliedDirectivesHolder = existingSchema.schemaAppliedDirectivesHolder;
this.definition = existingSchema.definition;
this.extensionDefinitions = existingSchema.extensionDefinitions;
this.typeMap = existingSchema.typeMap;
this.interfaceNameToObjectTypes = existingSchema.interfaceNameToObjectTypes;
this.interfaceNameToObjectTypeNames = existingSchema.interfaceNameToObjectTypeNames;
this.description = builder.description;
this.codeRegistry = builder.codeRegistry;
}
/**
* Private constructor for FastBuilder that copies data from the builder
* and converts mutable collections to immutable ones.
*/
@Internal
private GraphQLSchema(FastBuilder fastBuilder) {
// Build immutable collections from FastBuilder's mutable state
ImmutableMap<String, GraphQLNamedType> finalTypeMap = ImmutableMap.copyOf(fastBuilder.typeMap);
ImmutableList<GraphQLDirective> finalDirectives = ImmutableList.copyOf(fastBuilder.directiveMap.values());
// Get interface-to-object-type-names map from collector (already sorted)
ImmutableMap<String, ImmutableList<String>> finalInterfaceNameMap =
fastBuilder.shallowTypeRefCollector.getInterfaceNameToObjectTypeNames();
// Build interface-to-object-types map by looking up types in typeMap
ImmutableMap.Builder<String, ImmutableList<GraphQLObjectType>> interfaceMapBuilder = ImmutableMap.builder();
for (Map.Entry<String, ImmutableList<String>> entry : finalInterfaceNameMap.entrySet()) {
ImmutableList<GraphQLObjectType> objectTypes = map(entry.getValue(),
name -> (GraphQLObjectType) assertNotNull(finalTypeMap.get(name)));
interfaceMapBuilder.put(entry.getKey(), objectTypes);
}
ImmutableMap<String, ImmutableList<GraphQLObjectType>> finalInterfaceMap = interfaceMapBuilder.build();
// Initialize all fields
this.queryType = fastBuilder.queryType;
this.mutationType = fastBuilder.mutationType;
this.subscriptionType = fastBuilder.subscriptionType;
this.introspectionSchemaType = fastBuilder.introspectionSchemaType;
// Compute additionalTypes as all types minus root types.
// Note: Unlike the standard Builder which computes only "detached" types (types not
// reachable from roots), FastBuilder includes ALL non-root types in additionalTypes.
// This is a semantic difference but does not affect schema traversal or correctness.
Set<String> rootTypeNames = new LinkedHashSet<>();
rootTypeNames.add(fastBuilder.queryType.getName());
if (fastBuilder.mutationType != null) {
rootTypeNames.add(fastBuilder.mutationType.getName());
}
if (fastBuilder.subscriptionType != null) {
rootTypeNames.add(fastBuilder.subscriptionType.getName());
}
this.additionalTypes = finalTypeMap.values().stream()
.filter(type -> !rootTypeNames.contains(type.getName()))
.collect(ImmutableSet.toImmutableSet());
this.introspectionSchemaField = Introspection.buildSchemaField(fastBuilder.introspectionSchemaType);
this.introspectionTypeField = Introspection.buildTypeField(fastBuilder.introspectionSchemaType);
this.directiveDefinitionsHolder = new DirectivesUtil.DirectivesHolder(finalDirectives, emptyList());
this.schemaAppliedDirectivesHolder = new DirectivesUtil.DirectivesHolder(
ImmutableList.copyOf(fastBuilder.schemaDirectives),
ImmutableList.copyOf(fastBuilder.schemaAppliedDirectives));
this.definition = fastBuilder.definition;
this.extensionDefinitions = nonNullCopyOf(fastBuilder.extensionDefinitions);
this.description = fastBuilder.description;
this.codeRegistry = fastBuilder.codeRegistryBuilder.build();
this.typeMap = finalTypeMap;
this.interfaceNameToObjectTypes = finalInterfaceMap;
this.interfaceNameToObjectTypeNames = finalInterfaceNameMap;
}
private static GraphQLDirective[] schemaDirectivesArray(GraphQLSchema existingSchema) {
return existingSchema.schemaAppliedDirectivesHolder.getDirectives().toArray(new GraphQLDirective[0]);
}
private static GraphQLAppliedDirective[] schemaAppliedDirectivesArray(GraphQLSchema existingSchema) {
return existingSchema.schemaAppliedDirectivesHolder.getAppliedDirectives().toArray(new GraphQLAppliedDirective[0]);
}
private static List<GraphQLNamedType> getAllTypesAsList(ImmutableMap<String, GraphQLNamedType> typeMap) {
return sortTypes(byNameAsc(), typeMap.values());
}
private static ImmutableMap<String, ImmutableList<GraphQLObjectType>> buildInterfacesToObjectTypes(Map<String, List<GraphQLObjectType>> groupImplementations) {
ImmutableMap.Builder<String, ImmutableList<GraphQLObjectType>> map = ImmutableMap.builder();
for (Map.Entry<String, List<GraphQLObjectType>> e : groupImplementations.entrySet()) {
ImmutableList<GraphQLObjectType> sortedObjectTypes = ImmutableList.copyOf(sortTypes(byNameAsc(), e.getValue()));
map.put(e.getKey(), sortedObjectTypes);
}
return map.build();
}
private static ImmutableMap<String, ImmutableList<String>> buildInterfacesToObjectName(ImmutableMap<String, ImmutableList<GraphQLObjectType>> byInterface) {
ImmutableMap.Builder<String, ImmutableList<String>> map = ImmutableMap.builder();
for (Map.Entry<String, ImmutableList<GraphQLObjectType>> e : byInterface.entrySet()) {
ImmutableList<String> objectTypeNames = map(e.getValue(), GraphQLObjectType::getName);
map.put(e.getKey(), objectTypeNames);
}
return map.build();
}
public GraphQLCodeRegistry getCodeRegistry() {
return codeRegistry;
}
/**
* @return the special system field called "__schema"
*/
public GraphQLFieldDefinition getIntrospectionSchemaFieldDefinition() {
return introspectionSchemaField;
}
/**
* @return the special system field called "__type"
*/
public GraphQLFieldDefinition getIntrospectionTypeFieldDefinition() {
return introspectionTypeField;
}
/**
* @return the special system field called "__typename"
*/
public GraphQLFieldDefinition getIntrospectionTypenameFieldDefinition() {
return __typename;
}
public GraphQLObjectType getIntrospectionSchemaType() {
return introspectionSchemaType;
}
/**
* Returns the set of "additional types" that were provided when building the schema.
* <p>
* During schema construction, types are discovered by traversing the schema from multiple roots:
* <ul>
* <li>Root operation types (Query, Mutation, Subscription)</li>
* <li>Directive argument types</li>
* <li>Introspection types</li>
* <li>Types explicitly added via {@link Builder#additionalType(GraphQLNamedType)}</li>
* </ul>
* <p>
* Additional types are types that are not reachable via any of the automatic traversal paths
* but still need to be part of the schema. The most common use case is for interface
* implementations that are not directly referenced elsewhere.
* <p>
* <b>Types that do NOT need to be added as additional types:</b>
* <ul>
* <li>Types reachable from Query, Mutation, or Subscription fields</li>
* <li>Types used as directive arguments (these are discovered via directive traversal)</li>
* </ul>
* <p>
* <b>When additional types ARE typically needed:</b>
* <ul>
* <li><b>Interface implementations:</b> When an interface is used as a field's return type,
* implementing object types are not automatically discovered because interfaces do not
* reference their implementors. These need to be added so they can be resolved at runtime
* and appear in introspection.</li>
* <li><b>SDL-defined schemas:</b> When building from SDL, the {@link graphql.schema.idl.SchemaGenerator}
* automatically detects types not connected to any root and adds them as additional types.</li>
* <li><b>Programmatic schemas with type references:</b> When using {@link GraphQLTypeReference}
* to break circular dependencies, the actual type implementations may need to be provided
* as additional types.</li>
* </ul>
* <p>
* <b>Example - Interface implementation not directly referenced:</b>
* <pre>{@code
* // Given this schema:
* // type Query { node: Node }
* // interface Node { id: ID! }
* // type User implements Node { id: ID!, name: String }
* //
* // User is not directly referenced from Query, so it needs to be added:
* GraphQLSchema.newSchema()
* .query(queryType)
* .additionalType(GraphQLObjectType.newObject().name("User")...)
* .build();
* }</pre>
* <p>
* <b>Note:</b> There are no restrictions on what types can be added via this mechanism.
* Types that are already reachable from other roots can also be added without causing
* errors - they will simply be present in both the type map (via traversal) and this set.
* After schema construction, use {@link #getTypeMap()} or {@link #getAllTypesAsList()} to get
* all types in the schema regardless of how they were discovered.
* <p>
* <b>Note on FastBuilder:</b> When a schema is constructed using {@link FastBuilder},
* this method returns ALL types in the schema except the root operation types (Query,
* Mutation, Subscription). This differs from schemas built with the standard
* {@link Builder}, which returns only types not reachable from the root types.
* This semantic difference does not affect schema traversal or correctness, as both
* approaches ensure all types are properly discoverable.
*
* @return an immutable set of types that were explicitly added as additional types
*
* @see Builder#additionalType(GraphQLNamedType)
* @see Builder#additionalTypes(Set)
*/
public Set<GraphQLNamedType> getAdditionalTypes() {
return additionalTypes;
}
/**
* Gets the named type from the schema or null if it's not present
*
* @param typeName the name of the type to retrieve
*
* @return the type
*/
public @Nullable GraphQLType getType(String typeName) {
return typeMap.get(typeName);
}
/**
* All types with the provided names.
* throws {@link graphql.AssertException} when a type name could not be resolved
*
* @param typeNames the type names to get
* @param <T> for two
*
* @return The List of resolved types.
*/
@SuppressWarnings("unchecked")
public <T extends GraphQLType> List<T> getTypes(Collection<String> typeNames) {
ImmutableList.Builder<T> builder = ImmutableList.builder();
for (String typeName : typeNames) {
builder.add((T) assertNotNull(typeMap.get(typeName), "No type found for name %s", typeName));
}
return builder.build();
}
/**
* Gets the named type from the schema or null if it's not present.
* <p>
* Warning - you are inviting class cast errors if the types are not what you expect.
*
* @param typeName the name of the type to retrieve
* @param <T> for two
*
* @return the type cast to the target type.
*/
public <T extends GraphQLType> @Nullable T getTypeAs(String typeName) {
//noinspection unchecked
return (T) typeMap.get(typeName);
}
/**
* Returns true if the schema contains a type with the specified name
*
* @param typeName the name of the type to check
*
* @return true if there is a type with the specified name
*/
public boolean containsType(String typeName) {
return typeMap.containsKey(typeName);
}
/**
* Called to return a named {@link graphql.schema.GraphQLObjectType} from the schema
*
* @param typeName the name of the type
*
* @return a graphql object type or null if there is one
*
* @throws graphql.GraphQLException if the type is NOT an object type
*/
public @Nullable GraphQLObjectType getObjectType(String typeName) {
GraphQLType graphQLType = typeMap.get(typeName);
if (graphQLType != null) {
assertTrue(graphQLType instanceof GraphQLObjectType,
"You have asked for named object type '%s' but it's not an object type but rather a '%s'", typeName, graphQLType.getClass().getName());
}
return (GraphQLObjectType) graphQLType;
}
/**
* Returns a {@link GraphQLFieldDefinition} as the specified co-ordinates or null
* if it does not exist
*
* @param fieldCoordinates the field co-ordinates
*
* @return the field or null if it does not exist
*/
public @Nullable GraphQLFieldDefinition getFieldDefinition(FieldCoordinates fieldCoordinates) {
String fieldName = fieldCoordinates.getFieldName();
if (fieldCoordinates.isSystemCoordinates()) {
if (fieldName.equals(this.getIntrospectionSchemaFieldDefinition().getName())) {
return this.getIntrospectionSchemaFieldDefinition();
}
if (fieldName.equals(this.getIntrospectionTypeFieldDefinition().getName())) {
return this.getIntrospectionTypeFieldDefinition();
}
if (fieldName.equals(this.getIntrospectionTypenameFieldDefinition().getName())) {
return this.getIntrospectionTypenameFieldDefinition();
}
return Assert.assertShouldNeverHappen("The system field name %s is unknown", fieldName);
}
String typeName = fieldCoordinates.getTypeName();
GraphQLType graphQLType = getType(typeName);
if (graphQLType != null) {
assertTrue(graphQLType instanceof GraphQLFieldsContainer,
"You have asked for named type '%s' but it's not GraphQLFieldsContainer but rather a '%s'", typeName, graphQLType.getClass().getName());
return ((GraphQLFieldsContainer) graphQLType).getFieldDefinition(fieldName);
}
return null;
}
/**
* @return all the named types in the scheme as a map from name to named type
*/
public Map<String, GraphQLNamedType> getTypeMap() {
return typeMap;
}
/**
* This returns all the {@link GraphQLNamedType} named types in th schema
*
* @return all the {@link GraphQLNamedType} types in the schema
*/
public List<GraphQLNamedType> getAllTypesAsList() {
return getAllTypesAsList(typeMap);
}
/**
* This returns all the top level {@link GraphQLNamedSchemaElement} named types and directives
* in the schema
*
* @return all the top level {@link GraphQLNamedSchemaElement} types and directives in the schema
*/
public List<GraphQLNamedSchemaElement> getAllElementsAsList() {
List<GraphQLNamedSchemaElement> list = new ArrayList<>();
list.addAll(getDirectives());
list.addAll(getAllTypesAsList());
return list;
}
/**
* This will return the list of {@link graphql.schema.GraphQLObjectType} types that implement the given
* interface type.
*
* @param type interface type to obtain implementations of.
*
* @return list of types implementing provided interface
*/
public @Nullable List<GraphQLObjectType> getImplementations(GraphQLInterfaceType type) {
return interfaceNameToObjectTypes.getOrDefault(type.getName(), emptyList());
}
/**
* Returns true if a specified concrete type is a possible type of a provided abstract type.
* If the provided abstract type is:
* - an interface, it checks whether the concrete type is one of its implementations.
* - a union, it checks whether the concrete type is one of its possible types.
*
* @param abstractType abstract type either interface or union
* @param concreteType concrete type
*
* @return true if possible type, false otherwise.
*/
public boolean isPossibleType(GraphQLNamedType abstractType, GraphQLObjectType concreteType) {
if (abstractType instanceof GraphQLInterfaceType) {
ImmutableList<String> objectNames = this.interfaceNameToObjectTypeNames.getOrDefault(abstractType.getName(), emptyList());
return objectNames.contains(concreteType.getName());
} else if (abstractType instanceof GraphQLUnionType) {
return ((GraphQLUnionType) abstractType).isPossibleType(concreteType);
}
return assertShouldNeverHappen("Unsupported abstract type %s. Abstract types supported are Union and Interface.", abstractType.getName());
}
/**
* @return the Query type of the schema
*/
public GraphQLObjectType getQueryType() {
return queryType;
}
/**
* @return the Mutation type of the schema of null if there is not one
*/
public @Nullable GraphQLObjectType getMutationType() {
return mutationType;
}
/**
* @return the Subscription type of the schema of null if there is not one
*/
public @Nullable GraphQLObjectType getSubscriptionType() {
return subscriptionType;
}
/**
* This returns the list of directives definitions that are associated with this schema object including
* built in ones.
*
* @return a list of directives
*/
public List<GraphQLDirective> getDirectives() {
return directiveDefinitionsHolder.getDirectives();
}
/**
* @return a map of non-repeatable directives by directive name
*/
public Map<String, GraphQLDirective> getDirectivesByName() {
return directiveDefinitionsHolder.getDirectivesByName();
}
/**
* Returns a named directive that (for legacy reasons) will be only in the set of non-repeatable directives
*
* @param directiveName the name of the directive to retrieve
*
* @return the directive or null if there is not one with that name
*/
public @Nullable GraphQLDirective getDirective(String directiveName) {
return directiveDefinitionsHolder.getDirective(directiveName);
}
/**
* This returns the list of directives that have been explicitly applied to the
* schema object. Note that {@link #getDirectives()} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @return a list of directives
*
* @deprecated Use the {@link GraphQLAppliedDirective} methods instead
*/
@Deprecated(since = "2022-02-24")
public List<GraphQLDirective> getSchemaDirectives() {
return schemaAppliedDirectivesHolder.getDirectives();
}
/**
* This returns a map of non-repeatable directives that have been explicitly applied to the
* schema object. Note that {@link #getDirectives()} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @return a map of directives
*
* @deprecated Use the {@link GraphQLAppliedDirective} methods instead
*/
@Deprecated(since = "2022-02-24")
public Map<String, GraphQLDirective> getSchemaDirectiveByName() {
return schemaAppliedDirectivesHolder.getDirectivesByName();
}
/**
* This returns a map of non-repeatable and repeatable directives that have been explicitly applied to the
* schema object. Note that {@link #getDirectives()} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @return a map of directives
*
* @deprecated Use the {@link GraphQLAppliedDirective} methods instead
*/
@Deprecated(since = "2022-02-24")
public Map<String, List<GraphQLDirective>> getAllSchemaDirectivesByName() {
return schemaAppliedDirectivesHolder.getAllDirectivesByName();
}
/**
* This returns the named directive that have been explicitly applied to the
* schema object. Note that {@link graphql.schema.GraphQLDirectiveContainer#getDirective(String)} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @param directiveName the name of the directive
*
* @return a named directive
*
* @deprecated Use the {@link GraphQLAppliedDirective} methods instead
*/
@Deprecated(since = "2022-02-24")
public GraphQLDirective getSchemaDirective(String directiveName) {
return schemaAppliedDirectivesHolder.getDirective(directiveName);
}
/**
* This returns the named directives that have been explicitly applied to the
* schema object.
*
* @param directiveName the name of the directive
*
* @return A list of repeated applied directives
*
* @deprecated Use the {@link GraphQLAppliedDirective} methods instead
*/
@Deprecated(since = "2022-02-24")
public List<GraphQLDirective> getSchemaDirectives(String directiveName) {
return schemaAppliedDirectivesHolder.getDirectives(directiveName);
}
/**
* This returns the list of directives that have been explicitly applied to the
* schema object. Note that {@link #getDirectives()} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @return a list of directives
*/
public List<GraphQLAppliedDirective> getSchemaAppliedDirectives() {
return schemaAppliedDirectivesHolder.getAppliedDirectives();
}
/**
* This returns a map of non-repeatable and repeatable directives that have been explicitly applied to the
* schema object. Note that {@link #getDirectives()} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @return a map of all schema directives by directive name
*/
public Map<String, List<GraphQLAppliedDirective>> getAllSchemaAppliedDirectivesByName() {
return schemaAppliedDirectivesHolder.getAllAppliedDirectivesByName();
}
/**
* This returns the named directive that have been explicitly applied to the
* schema object. Note that {@link graphql.schema.GraphQLDirectiveContainer#getDirective(String)} will return
* directives for all schema elements, whereas this is just for the schema
* element itself
*
* @param directiveName the name of the directive
*
* @return a named directive
*/
public GraphQLAppliedDirective getSchemaAppliedDirective(String directiveName) {
return schemaAppliedDirectivesHolder.getAppliedDirective(directiveName);
}
public List<GraphQLAppliedDirective> getSchemaAppliedDirectives(String directiveName) {
return schemaAppliedDirectivesHolder.getAppliedDirectives(directiveName);
}
@Nullable
public SchemaDefinition getDefinition() {
return definition;
}
public List<SchemaExtensionDefinition> getExtensionDefinitions() {
return extensionDefinitions;
}
public boolean isSupportingMutations() {
return mutationType != null;
}
public boolean isSupportingSubscriptions() {
return subscriptionType != null;
}
@Nullable
public String getDescription() {
return description;
}
/**
* This helps you transform the current GraphQLSchema object into another one by starting a builder with all
* the current values and allows you to transform it how you want.
*
* @param builderConsumer the consumer code that will be given a builder to transform
*
* @return a new GraphQLSchema object based on calling built on that builder
*/
public GraphQLSchema transform(Consumer<Builder> builderConsumer) {
Builder builder = newSchema(this);
builderConsumer.accept(builder);
return builder.build();
}
/**
* This helps you transform the current GraphQLSchema object into another one by using a builder that only allows you to change
* simple values and does not involve changing the complex schema type graph.
*
* @param builderConsumer the consumer code that will be given a builder to transform
*
* @return a new GraphQLSchema object based on calling built on that builder
*/
public GraphQLSchema transformWithoutTypes(Consumer<BuilderWithoutTypes> builderConsumer) {
BuilderWithoutTypes builder = new BuilderWithoutTypes(this);
builderConsumer.accept(builder);
return builder.build();
}
/**
* @return a new schema builder
*/
public static Builder newSchema() {
return new Builder();
}
/**
* This allows you to build a schema from an existing schema. It copies everything from the existing
* schema and then allows you to replace them.
*
* @param existingSchema the existing schema
*
* @return a new schema builder
*/
public static Builder newSchema(GraphQLSchema existingSchema) {
return new Builder()
.query(existingSchema.getQueryType())
.mutation(existingSchema.getMutationType())
.subscription(existingSchema.getSubscriptionType())
.extensionDefinitions(existingSchema.getExtensionDefinitions())
.introspectionSchemaType(existingSchema.getIntrospectionSchemaType())
.codeRegistry(existingSchema.getCodeRegistry())
.clearAdditionalTypes()
.additionalDirectives(new LinkedHashSet<>(existingSchema.getDirectives()))
.clearSchemaDirectives()
.withSchemaDirectives(schemaDirectivesArray(existingSchema))
.withSchemaAppliedDirectives(schemaAppliedDirectivesArray(existingSchema))
.additionalTypes(existingSchema.additionalTypes)
.description(existingSchema.getDescription());
}
@NullUnmarked
public static class BuilderWithoutTypes {
private GraphQLCodeRegistry codeRegistry;
private String description;
private final GraphQLSchema existingSchema;
private BuilderWithoutTypes(GraphQLSchema existingSchema) {
this.existingSchema = existingSchema;
this.codeRegistry = existingSchema.codeRegistry;
this.description = existingSchema.description;
}
public BuilderWithoutTypes codeRegistry(GraphQLCodeRegistry codeRegistry) {
this.codeRegistry = Assert.assertNotNull(codeRegistry);
return this;
}
public BuilderWithoutTypes codeRegistry(GraphQLCodeRegistry.Builder codeRegistryBuilder) {
return codeRegistry(codeRegistryBuilder.build());
}
public BuilderWithoutTypes description(String description) {
this.description = description;
return this;
}
public GraphQLSchema build() {
return new GraphQLSchema(this);
}
}
@NullUnmarked
public static class Builder {
private GraphQLObjectType queryType;
private GraphQLObjectType mutationType;
private GraphQLObjectType introspectionSchemaType = Introspection.__Schema;
private GraphQLObjectType subscriptionType;
private GraphQLCodeRegistry codeRegistry = GraphQLCodeRegistry.newCodeRegistry().build();
private SchemaDefinition definition;
private List<SchemaExtensionDefinition> extensionDefinitions;
private String description;
private final Set<GraphQLDirective> additionalDirectives = new LinkedHashSet<>();
private final Set<GraphQLNamedType> additionalTypes = new LinkedHashSet<>();
private final List<GraphQLDirective> schemaDirectives = new ArrayList<>();
private final List<GraphQLAppliedDirective> schemaAppliedDirectives = new ArrayList<>();
public Builder query(GraphQLObjectType.Builder builder) {
return query(builder.build());
}
public Builder query(GraphQLObjectType queryType) {
this.queryType = queryType;
return this;
}
public Builder mutation(GraphQLObjectType.Builder builder) {
return mutation(builder.build());
}
public Builder mutation(GraphQLObjectType mutationType) {
this.mutationType = mutationType;
return this;
}
public Builder subscription(GraphQLObjectType.Builder builder) {
return subscription(builder.build());
}
public Builder subscription(GraphQLObjectType subscriptionType) {
this.subscriptionType = subscriptionType;
return this;
}
public Builder codeRegistry(GraphQLCodeRegistry codeRegistry) {
this.codeRegistry = codeRegistry;
return this;
}
/**
* Adds multiple types to the set of additional types.
* <p>
* Additional types are types that may not be directly reachable by traversing the schema
* from the root operation types (Query, Mutation, Subscription), but still need to be
* included in the schema. The most common use case is for object types that implement
* an interface but are not directly referenced as field return types.
* <p>
* <b>Example - Adding interface implementations:</b>
* <pre>{@code
* // If Node interface is used but User/Post types aren't directly referenced:
* builder.additionalTypes(Set.of(
* GraphQLObjectType.newObject().name("User").withInterface(nodeInterface)...,
* GraphQLObjectType.newObject().name("Post").withInterface(nodeInterface)...
* ));
* }</pre>
* <p>
* <b>Note:</b> There are no restrictions on what types can be added. Types already
* reachable from root operations can be added without causing errors - they will
* simply exist in both the traversed type map and this set.
*
* @param additionalTypes the types to add
*
* @return this builder
*
* @see GraphQLSchema#getAdditionalTypes()
*/
public Builder additionalTypes(Set<? extends GraphQLNamedType> additionalTypes) {
this.additionalTypes.addAll(additionalTypes);
return this;
}
/**
* Adds a single type to the set of additional types.
* <p>
* Additional types are types that may not be directly reachable by traversing the schema
* from the root operation types (Query, Mutation, Subscription), but still need to be
* included in the schema. The most common use case is for object types that implement
* an interface but are not directly referenced as field return types.
* <p>
* <b>Note:</b> There are no restrictions on what types can be added. Types already
* reachable from root operations can be added without causing errors.
*
* @param additionalType the type to add
*
* @return this builder
*
* @see GraphQLSchema#getAdditionalTypes()
* @see #additionalTypes(Set)
*/
public Builder additionalType(GraphQLNamedType additionalType) {
this.additionalTypes.add(additionalType);
return this;
}
/**
* Clears all additional types that have been added to this builder.
* <p>
* This is useful when transforming an existing schema and you want to
* rebuild the additional types set from scratch.
*
* @return this builder
*
* @see #additionalType(GraphQLNamedType)
* @see #additionalTypes(Set)
*/
public Builder clearAdditionalTypes() {
this.additionalTypes.clear();
return this;
}
public Builder additionalDirectives(Set<GraphQLDirective> additionalDirectives) {
this.additionalDirectives.addAll(additionalDirectives);
return this;
}
public Builder additionalDirective(GraphQLDirective additionalDirective) {
this.additionalDirectives.add(additionalDirective);
return this;
}
public Builder withSchemaDirectives(GraphQLDirective... directives) {
for (GraphQLDirective directive : directives) {
withSchemaDirective(directive);
}
return this;
}
public Builder withSchemaDirectives(Collection<? extends GraphQLDirective> directives) {
for (GraphQLDirective directive : directives) {
withSchemaDirective(directive);
}
return this;
}
public Builder withSchemaDirective(GraphQLDirective directive) {
assertNotNull(directive, "directive can't be null");
schemaDirectives.add(directive);
return this;
}
public Builder withSchemaDirective(GraphQLDirective.Builder builder) {
return withSchemaDirective(builder.build());
}
public Builder withSchemaAppliedDirectives(GraphQLAppliedDirective... appliedDirectives) {
for (GraphQLAppliedDirective directive : appliedDirectives) {
withSchemaAppliedDirective(directive);
}
return this;
}
public Builder withSchemaAppliedDirectives(Collection<? extends GraphQLAppliedDirective> appliedDirectives) {
for (GraphQLAppliedDirective directive : appliedDirectives) {
withSchemaAppliedDirective(directive);
}
return this;
}
public Builder withSchemaAppliedDirective(GraphQLAppliedDirective appliedDirective) {
assertNotNull(appliedDirective, "directive can't be null");
schemaAppliedDirectives.add(appliedDirective);
return this;
}
public Builder withSchemaAppliedDirective(GraphQLAppliedDirective.Builder builder) {
return withSchemaAppliedDirective(builder.build());
}
/**
* This is used to clear all the directives in the builder so far.
*
* @return the builder
*/
public Builder clearSchemaDirectives() {
schemaDirectives.clear();
schemaAppliedDirectives.clear();
return this;
}
public Builder definition(SchemaDefinition definition) {
this.definition = definition;
return this;
}
public Builder extensionDefinitions(List<SchemaExtensionDefinition> extensionDefinitions) {
this.extensionDefinitions = extensionDefinitions;
return this;