[plugin] refactor Gradle tasks to use Worker API (ExpediaGroup#1002)

Updating all Gradle tasks to use Worker API that allows us to minimize the number of plugin dependencies through classpath isolation. Plugin has `compileOnly` dependencies on `graphql-kotlin` modules (`client-generator` which is renamed `plugin-core` module and `sdl-generator`). New `WorkAction`s will use classpath isolation with custom configuration that includes necessary dependencies to run the actions.

Updated build scan (from example gradle client): https://scans.gradle.com/s/znufum5lj75lg/build-dependencies

Author: dariuszkuc

docs/plugins/gradle-plugin-examples.md

@@ -136,7 +136,7 @@ if you would like to use WebClient implementation instead you need to specify `G
 
 ```kotlin
 // build.gradle.kts
-import com.expediagroup.graphql.plugin.generator.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
 import com.expediagroup.graphql.plugin.gradle.tasks.GraphQLGenerateClientTask
 
 val graphqlGenerateClient by tasks.getting(GraphQLGenerateClientTask::class) {
@@ -150,8 +150,10 @@ val graphqlGenerateClient by tasks.getting(GraphQLGenerateClientTask::class) {
 
 ```groovy
 //build.gradle
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+
 graphqlGenerateClient {
-    clientType = com.expediagroup.graphql.plugin.generator.GraphQLClientType.KTOR
+    clientType = GraphQLClientType.KTOR
     packageName = "com.example.generated"
     schemaFileName = "mySchema.graphql"
 }
@@ -191,23 +193,26 @@ Afterwards we need to configure our plugin to use this custom converter
 
 ```kotlin
 // build.gradle.kts
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.tasks.GraphQLGenerateClientTask
 
 val graphqlGenerateClient by tasks.getting(GraphQLGenerateClientTask::class) {
   packageName.set("com.example.generated")
   schemaFileName.set("mySchema.graphql")
-  converters.put("UUID", ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter"))
+  customScalars.add(GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
 }
 ```
 
 <!--Groovy-->
 
 ```groovy
 //build.gradle
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+
 graphqlGenerateClient {
     packageName = "com.example.generated"
     schemaFileName = "mySchema.graphql"
-    converters["UUID"] = new com.expediagroup.graphql.plugin.generator.ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter")
+    customScalars.add(new GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
 }
 ```
 
@@ -331,9 +336,8 @@ the GraphQL Ktor client code based on the provided query.
 
 ```kotlin
 // build.gradle.kts
-import com.expediagroup.graphql.plugin.config.TimeoutConfig
-import com.expediagroup.graphql.plugin.generator.GraphQLClientType
-import com.expediagroup.graphql.plugin.generator.ScalarConverterMapping
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.graphql
 
 graphql {
@@ -343,7 +347,7 @@ graphql {
     // optional configuration
     allowDeprecatedFields = true
     clientType = GraphQLClientType.KTOR
-    converters = mapOf("UUID" to ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter"))
+    customScalars = listOf(GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
     headers = mapOf("X-Custom-Header" to "My-Custom-Header")
     queryFiles = listOf(file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql"))
     timeout {
@@ -358,24 +362,24 @@ Above configuration is equivalent to the following
 
 ```kotlin
 // build.gradle.kts
-import com.expediagroup.graphql.plugin.config.TimeoutConfig
-import com.expediagroup.graphql.plugin.generator.GraphQLClientType
-import com.expediagroup.graphql.plugin.generator.ScalarConverterMapping
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+import com.expediagroup.graphql.plugin.gradle.config.TimeoutConfiguration
 import com.expediagroup.graphql.plugin.gradle.tasks.GraphQLDownloadSDLTask
 import com.expediagroup.graphql.plugin.gradle.tasks.GraphQLIntrospectSchemaTask
 
 val graphqlDownloadSDL by tasks.getting(GraphQLDownloadSDLTask::class) {
     endpoint.set("http://localhost:8080/sdl")
     headers.put("X-Custom-Header", "My-Custom-Header")
-    timeoutConfig.set(TimeoutConfig(connect = 10_000, read = 30_000))
+    timeoutConfig.set(TimeoutConfiguration(connect = 10_000, read = 30_000))
 }
 val graphqlGenerateClient by tasks.getting(GraphQLGenerateClientTask::class) {
     packageName.set("com.example.generated")
     schemaFile.set(graphqlDownloadSDL.outputFile)
     // optional
     allowDeprecatedFields.set(true)
     clientType.set(GraphQLClientType.KTOR)
-    converters.put("UUID", ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter"))
+    customScalars.add(GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
     queryFiles.from("${project.projectDir}/src/main/resources/queries/MyQuery.graphql")
 
     dependsOn("graphqlDownloadSDL")
@@ -386,19 +390,22 @@ val graphqlGenerateClient by tasks.getting(GraphQLGenerateClientTask::class) {
 
 ```groovy
 // build.gradle
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+
 graphql {
     client {
         sdlEndpoint = "http://localhost:8080/sdl"
         packageName = "com.example.generated"
         // optional configuration
         allowDeprecatedFields = true
-        clientType = com.expediagroup.graphql.plugin.generator.GraphQLClientType.KTOR
-        converters = ["UUID" : new com.expediagroup.graphql.plugin.generator.ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter")]
+        clientType = GraphQLClientType.KTOR
+        customScalars = [new GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter")]
         headers = ["X-Custom-Header" : "My-Custom-Header"]
         queryFiles = [file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql")]
         timeout { t ->
-            t.connect = 10_000
-            t.read = 30_000
+            t.connect = 10000
+            t.read = 30000
         }
     }
 }
@@ -408,18 +415,22 @@ Above configuration is equivalent to the following
 
 ```groovy
 //build.gradle
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+import com.expediagroup.graphql.plugin.gradle.config.TimeoutConfiguration
+
 graphqlDownloadSDL {
     endpoint = "http://localhost:8080/sdl"
     headers["X-Custom-Header"] = "My-Custom-Header"
-    timeoutConfig = new com.expediagroup.graphql.plugin.config.TimeoutConfig(10000, 30000)
+    timeoutConfig = new TimeoutConfiguration(10000, 30000)
 }
 graphqlGenerateClient {
     packageName = "com.example.generated"
     schemaFile = graphqlDownloadSDL.outputFile
     // optional
     allowDeprecatedFields = true
-    clientType = com.expediagroup.graphql.plugin.generator.GraphQLClientType.KTOR
-    converters["UUID"] = new com.expediagroup.graphql.plugin.generator.ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter")
+    clientType = GraphQLClientType.KTOR
+    customScalars.add(new GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
     queryFiles.from("${project.projectDir}/src/main/resources/queries/MyQuery.graphql")
 
     dependsOn graphqlDownloadSDL

docs/plugins/gradle-plugin.md

@@ -86,7 +86,8 @@ tasks.
 
 ```kotlin
 // build.gradle.kts
-import com.expediagroup.graphql.plugin.generator.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.graphql
 
 graphql {
@@ -95,8 +96,8 @@ graphql {
     allowDeprecatedFields = false
     // Type of GraphQL client implementation to generate.
     clientType = GraphQLClientType.DEFAULT
-    // Custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
-    converters = mapOf("UUID" to ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter"))
+    // List of custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
+    customScalars = listOf(GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
     // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint`.
     endpoint = "http://localhost:8080/graphql"
     // Optional HTTP headers to be specified on an introspection query or SDL request.
@@ -129,14 +130,17 @@ graphql {
 
 ```groovy
 // build.gradle
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLClientType
+import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
+
 graphql {
     client {
         // Boolean flag indicating whether or not selection of deprecated fields is allowed.
         allowDeprecatedFields = false
         // Type of GraphQL client implementation to generate.
-        clientType = com.expediagroup.graphql.plugin.generator.GraphQLClientType.DEFAULT
-        // Custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
-        converters = ["UUID" : new com.expediagroup.graphql.plugin.generator.ScalarConverterMapping("java.util.UUID", "com.example.UUIDScalarConverter")]
+        clientType = GraphQLClientType.DEFAULT
+        // List of custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
+        customScalars = [new GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter")]
         // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint`.
         endpoint = "http://localhost:8080/graphql"
         // Optional HTTP headers to be specified on an introspection query or SDL request.
@@ -200,7 +204,7 @@ resulting generated code will be automatically added to the project main source
 | -------- | ---- | -------- | ----------- |
 | `allowDeprecatedFields` | Boolean | | Boolean flag indicating whether selection of deprecated fields is allowed or not.<br/>**Default value is:** `false`.<br/>**Command line property is**: `allowDeprecatedFields`. |
 | `clientType` | GraphQLClientType | | Enum value that specifies target GraphQL client type implementation.<br/>**Default value is:** `GraphQLClientType.DEFAULT`. |
-| `converters` | Map<String, ScalarConverter> | | Custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values. |
+| `customScalars` | List<GraphQLScalar> | | List of custom GraphQL scalar to converter mappings containing information about corresponding Java type and converter that should be used to serialize/deserialize values. |
 | `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`. |
@@ -236,7 +240,7 @@ test source set.
 | -------- | ---- | -------- | ----------- |
 | `allowDeprecatedFields` | Boolean | | Boolean flag indicating whether selection of deprecated fields is allowed or not.<br/>**Default value is:** `false`.<br/>**Command line property is**: `allowDeprecatedFields`. |
 | `clientType` | GraphQLClientType | | Enum value that specifies target GraphQL client type implementation.<br/>**Default value is:** `GraphQLClientType.DEFAULT`. |
-| `converters` | Map<String, ScalarConverter> | | Custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values. |
+| `customScalars` | List<GraphQLScalar> | | List of custom GraphQL scalar to converter mappings containing information about corresponding Java type and converter that should be used to serialize/deserialize values. |
 | `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`. |

docs/plugins/maven-plugin-examples.md

@@ -172,16 +172,17 @@ Afterwards we need to configure our plugin to use this custom converter
             </goals>
             <configuration>
                 <allowDeprecatedFields>false</allowDeprecatedFields>
-                <converters>
-                    <!-- custom scalar UUID type -->
-                    <UUID>
+                <customScalars>
+                    <customScalar>
+                        <!-- custom scalar UUID type -->
+                        <scalar>UUID</scalar>
                         <!-- fully qualified Java class name of a custom scalar type -->
                         <type>java.util.UUID</type>
                         <!-- fully qualified Java class name of a custom com.expediagroup.graphql.client.converter.ScalarConverter
                            used to convert to/from raw JSON and scalar type -->
                         <converter>com.example.UUIDScalarConverter</converter>
-                    </UUID>
-                </converters>
+                    </customScalar>
+                </customScalars>
                 <packageName>com.example.generated</packageName>
                 <schemaFile>mySchema.graphql</schemaFile>
             </configuration>
@@ -279,16 +280,17 @@ the GraphQL client code based on the provided query.
                 <!-- optional configuration below -->
                 <schemaFile>${project.build.directory}/mySchema.graphql</schemaFile>
                 <allowDeprecatedFields>true</allowDeprecatedFields>
-                <converters>
-                    <!-- custom scalar UUID type -->
-                    <UUID>
+                <customScalars>
+                    <customScalar>
+                        <!-- custom scalar UUID type -->
+                        <scalar>UUID</scalar>
                         <!-- fully qualified Java class name of a custom scalar type -->
                         <type>java.util.UUID</type>
                         <!-- fully qualified Java class name of a custom com.expediagroup.graphql.client.converter.ScalarConverter
                            used to convert to/from raw JSON and scalar type -->
                         <converter>com.example.UUIDScalarConverter</converter>
-                    </UUID>
-                </converters>
+                    </customScalar>
+                </customScalars>
                 <headers>
                     <X-Custom-Header>My-Custom-Header</X-Custom-Header>
                 </headers>