Test scalar converters with Ulocale (#1259)

smyrick · web-flow · commit 584ca9fd8a0f · 2021-09-29T11:38:33.000-07:00
* Test scalar converters with Ulocale

* Update wiremock schema

* Add fields to types
diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts
@@ -51,6 +51,7 @@ subprojects {
         implementation(kotlin("stdlib", kotlinVersion))
         implementation(kotlin("reflect", kotlinVersion))
         implementation("org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:$kotlinCoroutinesVersion")
+        implementation("com.ibm.icu:icu4j:69.1")
         testImplementation(kotlin("test-junit5", kotlinVersion))
         testImplementation("org.junit.jupiter:junit-jupiter-api:$junitVersion")
         testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
diff --git a/examples/client/gradle-client/build.gradle.kts b/examples/client/gradle-client/build.gradle.kts
@@ -31,7 +31,10 @@ graphql {
         // optional
         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"))
+        customScalars = listOf(
+            GraphQLScalar("UUID", "java.util.UUID", "com.expediagroup.graphql.examples.client.gradle.UUIDScalarConverter"),
+            GraphQLScalar("Locale", "com.ibm.icu.util.ULocale", "com.expediagroup.graphql.examples.client.gradle.ULocaleScalarConverter"),
+        )
         serializer = GraphQLSerializer.KOTLINX
     }
 }
diff --git a/examples/client/gradle-client/src/main/kotlin/com/expediagroup/graphql/examples/client/gradle/ULocaleScalarConverter.kt b/examples/client/gradle-client/src/main/kotlin/com/expediagroup/graphql/examples/client/gradle/ULocaleScalarConverter.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 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 com.ibm.icu.util.ULocale
+
+/**
+ * Public client converter for a [ULocale]
+ */
+class ULocaleScalarConverter : ScalarConverter<ULocale> {
+    override fun toScalar(rawValue: Any): ULocale = ULocale(rawValue.toString())
+    override fun toJson(value: ULocale): Any = value.toString()
+}
diff --git a/examples/client/gradle-client/src/main/resources/ExampleQuery.graphql b/examples/client/gradle-client/src/main/resources/ExampleQuery.graphql
@@ -8,6 +8,8 @@ query ExampleQuery($simpleCriteria: SimpleArgumentInput) {
     name
     rating
     valid
+    locale
+    listLocale
   }
   listQuery {
     id
diff --git a/examples/client/maven-client/pom.xml b/examples/client/maven-client/pom.xml
@@ -30,6 +30,11 @@
             <artifactId>reactor-core</artifactId>
             <version>${reactor.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.ibm.icu</groupId>
+            <artifactId>icu4j</artifactId>
+            <version>69.1</version>
+        </dependency>
     </dependencies>
 
     <build>
@@ -79,6 +84,15 @@
                                        used to convert to/from raw JSON and scalar type -->
                                     <converter>com.expediagroup.graphql.examples.client.maven.UUIDScalarConverter</converter>
                                 </customScalar>
+                                <customScalar>
+                                    <!-- custom scalar UUID type -->
+                                    <scalar>Locale</scalar>
+                                    <!-- fully qualified Java class name of a custom scalar type -->
+                                    <type>com.ibm.icu.util.ULocale</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.expediagroup.graphql.examples.client.maven.ULocaleScalarConverter</converter>
+                                </customScalar>
                             </customScalars>
                             <serializer>JACKSON</serializer>
                             <useOptionalInputWrapper>true</useOptionalInputWrapper>
diff --git a/examples/client/maven-client/src/main/kotlin/com/expediagroup/graphql/examples/client/maven/ULocaleScalarConverter.kt b/examples/client/maven-client/src/main/kotlin/com/expediagroup/graphql/examples/client/maven/ULocaleScalarConverter.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 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.maven
+
+import com.expediagroup.graphql.client.converter.ScalarConverter
+import com.ibm.icu.util.ULocale
+
+/**
+ * Public client converter for a [ULocale]
+ */
+class ULocaleScalarConverter : ScalarConverter<ULocale> {
+    override fun toScalar(rawValue: Any): ULocale = ULocale(rawValue.toString())
+    override fun toJson(value: ULocale): Any = value.toString()
+}
diff --git a/examples/client/maven-client/src/main/resources/ExampleQuery.graphql b/examples/client/maven-client/src/main/resources/ExampleQuery.graphql
@@ -8,6 +8,8 @@ query ExampleQuery($simpleCriteria: SimpleArgumentInput) {
         name
         rating
         valid
+        locale
+        listLocale
     }
     listQuery {
         id
diff --git a/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/Application.kt b/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/Application.kt
@@ -16,12 +16,10 @@
 
 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 graphql.language.StringValue
-import graphql.schema.Coercing
-import graphql.schema.CoercingParseLiteralException
-import graphql.schema.CoercingParseValueException
-import graphql.schema.GraphQLScalarType
+import com.ibm.icu.util.ULocale
 import graphql.schema.GraphQLType
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.runApplication
@@ -32,33 +30,11 @@ import kotlin.reflect.KType
 @SpringBootApplication
 class Application {
 
-    private val graphqlUUIDType = GraphQLScalarType.newScalar()
-        .name("UUID")
-        .description("Custom scalar representing UUID")
-        .coercing(object : Coercing<UUID, String> {
-            override fun parseValue(input: Any): UUID = try {
-                UUID.fromString(
-                    serialize(input)
-                )
-            } catch (e: Exception) {
-                throw CoercingParseValueException("Cannot parse value $input to UUID", e)
-            }
-
-            override fun parseLiteral(input: Any): UUID = try {
-                val uuidString = (input as? StringValue)?.value
-                UUID.fromString(uuidString)
-            } catch (e: Exception) {
-                throw CoercingParseLiteralException("Cannot parse literal $input to UUID", e)
-            }
-
-            override fun serialize(dataFetcherResult: Any): String = dataFetcherResult.toString()
-        })
-        .build()
-
     @Bean
     fun customHooks(): SchemaGeneratorHooks = object : SchemaGeneratorHooks {
         override fun willGenerateGraphQLType(type: KType): GraphQLType? = when (type.classifier) {
             UUID::class -> graphqlUUIDType
+            ULocale::class -> graphqlULocaleType
             else -> null
         }
     }
diff --git a/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/SimpleQueries.kt b/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/SimpleQueries.kt
@@ -31,6 +31,7 @@ import com.expediagroup.graphql.examples.client.server.repository.BasicObjectRep
 import com.expediagroup.graphql.generator.annotations.GraphQLDescription
 import com.expediagroup.graphql.generator.scalars.ID
 import com.expediagroup.graphql.server.operations.Query
+import com.ibm.icu.util.ULocale
 import org.springframework.stereotype.Component
 import java.util.UUID
 import kotlin.random.Random
@@ -54,7 +55,9 @@ class SimpleQueries(private val repository: BasicObjectRepository) : Query {
         count = 1,
         rating = null,
         custom = UUID.randomUUID(),
-        customList = listOf(UUID.randomUUID(), UUID.randomUUID())
+        customList = listOf(UUID.randomUUID(), UUID.randomUUID()),
+        locale = ULocale.US,
+        listLocale = listOf(ULocale.US, ULocale.FRANCE)
     )
 
     @GraphQLDescription("Query returning list of simple objects")
diff --git a/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/model/ScalarWrapper.kt b/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/model/ScalarWrapper.kt
@@ -18,6 +18,7 @@ package com.expediagroup.graphql.examples.client.server.model
 
 import com.expediagroup.graphql.generator.annotations.GraphQLDescription
 import com.expediagroup.graphql.generator.scalars.ID
+import com.ibm.icu.util.ULocale
 import java.util.UUID
 
 @GraphQLDescription("Wrapper that holds all supported scalar types")
@@ -32,8 +33,12 @@ data class ScalarWrapper(
     val count: Int?,
     @GraphQLDescription("A nullable signed double-precision floating-point value")
     val rating: Float?,
-    @GraphQLDescription("Custom scalar")
+    @GraphQLDescription("Custom scalar of UUID")
     val custom: UUID,
-    @GraphQLDescription("List of custom scalars")
-    val customList: List<UUID>
+    @GraphQLDescription("List of custom scalar UUIDs")
+    val customList: List<UUID>,
+    @GraphQLDescription("Custom scalar of Locale")
+    val locale: ULocale,
+    @GraphQLDescription("List of custom scalar Locales")
+    val listLocale: List<ULocale>
 )
diff --git a/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/scalars/ULocaleCoercing.kt b/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/scalars/ULocaleCoercing.kt
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021 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.server.scalars
+
+import graphql.language.StringValue
+import graphql.schema.Coercing
+import graphql.schema.CoercingParseLiteralException
+import graphql.schema.CoercingParseValueException
+import graphql.schema.GraphQLScalarType
+
+internal val graphqlULocaleType = GraphQLScalarType.newScalar()
+    .name("Locale")
+    .description("A type representing a Locale such as en_US or fr_FR")
+    .coercing(ULocaleCoercing)
+    .build()
+
+// We coerce between <String, String> because jackson will
+// take care of ser/deser for us within SchemaGenerator
+private object ULocaleCoercing : Coercing<String, String> {
+    override fun parseValue(input: Any): String = input as? String ?: throw CoercingParseValueException("$input can not be cast to String")
+
+    override fun parseLiteral(input: Any): String = (input as? StringValue)?.value ?: throw CoercingParseLiteralException("$input can not be cast to StringValue")
+
+    override fun serialize(dataFetcherResult: Any): String = dataFetcherResult.toString()
+}
diff --git a/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/scalars/UUIDCoercing.kt b/examples/client/server/src/main/kotlin/com/expediagroup/graphql/examples/client/server/scalars/UUIDCoercing.kt
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2021 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.server.scalars
+
+import graphql.language.StringValue
+import graphql.schema.Coercing
+import graphql.schema.CoercingParseLiteralException
+import graphql.schema.CoercingParseValueException
+import graphql.schema.GraphQLScalarType
+import java.util.UUID
+
+internal val graphqlUUIDType = GraphQLScalarType.newScalar()
+    .name("UUID")
+    .description("Custom scalar representing UUID")
+    .coercing(object : Coercing<UUID, String> {
+        override fun parseValue(input: Any): UUID = try {
+            UUID.fromString(
+                serialize(input)
+            )
+        } catch (e: Exception) {
+            throw CoercingParseValueException("Cannot parse value $input to UUID", e)
+        }
+
+        override fun parseLiteral(input: Any): UUID = try {
+            val uuidString = (input as? StringValue)?.value
+            UUID.fromString(uuidString)
+        } catch (e: Exception) {
+            throw CoercingParseLiteralException("Cannot parse literal $input to UUID", e)
+        }
+
+        override fun serialize(dataFetcherResult: Any): String = dataFetcherResult.toString()
+    })
+    .build()
diff --git a/examples/client/src/integration/wiremock/__files/schema.graphql b/examples/client/src/integration/wiremock/__files/schema.graphql
@@ -147,6 +147,10 @@ type ScalarWrapper {
   rating: Float
   "Either true or false"
   valid: Boolean!
+  "Custom scalar of Locale"
+  locale: Locale!
+  "List of custom scalar Locales"
+  listLocale: [Locale!]!
 }
 
 "Example interface implementation where value is a float"
@@ -172,6 +176,9 @@ enum CustomEnum {
 "Custom scalar representing UUID"
 scalar UUID
 
+"A type representing a Locale such as en_US or fr_FR"
+scalar Locale
+
 "Some basic description"
 input BasicObjectInput {
   id: Int!
diff --git a/plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/exceptions/InvalidSelectionSetException.kt b/plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/generator/exceptions/InvalidSelectionSetException.kt
@@ -20,4 +20,4 @@ package com.expediagroup.graphql.plugin.client.generator.exceptions
  * Exception thrown when specified query file contains invalid selection set.
  */
 internal class InvalidSelectionSetException(operationName: String, typeDefinitionName: String, typeName: String) :
-    RuntimeException("Operation $operationName specifies invalid selection set for $typeName - cannot select empty $typeDefinitionName")
+    RuntimeException("Operation $operationName specifies invalid selection set for $typeName - cannot find field '$typeDefinitionName'")
diff --git a/plugins/client/graphql-kotlin-client-generator/src/test/resources/testSchema.graphql b/plugins/client/graphql-kotlin-client-generator/src/test/resources/testSchema.graphql
@@ -127,6 +127,10 @@ type ScalarWrapper {
   rating: Float
   "Either true or false"
   valid: Boolean!
+  "Custom scalar of Locale"
+  locale: Locale!
+  "List of custom scalar Locales"
+  listLocale: [Locale!]!
 }
 "Example interface implementation where value is a float"
 type SecondInterfaceImplementation implements BasicInterface {
@@ -160,6 +164,10 @@ enum OtherEnum {
 }
 "Custom scalar representing UUID"
 scalar UUID
+
+"A type representing a Locale such as en_US or fr_FR"
+scalar Locale
+
 "Test input object"
 input SimpleArgumentInput {
   "Maximum value for test criteria"

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,10 @@ graphql {`
`31`	`31`	`// optional`
`32`	`32`	`allowDeprecatedFields = true`
`33`	`33`	`headers = mapOf("X-Custom-Header" to "My-Custom-Header")`
`34`		`- customScalars = listOf(GraphQLScalar("UUID", "java.util.UUID", "com.expediagroup.graphql.examples.client.gradle.UUIDScalarConverter"))`
	`34`	`+ customScalars = listOf(`
	`35`	`+ GraphQLScalar("UUID", "java.util.UUID", "com.expediagroup.graphql.examples.client.gradle.UUIDScalarConverter"),`
	`36`	`+ GraphQLScalar("Locale", "com.ibm.icu.util.ULocale", "com.expediagroup.graphql.examples.client.gradle.ULocaleScalarConverter"),`
	`37`	`+ )`
`35`	`38`	`serializer = GraphQLSerializer.KOTLINX`
`36`	`39`	`}`
`37`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ query ExampleQuery($simpleCriteria: SimpleArgumentInput) {`
`8`	`8`	`name`
`9`	`9`	`rating`
`10`	`10`	`valid`
	`11`	`+ locale`
	`12`	`+ listLocale`
`11`	`13`	`}`
`12`	`14`	`listQuery {`
`13`	`15`	`id`