Throw exception on multi-level interface (#420)

* Throw exception on multi-level interface

Resolves #419

According to the spec, an interface can not implement another interface. This is not caught by our schema generator but instead just returns the first level interface as the type in the schema. We are now throwing an exception to help translate this understanding of GraphQL through the Kotlin code

* Return superclasses from multiple levels deep

Author: smyrick

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/exceptions/InvalidInterfaceException.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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.exceptions
+
+/**
+ * Thrown when a interface implements another interface or abstract class that is not exluded from the schema.
+ *
+ * This is an invalid schema until the GraphQL spec is updated
+ * https://github.com/ExpediaGroup/graphql-kotlin/issues/419
+ */
+class InvalidInterfaceException : GraphQLKotlinException("Interfaces can not have any superclasses")

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/extensions/kClassExtensions.kt

@@ -51,6 +51,9 @@ internal fun KClass<*>.getValidSuperclasses(hooks: SchemaGeneratorHooks): List<K
     this.superclasses
         .filter { hooks.isValidSuperclass(it) }
         .filter { kClass -> superclassFilters.all { it.invoke(kClass) } }
+        .ifEmpty {
+            this.superclasses.flatMap { it.getValidSuperclasses(hooks) }
+        }
 
 internal fun KClass<*>.findConstructorParamter(name: String): KParameter? =
     this.primaryConstructor?.findParameterByName(name)

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/filters/superclassFilters.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.generator.filters
 
+import com.expediagroup.graphql.generator.extensions.isGraphQLIgnored
 import com.expediagroup.graphql.generator.extensions.isInterface
 import com.expediagroup.graphql.generator.extensions.isPublic
 import com.expediagroup.graphql.generator.extensions.isUnion
@@ -26,5 +27,6 @@ private typealias SuperclassFilter = (KClass<*>) -> Boolean
 private val isPublic: SuperclassFilter = { it.isPublic() }
 private val isInterface: SuperclassFilter = { it.isInterface() }
 private val isNotUnion: SuperclassFilter = { it.isUnion().not() }
+private val isNotIgnored: SuperclassFilter = { it.isGraphQLIgnored().not() }
 
-internal val superclassFilters: List<SuperclassFilter> = listOf(isPublic, isInterface, isNotUnion)
+internal val superclassFilters: List<SuperclassFilter> = listOf(isPublic, isInterface, isNotUnion, isNotIgnored)

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/InterfaceBuilder.kt

@@ -16,12 +16,14 @@
 
 package com.expediagroup.graphql.generator.types
 
+import com.expediagroup.graphql.exceptions.InvalidInterfaceException
 import com.expediagroup.graphql.generator.SchemaGenerator
 import com.expediagroup.graphql.generator.TypeBuilder
 import com.expediagroup.graphql.generator.extensions.getGraphQLDescription
 import com.expediagroup.graphql.generator.extensions.getSimpleName
 import com.expediagroup.graphql.generator.extensions.getValidFunctions
 import com.expediagroup.graphql.generator.extensions.getValidProperties
+import com.expediagroup.graphql.generator.extensions.getValidSuperclasses
 import com.expediagroup.graphql.generator.extensions.safeCast
 import graphql.TypeResolutionEnvironment
 import graphql.schema.GraphQLInterfaceType
@@ -34,6 +36,12 @@ import kotlin.reflect.full.createType
 internal class InterfaceBuilder(generator: SchemaGenerator) : TypeBuilder(generator) {
     internal fun interfaceType(kClass: KClass<*>): GraphQLType {
         return state.cache.buildIfNotUnderConstruction(kClass) {
+
+            // Interfaces can not implement another interface in GraphQL
+            if (kClass.getValidSuperclasses(config.hooks).isNotEmpty()) {
+                throw InvalidInterfaceException()
+            }
+
             val builder = GraphQLInterfaceType.newInterface()
 
             builder.name(kClass.getSimpleName())

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

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.generator.extensions
 
+import com.expediagroup.graphql.annotations.GraphQLIgnore
 import com.expediagroup.graphql.annotations.GraphQLName
 import com.expediagroup.graphql.exceptions.CouldNotGetNameOfKClassException
 import com.expediagroup.graphql.hooks.NoopSchemaGeneratorHooks
@@ -83,6 +84,38 @@ open class KClassExtensionsTest {
 
     internal class UnionSuperclass : TestInterface
 
+    @GraphQLIgnore
+    internal interface IgnoredInterface {
+        val id: String
+    }
+
+    @GraphQLIgnore
+    interface IgnoredSecondLevelInterface : SomeInterface
+
+    internal class ClassWithSecondLevelInterface : IgnoredSecondLevelInterface {
+        override val someField: String = "hello"
+
+        override fun someFunction(): String? = null
+    }
+
+    @GraphQLIgnore
+    abstract class IgnoredAbstractClass : SomeInterface
+
+    @GraphQLIgnore
+    abstract class IgnoredSecondAbstractClass : IgnoredAbstractClass()
+
+    internal class ClassWithNoValidSuperclass(override val id: String) : IgnoredInterface
+
+    internal class ClassWithSecondLevelAbstractClass : IgnoredAbstractClass() {
+        override val someField: String = "foo"
+        override fun someFunction(): String? = "bar"
+    }
+
+    internal class ClassWithThirdLevelAbstractClass : IgnoredSecondAbstractClass() {
+        override val someField: String = "foo"
+        override fun someFunction(): String? = "bar"
+    }
+
     internal class InterfaceSuperclass : InvalidFunctionUnionInterface {
         override fun getTest() = 2
     }
@@ -175,6 +208,30 @@ open class KClassExtensionsTest {
         assertTrue(superclasses.isEmpty())
     }
 
+    @Test
+    fun `Superclasses are not included when marked as ignored`() {
+        val superclasses = ClassWithNoValidSuperclass::class.getValidSuperclasses(noopHooks)
+        assertTrue(superclasses.isEmpty())
+    }
+
+    @Test
+    fun `Return superclasses from abstract class two levels deep`() {
+        val superclasses = ClassWithSecondLevelAbstractClass::class.getValidSuperclasses(noopHooks)
+        assertEquals(expected = 1, actual = superclasses.size)
+    }
+
+    @Test
+    fun `Return superclasses from abstract class three levels deep`() {
+        val superclasses = ClassWithThirdLevelAbstractClass::class.getValidSuperclasses(noopHooks)
+        assertEquals(expected = 1, actual = superclasses.size)
+    }
+
+    @Test
+    fun `Return superclasses from interface two levels deep`() {
+        val superclasses = ClassWithSecondLevelInterface::class.getValidSuperclasses(noopHooks)
+        assertEquals(expected = 1, actual = superclasses.size)
+    }
+
     @Test
     fun `test findConstructorParamter`() {
         assertNotNull(MyTestClass::class.findConstructorParamter("publicProperty"))

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

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 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.test.integration
+
+import com.expediagroup.graphql.TopLevelObject
+import com.expediagroup.graphql.exceptions.InvalidInterfaceException
+import com.expediagroup.graphql.testSchemaConfig
+import com.expediagroup.graphql.toSchema
+import org.junit.jupiter.api.Test
+import kotlin.test.assertFailsWith
+
+class InterfaceOfInterfaceTest {
+
+    @Test
+    fun `interface of interface`() {
+        val queries = listOf(TopLevelObject(InterfaceOfInterfaceQuery()))
+
+        assertFailsWith(InvalidInterfaceException::class) {
+            toSchema(queries = queries, config = testSchemaConfig)
+        }
+    }
+
+    interface FirstLevel {
+        val id: String
+    }
+
+    interface SecondLevel : FirstLevel {
+        val name: String
+    }
+
+    class MyClass(override val id: String, override val name: String) : SecondLevel
+
+    class InterfaceOfInterfaceQuery {
+        fun getClass() = MyClass(id = "1", name = "fooBar")
+    }
+}