graphql-kotlin-types (#729)

### 📝 Description
Create new package `graphql-kotlin-types` which contains the common classes used by both client and server.

* Moved `GraphQLRequest` and `GraphQLResponse` previously in the spring package to `com.expediagroup.graphql.types`
* Created new `GraphQLError` that is not dependent on graphql-java types

This also removed the types that were previously defined in `graphql-kotlin-spring-server` so this is a breaking change. We don't expect other developers to be using this package directly but allows us to shared code across modules.

### 🔗 Related Issues
n|A

Author: smyrick

README.md

@@ -9,11 +9,12 @@ GraphQL Kotlin is a collection of libraries built on top of [graphql-java](https
 
 ## 📦 Modules
 
+* [examples](/examples) - Example apps that use graphql-kotlin libraries to test and demonstrate usages
 * [graphql-kotlin-client](/graphql-kotlin-client) - Lightweight GraphQL Kotlin HTTP client
-* [graphql-kotlin-federation](/graphql-kotlin-federation) - Schema generator extension to build federated GraphQL schemas
+* [graphql-kotlin-federation](/graphql-kotlin-federation) - Schema generator extension to build Apollo Federation GraphQL schemas
 * [graphql-kotlin-schema-generator](/graphql-kotlin-schema-generator) - Code only GraphQL schema generation for Kotlin
-* [graphql-kotlin-spring-server](/graphql-kotlin-spring-server) - Spring Boot auto-configuration library to create a GraphQL web app
-* [examples](/examples) - Example apps that use graphql-kotlin libraries to test and demonstrate usages
+* [graphql-kotlin-spring-server](/graphql-kotlin-spring-server) - Spring Boot auto-configuration library to create a GraphQL server
+* [graphql-kotlin-types](/graphql-kotlin-types) - Core types used by both client and server
 * [plugins](/plugins) - GraphQL Kotlin Gradle and Maven plugins
 
 ## ⌨️ Usage

docs/client/client-overview.md

@@ -131,15 +131,15 @@ Plugins will generate following client code
 package com.example.generated
 
 import com.expediagroup.graphql.client.GraphQLClient
-import com.expediagroup.graphql.client.GraphQLResult
+import com.expediagroup.graphql.types.GraphQLResponse
 import kotlin.String
 
 const val HELLO_WORLD_QUERY: String = "query HelloWorldQuery {\n    helloWorld\n}"
 
 class HelloWorldQuery(
   private val graphQLClient: GraphQLClient
 ) {
-  suspend fun execute(): GraphQLResult<HelloWorldQuery.Result> =
+  suspend fun execute(): GraphQLResponse<HelloWorldQuery.Result> =
       graphQLClient.execute(HELLO_WORLD_QUERY, "HelloWorldQuery", null)
 
   data class Result(

examples/spring/src/main/kotlin/com/expediagroup/graphql/examples/query/DataAndErrorsQuery.kt

@@ -28,20 +28,19 @@ import java.util.concurrent.CompletableFuture
 class DataAndErrorsQuery : Query {
 
     fun returnDataAndErrors(): DataFetcherResult<String> {
-        val error = SimpleKotlinGraphQLError(RuntimeException(), listOf(SourceLocation(1, 1)), ExecutionPath.rootPath().toList())
+        val error = SimpleKotlinGraphQLError(RuntimeException("data and errors"), listOf(SourceLocation(1, 1)), ExecutionPath.rootPath().toList())
         return DataFetcherResult.newResult<String>()
             .data("Hello from data fetcher")
             .error(error)
             .build()
     }
 
     fun completableFutureDataAndErrors(): CompletableFuture<DataFetcherResult<String>> {
-        val error = SimpleKotlinGraphQLError(RuntimeException(), listOf(SourceLocation(1, 1)), ExecutionPath.rootPath().toList())
+        val error = SimpleKotlinGraphQLError(RuntimeException("data and errors"), listOf(SourceLocation(1, 1)), ExecutionPath.rootPath().toList())
         val dataFetcherResult = DataFetcherResult.newResult<String>()
             .data("Hello from data fetcher")
             .error(error)
             .build()
-
         return CompletableFuture.completedFuture(dataFetcherResult)
     }
 }

examples/spring/src/test/kotlin/com/expediagroup/graphql/examples/query/DataAndErrorsQueryIT.kt

@@ -40,7 +40,7 @@ class DataAndErrorsQueryIT(@Autowired private val testClient: WebTestClient) {
     @ValueSource(strings = ["returnDataAndErrors", "completableFutureDataAndErrors"])
     fun `verify data and errors queries`(query: String) {
         val expectedData = "Hello from data fetcher"
-        val expectedError = "Exception while fetching data () : null"
+        val expectedError = "Exception while fetching data () : data and errors"
 
         testClient.post()
             .uri(GRAPHQL_ENDPOINT)

examples/spring/src/test/kotlin/com/expediagroup/graphql/examples/subscriptions/SimpleSubscriptionIT.kt

@@ -17,9 +17,9 @@
 package com.expediagroup.graphql.examples.subscriptions
 
 import com.expediagroup.graphql.examples.SUBSCRIPTION_ENDPOINT
-import com.expediagroup.graphql.spring.model.GraphQLRequest
 import com.expediagroup.graphql.spring.model.SubscriptionOperationMessage
 import com.expediagroup.graphql.spring.model.SubscriptionOperationMessage.ClientMessages.GQL_START
+import com.expediagroup.graphql.types.GraphQLRequest
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.fasterxml.jackson.module.kotlin.readValue
 import com.fasterxml.jackson.module.kotlin.registerKotlinModule

graphql-kotlin-client/build.gradle.kts

@@ -4,6 +4,7 @@ val ktorVersion: String by project
 val kotlinCoroutinesVersion: String by project
 
 dependencies {
+    api(project(path = ":graphql-kotlin-types"))
     api("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutinesVersion")
     api("io.ktor:ktor-client-cio:$ktorVersion")
     api("io.ktor:ktor-client-json:$ktorVersion")

graphql-kotlin-client/src/main/kotlin/com/expediagroup/graphql/client/GraphQLClient.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.client
 
+import com.expediagroup.graphql.types.GraphQLResponse
 import com.fasterxml.jackson.databind.DeserializationFeature
 import com.fasterxml.jackson.databind.JavaType
 import com.fasterxml.jackson.databind.ObjectMapper
@@ -48,6 +49,7 @@ class GraphQLClient<in T : HttpClientEngineConfig>(
 ) : Closeable {
 
     private val typeCache = mutableMapOf<Class<*>, JavaType>()
+
     init {
         mapper.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE)
     }
@@ -68,9 +70,9 @@ class GraphQLClient<in T : HttpClientEngineConfig>(
      * default serialization would attempt to serialize results back to Any object. As a workaround we get raw results as String which we then
      * manually deserialize using passed in result type Class information.
      */
-    suspend fun <T> executeOperation(query: String, operationName: String? = null, variables: Any? = null, resultType: Class<T>): GraphQLResult<T> {
-        // variables are simple data classes which will be serialized as map
-        // by using map instead of typed object we can eliminate the need to explicitly convert variables to a map
+    suspend fun <T> execute(query: String, operationName: String? = null, variables: Any? = null, resultType: Class<T>): GraphQLResponse<T> {
+        // Variables are simple data classes which will be serialized as map.
+        // By using map instead of typed object we can eliminate the need to explicitly convert variables to a map
         val graphQLRequest = mapOf(
             "query" to query,
             "operationName" to operationName,
@@ -90,13 +92,13 @@ class GraphQLClient<in T : HttpClientEngineConfig>(
     /**
      * Executes specified GraphQL query or mutation operation.
      */
-    suspend inline fun <reified T> execute(query: String, operationName: String? = null, variables: Any? = null): GraphQLResult<T> {
-        return executeOperation(query, operationName, variables, T::class.java)
+    suspend inline fun <reified T> execute(query: String, operationName: String? = null, variables: Any? = null): GraphQLResponse<T> {
+        return execute(query, operationName, variables, T::class.java)
     }
 
     private fun <T> parameterizedType(resultType: Class<T>): JavaType {
         return typeCache.computeIfAbsent(resultType) {
-            mapper.typeFactory.constructParametricType(GraphQLResult::class.java, resultType)
+            mapper.typeFactory.constructParametricType(GraphQLResponse::class.java, resultType)
         }
     }
 

graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/extensions/GraphQLSchemaExtensionsTest.kt

@@ -22,9 +22,9 @@ import com.expediagroup.graphql.annotations.GraphQLDirective
 import com.expediagroup.graphql.annotations.GraphQLIgnore
 import com.expediagroup.graphql.annotations.GraphQLName
 import com.expediagroup.graphql.getTestSchemaConfigWithMockedDirectives
+import com.expediagroup.graphql.scalars.ID
 import com.expediagroup.graphql.testSchemaConfig
 import com.expediagroup.graphql.toSchema
-import com.expediagroup.graphql.scalars.ID
 import graphql.introspection.Introspection
 import graphql.schema.GraphQLSchema
 import org.junit.jupiter.api.Test

graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/ToSchemaTest.kt

@@ -24,9 +24,9 @@ import com.expediagroup.graphql.annotations.GraphQLName
 import com.expediagroup.graphql.exceptions.ConflictingTypesException
 import com.expediagroup.graphql.exceptions.GraphQLKotlinException
 import com.expediagroup.graphql.extensions.deepName
+import com.expediagroup.graphql.scalars.ID
 import com.expediagroup.graphql.testSchemaConfig
 import com.expediagroup.graphql.toSchema
-import com.expediagroup.graphql.scalars.ID
 import graphql.ExceptionWhileDataFetching
 import graphql.GraphQL
 import graphql.Scalars

graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/types/GenerateArgumentTest.kt

@@ -19,8 +19,8 @@ package com.expediagroup.graphql.generator.types
 import com.expediagroup.graphql.annotations.GraphQLDescription
 import com.expediagroup.graphql.annotations.GraphQLName
 import com.expediagroup.graphql.exceptions.InvalidInputFieldTypeException
-import com.expediagroup.graphql.test.utils.SimpleDirective
 import com.expediagroup.graphql.scalars.ID
+import com.expediagroup.graphql.test.utils.SimpleDirective
 import graphql.Scalars
 import graphql.Scalars.GraphQLString
 import graphql.schema.GraphQLList