Add GraphQL Footer Log in Dev UI

Signed-off-by: Phillip Kruger <phillip.kruger@gmail.com>
quarkusio · Sep 24, 2024 · c33b896 · c33b896
1 parent 2723368
commit c33b896
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 4 deletions.
diff --git a/bom/application/pom.xml b/bom/application/pom.xml
@@ -56,7 +56,7 @@
         <smallrye-health.version>4.1.0</smallrye-health.version>
         <smallrye-metrics.version>4.0.0</smallrye-metrics.version>
         <smallrye-open-api.version>3.12.0</smallrye-open-api.version>
-        <smallrye-graphql.version>2.10.0</smallrye-graphql.version>
+        <smallrye-graphql.version>2.10.1-SNAPSHOT</smallrye-graphql.version>
         <smallrye-fault-tolerance.version>6.4.0</smallrye-fault-tolerance.version>
         <smallrye-jwt.version>4.6.0</smallrye-jwt.version>
         <smallrye-context-propagation.version>2.1.2</smallrye-context-propagation.version>

diff --git a/...oyment/src/main/java/io/quarkus/smallrye/graphql/deployment/GraphQLDevUILogBuildItem.java b/...oyment/src/main/java/io/quarkus/smallrye/graphql/deployment/GraphQLDevUILogBuildItem.java
@@ -0,0 +1,21 @@
+package io.quarkus.smallrye.graphql.deployment;
+
+import java.util.concurrent.SubmissionPublisher;
+
+import io.quarkus.builder.item.SimpleBuildItem;
+import io.quarkus.runtime.RuntimeValue;
+
+/**
+ * Used to create the publisher for the graphql trafic log in dev ui
+ */
+public final class GraphQLDevUILogBuildItem extends SimpleBuildItem {
+    private final RuntimeValue<SubmissionPublisher<String>> publisher;
+
+    public GraphQLDevUILogBuildItem(RuntimeValue<SubmissionPublisher<String>> publisher) {
+        this.publisher = publisher;
+    }
+
+    public RuntimeValue<SubmissionPublisher<String>> getPublisher() {
+        return this.publisher;
+    }
+}
diff --git a/...oyment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLProcessor.java b/...oyment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLProcessor.java
@@ -16,6 +16,7 @@
 import java.util.Optional;
 import java.util.Scanner;
 import java.util.Set;
+import java.util.concurrent.SubmissionPublisher;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -36,6 +37,7 @@
 import io.quarkus.deployment.Capabilities;
 import io.quarkus.deployment.Capability;
 import io.quarkus.deployment.Feature;
+import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.Consume;
@@ -56,6 +58,7 @@
 import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
 import io.quarkus.deployment.metrics.MetricsCapabilityBuildItem;
+import io.quarkus.devui.spi.buildtime.FooterLogBuildItem;
 import io.quarkus.maven.dependency.GACT;
 import io.quarkus.runtime.LaunchMode;
 import io.quarkus.runtime.RuntimeValue;
@@ -329,6 +332,16 @@ void buildFinalIndex(
         smallRyeGraphQLFinalIndexProducer.produce(new SmallRyeGraphQLFinalIndexBuildItem(overridableIndex));
     }
 
+    @BuildStep(onlyIf = IsDevelopment.class)
+    @Record(ExecutionTime.STATIC_INIT)
+    void createDevUILog(BuildProducer<FooterLogBuildItem> footerLogProducer,
+            SmallRyeGraphQLRecorder recorder,
+            BuildProducer<GraphQLDevUILogBuildItem> graphQLDevUILogProducer) {
+        RuntimeValue<SubmissionPublisher<String>> publisher = recorder.createTraficLogPublisher();
+        footerLogProducer.produce(new FooterLogBuildItem("GraphQL", publisher));
+        graphQLDevUILogProducer.produce(new GraphQLDevUILogBuildItem(publisher));
+    }
+
     @Record(ExecutionTime.STATIC_INIT)
     @BuildStep
     void buildExecutionService(
@@ -339,14 +352,20 @@ void buildExecutionService(
             SmallRyeGraphQLFinalIndexBuildItem graphQLFinalIndexBuildItem,
             BeanContainerBuildItem beanContainer,
             BuildProducer<SystemPropertyBuildItem> systemPropertyProducer,
-            SmallRyeGraphQLConfig graphQLConfig) {
+            SmallRyeGraphQLConfig graphQLConfig,
+            Optional<GraphQLDevUILogBuildItem> graphQLDevUILogBuildItem) {
 
         activateFederation(graphQLConfig, systemPropertyProducer, graphQLFinalIndexBuildItem);
         graphQLConfig.extraScalars.ifPresent(this::registerExtraScalarsInSchema);
         Schema schema = SchemaBuilder.build(graphQLFinalIndexBuildItem.getFinalIndex(),
                 Converters.getImplicitConverter(TypeAutoNameStrategy.class).convert(graphQLConfig.autoNameStrategy));
 
-        RuntimeValue<Boolean> initialized = recorder.createExecutionService(beanContainer.getValue(), schema, graphQLConfig);
+        Optional publisher = Optional.empty();
+        if (graphQLDevUILogBuildItem.isPresent()) {
+            publisher = Optional.of(graphQLDevUILogBuildItem.get().getPublisher());
+        }
+        RuntimeValue<Boolean> initialized = recorder.createExecutionService(beanContainer.getValue(), schema, graphQLConfig,
+                publisher);
         graphQLInitializedProducer.produce(new SmallRyeGraphQLInitializedBuildItem(initialized));
 
         // Make sure the complex object from the application can work in native mode

diff --git a/...ql/runtime/src/main/java/io/quarkus/smallrye/graphql/runtime/SmallRyeGraphQLRecorder.java b/...ql/runtime/src/main/java/io/quarkus/smallrye/graphql/runtime/SmallRyeGraphQLRecorder.java
@@ -1,6 +1,8 @@
 package io.quarkus.smallrye.graphql.runtime;
 
 import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.SubmissionPublisher;
 import java.util.function.Consumer;
 
 import graphql.schema.GraphQLSchema;
@@ -26,13 +28,21 @@
 @Recorder
 public class SmallRyeGraphQLRecorder {
 
+    public RuntimeValue<SubmissionPublisher<String>> createTraficLogPublisher() {
+        return new RuntimeValue<>(new SubmissionPublisher<>());
+    }
+
     public RuntimeValue<Boolean> createExecutionService(BeanContainer beanContainer,
             Schema schema,
-            SmallRyeGraphQLConfig graphQLConfig) {
+            SmallRyeGraphQLConfig graphQLConfig,
+            Optional<RuntimeValue<SubmissionPublisher<String>>> publisher) {
         GraphQLProducer graphQLProducer = beanContainer.beanInstance(GraphQLProducer.class);
         if (graphQLConfig.extraScalars.isPresent()) {
             registerExtraScalars(graphQLConfig.extraScalars.get());
         }
+        if (publisher.isPresent()) {
+            graphQLProducer.setTraficPublisher(publisher.get().getValue());
+        }
         GraphQLSchema graphQLSchema = graphQLProducer.initialize(schema);
         return new RuntimeValue<>(graphQLSchema != null);
     }