Fix conversion of input objects with Optional fields

Update our converter to delegate to Spring's ObjectToOptionalConverter to support conversion to target types with Optional fields / properties.
Netflix · Jun 27, 2024 · b1347d7 · b1347d7
1 parent 830ae96
commit b1347d7
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/graphql-dgs/src/main/kotlin/com/netflix/graphql/dgs/internal/DefaultInputObjectMapper.kt b/graphql-dgs/src/main/kotlin/com/netflix/graphql/dgs/internal/DefaultInputObjectMapper.kt
@@ -31,6 +31,7 @@ import org.springframework.core.convert.support.DefaultConversionService
 import org.springframework.util.CollectionUtils
 import org.springframework.util.ReflectionUtils
 import java.lang.reflect.Type
+import java.util.Optional
 import kotlin.reflect.KClass
 import kotlin.reflect.KParameter
 import kotlin.reflect.full.primaryConstructor
@@ -54,6 +55,10 @@ class DefaultInputObjectMapper(customInputObjectMapper: InputObjectMapper? = nul
         }
 
         override fun matches(sourceType: TypeDescriptor, targetType: TypeDescriptor): Boolean {
+            if (targetType.type == Optional::class.java) {
+                // Let Spring's ObjectToOptionalConverter handle it
+                return false
+            }
             if (sourceType.isMap) {
                 val keyDescriptor = sourceType.mapKeyTypeDescriptor
                 return keyDescriptor == null || keyDescriptor.type == String::class.java

diff --git a/graphql-dgs/src/test/kotlin/com/netflix/graphql/dgs/internal/InputObjectMapperTest.kt b/graphql-dgs/src/test/kotlin/com/netflix/graphql/dgs/internal/InputObjectMapperTest.kt
@@ -27,6 +27,7 @@ import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatThrownBy
 import org.junit.jupiter.api.Test
 import java.time.LocalDateTime
+import java.util.Optional
 import kotlin.reflect.KClass
 
 internal class InputObjectMapperTest {
@@ -247,6 +248,17 @@ internal class InputObjectMapperTest {
         assertThat(result.items).isEqualTo(setOf(1, 2, 3, 4))
     }
 
+    @Test
+    fun `mapping to an object with Optional fields works`() {
+        var result = inputObjectMapper.mapToKotlinObject(mapOf<String, Any?>("foo" to null, "bar" to mapOf("subkey1" to "subkey1-value")), InputWithOptional::class)
+        assertThat(result.foo).isNotPresent
+        assertThat(result.bar).get().isEqualTo(KotlinSubObject("subkey1-value"))
+
+        result = inputObjectMapper.mapToKotlinObject(mapOf<String, Any?>("foo" to "foo-value", "bar" to null), InputWithOptional::class)
+        assertThat(result.foo).get().isEqualTo("foo-value")
+        assertThat(result.bar).isNotPresent
+    }
+
     data class KotlinInputObject(val simpleString: String?, val someDate: LocalDateTime, val someObject: KotlinSomeObject)
     data class KotlinNestedInputObject(val input: KotlinInputObject)
     data class KotlinDoubleNestedInputObject(val inputL1: KotlinNestedInputObject)
@@ -259,4 +271,6 @@ internal class InputObjectMapperTest {
 
     enum class FieldType { FOO, BAR, BAZ }
     data class KotlinObjectWithEnumField(val name: String, val type: FieldType)
+
+    data class InputWithOptional(val foo: Optional<String>, val bar: Optional<KotlinSubObject>)
 }