Add kotlin.serialization implementation of Serializer #338

lion7 · 2024-05-28T12:00:22Z

This PR adds support for serializing by using kotlinx.serialization and is basically a continuation of #124.

Note that I had to upgrade the Kotlin version (and fix a few generics in QueryGatewayExtensions.kt) to make it work.

gklijs · 2024-05-28T12:12:58Z

Looks great from quickly going through it, I'll try to review it this week.

CLAassistant · 2024-05-28T12:16:13Z

All committers have signed the CLA.

jangalinski · 2024-05-28T13:02:53Z

Great approach. We are working on a kotlinx.serialization based avro serializer as well and might (re-)use generic features provided by extension-kotlin.
But: kotlinx.serialization is a generic tool for serialization, json is just one aspect. So I would like to have a clearer separation between json-specific and kotlinx-generic features ...

lion7 · 2024-05-29T09:09:27Z

This implementation is already independent of the serialization format. I changed the main dependency to use the core library instead and added a few more tests for binary formats as well.

It should work with any SerialFormat that either implements StringFormat or BinaryFormat.

gklijs

I have some questions about Axon Specific classes that needs to be serialized, which are not included in the SerializersModule. All new files should have the copyright notice. It would also be nice if we don't need to opt in for experimental api's. As this is a new feature, it's likely better to set 4.10 as the target.

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

zambrovski · 2024-05-29T14:12:38Z

We were playing with KSerializer registration in our Apache Avro approach and came up with a small SPI. By doing so it is pretty easy to write own serializers and let the SPI loader automatically register those.

But before building this, it would be a good idea to document how new KSerializers needs to be registered. In general, do you have any docs describing the implemented features?

jangalinski · 2024-05-29T14:30:05Z

We were playing with KSerializer registration in our Apache Avro approach and came up with a small SPI. By doing so it is pretty easy to write own serializers and let the SPI loader automatically register those.

But before building this, it would be a good idea to document how new KSerializers needs to be registered. In general, do you have any docs describing the implemented features?

Actually, this part is already public/released ... peek here if you like: https://github.com/toolisticon/avro-kotlin/tree/develop/avro-kotlin-serialization/src/main/kotlin/spi

smcvb · 2024-07-17T12:36:09Z

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/serialization/ArrayResponseType.kt

