Merge pull request #160 from graphql-java-kickstart/bugfix/157-graphql-tools-props

oliemansm · web-flow · commit 0923ca11ad3b · 2018-11-17T16:39:47.000+01:00
Added ConfigurationProperties for graphql-tools props (fix #157)
diff --git a/README.md b/README.md
@@ -166,34 +166,15 @@ Available Spring Boot configuration parameters (either `application.yml` or `app
 ```yaml
 graphql:
     tools:
-        schemaLocationPattern: "**/*.graphqls"
+        schema-location-pattern: "**/*.graphqls"
         # Enable or disable the introspection query. Disabling it puts your server in contravention of the GraphQL
         # specification and expectations of most clients, so use this option with caution
-        introspectionEnabled: true
+        introspection-enabled: true
 ```
 By default GraphQL tools uses the location pattern `**/*.graphqls` to scan for GraphQL schemas on the classpath.
 Use the `schemaLocationPattern` property to customize this pattern.
 
 
-## GraphQL Spring Common [LATEST SUPPORTED VERSION: 3.1.1]
-**https://github.com/oembedler/spring-graphql-common**
-
-See the [Readme](https://github.com/oembedler/spring-graphql-common#usage) and the [example](https://github.com/graphql-java-kickstart/graphql-spring-boot/tree/master/example-spring-common) for usage instructions.
-
-#### Application Properties
-```yaml
-graphql:
-      spring-graphql-common:
-               clientMutationIdName: clientMutationId
-               injectClientMutationId: true
-               allowEmptyClientMutationId: false
-               mutationInputArgumentName: input
-               outputObjectNamePrefix: Payload
-               inputObjectNamePrefix: Input
-               schemaMutationObjectName: Mutation
-```
-
-
 # Contributions
 
 Contributions are welcome.  Please respect the [Code of Conduct](http://contributor-covenant.org/version/1/3/0/).
@@ -203,8 +184,6 @@ Contributions are welcome.  Please respect the [Code of Conduct](http://contribu
 
 `graphql-spring-boot-starter` and `graphiql-spring-boot-starter` are licensed under the MIT License. See [LICENSE](LICENSE.md) for details.
 
-[spring-graphql-common License](https://github.com/oembedler/spring-graphql-common/blob/master/LICENSE.md)
-
 [graphql-java License](https://github.com/andimarek/graphql-java/blob/master/LICENSE.md)
 
 [graphiql License](https://github.com/graphql/graphiql/blob/master/LICENSE)
diff --git a/build.gradle b/build.gradle
@@ -34,6 +34,7 @@ buildscript {
 
 plugins {
     id 'net.researchgate.release' version '2.7.0'
+    id 'io.franzbecker.gradle-lombok' version '1.14' apply false
 }
 
 subprojects {
@@ -42,6 +43,7 @@ subprojects {
     apply plugin: 'maven'
     apply plugin: 'maven-publish'
     apply plugin: "com.jfrog.bintray"
+    apply plugin: 'io.franzbecker.gradle-lombok'
 
     group = PROJECT_GROUP
 
@@ -65,6 +67,14 @@ subprojects {
         targetCompatibility = TARGET_COMPATIBILITY
     }
 
+    compileJava.dependsOn(processResources)
+    
+    lombok {
+        version = "1.18.4"
+        sha256 = ""
+    }
+
+
     if (!it.name.startsWith('example')) {
 
         jar {
diff --git a/example-graphql-tools/src/main/java/com/graphql/sample/boot/Comment.java b/example-graphql-tools/src/main/java/com/graphql/sample/boot/Comment.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot.resolvers;
+package com.graphql.sample.boot;
 
 class Comment {
 
diff --git a/example-graphql-tools/src/main/java/com/graphql/sample/boot/GraphQLToolsSampleApplication.java b/example-graphql-tools/src/main/java/com/graphql/sample/boot/GraphQLToolsSampleApplication.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package com.graphql.sample.boot;
 
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import graphql.servlet.ObjectMapperConfigurer;
diff --git a/example-graphql-tools/src/main/java/com/graphql/sample/boot/Mutation.java b/example-graphql-tools/src/main/java/com/graphql/sample/boot/Mutation.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot.resolvers;
+package com.graphql.sample.boot;
 
 import com.coxautodev.graphql.tools.GraphQLMutationResolver;
 import java.util.Random;
diff --git a/example-graphql-tools/src/main/java/com/graphql/sample/boot/Post.java b/example-graphql-tools/src/main/java/com/graphql/sample/boot/Post.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot.resolvers;
+package com.graphql.sample.boot;
 
 public class Post {
 
diff --git a/example-graphql-tools/src/main/java/com/graphql/sample/boot/PostResolver.java b/example-graphql-tools/src/main/java/com/graphql/sample/boot/PostResolver.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot.resolvers;
+package com.graphql.sample.boot;
 
 import com.coxautodev.graphql.tools.GraphQLResolver;
 import org.springframework.stereotype.Component;
diff --git a/example-graphql-tools/src/main/java/com/graphql/sample/boot/Query.java b/example-graphql-tools/src/main/java/com/graphql/sample/boot/Query.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot.resolvers;
+package com.graphql.sample.boot;
 
 import com.coxautodev.graphql.tools.GraphQLQueryResolver;
 import org.springframework.stereotype.Component;
diff --git a/example-graphql-tools/src/test/java/com/graphql/sample/boot/GraphQLServletTest.kt b/example-graphql-tools/src/test/java/com/graphql/sample/boot/GraphQLServletTest.kt
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot
+package com.graphql.sample.boot
 
 
 import com.graphql.spring.boot.test.GraphQLTestTemplate
diff --git a/example-graphql-tools/src/test/java/com/graphql/sample/boot/GraphQLToolsSampleApplicationTest.java b/example-graphql-tools/src/test/java/com/graphql/sample/boot/GraphQLToolsSampleApplicationTest.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package com.graphql.sample.boot;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
diff --git a/example-graphql-tools/src/test/java/com/graphql/sample/boot/SpringBootTestWithoutWebEnvironmentTest.java b/example-graphql-tools/src/test/java/com/graphql/sample/boot/SpringBootTestWithoutWebEnvironmentTest.java
@@ -1,4 +1,4 @@
-package com.oembedler.moon.graphql.boot;
+package com.graphql.sample.boot;
 
 import org.junit.Ignore;
 import org.junit.Test;
diff --git a/gradle.properties b/gradle.properties
@@ -41,10 +41,10 @@ LIB_JUNIT_VER = 4.12
 LIB_SPRING_CORE_VER = 5.0.4.RELEASE
 LIB_SPRING_BOOT_VER = 2.0.5.RELEASE
 LIB_GRAPHQL_SERVLET_VER = 7.0.0
-LIB_GRAPHQL_JAVA_TOOLS_VER = 5.3.5
+LIB_GRAPHQL_JAVA_TOOLS_VER = 5.4.0
 LIB_COMMONS_IO_VER = 2.6
 
-GRADLE_WRAPPER_VER = 4.7
+GRADLE_WRAPPER_VER = 4.10.2
 
 ###
 
diff --git a/graphql-spring-boot-autoconfigure/build.gradle b/graphql-spring-boot-autoconfigure/build.gradle
@@ -18,7 +18,7 @@
  */
 
 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 "org.springframework.boot:spring-boot-autoconfigure:$LIB_SPRING_BOOT_VER"
     compile "org.springframework.boot:spring-boot-starter-websocket:$LIB_SPRING_BOOT_VER"
diff --git a/graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/ClasspathResourceSchemaStringProvider.java b/graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/ClasspathResourceSchemaStringProvider.java
@@ -2,7 +2,6 @@
 
 import org.apache.commons.io.IOUtils;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.ApplicationContext;
 import org.springframework.core.io.Resource;
 
@@ -16,34 +15,37 @@
 
 public class ClasspathResourceSchemaStringProvider implements SchemaStringProvider {
 
-  @Autowired
-  private ApplicationContext applicationContext;
-  @Value("${graphql.tools.schemaLocationPattern:**/*.graphqls}")
-  private String 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.");
+    @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());
     }
 
-    return Arrays.stream(resources)
-        .map(this::readSchema)
-        .collect(Collectors.toList());
-  }
-
-  private String readSchema(Resource resource) {
-    StringWriter writer = new StringWriter();
-    try (InputStream inputStream = resource.getInputStream()) {
-      IOUtils.copy(inputStream, writer, StandardCharsets.UTF_8);
-    } catch (IOException e) {
-      throw new IllegalStateException("Cannot read graphql schema from resource " + resource, e);
+    private String readSchema(Resource resource) {
+        StringWriter writer = new StringWriter();
+        try (InputStream inputStream = resource.getInputStream()) {
+            IOUtils.copy(inputStream, writer, StandardCharsets.UTF_8);
+        } catch (IOException e) {
+            throw new IllegalStateException("Cannot read graphql schema from resource " + resource, e);
+        }
+        return writer.toString();
     }
-    return writer.toString();
-  }
 
 }
