Upgrade to graphql-java 14 (#568)

* First pass at graphql-java 14

* Fix regex for new graphql description format

* Fix integration tests

* Add multiline comment tests to federated SDL

* Remove deprecated printer option

GraphQL Java deprecated the descriptionsAsHashComments so instead of including it we should just not add it until there is a need as it will eventually be removed

Author: smyrick

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

@@ -82,7 +82,8 @@ class PolymorphicQueryIT(@Autowired private val testClient: WebTestClient) {
             .exchange()
             .expectStatus().isOk
             .verifyError("Validation error of type WrongType: " +
-                "argument 'type' with value 'EnumValue{name='$unknownType'}' is not a valid 'AnimalType' @ 'animal'")
+                "argument 'type' with value 'EnumValue{name='$unknownType'}' is not a valid 'AnimalType' - " +
+                "Expected enum literal value not in allowable values -  'EnumValue{name='HELLO'}'. @ 'animal'")
     }
 
     @Test

gradle.properties

@@ -9,7 +9,7 @@ org.gradle.parallel=true
 kotlinVersion = 1.3.50
 kotlinCoroutinesVersion = 1.3.2
 
-graphQLJavaVersion = 13.0
+graphQLJavaVersion = 14.0
 jacksonVersion = 2.10.1
 springBootVersion = 2.2.1.RELEASE
 classGraphVersion = 4.8.53

graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGeneratorHooks.kt

@@ -17,9 +17,14 @@
 package com.expediagroup.graphql.federation
 
 import com.expediagroup.graphql.annotations.GraphQLName
+import com.expediagroup.graphql.directives.DEPRECATED_DIRECTIVE_NAME
 import com.expediagroup.graphql.extensions.print
+import com.expediagroup.graphql.federation.directives.EXTENDS_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.EXTERNAL_DIRECTIVE_NAME
 import com.expediagroup.graphql.federation.directives.FieldSet
 import com.expediagroup.graphql.federation.directives.KEY_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.PROVIDES_DIRECTIVE_NAME
+import com.expediagroup.graphql.federation.directives.REQUIRES_DIRECTIVE_NAME
 import com.expediagroup.graphql.federation.directives.extendsDirectiveType
 import com.expediagroup.graphql.federation.execution.EntityResolver
 import com.expediagroup.graphql.federation.execution.FederatedTypeRegistry
@@ -34,23 +39,26 @@ import graphql.TypeResolutionEnvironment
 import graphql.schema.DataFetcher
 import graphql.schema.FieldCoordinates
 import graphql.schema.GraphQLCodeRegistry
+import graphql.schema.GraphQLDirective
 import graphql.schema.GraphQLObjectType
 import graphql.schema.GraphQLSchema
 import graphql.schema.GraphQLType
+import java.util.function.Predicate
 import kotlin.reflect.KType
 import kotlin.reflect.full.findAnnotation
 
 /**
  * Hooks for generating federated GraphQL schema.
  */
 open class FederatedSchemaGeneratorHooks(private val federatedTypeRegistry: FederatedTypeRegistry) : SchemaGeneratorHooks {
-    private val directiveDefinitionRegex = "(^#.+$[\\r\\n])?^directive @\\w+.+$[\\r\\n]*".toRegex(setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE))
-    private val customDirectivesRegex = "\\s*@(?!extends)(?!external)(?!key)(?!provides)(?!requires)(?!deprecated)\\w+(?:\\(.*(?=\\))\\))?".toRegex(
-        setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE))
-    private val scalarDefinitionRegex = "(^#.+$[\\r\\n])?^scalar (_FieldSet|_Any)$[\\r\\n]*".toRegex(setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE))
+    private val directiveDefinitionRegex = "(^\".+\"$[\\r\\n])?^directive @\\w+.+\$[\\r\\n]*".toRegex(setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE))
+    private val scalarDefinitionRegex = "(^\".+\"$[\\r\\n])?^scalar (_FieldSet|_Any)$[\\r\\n]*".toRegex(setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE))
     private val emptyQueryRegex = "^type Query \\{$\\s+^\\}$\\s+".toRegex(setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE))
     private val validator = FederatedSchemaValidator()
 
