Merge pull request #301 from graphql-java-kickstart/feature/separate-graphql-tools-starter

Separate graphql tools starter

Author: oliemansm

example-graphql-tools/src/main/java/com/graphql/sample/boot/GraphQLToolsSampleApplication.java

@@ -1,7 +1,7 @@
 package com.graphql.sample.boot;
 
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
-import graphql.servlet.config.ObjectMapperConfigurer;
+import graphql.kickstart.execution.config.ObjectMapperConfigurer;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.Bean;

example-request-scoped-dataloader/src/main/java/graphql/servlet/examples/dataloader/requestscope/CustomGraphQLContextBuilder.java

@@ -1,50 +1,51 @@
 package graphql.servlet.examples.dataloader.requestscope;
 
-import graphql.servlet.context.DefaultGraphQLContext;
+import graphql.kickstart.execution.context.DefaultGraphQLContext;
+import graphql.kickstart.execution.context.GraphQLContext;
 import graphql.servlet.context.DefaultGraphQLServletContext;
 import graphql.servlet.context.DefaultGraphQLWebSocketContext;
-import graphql.servlet.context.GraphQLContext;
-import graphql.servlet.context.GraphQLContextBuilder;
-import org.dataloader.DataLoader;
-import org.dataloader.DataLoaderRegistry;
-import org.springframework.stereotype.Component;
-
+import graphql.servlet.context.GraphQLServletContextBuilder;
+import java.util.concurrent.CompletableFuture;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.websocket.Session;
 import javax.websocket.server.HandshakeRequest;
-import java.util.concurrent.CompletableFuture;
+import org.dataloader.DataLoader;
+import org.dataloader.DataLoaderRegistry;
+import org.springframework.stereotype.Component;
 
 @Component
