forked from quarkusio/quarkus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SmallRyeGraphQLProcessor.java
666 lines (579 loc) · 30.9 KB
/
SmallRyeGraphQLProcessor.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
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
package io.quarkus.smallrye.graphql.deployment;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Scanner;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.eclipse.microprofile.config.ConfigProvider;
import org.jboss.jandex.Indexer;
import org.jboss.logging.Logger;
import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.arc.deployment.BeanContainerBuildItem;
import io.quarkus.arc.deployment.BeanDefiningAnnotationBuildItem;
import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
import io.quarkus.arc.processor.BuiltinScope;
import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.Capability;
import io.quarkus.deployment.Feature;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.annotations.Consume;
import io.quarkus.deployment.annotations.ExecutionTime;
import io.quarkus.deployment.annotations.Record;
import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
import io.quarkus.deployment.builditem.FeatureBuildItem;
import io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem;
import io.quarkus.deployment.builditem.IndexDependencyBuildItem;
import io.quarkus.deployment.builditem.LaunchModeBuildItem;
import io.quarkus.deployment.builditem.ShutdownContextBuildItem;
import io.quarkus.deployment.builditem.SystemPropertyBuildItem;
import io.quarkus.deployment.builditem.TransformedClassesBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ReflectiveHierarchyBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
import io.quarkus.deployment.metrics.MetricsCapabilityBuildItem;
import io.quarkus.maven.dependency.GACT;
import io.quarkus.runtime.LaunchMode;
import io.quarkus.runtime.RuntimeValue;
import io.quarkus.runtime.configuration.ConfigurationException;
import io.quarkus.smallrye.graphql.runtime.SmallRyeGraphQLConfig;
import io.quarkus.smallrye.graphql.runtime.SmallRyeGraphQLConfigMapping;
import io.quarkus.smallrye.graphql.runtime.SmallRyeGraphQLLocaleResolver;
import io.quarkus.smallrye.graphql.runtime.SmallRyeGraphQLRecorder;
import io.quarkus.smallrye.graphql.runtime.SmallRyeGraphQLRuntimeConfig;
import io.quarkus.vertx.http.deployment.BodyHandlerBuildItem;
import io.quarkus.vertx.http.deployment.HttpRootPathBuildItem;
import io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem;
import io.quarkus.vertx.http.deployment.RouteBuildItem;
import io.quarkus.vertx.http.deployment.WebsocketSubProtocolsBuildItem;
import io.quarkus.vertx.http.deployment.webjar.WebJarBuildItem;
import io.quarkus.vertx.http.deployment.webjar.WebJarResourcesFilter;
import io.quarkus.vertx.http.deployment.webjar.WebJarResultsBuildItem;
import io.smallrye.graphql.api.Entry;
import io.smallrye.graphql.cdi.config.ConfigKey;
import io.smallrye.graphql.cdi.config.MicroProfileConfig;
import io.smallrye.graphql.cdi.producer.GraphQLProducer;
import io.smallrye.graphql.schema.Annotations;
import io.smallrye.graphql.schema.SchemaBuilder;
import io.smallrye.graphql.schema.model.Argument;
import io.smallrye.graphql.schema.model.Field;
import io.smallrye.graphql.schema.model.Group;
import io.smallrye.graphql.schema.model.InputType;
import io.smallrye.graphql.schema.model.Operation;
import io.smallrye.graphql.schema.model.Reference;
import io.smallrye.graphql.schema.model.Schema;
import io.smallrye.graphql.schema.model.Type;
import io.smallrye.graphql.spi.EventingService;
import io.smallrye.graphql.spi.LookupService;
import io.vertx.core.Handler;
import io.vertx.ext.web.RoutingContext;
/**
* Processor for SmallRye GraphQL.
* We scan all annotations and build the model during build.
*/
public class SmallRyeGraphQLProcessor {
private static final Logger LOG = Logger.getLogger(SmallRyeGraphQLProcessor.class);
private static final String SCHEMA_PATH = "schema.graphql";
// For Service integration
private static final String SERVICE_NOT_AVAILABLE_WARNING = "The %s property is true, but the %s extension is not present. SmallRye GraphQL %s will be disabled.";
private static final String TRUE = "true";
private static final String FALSE = "false";
// For the UI
private static final GACT GRAPHQL_UI_WEBJAR_ARTIFACT_KEY = new GACT("io.smallrye", "smallrye-graphql-ui-graphiql", null,
"jar");
private static final String GRAPHQL_UI_WEBJAR_STATIC_RESOURCES_PATH = "META-INF/resources/graphql-ui/";
private static final String FILE_TO_UPDATE = "render.js";
private static final String LINE_TO_UPDATE = "const api = '";
private static final String LINE_FORMAT = LINE_TO_UPDATE + "%s';";
private static final String UI_LINE_TO_UPDATE = "const ui = '";
private static final String UI_LINE_FORMAT = UI_LINE_TO_UPDATE + "%s';";
private static final String LOGO_LINE_TO_UPDATE = "const logo = '";
private static final String LOGO_LINE_FORMAT = LOGO_LINE_TO_UPDATE + "%s';";
// Branding files to monitor for changes
private static final String BRANDING_DIR = "META-INF/branding/";
private static final String BRANDING_LOGO_GENERAL = BRANDING_DIR + "logo.png";
private static final String BRANDING_LOGO_MODULE = BRANDING_DIR + "smallrye-graphql-ui-graphiql.png";
private static final String BRANDING_STYLE_GENERAL = BRANDING_DIR + "style.css";
private static final String BRANDING_STYLE_MODULE = BRANDING_DIR + "smallrye-graphql-ui-graphiql.css";
private static final String BRANDING_FAVICON_GENERAL = BRANDING_DIR + "favicon.ico";
private static final String BRANDING_FAVICON_MODULE = BRANDING_DIR + "smallrye-graphql-ui-graphiql.ico";
private static final String SUBPROTOCOL_GRAPHQL_WS = "graphql-ws";
private static final String SUBPROTOCOL_GRAPHQL_TRANSPORT_WS = "graphql-transport-ws";
private static final List<String> SUPPORTED_WEBSOCKET_SUBPROTOCOLS = List.of(SUBPROTOCOL_GRAPHQL_WS,
SUBPROTOCOL_GRAPHQL_TRANSPORT_WS);
@BuildStep
void feature(BuildProducer<FeatureBuildItem> featureProducer) {
featureProducer.produce(new FeatureBuildItem(Feature.SMALLRYE_GRAPHQL));
}
@BuildStep
List<HotDeploymentWatchedFileBuildItem> brandingFiles() {
return Stream.of(BRANDING_LOGO_GENERAL,
BRANDING_STYLE_GENERAL,
BRANDING_FAVICON_GENERAL,
BRANDING_LOGO_MODULE,
BRANDING_STYLE_MODULE,
BRANDING_FAVICON_MODULE).map(HotDeploymentWatchedFileBuildItem::new)
.collect(Collectors.toList());
}
@BuildStep
void additionalBeanDefiningAnnotation(BuildProducer<BeanDefiningAnnotationBuildItem> beanDefiningAnnotationProducer) {
// Make ArC discover the beans marked with the @GraphQLApi qualifier
beanDefiningAnnotationProducer
.produce(new BeanDefiningAnnotationBuildItem(Annotations.GRAPHQL_API, BuiltinScope.SINGLETON.getName()));
}
@BuildStep
void additionalBean(Capabilities capabilities, BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer) {
additionalBeanProducer.produce(AdditionalBeanBuildItem.builder()
.addBeanClass(GraphQLProducer.class)
.setUnremovable().build());
if (capabilities.isPresent(Capability.HIBERNATE_VALIDATOR)) {
additionalBeanProducer.produce(AdditionalBeanBuildItem.builder()
.addBeanClass(SmallRyeGraphQLLocaleResolver.class)
.setUnremovable().build());
}
}
@BuildStep
void addDependencies(BuildProducer<IndexDependencyBuildItem> indexDependency) {
indexDependency.produce(new IndexDependencyBuildItem("com.graphql-java", "graphql-java"));
}
@BuildStep
void registerNativeImageResources(BuildProducer<ServiceProviderBuildItem> serviceProvider) throws IOException {
// Lookup Service (We use the one from the CDI Module)
serviceProvider.produce(ServiceProviderBuildItem.allProvidersFromClassPath(LookupService.class.getName()));
// Eventing Service (We use the one from the CDI Module)
serviceProvider.produce(ServiceProviderBuildItem.allProvidersFromClassPath(EventingService.class.getName()));
// Use MicroProfile Config (We use the one from the CDI Module)
serviceProvider.produce(ServiceProviderBuildItem.allProvidersFromClassPath(MicroProfileConfig.class.getName()));
// Config mapping between SmallRye / MP and Quarkus
serviceProvider
.produce(ServiceProviderBuildItem.allProvidersFromClassPath(SmallRyeGraphQLConfigMapping.class.getName()));
}
@BuildStep
SmallRyeGraphQLIndexBuildItem createIndex(TransformedClassesBuildItem transformedClassesBuildItem) {
Map<String, byte[]> modifiedClasses = new HashMap<>();
Map<Path, Set<TransformedClassesBuildItem.TransformedClass>> transformedClassesByJar = transformedClassesBuildItem
.getTransformedClassesByJar();
for (Map.Entry<Path, Set<TransformedClassesBuildItem.TransformedClass>> transformedClassesByJarEntrySet : transformedClassesByJar
.entrySet()) {
Set<TransformedClassesBuildItem.TransformedClass> transformedClasses = transformedClassesByJarEntrySet.getValue();
for (TransformedClassesBuildItem.TransformedClass transformedClass : transformedClasses) {
modifiedClasses.put(transformedClass.getClassName(), transformedClass.getData());
}
}
return new SmallRyeGraphQLIndexBuildItem(modifiedClasses);
}
@Record(ExecutionTime.STATIC_INIT)
@BuildStep
void buildExecutionService(
BuildProducer<ReflectiveClassBuildItem> reflectiveClassProducer,
BuildProducer<ReflectiveHierarchyBuildItem> reflectiveHierarchyProducer,
BuildProducer<SmallRyeGraphQLInitializedBuildItem> graphQLInitializedProducer,
SmallRyeGraphQLRecorder recorder,
SmallRyeGraphQLIndexBuildItem graphQLIndexBuildItem,
BeanContainerBuildItem beanContainer,
CombinedIndexBuildItem combinedIndex,
SmallRyeGraphQLConfig graphQLConfig) {
Indexer indexer = new Indexer();
Map<String, byte[]> modifiedClases = graphQLIndexBuildItem.getModifiedClases();
for (Map.Entry<String, byte[]> kv : modifiedClases.entrySet()) {
if (kv.getKey() != null && kv.getValue() != null) {
try (ByteArrayInputStream bais = new ByteArrayInputStream(kv.getValue())) {
indexer.index(bais);
} catch (IOException ex) {
LOG.warn("Could not index [" + kv.getKey() + "] - " + ex.getMessage());
}
}
}
try {
indexer.indexClass(Map.class);
indexer.indexClass(Entry.class);
} catch (IOException ex) {
LOG.warn("Failure while creating index", ex);
}
OverridableIndex overridableIndex = OverridableIndex.create(combinedIndex.getIndex(), indexer.complete());
Schema schema = SchemaBuilder.build(overridableIndex, graphQLConfig.autoNameStrategy);
RuntimeValue<Boolean> initialized = recorder.createExecutionService(beanContainer.getValue(), schema);
graphQLInitializedProducer.produce(new SmallRyeGraphQLInitializedBuildItem(initialized));
// Make sure the complex object from the application can work in native mode
reflectiveClassProducer.produce(new ReflectiveClassBuildItem(true, true, getSchemaJavaClasses(schema)));
// Make sure the GraphQL Java classes needed for introspection can work in native mode
reflectiveClassProducer.produce(new ReflectiveClassBuildItem(true, true, getGraphQLJavaClasses()));
}
@Record(ExecutionTime.RUNTIME_INIT)
@BuildStep
void buildSchemaEndpoint(
BuildProducer<RouteBuildItem> routeProducer,
HttpRootPathBuildItem httpRootPathBuildItem,
SmallRyeGraphQLInitializedBuildItem graphQLInitializedBuildItem,
SmallRyeGraphQLRecorder recorder,
SmallRyeGraphQLConfig graphQLConfig) {
Handler<RoutingContext> schemaHandler = recorder.schemaHandler(graphQLInitializedBuildItem.getInitialized(),
graphQLConfig.schemaAvailable);
routeProducer.produce(httpRootPathBuildItem.routeBuilder()
.nestedRoute(graphQLConfig.rootPath, SCHEMA_PATH)
.handler(schemaHandler)
.displayOnNotFoundPage("MicroProfile GraphQL Schema")
.build());
}
@Record(ExecutionTime.RUNTIME_INIT)
@BuildStep
@Consume(BeanContainerBuildItem.class)
void buildExecutionEndpoint(
BuildProducer<RouteBuildItem> routeProducer,
HttpRootPathBuildItem httpRootPathBuildItem,
SmallRyeGraphQLInitializedBuildItem graphQLInitializedBuildItem,
SmallRyeGraphQLRecorder recorder,
ShutdownContextBuildItem shutdownContext,
LaunchModeBuildItem launchMode,
BodyHandlerBuildItem bodyHandlerBuildItem,
SmallRyeGraphQLConfig graphQLConfig,
BeanContainerBuildItem beanContainer,
BuildProducer<WebsocketSubProtocolsBuildItem> webSocketSubProtocols) {
/*
* <em>Ugly Hack</em>
* In dev mode, we pass a classloader to use in the CDI Loader.
* This hack is required because using the TCCL would get an outdated version - the initial one.
* This is because the worker thread on which the handler is called captures the TCCL at creation time
* and does not allow updating it.
*
* In non dev mode, the TCCL is used.
*/
if (launchMode.getLaunchMode() == LaunchMode.DEVELOPMENT) {
recorder.setupClDevMode(shutdownContext);
}
boolean runBlocking = shouldRunBlockingRoute(graphQLConfig);
// Subscriptions
Handler<RoutingContext> graphqlOverWebsocketHandler = recorder
.graphqlOverWebsocketHandler(beanContainer.getValue(), graphQLInitializedBuildItem.getInitialized(),
runBlocking);
HttpRootPathBuildItem.Builder subscriptionsBuilder = httpRootPathBuildItem.routeBuilder()
.orderedRoute(graphQLConfig.rootPath, Integer.MIN_VALUE)
.handler(graphqlOverWebsocketHandler);
routeProducer.produce(subscriptionsBuilder.build());
// WebSocket subprotocols
graphQLConfig.websocketSubprotocols.ifPresentOrElse(subprotocols -> {
for (String subprotocol : subprotocols) {
if (!SUPPORTED_WEBSOCKET_SUBPROTOCOLS.contains(subprotocol)) {
throw new IllegalArgumentException("Unknown websocket subprotocol: " + subprotocol);
} else {
webSocketSubProtocols.produce(new WebsocketSubProtocolsBuildItem(subprotocol));
}
}
}, () -> {
// if unspecified, allow all supported subprotocols
for (String subprotocol : SUPPORTED_WEBSOCKET_SUBPROTOCOLS) {
webSocketSubProtocols.produce(new WebsocketSubProtocolsBuildItem(subprotocol));
}
});
// Queries and Mutations
boolean allowGet = getBooleanConfigValue(ConfigKey.ALLOW_GET, false);
boolean allowQueryParametersOnPost = getBooleanConfigValue(ConfigKey.ALLOW_POST_WITH_QUERY_PARAMETERS, false);
Handler<RoutingContext> executionHandler = recorder.executionHandler(graphQLInitializedBuildItem.getInitialized(),
allowGet, allowQueryParametersOnPost, runBlocking);
HttpRootPathBuildItem.Builder requestBuilder = httpRootPathBuildItem.routeBuilder()
.routeFunction(graphQLConfig.rootPath, recorder.routeFunction(bodyHandlerBuildItem.getHandler()))
.handler(executionHandler)
.routeConfigKey("quarkus.smallrye-graphql.root-path")
.displayOnNotFoundPage("MicroProfile GraphQL Endpoint");
if (runBlocking) {
requestBuilder = requestBuilder.blockingRoute();
}
routeProducer.produce(requestBuilder.build());
}
private boolean shouldRunBlockingRoute(SmallRyeGraphQLConfig graphQLConfig) {
if (graphQLConfig.nonBlockingEnabled.isPresent()) {
return !graphQLConfig.nonBlockingEnabled.get();
}
return false;
}
private boolean getBooleanConfigValue(String smallryeKey, boolean defaultValue) {
return ConfigProvider.getConfig().getOptionalValue(smallryeKey, boolean.class).orElse(defaultValue);
}
private String[] getSchemaJavaClasses(Schema schema) {
// Unique list of classes we need to do reflection on
Set<String> classes = new HashSet<>();
classes.addAll(getOperationClassNames(schema.getQueries()));
classes.addAll(getOperationClassNames(schema.getGroupedQueries()));
classes.addAll(getOperationClassNames(schema.getMutations()));
classes.addAll(getOperationClassNames(schema.getGroupedMutations()));
classes.addAll(getTypeClassNames(schema.getTypes().values()));
classes.addAll(getInputClassNames(schema.getInputs().values()));
classes.addAll(getInterfaceClassNames(schema.getInterfaces().values()));
return classes.toArray(String[]::new);
}
private Class[] getGraphQLJavaClasses() {
Set<Class> classes = new HashSet<>();
classes.add(graphql.schema.FieldCoordinates.class);
classes.add(graphql.schema.GraphQLArgument.class);
classes.add(graphql.schema.GraphQLCodeRegistry.class);
classes.add(graphql.schema.GraphQLEnumType.class);
classes.add(graphql.schema.GraphQLFieldDefinition.class);
classes.add(graphql.schema.GraphQLInputObjectField.class);
classes.add(graphql.schema.GraphQLInputObjectType.class);
classes.add(graphql.schema.GraphQLInputType.class);
classes.add(graphql.schema.GraphQLInterfaceType.class);
classes.add(graphql.schema.GraphQLList.class);
classes.add(graphql.schema.GraphQLNonNull.class);
classes.add(graphql.schema.GraphQLObjectType.class);
classes.add(graphql.schema.GraphQLOutputType.class);
classes.add(graphql.schema.GraphQLScalarType.class);
classes.add(graphql.schema.GraphQLSchema.class);
classes.add(graphql.schema.GraphQLTypeReference.class);
classes.add(List.class);
classes.add(Collection.class);
return classes.toArray(Class[]::new);
}
private Set<String> getOperationClassNames(Set<Operation> operations) {
Set<String> classes = new HashSet<>();
for (Operation operation : operations) {
classes.add(operation.getClassName());
for (Argument argument : operation.getArguments()) {
classes.addAll(getAllReferenceClasses(argument.getReference()));
}
classes.addAll(getAllReferenceClasses(operation.getReference()));
}
return classes;
}
private Set<String> getOperationClassNames(Map<Group, Set<Operation>> groupedOperations) {
Set<String> classes = new HashSet<>();
Collection<Set<Operation>> operations = groupedOperations.values();
for (Set<Operation> operationSet : operations) {
classes.addAll(getOperationClassNames(operationSet));
}
return classes;
}
private Set<String> getTypeClassNames(Collection<Type> complexGraphQLTypes) {
Set<String> classes = new HashSet<>();
for (Type complexGraphQLType : complexGraphQLTypes) {
classes.add(complexGraphQLType.getClassName());
classes.addAll(getFieldClassNames(complexGraphQLType.getFields()));
}
return classes;
}
private Set<String> getInputClassNames(Collection<InputType> complexGraphQLTypes) {
Set<String> classes = new HashSet<>();
for (InputType complexGraphQLType : complexGraphQLTypes) {
classes.add(complexGraphQLType.getClassName());
classes.addAll(getFieldClassNames(complexGraphQLType.getFields()));
}
return classes;
}
private Set<String> getInterfaceClassNames(Collection<Type> complexGraphQLTypes) {
Set<String> classes = new HashSet<>();
for (Type complexGraphQLType : complexGraphQLTypes) {
classes.add(complexGraphQLType.getClassName());
classes.addAll(getFieldClassNames(complexGraphQLType.getFields()));
}
return classes;
}
private Set<String> getFieldClassNames(Map<String, Field> fields) {
Set<String> classes = new HashSet<>();
for (Field field : fields.values()) {
classes.addAll(getAllReferenceClasses(field.getReference()));
}
return classes;
}
private Set<String> getAllReferenceClasses(Reference reference) {
Set<String> classes = new HashSet<>();
classes.add(reference.getClassName());
if (reference.getClassParametrizedTypes() != null && !reference.getClassParametrizedTypes().isEmpty()) {
Collection<Reference> parametrized = reference.getClassParametrizedTypes().values();
for (Reference r : parametrized) {
classes.addAll(getAllReferenceClasses(r));
}
}
return classes;
}
@BuildStep
void printDataFetcherExceptionInDevMode(SmallRyeGraphQLConfig graphQLConfig,
LaunchModeBuildItem launchMode,
BuildProducer<SystemPropertyBuildItem> systemProperties) {
// User did not set this explicitly
if (!graphQLConfig.printDataFetcherException.isPresent()) {
if (launchMode.getLaunchMode().isDevOrTest()) {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.PRINT_DATAFETCHER_EXCEPTION, TRUE));
}
} else {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.PRINT_DATAFETCHER_EXCEPTION,
String.valueOf(graphQLConfig.printDataFetcherException.get())));
}
}
// Services Integrations
@BuildStep
void activateMetrics(Capabilities capabilities,
Optional<MetricsCapabilityBuildItem> metricsCapability,
SmallRyeGraphQLConfig graphQLConfig,
BuildProducer<SystemPropertyBuildItem> systemProperties) {
boolean activate = shouldActivateService(graphQLConfig.metricsEnabled,
metricsCapability.isPresent(),
"quarkus-smallrye-metrics",
"metrics",
"quarkus.smallrye-graphql.metrics.enabled",
false);
if (activate) {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_METRICS, TRUE));
} else {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_METRICS, FALSE));
}
}
@BuildStep
void activateTracing(Capabilities capabilities,
SmallRyeGraphQLConfig graphQLConfig,
BuildProducer<SystemPropertyBuildItem> systemProperties,
BuildProducer<UnremovableBeanBuildItem> unremovableBeans) {
boolean activate = shouldActivateService(graphQLConfig.tracingEnabled,
capabilities.isPresent(Capability.OPENTRACING),
"quarkus-smallrye-opentracing",
Capability.OPENTRACING,
"quarkus.smallrye-graphql.tracing.enabled",
true);
if (activate) {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_TRACING, TRUE));
} else {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_TRACING, FALSE));
}
}
@BuildStep
void activateValidation(Capabilities capabilities,
SmallRyeGraphQLConfig graphQLConfig,
BuildProducer<SystemPropertyBuildItem> systemProperties) {
boolean activate = shouldActivateService(graphQLConfig.validationEnabled,
capabilities.isPresent(Capability.HIBERNATE_VALIDATOR),
"quarkus-hibernate-validator",
Capability.HIBERNATE_VALIDATOR,
"quarkus.smallrye-graphql.validation.enabled",
true);
if (activate) {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_VALIDATION, TRUE));
} else {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_VALIDATION, FALSE));
}
}
@BuildStep
void activateEventing(SmallRyeGraphQLConfig graphQLConfig, BuildProducer<SystemPropertyBuildItem> systemProperties) {
if (graphQLConfig.eventsEnabled) {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_EVENTS, TRUE));
} else {
systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_EVENTS, FALSE));
}
}
private boolean shouldActivateService(Optional<Boolean> serviceEnabled,
boolean linkedCapabilityIsPresent,
String linkedExtensionName,
String linkedCapabilityName,
String configKey,
boolean activateByDefaultIfCapabilityIsPresent) {
if (serviceEnabled.isPresent()) {
// The user explicitly asked from something
boolean isEnabled = serviceEnabled.get();
if (isEnabled && !linkedCapabilityIsPresent) {
// Warn and disable
LOG.warnf(SERVICE_NOT_AVAILABLE_WARNING, configKey, linkedExtensionName, linkedCapabilityName);
}
return (isEnabled && linkedCapabilityIsPresent);
} else {
// Auto dis/enable
return linkedCapabilityIsPresent && activateByDefaultIfCapabilityIsPresent;
}
}
// UI Related
@BuildStep
void getGraphqlUiFinalDestination(
HttpRootPathBuildItem httpRootPath,
NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
LaunchModeBuildItem launchMode,
SmallRyeGraphQLConfig graphQLConfig,
BuildProducer<WebJarBuildItem> webJarBuildProducer) {
if (shouldInclude(launchMode, graphQLConfig)) {
if ("/".equals(graphQLConfig.ui.rootPath)) {
throw new ConfigurationException(
"quarkus.smallrye-graphql.root-path-ui was set to \"/\", this is not allowed as it blocks the application from serving anything else.",
Collections.singleton("quarkus.smallrye-graphql.root-path-ui"));
}
String graphQLPath = httpRootPath.resolvePath(graphQLConfig.rootPath);
String graphQLUiPath = nonApplicationRootPathBuildItem.resolvePath(graphQLConfig.ui.rootPath);
webJarBuildProducer.produce(
WebJarBuildItem.builder().artifactKey(GRAPHQL_UI_WEBJAR_ARTIFACT_KEY) //
.root(GRAPHQL_UI_WEBJAR_STATIC_RESOURCES_PATH) //
.filter(new WebJarResourcesFilter() {
@Override
public FilterResult apply(String fileName, InputStream file) throws IOException {
if (fileName.endsWith(FILE_TO_UPDATE)) {
String content = new String(file.readAllBytes(), StandardCharsets.UTF_8);
content = updateUrl(content, graphQLPath, LINE_TO_UPDATE,
LINE_FORMAT);
content = updateUrl(content, graphQLUiPath,
UI_LINE_TO_UPDATE,
UI_LINE_FORMAT);
content = updateUrl(content, graphQLUiPath,
LOGO_LINE_TO_UPDATE,
LOGO_LINE_FORMAT);
return new FilterResult(
new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8)), true);
}
return new FilterResult(file, false);
}
})
.build());
}
}
@BuildStep
@Record(ExecutionTime.RUNTIME_INIT)
void registerGraphQLUiHandler(
BuildProducer<RouteBuildItem> routeProducer,
SmallRyeGraphQLRecorder recorder,
SmallRyeGraphQLRuntimeConfig runtimeConfig,
LaunchModeBuildItem launchMode,
NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
SmallRyeGraphQLConfig graphQLConfig,
WebJarResultsBuildItem webJarResultsBuildItem,
BuildProducer<SmallRyeGraphQLBuildItem> smallRyeGraphQLBuildProducer, ShutdownContextBuildItem shutdownContext) {
WebJarResultsBuildItem.WebJarResult result = webJarResultsBuildItem.byArtifactKey(GRAPHQL_UI_WEBJAR_ARTIFACT_KEY);
if (result == null) {
return;
}
if (shouldInclude(launchMode, graphQLConfig)) {
String graphQLUiPath = nonApplicationRootPathBuildItem.resolvePath(graphQLConfig.ui.rootPath);
smallRyeGraphQLBuildProducer
.produce(new SmallRyeGraphQLBuildItem(result.getFinalDestination(), graphQLUiPath));
Handler<RoutingContext> handler = recorder.uiHandler(result.getFinalDestination(),
graphQLUiPath, result.getWebRootConfigurations(), runtimeConfig, shutdownContext);
routeProducer.produce(nonApplicationRootPathBuildItem.routeBuilder()
.route(graphQLConfig.ui.rootPath)
.displayOnNotFoundPage("GraphQL UI")
.routeConfigKey("quarkus.smallrye-graphql.ui.root-path")
.handler(handler)
.build());
routeProducer.produce(nonApplicationRootPathBuildItem.routeBuilder()
.route(graphQLConfig.ui.rootPath + "*")
.handler(handler)
.build());
}
}
private static boolean shouldInclude(LaunchModeBuildItem launchMode, SmallRyeGraphQLConfig graphQLConfig) {
return launchMode.getLaunchMode().isDevOrTest() || graphQLConfig.ui.alwaysInclude;
}
private String updateUrl(String original, String path, String lineStartsWith, String format) {
try (Scanner scanner = new Scanner(original)) {
while (scanner.hasNextLine()) {
String line = scanner.nextLine();
if (line.trim().startsWith(lineStartsWith)) {
String newLine = String.format(format, path);
return original.replace(line.trim(), newLine);
}
}
}
return original;
}
}