Merge pull request #9439 from jmartisk/graphql-tracing

Enable tracing in the SmallRye GraphQL extension

Author: geoand

core/deployment/src/main/java/io/quarkus/deployment/Capabilities.java

@@ -36,6 +36,7 @@ public final class Capabilities extends SimpleBuildItem {
     public static final String CONTAINER_IMAGE_DOCKER = "io.quarkus.container-image-docker";
     public static final String CONTAINER_IMAGE_S2I = "io.quarkus.container-image-s2i";
     public static final String HIBERNATE_ORM = "io.quarkus.hibernate-orm";
+    public static final String SMALLRYE_OPENTRACING = "io.quarkus.opentracing";
 
     private final Set<String> capabilities;
 

extensions/smallrye-graphql/deployment/pom.xml

@@ -65,6 +65,11 @@
             <artifactId>quarkus-smallrye-metrics</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-opentracing</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

extensions/smallrye-graphql/deployment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLProcessor.java

@@ -223,6 +223,14 @@ void buildEndpoints(
                 new RouteBuildItem(quarkusConfig.rootPath + SCHEMA_PATH, schemaHandler, HandlerType.BLOCKING));
     }
 
+    @BuildStep
+    void openTracingIntegration(Capabilities capabilities,
+            BuildProducer<SystemPropertyBuildItem> properties) {
+        if (capabilities.isCapabilityPresent(Capabilities.SMALLRYE_OPENTRACING)) {
+            properties.produce(new SystemPropertyBuildItem("smallrye.graphql.tracing.enabled", "true"));
+        }
+    }
+
     private Set<String> getClassesToRegisterForReflection(Schema schema) {
         // Unique list of classes we need to do reflection on
         Set<String> classes = new HashSet<>();

extensions/smallrye-graphql/deployment/src/test/java/io/quarkus/smallrye/graphql/deployment/GraphQLTracingTest.java

@@ -0,0 +1,48 @@
+package io.quarkus.smallrye.graphql.deployment;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.asset.EmptyAsset;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.opentracing.mock.MockSpan;
+import io.opentracing.mock.MockTracer;
+import io.opentracing.util.GlobalTracer;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class GraphQLTracingTest extends AbstractGraphQLTest {
+
+    @RegisterExtension
+    static QuarkusUnitTest test = new QuarkusUnitTest()
+            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
+                    .addClasses(TestResource.class, TestPojo.class, TestRandom.class)
+                    .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml"));
+
+    static MockTracer mockTracer = new MockTracer();
+
+    static {
+        GlobalTracer.register(mockTracer);
+    }
+
+    @BeforeEach
+    public void before() {
+        mockTracer.reset();
+    }
+
+    @Test
+    public void testTracing() {
+        pingTest();
+        List<MockSpan> spans = mockTracer.finishedSpans()
+                .stream()
+                .filter(span -> span.operationName().equals("GraphQL:Query.ping"))
+                .collect(Collectors.toList());
+        Assertions.assertEquals(1, spans.size());
+    }
+
+}

extensions/smallrye-graphql/deployment/src/test/java/io/quarkus/smallrye/graphql/deployment/ui/DisabledTest.java

@@ -19,6 +19,5 @@ public class DisabledTest {
     @Test
     public void shouldUseDefaultConfig() {
         RestAssured.when().get("/graphql-ui").then().statusCode(404);
-        RestAssured.when().get("/graphql-ui/index.html").then().statusCode(404);
     }
 }

extensions/smallrye-opentracing/deployment/src/main/java/io/quarkus/smallrye/opentracing/deployment/SmallRyeOpenTracingProcessor.java

@@ -11,6 +11,7 @@
 import io.quarkus.deployment.Capabilities;
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.CapabilityBuildItem;
 import io.quarkus.deployment.builditem.FeatureBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem;
 import io.quarkus.resteasy.common.spi.ResteasyJaxrsProviderBuildItem;
@@ -59,4 +60,9 @@ void setupFilter(BuildProducer<ResteasyJaxrsProviderBuildItem> providers,
         }
     }
 
+    @BuildStep
+    public CapabilityBuildItem capability() {
+        return new CapabilityBuildItem(Capabilities.SMALLRYE_OPENTRACING);
+    }
+
 }