-public class CustomGraphQLContextBuilder implements GraphQLContextBuilder {
-
-    private final CustomerRepository customerRepository;
-
-    public CustomGraphQLContextBuilder(CustomerRepository customerRepository) {
-        this.customerRepository = customerRepository;
-    }
-
-    @Override
-    public GraphQLContext build(HttpServletRequest req, HttpServletResponse response) {
-        return DefaultGraphQLServletContext.createServletContext(buildDataLoaderRegistry(), null).with(req).with(response).build();
-    }
-
-    @Override
-    public GraphQLContext build() {
-        return new DefaultGraphQLContext(buildDataLoaderRegistry(), null);
-    }
-
-    @Override
-    public GraphQLContext build(Session session, HandshakeRequest request) {
-        return DefaultGraphQLWebSocketContext.createWebSocketContext(buildDataLoaderRegistry(), null).with(session).with(request).build();
-    }
-
-    private DataLoaderRegistry buildDataLoaderRegistry() {
-        DataLoaderRegistry dataLoaderRegistry = new DataLoaderRegistry();
-        dataLoaderRegistry.register("customerDataLoader",
-                new DataLoader<Integer, String>(customerIds ->
-                        CompletableFuture.supplyAsync(() ->
-                                customerRepository.getUserNamesForIds(customerIds))));
-        return dataLoaderRegistry;
-    }
+public class CustomGraphQLContextBuilder implements GraphQLServletContextBuilder {
+
+  private final CustomerRepository customerRepository;
+
+  public CustomGraphQLContextBuilder(CustomerRepository customerRepository) {
+    this.customerRepository = customerRepository;
+  }
+
+  @Override
+  public GraphQLContext build(HttpServletRequest req, HttpServletResponse response) {
+    return DefaultGraphQLServletContext.createServletContext(buildDataLoaderRegistry(), null).with(req).with(response)
+        .build();
+  }
+
+  @Override
+  public GraphQLContext build() {
+    return new DefaultGraphQLContext(buildDataLoaderRegistry(), null);
+  }
+
+  @Override
+  public GraphQLContext build(Session session, HandshakeRequest request) {
+    return DefaultGraphQLWebSocketContext.createWebSocketContext(buildDataLoaderRegistry(), null).with(session)
+        .with(request).build();
+  }
+
+  private DataLoaderRegistry buildDataLoaderRegistry() {
+    DataLoaderRegistry dataLoaderRegistry = new DataLoaderRegistry();
+    dataLoaderRegistry.register("customerDataLoader",
+        new DataLoader<Integer, String>(customerIds ->
+            CompletableFuture.supplyAsync(() ->
+                customerRepository.getUserNamesForIds(customerIds))));
+    return dataLoaderRegistry;
+  }
 }

example-request-scoped-dataloader/src/main/java/graphql/servlet/examples/dataloader/requestscope/CustomerResolver.java

@@ -1,21 +1,21 @@
 package graphql.servlet.examples.dataloader.requestscope;
 
 import com.coxautodev.graphql.tools.GraphQLResolver;
+import graphql.kickstart.execution.context.GraphQLContext;
 import graphql.schema.DataFetchingEnvironment;
-import graphql.servlet.context.GraphQLContext;
+import java.util.concurrent.CompletableFuture;
 import org.dataloader.DataLoader;
 import org.springframework.stereotype.Component;
 
-import java.util.concurrent.CompletableFuture;
-
 @Component
 public class CustomerResolver implements GraphQLResolver<Customer> {
 
-    public CompletableFuture<String> getName(Customer customer, DataFetchingEnvironment dfe) {
-        final DataLoader<Integer, String> dataloader = ((GraphQLContext) dfe.getContext())
-                .getDataLoaderRegistry().get()
-                .getDataLoader("customerDataLoader");
+  public CompletableFuture<String> getName(Customer customer, DataFetchingEnvironment dfe) {
+    final DataLoader<Integer, String> dataloader = ((GraphQLContext) dfe.getContext())
+        .getDataLoaderRegistry().get()
+        .getDataLoader("customerDataLoader");
+
+    return dataloader.load(customer.getCustomerId());
+  }
 
-        return dataloader.load(customer.getCustomerId());
-    }
 }

gradle.properties

@@ -17,7 +17,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-version = 5.11.1
+version = 6.0.0
 
 PROJECT_GROUP = com.graphql-java-kickstart
 PROJECT_NAME = graphql-spring-boot
@@ -39,13 +39,11 @@ TARGET_COMPATIBILITY = 1.8
 
 LIB_GRAPHQL_JAVA_VER = 13.0
 LIB_JUNIT_VER = 4.12
-LIB_SPRING_CORE_VER = 5.0.4.RELEASE
-LIB_SPRING_BOOT_VER = 2.1.6.RELEASE
-LIB_GRAPHQL_SERVLET_VER = 8.0.0
+LIB_SPRING_CORE_VER = 5.2.1.RELEASE
+LIB_SPRING_BOOT_VER = 2.2.1.RELEASE
+LIB_GRAPHQL_SERVLET_VER = 9.0.0
 LIB_GRAPHQL_JAVA_TOOLS_VER = 5.7.1
 LIB_COMMONS_IO_VER = 2.6
-LIB_TRANSACTIONS_API_VERSION=1.3
-LIB_INTERCEPTOR_API_VERSION=1.2.2
 kotlin.version=1.3.31
 
 GRADLE_WRAPPER_VER = 4.10.3

graphql-kickstart-spring-boot-autoconfigure-tools/build.gradle

@@ -0,0 +1,17 @@
+dependencies {
+    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor:$LIB_SPRING_BOOT_VER"
+    compileOnly "org.springframework.boot:spring-boot-configuration-processor:$LIB_SPRING_BOOT_VER"
+
+    compile "com.graphql-java-kickstart:graphql-java-tools:$LIB_GRAPHQL_JAVA_TOOLS_VER"
+    compile "org.springframework.boot:spring-boot-autoconfigure:$LIB_SPRING_BOOT_VER"
+
+    compileOnly "com.graphql-java-kickstart:graphql-java-servlet:$LIB_GRAPHQL_SERVLET_VER"
+
+    testCompile "com.graphql-java-kickstart:graphql-java-servlet:$LIB_GRAPHQL_SERVLET_VER"
+    testCompile "com.graphql-java:graphql-java:$LIB_GRAPHQL_JAVA_VER"
+    testCompile "org.springframework.boot:spring-boot-starter-web:$LIB_SPRING_BOOT_VER"
+    testCompile "org.springframework.boot:spring-boot-starter-test:$LIB_SPRING_BOOT_VER"
+    testCompile(project(":graphql-spring-boot-test"))
+}
+
+compileJava.dependsOn(processResources)

graphql-kickstart-spring-boot-autoconfigure-tools/src/main/java/graphql/kickstart/tools/boot/ClasspathResourceSchemaStringProvider.java

@@ -0,0 +1,54 @@
+package graphql.kickstart.tools.boot;
+
+import static java.util.stream.Collectors.joining;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.core.io.Resource;
+
+public class ClasspathResourceSchemaStringProvider implements SchemaStringProvider {
+
+  @Autowired
+  private ApplicationContext applicationContext;
+  private String schemaLocationPattern;
+
+  public ClasspathResourceSchemaStringProvider(String schemaLocationPattern) {
+    this.schemaLocationPattern = schemaLocationPattern;
+  }
+
+  @Override
+  public List<String> schemaStrings() throws IOException {
+    Resource[] resources = applicationContext.getResources("classpath*:" + schemaLocationPattern);
+    if (resources.length <= 0) {
+      throw new IllegalStateException(
+          "No graphql schema files found on classpath with location pattern '"
+              + schemaLocationPattern
+              + "'.  Please add a graphql schema to the classpath or add a SchemaParser bean to your application context.");
+    }
+
+    return Arrays.stream(resources)
+        .map(this::readSchema)
+        .collect(Collectors.toList());
+  }
+
+  private String readSchema(Resource resource) {
+    try (
+        InputStream inputStream = resource.getInputStream();
+        InputStreamReader bufferedInputStream = new InputStreamReader(inputStream, StandardCharsets.UTF_8.name());
+        BufferedReader reader = new BufferedReader(bufferedInputStream)
+    ) {
+      return reader.lines().collect(joining("\n"));
+    } catch (IOException e) {
+      throw new IllegalStateException("Cannot read graphql schema from resource " + resource, e);
+    }
+  }
+
+}

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLJavaToolsAutoConfiguration.java renamed to graphql-kickstart-spring-boot-autoconfigure-tools/src/main/java/graphql/kickstart/tools/boot/GraphQLJavaToolsAutoConfiguration.java

@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package graphql.kickstart.tools.boot;
 
 import com.coxautodev.graphql.tools.GraphQLResolver;
 import com.coxautodev.graphql.tools.PerFieldObjectMapperProvider;
@@ -10,12 +10,13 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import com.fasterxml.jackson.module.kotlin.KotlinModule;
+import graphql.kickstart.execution.config.GraphQLSchemaProvider;
 import graphql.schema.GraphQLScalarType;
 import graphql.schema.GraphQLSchema;
 import graphql.schema.idl.SchemaDirectiveWiring;
-import graphql.servlet.config.GraphQLSchemaProvider;
 import java.io.IOException;
 import java.util.List;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -31,6 +32,7 @@
 /**
  * @author Andrew Potter
  */
+@Slf4j
 @Configuration
 @ConditionalOnClass(SchemaParser.class)
 @AutoConfigureAfter({JacksonAutoConfiguration.class})

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLToolsProperties.java renamed to graphql-kickstart-spring-boot-autoconfigure-tools/src/main/java/graphql/kickstart/tools/boot/GraphQLToolsProperties.java

@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package graphql.kickstart.tools.boot;
 
 import lombok.Data;
 import org.springframework.boot.context.properties.ConfigurationProperties;

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/ListSchemaStringProvider.java renamed to graphql-kickstart-spring-boot-autoconfigure-tools/src/main/java/graphql/kickstart/tools/boot/ListSchemaStringProvider.java

@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package graphql.kickstart.tools.boot;
 
 import java.io.IOException;
 import java.util.ArrayList;

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/SchemaDirective.java renamed to graphql-kickstart-spring-boot-autoconfigure-tools/src/main/java/graphql/kickstart/tools/boot/SchemaDirective.java

@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package graphql.kickstart.tools.boot;
 
 import graphql.schema.idl.SchemaDirectiveWiring;
 

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/SchemaStringProvider.java renamed to graphql-kickstart-spring-boot-autoconfigure-tools/src/main/java/graphql/kickstart/tools/boot/SchemaStringProvider.java

@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package graphql.kickstart.tools.boot;
 
 import java.io.IOException;
 import java.util.List;

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

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+graphql.kickstart.tools.boot.GraphQLJavaToolsAutoConfiguration

graphql-kickstart-spring-boot-autoconfigure-tools/src/test/java/graphql/kickstart/tools/boot/AbstractAutoConfigurationTest.java

@@ -0,0 +1,80 @@
+package graphql.kickstart.tools.boot;
+
+import static org.mockito.Mockito.mock;
+
+import javax.servlet.ServletContext;
+import javax.websocket.server.ServerContainer;
+import org.junit.After;
+import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
+import org.springframework.boot.test.util.TestPropertyValues;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.AnnotationConfigRegistry;
+import org.springframework.context.support.AbstractApplicationContext;
+import org.springframework.mock.web.MockServletContext;
+import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
+
+/**
+ * @author Andrew Potter
+ */
+public abstract class AbstractAutoConfigurationTest {
+
+  private final Class<? extends AbstractApplicationContext> contextClass;
+  private final Class<?> autoConfiguration;
+
+  private AbstractApplicationContext context;
+
+  protected AbstractAutoConfigurationTest(Class<?> autoConfiguration) {
+    this(AnnotationConfigApplicationContext.class, autoConfiguration);
+  }
+
+  protected AbstractAutoConfigurationTest(Class<? extends AbstractApplicationContext> contextClass,
+      Class<?> autoConfiguration) {
+    assert AnnotationConfigRegistry.class.isAssignableFrom(contextClass);
+    this.contextClass = contextClass;
+    this.autoConfiguration = autoConfiguration;
+  }
+
+  @After
+  public void tearDown() {
+    if (this.context != null) {
+      this.context.close();
+      this.context = null;
+    }
+  }
+
+  protected void load(Class<?> config, String... environment) {
+    try {
+      this.context = contextClass.newInstance();
+    } catch (InstantiationException | IllegalAccessException e) {
+      throw new RuntimeException("Failed to instantiate testing context", e);
+    }
+
+    if (environment != null && environment.length > 0) {
+      TestPropertyValues.of(environment).applyTo(context);
+    }
+
+    getRegistry().register(config);
+    getRegistry().register(autoConfiguration);
+    getRegistry().register(JacksonAutoConfiguration.class);
+
+    loadServletContext();
+    getContext().refresh();
+  }
+
+  private void loadServletContext() {
+    if (context instanceof AnnotationConfigWebApplicationContext) {
+      ServerContainer serverContainer = mock(ServerContainer.class);
+      ServletContext servletContext = new MockServletContext();
+      servletContext.setAttribute("javax.websocket.server.ServerContainer", serverContainer);
+      ((AnnotationConfigWebApplicationContext) context).setServletContext(servletContext);
+    }
+  }
+
+  public AnnotationConfigRegistry getRegistry() {
+    return (AnnotationConfigRegistry) context;
+  }
+
+  public AbstractApplicationContext getContext() {
+    return context;
+  }
+}