Repository navigation
Expand file tree
/
Copy pathExecutableNormalizedField.java
More file actions
689 lines (605 loc) · 24.5 KB
/
Copy pathExecutableNormalizedField.java
File metadata and controls
689 lines (605 loc) · 24.5 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
package graphql.normalized;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import graphql.Assert;
import graphql.ExperimentalApi;
import graphql.Internal;
import graphql.Mutable;
import graphql.PublicApi;
import graphql.collect.ImmutableKit;
import graphql.introspection.Introspection;
import graphql.language.Argument;
import graphql.normalized.incremental.NormalizedDeferExecution;
import graphql.schema.GraphQLFieldDefinition;
import graphql.schema.GraphQLInterfaceType;
import graphql.schema.GraphQLNamedOutputType;
import graphql.schema.GraphQLObjectType;
import graphql.schema.GraphQLOutputType;
import graphql.schema.GraphQLSchema;
import graphql.schema.GraphQLUnionType;
import graphql.util.FpKit;
import graphql.util.MutableRef;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
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.assertTrue;
import static graphql.schema.GraphQLTypeUtil.simplePrint;
import static graphql.schema.GraphQLTypeUtil.unwrapAll;
import static java.util.stream.Collectors.joining;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Collectors.toSet;
/**
* An {@link ExecutableNormalizedField} represents a field in an executable graphql operation. Its models what
* could be executed during a given operation.
* <p>
* This class is intentionally mutable for performance reasons since building immutable parent child
* objects is too expensive.
*/
@PublicApi
@Mutable
public class ExecutableNormalizedField {
private final String alias;
private final ImmutableMap<String, NormalizedInputValue> normalizedArguments;
private final LinkedHashMap<String, Object> resolvedArguments;
private final ImmutableList<Argument> astArguments;
// Mutable List on purpose: it is modified after creation
private final LinkedHashSet<String> objectTypeNames;
private final ArrayList<ExecutableNormalizedField> children;
private ExecutableNormalizedField parent;
private final String fieldName;
private final int level;
// Mutable List on purpose: it is modified after creation
private final LinkedHashSet<NormalizedDeferExecution> deferExecutions;
private ExecutableNormalizedField(Builder builder) {
this.alias = builder.alias;
this.resolvedArguments = builder.resolvedArguments;
this.normalizedArguments = builder.normalizedArguments;
this.astArguments = builder.astArguments;
this.objectTypeNames = builder.objectTypeNames;
this.fieldName = assertNotNull(builder.fieldName);
this.children = builder.children;
this.level = builder.level;
this.parent = builder.parent;
this.deferExecutions = builder.deferExecutions;
}
/**
* Determines whether this {@link ExecutableNormalizedField} needs a fragment to select the field. However, it considers the parent
* output type when determining whether it needs a fragment.
* <p>
* Consider the following schema
*
* <pre>
* interface Animal {
* name: String
* parent: Animal
* }
* type Cat implements Animal {
* name: String
* parent: Cat
* }
* type Dog implements Animal {
* name: String
* parent: Dog
* isGoodBoy: Boolean
* }
* type Query {
* animal: Animal
* }
* </pre>
* <p>
* and the following query
*
* <pre>
* {
* animal {
* parent {
* name
* }
* }
* }
* </pre>
* <p>
* Then we would get the following {@link ExecutableNormalizedOperation}
*
* <pre>
* -Query.animal: Animal
* --[Cat, Dog].parent: Cat, Dog
* ---[Cat, Dog].name: String
* </pre>
* <p>
* If we simply checked the {@link #parent}'s {@link #getFieldDefinitions(GraphQLSchema)} that would
* point us to {@code Cat.parent} and {@code Dog.parent} whose output types would incorrectly answer
* our question whether this is conditional?
* <p>
* We MUST consider that the output type of the {@code parent} field is {@code Animal} and
* NOT {@code Cat} or {@code Dog} as their respective implementations would say.
*
* @param schema - the graphql schema in play
*
* @return true if the field is conditional
*/
public boolean isConditional(@NotNull GraphQLSchema schema) {
if (parent == null) {
return false;
}
for (GraphQLInterfaceType commonParentOutputInterface : parent.getInterfacesCommonToAllOutputTypes(schema)) {
List<GraphQLObjectType> implementations = schema.getImplementations(commonParentOutputInterface);
// __typename
if (fieldName.equals(Introspection.TypeNameMetaFieldDef.getName()) && implementations.size() == objectTypeNames.size()) {
return false;
}
if (commonParentOutputInterface.getField(fieldName) == null) {
continue;
}
if (implementations.size() == objectTypeNames.size()) {
return false;
}
}
// __typename is the only field in a union type that CAN be NOT conditional
GraphQLFieldDefinition parentFieldDef = parent.getOneFieldDefinition(schema);
if (unwrapAll(parentFieldDef.getType()) instanceof GraphQLUnionType) {
GraphQLUnionType parentOutputTypeAsUnion = (GraphQLUnionType) unwrapAll(parentFieldDef.getType());
if (fieldName.equals(Introspection.TypeNameMetaFieldDef.getName()) && objectTypeNames.size() == parentOutputTypeAsUnion.getTypes().size()) {
return false; // Not conditional
}
}
// This means there is no Union or Interface which could serve as unconditional parent
if (objectTypeNames.size() > 1) {
return true; // Conditional
}
if (parent.objectTypeNames.size() > 1) {
return true;
}
GraphQLObjectType oneObjectType = (GraphQLObjectType) schema.getType(objectTypeNames.iterator().next());
return unwrapAll(parentFieldDef.getType()) != oneObjectType;
}
public boolean hasChildren() {
return children.size() > 0;
}
public GraphQLOutputType getType(GraphQLSchema schema) {
List<GraphQLFieldDefinition> fieldDefinitions = getFieldDefinitions(schema);
Set<String> fieldTypes = fieldDefinitions.stream().map(fd -> simplePrint(fd.getType())).collect(toSet());
Assert.assertTrue(fieldTypes.size() == 1, () -> "More than one type ... use getTypes");
return fieldDefinitions.get(0).getType();
}
public List<GraphQLOutputType> getTypes(GraphQLSchema schema) {
return ImmutableKit.map(getFieldDefinitions(schema), fd -> fd.getType());
}
public void forEachFieldDefinition(GraphQLSchema schema, Consumer<GraphQLFieldDefinition> consumer) {
var fieldDefinition = resolveIntrospectionField(schema, objectTypeNames, fieldName);
if (fieldDefinition != null) {
consumer.accept(fieldDefinition);
return;
}
for (String objectTypeName : objectTypeNames) {
GraphQLObjectType type = (GraphQLObjectType) assertNotNull(schema.getType(objectTypeName));
consumer.accept(assertNotNull(type.getField(fieldName), () -> String.format("No field %s found for type %s", fieldName, objectTypeName)));
}
}
public List<GraphQLFieldDefinition> getFieldDefinitions(GraphQLSchema schema) {
ImmutableList.Builder<GraphQLFieldDefinition> builder = ImmutableList.builder();
forEachFieldDefinition(schema, builder::add);
return builder.build();
}
/**
* This is NOT public as it is not recommended usage.
* <p>
* Internally there are cases where we know it is safe to use this, so this exists.
*/
private GraphQLFieldDefinition getOneFieldDefinition(GraphQLSchema schema) {
var fieldDefinition = resolveIntrospectionField(schema, objectTypeNames, fieldName);
if (fieldDefinition != null) {
return fieldDefinition;
}
String objectTypeName = objectTypeNames.iterator().next();
GraphQLObjectType type = (GraphQLObjectType) assertNotNull(schema.getType(objectTypeName));
return assertNotNull(type.getField(fieldName), () -> String.format("No field %s found for type %s", fieldName, objectTypeName));
}
private static GraphQLFieldDefinition resolveIntrospectionField(GraphQLSchema schema, Set<String> objectTypeNames, String fieldName) {
if (fieldName.equals(schema.getIntrospectionTypenameFieldDefinition().getName())) {
return schema.getIntrospectionTypenameFieldDefinition();
} else if (objectTypeNames.size() == 1 && objectTypeNames.iterator().next().equals(schema.getQueryType().getName())) {
if (fieldName.equals(schema.getIntrospectionSchemaFieldDefinition().getName())) {
return schema.getIntrospectionSchemaFieldDefinition();
} else if (fieldName.equals(schema.getIntrospectionTypeFieldDefinition().getName())) {
return schema.getIntrospectionTypeFieldDefinition();
}
}
return null;
}
@Internal
public void addObjectTypeNames(Collection<String> objectTypeNames) {
this.objectTypeNames.addAll(objectTypeNames);
}
@Internal
public void setObjectTypeNames(Collection<String> objectTypeNames) {
this.objectTypeNames.clear();
this.objectTypeNames.addAll(objectTypeNames);
}
@Internal
public void addChild(ExecutableNormalizedField executableNormalizedField) {
this.children.add(executableNormalizedField);
}
@Internal
public void clearChildren() {
this.children.clear();
}
@Internal
public void setDeferExecutions(Collection<NormalizedDeferExecution> deferExecutions) {
this.deferExecutions.clear();
this.deferExecutions.addAll(deferExecutions);
}
/**
* All merged fields have the same name so this is the name of the {@link ExecutableNormalizedField}.
* <p>
* WARNING: This is not always the key in the execution result, because of possible field aliases.
*
* @return the name of this {@link ExecutableNormalizedField}
*
* @see #getResultKey()
* @see #getAlias()
*/
public String getName() {
return getFieldName();
}
/**
* @return the same value as {@link #getName()}
*
* @see #getResultKey()
* @see #getAlias()
*/
public String getFieldName() {
return fieldName;
}
/**
* Returns the result key of this {@link ExecutableNormalizedField} within the overall result.
* This is either a field alias or the value of {@link #getName()}
*
* @return the result key for this {@link ExecutableNormalizedField}.
*
* @see #getName()
*/
public String getResultKey() {
if (alias != null) {
return alias;
}
return getName();
}
/**
* @return the field alias used or null if there is none
*
* @see #getResultKey()
* @see #getName()
*/
public String getAlias() {
return alias;
}
/**
* @return a list of the {@link Argument}s on the field
*/
public ImmutableList<Argument> getAstArguments() {
return astArguments;
}
/**
* Returns an argument value as a {@link NormalizedInputValue} which contains its type name and its current value
*
* @param name the name of the argument
*
* @return an argument value
*/
public NormalizedInputValue getNormalizedArgument(String name) {
return normalizedArguments.get(name);
}
/**
* @return a map of all the arguments in {@link NormalizedInputValue} form
*/
public ImmutableMap<String, NormalizedInputValue> getNormalizedArguments() {
return normalizedArguments;
}
/**
* @return a map of the resolved argument values
*/
public LinkedHashMap<String, Object> getResolvedArguments() {
return resolvedArguments;
}
/**
* A {@link ExecutableNormalizedField} can sometimes (for non-concrete types like interfaces and unions)
* have more than one object type it could be when executed. There is no way to know what it will be until
* the field is executed over data and the type is resolved via a {@link graphql.schema.TypeResolver}.
* <p>
* This method returns all the possible types a field can be which is one or more {@link GraphQLObjectType}
* names.
* <p>
* Warning: This returns a Mutable Set. No defensive copy is made for performance reasons.
*
* @return a set of the possible type names this field could be.
*/
public Set<String> getObjectTypeNames() {
return objectTypeNames;
}
/**
* This returns the first entry in {@link #getObjectTypeNames()}. Sometimes you know a field cant be more than one
* type and this method is a shortcut one to help you.
*
* @return the first entry from
*/
public String getSingleObjectTypeName() {
return objectTypeNames.iterator().next();
}
/**
* @return a helper method show field details
*/
public String printDetails() {
StringBuilder result = new StringBuilder();
if (getAlias() != null) {
result.append(getAlias()).append(": ");
}
return result + objectTypeNamesToString() + "." + fieldName;
}
/**
* @return a helper method to show the object types names as a string
*/
public String objectTypeNamesToString() {
if (objectTypeNames.size() == 1) {
return objectTypeNames.iterator().next();
} else {
return objectTypeNames.toString();
}
}
/**
* This returns the list of the result keys (see {@link #getResultKey()} that lead from this field upwards to
* its parent field
*
* @return a list of the result keys from this {@link ExecutableNormalizedField} to the top of the operation via parent fields
*/
public List<String> getListOfResultKeys() {
LinkedList<String> list = new LinkedList<>();
ExecutableNormalizedField current = this;
while (current != null) {
list.addFirst(current.getResultKey());
current = current.parent;
}
return list;
}
/**
* @return the children of the {@link ExecutableNormalizedField}
*/
public List<ExecutableNormalizedField> getChildren() {
return children;
}
/**
* Returns the list of child fields that would have the same result key
*
* @param resultKey the result key to check
*
* @return a list of all direct {@link ExecutableNormalizedField} children with the specified result key
*/
public List<ExecutableNormalizedField> getChildrenWithSameResultKey(String resultKey) {
return FpKit.filterList(children, child -> child.getResultKey().equals(resultKey));
}
public List<ExecutableNormalizedField> getChildren(int includingRelativeLevel) {
List<ExecutableNormalizedField> result = new ArrayList<>();
assertTrue(includingRelativeLevel >= 1, () -> "relative level must be >= 1");
this.getChildren().forEach(child -> {
traverseImpl(child, result::add, 1, includingRelativeLevel);
});
return result;
}
/**
* This returns the child fields that can be used if the object is of the specified object type
*
* @param objectTypeName the object type
*
* @return a list of child fields that would apply to that object type
*/
public List<ExecutableNormalizedField> getChildren(String objectTypeName) {
return children.stream()
.filter(cld -> cld.objectTypeNames.contains(objectTypeName))
.collect(toList());
}
/**
* the level of the {@link ExecutableNormalizedField} in the operation hierarchy with top level fields
* starting at 1
*
* @return the level of the {@link ExecutableNormalizedField} in the operation hierarchy
*/
public int getLevel() {
return level;
}
/**
* @return the parent of this {@link ExecutableNormalizedField} or null if it's a top level field
*/
public ExecutableNormalizedField getParent() {
return parent;
}
// TODO: Javadoc
@ExperimentalApi
public LinkedHashSet<NormalizedDeferExecution> getDeferExecutions() {
return deferExecutions;
}
@Internal
public void replaceParent(ExecutableNormalizedField newParent) {
this.parent = newParent;
}
@Override
public String toString() {
return "NormalizedField{" +
objectTypeNamesToString() + "." + fieldName +
", alias=" + alias +
", level=" + level +
", children=" + children.stream().map(ExecutableNormalizedField::toString).collect(joining("\n")) +
'}';
}
/**
* Traverse from this {@link ExecutableNormalizedField} down into itself and all of its children
*
* @param consumer the callback for each {@link ExecutableNormalizedField} in the hierarchy.
*/
public void traverseSubTree(Consumer<ExecutableNormalizedField> consumer) {
this.getChildren().forEach(child -> {
traverseImpl(child, consumer, 1, Integer.MAX_VALUE);
});
}
private void traverseImpl(ExecutableNormalizedField root,
Consumer<ExecutableNormalizedField> consumer,
int curRelativeLevel,
int abortAfter) {
if (curRelativeLevel > abortAfter) {
return;
}
consumer.accept(root);
root.getChildren().forEach(child -> {
traverseImpl(child, consumer, curRelativeLevel + 1, abortAfter);
});
}
/**
* This tries to find interfaces common to all the field output types.
* <p>
* i.e. goes through {@link #getFieldDefinitions(GraphQLSchema)} and finds interfaces that
* all the field's unwrapped output types are assignable to.
*/
@SuppressWarnings({"unchecked", "rawtypes"})
private Set<GraphQLInterfaceType> getInterfacesCommonToAllOutputTypes(GraphQLSchema schema) {
// Shortcut for performance
if (objectTypeNames.size() == 1) {
var fieldDef = getOneFieldDefinition(schema);
var outputType = unwrapAll(fieldDef.getType());
if (outputType instanceof GraphQLObjectType) {
return new LinkedHashSet<>((List) ((GraphQLObjectType) outputType).getInterfaces());
} else if (outputType instanceof GraphQLInterfaceType) {
var result = new LinkedHashSet<>((List) ((GraphQLInterfaceType) outputType).getInterfaces());
result.add(outputType);
return result;
} else {
return Collections.emptySet();
}
}
MutableRef<Set<GraphQLInterfaceType>> commonInterfaces = new MutableRef<>();
forEachFieldDefinition(schema, (fieldDef) -> {
var outputType = unwrapAll(fieldDef.getType());
List<GraphQLInterfaceType> outputTypeInterfaces;
if (outputType instanceof GraphQLObjectType) {
outputTypeInterfaces = (List) ((GraphQLObjectType) outputType).getInterfaces();
} else if (outputType instanceof GraphQLInterfaceType) {
// This interface and superinterfaces
List<GraphQLNamedOutputType> superInterfaces = ((GraphQLInterfaceType) outputType).getInterfaces();
outputTypeInterfaces = new ArrayList<>(superInterfaces.size() + 1);
outputTypeInterfaces.add((GraphQLInterfaceType) outputType);
if (!superInterfaces.isEmpty()) {
outputTypeInterfaces.addAll((List) superInterfaces);
}
} else {
outputTypeInterfaces = Collections.emptyList();
}
if (commonInterfaces.value == null) {
commonInterfaces.value = new LinkedHashSet<>(outputTypeInterfaces);
} else {
commonInterfaces.value.retainAll(outputTypeInterfaces);
}
});
return commonInterfaces.value;
}
/**
* @return a {@link Builder} of {@link ExecutableNormalizedField}s
*/
public static Builder newNormalizedField() {
return new Builder();
}
/**
* Allows this {@link ExecutableNormalizedField} to be transformed via a {@link Builder} consumer callback
*
* @param builderConsumer the consumer given a builder
*
* @return a new transformed {@link ExecutableNormalizedField}
*/
public ExecutableNormalizedField transform(Consumer<Builder> builderConsumer) {
Builder builder = new Builder(this);
builderConsumer.accept(builder);
return builder.build();
}
public static class Builder {
private LinkedHashSet<String> objectTypeNames = new LinkedHashSet<>();
private String fieldName;
private ArrayList<ExecutableNormalizedField> children = new ArrayList<>();
private int level;
private ExecutableNormalizedField parent;
private String alias;
private ImmutableMap<String, NormalizedInputValue> normalizedArguments = ImmutableKit.emptyMap();
private LinkedHashMap<String, Object> resolvedArguments = new LinkedHashMap<>();
private ImmutableList<Argument> astArguments = ImmutableKit.emptyList();
private LinkedHashSet<NormalizedDeferExecution> deferExecutions = new LinkedHashSet<>();
private Builder() {
}
private Builder(ExecutableNormalizedField existing) {
this.alias = existing.alias;
this.normalizedArguments = existing.normalizedArguments;
this.astArguments = existing.astArguments;
this.resolvedArguments = existing.resolvedArguments;
this.objectTypeNames = new LinkedHashSet<>(existing.getObjectTypeNames());
this.fieldName = existing.getFieldName();
this.children = new ArrayList<>(existing.children);
this.level = existing.getLevel();
this.parent = existing.getParent();
this.deferExecutions = existing.getDeferExecutions();
}
public Builder clearObjectTypesNames() {
this.objectTypeNames.clear();
return this;
}
public Builder objectTypeNames(List<String> objectTypeNames) {
this.objectTypeNames.addAll(objectTypeNames);
return this;
}
public Builder alias(String alias) {
this.alias = alias;
return this;
}
public Builder normalizedArguments(@Nullable Map<String, NormalizedInputValue> arguments) {
this.normalizedArguments = arguments == null ? ImmutableKit.emptyMap() : ImmutableMap.copyOf(arguments);
return this;
}
public Builder resolvedArguments(@Nullable Map<String, Object> arguments) {
this.resolvedArguments = arguments == null ? new LinkedHashMap<>() : new LinkedHashMap<>(arguments);
return this;
}
public Builder astArguments(@NotNull List<Argument> astArguments) {
this.astArguments = ImmutableList.copyOf(astArguments);
return this;
}
public Builder fieldName(String fieldName) {
this.fieldName = fieldName;
return this;
}
public Builder children(List<ExecutableNormalizedField> children) {
this.children.clear();
this.children.addAll(children);
return this;
}
public Builder level(int level) {
this.level = level;
return this;
}
public Builder parent(ExecutableNormalizedField parent) {
this.parent = parent;
return this;
}
public Builder deferExecutions(LinkedHashSet<NormalizedDeferExecution> deferExecutions) {
this.deferExecutions = deferExecutions;
return this;
}
public ExecutableNormalizedField build() {
return new ExecutableNormalizedField(this);
}
}
}