Merge pull request #114 from graphql-java/servercontainer-issue

Split autoconfiguration of websocket in separate class

Author: oliemansm

README.md

@@ -42,7 +42,7 @@ repositories {
 
 dependencies {
   compile 'com.graphql-java:graphql-spring-boot-starter:5.0.2'
-
+  
   // to embed GraphiQL tool
   compile 'com.graphql-java:graphiql-spring-boot-starter:5.0.2'
 

gradle.properties

@@ -17,7 +17,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-PROJECT_VERSION = 5.0.2
+PROJECT_VERSION = 5.0.3
 PROJECT_GROUP = com.graphql-java
 PROJECT_NAME = graphql-spring-boot
 PROJECT_DESC = GraphQL Spring Framework Boot

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

@@ -26,29 +26,11 @@
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.preparsed.PreparsedDocumentProvider;
 import graphql.schema.GraphQLSchema;
-import graphql.servlet.AbstractGraphQLHttpServlet;
-import graphql.servlet.DefaultExecutionStrategyProvider;
-import graphql.servlet.DefaultGraphQLSchemaProvider;
-import graphql.servlet.ExecutionStrategyProvider;
-import graphql.servlet.GraphQLContextBuilder;
-import graphql.servlet.GraphQLErrorHandler;
-import graphql.servlet.GraphQLInvocationInputFactory;
-import graphql.servlet.GraphQLObjectMapper;
-import graphql.servlet.GraphQLQueryInvoker;
-import graphql.servlet.GraphQLRootObjectBuilder;
-import graphql.servlet.GraphQLSchemaProvider;
-import graphql.servlet.GraphQLServletListener;
-import graphql.servlet.GraphQLWebsocketServlet;
-import graphql.servlet.ObjectMapperConfigurer;
-import graphql.servlet.SimpleGraphQLHttpServlet;
+import graphql.servlet.*;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.boot.autoconfigure.condition.*;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.web.servlet.ServletRegistrationBean;
 import org.springframework.context.annotation.Bean;
@@ -57,8 +39,6 @@
 import org.springframework.web.filter.CorsFilter;
 import org.springframework.web.servlet.DispatcherServlet;
 import org.springframework.web.servlet.config.annotation.CorsRegistryWorkaround;
-import org.springframework.web.socket.server.standard.ServerEndpointExporter;
-import org.springframework.web.socket.server.standard.ServerEndpointRegistration;
 
 import javax.servlet.MultipartConfigElement;
 import java.util.List;
@@ -85,9 +65,6 @@ public class GraphQLWebAutoConfiguration {
     @Autowired
     private GraphQLServletProperties graphQLServletProperties;
 
-    @Value("${graphql.servlet.subscriptions.websocket.path:/subscriptions}")
-    private String websocketPath;
-
     @Autowired(required = false)
     private List<GraphQLServletListener> listeners;
 
@@ -236,23 +213,6 @@ public ServletRegistrationBean<AbstractGraphQLHttpServlet> graphQLServletRegistr
         return registration;
     }
 
-    @Bean
-    @ConditionalOnMissingBean
-    public GraphQLWebsocketServlet graphQLWebsocketServlet(GraphQLInvocationInputFactory invocationInputFactory, GraphQLQueryInvoker queryInvoker, GraphQLObjectMapper graphQLObjectMapper) {
-        return new GraphQLWebsocketServlet(queryInvoker, invocationInputFactory, graphQLObjectMapper);
-    }
-
-    @Bean
-    public ServerEndpointRegistration serverEndpointRegistration(GraphQLWebsocketServlet servlet) {
-        return new GraphQLWsServerEndpointRegistration(websocketPath, servlet);
-    }
-
-    @Bean
-    @ConditionalOnMissingBean
-    public ServerEndpointExporter serverEndpointExporter() {
-        return new ServerEndpointExporter();
-    }
-
     private MultipartConfigElement multipartConfigElement() {
         return Optional.ofNullable(multipartConfigElement).orElse(new MultipartConfigElement(""));
     }

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

@@ -0,0 +1,49 @@
+package com.oembedler.moon.graphql.boot;
+
+import graphql.schema.GraphQLSchema;
+import graphql.servlet.GraphQLInvocationInputFactory;
+import graphql.servlet.GraphQLObjectMapper;
+import graphql.servlet.GraphQLQueryInvoker;
+import graphql.servlet.GraphQLWebsocketServlet;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.condition.*;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.DispatcherServlet;
+import org.springframework.web.socket.server.standard.ServerEndpointExporter;
+import org.springframework.web.socket.server.standard.ServerEndpointRegistration;
+
+import javax.websocket.server.ServerContainer;
+
+@Configuration
+@ConditionalOnWebApplication
+@ConditionalOnClass(DispatcherServlet.class)
+@ConditionalOnBean({GraphQLSchema.class})
+@ConditionalOnProperty(value = "graphql.servlet.websocket.enabled", havingValue = "true", matchIfMissing = true)
+@AutoConfigureAfter({GraphQLJavaToolsAutoConfiguration.class})
+public class GraphQLWebsocketAutoConfiguration {
+
+    @Value("${graphql.servlet.subscriptions.websocket.path:/subscriptions}")
+    private String websocketPath;
+
+    @Bean
+    @ConditionalOnMissingBean
+    public GraphQLWebsocketServlet graphQLWebsocketServlet(GraphQLInvocationInputFactory invocationInputFactory, GraphQLQueryInvoker queryInvoker, GraphQLObjectMapper graphQLObjectMapper) {
+        return new GraphQLWebsocketServlet(queryInvoker, invocationInputFactory, graphQLObjectMapper);
+    }
+
+    @Bean
+    @ConditionalOnClass(ServerContainer.class)
+    public ServerEndpointRegistration serverEndpointRegistration(GraphQLWebsocketServlet servlet) {
+        return new GraphQLWsServerEndpointRegistration(websocketPath, servlet);
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnClass(ServerContainer.class)
+    public ServerEndpointExporter serverEndpointExporter() {
+        return new ServerEndpointExporter();
+    }
+
+}

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

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

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

@@ -0,0 +1,26 @@
+package com.oembedler.moon.graphql.boot;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static graphql.Assert.assertNotNull;
+import static org.junit.Assert.assertEquals;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest(properties = {"graphql.servlet.mapping=/test"})
+public class GraphQLServletPropertiesTest {
+
+    @Autowired
+    private GraphQLServletProperties properties;
+
+    @Test
+    public void contains_custom_servlet_endpoint() {
+        String mapping = properties.getMapping();
+        assertNotNull(mapping);
+        assertEquals("/test", mapping);
+    }
+
+}

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

@@ -0,0 +1,13 @@
+package com.oembedler.moon.graphql.boot;
+
+import org.springframework.boot.SpringBootConfiguration;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Import;
+
+@SpringBootConfiguration
+@Import(GraphQLServletProperties.class)
+@EnableConfigurationProperties
+public class TestAutoConfiguration {
+
+
+}

graphql-spring-boot-autoconfigure/src/test/resources/application.yml

@@ -0,0 +1 @@
+graphql.servlet.mapping: /test