[client] support non JSON primitive scalars

Author: dariuszkuc

clients/graphql-kotlin-client-serialization/src/test/kotlin/com/expediagroup/graphql/client/serialization/data/scalars/UUIDSerializer.kt

@@ -18,37 +18,47 @@ package com.expediagroup.graphql.client.serialization.data.scalars
 
 import com.expediagroup.graphql.client.Generated
 import com.expediagroup.graphql.client.converter.ScalarConverter
+import kotlinx.serialization.ExperimentalSerializationApi
 import java.util.UUID
 import kotlinx.serialization.KSerializer
-import kotlinx.serialization.descriptors.PrimitiveKind.STRING
-import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
 import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.descriptors.buildClassSerialDescriptor
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.json.JsonDecoder
+import kotlinx.serialization.json.JsonPrimitive
 import kotlinx.serialization.json.jsonPrimitive
+import kotlinx.serialization.serializerOrNull
 
 @Generated
 object UUIDSerializer : KSerializer<UUID> {
     private val converter: UUIDScalarConverter = UUIDScalarConverter()
 
-    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("UUID", STRING)
+    override val descriptor: SerialDescriptor = buildClassSerialDescriptor("UUID")
 
+    @ExperimentalSerializationApi
     override fun serialize(encoder: Encoder, `value`: UUID) {
         val encoded = converter.toJson(value)
-        encoder.encodeString(encoded.toString())
+        val serializer = serializerOrNull(encoded::class.java)
+        if (serializer != null) {
+            encoder.encodeSerializableValue(serializer, encoded)
+        } else {
+            encoder.encodeString(encoded.toString())
+        }
     }
 
     override fun deserialize(decoder: Decoder): UUID {
         val jsonDecoder = decoder as JsonDecoder
-        val element = jsonDecoder.decodeJsonElement()
-        val rawContent = element.jsonPrimitive.content
+        val rawContent: Any = when (val element = jsonDecoder.decodeJsonElement()) {
+            is JsonPrimitive -> element.jsonPrimitive.content
+            else -> element
+        }
         return converter.toScalar(rawContent)
     }
 }
 
 // scalar converter would not be part of the generated sources
 class UUIDScalarConverter : ScalarConverter<java.util.UUID> {
     override fun toScalar(rawValue: Any): java.util.UUID = java.util.UUID.fromString(rawValue.toString())
-    override fun toJson(value: java.util.UUID): String = value.toString()
+    override fun toJson(value: java.util.UUID): Any = value.toString()
 }

examples/client/gradle-client/README.md

@@ -16,6 +16,7 @@ gradle clean build
 
 ## Running locally
 
+* Start server in `server-client-example`, see project README for details
 * **[only works after project is build]** Run `Application.kt` directly from your IDE
 * Alternatively you can also use the Gradle application plugin by running `gradle run` from the command line
 

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

@@ -32,8 +32,9 @@ 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"),
+            GraphQLScalar("_Any", "kotlinx.serialization.json.JsonObject", "com.expediagroup.graphql.examples.client.gradle._AnyScalarConverter"),
             GraphQLScalar("Locale", "com.ibm.icu.util.ULocale", "com.expediagroup.graphql.examples.client.gradle.ULocaleScalarConverter"),
+            GraphQLScalar("UUID", "java.util.UUID", "com.expediagroup.graphql.examples.client.gradle.UUIDScalarConverter"),
         )
         serializer = GraphQLSerializer.KOTLINX
     }

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

@@ -19,10 +19,12 @@ 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.EntitiesQuery
 import com.expediagroup.graphql.generated.ExampleQuery
 import com.expediagroup.graphql.generated.HelloWorldQuery
 import com.expediagroup.graphql.generated.RetrieveObjectQuery
 import com.expediagroup.graphql.generated.UpdateObjectMutation
+import com.expediagroup.graphql.generated.entitiesquery.Product
 import com.expediagroup.graphql.generated.inputs.BasicObjectInput
 import com.expediagroup.graphql.generated.inputs.SimpleArgumentInput
 import io.ktor.client.HttpClient
