feat: add codecs and serializers for InetAddress, Inet4Address, and Inet6Address; implement error handling for invalid addresses

twisti-dev · twisti-dev · commit 761757db8688 · 2025-09-28T19:46:58.000+02:00
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/SurfCodecs.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/SurfCodecs.kt
@@ -20,6 +20,10 @@ import dev.slne.surf.surfapi.core.api.serializer.java.datetime.datetime.zdt.Zone
 import dev.slne.surf.surfapi.core.api.serializer.java.datetime.time.local.LocalTimeCodec
 import dev.slne.surf.surfapi.core.api.serializer.java.datetime.zone.id.ZoneIdCodec
 import dev.slne.surf.surfapi.core.api.serializer.java.datetime.zone.offset.ZoneOffsetCodec
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inet.InetAddressCodec
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inetsocket.InetSocketAddressCodec
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv4.Inet4AddressCodec
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv6.Inet6AddressCodec
 import dev.slne.surf.surfapi.core.api.serializer.java.uri.URICodec
 import dev.slne.surf.surfapi.core.api.serializer.java.uuid.JavaUUIDCodec
 import dev.slne.surf.surfapi.core.api.serializer.spongepowered.math.matrix.m2d.SpongeMatrix2dCodec
@@ -105,5 +109,9 @@ object SurfCodecs {
     val LOCAL_TIME = LocalTimeCodec.CODEC
     val ZONE_ID = ZoneIdCodec.CODEC
     val ZONE_OFFSET = ZoneOffsetCodec.CODEC
+    val INET_ADDRESS = InetAddressCodec.CODEC
+    val INET_SOCKET_ADDRESS = InetSocketAddressCodec.CODEC
+    val INET4_ADDRESS = Inet4AddressCodec.CODEC
+    val INET6_ADDRESS = Inet6AddressCodec.CODEC
     // endregion
 }
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/SurfSerializerModule.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/SurfSerializerModule.kt
@@ -21,6 +21,10 @@ import dev.slne.surf.surfapi.core.api.serializer.java.datetime.datetime.zdt.Zone
 import dev.slne.surf.surfapi.core.api.serializer.java.datetime.time.local.LocalTimeSerializer
 import dev.slne.surf.surfapi.core.api.serializer.java.datetime.zone.id.ZonedIdSerializer
 import dev.slne.surf.surfapi.core.api.serializer.java.datetime.zone.offset.ZoneOffsetSerializer
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inet.InetAddressSerializer
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inetsocket.InetSocketAddressSerializer
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv4.Inet4AddressSerializer
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv6.Inet6AddressSerializer
 import dev.slne.surf.surfapi.core.api.serializer.java.uri.URISerializer
 import dev.slne.surf.surfapi.core.api.serializer.java.uuid.JavaUUIDSerializer
 import dev.slne.surf.surfapi.core.api.serializer.spongepowered.math.matrix.m2d.SpongeMatrix2dSerializer
@@ -110,6 +114,10 @@ object SurfSerializerModule {
         contextual(LocalTimeSerializer)
         contextual(ZonedIdSerializer)
         contextual(ZoneOffsetSerializer)
+        contextual(InetAddressSerializer)
+        contextual(InetSocketAddressSerializer)
+        contextual(Inet4AddressSerializer)
+        contextual(Inet6AddressSerializer)
     }
 
     val all = SerializersModule {
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/codec-extensions.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/codec-extensions.kt
@@ -53,15 +53,24 @@ fun <A> Codec<A>.positive(
     }
 }
 
+@JvmName("positiveLong")
 fun Codec<Long>.positive(zeroAllowed: Boolean = true) = positive(zeroAllowed, 0L, Long::compareTo)
+
+@JvmName("positiveInt")
 fun Codec<Int>.positive(zeroAllowed: Boolean = true) = positive(zeroAllowed, 0, Int::compareTo)
+
+@JvmName("positiveDouble")
 fun Codec<Double>.positive(zeroAllowed: Boolean = true) =
     positive(zeroAllowed, 0.0, Double::compareTo)
 
+@JvmName("positiveFloat")
 fun Codec<Float>.positive(zeroAllowed: Boolean = true) = positive(zeroAllowed, 0f, Float::compareTo)
+
+@JvmName("positiveShort")
 fun Codec<Short>.positive(zeroAllowed: Boolean = true) =
     positive(zeroAllowed, 0.toShort(), Short::compareTo)
 
+@JvmName("positiveByte")
 fun Codec<Byte>.positive(zeroAllowed: Boolean = true) =
     positive(zeroAllowed, 0.toByte(), Byte::compareTo)
 
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inet/InetAddressCodec.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inet/InetAddressCodec.kt
@@ -1,9 +1,19 @@
 package dev.slne.surf.surfapi.core.api.serializer.java.ip.inet
 
 import com.mojang.serialization.Codec
+import com.mojang.serialization.DataResult
 import java.net.InetAddress
