[ECO-5386] Updated unit tests for ObjectMesssage serialization

1. Updated test for testOmitNullsInObjectMessageSerialization
2. Added test HandleNullsInObjectMessageDeserialization

Author: sacOO7

gradle/libs.versions.toml

@@ -26,7 +26,7 @@ turbine = "1.2.0"
 ktor = "3.1.3"
 jetbrains-annoations = "26.0.2"
 jackson-msgpack = "0.8.11" # Compatible with msgpack-core 0.8.11
-jackson-param = "2.18.0" # Compatible with jackson-msgpack
+jackson-param = "2.19.1" # Compatible with jackson-msgpack
 
 [libraries]
 gson = { group = "com.google.code.gson", name = "gson", version.ref = "gson" }

live-objects/src/main/kotlin/io/ably/lib/objects/Serialization.kt

@@ -87,11 +87,11 @@ internal class DefaultLiveObjectSerializer : LiveObjectSerializer {
 }
 
 internal class ObjectDataJsonSerializer : JsonSerializer<ObjectData>, JsonDeserializer<ObjectData> {
-  override fun serialize(src: ObjectData?, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
+  override fun serialize(src: ObjectData, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
     val obj = JsonObject()
-    src?.objectId?.let { obj.addProperty("objectId", it) }
+    src.objectId?.let { obj.addProperty("objectId", it) }
 
-    src?.value?.let { value ->
+    src.value?.let { value ->
       when (val v = value.value) {
         is Boolean -> obj.addProperty("boolean", v)
         is String -> obj.addProperty("string", v)
@@ -107,8 +107,8 @@ internal class ObjectDataJsonSerializer : JsonSerializer<ObjectData>, JsonDeseri
     return obj
   }
 
-  override fun deserialize(json: JsonElement?, typeOfT: Type?, context: JsonDeserializationContext?): ObjectData {
-    val obj = if (json?.isJsonObject == true) json.asJsonObject else throw JsonParseException("Expected JsonObject")
+  override fun deserialize(json: JsonElement, typeOfT: Type?, context: JsonDeserializationContext?): ObjectData {
+    val obj = if (json.isJsonObject) json.asJsonObject else throw JsonParseException("Expected JsonObject")
     val objectId = if (obj.has("objectId")) obj.get("objectId").asString else null
     val encoding = if (obj.has("encoding")) obj.get("encoding").asString else null
     val value = when {
@@ -135,10 +135,10 @@ internal class ObjectDataJsonSerializer : JsonSerializer<ObjectData>, JsonDeseri
 }
 
 internal class ObjectDataMsgpackSerializer : com.fasterxml.jackson.databind.JsonSerializer<ObjectData>() {
-  override fun serialize(value: ObjectData?, gen: JsonGenerator, serializers: SerializerProvider) {
+  override fun serialize(value: ObjectData, gen: JsonGenerator, serializers: SerializerProvider) {
     gen.writeStartObject()
-    value?.objectId?.let { gen.writeStringField("objectId", it) }
-    value?.value?.let { v ->
+    value.objectId?.let { gen.writeStringField("objectId", it) }
+    value.value?.let { v ->
       when (val data = v.value) {
         is Boolean -> gen.writeBooleanField("boolean", data)
         is String -> gen.writeStringField("string", data)
@@ -192,8 +192,8 @@ internal class InitialValueJsonSerializer : JsonSerializer<Binary>, JsonDeserial
 }
 
 internal class InitialValueMsgpackSerializer : com.fasterxml.jackson.databind.JsonSerializer<Binary>() {
-  override fun serialize(value: Binary?, gen: JsonGenerator, serializers: SerializerProvider) {
-    gen.writeBinary(value?.data)
+  override fun serialize(value: Binary, gen: JsonGenerator, serializers: SerializerProvider) {
+    gen.writeBinary(value.data)
   }
 }
 

live-objects/src/test/kotlin/io/ably/lib/objects/unit/ObjectMessageSerializationTest.kt

@@ -1,15 +1,20 @@
 package io.ably.lib.objects.unit
 
-import io.ably.lib.objects.gson
-import io.ably.lib.objects.msgpackMapper
+import com.google.gson.Gson
+import com.google.gson.GsonBuilder
+import com.google.gson.JsonElement
+import com.google.gson.JsonNull
 import io.ably.lib.objects.unit.fixtures.*
 import io.ably.lib.types.ProtocolMessage
+import io.ably.lib.types.ProtocolMessage.ActionSerializer
 import io.ably.lib.types.ProtocolSerializer
 import io.ably.lib.util.Serialisation
 import kotlinx.coroutines.test.runTest
 import org.junit.Assert.assertEquals
 import org.junit.Test
 import kotlin.test.assertNotNull
+import kotlin.test.assertNull
+import kotlin.test.assertTrue
 
 class ObjectMessageSerializationTest {
 
@@ -61,18 +66,91 @@ class ObjectMessageSerializationTest {
   }
 
   @Test
-  fun testOmitNullInSerialization() = runTest {
-    val nullableObject = object {
-      val name = "Test Object"
-      val description: String? = null // This will be omitted if using Gson with excludeNulls
-      val value = 42
+  fun testOmitNullsInObjectMessageSerialization() = runTest {
+    val objectMessage = dummyObjectMessageWithStringData()
+    val objectMessageWithNullFields = objectMessage.copy(
+      id = null,
+      timestamp = null,
+      clientId = "test-client",
+      connectionId = "test-connection",
+      extras = null,
+      operation = null,
+      objectState = null,
+      serial = null,
+      siteCode = null
+    )
+    val protocolMessage = ProtocolMessage()
+    protocolMessage.action = ProtocolMessage.Action.`object`
+    protocolMessage.state = arrayOf(objectMessageWithNullFields)
+
+    // check if Gson/Msgpack serialization omits null fields
+    fun assertSerializedObjectMessage(serializedProtoMsg: String) {
+      val deserializedProtoMsg = Gson().fromJson(serializedProtoMsg, JsonElement::class.java).asJsonObject
+      val serializedObjectMessage = deserializedProtoMsg.get("state").asJsonArray[0].asJsonObject.toString()
+      assertEquals("""{"clientId":"test-client","connectionId":"test-connection"}""", serializedObjectMessage)
     }
-    val serializedJsonString = gson.toJson(nullableObject)
-    // check serializedObject does not contain the null field
-    assertEquals("""{"name":"Test Object","value":42}""", serializedJsonString)
 
-    val serializedMsgpackBytes = msgpackMapper.writeValueAsBytes(nullableObject)
-    // check serializedObject does not contain the null field
-    assertEquals("""{"name":"Test Object","value":42}""", Serialisation.msgpackToGson(serializedMsgpackBytes).toString())
+    // Serialize using Gson
+    val serializedProtoMsg = ProtocolSerializer.writeJSON(protocolMessage).toString(Charsets.UTF_8)
+    assertSerializedObjectMessage(serializedProtoMsg)
+
+    // Serialize using MsgPack
+    val serializedMsgpackBytes = ProtocolSerializer.writeMsgpack(protocolMessage)
+    val serializedJsonStringFromMsgpackBytes = Serialisation.msgpackToGson(serializedMsgpackBytes).toString()
+    assertSerializedObjectMessage(serializedJsonStringFromMsgpackBytes)
+  }
+
+  @Test
+  fun testHandleNullsInObjectMessageDeserialization() = runTest {
+    val protocolMessage = ProtocolMessage()
+    protocolMessage.id = "id"
+    protocolMessage.action = ProtocolMessage.Action.`object`
+    protocolMessage.state = null
+
+    // Serialize using Gson with serializeNulls enabled
+    val gsonBuilderCreatingNulls = GsonBuilder()
+      .registerTypeAdapter(ProtocolMessage.Action::class.java, ActionSerializer())
+      .serializeNulls().create()
+
+    var protoMsgJsonObject = gsonBuilderCreatingNulls.toJsonTree(protocolMessage).asJsonObject
+    assertTrue(protoMsgJsonObject.has("state"))
+    assertEquals(JsonNull.INSTANCE, protoMsgJsonObject.get("state"))
+
+    var deserializedProtoMsg = ProtocolSerializer.fromJSON(protoMsgJsonObject.toString())
+    assertNull(deserializedProtoMsg.state)
+
+    var serializedMsgpackBytes = Serialisation.gsonToMsgpack(protoMsgJsonObject)
+    deserializedProtoMsg = ProtocolSerializer.readMsgpack(serializedMsgpackBytes)
+    assertNull(deserializedProtoMsg.state)
+
+    // Create ObjectMessage and serialize in a way that resulting string/bytes include null fields
+    val objectMessage = dummyObjectMessageWithStringData()
+    val objectMessageWithNullFields = objectMessage.copy(
+      id = null,
+      timestamp = null,
+      clientId = "test-client",
+      connectionId = "test-connection",
+      extras = null,
+      operation = objectMessage.operation?.copy(
+        initialValue = null, // initialValue set to null
+        mapOp = objectMessage.operation.mapOp?.copy(
+          data = null // objectData set to null
+        )
+      ),
+      objectState = null,
+      serial = null,
+      siteCode = null
+    )
+    protocolMessage.state = arrayOf(objectMessageWithNullFields)
+    protoMsgJsonObject = gsonBuilderCreatingNulls.toJsonTree(protocolMessage).asJsonObject
+
+    // Check if gson deserialization works correctly
+    deserializedProtoMsg = ProtocolSerializer.fromJSON(protoMsgJsonObject.toString())
+    assertEquals(objectMessageWithNullFields, deserializedProtoMsg.state[0] as? io.ably.lib.objects.ObjectMessage)
+
+    // Check if msgpack deserialization works correctly
+    serializedMsgpackBytes = Serialisation.gsonToMsgpack(protoMsgJsonObject)
+    deserializedProtoMsg = ProtocolSerializer.readMsgpack(serializedMsgpackBytes)
+    assertEquals(objectMessageWithNullFields, deserializedProtoMsg.state[0] as? io.ably.lib.objects.ObjectMessage)
   }
 }