[generator] Only add directives with valid locations (#925)

smyrick · Shane Myrick · web-flow · commit 36b62bd333ab · 2020-10-28T23:08:54.000-05:00
* Only add directives with valid locations

* Rename function for generating enum value directives

Co-authored-by: Shane Myrick &lt;accounts@shanemyrick.com&gt;
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateArgument.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateArgument.kt
@@ -27,6 +27,7 @@ import com.expediagroup.graphql.generator.extensions.isListType
 import com.expediagroup.graphql.generator.extensions.isUnion
 import com.expediagroup.graphql.generator.extensions.safeCast
 import com.expediagroup.graphql.generator.extensions.unwrapOptionalInputType
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLArgument
 import kotlin.reflect.KClass
 import kotlin.reflect.KParameter
@@ -54,7 +55,7 @@ internal fun generateArgument(generator: SchemaGenerator, parameter: KParameter)
         .description(parameter.getGraphQLDescription())
         .type(graphQLType.safeCast())
 
-    generateDirectives(generator, parameter).forEach {
+    generateDirectives(generator, parameter, DirectiveLocation.ARGUMENT_DEFINITION).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateDirective.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateDirective.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.generator.extensions.getPropertyAnnotations
 import com.expediagroup.graphql.generator.extensions.getSimpleName
 import com.expediagroup.graphql.generator.extensions.getValidProperties
 import com.expediagroup.graphql.generator.extensions.safeCast
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLArgument
 import graphql.schema.GraphQLDirective
 import java.lang.reflect.Field
@@ -29,20 +30,27 @@ import kotlin.reflect.KClass
 import kotlin.reflect.KProperty
 import com.expediagroup.graphql.annotations.GraphQLDirective as GraphQLDirectiveAnnotation
 
-internal fun generateDirectives(generator: SchemaGenerator, element: KAnnotatedElement, parentClass: KClass<*>? = null): List<GraphQLDirective> {
+internal fun generateDirectives(
+    generator: SchemaGenerator,
+    element: KAnnotatedElement,
+    location: DirectiveLocation,
+    parentClass: KClass<*>? = null
+): List<GraphQLDirective> {
     val annotations = when {
         element is KProperty<*> && parentClass != null -> element.getPropertyAnnotations(parentClass)
         else -> element.annotations
     }
 
     return annotations
         .mapNotNull { it.getDirectiveInfo() }
+        .filter { it.directiveAnnotation.locations.contains(location) }
         .map { getDirective(generator, it) }
 }
 
-internal fun generateFieldDirectives(generator: SchemaGenerator, field: Field): List<GraphQLDirective> =
+internal fun generateEnumValueDirectives(generator: SchemaGenerator, field: Field): List<GraphQLDirective> =
     field.annotations
         .mapNotNull { it.getDirectiveInfo() }
+        .filter { it.directiveAnnotation.locations.contains(DirectiveLocation.ENUM_VALUE) }
         .map { getDirective(generator, it) }
 
 private fun getDirective(generator: SchemaGenerator, directiveInfo: DirectiveInfo): GraphQLDirective {
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateEnum.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateEnum.kt
@@ -23,6 +23,7 @@ import com.expediagroup.graphql.generator.extensions.getGraphQLDescription
 import com.expediagroup.graphql.generator.extensions.getGraphQLName
 import com.expediagroup.graphql.generator.extensions.getSimpleName
 import com.expediagroup.graphql.generator.extensions.safeCast
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLEnumType
 import graphql.schema.GraphQLEnumValueDefinition
 import kotlin.reflect.KClass
@@ -33,7 +34,7 @@ internal fun generateEnum(generator: SchemaGenerator, kClass: KClass<out Enum<*>
     enumBuilder.name(kClass.getSimpleName())
     enumBuilder.description(kClass.getGraphQLDescription())
 
-    generateDirectives(generator, kClass).forEach {
+    generateDirectives(generator, kClass, DirectiveLocation.ENUM).forEach {
         enumBuilder.withDirective(it)
     }
 
@@ -51,7 +52,7 @@ private fun getEnumValueDefinition(generator: SchemaGenerator, enum: Enum<*>, kC
     valueBuilder.name(name)
     valueBuilder.value(name)
 
-    generateFieldDirectives(generator, valueField).forEach {
+    generateEnumValueDirectives(generator, valueField).forEach {
         valueBuilder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateFunction.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateFunction.kt
@@ -24,6 +24,7 @@ import com.expediagroup.graphql.generator.extensions.getGraphQLDescription
 import com.expediagroup.graphql.generator.extensions.getValidArguments
 import com.expediagroup.graphql.generator.extensions.safeCast
 import com.expediagroup.graphql.generator.types.utils.getWrappedReturnType
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.FieldCoordinates
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLOutputType
@@ -40,7 +41,7 @@ internal fun generateFunction(generator: SchemaGenerator, fn: KFunction<*>, pare
         builder.withDirective(deprecatedDirectiveWithReason(it))
     }
 
-    generateDirectives(generator, fn).forEach {
+    generateDirectives(generator, fn, DirectiveLocation.FIELD_DEFINITION).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateInputObject.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateInputObject.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.generator.extensions.getGraphQLDescription
 import com.expediagroup.graphql.generator.extensions.getSimpleName
 import com.expediagroup.graphql.generator.extensions.getValidProperties
 import com.expediagroup.graphql.generator.extensions.safeCast
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLInputObjectType
 import kotlin.reflect.KClass
 
@@ -30,7 +31,7 @@ internal fun generateInputObject(generator: SchemaGenerator, kClass: KClass<*>):
     builder.name(kClass.getSimpleName(isInputClass = true))
     builder.description(kClass.getGraphQLDescription())
 
-    generateDirectives(generator, kClass).forEach {
+    generateDirectives(generator, kClass, DirectiveLocation.INPUT_OBJECT).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateInputProperty.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateInputProperty.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.generator.extensions.getPropertyDescription
 import com.expediagroup.graphql.generator.extensions.getPropertyName
 import com.expediagroup.graphql.generator.extensions.safeCast
 import com.expediagroup.graphql.generator.extensions.unwrapOptionalInputType
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLInputObjectField
 import graphql.schema.GraphQLInputType
 import kotlin.reflect.KClass
@@ -38,7 +39,7 @@ internal fun generateInputProperty(generator: SchemaGenerator, prop: KProperty<*
     builder.name(prop.getPropertyName(parentClass))
     builder.type(graphQLInputType)
 
-    generateDirectives(generator, prop, parentClass).forEach {
+    generateDirectives(generator, prop, DirectiveLocation.INPUT_FIELD_DEFINITION, parentClass).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateInterface.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateInterface.kt
@@ -26,6 +26,7 @@ import com.expediagroup.graphql.generator.extensions.getValidSuperclasses
 import com.expediagroup.graphql.generator.extensions.safeCast
 import com.expediagroup.graphql.generator.state.AdditionalType
 import graphql.TypeResolutionEnvironment
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLInterfaceType
 import graphql.schema.GraphQLTypeReference
 import kotlin.reflect.KClass
@@ -37,7 +38,7 @@ internal fun generateInterface(generator: SchemaGenerator, kClass: KClass<*>): G
     builder.name(kClass.getSimpleName())
     builder.description(kClass.getGraphQLDescription())
 
-    generateDirectives(generator, kClass).forEach {
+    generateDirectives(generator, kClass, DirectiveLocation.INTERFACE).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateMutation.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateMutation.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.exceptions.InvalidMutationTypeException
 import com.expediagroup.graphql.generator.SchemaGenerator
 import com.expediagroup.graphql.generator.extensions.getValidFunctions
 import com.expediagroup.graphql.generator.extensions.isNotPublic
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLObjectType
 
 internal fun generateMutations(generator: SchemaGenerator, mutations: List<TopLevelObject>): GraphQLObjectType? {
@@ -37,7 +38,7 @@ internal fun generateMutations(generator: SchemaGenerator, mutations: List<TopLe
             throw InvalidMutationTypeException(mutation.kClass)
         }
 
-        generateDirectives(generator, mutation.kClass).forEach {
+        generateDirectives(generator, mutation.kClass, DirectiveLocation.OBJECT).forEach {
             mutationBuilder.withDirective(it)
         }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateObject.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateObject.kt
@@ -24,6 +24,7 @@ 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.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLInterfaceType
 import graphql.schema.GraphQLObjectType
 import graphql.schema.GraphQLTypeReference
@@ -37,7 +38,7 @@ internal fun generateObject(generator: SchemaGenerator, kClass: KClass<*>): Grap
     builder.name(name)
     builder.description(kClass.getGraphQLDescription())
 
-    generateDirectives(generator, kClass).forEach {
+    generateDirectives(generator, kClass, DirectiveLocation.OBJECT).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateProperty.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateProperty.kt
@@ -23,6 +23,7 @@ import com.expediagroup.graphql.generator.extensions.getPropertyDescription
 import com.expediagroup.graphql.generator.extensions.getPropertyName
 import com.expediagroup.graphql.generator.extensions.getSimpleName
 import com.expediagroup.graphql.generator.extensions.safeCast
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.FieldCoordinates
 import graphql.schema.GraphQLFieldDefinition
 import graphql.schema.GraphQLOutputType
@@ -45,7 +46,7 @@ internal fun generateProperty(generator: SchemaGenerator, prop: KProperty<*>, pa
         fieldBuilder.withDirective(deprecatedDirectiveWithReason(it))
     }
 
-    generateDirectives(generator, prop, parentClass).forEach {
+    generateDirectives(generator, prop, DirectiveLocation.FIELD_DEFINITION, parentClass).forEach {
         fieldBuilder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateQuery.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateQuery.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.exceptions.InvalidQueryTypeException
 import com.expediagroup.graphql.generator.SchemaGenerator
 import com.expediagroup.graphql.generator.extensions.getValidFunctions
 import com.expediagroup.graphql.generator.extensions.isNotPublic
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLObjectType
 
 internal fun generateQueries(generator: SchemaGenerator, queries: List<TopLevelObject>): GraphQLObjectType {
@@ -32,7 +33,7 @@ internal fun generateQueries(generator: SchemaGenerator, queries: List<TopLevelO
             throw InvalidQueryTypeException(query.kClass)
         }
 
-        generateDirectives(generator, query.kClass).forEach {
+        generateDirectives(generator, query.kClass, DirectiveLocation.OBJECT).forEach {
             queryBuilder.withDirective(it)
         }
 
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateSubscription.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateSubscription.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.exceptions.InvalidSubscriptionTypeException
 import com.expediagroup.graphql.generator.SchemaGenerator
 import com.expediagroup.graphql.generator.extensions.getValidFunctions
 import com.expediagroup.graphql.generator.extensions.isNotPublic
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLObjectType
 
 internal fun generateSubscriptions(generator: SchemaGenerator, subscriptions: List<TopLevelObject>): GraphQLObjectType? {
@@ -38,6 +39,10 @@ internal fun generateSubscriptions(generator: SchemaGenerator, subscriptions: Li
             throw InvalidSubscriptionTypeException(kClass)
         }
 
+        generateDirectives(generator, subscription.kClass, DirectiveLocation.OBJECT).forEach {
+            subscriptionBuilder.withDirective(it)
+        }
+
         kClass.getValidFunctions(generator.config.hooks)
             .forEach {
                 if (generator.config.hooks.isValidSubscriptionReturnType(kClass, it).not()) {
diff --git a/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateUnion.kt b/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/types/generateUnion.kt
@@ -22,6 +22,7 @@ import com.expediagroup.graphql.generator.extensions.getGraphQLDescription
 import com.expediagroup.graphql.generator.extensions.getSimpleName
 import com.expediagroup.graphql.generator.extensions.safeCast
 import graphql.TypeResolutionEnvironment
+import graphql.introspection.Introspection.DirectiveLocation
 import graphql.schema.GraphQLObjectType
 import graphql.schema.GraphQLTypeReference
 import graphql.schema.GraphQLUnionType
@@ -33,7 +34,7 @@ internal fun generateUnion(generator: SchemaGenerator, kClass: KClass<*>): Graph
     builder.name(kClass.getSimpleName())
     builder.description(kClass.getGraphQLDescription())
 
-    generateDirectives(generator, kClass).forEach {
+    generateDirectives(generator, kClass, DirectiveLocation.UNION).forEach {
         builder.withDirective(it)
     }
 
diff --git a/graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/types/GenerateDirectiveTest.kt b/graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/types/GenerateDirectiveTest.kt
diff --git a/graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/types/GenerateSubscriptionTest.kt b/graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/types/GenerateSubscriptionTest.kt

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ import com.expediagroup.graphql.generator.extensions.getGraphQLDescription`
`24`	`24`	`import com.expediagroup.graphql.generator.extensions.getValidArguments`
`25`	`25`	`import com.expediagroup.graphql.generator.extensions.safeCast`
`26`	`26`	`import com.expediagroup.graphql.generator.types.utils.getWrappedReturnType`
	`27`	`+import graphql.introspection.Introspection.DirectiveLocation`
`27`	`28`	`import graphql.schema.FieldCoordinates`
`28`	`29`	`import graphql.schema.GraphQLFieldDefinition`
`29`	`30`	`import graphql.schema.GraphQLOutputType`
`@@ -40,7 +41,7 @@ internal fun generateFunction(generator: SchemaGenerator, fn: KFunction<*>, pare`
`40`	`41`	`builder.withDirective(deprecatedDirectiveWithReason(it))`
`41`	`42`	`}`
`42`	`43`
`43`		`- generateDirectives(generator, fn).forEach {`
	`44`	`+ generateDirectives(generator, fn, DirectiveLocation.FIELD_DEFINITION).forEach {`
`44`	`45`	`builder.withDirective(it)`
`45`	`46`	`}`
`46`	`47`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import com.expediagroup.graphql.exceptions.InvalidMutationTypeException`
`21`	`21`	`import com.expediagroup.graphql.generator.SchemaGenerator`
`22`	`22`	`import com.expediagroup.graphql.generator.extensions.getValidFunctions`
`23`	`23`	`import com.expediagroup.graphql.generator.extensions.isNotPublic`
	`24`	`+import graphql.introspection.Introspection.DirectiveLocation`
`24`	`25`	`import graphql.schema.GraphQLObjectType`
`25`	`26`
`26`	`27`	`internal fun generateMutations(generator: SchemaGenerator, mutations: List<TopLevelObject>): GraphQLObjectType? {`
`@@ -37,7 +38,7 @@ internal fun generateMutations(generator: SchemaGenerator, mutations: List<TopLe`
`37`	`38`	`throw InvalidMutationTypeException(mutation.kClass)`
`38`	`39`	`}`
`39`	`40`
`40`		`- generateDirectives(generator, mutation.kClass).forEach {`
	`41`	`+ generateDirectives(generator, mutation.kClass, DirectiveLocation.OBJECT).forEach {`
`41`	`42`	`mutationBuilder.withDirective(it)`
`42`	`43`	`}`
`43`	`44`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ import com.expediagroup.graphql.generator.extensions.getPropertyDescription`
`23`	`23`	`import com.expediagroup.graphql.generator.extensions.getPropertyName`
`24`	`24`	`import com.expediagroup.graphql.generator.extensions.getSimpleName`
`25`	`25`	`import com.expediagroup.graphql.generator.extensions.safeCast`
	`26`	`+import graphql.introspection.Introspection.DirectiveLocation`
`26`	`27`	`import graphql.schema.FieldCoordinates`
`27`	`28`	`import graphql.schema.GraphQLFieldDefinition`
`28`	`29`	`import graphql.schema.GraphQLOutputType`
`@@ -45,7 +46,7 @@ internal fun generateProperty(generator: SchemaGenerator, prop: KProperty<*>, pa`
`45`	`46`	`fieldBuilder.withDirective(deprecatedDirectiveWithReason(it))`
`46`	`47`	`}`
`47`	`48`
`48`		`- generateDirectives(generator, prop, parentClass).forEach {`
	`49`	`+ generateDirectives(generator, prop, DirectiveLocation.FIELD_DEFINITION, parentClass).forEach {`
`49`	`50`	`fieldBuilder.withDirective(it)`
`50`	`51`	`}`
`51`	`52`