+import java.net.UnknownHostException
 
 object InetAddressCodec {
-    val CODEC: Codec<InetAddress> =
-        Codec.STRING.xmap({ InetAddress.getByName(it) }, { it.hostName })
+    val CODEC: Codec<InetAddress> = Codec.STRING
+        .comapFlatMap({ hostName ->
+            try {
+                DataResult.success(InetAddress.getByName(hostName))
+            } catch (e: UnknownHostException) {
+                DataResult.error { "Unknown host: $hostName (${e.message ?: "no details"})" }
+            } catch (e: SecurityException) {
+                DataResult.error { "Security exception when resolving host: $hostName (${e.message ?: "no details"})" }
+            }
+        }, InetAddress::getHostName)
 }
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inet/InetAddressSerializer.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inet/InetAddressSerializer.kt
@@ -5,10 +5,26 @@ package dev.slne.surf.surfapi.core.api.serializer.java.ip.inet
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
-import kotlinx.serialization.Serializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 import java.net.InetAddress
 
 typealias SerializableInetAddress = @Serializable(with = InetAddressSerializer::class) InetAddress
 
-@Serializer(forClass = InetAddress::class)
-object InetAddressSerializer : KSerializer<InetAddress>
+object InetAddressSerializer : KSerializer<InetAddress> {
+    override val descriptor =
+        PrimitiveSerialDescriptor("surfapi.java.ip.InetAddress", PrimitiveKind.STRING)
+
+    override fun serialize(
+        encoder: Encoder,
+        value: InetAddress,
+    ) {
+        encoder.encodeString(value.hostAddress)
+    }
+
+    override fun deserialize(decoder: Decoder): InetAddress {
+        return InetAddress.getByName(decoder.decodeString())
+    }
+}
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inetsocket/InetSocketAddressCodec.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inetsocket/InetSocketAddressCodec.kt
@@ -2,15 +2,17 @@ package dev.slne.surf.surfapi.core.api.serializer.java.ip.inetsocket
 
 import com.mojang.serialization.Codec
 import com.mojang.serialization.codecs.RecordCodecBuilder
+import dev.slne.surf.surfapi.core.api.serializer.ranged
 import java.net.InetSocketAddress
 
 object InetSocketAddressCodec {
     val CODEC: Codec<InetSocketAddress> = RecordCodecBuilder.create { instance ->
         instance.group(
             Codec.STRING.fieldOf("address").forGetter(InetSocketAddress::getHostName),
-            Codec.INT.fieldOf("port").forGetter(InetSocketAddress::getPort),
-        ).apply(instance) { address, port ->
-            InetSocketAddress(address, port)
-        }
+            Codec.INT
+                .ranged(0, 0xFFFF)
+                .fieldOf("port")
+                .forGetter(InetSocketAddress::getPort),
+        ).apply(instance, ::InetSocketAddress)
     }
 }
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inetsocket/InetSocketAddressSerializer.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/inetsocket/InetSocketAddressSerializer.kt
@@ -7,10 +7,7 @@ import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.descriptors.buildClassSerialDescriptor
 import kotlinx.serialization.descriptors.element
-import kotlinx.serialization.encoding.Decoder
-import kotlinx.serialization.encoding.Encoder
-import kotlinx.serialization.encoding.decodeStructure
-import kotlinx.serialization.encoding.encodeStructure
+import kotlinx.serialization.encoding.*
 import java.net.InetSocketAddress
 
 typealias SerializableInetSocketAddress = @Serializable(with = InetSocketAddressSerializer::class) InetSocketAddress
