Merge pull request #105 from marceloverdijk/instrumentation-autoconfiguration

Added instrumentation auto configuration

Author: oliemansm

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLInstrumentationAutoConfiguration.java

@@ -0,0 +1,47 @@
+package com.oembedler.moon.graphql.boot;
+
+import graphql.analysis.MaxQueryComplexityInstrumentation;
+import graphql.analysis.MaxQueryDepthInstrumentation;
+import graphql.execution.instrumentation.tracing.TracingInstrumentation;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author Marcel Overdijk
+ */
+@Configuration
+@ConditionalOnProperty(value = "graphql.servlet.enabled", havingValue = "true", matchIfMissing = true)
+@EnableConfigurationProperties({GraphQLServletProperties.class})
+public class GraphQLInstrumentationAutoConfiguration {
+
+    @Value("${graphql.servlet.maxQueryComplexity:#{null}}")
+    private Integer maxQueryComplexity;
+
+    @Value("${graphql.servlet.maxQueryDepth:#{null}}")
+    private Integer maxQueryDepth;
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnProperty(value = "graphql.servlet.tracing-enabled", havingValue = "true")
+    public TracingInstrumentation tracingInstrumentation() {
+        return new TracingInstrumentation();
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnProperty(value = "graphql.servlet.max-query-complexity")
+    public MaxQueryComplexityInstrumentation maxQueryComplexityInstrumentation() {
+        return new MaxQueryComplexityInstrumentation(maxQueryComplexity);
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnProperty(value = "graphql.servlet.max-query-depth")
+    public MaxQueryDepthInstrumentation maxQueryDepthInstrumentation() {
+        return new MaxQueryDepthInstrumentation(maxQueryDepth);
+    }
+}

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLWebAutoConfiguration.java

@@ -22,6 +22,7 @@
 import graphql.execution.AsyncExecutionStrategy;
 import graphql.execution.ExecutionStrategy;
 import graphql.execution.SubscriptionExecutionStrategy;
+import graphql.execution.instrumentation.ChainedInstrumentation;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.preparsed.PreparsedDocumentProvider;
 import graphql.schema.GraphQLSchema;
@@ -91,7 +92,7 @@ public class GraphQLWebAutoConfiguration {
     private List<GraphQLServletListener> listeners;
 
     @Autowired(required = false)
-    private Instrumentation instrumentation;
+    private List<Instrumentation> instrumentations;
 
     @Autowired(required = false)
     private GraphQLErrorHandler errorHandler;
@@ -186,8 +187,13 @@ public GraphQLQueryInvoker queryInvoker(ExecutionStrategyProvider executionStrat
         GraphQLQueryInvoker.Builder builder = GraphQLQueryInvoker.newBuilder()
                 .withExecutionStrategyProvider(executionStrategyProvider);
 
-        if (instrumentation != null) {
-            builder.withInstrumentation(instrumentation);
+        if (instrumentations != null && !instrumentations.isEmpty()) {
+            if (instrumentations.size() == 1) {
+                builder.withInstrumentation(instrumentations.get(0));
+            } else {
+                Instrumentation instrumentation = new ChainedInstrumentation(instrumentations);
+                builder.withInstrumentation(instrumentation);
+            }
         }
 
         if (preparsedDocumentProvider != null) {

graphql-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -24,6 +24,21 @@
       "name": "graphql.servlet.subscriptions.websocket.path",
       "defaultValue": "/subscriptions",
       "type": "java.lang.String"
+    },
+    {
+      "name": "graphql.servlet.tracingEnabled",
+      "defaultValue": false,
+      "type": "java.lang.Boolean"
+    },
+    {
+      "name": "graphql.servlet.maxQueryComplexity",
+      "defaultValue": null,
+      "type": "java.lang.Integer"
+    },
+    {
+      "name": "graphql.servlet.maxQueryDepth",
+      "defaultValue": null,
+      "type": "java.lang.Integer"
     }
   ]
 }

graphql-spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -1,3 +1,4 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 com.oembedler.moon.graphql.boot.GraphQLWebAutoConfiguration,\
-com.oembedler.moon.graphql.boot.GraphQLJavaToolsAutoConfiguration
+com.oembedler.moon.graphql.boot.GraphQLJavaToolsAutoConfiguration,\
+com.oembedler.moon.graphql.boot.GraphQLInstrumentationAutoConfiguration

graphql-spring-boot-autoconfigure/src/test/java/com/oembedler/moon/graphql/boot/test/instrumentation/GraphQLInstrumentationAutoConfigurationTest.java

@@ -0,0 +1,75 @@
+package com.oembedler.moon.graphql.boot.test.instrumentation;
+
+import com.oembedler.moon.graphql.boot.GraphQLInstrumentationAutoConfiguration;
+import com.oembedler.moon.graphql.boot.GraphQLWebAutoConfiguration;
+import com.oembedler.moon.graphql.boot.test.AbstractAutoConfigurationTest;
+import graphql.analysis.MaxQueryComplexityInstrumentation;
+import graphql.analysis.MaxQueryDepthInstrumentation;
+import graphql.execution.AsyncExecutionStrategy;
+import graphql.execution.ExecutionStrategy;
+import graphql.execution.instrumentation.Instrumentation;
+import graphql.execution.instrumentation.tracing.TracingInstrumentation;
+import graphql.schema.GraphQLObjectType;
+import graphql.schema.GraphQLSchema;
+import graphql.servlet.AbstractGraphQLHttpServlet;
+import org.junit.Assert;
+import org.junit.Test;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
+
+/**
+ * @author Marcel Overdijk
+ */
+public class GraphQLInstrumentationAutoConfigurationTest extends AbstractAutoConfigurationTest {
+
+    public GraphQLInstrumentationAutoConfigurationTest() {
+        super(AnnotationConfigWebApplicationContext.class, GraphQLInstrumentationAutoConfiguration.class);
+    }
+
+    @Configuration
+    static class DefaultConfiguration {
+
+        @Bean
+        GraphQLSchema schema() {
+            return GraphQLSchema.newSchema().query(GraphQLObjectType.newObject().name("Query").build()).build();
+        }
+
+    }
+
+    @Test(expected = NoSuchBeanDefinitionException.class)
+    public void noDefaultInstrumentations() {
+        load(DefaultConfiguration.class);
+
+        this.getContext().getBean(Instrumentation.class);
+    }
+
+    @Test(expected = NoSuchBeanDefinitionException.class)
+    public void tracingInstrumentationDisabled() {
+        load(DefaultConfiguration.class, "graphql.servlet.tracingEnabled=false");
+
+        this.getContext().getBean(TracingInstrumentation.class);
+    }
+
+    @Test
+    public void tracingInstrumentationEnabled() {
+        load(DefaultConfiguration.class, "graphql.servlet.tracingEnabled=true");
+
+        Assert.assertNotNull(this.getContext().getBean(TracingInstrumentation.class));
+    }
+
+    @Test
+    public void maxQueryComplexityEnabled() {
+        load(DefaultConfiguration.class, "graphql.servlet.maxQueryComplexity=10");
+
+        Assert.assertNotNull(this.getContext().getBean(MaxQueryComplexityInstrumentation.class));
+    }
+
+    @Test
+    public void maxQueryDepthEnabled() {
+        load(DefaultConfiguration.class, "graphql.servlet.maxQueryDepth=10");
+
+        Assert.assertNotNull(this.getContext().getBean(MaxQueryDepthInstrumentation.class));
+    }
+}

graphql-spring-boot-autoconfigure/src/test/java/com/oembedler/moon/graphql/boot/test/web/GraphQLWebAutoConfigurationTest.java

@@ -2,8 +2,11 @@
 
 import com.oembedler.moon.graphql.boot.GraphQLWebAutoConfiguration;
 import com.oembedler.moon.graphql.boot.test.AbstractAutoConfigurationTest;
+import graphql.analysis.MaxQueryComplexityInstrumentation;
+import graphql.analysis.MaxQueryDepthInstrumentation;
 import graphql.execution.AsyncExecutionStrategy;
 import graphql.execution.ExecutionStrategy;
+import graphql.execution.instrumentation.tracing.TracingInstrumentation;
 import graphql.schema.GraphQLObjectType;
 import graphql.schema.GraphQLSchema;
 import graphql.servlet.AbstractGraphQLHttpServlet;
@@ -98,4 +101,46 @@ public void appContextLoadsWithThreeExecutionStrategies() {
 
         Assert.assertNotNull(this.getContext().getBean(AbstractGraphQLHttpServlet.class));
     }
+
+    @Configuration
+    static class OneInstrumentationConfiguration extends SimpleConfiguration {
+        @Bean
+        public TracingInstrumentation tracingInstrumentation() {
+            return new TracingInstrumentation();
+        }
+    }
+
+    @Configuration
+    static class MultipleInstrumentationsConfiguration extends OneInstrumentationConfiguration {
+        @Bean
+        public MaxQueryComplexityInstrumentation maxQueryComplexityInstrumentation() {
+            return new MaxQueryComplexityInstrumentation(10);
+        }
+
+        @Bean
+        public MaxQueryDepthInstrumentation maxQueryDepthInstrumentation() {
+            return new MaxQueryDepthInstrumentation(10);
+        }
+    }
+
+    @Test
+    public void appContextLoadsWithNoInstrumentation() {
+        load(SimpleConfiguration.class);
+
+        Assert.assertNotNull(this.getContext().getBean(AbstractGraphQLHttpServlet.class));
+    }
+
+    @Test
+    public void appContextLoadsWithOneInstrumentation() {
+        load(OneInstrumentationConfiguration.class);
+
+        Assert.assertNotNull(this.getContext().getBean(AbstractGraphQLHttpServlet.class));
+    }
+
+    @Test
+    public void appContextLoadsWithMultipleInstrumentations() {
+        load(MultipleInstrumentationsConfiguration.class);
+
+        Assert.assertNotNull(this.getContext().getBean(AbstractGraphQLHttpServlet.class));
+    }
 }