diff --git a/graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLJavaToolsAutoConfiguration.java b/graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLJavaToolsAutoConfiguration.java
@@ -8,13 +8,13 @@
 import graphql.schema.GraphQLSchema;
 import graphql.servlet.GraphQLSchemaProvider;
 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.jackson.JacksonAutoConfiguration;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -29,6 +29,7 @@
 @Configuration
 @ConditionalOnClass(SchemaParser.class)
 @AutoConfigureAfter({JacksonAutoConfiguration.class})
+@EnableConfigurationProperties(GraphQLToolsProperties.class)
 public class GraphQLJavaToolsAutoConfiguration {
 
     @Autowired(required = false)
@@ -40,13 +41,13 @@ public class GraphQLJavaToolsAutoConfiguration {
     @Autowired(required = false)
     private SchemaParserOptions options;
 
-    @Value("${graphql.tools.introspectionEnabled:true}")
-    private boolean introspectionEnabled;
+    @Autowired
+    private GraphQLToolsProperties props;
 
     @Bean
     @ConditionalOnMissingBean
     public SchemaStringProvider schemaStringProvider() {
-        return new ClasspathResourceSchemaStringProvider();
+        return new ClasspathResourceSchemaStringProvider(props.getSchemaLocationPattern());
     }
 
     @Bean
@@ -71,7 +72,7 @@ public SchemaParser schemaParser(
         } else if (perFieldObjectMapperProvider != null) {
             final SchemaParserOptions.Builder optionsBuilder =
                     newOptions().objectMapperProvider(perFieldObjectMapperProvider);
-            optionsBuilder.introspectionEnabled(introspectionEnabled);
+            optionsBuilder.introspectionEnabled(props.isIntrospectionEnabled());
             builder.options(optionsBuilder.build());
         }
 
diff --git a/graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLToolsProperties.java b/graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLToolsProperties.java
@@ -0,0 +1,16 @@
+package com.oembedler.moon.graphql.boot;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+
+@Data
+@Configuration
+@ConfigurationProperties(prefix = "graphql.tools")
+class GraphQLToolsProperties {
+
+    private String schemaLocationPattern = "**/*.graphqls";
+    private boolean introspectionEnabled = true;
+    private boolean useDefaultObjectmapper = true;
+
+}
diff --git a/graphql-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/graphql-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -44,16 +44,6 @@
       "name": "graphql.servlet.maxQueryDepth",
       "defaultValue": null,
       "type": "java.lang.Integer"
-    },
-    {
-      "name": "graphql.tools.schemaLocationPattern",
-      "defaultValue": "**/*.graphqls",
-      "type": "java.lang.String"
-    },
-    {
-      "name": "graphql.tools.introspectionEnabled",
-      "defaultValue": true,
-      "type": "java.lang.Boolean"
     }
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.oembedler.moon.graphql.boot.resolvers;`
	`1`	`+package com.graphql.sample.boot;`
`2`	`2`
`3`	`3`	`class Comment {`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.oembedler.moon.graphql.boot`
	`1`	`+package com.graphql.sample.boot`
`2`	`2`
`3`	`3`
`4`	`4`	`import com.graphql.spring.boot.test.GraphQLTestTemplate`