fix parsing of cbor elements as members

Author: JesusMcCloud

formats/cbor/commonMain/src/kotlinx/serialization/cbor/internal/CborElementSerializers.kt

@@ -11,11 +11,13 @@ import kotlinx.serialization.cbor.*
 import kotlinx.serialization.descriptors.*
 import kotlinx.serialization.encoding.*
 
+internal interface CborSerializer
+
 /**
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborElement].
  * It can only be used by with [Cbor] format and its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborElementSerializer : KSerializer<CborElement> {
+internal object CborElementSerializer : KSerializer<CborElement>, CborSerializer {
     override val descriptor: SerialDescriptor =
         buildSerialDescriptor("kotlinx.serialization.cbor.CborElement", PolymorphicKind.SEALED) {
             // Resolve cyclic dependency in descriptors by late binding
@@ -52,7 +54,7 @@ internal object CborElementSerializer : KSerializer<CborElement> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborPrimitive].
  * It can only be used by with [Cbor] format an its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborPrimitiveSerializer : KSerializer<CborPrimitive<*>> {
+internal object CborPrimitiveSerializer : KSerializer<CborPrimitive<*>>, CborSerializer {
     override val descriptor: SerialDescriptor =
         buildSerialDescriptor("kotlinx.serialization.cbor.CborPrimitive", PolymorphicKind.SEALED)
 
@@ -79,7 +81,7 @@ internal object CborPrimitiveSerializer : KSerializer<CborPrimitive<*>> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborNull].
  * It can only be used by with [Cbor] format an its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborNullSerializer : KSerializer<CborNull> {
+internal object CborNullSerializer : KSerializer<CborNull>, CborSerializer {
 
     override val descriptor: SerialDescriptor =
         buildSerialDescriptor("kotlinx.serialization.cbor.CborNull", SerialKind.ENUM)
@@ -102,7 +104,7 @@ internal object CborNullSerializer : KSerializer<CborNull> {
 }
 
 
-internal object CborIntSerializer : KSerializer<CborInt<*>> {
+internal object CborIntSerializer : KSerializer<CborInt<*>>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborInt", PrimitiveKind.LONG)
 
@@ -120,7 +122,7 @@ internal object CborIntSerializer : KSerializer<CborInt<*>> {
     }
 }
 
-internal object CborNegativeIntSerializer : KSerializer<CborNegativeInt> {
+internal object CborNegativeIntSerializer : KSerializer<CborNegativeInt>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborNegativeInt", PrimitiveKind.LONG)
 
@@ -136,7 +138,7 @@ internal object CborNegativeIntSerializer : KSerializer<CborNegativeInt> {
     }
 }
 
-internal object CborPositiveIntSerializer : KSerializer<CborPositiveInt> {
+internal object CborPositiveIntSerializer : KSerializer<CborPositiveInt>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborPositiveInt", PrimitiveKind.LONG)
 
@@ -152,7 +154,7 @@ internal object CborPositiveIntSerializer : KSerializer<CborPositiveInt> {
     }
 }
 
-internal object CborDoubleSerializer : KSerializer<CborDouble> {
+internal object CborDoubleSerializer : KSerializer<CborDouble>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborDouble", PrimitiveKind.DOUBLE)
 
@@ -172,7 +174,7 @@ internal object CborDoubleSerializer : KSerializer<CborDouble> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborString].
  * It can only be used by with [Cbor] format an its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborStringSerializer : KSerializer<CborString> {
+internal object CborStringSerializer : KSerializer<CborString>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborString", PrimitiveKind.STRING)
 
@@ -194,7 +196,7 @@ internal object CborStringSerializer : KSerializer<CborString> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborBoolean].
  * It can only be used by with [Cbor] format an its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborBooleanSerializer : KSerializer<CborBoolean> {
+internal object CborBooleanSerializer : KSerializer<CborBoolean>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborBoolean", PrimitiveKind.BOOLEAN)
 
@@ -216,7 +218,7 @@ internal object CborBooleanSerializer : KSerializer<CborBoolean> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborByteString].
  * It can only be used by with [Cbor] format and its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborByteStringSerializer : KSerializer<CborByteString> {
+internal object CborByteStringSerializer : KSerializer<CborByteString>, CborSerializer {
     override val descriptor: SerialDescriptor =
         PrimitiveSerialDescriptor("kotlinx.serialization.cbor.CborByteString", PrimitiveKind.STRING)
 
@@ -238,7 +240,7 @@ internal object CborByteStringSerializer : KSerializer<CborByteString> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborMap].
  * It can only be used by with [Cbor] format and its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborMapSerializer : KSerializer<CborMap> {
+internal object CborMapSerializer : KSerializer<CborMap>, CborSerializer {
     private object CborMapDescriptor :
         SerialDescriptor by MapSerializer(CborElementSerializer, CborElementSerializer).descriptor {
         @ExperimentalSerializationApi
@@ -263,7 +265,7 @@ internal object CborMapSerializer : KSerializer<CborMap> {
  * Serializer object providing [SerializationStrategy] and [DeserializationStrategy] for [CborList].
  * It can only be used by with [Cbor] format an its input ([CborDecoder] and [CborEncoder]).
  */
