feat: accept list of package and move hooks (#39)

supportedPackages is now a list so you can pass in multiple paths
the monadResolver was moved to the hooks as it works the same was as the other hooks

Author: smyrick

src/main/kotlin/com/expedia/graphql/schema/SchemaGeneratorConfig.kt

@@ -1,19 +1,16 @@
 package com.expedia.graphql.schema
 
-import com.expedia.graphql.schema.generator.completableFutureResolver
 import com.expedia.graphql.schema.hooks.NoopSchemaGeneratorHooks
 import com.expedia.graphql.schema.hooks.SchemaGeneratorHooks
 import graphql.schema.DataFetcherFactory
-import kotlin.reflect.KType
 
 /**
  * Settings for generating the schema.
  */
 data class SchemaGeneratorConfig(
-    val supportedPackages: String,
+    val supportedPackages: List<String>,
     val topLevelQueryName: String = "TopLevelQuery",
     val topLevelMutationName: String = "TopLevelMutation",
     val hooks: SchemaGeneratorHooks = NoopSchemaGeneratorHooks(),
-    val monadResolver: (KType) -> KType = completableFutureResolver,
     val dataFetcherFactory: DataFetcherFactory<*>? = null
 )

src/main/kotlin/com/expedia/graphql/schema/exceptions/TypeNotSupportedException.kt

@@ -3,5 +3,5 @@ package com.expedia.graphql.schema.exceptions
 /**
  * Thrown when the generator does not have a type to map to in GraphQL or in the hooks.
  */
-class TypeNotSupportedException(typeName: String, packageName: String)
-    : RuntimeException("Cannot convert $typeName since it is outside the supported package $packageName")
+class TypeNotSupportedException(typeName: String, packageList: List<String>)
+    : RuntimeException("Cannot convert $typeName since it is outside the supported packages $packageList")

src/main/kotlin/com/expedia/graphql/schema/generator/SchemaGenerator.kt

@@ -143,7 +143,9 @@ internal class SchemaGenerator(
             val hookDataFetcher = config.hooks.didGenerateDataFetcher(fn, dataFetcher)
             builder.dataFetcher(hookDataFetcher)
         }
-        builder.type(graphQLTypeOf(config.monadResolver(fn.returnType)) as GraphQLOutputType)
+
+        val monadType = config.hooks.willResolveMonad(fn.returnType)
+        builder.type(graphQLTypeOf(monadType) as GraphQLOutputType)
         return builder.build()
     }
 

src/main/kotlin/com/expedia/graphql/schema/generator/TypesCache.kt

@@ -13,7 +13,7 @@ import kotlin.reflect.jvm.jvmErasure
 
 internal data class TypesCacheKey(val type: KType, val inputType: Boolean)
 
