feat: allow renaming of properties and functions (ExpediaGroup#272)

Use @GraphQLName to set the name of fields in the schema, not just type names

Author: smyrick

graphql-kotlin-schema-generator/src/main/kotlin/com/expedia/graphql/annotations/GraphQLName.kt

@@ -3,5 +3,5 @@ package com.expedia.graphql.annotations
 /**
  * Set the GraphQL name to be picked up by the schema generator.
  */
-@Target(AnnotationTarget.CLASS)
+@Target(AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION)
 annotation class GraphQLName(val value: String)

graphql-kotlin-schema-generator/src/main/kotlin/com/expedia/graphql/generator/extensions/kCallableExtensions.kt

@@ -4,3 +4,5 @@ import kotlin.reflect.KCallable
 import kotlin.reflect.KVisibility
 
 internal fun KCallable<*>.isPublic(): Boolean = this.visibility == KVisibility.PUBLIC
+
+internal fun KCallable<*>.getFunctionName(): String = this.getGraphQLName() ?: this.name

graphql-kotlin-schema-generator/src/main/kotlin/com/expedia/graphql/generator/extensions/kPropertyExtensions.kt

@@ -21,4 +21,7 @@ internal fun KProperty<*>.getPropertyDeprecationReason(parentClass: KClass<*>):
 internal fun KProperty<*>.getPropertyDescription(parentClass: KClass<*>): String? =
     this.getGraphQLDescription() ?: getConstructorParameter(parentClass)?.getGraphQLDescription()
 
+internal fun KProperty<*>.getPropertyName(parentClass: KClass<*>): String? =
+    this.getGraphQLName() ?: getConstructorParameter(parentClass)?.getGraphQLName() ?: this.name
+
 private fun KProperty<*>.getConstructorParameter(parentClass: KClass<*>) = parentClass.findConstructorParamter(this.name)

graphql-kotlin-schema-generator/src/main/kotlin/com/expedia/graphql/generator/types/FunctionBuilder.kt

@@ -5,6 +5,7 @@ import com.expedia.graphql.exceptions.InvalidInputFieldTypeException
 import com.expedia.graphql.generator.SchemaGenerator
 import com.expedia.graphql.generator.TypeBuilder
 import com.expedia.graphql.generator.extensions.getDeprecationReason
+import com.expedia.graphql.generator.extensions.getFunctionName
 import com.expedia.graphql.generator.extensions.getGraphQLDescription
 import com.expedia.graphql.generator.extensions.getKClass
 import com.expedia.graphql.generator.extensions.getName
@@ -30,7 +31,8 @@ internal class FunctionBuilder(generator: SchemaGenerator) : TypeBuilder(generat
 
     internal fun function(fn: KFunction<*>, parentName: String, target: Any? = null, abstract: Boolean = false): GraphQLFieldDefinition {
         val builder = GraphQLFieldDefinition.newFieldDefinition()
-        builder.name(fn.name)
+        val functionName = fn.getFunctionName()
+        builder.name(functionName)
         builder.description(fn.getGraphQLDescription())
 
         fn.getDeprecationReason()?.let {
@@ -56,7 +58,7 @@ internal class FunctionBuilder(generator: SchemaGenerator) : TypeBuilder(generat
         builder.type(graphQLTypeOf(returnType).safeCast<GraphQLOutputType>())
         val graphQLType = builder.build()
 
-        val coordinates = FieldCoordinates.coordinates(parentName, fn.name)
+        val coordinates = FieldCoordinates.coordinates(parentName, functionName)
         if (!abstract) {
             val dataFetcherFactory = config.dataFetcherFactoryProvider.functionDataFetcherFactory(target = target, kFunction = fn)
             generator.codeRegistry.dataFetcher(coordinates, dataFetcherFactory)

graphql-kotlin-schema-generator/src/main/kotlin/com/expedia/graphql/generator/types/InputObjectBuilder.kt

@@ -4,6 +4,7 @@ import com.expedia.graphql.generator.SchemaGenerator
 import com.expedia.graphql.generator.TypeBuilder
 import com.expedia.graphql.generator.extensions.getGraphQLDescription
 import com.expedia.graphql.generator.extensions.getPropertyDescription
+import com.expedia.graphql.generator.extensions.getPropertyName
 import com.expedia.graphql.generator.extensions.getSimpleName
 import com.expedia.graphql.generator.extensions.getValidProperties
 import com.expedia.graphql.generator.extensions.isPropertyGraphQLID
@@ -36,7 +37,7 @@ internal class InputObjectBuilder(generator: SchemaGenerator) : TypeBuilder(gene
         val builder = GraphQLInputObjectField.newInputObjectField()
 
         builder.description(prop.getPropertyDescription(parentClass))
-        builder.name(prop.name)
+        builder.name(prop.getPropertyName(parentClass))
         builder.type(graphQLTypeOf(prop.returnType, true, prop.isPropertyGraphQLID(parentClass)).safeCast<GraphQLInputType>())
 
         generator.directives(prop).forEach {

graphql-kotlin-schema-generator/src/main/kotlin/com/expedia/graphql/generator/types/PropertyBuilder.kt

@@ -5,6 +5,7 @@ import com.expedia.graphql.generator.SchemaGenerator
 import com.expedia.graphql.generator.TypeBuilder
 import com.expedia.graphql.generator.extensions.getPropertyDeprecationReason
 import com.expedia.graphql.generator.extensions.getPropertyDescription
+import com.expedia.graphql.generator.extensions.getPropertyName
 import com.expedia.graphql.generator.extensions.getSimpleName
 import com.expedia.graphql.generator.extensions.isPropertyGraphQLID
 import com.expedia.graphql.generator.extensions.safeCast
@@ -21,7 +22,7 @@ internal class PropertyBuilder(generator: SchemaGenerator) : TypeBuilder(generat
 
         val fieldBuilder = GraphQLFieldDefinition.newFieldDefinition()
             .description(prop.getPropertyDescription(parentClass))
-            .name(prop.name)
+            .name(prop.getPropertyName(parentClass))
             .type(propertyType)
 
         prop.getPropertyDeprecationReason(parentClass)?.let {

graphql-kotlin-schema-generator/src/test/kotlin/com/expedia/graphql/extensions/GraphQLSchemaExtensionsTest.kt

@@ -43,11 +43,13 @@ class GraphQLSchemaExtensionsTest {
     }
 
     class RenamedQuery {
+        @GraphQLName("renamedFunction")
         fun original(id: Int) = OriginalType(id)
     }
 
     @GraphQLName("RenamedType")
     class OriginalType(
+        @GraphQLName("renamedProperty")
         val originalProperty: Int
     )
 
@@ -58,11 +60,11 @@ class GraphQLSchemaExtensionsTest {
         val sdl = schema.print(includeDefaultSchemaDefinition = false, includeDirectives = false).trim()
         val expected = """
             type Query {
-              original(id: Int!): RenamedType!
+              renamedFunction(id: Int!): RenamedType!
             }
 
             type RenamedType {
-              originalProperty: Int!
+              renamedProperty: Int!
             }
         """.trimIndent()
         assertEquals(expected, sdl)

graphql-kotlin-schema-generator/src/test/kotlin/com/expedia/graphql/generator/extensions/AnnotationExtensionsTest.kt

@@ -5,6 +5,7 @@ import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
 import com.expedia.graphql.annotations.GraphQLName
 import org.junit.jupiter.api.Test
+import kotlin.reflect.KClass
 import kotlin.reflect.full.declaredMemberProperties
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
@@ -22,6 +23,7 @@ internal class AnnotationExtensionsTest {
         @property:Deprecated("property deprecated")
         @property:GraphQLDescription("property description")
         @property:GraphQLID
+        @property:GraphQLName("newName")
         val id: String
     )
 
@@ -33,6 +35,13 @@ internal class AnnotationExtensionsTest {
         assertNull(NoAnnotations::class.getGraphQLName())
     }
 
+    @Test
+    fun `verify @GraphQLName on fields`() {
+        val fieldName = WithAnnotations::class.findMemberProperty("id")?.getGraphQLName()
+        assertEquals(expected = "newName", actual = fieldName)
+        assertNull(NoAnnotations::class.findMemberProperty("id")?.getGraphQLName())
+    }
+
     @Test
     fun `verify @GraphQLDescrption on classes`() {
         assertEquals(expected = "class description", actual = WithAnnotations::class.getGraphQLDescription())
@@ -42,11 +51,12 @@ internal class AnnotationExtensionsTest {
     @Test
     fun `verify @Deprecated`() {
         val classDeprecation = WithAnnotations::class.getDeprecationReason()
-        val classPropertyDeprecation = WithAnnotations::class.declaredMemberProperties.find { it.name == "id" }?.getDeprecationReason()
+        val classPropertyDeprecation = WithAnnotations::class.findMemberProperty("id")?.getDeprecationReason()
 
         assertEquals(expected = "class deprecated", actual = classDeprecation)
         assertEquals(expected = "property deprecated", actual = classPropertyDeprecation)
         assertNull(NoAnnotations::class.getDeprecationReason())
+        assertNull(NoAnnotations::class.findMemberProperty("id")?.getDeprecationReason())
     }
 
     @Test
@@ -57,9 +67,11 @@ internal class AnnotationExtensionsTest {
 
     @Test
     fun `verify @GraphQLID`() {
-        val id = WithAnnotations::class.declaredMemberProperties.find { it.name == "id" }
-        val notId = NoAnnotations::class.declaredMemberProperties.find { it.name == "id" }
+        val id = WithAnnotations::class.findMemberProperty("id")
+        val notId = NoAnnotations::class.findMemberProperty("id")
         assertTrue { id?.isGraphQLID().isTrue() }
         assertFalse { notId?.isGraphQLID().isTrue() }
     }
+
+    private fun KClass<*>.findMemberProperty(name: String) = this.declaredMemberProperties.find { it.name == name }
 }

graphql-kotlin-schema-generator/src/test/kotlin/com/expedia/graphql/generator/extensions/KCallableExtensionsKtTest.kt

@@ -1,7 +1,9 @@
 package com.expedia.graphql.generator.extensions
 
+import com.expedia.graphql.annotations.GraphQLName
 import org.junit.jupiter.api.Test
 import kotlin.reflect.full.functions
+import kotlin.test.assertEquals
 import kotlin.test.assertFalse
 import kotlin.test.assertTrue
 
@@ -16,6 +18,9 @@ internal class KCallableExtensionsKtTest {
         internal fun internal() = 3
 
         private fun private() = 4
+
+        @GraphQLName("renamedFunction")
+        fun originalName() = 1
     }
 
     @Test
@@ -25,4 +30,10 @@ internal class KCallableExtensionsKtTest {
         assertFalse(MyTestClass::class.functions.find { it.name == "protected" }?.isPublic().isTrue())
         assertFalse(MyTestClass::class.functions.find { it.name == "private" }?.isPublic().isTrue())
     }
+
+    @Test
+    fun graphQLName() {
+        assertEquals(expected = "renamedFunction", actual = MyTestClass::originalName.getFunctionName())
+        assertEquals(expected = "public", actual = MyTestClass::public.getFunctionName())
+    }
 }

graphql-kotlin-schema-generator/src/test/kotlin/com/expedia/graphql/generator/extensions/KPropertyExtensionsKtTest.kt

@@ -3,6 +3,7 @@ package com.expedia.graphql.generator.extensions
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
+import com.expedia.graphql.annotations.GraphQLName
 import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
@@ -18,12 +19,14 @@ internal class KPropertyExtensionsKtTest {
         @property:GraphQLDescription("property description")
         @property:GraphQLID
         @property:GraphQLIgnore
+        @property:GraphQLName("nameOnProperty")
         val propertyAnnotation: String,
 
         @Deprecated("constructor deprecated")
         @GraphQLDescription("constructor description")
         @GraphQLID
         @GraphQLIgnore
+        @GraphQLName("nameOnConstructor")
         val constructorAnnotation: String,
 
         val noAnnotations: String
@@ -56,4 +59,11 @@ internal class KPropertyExtensionsKtTest {
         assertEquals("constructor description", MyDataClass::constructorAnnotation.getPropertyDescription(MyDataClass::class))
         assertEquals(null, MyDataClass::noAnnotations.getPropertyDescription(MyDataClass::class))
     }
+
+    @Test
+    fun getPropertyName() {
+        assertEquals("nameOnProperty", MyDataClass::propertyAnnotation.getPropertyName(MyDataClass::class))
+        assertEquals("nameOnConstructor", MyDataClass::constructorAnnotation.getPropertyName(MyDataClass::class))
+        assertEquals("noAnnotations", MyDataClass::noAnnotations.getPropertyName(MyDataClass::class))
+    }
 }

graphql-kotlin-schema-generator/src/test/kotlin/com/expedia/graphql/generator/types/FunctionBuilderTest.kt

@@ -4,6 +4,7 @@ import com.expedia.graphql.annotations.GraphQLContext
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLDirective
 import com.expedia.graphql.annotations.GraphQLIgnore
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.execution.FunctionDataFetcher
 import graphql.Scalars
 import graphql.introspection.Introspection
@@ -52,6 +53,9 @@ internal class FunctionBuilderTest : TypeTestHelper() {
         @Deprecated("Should paint instead")
         fun sketch(tree: String) = tree
 
+        @GraphQLName("renamedFunction")
+        fun originalName(input: String) = input
+
         @Deprecated("No saw, just paint", replaceWith = ReplaceWith("paint"))
         fun saw(tree: String) = tree
 
@@ -94,6 +98,13 @@ internal class FunctionBuilderTest : TypeTestHelper() {
         assertEquals("deprecated", fieldDirectives.first().name)
     }
 
+    @Test
+    fun `test changing the name of a function`() {
+        val kFunction = Happy::originalName
+        val result = builder.function(kFunction, "Query")
+        assertEquals("renamedFunction", result.name)
+    }
+
     @Test
     fun `test deprecation with replacement`() {
         val kFunction = Happy::saw