[plugins] update plugins to allow generation of client code using kotlinx serialization (#1070)

This is a third and final PR in a series to introduce support for both `Jackson` and `kotlinx.serialization` data formats for GraphQL Kotlin clients.

This PR updates Gradle and Maven plugins to allow generating client data models supporting both formats. This PR also updates Ktor client to by default depend on `kotlinx.serialization` instead of `Jackson`.

Large size of the PR is driven primarily due to the formatting fixes in the Gradle plugin integration tests (updated build scripts templates to use `trimMargin` for consistent indentation).

Related:
* #1048 - this is an attempt to split it up to more manageable pieces
* #1066 - first PR in the series
* #1069 - second PR in the series
* resolves #929 - add support for generating `kotlinx.serialization` data models

Author: dariuszkuc

clients/graphql-kotlin-ktor-client/build.gradle.kts

@@ -9,10 +9,10 @@ val wireMockVersion: String by project
 
 dependencies {
     api(project(path = ":graphql-kotlin-client"))
-    api(project(path = ":graphql-kotlin-client-jackson"))
+    api(project(path = ":graphql-kotlin-client-serialization"))
     api("io.ktor:ktor-client-cio:$ktorVersion")
-    api("io.ktor:ktor-client-jackson:$ktorVersion")
-    testImplementation(project(path = ":graphql-kotlin-client-serialization"))
+    api("io.ktor:ktor-client-serialization:$ktorVersion")
+    testImplementation(project(path = ":graphql-kotlin-client-jackson"))
     testImplementation("io.ktor:ktor-client-okhttp:$ktorVersion")
     testImplementation("io.ktor:ktor-client-logging:$ktorVersion")
     testImplementation("com.github.tomakehurst:wiremock-jre8:$wireMockVersion")

examples/client/gradle-client/README.md

@@ -1,8 +1,10 @@
 # Example usage GraphQL Kotlin Client using Gradle
 
 This project is a simple application that use [GraphQL Kotlin Gradle plugin](https://expediagroup.github.io/graphql-kotlin/docs/plugins/gradle-plugin)
-to auto-generate GraphQL client and then use it to communicate with the target GraphQL server. See [client documentation](https://expediagroup.github.io/graphql-kotlin/docs/client/client-overview)
-for details.
+to auto-generate GraphQL client data model compatible with `kotlinx.serialization` and then use Ktor based client to communicate
+with the target GraphQL server.
+
+See [client documentation](https://expediagroup.github.io/graphql-kotlin/docs/client/client-overview) for additional details.
 
 ## Building locally
 

examples/client/gradle-client/build.gradle.kts

@@ -1,10 +1,12 @@
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
 import com.expediagroup.graphql.plugin.gradle.graphql
 
 description = "Example usage of Gradle plugin to generate GraphQL Kotlin Client"
 
 plugins {
     application
+    kotlin("plugin.serialization")
     id("com.expediagroup.graphql")
 }
 
@@ -30,6 +32,7 @@ graphql {
         allowDeprecatedFields = true
         headers = mapOf("X-Custom-Header" to "My-Custom-Header")
         customScalars = listOf(GraphQLScalar("UUID", "java.util.UUID", "com.expediagroup.graphql.examples.client.gradle.UUIDScalarConverter"))
+        serializer = GraphQLSerializer.KOTLINX
     }
 }
 ktlint {

examples/client/gradle-client/src/main/kotlin/com/expediagroup/graphql/examples/client/gradle/Application.kt

@@ -17,6 +17,7 @@
 package com.expediagroup.graphql.examples.client.gradle
 
 import com.expediagroup.graphql.client.ktor.GraphQLKtorClient
+import com.expediagroup.graphql.client.types.GraphQLClientResponse
 import com.expediagroup.graphql.generated.AddObjectMutation
 import com.expediagroup.graphql.generated.ExampleQuery
 import com.expediagroup.graphql.generated.HelloWorldQuery
@@ -50,10 +51,14 @@ fun main() {
     }
     val client = GraphQLKtorClient(
         url = URL("http://localhost:8080/graphql"),
-        httpClient = httpClient,
+        httpClient = httpClient
     )
     println("HelloWorld examples")
     runBlocking {
+        val helloWorldQuery = HelloWorldQuery(variables = HelloWorldQuery.Variables())
+        val helloWorldResult = client.execute(helloWorldQuery)
+        val helloWorldResultImplicit: GraphQLClientResponse<HelloWorldQuery.Result> = client.execute(helloWorldQuery)
+
         val results = client.execute(
             listOf(
                 HelloWorldQuery(variables = HelloWorldQuery.Variables(name = null)),

examples/client/maven-client/README.md

@@ -1,8 +1,10 @@
 # Example usage GraphQL Kotlin Client using Maven
 
 This project is a simple application that use [GraphQL Kotlin Maven plugin](https://expediagroup.github.io/graphql-kotlin/docs/plugins/maven-plugin)
-to auto-generate GraphQL client and then use it to communicate with the target GraphQL server. See [documentation](https://expediagroup.github.io/graphql-kotlin/)
-for details.
+to auto-generate GraphQL client data model compatible with `Jackson` and then use Spring Webclient based client to communicate
+with the target GraphQL server.
+
+See [client documentation](https://expediagroup.github.io/graphql-kotlin/docs/client/client-overview) for additional details.
 
 ## Building locally
 

examples/client/maven-client/pom.xml

@@ -80,6 +80,7 @@
                                     <converter>com.expediagroup.graphql.examples.client.maven.UUIDScalarConverter</converter>
                                 </customScalar>
                             </customScalars>
+                            <serializer>JACKSON</serializer>
                         </configuration>
                     </execution>
                 </executions>

examples/settings.gradle.kts

@@ -10,6 +10,7 @@ pluginManagement {
     plugins {
         kotlin("jvm") version kotlinVersion
         kotlin("plugin.spring") version kotlinVersion
+        kotlin("plugin.serialization") version kotlinVersion
         id("io.gitlab.arturbosch.detekt") version detektVersion
         id("org.jlleitschuh.gradle.ktlint") version ktlintPluginVersion
         id("org.springframework.boot") version springBootVersion

plugins/graphql-kotlin-gradle-plugin/README.md

@@ -23,6 +23,7 @@ This extension can be used to configure global options instead of explicitly con
 
 ```kotlin
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
 import com.expediagroup.graphql.plugin.gradle.graphql
 
 graphql {
@@ -41,6 +42,8 @@ graphql {
       queryFileDirectory = "${project.projectDir}/src/main/resources/queries"
       // Optional list of query files to be processed, takes precedence over queryFileDirectory
       queryFiles = listOf(file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql"))
+      // JSON serializer that will be used to generate the data classes.
+      serializer = GraphQLSerializer.JACKSON
       // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
       sdlEndpoint = "http://localhost:8080/sdl"
       // Timeout configuration for introspection query/downloading SDL
@@ -97,6 +100,7 @@ resulting generated code will be automatically added to the project main source
 | `packageName` | String | yes | Target package name for generated code.<br/>**Command line property is**: `packageName`. |
 | `queryFiles` | FileCollection | | List of query files to be processed. Instead of a list of files to be processed you can specify `queryFileDirectory` directory instead. If this property is specified it will take precedence over the corresponding directory property. |
 | `queryFileDirectory` | String | | Directory file containing GraphQL queries. Instead of specifying a directory you can also specify list of query file by using `queryFiles` property instead.<br/>**Default value is:** `src/main/resources`.<br/>**Command line property is**: `queryFileDirectory`. |
+| `serializer` | GraphQLSerializer | | JSON serializer that will be used to generate the data classes.<br/>**Default value is:** `GraphQLSerializer.JACKSON`. |
 | `schemaFile` | File | `schemaFileName` or `schemaFile` has to be provided | GraphQL schema file that will be used to generate client code. |
 | `schemaFileName` | String | `schemaFileName` or `schemaFile` has to be provided | Path to GraphQL schema file that will be used to generate client code.<br/>**Command line property is**: `schemaFileName`. |
 
@@ -143,6 +147,7 @@ test source set.
 | `packageName` | String | yes | Target package name for generated code.<br/>**Command line property is**: `packageName`. |
 | `queryFiles` | FileCollection | | List of query files to be processed. Instead of a list of files to be processed you can specify `queryFileDirectory` directory instead. If this property is specified it will take precedence over the corresponding directory property. |
 | `queryFileDirectory` | String | | Directory file containing GraphQL queries. Instead of specifying a directory you can also specify list of query file by using `queryFiles` property instead.<br/>**Default value is:** `src/test/resources`.<br/>**Command line property is**: `queryFileDirectory`. |
+| `serializer` | GraphQLSerializer | | JSON serializer that will be used to generate the data classes.<br/>**Default value is:** `GraphQLSerializer.JACKSON`. |
 | `schemaFile` | File | `schemaFileName` or `schemaFile` has to be provided | GraphQL schema file that will be used to generate client code. |
 | `schemaFileName` | String | `schemaFileName` or `schemaFile` has to be provided | Path to GraphQL schema file that will be used to generate client code.<br/>**Command line property is**: `schemaFileName`. |
 

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLGradlePlugin.kt

@@ -95,6 +95,7 @@ class GraphQLGradlePlugin : Plugin<Project> {
                     generateClientTask.queryFileDirectory.convention(queryFileDirectory)
                 }
                 generateClientTask.queryFiles.setFrom(extension.clientExtension.queryFiles)
+                generateClientTask.serializer.convention(extension.clientExtension.serializer)
 
                 when {
                     extension.clientExtension.endpoint != null -> {

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLPluginExtension.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.plugin.gradle
 
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.config.TimeoutConfiguration
 import org.gradle.api.Action
@@ -70,6 +71,8 @@ open class GraphQLPluginClientExtension {
     var queryFiles: List<File> = emptyList()
     /** Directory containing GraphQL query files. */
     var queryFileDirectory: String? = null
+    /** JSON serializer that will be used to generate the data classes. */
+    var serializer: GraphQLSerializer = GraphQLSerializer.JACKSON
 
     /** Connect and read timeout configuration for executing introspection query/download schema */
     internal val timeoutConfig: TimeoutConfiguration = TimeoutConfiguration()