@@ -32,10 +34,19 @@ import io.ktor.client.plugins.logging.LogLevel
 import io.ktor.client.plugins.logging.Logger
 import io.ktor.client.plugins.logging.Logging
 import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.decodeFromString
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonObject
 import java.net.URL
 import java.util.concurrent.TimeUnit
 
 fun main() {
+    /*
+     * ************************************************************
+     * Make sure to start example server before running this code
+     * https://github.com/dariuszkuc/graphql-kotlin/blob/client-custom-scalars/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/Application.kt
+     * ************************************************************
+     */
     val httpClient = HttpClient(engineFactory = OkHttp) {
         engine {
             config {
@@ -57,6 +68,8 @@ fun main() {
     runBlocking {
         val helloWorldQuery = HelloWorldQuery(variables = HelloWorldQuery.Variables())
         val helloWorldResult = client.execute(helloWorldQuery)
+        println("\tquery without parameters result: ${helloWorldResult.data?.helloWorld}")
+
         val helloWorldResultImplicit: GraphQLClientResponse<HelloWorldQuery.Result> = client.execute(helloWorldQuery)
 
         val results = client.execute(
@@ -68,7 +81,7 @@ fun main() {
 
         val resultsNoParam = results[0].data as? HelloWorldQuery.Result
         val resultsWithParam = results[1].data as? HelloWorldQuery.Result
-        println("\tquery without parameters result: ${resultsNoParam?.helloWorld}")
+        println("\tquery with null name result: ${resultsNoParam?.helloWorld}")
         println("\tquery with parameters result: ${resultsWithParam?.helloWorld}")
     }
 
@@ -95,5 +108,23 @@ fun main() {
         println("\tretrieved example list: [${exampleData.data?.listQuery?.joinToString { it.name }}]")
     }
 
+    println("entities query")
+    runBlocking {
+        val entity = Json.decodeFromString<JsonObject>(
+            """
+            |{
+            |  "__typename": "Product",
+            |  "id": "apollo-federation"
+            |}
+            """.trimMargin()
+        )
+        val entityData = client.execute(EntitiesQuery(variables = EntitiesQuery.Variables(representations = listOf(entity))))
+        val product = entityData.data?._entities?.get(0) as? Product
+        println("\tretrieved product SKU: ${product?.sku}")
+        println("\tretrieved product package: ${product?.`package`}")
+        println("\tretrieved product variation ID: ${product?.variation?.id}")
+        println("\tretrieved product dimensions: size=${product?.dimensions?.size}, weight=${product?.dimensions?.weight}")
+    }
+
     client.close()
 }

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

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2022 Expedia, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.expediagroup.graphql.examples.client.gradle
+
+import com.expediagroup.graphql.client.converter.ScalarConverter
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.jsonObject
+
+class _AnyScalarConverter : ScalarConverter<JsonObject> {
+
+    override fun toScalar(rawValue: Any): JsonObject = Json.parseToJsonElement(rawValue.toString()).jsonObject
+
+    override fun toJson(value: JsonObject): Any = value
+}

examples/client/gradle-client/src/main/resources/EntitiesQuery.graphql

@@ -0,0 +1,7 @@
+query EntitiesQuery($representations: [_Any!]!) {
+    _entities(representations: $representations) {
+        __typename
+        ...on Product {sku package variation { id } dimensions { size weight }
+        }
+    }
+}

examples/client/maven-client/README.md

@@ -24,6 +24,7 @@ you can build it as
 
 ## Running locally
 
+* Start server in `server-client-example`, see project README for details
 * **[only works after project is build]** Run `Application.kt` directly from your IDE
 * Alternatively you can also use the Maven exec plugin by running `./mvnw exec:java` from the command line
 

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

@@ -16,29 +16,11 @@
 
 package com.expediagroup.graphql.examples.client.server
 
-import com.expediagroup.graphql.examples.client.server.scalars.graphqlULocaleType
-import com.expediagroup.graphql.examples.client.server.scalars.graphqlUUIDType
-import com.expediagroup.graphql.generator.hooks.SchemaGeneratorHooks
-import com.ibm.icu.util.ULocale
-import graphql.schema.GraphQLType
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.runApplication
-import org.springframework.context.annotation.Bean
-import java.util.UUID
-import kotlin.reflect.KType
 
 @SpringBootApplication
-class Application {
-
-    @Bean
-    fun customHooks(): SchemaGeneratorHooks = object : SchemaGeneratorHooks {
-        override fun willGenerateGraphQLType(type: KType): GraphQLType? = when (type.classifier) {
-            UUID::class -> graphqlUUIDType
-            ULocale::class -> graphqlULocaleType
-            else -> null
-        }
-    }
-}
+class Application
 
 fun main(args: Array<String>) {
     runApplication<Application>(*args)

examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/CustomFederatedHooks.kt

@@ -0,0 +1,20 @@
+package com.expediagroup.graphql.examples.client.server
+
+import com.expediagroup.graphql.examples.client.server.scalars.graphqlULocaleType
+import com.expediagroup.graphql.examples.client.server.scalars.graphqlUUIDType
+import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
+import com.expediagroup.graphql.generator.federation.execution.FederatedTypeResolver
+import com.ibm.icu.util.ULocale
+import graphql.schema.GraphQLType
+import org.springframework.stereotype.Component
+import java.util.UUID
+import kotlin.reflect.KType
+
+@Component
+class CustomFederatedHooks(resolvers: List<FederatedTypeResolver<*>>) : FederatedSchemaGeneratorHooks(resolvers, true) {
+    override fun willGenerateGraphQLType(type: KType): GraphQLType? = when (type.classifier) {
+        UUID::class -> graphqlUUIDType
+        ULocale::class -> graphqlULocaleType
+        else -> super.willGenerateGraphQLType(type)
+    }
+}

examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/FederatedQuery.kt

@@ -0,0 +1,132 @@
+package com.expediagroup.graphql.examples.client.server
+
+import com.expediagroup.graphql.generator.annotations.GraphQLName
+import com.expediagroup.graphql.generator.federation.directives.ExtendsDirective
+import com.expediagroup.graphql.generator.federation.directives.ExternalDirective
+import com.expediagroup.graphql.generator.federation.directives.FieldSet
+import com.expediagroup.graphql.generator.federation.directives.InaccessibleDirective
+import com.expediagroup.graphql.generator.federation.directives.KeyDirective
+import com.expediagroup.graphql.generator.federation.directives.OverrideDirective
+import com.expediagroup.graphql.generator.federation.directives.ProvidesDirective
+import com.expediagroup.graphql.generator.federation.directives.ShareableDirective
+import com.expediagroup.graphql.generator.federation.directives.TagDirective
+import com.expediagroup.graphql.generator.federation.execution.FederatedTypeResolver
+import com.expediagroup.graphql.generator.scalars.ID
+import com.expediagroup.graphql.server.operations.Query
+import graphql.schema.DataFetchingEnvironment
+import org.springframework.stereotype.Component
+
+@Component
+class FederatedQuery : Query {
+
+    fun product(id: ID) = Product.byID(id)
+}
+
+@KeyDirective(fields = FieldSet("id"))
+// @KeyDirective(fields = FieldSet("sku package"))
+// @KeyDirective(fields = FieldSet("sku variation { id }"))
+data class Product(
+    val id: ID,
+    val sku: String? = null,
+    @GraphQLName("package")
+    val pkg: String? = null,
+    val variation: ProductVariation? = null,
+    val dimensions: ProductDimension? = null,
+    @ProvidesDirective(FieldSet("totalProductsCreated"))
+    val createdBy: User? = null,
+    @TagDirective("internal")
+    val notes: String? = null
+) {
+    companion object {
+        fun byID(id: ID) = PRODUCTS.find { it.id.value == id.value }
+        private fun bySkuAndPackage(sku: String, pkg: String) = PRODUCTS.find { it.sku == sku && it.pkg == pkg }
+        private fun bySkuAndVariation(sku: String, variationId: String) =
+            PRODUCTS.find { it.sku == sku && it.variation?.id?.value == variationId }
+
+        fun byReference(ref: Map<String, Any>): Product? {
+            val id = ref["id"]?.toString()
+            val sku = ref["sku"]?.toString()
+            val pkg = ref["package"]?.toString()
+            val variation = ref["variation"]
+            val variationId = if (variation is Map<*, *>) {
+                variation["id"].toString()
+            } else null
+
+            return when {
+                id != null -> byID(ID(id))
+                sku != null && pkg != null -> bySkuAndPackage(sku, pkg)
+                sku != null && variationId != null -> bySkuAndVariation(sku, variationId)
+                else -> throw RuntimeException("invalid entity reference")
+            }
+        }
+    }
+}
+
+val PRODUCTS = listOf(
+    Product(
+        ID("apollo-federation"),
+        "federation",
+        "@apollo/federation",
+        ProductVariation(ID("OSS")),
+        ProductDimension("small", 1.0f),
+        User(email = "[email protected]", name = "support", totalProductsCreated = 1337)
+    ),
+    Product(
+        ID("apollo-studio"),
+        "studio",
+        "",
+        ProductVariation(ID("platform")),
+        ProductDimension("small", 1.0f),
+        User(email = "[email protected]", name = "support", totalProductsCreated = 1337)
+    )
+)
+
+@ShareableDirective
+data class ProductDimension(
+    val size: String? = null,
+    val weight: Float? = null,
+    @InaccessibleDirective
+    val unit: String? = null
+)
+
+data class ProductVariation(
+    val id: ID
+)
+
+@KeyDirective(fields = FieldSet("email"))
+@ExtendsDirective
+data class User(
+    @ExternalDirective
+    val email: String,
+    @OverrideDirective(from = "users")
+    val name: String,
+    @ExternalDirective
+    val totalProductsCreated: Int? = null
+)
+
+@Component
+class ProductsResolver : FederatedTypeResolver<Product> {
+    override val typeName: String = "Product"
+
+    override suspend fun resolve(
+        environment: DataFetchingEnvironment,
+        representations: List<Map<String, Any>>
+    ): List<Product?> = representations.map {
+        Product.byReference(it)
+    }
+}
+
+@Component
+class UserResolver : FederatedTypeResolver<User> {
+    override val typeName: String = "User"
+
+    override suspend fun resolve(
+        environment: DataFetchingEnvironment,
+        representations: List<Map<String, Any>>
+    ): List<User?> {
+        return representations.map {
+            val email = it["email"]?.toString() ?: throw RuntimeException("invalid entity reference")
+            User(email = email, name = "default", totalProductsCreated = 1337)
+        }
+    }
+}