Skip to content

Commit 9232a3c

Browse files
MateuszNaKodachsmcvb
MateuszNaKodach
authored and
smcvb
committed
[#380] fix: add MetaDataSerializer
(cherry picked from commit a04897c)
1 parent 60e19bd commit 9232a3c

File tree

3 files changed

+196
-58
lines changed

3 files changed

+196
-58
lines changed

‎kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/serialization/AxonSerializers.kt‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,13 @@
1515
*/
1616
package org.axonframework.extensions.kotlin.serialization
1717

18-
import MetaDataSerializer
1918
import kotlinx.serialization.KSerializer
2019
import kotlinx.serialization.PolymorphicSerializer
2120
import kotlinx.serialization.SerializationException
2221
import kotlinx.serialization.builtins.MapSerializer
2322
import kotlinx.serialization.builtins.SetSerializer
2423
import kotlinx.serialization.builtins.nullable
2524
import kotlinx.serialization.builtins.serializer
26-
import kotlinx.serialization.descriptors.SerialDescriptor
2725
import kotlinx.serialization.descriptors.buildClassSerialDescriptor
2826
import kotlinx.serialization.descriptors.element
2927
import kotlinx.serialization.encoding.CompositeDecoder

‎kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/serialization/MetaDataSerializer.kt‎

Lines changed: 35 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,53 @@
1+
package org.axonframework.extensions.kotlin.serialization
2+
13
import kotlinx.serialization.KSerializer
4+
import kotlinx.serialization.PolymorphicSerializer
25
import kotlinx.serialization.builtins.MapSerializer
6+
import kotlinx.serialization.builtins.nullable
37
import kotlinx.serialization.builtins.serializer
8+
import kotlinx.serialization.descriptors.SerialDescriptor
49
import kotlinx.serialization.descriptors.buildClassSerialDescriptor
5-
import kotlinx.serialization.descriptors.element
6-
import kotlinx.serialization.encoding.*
10+
import kotlinx.serialization.encoding.CompositeDecoder
11+
import kotlinx.serialization.encoding.Decoder
12+
import kotlinx.serialization.encoding.Encoder
13+
import kotlinx.serialization.encoding.decodeStructure
14+
import kotlinx.serialization.encoding.encodeStructure
715
import org.axonframework.messaging.MetaData
816

917
/**
10-
* Serializer for Axon's MetaData class.
11-
*
12-
* This serializer handles the MetaData by converting it to a simple string-to-string
13-
* map for serialization. This ensures compatibility with any Kotlin serialization format.
18+
* Serializer for Axon Framework's [MetaData] class.
19+
* Since MetaData implements Map<String, Object>, we can use a map serializer
20+
* but need special handling for the polymorphic values.
1421
*/
1522
object MetaDataSerializer : KSerializer<MetaData> {
16-
// Use a simple String -> String map for maximum compatibility
17-
private val mapSerializer = MapSerializer(String.serializer(), String.serializer())
18-
19-
override val descriptor = buildClassSerialDescriptor(MetaData::class.java.name) {
20-
element<Map<String, String>>("values")
21-
}
22-
23-
override fun deserialize(decoder: Decoder): MetaData = decoder.decodeStructure(descriptor) {
24-
var stringMap: Map<String, String>? = null
25-
while (true) {
26-
val index = decodeElementIndex(descriptor)
27-
if (index == CompositeDecoder.DECODE_DONE) break
28-
when (index) {
29-
0 -> stringMap = decodeSerializableElement(descriptor, index, mapSerializer)
30-
}
31-
}
32-
33-
if (stringMap == null || stringMap.isEmpty()) {
34-
return@decodeStructure MetaData.emptyInstance()
35-
}
36-
37-
// The string map contains string representations of values
38-
// Convert back to appropriate types when possible
39-
val resultMap = HashMap<String, Any?>()
40-
stringMap.forEach { (key, valueStr) ->
41-
resultMap[key] = convertStringToTypedValue(valueStr)
42-
}
43-
44-
return@decodeStructure MetaData.from(resultMap)
23+
// We use a map serializer with String keys and polymorphic Any values
24+
private val mapSerializer = MapSerializer(
25+
keySerializer = String.serializer(),
26+
valueSerializer = PolymorphicSerializer(Any::class).nullable
27+
)
28+
29+
override val descriptor: SerialDescriptor = buildClassSerialDescriptor("org.axonframework.messaging.MetaData") {
30+
element("entries", mapSerializer.descriptor)
4531
}
4632

4733
override fun serialize(encoder: Encoder, value: MetaData) {
48-
// Convert MetaData entries to strings
49-
val stringMap = HashMap<String, String>()
50-
51-
value.forEach { (key, obj) ->
52-
stringMap[key] = obj?.toString() ?: "null"
53-
}
54-
5534
encoder.encodeStructure(descriptor) {
56-
encodeSerializableElement(descriptor, 0, mapSerializer, stringMap)
35+
encodeSerializableElement(descriptor, 0, mapSerializer, value)
5736
}
5837
}
5938

60-
/**
61-
* Converts a string representation back to a typed value when possible.
62-
*/
63-
private fun convertStringToTypedValue(value: String): Any? {
64-
if (value == "null") return null
65-
66-
// Try to convert to common primitive types
67-
return value.toBooleanStrictOrNull() ?:
68-
value.toIntOrNull() ?:
69-
value.toLongOrNull() ?:
70-
value.toDoubleOrNull() ?:
71-
// If all else fails, keep as string
72-
value
39+
override fun deserialize(decoder: Decoder): MetaData {
40+
// Deserialize as a Map, then convert to MetaData
41+
return decoder.decodeStructure(descriptor) {
42+
var map: Map<String, Any?>? = null
43+
while (true) {
44+
val index = decodeElementIndex(descriptor)
45+
if (index == CompositeDecoder.DECODE_DONE) break
46+
when (index) {
47+
0 -> map = decodeSerializableElement(descriptor, index, mapSerializer)
48+
}
49+
}
50+
MetaData.from(map ?: HashMap<String, Any?>())
51+
}
7352
}
7453
}

‎kotlin/src/test/kotlin/org/axonframework/extensions/kotlin/serialization/MetaDataSerializerTest.kt‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
package org.axonframework.extensions.kotlin.serialization
2+
3+
import kotlinx.serialization.Serializable
4+
import kotlinx.serialization.cbor.Cbor
5+
import kotlinx.serialization.json.Json
6+
import kotlinx.serialization.modules.SerializersModule
7+
import kotlinx.serialization.modules.plus
8+
import kotlinx.serialization.modules.polymorphic
9+
import kotlinx.serialization.modules.subclass
10+
import org.axonframework.messaging.MetaData
11+
import org.junit.jupiter.api.Assertions.*
12+
import org.junit.jupiter.api.Test
13+
14+
class MetaDataSerializerTest {
15+
16+
// Custom object to test serialization of complex types in MetaData
17+
@Serializable
18+
data class CustomObject(val name: String, val value: Int, val active: Boolean = true)
19+
20+
// Extended module that includes our custom type serializer
21+
private val extendedModule = AxonSerializersModule + SerializersModule {
22+
// Correctly register the custom type for polymorphic serialization
23+
polymorphic(Any::class) {
24+
subclass(CustomObject::class)
25+
}
26+
}
27+
28+
// Configure JSON with our serializers
29+
private val json = Json {
30+
serializersModule = extendedModule
31+
encodeDefaults = true
32+
// Important for polymorphic serialization
33+
classDiscriminator = "type"
34+
}
35+
36+
// Create a serializer with our configuration
37+
private val serializer = KotlinSerializer(serialFormat = json)
38+
39+
@Test
40+
fun `serialize empty metadata`() {
41+
val metadata = MetaData.emptyInstance()
42+
43+
val serialized = serializer.serialize(metadata, String::class.java)
44+
45+
// Verify serialization format
46+
assertEquals("{\"entries\":{}}", serialized.data)
47+
48+
// Verify deserialization - specifying type arguments explicitly
49+
val deserialized = serializer.deserialize<String, MetaData>(serialized)!!
50+
assertEquals(metadata, deserialized)
51+
assertTrue(deserialized.isEmpty())
52+
}
53+
54+
@Test
55+
fun `serialize metadata with primitive values`() {
56+
val metadata = MetaData.with("stringKey", "stringValue")
57+
.and("intKey", 42)
58+
.and("booleanKey", true)
59+
.and("doubleKey", 3.14)
60+
.and("nullKey", null)
61+
62+
val serialized = serializer.serialize(metadata, String::class.java)
63+
64+
// Verify deserialization - specifying type arguments explicitly
65+
val deserialized = serializer.deserialize<String, MetaData>(serialized)!!
66+
67+
assertEquals(metadata.size, deserialized.size)
68+
assertEquals("stringValue", deserialized["stringKey"])
69+
assertEquals(42, deserialized["intKey"])
70+
assertEquals(true, deserialized["booleanKey"])
71+
assertEquals(3.14, deserialized["doubleKey"])
72+
assertNull(deserialized["nullKey"])
73+
}
74+
//
75+
// @Test
76+
// fun `serialize metadata with collection values`() {
77+
// val metadata = MetaData.with("listKey", listOf("item1", "item2", "item3"))
78+
// .and("mapKey", mapOf("key1" to "value1", "key2" to "value2"))
79+
// .and("nestedListKey", listOf(listOf(1, 2), listOf(3, 4)))
80+
//
81+
// val serialized = serializer.serialize(metadata, String::class.java)
82+
//
83+
// // Verify deserialization - specifying type arguments explicitly
84+
// val deserialized = serializer.deserialize<String, MetaData>(serialized)
85+
//
86+
// assertEquals(metadata.size, deserialized.size)
87+
//
88+
// @Suppress("UNCHECKED_CAST")
89+
// val list = deserialized["listKey"] as List<String>
90+
// assertEquals(3, list.size)
91+
// assertEquals("item1", list[0])
92+
//
93+
// @Suppress("UNCHECKED_CAST")
94+
// val map = deserialized["mapKey"] as Map<String, String>
95+
// assertEquals(2, map.size)
96+
// assertEquals("value1", map["key1"])
97+
//
98+
// @Suppress("UNCHECKED_CAST")
99+
// val nestedList = deserialized["nestedListKey"] as List<List<Int>>
100+
// assertEquals(2, nestedList.size)
101+
// assertEquals(1, nestedList[0][0])
102+
// }
103+
//
104+
// @Test
105+
// fun `serialize metadata with custom object`() {
106+
// val customObject = CustomObject("test", 123)
107+
// val metadata = MetaData.with("customKey", customObject)
108+
//
109+
// val serialized = serializer.serialize(metadata, String::class.java)
110+
//
111+
// // Verify deserialization - specifying type arguments explicitly
112+
// val deserialized = serializer.deserialize<String, MetaData>(serialized)
113+
//
114+
// assertEquals(metadata.size, deserialized.size)
115+
//
116+
// // With proper polymorphic serialization, we should get back our CustomObject
117+
// val deserializedObject = deserialized["customKey"] as CustomObject
118+
// assertEquals("test", deserializedObject.name)
119+
// assertEquals(123, deserializedObject.value)
120+
// assertEquals(true, deserializedObject.active)
121+
// }
122+
//
123+
// @Test
124+
// fun `verify metadata works with different formats`() {
125+
// // Test with CBOR format
126+
// val cborSerializer = KotlinSerializer(
127+
// serialFormat = Cbor {
128+
// serializersModule = extendedModule
129+
// }
130+
// )
131+
//
132+
// val metadata = MetaData.with("key", "value")
133+
// .and("customKey", CustomObject("cbor-test", 456))
134+
//
135+
// val serialized = cborSerializer.serialize(metadata, ByteArray::class.java)
136+
// val deserialized = cborSerializer.deserialize<ByteArray, MetaData>(serialized)
137+
//
138+
// assertEquals("value", deserialized["key"])
139+
//
140+
// // With proper polymorphic serialization in CBOR format
141+
// val deserializedObject = deserialized["customKey"] as CustomObject
142+
// assertEquals("cbor-test", deserializedObject.name)
143+
// assertEquals(456, deserializedObject.value)
144+
// }
145+
//
146+
// @Test
147+
// fun `verify direct serialization and deserialization`() {
148+
// val metadata = MetaData.with("key", "direct-serialization")
149+
// .and("number", 789)
150+
//
151+
// // Direct serialization with the serializer module
152+
// val serializedString = json.encodeToString(MetaDataSerializer, metadata)
153+
//
154+
// // Direct deserialization
155+
// val deserialized = json.decodeFromString(MetaDataSerializer, serializedString)
156+
//
157+
// assertEquals(metadata, deserialized)
158+
// assertEquals("direct-serialization", deserialized["key"])
159+
// assertEquals(789, deserialized["number"])
160+
// }
161+
}

0 commit comments

Comments
 (0)