feat: add serializers for various data types including Adventure components, BitSet, and UUID

Author: twisti-dev

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/CloudBufSerializer.kt

@@ -0,0 +1,10 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx
+
+import dev.slne.surf.bytebufserializer.KBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import dev.slne.surf.cloud.api.common.util.annotation.InternalApi
+
+@InternalApi
+abstract class CloudBufSerializer<T> : KBufSerializer<T, SurfByteBuf> {
+    override val bufClass = SurfByteBuf::class
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/SurfCloudBufSerializer.kt

@@ -0,0 +1,39 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx
+
+import dev.slne.surf.bytebufserializer.Buf
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.adventure.AdventureComponentSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.adventure.AdventureKeySerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.adventure.AdventureSoundSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.BitSetSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.Inet4AddressSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.InetSocketAddressSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.URISerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.UUIDSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.UtfStringSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java.ZonedDateTimeSerializer
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.nbt.CompoundTagSerializer
+import kotlinx.serialization.modules.SerializersModule
+import kotlinx.serialization.modules.contextual
+
+object SurfCloudBufSerializer {
+    val serializerModule = SerializersModule {
+        // Adventure
+        contextual(AdventureKeySerializer)
+        contextual(AdventureSoundSerializer)
+        contextual(AdventureComponentSerializer)
+
+        // Java
+        contextual(UUIDSerializer)
+        contextual(BitSetSerializer)
+        contextual(UtfStringSerializer)
+        contextual(URISerializer)
+        contextual(InetSocketAddressSerializer)
+        contextual(ZonedDateTimeSerializer)
+        contextual(Inet4AddressSerializer)
+
+        // NBT
+        contextual(CompoundTagSerializer)
+    }
+
+    val serializer = Buf(serializerModule)
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/adventure/AdventureComponentSerializer.kt

@@ -0,0 +1,25 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.adventure
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import net.kyori.adventure.text.Component
+
+typealias SerializableComponent = @Serializable(with = AdventureComponentSerializer::class) Component
+
+object AdventureComponentSerializer : CloudBufSerializer<Component>() {
+    override val descriptor = PrimitiveSerialDescriptor("Component", PrimitiveKind.STRING)
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: Component
+    ) {
+        buf.writeComponent(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): Component {
+        return buf.readComponent()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/adventure/AdventureKeySerializer.kt

@@ -0,0 +1,25 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.adventure
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import net.kyori.adventure.key.Key
+
+typealias SerializableKey = @Serializable(with = AdventureKeySerializer::class) Key
+
+object AdventureKeySerializer : CloudBufSerializer<Key>() {
+    override val descriptor = PrimitiveSerialDescriptor("Key", PrimitiveKind.STRING)
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: Key
+    ) {
+        buf.writeKey(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): Key {
+        return buf.readKey()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/adventure/AdventureSoundSerializer.kt

@@ -0,0 +1,32 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.adventure
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.descriptors.buildClassSerialDescriptor
+import kotlinx.serialization.descriptors.element
+import net.kyori.adventure.sound.Sound
+
+typealias SerializableSound = @Serializable(with = AdventureSoundSerializer::class) Sound
+
+object AdventureSoundSerializer : CloudBufSerializer<Sound>() {
+    override val descriptor: SerialDescriptor = buildClassSerialDescriptor("Sound") {
+        element<Sound.Source>("source")
+        element<Float>("volume")
+        element<Float>("pitch")
+        element<Long?>("seed")
+        element<String>("name")
+    }
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: Sound
+    ) {
+        buf.writeSound(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): Sound {
+        return buf.readSound()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/java/BitSetSerializer.kt

@@ -0,0 +1,27 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.buildClassSerialDescriptor
+import kotlinx.serialization.descriptors.element
+import java.util.*
+
+typealias SerializableBitSet = @Serializable(with = BitSetSerializer::class) BitSet
+
+object BitSetSerializer : CloudBufSerializer<BitSet>() {
+    override val descriptor = buildClassSerialDescriptor("BitSet") {
+        element<LongArray>("longArray")
+    }
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: BitSet
+    ) {
+        buf.writeBitSet(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): BitSet {
+        return buf.readBitSet()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/java/Inet4AddressSerializer.kt

@@ -0,0 +1,25 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.builtins.ByteArraySerializer
+import kotlinx.serialization.descriptors.SerialDescriptor
+import java.net.Inet4Address
+
+typealias SerializableInet4Address = @Serializable(with = Inet4AddressSerializer::class) Inet4Address
+
+object Inet4AddressSerializer: CloudBufSerializer<Inet4Address>() {
+    override val descriptor = SerialDescriptor("Inet4Address", ByteArraySerializer().descriptor)
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: Inet4Address
+    ) {
+        buf.writeInet4Address(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): Inet4Address {
+        return buf.readInet4Address()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/java/InetSocketAddressSerializer.kt

@@ -0,0 +1,28 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.buildClassSerialDescriptor
+import kotlinx.serialization.descriptors.element
+import java.net.InetSocketAddress
+
+typealias SerializableInetSocketAddress = @Serializable(with = InetSocketAddressSerializer::class) InetSocketAddress
+
+object InetSocketAddressSerializer : CloudBufSerializer<InetSocketAddress>() {
+    override val descriptor = buildClassSerialDescriptor("InetSocketAddress") {
+        element<String>("host")
+        element<Int>("port")
+    }
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: InetSocketAddress
+    ) {
+        buf.writeInetSocketAddress(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): InetSocketAddress {
+        return buf.readInetSocketAddress()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/java/URISerializer.kt

@@ -0,0 +1,25 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import java.net.URI
+
+typealias SerializableURI = @Serializable(with = URISerializer::class) URI
+
+object URISerializer : CloudBufSerializer<URI>() {
+    override val descriptor = PrimitiveSerialDescriptor("URI", PrimitiveKind.STRING)
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: URI
+    ) {
+        buf.writeURI(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): URI {
+        return buf.readURI()
+    }
+}

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/network/codec/kotlinx/java/UUIDSerializer.kt

@@ -0,0 +1,28 @@
+package dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.java
+
+import dev.slne.surf.cloud.api.common.netty.network.codec.kotlinx.CloudBufSerializer
+import dev.slne.surf.cloud.api.common.netty.protocol.buffer.SurfByteBuf
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.buildClassSerialDescriptor
+import org.gradle.internal.impldep.kotlinx.serialization.descriptors.element
+import java.util.UUID
+
+typealias SerializableUUID = @Serializable(with = UUIDSerializer::class) UUID
+
+object UUIDSerializer: CloudBufSerializer<UUID>() {
+    override val descriptor = buildClassSerialDescriptor("UUID") {
+        element<Long>("mostSignificantBits")
+        element<Long>("leastSignificantBits")
+    }
+
+    override fun serialize0(
+        buf: SurfByteBuf,
+        value: UUID
+    ) {
+        buf.writeUuid(value)
+    }
+
+    override fun deserialize0(buf: SurfByteBuf): UUID {
+        return buf.readUuid()
+    }
+}