UtcOffset serialization (as a string primitive)

Author: ilya-g

core/common/src/TimeZone.kt

@@ -10,6 +10,7 @@ package kotlinx.datetime
 
 import kotlinx.datetime.serializers.TimeZoneSerializer
 import kotlinx.datetime.serializers.FixedOffsetTimeZoneSerializer
+import kotlinx.datetime.serializers.UtcOffsetSerializer
 import kotlinx.serialization.Serializable
 
 @Serializable(with = TimeZoneSerializer::class)
@@ -97,6 +98,7 @@ public expect class FixedOffsetTimeZone : TimeZone {
 @Deprecated("Use FixedOffsetTimeZone of UtcOffset instead", ReplaceWith("FixedOffsetTimeZone"))
 public typealias ZoneOffset = FixedOffsetTimeZone
 
+@Serializable(with = UtcOffsetSerializer::class)
 public expect class UtcOffset {
     public val totalSeconds: Int
 

core/common/src/serializers/TimeZoneSerializers.kt

@@ -7,6 +7,7 @@ package kotlinx.datetime.serializers
 
 import kotlinx.datetime.FixedOffsetTimeZone
 import kotlinx.datetime.TimeZone
+import kotlinx.datetime.UtcOffset
 import kotlinx.serialization.*
 import kotlinx.serialization.descriptors.*
 import kotlinx.serialization.encoding.*
@@ -25,7 +26,7 @@ public object TimeZoneSerializer: KSerializer<TimeZone> {
 
 public object FixedOffsetTimeZoneSerializer: KSerializer<FixedOffsetTimeZone> {
 
-    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("ZoneOffset", PrimitiveKind.STRING)
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("FixedOffsetTimeZone", PrimitiveKind.STRING)
 
     override fun deserialize(decoder: Decoder): FixedOffsetTimeZone {
         val zone = TimeZone.of(decoder.decodeString())
@@ -41,3 +42,17 @@ public object FixedOffsetTimeZoneSerializer: KSerializer<FixedOffsetTimeZone> {
     }
 
 }
+
+public object UtcOffsetSerializer: KSerializer<UtcOffset> {
+
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("UtcOffset", PrimitiveKind.STRING)
+
+    override fun deserialize(decoder: Decoder): UtcOffset {
+        return UtcOffset.parse(decoder.decodeString())
+    }
+
+    override fun serialize(encoder: Encoder, value: UtcOffset) {
+        encoder.encodeString(value.toString())
+    }
+
+}

core/js/src/TimeZone.kt

@@ -7,6 +7,7 @@ package kotlinx.datetime
 import kotlinx.datetime.internal.JSJoda.ZoneId
 import kotlinx.datetime.serializers.TimeZoneSerializer
 import kotlinx.datetime.serializers.FixedOffsetTimeZoneSerializer
+import kotlinx.datetime.serializers.UtcOffsetSerializer
 import kotlinx.serialization.Serializable
 import kotlinx.datetime.internal.JSJoda.ZoneOffset as jtZoneOffset
 
@@ -54,6 +55,7 @@ public actual class FixedOffsetTimeZone actual constructor(public actual val utc
     public actual val totalSeconds: Int get() = zoneOffset.totalSeconds().toInt()
 }
 
+@Serializable(with = UtcOffsetSerializer::class)
 public actual class UtcOffset(internal val zoneOffset: jtZoneOffset) {
     public actual val totalSeconds: Int get() = zoneOffset.totalSeconds().toInt()
 

core/jvm/src/TimeZoneJvm.kt

@@ -10,6 +10,7 @@ package kotlinx.datetime
 
 import kotlinx.datetime.serializers.TimeZoneSerializer
 import kotlinx.datetime.serializers.FixedOffsetTimeZoneSerializer
+import kotlinx.datetime.serializers.UtcOffsetSerializer
 import kotlinx.serialization.Serializable
 import java.time.DateTimeException
 import java.time.ZoneId
@@ -58,6 +59,7 @@ public actual constructor(public actual val utcOffset: UtcOffset): TimeZone(utcO
     public actual val totalSeconds: Int get() = utcOffset.totalSeconds
 }
 
+@Serializable(with = UtcOffsetSerializer::class)
 public actual class UtcOffset(internal val zoneOffset: jtZoneOffset) {
     public actual val totalSeconds: Int get() = zoneOffset.totalSeconds
 

core/native/src/TimeZone.kt

@@ -10,6 +10,7 @@ package kotlinx.datetime
 
 import kotlinx.datetime.serializers.TimeZoneSerializer
 import kotlinx.datetime.serializers.FixedOffsetTimeZoneSerializer
+import kotlinx.datetime.serializers.UtcOffsetSerializer
 import kotlin.math.abs
 import kotlin.native.concurrent.*
 import kotlinx.serialization.Serializable
@@ -105,6 +106,7 @@ public actual class FixedOffsetTimeZone internal constructor(public actual val u
 }
 
 
+@Serializable(with = UtcOffsetSerializer::class)
 public actual class UtcOffset internal constructor(public actual val totalSeconds: Int) {
     private val id: String = zoneIdByOffset(totalSeconds)
 

serialization/common/test/TimeZoneSerializationTest.kt

@@ -49,4 +49,5 @@ class TimeZoneSerializationTest {
         zoneOffsetSerialization(Json.serializersModule.serializer())
         serialization(Json.serializersModule.serializer())
     }
-}
+}
+

serialization/common/test/UtcOffsetSerializationTest.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019-2021 JetBrains s.r.o.
+ * Use of this source code is governed by the Apache 2.0 License that can be found in the LICENSE.txt file.
+ */
+
+package kotlinx.datetime.serialization.test
+
+import kotlinx.datetime.*
+import kotlinx.datetime.serializers.*
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.json.*
+import kotlinx.serialization.serializer
+import kotlin.test.*
+
+class UtcOffsetSerializationTest {
+
+    private fun testSerializationAsPrimitive(serializer: KSerializer<UtcOffset>) {
+        val offset2h = UtcOffset.parse("+2")
+        assertEquals("\"+02:00\"", Json.encodeToString(serializer, offset2h))
+        assertEquals(offset2h, Json.decodeFromString(serializer, "\"+02:00\""))
+        assertEquals(offset2h, Json.decodeFromString(serializer, "\"+02\""))
+        assertEquals(offset2h, Json.decodeFromString(serializer, "\"+2\""))
+
+        assertFailsWith<IllegalArgumentException> {
+            Json.decodeFromString(serializer, "\"UTC+02:00\"") // not an offset
+        }
+    }
+
+    @Test
+    fun defaultSerializer() {
+        testSerializationAsPrimitive(Json.serializersModule.serializer())
+    }
+
+    @Test
+    fun stringPrimitiveSerializer() {
+        testSerializationAsPrimitive(UtcOffsetSerializer)
+    }
+}