Fix GraphQL query serialization and add Gradle plugin for client-codegen #37 (#59)

* Introduce codegen for client code - Part 1. #37

* Remove redundant null-checks

* Minor fixes in Request class generation + improve code coverage. #37

* Customizable suffix of ResponseProjection classes. #37

* Code coverage for MappingConfig #37

* Fix method names #37 #53

* Add codegen properties to GraphqlCodegenGradleTask #37

* Rename example module to example-server #37

* Change example-server project for gradle plugin #37

* Add GraphQLResult class which holds response data+errors #37

* Fix GraphQLRequestSerializer #37

* Add example-client project for gradle plugin #37

* Add example-client project to CI and README.md #37

* Code coverage for GraphQLResult #37

* Downgrade all dependencies level to 'implementation' #37

* Fix GraphQL query characters escape + fix errors serialization #37

* Fix GraphQL request serialization #37

* Fix toString() generation for request input classes #37

* Remove redundant apache-commons dependency #37

* Use jackson lib to construct GraphQL query json #37

Author: kobylynskyi

.circleci/config.yml

@@ -96,8 +96,11 @@ jobs:
           name: Build plugin and run unit tests
           command: cd ~/repo/plugins/gradle/graphql-java-codegen-gradle-plugin && gradle build publishToMavenLocal
       - run:
-          name: Build example plugin project
-          command: cd ~/repo/plugins/gradle/example && gradle test
+          name: Build example-server plugin project
+          command: cd ~/repo/plugins/gradle/example-server && gradle test
+      - run:
+          name: Build example-client plugin project
+          command: cd ~/repo/plugins/gradle/example-client && gradle test
 workflows:
   build-library-and-plugins:
     jobs:

CONTRIBUTING.md