-internal class TypesCache(private val supportedPackages: String) {
+internal class TypesCache(private val supportedPackages: List<String>) {
 
     private val cache: MutableMap<String, KGraphQLType> = mutableMapOf()
 
@@ -73,7 +73,11 @@ internal class TypesCache(private val supportedPackages: String) {
     @Throws(TypeNotSupportedException::class)
     private fun throwIfTypeIsNotSupported(type: KType) {
         val qualifiedName = type.jvmErasure.qualifiedName ?: ""
-        val comesFromSupportedPackageName = qualifiedName.startsWith(supportedPackages)
+
+        val comesFromSupportedPackageName = supportedPackages.any {
+            qualifiedName.startsWith(it)
+        }
+
         if (!comesFromSupportedPackageName) {
             throw TypeNotSupportedException(qualifiedName, supportedPackages)
         }

src/main/kotlin/com/expedia/graphql/schema/generator/typeMappers.kt

@@ -4,7 +4,6 @@ import graphql.Scalars
 import graphql.schema.GraphQLType
 import java.math.BigDecimal
 import java.math.BigInteger
-import java.util.concurrent.CompletableFuture
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 
@@ -27,11 +26,3 @@ internal fun getGraphQLClassName(klass: KClass<*>, inputClass: Boolean): String?
 }
 
 private fun getInputClassName(className: String) = "${className}Input"
-
-internal val completableFutureResolver = { type: KType ->
-    if (type.classifier == CompletableFuture::class) {
-        type.arguments.firstOrNull()?.type ?: type
-    } else {
-        type
-    }
-}

src/main/kotlin/com/expedia/graphql/schema/hooks/NoopSchemaGeneratorHooks.kt

@@ -4,6 +4,7 @@ import graphql.schema.DataFetcher
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLSchema
 import graphql.schema.GraphQLType
+import java.util.concurrent.CompletableFuture
 import kotlin.reflect.KFunction
 import kotlin.reflect.KProperty
 import kotlin.reflect.KType
@@ -20,6 +21,13 @@ open class NoopSchemaGeneratorHooks : SchemaGeneratorHooks {
 
     override fun willGenerateGraphQLType(type: KType): GraphQLType? = null
 
+    override fun willResolveMonad(type: KType): KType =
+        if (type.classifier == CompletableFuture::class) {
+            type.arguments.firstOrNull()?.type ?: type
+        } else {
+            type
+        }
+
     override fun isValidProperty(property: KProperty<*>) = true
 
     override fun isValidFunction(function: KFunction<*>) = true

src/main/kotlin/com/expedia/graphql/schema/hooks/SchemaGeneratorHooks.kt

@@ -26,6 +26,12 @@ interface SchemaGeneratorHooks {
      */
     fun willGenerateGraphQLType(type: KType): GraphQLType?
 
+    /**
+     * Called before resolving a Monad or Future type to its wrapped KType.
+     * This allows for a custom resolver on how to extract the wrapped value.
+     */
+    fun willResolveMonad(type: KType): KType
+
     /**
      * Called when looking at the KClass properties to determine if it valid for adding to the generated schema.
      * If any filter returns false, it is rejected.

src/test/kotlin/com/expedia/graphql/schema/dataFetchers/CustomDataFetcherTests.kt

@@ -15,7 +15,7 @@ import kotlin.test.assertEquals
 class CustomDataFetcherTests {
     @Test
     fun `Custom DataFetcher can be used on functions`() {
-        val config = SchemaGeneratorConfig(supportedPackages = "com.expedia", dataFetcherFactory = PetDataFetcherFactory())
+        val config = SchemaGeneratorConfig(supportedPackages = listOf("com.expedia"), dataFetcherFactory = PetDataFetcherFactory())
         val schema = toSchema(listOf(TopLevelObjectDef(AnimalQuery())), config = config)
 
         val animalType = schema.getObjectType("Animal")

src/test/kotlin/com/expedia/graphql/schema/generator/SchemaGeneratorAsyncTests.kt

@@ -1,7 +1,8 @@
 package com.expedia.graphql.schema.generator
 
 import com.expedia.graphql.TopLevelObjectDef
-import com.expedia.graphql.schema.SchemaGeneratorConfig
+import com.expedia.graphql.schema.getTestSchemaConfigWithHooks
+import com.expedia.graphql.schema.hooks.NoopSchemaGeneratorHooks
 import com.expedia.graphql.schema.testSchemaConfig
 import com.expedia.graphql.toSchema
 import graphql.schema.GraphQLNonNull
@@ -15,14 +16,14 @@ import kotlin.test.assertEquals
 
 class SchemaGeneratorAsyncTests {
 
-    private val rxJavaMonadResolver: (KType) -> KType = { type ->
-        when (type.classifier) {
+    private class MonadHooks : NoopSchemaGeneratorHooks() {
+        override fun willResolveMonad(type: KType): KType = when (type.classifier) {
             Observable::class, Single::class, Maybe::class -> type.arguments.firstOrNull()?.type
             else -> type
         } ?: type
     }
-    private val testSchemaConfigWithRxJavaMonads =
-        SchemaGeneratorConfig(supportedPackages = "com.expedia", monadResolver = rxJavaMonadResolver)
+
+    private val configWithRxJavaMonads = getTestSchemaConfigWithHooks(hooks = MonadHooks())
 
     @Test
     fun `SchemaGenerator strips type argument from CompletableFuture to support async servlet`() {
@@ -34,23 +35,23 @@ class SchemaGeneratorAsyncTests {
 
     @Test
     fun `SchemaGenerator strips type argument from RxJava2 Observable`() {
-        val schema = toSchema(listOf(TopLevelObjectDef(RxJava2Query())), config = testSchemaConfigWithRxJavaMonads)
+        val schema = toSchema(listOf(TopLevelObjectDef(RxJava2Query())), config = configWithRxJavaMonads)
         val returnTypeName =
             (schema.getObjectType("TopLevelQuery").getFieldDefinition("asynchronouslyDo").type as GraphQLNonNull).wrappedType.name
         assertEquals("Int", returnTypeName)
     }
 
     @Test
     fun `SchemaGenerator strips type argument from RxJava2 Single`() {
-        val schema = toSchema(listOf(TopLevelObjectDef(RxJava2Query())), config = testSchemaConfigWithRxJavaMonads)
+        val schema = toSchema(listOf(TopLevelObjectDef(RxJava2Query())), config = configWithRxJavaMonads)
         val returnTypeName =
             (schema.getObjectType("TopLevelQuery").getFieldDefinition("asynchronouslyDoSingle").type as GraphQLNonNull).wrappedType.name
         assertEquals("Int", returnTypeName)
     }
 
     @Test
     fun `SchemaGenerator strips type argument from RxJava2 Maybe`() {
-        val schema = toSchema(listOf(TopLevelObjectDef(RxJava2Query())), config = testSchemaConfigWithRxJavaMonads)
+        val schema = toSchema(listOf(TopLevelObjectDef(RxJava2Query())), config = configWithRxJavaMonads)
         val returnTypeName =
             (schema.getObjectType("TopLevelQuery").getFieldDefinition("maybe").type as GraphQLNonNull).wrappedType.name
         assertEquals("Int", returnTypeName)

src/test/kotlin/com/expedia/graphql/schema/generator/TypesCacheTest.kt

@@ -18,7 +18,7 @@ class TypesCacheTest {
 
     @Test
     fun `basic get and put with non input type`() {
-        val cache = TypesCache("com.expedia.graphql")
+        val cache = TypesCache(listOf("com.expedia.graphql"))
         val cacheKey = TypesCacheKey(MyType::class.starProjectedType, false)
         val cacheValue = KGraphQLType(MyType::class, graphQLType)
 
@@ -31,7 +31,7 @@ class TypesCacheTest {
 
     @Test
     fun `basic get and put with input type`() {
-        val cache = TypesCache("com.expedia.graphql")
+        val cache = TypesCache(listOf("com.expedia.graphql"))
         val cacheKey = TypesCacheKey(MyType::class.starProjectedType, true)
         val cacheValue = KGraphQLType(MyType::class, graphQLType)
 
@@ -44,7 +44,7 @@ class TypesCacheTest {
 
     @Test
     fun `verify doesNotContainGraphQLType()`() {
-        val cache = TypesCache("com.expedia.graphql")
+        val cache = TypesCache(listOf("com.expedia.graphql"))
         val cacheKey = TypesCacheKey(MyType::class.starProjectedType, true)
         val cacheValue = KGraphQLType(MyType::class, graphQLType)