-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ExecutionInput.java
402 lines (358 loc) · 12.7 KB
/
ExecutionInput.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
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
package graphql;
import graphql.cachecontrol.CacheControl;
import graphql.collect.ImmutableKit;
import graphql.execution.ExecutionId;
import graphql.execution.RawVariables;
import graphql.execution.instrumentation.dataloader.DataLoaderDispatcherInstrumentationState;
import org.dataloader.DataLoaderRegistry;
import java.util.Locale;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.UnaryOperator;
import static graphql.Assert.assertNotNull;
/**
* This represents the series of values that can be input on a graphql query execution
*/
@PublicApi
public class ExecutionInput {
private final String query;
private final String operationName;
private final Object context;
private final GraphQLContext graphQLContext;
private final Object localContext;
private final Object root;
private final RawVariables rawVariables;
private final Map<String, Object> extensions;
private final DataLoaderRegistry dataLoaderRegistry;
private final CacheControl cacheControl;
private final ExecutionId executionId;
private final Locale locale;
@Internal
private ExecutionInput(Builder builder) {
this.query = assertNotNull(builder.query, () -> "query can't be null");
this.operationName = builder.operationName;
this.context = builder.context;
this.graphQLContext = assertNotNull(builder.graphQLContext);
this.root = builder.root;
this.rawVariables = builder.rawVariables;
this.dataLoaderRegistry = builder.dataLoaderRegistry;
this.cacheControl = builder.cacheControl;
this.executionId = builder.executionId;
this.locale = builder.locale;
this.localContext = builder.localContext;
this.extensions = builder.extensions;
}
/**
* @return the query text
*/
public String getQuery() {
return query;
}
/**
* @return the name of the query operation
*/
public String getOperationName() {
return operationName;
}
/**
* The legacy context object has been deprecated in favour of the more shareable
* {@link #getGraphQLContext()}
*
* @return the context object to pass to all data fetchers
*
* @deprecated - use {@link #getGraphQLContext()}
*/
@Deprecated
public Object getContext() {
return context;
}
/**
* @return the shared {@link GraphQLContext} object to pass to all data fetchers
*/
public GraphQLContext getGraphQLContext() {
return graphQLContext;
}
/**
* @return the local context object to pass to all top level (i.e. query, mutation, subscription) data fetchers
*/
public Object getLocalContext() {
return localContext;
}
/**
* @return the root object to start the query execution on
*/
public Object getRoot() {
return root;
}
/**
* @return a map of raw variables that can be referenced via $syntax in the query.
*/
public Map<String, Object> getVariables() {
return rawVariables.toMap();
}
/**
* @return a map of raw variables that can be referenced via $syntax in the query.
*/
public RawVariables getRawVariables() {
return rawVariables;
}
/**
* @return the data loader registry associated with this execution
*/
public DataLoaderRegistry getDataLoaderRegistry() {
return dataLoaderRegistry;
}
/**
* @return the cache control helper associated with this execution
*/
public CacheControl getCacheControl() {
return cacheControl;
}
/**
* @return Id that will be/was used to execute this operation.
*/
public ExecutionId getExecutionId() {
return executionId;
}
/**
* This returns the locale of this operation.
*
* @return the locale of this operation
*/
public Locale getLocale() {
return locale;
}
/**
* @return a map of extension values that can be sent in to a request
*/
public Map<String, Object> getExtensions() {
return extensions;
}
/**
* This helps you transform the current ExecutionInput 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 ExecutionInput object based on calling build on that builder
*/
public ExecutionInput transform(Consumer<Builder> builderConsumer) {
Builder builder = new Builder()
.query(this.query)
.operationName(this.operationName)
.context(this.context)
.transfer(this.graphQLContext)
.localContext(this.localContext)
.root(this.root)
.dataLoaderRegistry(this.dataLoaderRegistry)
.cacheControl(this.cacheControl)
.variables(this.rawVariables.toMap())
.extensions(this.extensions)
.executionId(this.executionId)
.locale(this.locale);
builderConsumer.accept(builder);
return builder.build();
}
@Override
public String toString() {
return "ExecutionInput{" +
"query='" + query + '\'' +
", operationName='" + operationName + '\'' +
", context=" + context +
", graphQLContext=" + graphQLContext +
", root=" + root +
", rawVariables=" + rawVariables +
", dataLoaderRegistry=" + dataLoaderRegistry +
", executionId= " + executionId +
", locale= " + locale +
'}';
}
/**
* @return a new builder of ExecutionInput objects
*/
public static Builder newExecutionInput() {
return new Builder();
}
/**
* Creates a new builder of ExecutionInput objects with the given query
*
* @param query the query to execute
*
* @return a new builder of ExecutionInput objects
*/
public static Builder newExecutionInput(String query) {
return new Builder().query(query);
}
public static class Builder {
private String query;
private String operationName;
private GraphQLContext graphQLContext = GraphQLContext.newContext().build();
private Object context = graphQLContext; // we make these the same object on purpose - legacy code will get the same object if this change nothing
private Object localContext;
private Object root;
private RawVariables rawVariables = RawVariables.emptyVariables();
public Map<String, Object> extensions = ImmutableKit.emptyMap();
//
// this is important - it allows code to later known if we never really set a dataloader and hence it can optimize
// dataloader field tracking away.
//
private DataLoaderRegistry dataLoaderRegistry = DataLoaderDispatcherInstrumentationState.EMPTY_DATALOADER_REGISTRY;
private CacheControl cacheControl = CacheControl.newCacheControl();
private Locale locale;
private ExecutionId executionId;
public Builder query(String query) {
this.query = assertNotNull(query, () -> "query can't be null");
return this;
}
public Builder operationName(String operationName) {
this.operationName = operationName;
return this;
}
/**
* A default one will be assigned, but you can set your own.
*
* @param executionId an execution id object
*
* @return this builder
*/
public Builder executionId(ExecutionId executionId) {
this.executionId = executionId;
return this;
}
/**
* Sets the locale to use for this operation
*
* @param locale the locale to use
*
* @return this builder
*/
public Builder locale(Locale locale) {
this.locale = locale;
return this;
}
/**
* Sets initial localContext in root data fetchers
*
* @param localContext the local context to use
*
* @return this builder
*/
public Builder localContext(Object localContext) {
this.localContext = localContext;
return this;
}
/**
* The legacy context object
*
* @param context the context object to use
*
* @return this builder
*
* @deprecated - the {@link ExecutionInput#getGraphQLContext()} is a fixed mutable instance now
*/
@Deprecated
public Builder context(Object context) {
this.context = context;
return this;
}
/**
* The legacy context object
*
* @param contextBuilder the context builder object to use
*
* @return this builder
*
* @deprecated - the {@link ExecutionInput#getGraphQLContext()} is a fixed mutable instance now
*/
@Deprecated
public Builder context(GraphQLContext.Builder contextBuilder) {
this.context = contextBuilder.build();
return this;
}
/**
* The legacy context object
*
* @param contextBuilderFunction the context builder function to use
*
* @return this builder
*
* @deprecated - the {@link ExecutionInput#getGraphQLContext()} is a fixed mutable instance now
*/
@Deprecated
public Builder context(UnaryOperator<GraphQLContext.Builder> contextBuilderFunction) {
GraphQLContext.Builder builder = GraphQLContext.newContext();
builder = contextBuilderFunction.apply(builder);
return context(builder.build());
}
/**
* This will give you a builder of {@link GraphQLContext} and any values you set will be copied
* into the underlying {@link GraphQLContext} of this execution input
*
* @param builderFunction a builder function you can use to put values into the context
*
* @return this builder
*/
public Builder graphQLContext(Consumer<GraphQLContext.Builder> builderFunction) {
GraphQLContext.Builder builder = GraphQLContext.newContext();
builderFunction.accept(builder);
this.graphQLContext.putAll(builder);
return this;
}
/**
* This will put all the values from the map into the underlying {@link GraphQLContext} of this execution input
*
* @param mapOfContext a map of values to put in the context
*
* @return this builder
*/
public Builder graphQLContext(Map<?, Object> mapOfContext) {
this.graphQLContext.putAll(mapOfContext);
return this;
}
// hidden on purpose
private Builder transfer(GraphQLContext graphQLContext) {
this.graphQLContext = Assert.assertNotNull(graphQLContext);
return this;
}
public Builder root(Object root) {
this.root = root;
return this;
}
/**
* Adds raw (not coerced) variables
*
* @param rawVariables the map of raw variables
*
* @return this builder
*/
public Builder variables(Map<String, Object> rawVariables) {
assertNotNull(rawVariables, () -> "variables map can't be null");
this.rawVariables = RawVariables.of(rawVariables);
return this;
}
public Builder extensions(Map<String, Object> extensions) {
this.extensions = assertNotNull(extensions, () -> "extensions map can't be null");
return this;
}
/**
* You should create new {@link org.dataloader.DataLoaderRegistry}s and new {@link org.dataloader.DataLoader}s for each execution. Do not
* re-use
* instances as this will create unexpected results.
*
* @param dataLoaderRegistry a registry of {@link org.dataloader.DataLoader}s
*
* @return this builder
*/
public Builder dataLoaderRegistry(DataLoaderRegistry dataLoaderRegistry) {
this.dataLoaderRegistry = assertNotNull(dataLoaderRegistry);
return this;
}
public Builder cacheControl(CacheControl cacheControl) {
this.cacheControl = assertNotNull(cacheControl);
return this;
}
public ExecutionInput build() {
return new ExecutionInput(this);
}
}
}