-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
RuntimeWiring.java
375 lines (332 loc) · 14.9 KB
/
RuntimeWiring.java
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
package graphql.schema.idl;
import graphql.PublicApi;
import graphql.schema.DataFetcher;
import graphql.schema.GraphQLCodeRegistry;
import graphql.schema.GraphQLScalarType;
import graphql.schema.GraphQLSchema;
import graphql.schema.GraphqlTypeComparatorRegistry;
import graphql.schema.TypeResolver;
import graphql.schema.idl.errors.StrictModeWiringException;
import graphql.schema.visibility.GraphqlFieldVisibility;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.UnaryOperator;
import static graphql.Assert.assertNotNull;
import static graphql.schema.visibility.DefaultGraphqlFieldVisibility.DEFAULT_FIELD_VISIBILITY;
import static java.lang.String.format;
/**
* A runtime wiring is a specification of data fetchers, type resolvers and custom scalars that are needed
* to wire together a functional {@link GraphQLSchema}
*/
@PublicApi
public class RuntimeWiring {
private final Map<String, Map<String, DataFetcher>> dataFetchers;
private final Map<String, DataFetcher> defaultDataFetchers;
private final Map<String, GraphQLScalarType> scalars;
private final Map<String, TypeResolver> typeResolvers;
private final Map<String, SchemaDirectiveWiring> registeredDirectiveWiring;
private final List<SchemaDirectiveWiring> directiveWiring;
private final WiringFactory wiringFactory;
private final Map<String, EnumValuesProvider> enumValuesProviders;
private final GraphqlFieldVisibility fieldVisibility;
private final GraphQLCodeRegistry codeRegistry;
private final GraphqlTypeComparatorRegistry comparatorRegistry;
/**
* This is a Runtime wiring which provides mocked types resolver
* and scalars. Useful for testing only.
*/
public static final RuntimeWiring MOCKED_WIRING = RuntimeWiring
.newRuntimeWiring()
.wiringFactory(new MockedWiringFactory()).build();
private RuntimeWiring(Builder builder) {
this.dataFetchers = builder.dataFetchers;
this.defaultDataFetchers = builder.defaultDataFetchers;
this.scalars = builder.scalars;
this.typeResolvers = builder.typeResolvers;
this.registeredDirectiveWiring = builder.registeredDirectiveWiring;
this.directiveWiring = builder.directiveWiring;
this.wiringFactory = builder.wiringFactory;
this.enumValuesProviders = builder.enumValuesProviders;
this.fieldVisibility = builder.fieldVisibility;
this.codeRegistry = builder.codeRegistry;
this.comparatorRegistry = builder.comparatorRegistry;
}
/**
* @return a builder of Runtime Wiring
*/
public static Builder newRuntimeWiring() {
return new Builder();
}
/**
* @param originalRuntimeWiring the runtime wiring to start from
*
* @return a builder of Runtime Wiring based on the provided one
*/
public static Builder newRuntimeWiring(RuntimeWiring originalRuntimeWiring) {
Builder builder = new Builder();
builder.dataFetchers.putAll(originalRuntimeWiring.dataFetchers);
builder.defaultDataFetchers.putAll(originalRuntimeWiring.defaultDataFetchers);
builder.scalars.putAll(originalRuntimeWiring.scalars);
builder.typeResolvers.putAll(originalRuntimeWiring.typeResolvers);
builder.registeredDirectiveWiring.putAll(originalRuntimeWiring.registeredDirectiveWiring);
builder.directiveWiring.addAll(originalRuntimeWiring.directiveWiring);
builder.wiringFactory = originalRuntimeWiring.wiringFactory;
builder.enumValuesProviders.putAll(originalRuntimeWiring.enumValuesProviders);
builder.fieldVisibility = originalRuntimeWiring.fieldVisibility;
builder.codeRegistry = originalRuntimeWiring.codeRegistry;
builder.comparatorRegistry = originalRuntimeWiring.comparatorRegistry;
return builder;
}
/**
* This helps you transform the current RuntimeWiring 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 RuntimeWiring object based on calling build on that builder
*/
public RuntimeWiring transform(Consumer<Builder> builderConsumer) {
Builder builder = newRuntimeWiring(this);
builderConsumer.accept(builder);
return builder.build();
}
public GraphQLCodeRegistry getCodeRegistry() {
return codeRegistry;
}
public Map<String, GraphQLScalarType> getScalars() {
return new LinkedHashMap<>(scalars);
}
public Map<String, Map<String, DataFetcher>> getDataFetchers() {
return dataFetchers;
}
public Map<String, DataFetcher> getDataFetcherForType(String typeName) {
return dataFetchers.computeIfAbsent(typeName, k -> new LinkedHashMap<>());
}
public DataFetcher getDefaultDataFetcherForType(String typeName) {
return defaultDataFetchers.get(typeName);
}
public Map<String, TypeResolver> getTypeResolvers() {
return typeResolvers;
}
public Map<String, EnumValuesProvider> getEnumValuesProviders() {
return this.enumValuesProviders;
}
public WiringFactory getWiringFactory() {
return wiringFactory;
}
public GraphqlFieldVisibility getFieldVisibility() {
return fieldVisibility;
}
public Map<String, SchemaDirectiveWiring> getRegisteredDirectiveWiring() {
return registeredDirectiveWiring;
}
public List<SchemaDirectiveWiring> getDirectiveWiring() {
return directiveWiring;
}
public GraphqlTypeComparatorRegistry getComparatorRegistry() {
return comparatorRegistry;
}
@PublicApi
public static class Builder {
private final Map<String, Map<String, DataFetcher>> dataFetchers = new LinkedHashMap<>();
private final Map<String, DataFetcher> defaultDataFetchers = new LinkedHashMap<>();
private final Map<String, GraphQLScalarType> scalars = new LinkedHashMap<>();
private final Map<String, TypeResolver> typeResolvers = new LinkedHashMap<>();
private final Map<String, EnumValuesProvider> enumValuesProviders = new LinkedHashMap<>();
private final Map<String, SchemaDirectiveWiring> registeredDirectiveWiring = new LinkedHashMap<>();
private final List<SchemaDirectiveWiring> directiveWiring = new ArrayList<>();
private WiringFactory wiringFactory = new NoopWiringFactory();
private boolean strictMode = false;
private GraphqlFieldVisibility fieldVisibility = DEFAULT_FIELD_VISIBILITY;
private GraphQLCodeRegistry codeRegistry = GraphQLCodeRegistry.newCodeRegistry().build();
private GraphqlTypeComparatorRegistry comparatorRegistry = GraphqlTypeComparatorRegistry.AS_IS_REGISTRY;
private Builder() {
ScalarInfo.GRAPHQL_SPECIFICATION_SCALARS.forEach(this::scalar);
}
/**
* This puts the builder into strict mode, so if things get defined twice, for example, it will throw a {@link StrictModeWiringException}.
*
* @return this builder
*/
public Builder strictMode() {
this.strictMode = true;
return this;
}
/**
* Adds a wiring factory into the runtime wiring
*
* @param wiringFactory the wiring factory to add
*
* @return this outer builder
*/
public Builder wiringFactory(WiringFactory wiringFactory) {
assertNotNull(wiringFactory, () -> "You must provide a wiring factory");
this.wiringFactory = wiringFactory;
return this;
}
/**
* This allows you to seed in your own {@link graphql.schema.GraphQLCodeRegistry} instance
*
* @param codeRegistry the code registry to use
*
* @return this outer builder
*/
public Builder codeRegistry(GraphQLCodeRegistry codeRegistry) {
this.codeRegistry = assertNotNull(codeRegistry);
return this;
}
/**
* This allows you to seed in your own {@link graphql.schema.GraphQLCodeRegistry} instance
*
* @param codeRegistry the code registry to use
*
* @return this outer builder
*/
public Builder codeRegistry(GraphQLCodeRegistry.Builder codeRegistry) {
this.codeRegistry = assertNotNull(codeRegistry).build();
return this;
}
/**
* This allows you to add in new custom Scalar implementations beyond the standard set.
*
* @param scalarType the new scalar implementation
*
* @return the runtime wiring builder
*/
public Builder scalar(GraphQLScalarType scalarType) {
if (strictMode && scalars.containsKey(scalarType.getName())) {
throw new StrictModeWiringException(format("The scalar %s is already defined", scalarType.getName()));
}
scalars.put(scalarType.getName(), scalarType);
return this;
}
/**
* This allows you to add a field visibility that will be associated with the schema
*
* @param fieldVisibility the new field visibility
*
* @return the runtime wiring builder
*/
public Builder fieldVisibility(GraphqlFieldVisibility fieldVisibility) {
this.fieldVisibility = assertNotNull(fieldVisibility);
return this;
}
/**
* This allows you to add a new type wiring via a builder
*
* @param builder the type wiring builder to use
*
* @return this outer builder
*/
public Builder type(TypeRuntimeWiring.Builder builder) {
return type(builder.build());
}
/**
* This form allows a lambda to be used as the builder of a type wiring
*
* @param typeName the name of the type to wire
* @param builderFunction a function that will be given the builder to use
*
* @return the runtime wiring builder
*/
public Builder type(String typeName, UnaryOperator<TypeRuntimeWiring.Builder> builderFunction) {
TypeRuntimeWiring.Builder builder = builderFunction.apply(TypeRuntimeWiring.newTypeWiring(typeName));
return type(builder.build());
}
/**
* This adds a type wiring
*
* @param typeRuntimeWiring the new type wiring
*
* @return the runtime wiring builder
*/
public Builder type(TypeRuntimeWiring typeRuntimeWiring) {
String typeName = typeRuntimeWiring.getTypeName();
Map<String, DataFetcher> typeDataFetchers = dataFetchers.computeIfAbsent(typeName, k -> new LinkedHashMap<>());
if (strictMode && !typeDataFetchers.isEmpty()) {
throw new StrictModeWiringException(format("The type %s has already been defined", typeName));
}
typeDataFetchers.putAll(typeRuntimeWiring.getFieldDataFetchers());
defaultDataFetchers.put(typeName, typeRuntimeWiring.getDefaultDataFetcher());
TypeResolver typeResolver = typeRuntimeWiring.getTypeResolver();
if (typeResolver != null) {
if (strictMode && this.typeResolvers.containsKey(typeName)) {
throw new StrictModeWiringException(format("The type %s already has a type resolver defined", typeName));
}
this.typeResolvers.put(typeName, typeResolver);
}
EnumValuesProvider enumValuesProvider = typeRuntimeWiring.getEnumValuesProvider();
if (enumValuesProvider != null) {
if (strictMode && this.enumValuesProviders.containsKey(typeName)) {
throw new StrictModeWiringException(format("The type %s already has a enum provider defined", typeName));
}
this.enumValuesProviders.put(typeName, enumValuesProvider);
}
return this;
}
/**
* This provides the wiring code for a named directive.
* <p>
* Note: The provided directive wiring will ONLY be called back if an element has a directive
* with the specified name.
* <p>
* To be called back for every directive the use {@link #directiveWiring(SchemaDirectiveWiring)} or
* use {@link graphql.schema.idl.WiringFactory#providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment)}
* instead.
*
* @param directiveName the name of the directive to wire
* @param schemaDirectiveWiring the runtime behaviour of this wiring
*
* @return the runtime wiring builder
*
* @see #directiveWiring(SchemaDirectiveWiring)
* @see graphql.schema.idl.SchemaDirectiveWiring
* @see graphql.schema.idl.WiringFactory#providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment)
*/
public Builder directive(String directiveName, SchemaDirectiveWiring schemaDirectiveWiring) {
registeredDirectiveWiring.put(directiveName, schemaDirectiveWiring);
return this;
}
/**
* This adds a directive wiring that will be called for all directives.
* <p>
* Note : Unlike {@link #directive(String, SchemaDirectiveWiring)} which is only called back if a named
* directives is present, this directive wiring will be called back for every element
* in the schema even if it has zero directives.
*
* @param schemaDirectiveWiring the runtime behaviour of this wiring
*
* @return the runtime wiring builder
*
* @see #directive(String, SchemaDirectiveWiring)
* @see graphql.schema.idl.SchemaDirectiveWiring
* @see graphql.schema.idl.WiringFactory#providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment)
*/
public Builder directiveWiring(SchemaDirectiveWiring schemaDirectiveWiring) {
directiveWiring.add(schemaDirectiveWiring);
return this;
}
/**
* You can specify your own sort order of graphql types via {@link graphql.schema.GraphqlTypeComparatorRegistry}
* which will tell you what type of objects you are to sort when
* it asks for a comparator.
*
* @param comparatorRegistry your own comparator registry
*
* @return the runtime wiring builder
*/
public Builder comparatorRegistry(GraphqlTypeComparatorRegistry comparatorRegistry) {
this.comparatorRegistry = comparatorRegistry;
return this;
}
/**
* @return the built runtime wiring
*/
public RuntimeWiring build() {
return new RuntimeWiring(this);
}
}
}