-internal object CborListSerializer : KSerializer<CborList> {
+internal object CborListSerializer : KSerializer<CborList>, CborSerializer {
     private object CborListDescriptor : SerialDescriptor by ListSerializer(CborElementSerializer).descriptor {
         @ExperimentalSerializationApi
         override val serialName: String = "kotlinx.serialization.cbor.CborList"

formats/cbor/commonMain/src/kotlinx/serialization/cbor/internal/CborParserInterface.kt

@@ -6,6 +6,7 @@
 package kotlinx.serialization.cbor.internal
 
 import kotlinx.serialization.*
+import kotlinx.serialization.cbor.CborList
 
 /**
  * Common interface for CBOR parsers that can read CBOR data from different sources.
@@ -38,4 +39,6 @@ internal sealed interface CborParserInterface {
 
     // Tag verification
     fun verifyTagsAndThrow(expected: ULongArray, actual: ULongArray?)
+
+    fun processTags(tags: ULongArray?): ULongArray?
 }

formats/cbor/commonMain/src/kotlinx/serialization/cbor/internal/Decoder.kt

@@ -18,7 +18,7 @@ internal open class CborReader(override val cbor: Cbor, protected val parser: Cb
     override fun decodeCborElement(): CborElement =
         when (parser) {
             is CborParser -> CborTreeReader(cbor.configuration, parser).read()
-            is StructuredCborParser -> parser.element
+            is StructuredCborParser -> parser.layer.currentElement
         }
 
 
@@ -116,7 +116,12 @@ internal open class CborReader(override val cbor: Cbor, protected val parser: Cb
 
     @OptIn(ExperimentalSerializationApi::class)
     override fun <T> decodeSerializableValue(deserializer: DeserializationStrategy<T>): T {
-        return if ((decodeByteArrayAsByteString || cbor.configuration.alwaysUseByteString)
+        @Suppress("UNCHECKED_CAST")
+        return if (deserializer is CborSerializer) {
+            parser.processTags(tags)
+            decodeCborElement() as T
+        }
+        else if ((decodeByteArrayAsByteString || cbor.configuration.alwaysUseByteString)
             && deserializer.descriptor == ByteArraySerializer().descriptor
         ) {
             @Suppress("UNCHECKED_CAST")
@@ -283,7 +288,7 @@ internal class CborParser(private val input: ByteArrayInput, private val verifyO
             input.readExactNBytes(strLen)
         }
 
-    private fun processTags(tags: ULongArray?): ULongArray? {
+    override fun processTags(tags: ULongArray?): ULongArray? {
         var index = 0
         val collectedTags = mutableListOf<ULong>()
         while ((curByte and 0b111_00000) == HEADER_TAG) {
@@ -559,7 +564,7 @@ private fun Iterable<ByteArray>.flatten(): ByteArray {
  * Works for single elements (where current is directly set to the element) and for collections (where current
  * will be first set after `startMap` or `startArray`
  */
-private class PeekingIterator<T : Any>(private val iter: ListIterator<T>) : Iterator<T> by iter {
+internal class PeekingIterator<T : Any>(private val iter: ListIterator<T>) : Iterator<T> by iter {
 
     lateinit var current: T
         private set
@@ -580,6 +585,7 @@ private class PeekingIterator<T : Any>(private val iter: ListIterator<T>) : Iter
 /** Maps are a bit special for nullability checks, so we need to check whether we're in a map or not*/
 private typealias CborLayer = Pair<Boolean, PeekingIterator<CborElement>>
 
+//TODO get rid of this!
 private val CborLayer.isMap get() = first
 
 /** current element reference inside a layer. If the layer is a primitive then the current element is the layer itself*/
@@ -595,7 +601,8 @@ private fun CborLayer.nextElement() = second.next()
 internal class StructuredCborParser(internal val element: CborElement, private val verifyObjectTags: Boolean) :
     CborParserInterface {
 
-    private var layer: CborLayer = false to PeekingIterator(element)
+    internal var layer: CborLayer = false to PeekingIterator(element)
+    private set
 
 
     private val layerStack = ArrayDeque<CborLayer>()
@@ -605,7 +612,7 @@ internal class StructuredCborParser(internal val element: CborElement, private v
     override fun isNull() =
         if (layer.isMap) layer.peek().let {
             it is CborNull ||
-            /*THIS IS NOT CBOR-COMPLIANT but KxS-proprietary handling of nullable classes*/
+                /*THIS IS NOT CBOR-COMPLIANT but KxS-proprietary handling of nullable classes*/
                 (it is CborMap && it.isEmpty())
         } else layer.currentElement is CborNull
 
@@ -647,7 +654,7 @@ internal class StructuredCborParser(internal val element: CborElement, private v
         processTags(tags)
         if (layer.currentElement !is CborNull) {
             /* THIS IS NOT CBOR-COMPLIANT but KxS-proprietary handling of nullable classes*/
-            if(layer.currentElement is CborMap && (layer.currentElement as CborMap).isEmpty())
+            if (layer.currentElement is CborMap && (layer.currentElement as CborMap).isEmpty())
                 return null
             throw CborDecodingException("Expected null, got ${layer.currentElement::class.simpleName}")
         }
@@ -715,7 +722,7 @@ internal class StructuredCborParser(internal val element: CborElement, private v
      * The reason this method mixes two behaviours is that decoding a primitive is invoked on a single element.
      * `decodeElementIndex`, etc. is invoked on an iterable and there are key tags and value tags
      */
-    private fun processTags(tags: ULongArray?): ULongArray? {
+    override fun processTags(tags: ULongArray?): ULongArray? {
 
         // If we're in a list/map, advance to the next element
         if (layer.hasNext()) layer.nextElement()

formats/cbor/commonTest/src/kotlinx/serialization/cbor/CborElementTest.kt

@@ -11,14 +11,6 @@ class CborElementTest {
 
     private val cbor = Cbor {}
 
-    /**
-     * Helper method to decode a hex string to a CborElement
-     */
-    private fun decodeHexToCborElement(hexString: String): CborElement {
-        val bytes = HexConverter.parseHexBinary(hexString.uppercase())
-        return cbor.decodeFromByteArray(bytes)
-    }
-
     @Test
     fun testCborNull() {
         val nullElement = CborNull()
@@ -217,42 +209,41 @@ class CborElementTest {
     }
 
     @Test
-    fun testDecodeIntegers() {
+    fun testDecodePositiveInt() {
         // Test data from CborParserTest.testParseIntegers
-        val element = decodeHexToCborElement("0C") as CborPositiveInt
+        val element = cbor.decodeFromHexString<CborElement>("0C") as CborPositiveInt
         assertEquals(12u, element.value)
-
     }
 
     @Test
     fun testDecodeStrings() {
         // Test data from CborParserTest.testParseStrings
-        val element = decodeHexToCborElement("6568656C6C6F")
+        val element = cbor.decodeFromHexString<CborElement>("6568656C6C6F")
         assertTrue(element is CborString)
         assertEquals("hello", element.value)
 
         val longStringElement =
-            decodeHexToCborElement("7828737472696E672074686174206973206C6F6E676572207468616E2032332063686172616374657273")
+            cbor.decodeFromHexString<CborElement>("7828737472696E672074686174206973206C6F6E676572207468616E2032332063686172616374657273")
         assertTrue(longStringElement is CborString)
         assertEquals("string that is longer than 23 characters", longStringElement.value)
     }
 
     @Test
     fun testDecodeFloatingPoint() {
         // Test data from CborParserTest.testParseDoubles
-        val doubleElement = decodeHexToCborElement("fb7e37e43c8800759c")
+        val doubleElement = cbor.decodeFromHexString<CborElement>("fb7e37e43c8800759c")
         assertTrue(doubleElement is CborDouble)
         assertEquals(1e+300, doubleElement.value)
 
-        val floatElement = decodeHexToCborElement("fa47c35000")
+        val floatElement = cbor.decodeFromHexString<CborElement>("fa47c35000")
         assertTrue(floatElement is CborDouble)
         assertEquals(100000.0f, floatElement.value.toFloat())
     }
 
     @Test
     fun testDecodeByteString() {
         // Test data from CborParserTest.testRfc7049IndefiniteByteStringExample
-        val element = decodeHexToCborElement("5F44aabbccdd43eeff99FF")
+        val element = cbor.decodeFromHexString<CborElement>("5F44aabbccdd43eeff99FF")
         assertTrue(element is CborByteString)
         val byteString = element as CborByteString
         val expectedBytes = HexConverter.parseHexBinary("aabbccddeeff99")
@@ -262,7 +253,7 @@ class CborElementTest {
     @Test
     fun testDecodeArray() {
         // Test data from CborParserTest.testSkipCollections
-        val element = decodeHexToCborElement("830118ff1a00010000")
+        val element = cbor.decodeFromHexString<CborElement>("830118ff1a00010000")
         assertTrue(element is CborList)
         val list = element as CborList
         assertEquals(3, list.size)
@@ -274,7 +265,7 @@ class CborElementTest {
     @Test
     fun testDecodeMap() {
         // Test data from CborParserTest.testSkipCollections
-        val element = decodeHexToCborElement("a26178676b6f746c696e7861796d73657269616c697a6174696f6e")
+        val element = cbor.decodeFromHexString<CborElement>("a26178676b6f746c696e7861796d73657269616c697a6174696f6e")
         assertTrue(element is CborMap)
         val map = element as CborMap
         assertEquals(2, map.size)
@@ -286,7 +277,7 @@ class CborElementTest {
     fun testDecodeComplexStructure() {
         // Test data from CborParserTest.testSkipIndefiniteLength
         val element =
-            decodeHexToCborElement("a461615f42cafe43010203ff61627f6648656c6c6f2065776f726c64ff61639f676b6f746c696e786d73657269616c697a6174696f6eff6164bf613101613202613303ff")
+            cbor.decodeFromHexString<CborElement>("a461615f42cafe43010203ff61627f6648656c6c6f2065776f726c64ff61639f676b6f746c696e786d73657269616c697a6174696f6eff6164bf613101613202613303ff")
         assertTrue(element is CborMap)
         val map = element as CborMap
         assertEquals(4, map.size)
@@ -313,8 +304,6 @@ class CborElementTest {
         assertEquals(CborPositiveInt(3u), nestedMap[CborString("3")])
     }
 
-    // Test removed due to incompatibility with the new tag implementation
-
     @OptIn(ExperimentalStdlibApi::class)
     @Test
     fun testTagsRoundTrip() {
@@ -333,6 +322,46 @@ class CborElementTest {
         assertEquals(42u, decodedElement.tags.first())
     }
 
-
+    @Test
+    fun testGenericAndCborSpecificMixed() {
+        Triple(
+            Cbor {
+                encodeValueTags = true
+                encodeKeyTags = true
+                verifyKeyTags = true
+                verifyObjectTags = true
+            },
+            MixedBag(
+                str = "A string, is a string, is a string",
+                bStr = CborByteString(byteArrayOf()),
+                cborElement = CborBoolean(false),
+                cborPositiveInt = CborPositiveInt(1u),
+                cborInt = CborInt(-1),
+                tagged = 26
+            ),
+            "bf6373747278224120737472696e672c206973206120737472696e672c206973206120737472696e676462537472406b63626f72456c656d656e74f46f63626f72506f736974697665496e74016763626f72496e7420d82a66746167676564d90921181aff"
+        )
+            .let { (cbor, obj, hex) ->
+                val struct = cbor.encodeToCbor(obj)
+                assertEquals(struct, cbor.decodeFromHexString<CborElement>(hex))
+                assertEquals(obj, cbor.decodeFromCbor(struct))
+                assertEquals(obj, cbor.decodeFromHexString(hex))
+                assertEquals(hex, cbor.encodeToHexString(obj))
+                assertEquals(hex, cbor.encodeToHexString(struct))
+
+            }
+    }
 
 }
+
+@Serializable
+data class MixedBag(
+    val str: String,
+    val bStr: CborByteString?,
+    val cborElement: CborElement,
+    val cborPositiveInt: CborPrimitive<*>,
+    val cborInt: CborInt<*>,
+    @KeyTags(42u)
+    @ValueTags(2337u)
+    val tagged: Int
+)