Feature/support deprecation of input values (#7)

Resolves #2
stuebingerb · Oct 17, 2024 · bb403bf · bb403bf
2 parents 1cc2f0e + f39d3fb
commit bb403bf
Show file tree

Hide file tree

Showing 12 changed files with 242 additions and 30 deletions.
diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/request/Parser.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/request/Parser.kt
@@ -724,19 +724,21 @@ open class Parser {
 
     /**
      * InputValueDefinition :
-     *   - Description? Name : Type DefaultValue? Directives{Const}?
+     *   - Description? Name ArgumentsDefinition? : Type DefaultValue? Directives{Const}?
      */
     private fun parseInputValueDef(): InputValueDefinitionNode {
         val start = lexer.token
         val description = parseDescription()
         val name = parseName()
+        val args = parseArgumentDefs()
         expectToken(COLON)
         val type = parseTypeReference()
         val defaultValue = expectOptionalToken(EQUALS)?.let { parseValueLiteral(true) }
         val directives = parseDirectives(true)
 
         return InputValueDefinitionNode(
             description = description,
+            arguments = args,
             name = name,
             type = type,
             defaultValue = defaultValue,

diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/dsl/SchemaBuilder.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/dsl/SchemaBuilder.kt
@@ -209,7 +209,7 @@ class SchemaBuilder internal constructor() {
 
     fun <T : Any> inputType(kClass: KClass<T>, block: InputTypeDSL<T>.() -> Unit) {
         val input = InputTypeDSL(kClass).apply(block)
-        model.addInputObject(TypeDef.Input(input.name, kClass, input.description))
+        model.addInputObject(input.toKQLObject())
     }
 
     inline fun <reified T : Any> inputType(noinline block: InputTypeDSL<T>.() -> Unit = {}) {

diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/dsl/types/InputTypeDSL.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/dsl/types/InputTypeDSL.kt
@@ -2,9 +2,33 @@ package com.apurebase.kgraphql.schema.dsl.types
 
 import com.apurebase.kgraphql.defaultKQLTypeName
 import com.apurebase.kgraphql.schema.dsl.ItemDSL
+import com.apurebase.kgraphql.schema.dsl.KotlinPropertyDSL
+import com.apurebase.kgraphql.schema.model.PropertyDef
+import com.apurebase.kgraphql.schema.model.TypeDef
 import kotlin.reflect.KClass
+import kotlin.reflect.KProperty1
 
 class InputTypeDSL<T : Any>(val kClass: KClass<T>) : ItemDSL() {
 
     var name = kClass.defaultKQLTypeName()
+
+    private val kotlinProperties = mutableMapOf<KProperty1<T, *>, PropertyDef.Kotlin<T, *>>()
+
+    fun <R> property(kProperty: KProperty1<T, R>, block: KotlinPropertyDSL<T, R>.() -> Unit) {
+        val dsl = KotlinPropertyDSL(kProperty, block)
+        kotlinProperties[kProperty] = dsl.toKQLProperty()
+    }
+
+    fun <R> KProperty1<T, R>.configure(block: KotlinPropertyDSL<T, R>.() -> Unit) {
+        property(this, block)
+    }
+
+    internal fun toKQLObject(): TypeDef.Input<T> {
+        return TypeDef.Input(
+            name = name,
+            kClass = kClass,
+            kotlinProperties = kotlinProperties.toMap(),
+            description = description
+        )
+    }
 }
diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/introspection/__InputValue.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/introspection/__InputValue.kt
@@ -1,6 +1,8 @@
 package com.apurebase.kgraphql.schema.introspection
 
-interface __InputValue : __Described {
+import com.apurebase.kgraphql.schema.model.Depreciable
+
+interface __InputValue :  Depreciable, __Described {
 
     val type: __Type
 

diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/MutableSchemaDefinition.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/MutableSchemaDefinition.kt
@@ -10,6 +10,7 @@ import com.apurebase.kgraphql.schema.introspection.TypeKind
 import com.apurebase.kgraphql.schema.introspection.__Directive
 import com.apurebase.kgraphql.schema.introspection.__EnumValue
 import com.apurebase.kgraphql.schema.introspection.__Field
+import com.apurebase.kgraphql.schema.introspection.__InputValue
 import com.apurebase.kgraphql.schema.introspection.__Schema
 import com.apurebase.kgraphql.schema.introspection.__Type
 import kotlin.reflect.KClass
@@ -23,7 +24,8 @@ data class MutableSchemaDefinition(
     private val objects: ArrayList<TypeDef.Object<*>> = arrayListOf(
         TypeDef.Object(__Schema::class.defaultKQLTypeName(), __Schema::class),
         create__TypeDefinition(),
-        create__DirectiveDefinition()
+        create__DirectiveDefinition(),
+        create__FieldDefinition()
     ),
     private val queries: ArrayList<QueryDef<*>> = arrayListOf(),
     private val scalars: ArrayList<TypeDef.Scalar<*>> = arrayListOf(
@@ -161,12 +163,37 @@ data class MutableSchemaDefinition(
     }
 }
 
+private fun create__FieldDefinition() = TypeDSL(emptyList(), __Field::class).apply {
+    transformation(__Field::args) { args: List<__InputValue>, includeDeprecated: Boolean? ->
+        if (includeDeprecated == true) {
+            args
+        } else {
+            args.filterNot { it.isDeprecated }
+        }
+    }
+}.toKQLObject()
+
 private fun create__TypeDefinition() = TypeDSL(emptyList(), __Type::class).apply {
     transformation(__Type::fields) { fields: List<__Field>?, includeDeprecated: Boolean? ->
-        if (includeDeprecated == true) fields else fields?.filterNot { it.isDeprecated }
+        if (includeDeprecated == true) {
+            fields
+        } else {
+            fields?.filterNot { it.isDeprecated }
+        }
+    }
+    transformation(__Type::inputFields) { fields: List<__InputValue>?, includeDeprecated: Boolean? ->
+        if (includeDeprecated == true) {
+            fields
+        } else {
+            fields?.filterNot { it.isDeprecated }
+        }
     }
     transformation(__Type::enumValues) { enumValues: List<__EnumValue>?, includeDeprecated: Boolean? ->
-        if (includeDeprecated == true) enumValues else enumValues?.filterNot { it.isDeprecated }
+        if (includeDeprecated == true) {
+            enumValues
+        } else {
+            enumValues?.filterNot { it.isDeprecated }
+        }
     }
 }.toKQLObject()
 
@@ -200,6 +227,13 @@ private fun create__DirectiveDefinition() = TypeDSL(
         }
         deprecate("Use `locations`.")
     }
+    transformation(__Directive::args) { args: List<__InputValue>, includeDeprecated: Boolean? ->
+        if (includeDeprecated == true) {
+            args
+        } else {
+            args.filterNot { it.isDeprecated }
+        }
+    }
 }.toKQLObject()
 
 private fun <T> List<T>.containsAny(vararg elements: T) = elements.any { this.contains(it) }
diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/TypeDef.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/TypeDef.kt
@@ -34,6 +34,7 @@ interface TypeDef {
     class Input<T : Any>(
         name: String,
         override val kClass: KClass<T>,
+        val kotlinProperties: Map<KProperty1<T, *>, PropertyDef.Kotlin<T, *>> = emptyMap(),
         description: String? = null
     ) : BaseKQLType(name, description), Kotlin<T>
 

diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/ast/InputValueDefinitionNode.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/ast/InputValueDefinitionNode.kt
@@ -6,6 +6,7 @@ data class InputValueDefinitionNode(
     override val loc: Location?,
     val name: NameNode,
     val description: StringValueNode?,
+    val arguments: List<InputValueDefinitionNode>?,
     val type: TypeNode,
     val defaultValue: ValueNode?,
     val directives: List<DirectiveNode>?

diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/structure/InputValue.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/structure/InputValue.kt
@@ -14,5 +14,9 @@ class InputValue<T : Any>(
 
     override val description: String? = valueDef.description
 
+    override val isDeprecated: Boolean = valueDef.isDeprecated
+
+    override val deprecationReason: String? = valueDef.deprecationReason
+
     val default: T? = valueDef.defaultValue
 }
diff --git a/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/structure/SchemaCompilation.kt b/kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/structure/SchemaCompilation.kt
@@ -340,7 +340,12 @@ class SchemaCompilation(
         inputTypeProxies[kClass] = typeProxy
 
         val fields = if (kClass.findAnnotation<NotIntrospected>() == null) {
-            kClass.memberProperties.map { property -> handleKotlinInputProperty(property) }
+            kClass.memberProperties.map { property ->
+                handleKotlinInputProperty(
+                    kProperty = property,
+                    kqlProperty = inputObjectDef.kotlinProperties[property]
+                )
+            }
         } else {
             listOf()
         }
@@ -366,6 +371,9 @@ class SchemaCompilation(
             val inputValue = inputValues.find { it.name == name }
             val kqlInput = inputValue ?: InputValueDef(kType.jvmErasure, name)
             val inputType = handlePossiblyWrappedType(inputValue?.kType ?: kType, TypeCategory.INPUT)
+            if (kqlInput.isDeprecated && !inputType.isNullable()) {
+                throw SchemaException("Required arguments cannot be marked as deprecated")
+            }
             InputValue(kqlInput, inputType)
         }
     }
@@ -391,9 +399,24 @@ class SchemaCompilation(
         return unionType
     }
 
-    private suspend fun handleKotlinInputProperty(kProperty: KProperty1<*, *>): InputValue<*> {
+    private suspend fun <T : Any, R> handleKotlinInputProperty(
+        kProperty: KProperty1<T, R>,
+        kqlProperty: PropertyDef.Kotlin<*, *>?
+    ): InputValue<*> {
         val type = handlePossiblyWrappedType(kProperty.returnType, TypeCategory.INPUT)
-        return InputValue(InputValueDef(kProperty.returnType.jvmErasure, kProperty.name), type)
+        val actualKqlProperty = kqlProperty ?: PropertyDef.Kotlin(kProperty)
+        if (actualKqlProperty.isDeprecated && !type.isNullable()) {
+            throw SchemaException("Required fields cannot be marked as deprecated")
+        }
+        return InputValue(
+            InputValueDef(
+                kProperty.returnType.jvmErasure,
+                kProperty.name,
+                description = actualKqlProperty.description,
+                isDeprecated = actualKqlProperty.isDeprecated,
+                deprecationReason = actualKqlProperty.deprecationReason
+            ), type
+        )
     }
 
     private suspend fun <T : Any, R> handleKotlinProperty(

diff --git a/kgraphql/src/test/kotlin/com/apurebase/kgraphql/integration/BaseSchemaTest.kt b/kgraphql/src/test/kotlin/com/apurebase/kgraphql/integration/BaseSchemaTest.kt
@@ -35,19 +35,18 @@ abstract class BaseSchemaTest {
                         name
                         description
                         locations
-                        args {
+                        args(includeDeprecated: true) {
                             ...InputValue
                         }
                     }
                 }
             }
 
-
             fragment FullType on __Type {
                 fields(includeDeprecated: true) {
                     name
                     description
-                    args {
+                    args(includeDeprecated: true) {
                         ...InputValue
                     }
                     type {
@@ -56,7 +55,7 @@ abstract class BaseSchemaTest {
                     isDeprecated
                     deprecationReason
                 }
-                inputFields {
+                inputFields(includeDeprecated: true) {
                     ...InputValue
                 }
                 interfaces {
@@ -78,6 +77,8 @@ abstract class BaseSchemaTest {
                 description
                 type { ...TypeRef }
                 defaultValue
+                isDeprecated
+                deprecationReason
             }
 
             fragment TypeRef on __Type {