+ * @author Gerard de Leeuw
+ * @see org.axonframework.messaging.responsetypes.MultipleInstancesResponseType
+ */
+class ArrayResponseType<E>(elementType: Class<E>) : AbstractResponseType<Array<E>>(elementType) {


@lion7, can you explain to me what the intent is of the ArrayResponseType for the KotlinSerializer exactly?

smcvb · 2024-07-17T12:44:15Z

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

+ val index = decodeElementIndex(descriptor)
+ if (index == CompositeDecoder.DECODE_DONE) break
+ when (index) {
+ 0 -> gapIndex = decodeLongElement(descriptor, index)


Question: I assume the values 0 and 1 reflecting the fields index and gaps mean that if we'd reorder the fields in the GapAwareTrackingToken, this would break the serialization?

smcvb · 2024-07-17T12:49:56Z

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

+import org.axonframework.messaging.responsetypes.ResponseType
+import kotlin.reflect.KClass
+
+private val trackingTokenSerializer = PolymorphicSerializer(TrackingToken::class).nullable


Reading the documentation of the PolymorphicSerializer constructor, I read the following:

... * To avoid the most common security pitfalls and reflective lookup (and potential load) of an arbitrary class, * all serializable implementations of any polymorphic type must be [registered][SerializersModuleBuilder.polymorphic] * in advance in the scope of base polymorphic type, efficiently preventing unbounded polymorphic serialization * of an arbitrary type. ...

So, I assume that when this trackingTokenSerializer is instantiated, all implementations have been registered, and novel implementations can be included by users as well?

smcvb · 2024-07-17T13:15:06Z

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

+object ReplayTokenSerializer : KSerializer<ReplayToken> {
+
+ override val descriptor = buildClassSerialDescriptor(ReplayToken::class.java.name) {
+ element<TrackingToken>("tokenAtReset")


I think we're missing the context object here, right? Or, I don't fully grasp how a KSerializer should be built.

I have made some local adjustments to validate my assumption here and I think they're correct.

The predicament, however, is the fact that the context field is of type Object, so Any in Kotlin.
After a quick search, my assumption is confirmed that the Any type does not work nicely with serialization.

I would wager that if we could set a Serializer for the context that would (1) check if the field is a primitive type and (2) check if it's of a type for which the user has provided a Serializer, we should be good.
The former should be a straightforward search, but I am not entirely sure how to solve requirement two for custom types from the user.
So, with that said, do you have a suggestion on how to tackle this, @lion7?

smcvb · 2024-07-17T14:11:20Z

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

+ }
+}
+
+object ConfigTokenSerializer : KSerializer<ConfigToken> {


Question: Would a user of the Kotlin Extension ever be required to work with the KSerializer implementations in this file directly?

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/serialization/KotlinSerializer.kt

smcvb

Looks fine, although I have a couple of questions and remarks.

Set since tag #338

Move ArrayResponseType to message/responsetypes. In doing so, we reflect the folder structure for the other ResponseType implementation in Axon Framework #338

Expand KDoc with construction example #338

Add kotlin.serialization implementation of Serializer

8a37ace

gklijs self-assigned this May 28, 2024

Add tests for more formats

1cdf9fc

lion7 added 2 commits May 29, 2024 11:10

revert accidental change

8026eee

fix JDK 8 and JDK 11 compatibility

c181625

gklijs added Type: Feature Status: In Progress Priority 3: Could labels May 29, 2024

gklijs suggested changes May 29, 2024

View reviewed changes

Add copyright

1ca85f8

gklijs added this to the Release 4.10.0 milestone Jun 15, 2024

gklijs merged commit 764e339 into AxonFramework:master Jun 15, 2024
1 check passed

gklijs added Status: Resolved and removed Status: In Progress labels Jun 15, 2024

lion7 mentioned this pull request Jun 20, 2024

Kotlin Serializer implementation #13

Closed

smcvb mentioned this pull request Jul 17, 2024

Add kotlin.serialization implementation of Serializer #124

Closed

smcvb reviewed Jul 17, 2024

View reviewed changes

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/serialization/KotlinSerializer.kt Show resolved Hide resolved

smcvb reviewed Jul 17, 2024

View reviewed changes

smcvb added a commit that referenced this pull request Jul 23, 2024

Set since tag

afb06d7

Set since tag #338

smcvb added a commit that referenced this pull request Jul 23, 2024

Move ArrayResponseType to message/responsetypes

f55bffc

Move ArrayResponseType to message/responsetypes. In doing so, we reflect the folder structure for the other ResponseType implementation in Axon Framework #338

smcvb added a commit that referenced this pull request Jul 23, 2024

Expand KDoc with construction example

236e818

Expand KDoc with construction example #338

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add kotlin.serialization implementation of Serializer #338

Add kotlin.serialization implementation of Serializer #338

lion7 commented May 28, 2024 •

edited

Loading

gklijs commented May 28, 2024

CLAassistant commented May 28, 2024 •

edited

Loading

jangalinski commented May 28, 2024

lion7 commented May 29, 2024

gklijs left a comment •

edited

Loading

zambrovski commented May 29, 2024

jangalinski commented May 29, 2024

smcvb Jul 17, 2024

smcvb Jul 17, 2024 •

edited

Loading

smcvb Jul 17, 2024 •

edited

Loading

smcvb Jul 17, 2024 •

edited

Loading

smcvb Jul 23, 2024

smcvb Jul 17, 2024

smcvb left a comment

Add kotlin.serialization implementation of Serializer #338

Add kotlin.serialization implementation of Serializer #338

Conversation

lion7 commented May 28, 2024 • edited Loading

gklijs commented May 28, 2024

CLAassistant commented May 28, 2024 • edited Loading

jangalinski commented May 28, 2024

lion7 commented May 29, 2024

gklijs left a comment • edited Loading

Choose a reason for hiding this comment

zambrovski commented May 29, 2024

jangalinski commented May 29, 2024

smcvb Jul 17, 2024

Choose a reason for hiding this comment

smcvb Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

smcvb Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

smcvb Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

smcvb Jul 23, 2024

Choose a reason for hiding this comment

smcvb Jul 17, 2024

Choose a reason for hiding this comment

smcvb left a comment

Choose a reason for hiding this comment

lion7 commented May 28, 2024 •

edited

Loading

CLAassistant commented May 28, 2024 •

edited

Loading

gklijs left a comment •

edited

Loading

smcvb Jul 17, 2024 •

edited

Loading

smcvb Jul 17, 2024 •

edited

Loading

smcvb Jul 17, 2024 •

edited

Loading