Iterate over element indicies in ObjectSerializer in order to let the…

… format skip unknown keys (#1916) Fixes #1915
Kotlin · Apr 27, 2022 · 4228656 · 4228656
1 parent 216ea9c
commit 4228656
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git a/core/commonMain/src/kotlinx/serialization/internal/ObjectSerializer.kt b/core/commonMain/src/kotlinx/serialization/internal/ObjectSerializer.kt
@@ -40,7 +40,14 @@ internal class ObjectSerializer<T : Any>(serialName: String, private val objectI
     }
 
     override fun deserialize(decoder: Decoder): T {
-        decoder.beginStructure(descriptor).endStructure(descriptor)
+        decoder.decodeStructure(descriptor) {
+            when (val index = decodeElementIndex(descriptor)) {
+                CompositeDecoder.DECODE_DONE -> {
+                    return@decodeStructure
+                }
+                else -> throw SerializationException("Unexpected index $index")
+            }
+        }
         return objectInstance
     }
 }
diff --git a/formats/json/commonTest/src/kotlinx/serialization/features/ObjectSerialization.kt b/formats/json/commonTest/src/kotlinx/serialization/features/ObjectSerialization.kt
@@ -5,10 +5,10 @@
 package kotlinx.serialization.features
 
 import kotlinx.serialization.*
-import kotlinx.serialization.json.Json
-import kotlinx.serialization.json.JsonTestBase
+import kotlinx.serialization.json.*
 import kotlinx.serialization.modules.*
-import kotlin.test.Test
+import kotlinx.serialization.test.*
+import kotlin.test.*
 
 class ObjectSerializationTest : JsonTestBase() {
 
@@ -46,4 +46,17 @@ class ObjectSerializationTest : JsonTestBase() {
             json
         )
     }
+
+    @Test
+    fun testUnknownKeys() {
+        val string = """{"metadata":"foo"}"""
+        assertFailsWithMessage<SerializationException>("ignoreUnknownKeys") {
+            Json.decodeFromString(
+                ApiResponse.Error.serializer(),
+                string
+            )
+        }
+        val json = Json { ignoreUnknownKeys = true }
+        assertEquals(ApiResponse.Error, json.decodeFromString(ApiResponse.Error.serializer(), string))
+    }
 }