@@ -37,10 +34,11 @@ object InetSocketAddressSerializer : KSerializer<InetSocketAddress> {
             hostname = decodeStringElement(descriptor, 0)
             port = decodeIntElement(descriptor, 1)
         } else while (true) {
-            when (decodeElementIndex(descriptor)) {
+            when (val index = decodeElementIndex(descriptor)) {
                 0 -> hostname = decodeStringElement(descriptor, 0)
                 1 -> port = decodeIntElement(descriptor, 1)
-                else -> break
+                CompositeDecoder.DECODE_DONE -> break
+                else -> error("Unexpected index: $index")
             }
         }
 
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv4/Inet4AddressCodec.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv4/Inet4AddressCodec.kt
@@ -1,9 +1,17 @@
 package dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv4
 
 import com.mojang.serialization.Codec
+import com.mojang.serialization.DataResult
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inet.InetAddressCodec
 import java.net.Inet4Address
+import java.util.function.Function
 
 object Inet4AddressCodec {
-    val CODEC: Codec<Inet4Address> =
-        Codec.STRING.xmap({ Inet4Address.getByName(it) as Inet4Address }, { it.hostName })
+    val CODEC: Codec<Inet4Address> = InetAddressCodec.CODEC.comapFlatMap({ address ->
+        if (address is Inet4Address) {
+            DataResult.success(address)
+        } else {
+            DataResult.error { "Not an IPv4 address: $address" }
+        }
+    }, Function.identity())
 }
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv4/Inet4AddressSerializer.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv4/Inet4AddressSerializer.kt
@@ -2,13 +2,31 @@
 
 package dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv4
 
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inet.InetAddressSerializer
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
-import kotlinx.serialization.Serializer
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 import java.net.Inet4Address
 
 typealias SerializableInet4Address = @Serializable(with = Inet4AddressSerializer::class) Inet4Address
 
-@Serializer(forClass = Inet4Address::class)
-object Inet4AddressSerializer : KSerializer<Inet4Address>
+object Inet4AddressSerializer : KSerializer<Inet4Address> {
+    override val descriptor =
+        SerialDescriptor("surfapi.java.ip.Inet4Address", InetAddressSerializer.descriptor)
+
+    override fun serialize(
+        encoder: Encoder,
+        value: Inet4Address,
+    ) {
+        encoder.encodeSerializableValue(InetAddressSerializer, value)
+    }
+
+    override fun deserialize(decoder: Decoder): Inet4Address {
+        val address = decoder.decodeSerializableValue(InetAddressSerializer)
+        require(address is Inet4Address) { "Not an IPv4 address: $address" }
+        return address
+    }
+}
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv6/Inet6AddressCodec.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv6/Inet6AddressCodec.kt
@@ -1,9 +1,17 @@
 package dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv6
 
 import com.mojang.serialization.Codec
+import com.mojang.serialization.DataResult
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inet.InetAddressCodec
 import java.net.Inet6Address
+import java.util.function.Function
 
 object Inet6AddressCodec {
-    val CODEC: Codec<Inet6Address> =
-        Codec.STRING.xmap({ Inet6Address.getByName(it) as Inet6Address }, { it.hostName })
+    val CODEC: Codec<Inet6Address> = InetAddressCodec.CODEC.comapFlatMap({ address ->
+        if (address is Inet6Address) {
+            DataResult.success(address)
+        } else {
+            DataResult.error { "Not an IPv6 address: $address" }
+        }
+    }, Function.identity())
 }
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv6/Inet6AddressSerializer.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/ip/ipv6/Inet6AddressSerializer.kt
@@ -2,13 +2,31 @@
 
 package dev.slne.surf.surfapi.core.api.serializer.java.ip.ipv6
 
+import dev.slne.surf.surfapi.core.api.serializer.java.ip.inet.InetAddressSerializer
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
-import kotlinx.serialization.Serializer
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 import java.net.Inet6Address
 
 typealias SerializableInet6Address = @Serializable(with = Inet6AddressSerializer::class) Inet6Address
 
-@Serializer(forClass = Inet6Address::class)
-object Inet6AddressSerializer : KSerializer<Inet6Address>
+object Inet6AddressSerializer : KSerializer<Inet6Address> {
+    override val descriptor =
+        SerialDescriptor("surfapi.java.ip.Inet6Address", InetAddressSerializer.descriptor)
+
+    override fun serialize(
+        encoder: Encoder,
+        value: Inet6Address,
+    ) {
+        encoder.encodeSerializableValue(InetAddressSerializer, value)
+    }
+
+    override fun deserialize(decoder: Decoder): Inet6Address {
+        val address = decoder.decodeSerializableValue(InetAddressSerializer)
+        require(address is Inet6Address) { "Not an IPv6 address: $address" }
+        return address
+    }
+}
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/uri/URISerializer.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/uri/URISerializer.kt
@@ -5,10 +5,22 @@ package dev.slne.surf.surfapi.core.api.serializer.java.uri
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
-import kotlinx.serialization.Serializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 import java.net.URI
 
 typealias SerializableURI = @Serializable(with = URISerializer::class) URI
 
-@Serializer(forClass = URI::class)
-object URISerializer : KSerializer<URI>
+object URISerializer : KSerializer<URI> {
+    override val descriptor = PrimitiveSerialDescriptor("surfapi.JavaURI", PrimitiveKind.STRING)
+
+    override fun serialize(encoder: Encoder, value: URI) {
+        encoder.encodeString(value.toString())
+    }
+
+    override fun deserialize(decoder: Decoder): URI {
+        return URI.create(decoder.decodeString())
+    }
+}
diff --git a/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/url/URLSerializer.kt b/surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/serializer/java/url/URLSerializer.kt
@@ -3,12 +3,8 @@
 package dev.slne.surf.surfapi.core.api.serializer.java.url
 
 import kotlinx.serialization.ExperimentalSerializationApi
-import kotlinx.serialization.KSerializer
-import kotlinx.serialization.Serializable
-import kotlinx.serialization.Serializer
-import java.net.URL
 
-typealias SerializableURL = @Serializable(with = URLSerializer::class) URL
-
-@Serializer(forClass = URL::class)
-object URLSerializer : KSerializer<URL>
+//typealias SerializableURL = @Serializable(with = URLSerializer::class) URL
+//
+//@Serializer(forClass = URL::class)
+//object URLSerializer : KSerializer<URL>
