Add invalid packages exception (ExpediaGroup#793)

Co-authored-by: Shane Myrick <[email protected]>

Author: smyrick

gradle.properties

@@ -18,7 +18,7 @@ kotlinJvmVersion = 1.8
 kotlinVersion = 1.3.72
 kotlinCoroutinesVersion = 1.3.7
 
-classGraphVersion = 4.8.85
+classGraphVersion = 4.8.87
 graphQLJavaVersion = 15.0
 jacksonVersion = 2.11.0
 kotlinPoetVersion = 1.6.0

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

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2020 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 the scanned packages contain no classes
+ */
+class InvalidPackagesException(packages: List<String>) :
+    GraphQLKotlinException("The configured packages do not contain any valid classes: \"$packages\"")

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

@@ -22,4 +22,4 @@ import kotlin.reflect.KType
  * Thrown when the generator does not have a type to map to in GraphQL or in the hooks.
  */
 class TypeNotSupportedException(kType: KType, packageList: List<String>) :
-    GraphQLKotlinException("Cannot convert $kType since it is not a valid GraphQL type or outside the supported packages $packageList")
+    GraphQLKotlinException("Cannot convert $kType since it is not a valid GraphQL type or outside the supported packages \"$packageList\"")

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

@@ -18,6 +18,7 @@ package com.expediagroup.graphql.generator
 
 import com.expediagroup.graphql.SchemaGeneratorConfig
 import com.expediagroup.graphql.TopLevelObject
+import com.expediagroup.graphql.exceptions.InvalidPackagesException
 import com.expediagroup.graphql.generator.state.ClassScanner
 import com.expediagroup.graphql.generator.state.TypesCache
 import com.expediagroup.graphql.generator.types.generateGraphQLType
@@ -40,7 +41,10 @@ import kotlin.reflect.full.createType
  *
  * This class maintains the state of the schema while generation is taking place. It is passed into the internal functions
  * so they can use the cache and add additional types and directives into the schema as they parse the Kotlin code.
- */
+ *
+ * This class should be used from a try-with-resouces block
+ * or another closable object as the internals can take up a lot of resources.
+*/
 open class SchemaGenerator(internal val config: SchemaGeneratorConfig) : Closeable {
 
     internal val additionalTypes: MutableSet<KType> = mutableSetOf()
@@ -49,6 +53,15 @@ open class SchemaGenerator(internal val config: SchemaGeneratorConfig) : Closeab
     internal val codeRegistry = GraphQLCodeRegistry.newCodeRegistry()
     internal val directives = ConcurrentHashMap<String, GraphQLDirective>()
 
+    /**
+     * Validate that the supported packages contain classes
+     */
+    init {
+        if (classScanner.isEmptyScan()) {
+            throw InvalidPackagesException(config.supportedPackages)
+        }
+    }
+
     /**
      * Generate a schema given a list of objects to parse for the queries, mutations, and subscriptions.
      */
@@ -70,6 +83,7 @@ open class SchemaGenerator(internal val config: SchemaGeneratorConfig) : Closeab
         if (!config.introspectionEnabled) {
             codeRegistry.fieldVisibility(NoIntrospectionGraphqlFieldVisibility.NO_INTROSPECTION_FIELD_VISIBILITY)
         }
+
         builder.codeRegistry(codeRegistry.build())
 
         return config.hooks.willBuildSchema(builder).build()

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/state/ClassScanner.kt

@@ -23,6 +23,10 @@ import java.io.Closeable
 import kotlin.reflect.KClass
 import kotlin.reflect.jvm.jvmName
 
+/**
+ * This class should be used from a try-with-resouces block
+ * or another closable object as the internal scan result can take up a lot of resources.
+ */
 internal class ClassScanner(supportedPackages: List<String>) : Closeable {
 
     @Suppress("Detekt.SpreadOperator")
@@ -31,6 +35,14 @@ internal class ClassScanner(supportedPackages: List<String>) : Closeable {
         .whitelistPackages(*supportedPackages.toTypedArray())
         .scan()
 
+    /**
+     * Return true if there are no valid packages scanned
+     */
+    fun isEmptyScan() = scanResult.packageInfo.isEmpty()
+
+    /**
+     * Get the sub-types/implementations of specific KClass
+     */
     fun getSubTypesOf(kclass: KClass<*>): List<KClass<*>> {
         val classInfo = scanResult.getClassInfo(kclass.jvmName) ?: return emptyList()
 
@@ -40,8 +52,14 @@ internal class ClassScanner(supportedPackages: List<String>) : Closeable {
             .filterNot { it.isAbstract }
     }
 
+    /**
+     * Find any class that has the specified annotation
+     */
     fun getClassesWithAnnotation(annotation: KClass<*>) = scanResult.getClassesWithAnnotation(annotation.jvmName).map { it.loadClass().kotlin }
 
+    /**
+     * Clean up the scan result resources
+     */
     override fun close() = scanResult.close()
 
     @Suppress("Detekt.SwallowedException")

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

@@ -17,10 +17,12 @@
 package com.expediagroup.graphql.generator
 
 import com.expediagroup.graphql.SchemaGeneratorConfig
+import com.expediagroup.graphql.exceptions.InvalidPackagesException
 import com.expediagroup.graphql.extensions.deepName
 import org.junit.jupiter.api.Test
 import kotlin.reflect.KClass
 import kotlin.test.assertEquals
+import kotlin.test.assertFailsWith
 
 class SchemaGeneratorTest {
 
@@ -51,6 +53,14 @@ class SchemaGeneratorTest {
         assertEquals("SomeObjectWithAnnotation!", result.first().deepName)
     }
 
+    @Test
+    fun invalidPackagesThrowsException() {
+        assertFailsWith(InvalidPackagesException::class) {
+            val config = SchemaGeneratorConfig(listOf("foo.bar"))
+            SchemaGenerator(config)
+        }
+    }
+
     class CustomSchemaGenerator(config: SchemaGeneratorConfig) : SchemaGenerator(config) {
         internal fun addTypes(annotation: KClass<*>) = addAdditionalTypesWithAnnotation(annotation)
 

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

@@ -20,46 +20,46 @@ import com.expediagroup.graphql.defaultSupportedPackages
 import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
+import kotlin.test.assertTrue
 
-@Suppress("Detekt.UnusedPrivateClass")
-internal class ClassScannerTest {
+class ClassScannerTest {
 
-    private interface NoSubTypesInterface
+    interface NoSubTypesInterface
 
-    private abstract class NoSubTypesClass
+    abstract class NoSubTypesClass
 
-    private interface MyInterface {
+    interface MyInterface {
         fun getValue(): Int
     }
 
-    private class FirstClass : MyInterface {
+    class FirstClass : MyInterface {
         override fun getValue() = 1
     }
 
-    private class SecondClass : MyInterface {
+    class SecondClass : MyInterface {
         override fun getValue() = 2
     }
 
     @Suppress("Detekt.UnnecessaryAbstractClass")
-    private abstract class MyAbstractClass {
+    abstract class MyAbstractClass {
         abstract fun someValue(): Int
     }
 
-    private class ThirdClass : MyAbstractClass() {
+    class ThirdClass : MyAbstractClass() {
         override fun someValue() = 3
     }
 
-    private abstract class FourthClass : MyAbstractClass() {
+    abstract class FourthClass : MyAbstractClass() {
         override fun someValue() = 3
 
         abstract fun getOtherValue(): Int
     }
 
-    private annotation class SimpleAnnotation
-    private annotation class OtherSimpleAnnotation
+    annotation class SimpleAnnotation
+    annotation class OtherSimpleAnnotation
 
     @SimpleAnnotation
-    private class MyClassWithAnnotaiton
+    class MyClassWithAnnotaiton
 
     private val basicClassScanner = ClassScanner(defaultSupportedPackages)
 
@@ -78,9 +78,11 @@ internal class ClassScannerTest {
     @Test
     fun `subtypes of non-supported packages`() {
         val classScannerOfOtherPackages = ClassScanner(listOf("com.example"))
-        val list = classScannerOfOtherPackages.getSubTypesOf(MyInterface::class)
-        assertEquals(expected = 0, actual = list.size)
-        classScannerOfOtherPackages.close()
+        classScannerOfOtherPackages.use {
+            assertTrue(classScannerOfOtherPackages.isEmptyScan())
+            val list = classScannerOfOtherPackages.getSubTypesOf(MyInterface::class)
+            assertEquals(expected = 0, actual = list.size)
+        }
     }
 
     @Test