-
Notifications
You must be signed in to change notification settings - Fork 9
[#380] fix: Kotlin Serializer not available for org.axonframework.messaging.MetaData #381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
05abcbf
[#380] fix: Kotlin MetaData serialization
MateuszNaKodach b5c2c88
[#380] fix: Kotli MetaData experiments
MateuszNaKodach 38528b4
[#380] fix: Kotli MetaData experiments
MateuszNaKodach a04897c
[#380] fix: add MetaDataSerializer
MateuszNaKodach 46ace77
[#380] fix: add MetaDataSerializer
MateuszNaKodach c613f56
[#380] fix: add MetaDataSerializer
MateuszNaKodach 13243f2
[#380] fix: add MetaDataSerializer
MateuszNaKodach e5148c4
[#380] fix: add MetaDataSerializer
MateuszNaKodach e2ee34c
[#380] fix: add MetaDataSerializer
MateuszNaKodach a51d148
[#380] custom object as string?
MateuszNaKodach bdc2cc8
[#380] custom object - throw exception
MateuszNaKodach 43fce66
[#380] docs: add documentation to `MetaDataSerializer`
MateuszNaKodach 1249544
[#380] docs: add documentation to `MetaDataSerializer`
MateuszNaKodach a14f3df
[#380] docs: add missing test case for malformed json
MateuszNaKodach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
...n/src/main/kotlin/org/axonframework/extensions/kotlin/serialization/MetaDataSerializer.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package org.axonframework.extensions.kotlin.serialization | ||
|
|
||
| import kotlinx.serialization.KSerializer | ||
| import kotlinx.serialization.SerializationException | ||
| import kotlinx.serialization.builtins.MapSerializer | ||
| import kotlinx.serialization.builtins.serializer | ||
| import kotlinx.serialization.descriptors.SerialDescriptor | ||
| import kotlinx.serialization.encoding.Decoder | ||
| import kotlinx.serialization.encoding.Encoder | ||
| import kotlinx.serialization.json.* | ||
| import org.axonframework.messaging.MetaData | ||
| import java.time.Instant | ||
| import java.util.Date | ||
| import java.util.UUID | ||
|
|
||
| object MetaDataSerializer : KSerializer<MetaData> { | ||
|
|
||
| private val json = Json { encodeDefaults = true; ignoreUnknownKeys = true } | ||
|
|
||
| override val descriptor: SerialDescriptor = String.serializer().descriptor | ||
|
|
||
| override fun serialize(encoder: Encoder, value: MetaData) { | ||
| val map: Map<String, JsonElement> = value.entries.associate { (key, rawValue) -> | ||
| key to toJsonElement(rawValue) | ||
| } | ||
| val jsonString = json.encodeToString(MapSerializer(String.serializer(), JsonElement.serializer()), map) | ||
| encoder.encodeSerializableValue(String.serializer(), jsonString) | ||
| } | ||
|
|
||
| override fun deserialize(decoder: Decoder): MetaData { | ||
| val jsonString = decoder.decodeSerializableValue(String.serializer()) | ||
| val map = json.decodeFromString(MapSerializer(String.serializer(), JsonElement.serializer()), jsonString) | ||
| val reconstructed = map.mapValues { (_, jsonElement) -> fromJsonElement(jsonElement) } | ||
| return MetaData(reconstructed) | ||
| } | ||
|
|
||
| private fun toJsonElement(value: Any?): JsonElement = when (value) { | ||
| null -> JsonNull | ||
| is String -> JsonPrimitive(value) | ||
| is Boolean -> JsonPrimitive(value) | ||
| is Int -> JsonPrimitive(value) | ||
| is Long -> JsonPrimitive(value) | ||
| is Float -> JsonPrimitive(value) | ||
| is Double -> JsonPrimitive(value) | ||
| is UUID -> JsonPrimitive(value.toString()) | ||
| is Date -> JsonPrimitive(value.toString()) | ||
| is Instant -> JsonPrimitive(value.toString()) | ||
| is Map<*, *> -> JsonObject(value.entries.associate { (k, v) -> k.toString() to toJsonElement(v) }) | ||
| is Collection<*> -> JsonArray(value.map { toJsonElement(it) }) | ||
| is Array<*> -> JsonArray(value.map { toJsonElement(it) }) | ||
| else -> throw SerializationException("Unsupported type: ${value::class}") | ||
| } | ||
|
|
||
| private fun fromJsonElement(element: JsonElement): Any? = when (element) { | ||
| is JsonNull -> null | ||
| is JsonPrimitive -> when { | ||
| element.isString -> element.content | ||
| element.booleanOrNull != null -> element.boolean | ||
| element.intOrNull != null -> element.int | ||
| element.longOrNull != null -> element.long | ||
| element.floatOrNull != null -> element.float | ||
| element.doubleOrNull != null -> element.double | ||
| else -> element.content | ||
| } | ||
| is JsonObject -> element.mapValues { fromJsonElement(it.value) } | ||
| is JsonArray -> element.map { fromJsonElement(it) } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
228 changes: 228 additions & 0 deletions
228
.../src/test/kotlin/org/axonframework/extensions/kotlin/serializer/MetaDataSerializerTest.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| import kotlinx.serialization.ExperimentalSerializationApi | ||
| import kotlinx.serialization.cbor.Cbor | ||
| import kotlinx.serialization.json.Json | ||
| import org.axonframework.extensions.kotlin.serialization.AxonSerializersModule | ||
| import org.axonframework.extensions.kotlin.serialization.KotlinSerializer | ||
| import org.axonframework.messaging.MetaData | ||
| import org.axonframework.serialization.SerializationException | ||
| import org.junit.jupiter.api.Assertions.* | ||
| import org.junit.jupiter.api.Test | ||
| import org.junit.jupiter.api.assertThrows | ||
| import java.time.Instant | ||
| import java.util.* | ||
|
|
||
| class MetaDataSerializerTest { | ||
|
|
||
| private val jsonSerializer = KotlinSerializer( | ||
| serialFormat = Json { | ||
| serializersModule = AxonSerializersModule | ||
| } | ||
| ) | ||
|
|
||
| @OptIn(ExperimentalSerializationApi::class) | ||
| private val cborSerializer = KotlinSerializer( | ||
| serialFormat = Cbor { | ||
| serializersModule = AxonSerializersModule | ||
| } | ||
| ) | ||
|
|
||
| @Test | ||
| fun `should serialize and deserialize empty MetaData`() { | ||
| val emptyMetaData = MetaData.emptyInstance() | ||
|
|
||
| val serialized = jsonSerializer.serialize(emptyMetaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(emptyMetaData, deserialized) | ||
| assertTrue(deserialized!!.isEmpty()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should serialize and deserialize MetaData with String values`() { | ||
| val metaData = MetaData.with("key1", "value1") | ||
| .and("key2", "value2") | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData, deserialized) | ||
| assertEquals("value1", deserialized?.get("key1")) | ||
| assertEquals("value2", deserialized?.get("key2")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should serialize and deserialize MetaData with numeric values`() { | ||
| val metaData = MetaData.with("int", 42) | ||
| .and("long", 123456789L) | ||
| .and("double", 3.14159) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData.size, deserialized!!.size) | ||
| // Note: numbers might be deserialized as different numeric types | ||
| // but their string representation should match | ||
| assertEquals(metaData["int"].toString(), deserialized.get("int").toString()) | ||
| assertEquals(metaData["long"].toString(), deserialized.get("long").toString()) | ||
| assertEquals(metaData["double"].toString(), deserialized.get("double").toString()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should serialize and deserialize MetaData with boolean values`() { | ||
| val metaData = MetaData.with("isTrue", true) | ||
| .and("isFalse", false) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData, deserialized) | ||
| assertEquals(true, deserialized?.get("isTrue")) | ||
| assertEquals(false, deserialized?.get("isFalse")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should serialize and deserialize MetaData with null values`() { | ||
| val metaData = MetaData.with("nullValue", null) | ||
| .and("nonNullValue", "present") | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData, deserialized) | ||
| assertNull(deserialized?.get("nullValue")) | ||
| assertEquals("present", deserialized?.get("nonNullValue")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should handle UUID`() { | ||
| val uuid = UUID.randomUUID() | ||
| val metaData = MetaData.with("uuid", uuid) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(uuid, metaData.get("uuid")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should handle Instant as String representation`() { | ||
| val timestamp = Instant.now() | ||
|
|
||
| val metaData = MetaData.with("timestamp", timestamp) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized)!! | ||
|
|
||
| assertEquals(timestamp.toString(), deserialized.get("timestamp")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should work with mixed value types`() { | ||
| val metaData = MetaData.with("string", "text") | ||
| .and("number", 123) | ||
| .and("boolean", true) | ||
| .and("null", null) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData, deserialized) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should work with CBOR format`() { | ||
| val metaData = MetaData.with("string", "text") | ||
| .and("number", 123) | ||
| .and("boolean", true) | ||
|
|
||
| val serialized = cborSerializer.serialize(metaData, ByteArray::class.java) | ||
| val deserialized = cborSerializer.deserialize<ByteArray, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData, deserialized) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should handle string that looks like a number or boolean`() { | ||
| val metaData = MetaData.with("numberString", "123") | ||
| .and("booleanString", "true") | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData, deserialized) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should handle nested maps in MetaData`() { | ||
| val nestedMap = mapOf( | ||
| "key1" to "value1", | ||
| "key2" to 123, | ||
| "nested" to mapOf("a" to 1, "b" to 2) | ||
| ) | ||
|
|
||
| val metaData = MetaData.with("mapValue", nestedMap) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| val deserializedValue = deserialized!!["mapValue"] | ||
| assertEquals(nestedMap, deserializedValue) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should handle lists in MetaData`() { | ||
| val list = listOf("item1", "item2", "item3") | ||
|
|
||
| val metaData = MetaData.with("listValue", list) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData.size, deserialized!!.size) | ||
|
|
||
| val deserializedValue = deserialized["listValue"] as List<*> | ||
| assertTrue(deserializedValue.contains("item1")) | ||
| assertTrue(deserializedValue.contains("item2")) | ||
| assertTrue(deserializedValue.contains("item3")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should handle complex nested structures in MetaData`() { | ||
| val complexStructure = mapOf( | ||
| "string" to "value", | ||
| "number" to 42, | ||
| "boolean" to true, | ||
| "null" to null, | ||
| "list" to listOf(1, 2, 3), | ||
| "nestedMap" to mapOf( | ||
| "a" to "valueA", | ||
| "b" to listOf("x", "y", "z"), | ||
| "c" to mapOf("nested" to "deepValue") | ||
| ) | ||
| ) | ||
|
|
||
| val metaData = MetaData.with("complexValue", complexStructure) | ||
|
|
||
| val serialized = jsonSerializer.serialize(metaData, String::class.java) | ||
| val deserialized = jsonSerializer.deserialize<String, MetaData>(serialized) | ||
|
|
||
| assertEquals(metaData.size, deserialized!!.size) | ||
|
|
||
| val deserializedValue = deserialized["complexValue"] as Map<*, *> | ||
| assertEquals(deserializedValue, complexStructure) | ||
| } | ||
|
|
||
| @Test | ||
| fun `do not handle custom objects`() { | ||
| data class Person(val name: String, val age: Int) | ||
|
|
||
| val person = Person("John Doe", 30) | ||
|
|
||
| val metaData = MetaData.with("personValue", person) | ||
|
|
||
| assertThrows<SerializationException> { | ||
| jsonSerializer.serialize(metaData, String::class.java) | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.