@@ -50,4 +50,4 @@ Please follow the steps below in order to make the changes:
    mvn clean install 
    ```
 
-7. Make sure that `example` project is compiling and running.
+7. Make sure that `example` projects are compiling and running.

build.gradle

@@ -17,11 +17,11 @@ repositories {
 }
 
 dependencies {
-    compile "org.freemarker:freemarker:2.3.28"
-    compile "com.graphql-java:graphql-java:13.0"
-    compile "com.google.code.gson:gson:2.8.6"
+    implementation "org.freemarker:freemarker:2.3.28"
+    implementation "com.graphql-java:graphql-java:13.0"
+    implementation "com.fasterxml.jackson.core:jackson-databind:2.9.9"
 
-    compileOnly "org.projectlombok:lombok:1.18.8"
+    implementation "org.projectlombok:lombok:1.18.8"
     annotationProcessor "org.projectlombok:lombok:1.18.8"
 
     testImplementation "org.junit.jupiter:junit-jupiter-api:5.5.1"

plugins/gradle/README.md

@@ -171,7 +171,8 @@ Access to classes from your code as normal Kotlin classes.
 
 ### Example
 
-[example](example)
+* GraphQL server code generation: [example-server](example-server)
+* GraphQL client code generation: [example-client](example-client)
 
 
 ### Inspired by

plugins/gradle/example-client/build.gradle

@@ -0,0 +1,70 @@
+import io.github.kobylynskyi.graphql.codegen.gradle.GraphqlCodegenGradleTask
+
+plugins {
+    id "java"
+    id "idea"
+    id "application"
+    id "net.ltgt.apt" version "0.20"
+    id "io.github.kobylynskyi.graphql.codegen" version "1.6.0-SNAPSHOT"
+}
+
+mainClassName = "io.github.kobylynskyi.bikeshop.Application"
+
+dependencies {
+    compile "org.springframework.boot:spring-boot-starter-web:2.1.7.RELEASE"
+    compile "org.springframework.boot:spring-boot-starter-data-mongodb:2.1.7.RELEASE"
+    compile "org.springframework.data:spring-data-commons:2.1.10.RELEASE"
+
+    compile "com.graphql-java-kickstart:graphql-java-tools:5.6.1"
+    compile "com.graphql-java-kickstart:graphql-spring-boot-starter:5.10.0"
+    compile "com.graphql-java-kickstart:graphiql-spring-boot-starter:5.10.0"
+
+    compile "io.github.kobylynskyi:graphql-java-codegen:1.6.0-SNAPSHOT"
+
+    compile "org.apache.httpcomponents:httpclient:4.5.12"
+
+    implementation "org.mapstruct:mapstruct:1.3.0.Final"
+    annotationProcessor "org.mapstruct:mapstruct-processor:1.3.0.Final"
+
+    compileOnly "org.projectlombok:lombok:1.18.8"
+    annotationProcessor "org.projectlombok:lombok:1.18.8"
+}
+
+/**
+ * Generate requests and model from external service
+ */
+compileJava.dependsOn "graphqlCodegenProductService"
+sourceSets.main.java.srcDirs "$buildDir/generated-client"
+task graphqlCodegenProductService(type: GraphqlCodegenGradleTask) {
+    graphqlSchemaPaths = ["$projectDir/src/main/resources/external/schema-product-service.graphqls".toString()]
+    outputDir = new File("$buildDir/generated-client")
+    modelPackageName = "io.github.kobylynskyi.product.graphql.model"
+    customTypesMapping = [
+            DateTime: "java.util.Date"
+    ]
+    modelNameSuffix = "TO"
+    generateRequests = true
+    generateApis = false
+}
+
+/**
+ * Generate apis and model
+ */
+compileJava.dependsOn "graphqlCodegenOrderService"
+sourceSets.main.java.srcDirs "$buildDir/generated-server"
+task graphqlCodegenOrderService(type: GraphqlCodegenGradleTask) {
+    graphqlSchemaPaths = ["$projectDir/src/main/resources/schema.graphqls".toString()]
+    outputDir = new File("$buildDir/generated-server")
+    apiPackageName = "io.github.kobylynskyi.order.graphql.api"
+    modelPackageName = "io.github.kobylynskyi.order.graphql.model"
+    customTypesMapping = [
+            DateTime: "java.util.Date"
+    ]
+    modelNameSuffix = "TO"
+}
+
+repositories {
+    jcenter()
+    mavenCentral()
+    mavenLocal()
+}

plugins/gradle/example/settings.gradle …ns/gradle/example-client/settings.gradleplugins/gradle/example/settings.gradle renamed to plugins/gradle/example-client/settings.gradle plugins/gradle/example/settings.gradle renamed to plugins/gradle/example-client/settings.gradle

@@ -5,4 +5,4 @@ pluginManagement {
     }
 }
 
-rootProject.name = "example"
+rootProject.name = "example-client"

…ub/kobylynskyi/bikeshop/Application.java …ithub/kobylynskyi/order/Application.javaplugins/gradle/example/src/main/java/io/github/kobylynskyi/bikeshop/Application.java renamed to plugins/gradle/example-client/src/main/java/io/github/kobylynskyi/order/Application.java plugins/gradle/example/src/main/java/io/github/kobylynskyi/bikeshop/Application.java renamed to plugins/gradle/example-client/src/main/java/io/github/kobylynskyi/order/Application.java

@@ -1,4 +1,4 @@
-package io.github.kobylynskyi.bikeshop;
+package io.github.kobylynskyi.order;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

plugins/gradle/example-client/src/main/java/io/github/kobylynskyi/order/external/ExternalProductMapper.java

@@ -0,0 +1,12 @@
+package io.github.kobylynskyi.order.external;
+
+import io.github.kobylynskyi.order.model.Product;
+import io.github.kobylynskyi.product.graphql.model.ProductTO;
+import org.mapstruct.Mapper;
+
+@Mapper(componentModel = "spring")
+public interface ExternalProductMapper {
+
+    Product map(ProductTO from);
+
+}

plugins/gradle/example-client/src/main/java/io/github/kobylynskyi/order/external/ProductServiceGraphQLClient.java

@@ -0,0 +1,63 @@
+package io.github.kobylynskyi.order.external;
+
+import com.kobylynskyi.graphql.codegen.model.graphql.GraphQLRequest;
+import com.kobylynskyi.graphql.codegen.model.graphql.GraphQLResult;
+import io.github.kobylynskyi.order.model.Product;
+import io.github.kobylynskyi.order.model.UnableToRetrieveProductException;
+import io.github.kobylynskyi.product.graphql.model.ProductByIdQueryRequest;
+import io.github.kobylynskyi.product.graphql.model.ProductResponseProjection;
+import io.github.kobylynskyi.product.graphql.model.ProductTO;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.MediaType;
+import org.springframework.stereotype.Service;
+import org.springframework.web.client.RestTemplate;
+
+import java.net.URI;
+import java.util.Collections;
+import java.util.Map;
+
+@Service
+public class ProductServiceGraphQLClient {
+
+    @Autowired
+    private ExternalProductMapper productMapper;
+
+    @Autowired
+    private RestTemplate restTemplate;
+
+    @Value("${external.service.product.url}")
+    private String productUrl;
+
+    public Product getProduct(String productId) throws UnableToRetrieveProductException {
+        ProductByIdQueryRequest getProductRequest = new ProductByIdQueryRequest();
+        getProductRequest.setId(productId);
+        GraphQLRequest request = new GraphQLRequest(getProductRequest,
+                new ProductResponseProjection()
+                        .id()
+                        .title()
+                        .price());
+
+        GraphQLResult<Map<String, ProductTO>> result = restTemplate.exchange(URI.create(productUrl),
+                HttpMethod.POST,
+                httpEntity(request),
+                new ParameterizedTypeReference<GraphQLResult<Map<String, ProductTO>>>() {
+                }).getBody();
+        assert result != null;
+        if (result.hasErrors()) {
+            throw new UnableToRetrieveProductException(productId, result.getErrors().get(0).getMessage());
+        }
+        return productMapper.map(result.getData().get(getProductRequest.getOperationName()));
+    }
+
+    private static HttpEntity<String> httpEntity(Object request) {
+        HttpHeaders headers = new HttpHeaders();
+        headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON_UTF8));
+        headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
+        return new HttpEntity<>(request.toString(), headers);
+    }
+}

plugins/gradle/example-client/src/main/java/io/github/kobylynskyi/order/external/config/RestClientsConfiguration.java

@@ -0,0 +1,16 @@
+package io.github.kobylynskyi.order.external.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
+import org.springframework.web.client.RestTemplate;
+
+@Configuration
+public class RestClientsConfiguration {
+
+    @Bean
+    public RestTemplate restTemplate() {
+        return new RestTemplate(new HttpComponentsClientHttpRequestFactory());
+    }
+
+}