+    private val directivesToInclude = listOf(EXTENDS_DIRECTIVE_NAME, EXTERNAL_DIRECTIVE_NAME, KEY_DIRECTIVE_NAME, PROVIDES_DIRECTIVE_NAME, REQUIRES_DIRECTIVE_NAME, DEPRECATED_DIRECTIVE_NAME)
+    private val customDirectivePredicate: Predicate<GraphQLDirective> = Predicate { directivesToInclude.contains(it.name) }
+
     override fun willGenerateGraphQLType(type: KType): GraphQLType? = when (type.classifier) {
         FieldSet::class -> FIELD_SET_SCALAR_TYPE
         else -> null
@@ -79,14 +87,13 @@ open class FederatedSchemaGeneratorHooks(private val federatedTypeRegistry: Fede
          * - any custom directives
          * - new federated scalars
          */
-        val sdl = originalSchema.print(includeDefaultSchemaDefinition = false)
+        val sdl = originalSchema.print(includeDefaultSchemaDefinition = false, includeDirectivesFilter = customDirectivePredicate)
             /**
-             * TODO: this can be simplified once this is solved: apollographql/apollo-server#3334
+             * TODO: this can be simplified once this is solved: https://github.com/apollographql/apollo-server/issues/3334
              */
             .replace(directiveDefinitionRegex, "")
             .replace(scalarDefinitionRegex, "")
             .replace(emptyQueryRegex, "")
-            .replace(customDirectivesRegex, "")
             .trim()
         federatedCodeRegistry.dataFetcher(FieldCoordinates.coordinates(originalQuery.name, SERVICE_FIELD_DEFINITION.name), DataFetcher { _Service(sdl) })
 

graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/FederatedSchemaGeneratorTest.kt

@@ -32,21 +32,36 @@ private const val FEDERATED_SDL = """schema {
   query: Query
 }
 
-#Marks target field as external meaning it will be resolved by federated schema
+"Directs the executor to include this field or fragment only when the `if` argument is true"
+directive @include(
+    "Included when true."
+    if: Boolean!
+  ) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+"Directs the executor to skip this field or fragment when the `if`'argument is true."
+directive @skip(
+    "Skipped when true."
+    if: Boolean!
+  ) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+"Marks target field as external meaning it will be resolved by federated schema"
 directive @external on FIELD_DEFINITION
 
-#Marks target object as extending part of the federated schema
+"Marks target object as extending part of the federated schema"
 directive @extends on OBJECT | INTERFACE
 
-#Specifies the base type field set that will be selectable by the gateway
+"Specifies the base type field set that will be selectable by the gateway"
 directive @provides(fields: _FieldSet!) on FIELD_DEFINITION
 
+"Marks the target field/enum value as deprecated"
+directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ENUM_VALUE
+
 directive @custom on SCHEMA | SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
 
-#Space separated list of primary keys needed to access federated object
+"Space separated list of primary keys needed to access federated object"
 directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
 
-#Specifies required input field set from the base type for a resolver
+"Specifies required input field set from the base type for a resolver"
 directive @requires(fields: _FieldSet!) on FIELD_DEFINITION
 
 interface Product @extends @key(fields : "id") {
@@ -64,15 +79,20 @@ type Book implements Product @extends @key(fields : "id") {
   weight: Float! @external
 }
 
+type CustomScalar {
+  value: String!
+}
+
 type Query @extends {
-  #Union of all types that use the @key directive, including both types native to the schema and extended types
+  "Union of all types that use the @key directive, including both types native to the schema and extended types"
   _entities(representations: [_Any!]!): [_Entity]!
   _service: _Service
 }
 
 type Review {
   body: String! @custom
   content: String @deprecated(reason : "no longer supported, replace with use Review.body instead")
+  customScalar: CustomScalar!
   id: String!
 }
 
@@ -85,20 +105,11 @@ type _Service {
   sdl: String!
 }
 
-#Federation scalar type used to represent any external entities passed to _entities query.
+"Federation scalar type used to represent any external entities passed to _entities query."
 scalar _Any
 
-#Federation type representing set of fields
-scalar _FieldSet
-
-#Directs the executor to include this field or fragment only when the `if` argument is true
-directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
-
-#Directs the executor to skip this field or fragment when the `if`'argument is true.
-directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
-
-#Marks the target field/enum value as deprecated
-directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ENUM_VALUE"""
+"Federation type representing set of fields"
+scalar _FieldSet"""
 
 class FederatedSchemaGeneratorTest {
 

graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/data/queries/federated/Product.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.federation.data.queries.federated
 
+import com.expediagroup.graphql.annotations.GraphQLDescription
 import com.expediagroup.graphql.annotations.GraphQLDirective
 import com.expediagroup.graphql.annotations.GraphQLIgnore
 import com.expediagroup.graphql.federation.directives.ExtendsDirective
@@ -59,7 +60,7 @@ class Book(
     @ExternalDirective
     var weight: Double by Delegates.notNull()
 
-    override fun reviews(): List<Review> = listOf(Review("parent-$id", "Dummy Review $id"))
+    override fun reviews(): List<Review> = listOf(Review(id = "parent-$id", body = "Dummy Review $id", content = null, customScalar = CustomScalar("foo")))
 
     @RequiresDirective(FieldSet("weight"))
     fun shippingCost(): String = "$${weight * 9.99}"
@@ -98,7 +99,8 @@ type Review {
 data class Review(
     val id: String,
     @CustomDirective val body: String,
-    @Deprecated(message = "no longer supported", replaceWith = ReplaceWith("use Review.body instead")) val content: String? = null
+    @Deprecated(message = "no longer supported", replaceWith = ReplaceWith("use Review.body instead")) val content: String? = null,
+    val customScalar: CustomScalar
 )
 
 /*
@@ -115,4 +117,11 @@ data class User(
 )
 
 @GraphQLDirective(name = "custom")
+@GraphQLDescription("""
+    This is a multi-line comment on a custom directive.
+    This should still work multiline and double quotes (") in the description.
+    Line 3.
+""")
 annotation class CustomDirective
+
+class CustomScalar(val value: String)

graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/execution/ServiceQueryResolverTest.kt

@@ -19,12 +19,20 @@ package com.expediagroup.graphql.federation.execution
 import com.expediagroup.graphql.TopLevelObject
 import com.expediagroup.graphql.federation.FederatedSchemaGeneratorConfig
 import com.expediagroup.graphql.federation.FederatedSchemaGeneratorHooks
+import com.expediagroup.graphql.federation.data.queries.federated.CustomScalar
 import com.expediagroup.graphql.federation.data.queries.simple.NestedQuery
 import com.expediagroup.graphql.federation.data.queries.simple.SimpleQuery
 import com.expediagroup.graphql.federation.toFederatedSchema
 import graphql.ExecutionInput
 import graphql.GraphQL
+import graphql.language.StringValue
+import graphql.schema.Coercing
+import graphql.schema.CoercingParseValueException
+import graphql.schema.GraphQLScalarType
+import graphql.schema.GraphQLType
 import org.junit.jupiter.api.Test
+import kotlin.reflect.KClass
+import kotlin.reflect.KType
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 
@@ -46,13 +54,21 @@ type Book implements Product @extends @key(fields : "id") {
 type Review {
   body: String!
   content: String @deprecated(reason : "no longer supported, replace with use Review.body instead")
+  customScalar: CustomScalar!
   id: String!
 }
 
 type User @extends @key(fields : "userId") {
   name: String! @external
   userId: Int! @external
-}"""
+}
+
+""${'"'}
+This is a multi-line comment on a custom scalar.
+This should still work multiline and double quotes (") in the description.
+Line 3.
+""${'"'}
+scalar CustomScalar"""
 
 const val BASE_SERVICE_SDL = """
 type Query {
@@ -69,11 +85,38 @@ type SelfReferenceObject {
 
 class ServiceQueryResolverTest {
 
+    class CustomScalarFederatedHooks : FederatedSchemaGeneratorHooks(FederatedTypeRegistry()) {
+        override fun willGenerateGraphQLType(type: KType): GraphQLType? = when (type.classifier as? KClass<*>) {
+            CustomScalar::class -> graphqlCustomScalar
+            else -> super.willGenerateGraphQLType(type)
+        }
+
+        private val graphqlCustomScalar = GraphQLScalarType.newScalar()
+            .name("CustomScalar")
+            .description("""
+                This is a multi-line comment on a custom scalar.
+                This should still work multiline and double quotes (") in the description.
+                Line 3.
+                """.trimIndent())
+            .coercing(CustomScalarCoercing()).build()
+
+        private class CustomScalarCoercing : Coercing<CustomScalar, String> {
+            override fun parseValue(input: Any?): CustomScalar = CustomScalar(serialize(input))
+
+            override fun parseLiteral(input: Any?): CustomScalar? {
+                val customValue = (input as? StringValue)?.value ?: throw CoercingParseValueException("CustomScalar value is null")
+                return CustomScalar(customValue)
+            }
+
+            override fun serialize(dataFetcherResult: Any?): String = dataFetcherResult.toString()
+        }
+    }
+
     @Test
     fun `verify can retrieve SDL using _service query`() {
         val config = FederatedSchemaGeneratorConfig(
             supportedPackages = listOf("com.expediagroup.graphql.federation.data.queries.federated"),
-            hooks = FederatedSchemaGeneratorHooks(FederatedTypeRegistry())
+            hooks = CustomScalarFederatedHooks()
         )
 
         val schema = toFederatedSchema(config = config)

graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/federation/types/ServiceTest.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.federation.types
 
+import graphql.Scalars.GraphQLString
 import graphql.schema.GraphQLNonNull
 import graphql.schema.GraphQLObjectType
 import org.junit.jupiter.api.Test
@@ -40,6 +41,6 @@ internal class ServiceTest {
 
         val fieldType = serviceObject.fieldDefinitions.first().type as? GraphQLNonNull
         assertNotNull(fieldType)
-        assertEquals(expected = "String", actual = fieldType.wrappedType.name)
+        assertEquals(expected = GraphQLString, actual = fieldType.wrappedType)
     }
 }

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/directives/KotlinDirectiveWiringFactory.kt

@@ -23,7 +23,7 @@ import graphql.schema.GraphQLCodeRegistry
 import graphql.schema.GraphQLDirective
 import graphql.schema.GraphQLDirectiveContainer
 import graphql.schema.GraphQLFieldDefinition
-import graphql.schema.GraphQLType
+import graphql.schema.GraphQLSchemaElement
 
 /**
  * Wiring factory that is used to provide the directives.
@@ -35,10 +35,10 @@ open class KotlinDirectiveWiringFactory(
     /**
      * Wire up the directive based on the GraphQL type.
      */
-    fun onWire(graphQLType: GraphQLType, coordinates: FieldCoordinates? = null, codeRegistry: GraphQLCodeRegistry.Builder? = null): GraphQLType {
-        if (graphQLType !is GraphQLDirectiveContainer) return graphQLType
+    fun onWire(graphQLSchemaElement: GraphQLSchemaElement, coordinates: FieldCoordinates? = null, codeRegistry: GraphQLCodeRegistry.Builder? = null): GraphQLSchemaElement {
+        if (graphQLSchemaElement !is GraphQLDirectiveContainer) return graphQLSchemaElement
 
-        return wireDirectives(graphQLType, coordinates, graphQLType.getAllDirectives(), codeRegistry)
+        return wireDirectives(graphQLSchemaElement, coordinates, graphQLSchemaElement.getAllDirectives(), codeRegistry)
     }
 
     /**

…ql/exceptions/CouldNotCastGraphQLType.kt …ions/CouldNotCastGraphQLSchemaElement.ktgraphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/exceptions/CouldNotCastGraphQLType.kt renamed to graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/exceptions/CouldNotCastGraphQLSchemaElement.kt graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/exceptions/CouldNotCastGraphQLType.kt renamed to graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/exceptions/CouldNotCastGraphQLSchemaElement.kt

@@ -16,11 +16,11 @@
 
 package com.expediagroup.graphql.exceptions
 
-import graphql.schema.GraphQLType
+import graphql.schema.GraphQLSchemaElement
 import kotlin.reflect.KClass
 
 /**
- * Thrown when the casting a GraphQLType to some parent type is invalid
+ * Thrown when the casting a [GraphQLSchemaElement] to some parent type is invalid
  */
-class CouldNotCastGraphQLType(type: GraphQLType, kClass: KClass<*>) :
-    GraphQLKotlinException("Could not cast GraphQLType $type to $kClass")
+class CouldNotCastGraphQLSchemaElement(graphQLSchemaElement: GraphQLSchemaElement, kClass: KClass<*>) :
+    GraphQLKotlinException("Could not cast GraphQLSchemaElement $graphQLSchemaElement to $kClass")