Expose unused definitions in SchemaParser (fix #116)

Author: oliemansm

src/main/kotlin/com/coxautodev/graphql/tools/ScannedSchemaObjects.kt

@@ -10,11 +10,12 @@ import graphql.schema.GraphQLScalarType
  * @author Andrew Potter
  */
 internal data class ScannedSchemaObjects(
-    val dictionary: TypeClassDictionary,
-    val definitions: Set<TypeDefinition<*>>,
-    val customScalars: CustomScalarMap,
-    val rootInfo: RootTypeInfo,
-    val fieldResolversByType: Map<ObjectTypeDefinition, MutableMap<FieldDefinition, FieldResolver>>
+        val dictionary: TypeClassDictionary,
+        val definitions: Set<TypeDefinition<*>>,
+        val customScalars: CustomScalarMap,
+        val rootInfo: RootTypeInfo,
+        val fieldResolversByType: Map<ObjectTypeDefinition, MutableMap<FieldDefinition, FieldResolver>>,
+        val unusedDefinitions: Set<TypeDefinition<*>>
 )
 
 internal typealias TypeClassDictionary = BiMap<TypeDefinition<*>, Class<*>>

src/main/kotlin/com/coxautodev/graphql/tools/SchemaClassScanner.kt

@@ -151,7 +151,8 @@ internal class SchemaClassScanner(initialDictionary: BiMap<String, Class<*>>, al
                     ?: provided.description, provided.coercing, listOf(), definition)
         }.associateBy { it.name!! }
 
-        (definitionsByName.values - observedDefinitions).forEach { definition ->
+        val unusedDefinitions = (definitionsByName.values - observedDefinitions).toSet()
+        unusedDefinitions.forEach { definition ->
             log.warn("Schema type was defined but can never be accessed, and can be safely deleted: ${definition.name}")
         }
 
@@ -167,7 +168,7 @@ internal class SchemaClassScanner(initialDictionary: BiMap<String, Class<*>>, al
         validateRootResolversWereUsed(rootTypeHolder.mutation, fieldResolvers)
         validateRootResolversWereUsed(rootTypeHolder.subscription, fieldResolvers)
 
-        return ScannedSchemaObjects(dictionary, observedDefinitions + extensionDefinitions, scalars, rootInfo, fieldResolversByType.toMap())
+        return ScannedSchemaObjects(dictionary, observedDefinitions + extensionDefinitions, scalars, rootInfo, fieldResolversByType.toMap(), unusedDefinitions)
     }
 
     private fun validateRootResolversWereUsed(rootType: RootType?, fieldResolvers: List<FieldResolver>) {

src/main/kotlin/com/coxautodev/graphql/tools/SchemaParser.kt

@@ -18,6 +18,7 @@ import graphql.language.ObjectTypeExtensionDefinition
 import graphql.language.ObjectValue
 import graphql.language.StringValue
 import graphql.language.Type
+import graphql.language.TypeDefinition
 import graphql.language.TypeName
 import graphql.language.UnionTypeDefinition
 import graphql.language.Value
@@ -59,13 +60,15 @@ class SchemaParser internal constructor(scanResult: ScannedSchemaObjects) {
     private val customScalars = scanResult.customScalars
     private val rootInfo = scanResult.rootInfo
     private val fieldResolversByType = scanResult.fieldResolversByType
+    private val unusedDefinitions = scanResult.unusedDefinitions
 
     private val extensionDefinitions = definitions.filterIsInstance<ObjectTypeExtensionDefinition>()
-    private val objectDefinitions = (definitions.filterIsInstance<ObjectTypeDefinition>() - extensionDefinitions)
 
+    private val objectDefinitions = (definitions.filterIsInstance<ObjectTypeDefinition>() - extensionDefinitions)
     private val inputObjectDefinitions = definitions.filterIsInstance<InputObjectTypeDefinition>()
     private val enumDefinitions = definitions.filterIsInstance<EnumTypeDefinition>()
     private val interfaceDefinitions = definitions.filterIsInstance<InterfaceTypeDefinition>()
+
     private val unionDefinitions = definitions.filterIsInstance<UnionTypeDefinition>()
 
     private val permittedTypesForObject: Set<String> = (objectDefinitions.map { it.name } +
@@ -108,6 +111,11 @@ class SchemaParser internal constructor(scanResult: ScannedSchemaObjects) {
      */
     fun makeExecutableSchema(): GraphQLSchema = parseSchemaObjects().toSchema()
 
+    /**
+     * Returns any unused type definitions that were found in the schema
+     */
+    fun getUnusedDefinitions(): Set<TypeDefinition<*>> = unusedDefinitions
+
     private fun createObject(definition: ObjectTypeDefinition, interfaces: List<GraphQLInterfaceType>): GraphQLObjectType {
         val name = definition.name
         val builder = GraphQLObjectType.newObject()