[AIT-208] feat: update LiveObjects messages fields to support protocol v6

- Expose typed fields on public `ObjectData` (`boolean`, `bytes`, `number`, `string`, `json`)
- Remove previous field names on `ObjectData`

Author: ttypic

liveobjects/src/main/kotlin/io/ably/lib/objects/Helpers.kt

@@ -161,19 +161,4 @@ internal fun ObjectsAdapter.throwIfEchoMessagesDisabled() {
    }
 }
 
-internal class Binary(val data: ByteArray) {
-  override fun equals(other: Any?): Boolean {
-    if (this === other) return true
-    if (other !is Binary) return false
-    return data.contentEquals(other.data)
-  }
-
-  override fun hashCode(): Int {
-    return data.contentHashCode()
-  }
-}
-
-internal fun Binary.size(): Int {
-  return data.size
-}
 

liveobjects/src/main/kotlin/io/ably/lib/objects/ObjectMessage.kt

@@ -1,11 +1,13 @@
 package io.ably.lib.objects
 
+import com.google.gson.JsonElement
 import com.google.gson.JsonObject
 
 import com.google.gson.annotations.JsonAdapter
 import com.google.gson.annotations.SerializedName
 import io.ably.lib.objects.serialization.ObjectDataJsonSerializer
 import io.ably.lib.objects.serialization.gson
+import java.util.Base64
 
 /**
  * An enum class representing the different actions that can be performed on an object.
@@ -42,28 +44,21 @@ internal data class ObjectData(
    */
   val objectId: String? = null,
 
-  /**
-   * String, number, boolean or binary - a concrete value of the object
-   * Spec: OD2c
-   */
-  val value: ObjectValue? = null,
-)
+  /** String value. Spec: OD2c */
+  val string: String? = null,
 
-/**
- * Represents a value that can be a String, Number, Boolean, Binary, JsonObject or JsonArray.
- * Provides compile-time type safety through sealed class pattern.
- * Spec: OD2c
- */
-internal sealed class ObjectValue {
-  abstract val value: Any
-
-  data class String(override val value: kotlin.String) : ObjectValue()
-  data class Number(override val value: kotlin.Number) : ObjectValue()
-  data class Boolean(override val value: kotlin.Boolean) : ObjectValue()
-  data class Binary(override val value: io.ably.lib.objects.Binary) : ObjectValue()
-  data class JsonObject(override val value: com.google.gson.JsonObject) : ObjectValue()
-  data class JsonArray(override val value: com.google.gson.JsonArray) : ObjectValue()
-}
+  /** Numeric value. Spec: OD2c */
+  val number: Double? = null,
+
+  /** Boolean value. Spec: OD2c */
+  val boolean: Boolean? = null,
+
+  /** Binary value encoded as a base64 string. Spec: OD2c */
+  val bytes: String? = null,
+
+  /** JSON object or array value. Spec: OD2c */
+  val json: JsonElement? = null,
+)
 
 /**
  * Payload for MAP_CREATE operation.
@@ -390,7 +385,7 @@ internal data class ObjectMessage(
  * Spec: OM3
  */
 internal fun ObjectMessage.size(): Int {
-  val clientIdSize = clientId?.length ?: 0 // Spec: OM3f
+  val clientIdSize = clientId?.byteSize ?: 0 // Spec: OM3f
   val operationSize = operation?.size() ?: 0 // Spec: OM3b, OOP4
   val objectStateSize = objectState?.size() ?: 0 // Spec: OM3c, OST3
   val extrasSize = extras?.let { gson.toJson(it).length } ?: 0 // Spec: OM3d
@@ -432,21 +427,21 @@ private fun ObjectState.size(): Int {
  * Calculates the size of a MapCreate payload in bytes.
  */
 private fun MapCreate.size(): Int {
-  return entries.entries.sumOf { it.key.length + it.value.size() }
+  return entries.entries.sumOf { it.key.byteSize + it.value.size() }
 }
 
 /**
  * Calculates the size of a MapSet payload in bytes.
  */
 private fun MapSet.size(): Int {
-  return key.length + value.size()
+  return key.byteSize + value.size()
 }
 
 /**
  * Calculates the size of a MapRemove payload in bytes.
  */
 private fun MapRemove.size(): Int {
-  return key.length
+  return key.byteSize
 }
 
 /**
@@ -467,14 +462,14 @@ private fun CounterInc.size(): Int {
  * Calculates the size of a MapCreateWithObjectId payload in bytes.
  */
 private fun MapCreateWithObjectId.size(): Int {
-  return initialValue.length + nonce.length
+  return initialValue.byteSize + nonce.byteSize
 }
 
 /**
  * Calculates the size of a CounterCreateWithObjectId payload in bytes.
  */
 private fun CounterCreateWithObjectId.size(): Int {
-  return initialValue.length + nonce.length
+  return initialValue.byteSize + nonce.byteSize
 }
 
 /**
@@ -513,23 +508,19 @@ private fun ObjectsMapEntry.size(): Int {
  * Spec: OD3
  */
 private fun ObjectData.size(): Int {
-  return value?.size() ?: 0 // Spec: OD3f
-}
-
-/**
- * Calculates the size of an ObjectValue in bytes.
- * Spec: OD3*
- */
-private fun ObjectValue.size(): Int {
-  return when (this) {
-    is ObjectValue.Boolean -> 1 // Spec: OD3b
-    is ObjectValue.Binary -> value.size() // Spec: OD3c
-    is ObjectValue.Number -> 8 // Spec: OD3d
-    is ObjectValue.String -> value.byteSize // Spec: OD3e
-    is ObjectValue.JsonObject, is ObjectValue.JsonArray -> value.toString().byteSize // Spec: OD3e
-  }
+  string?.let { return it.byteSize } // Spec: OD3e
+  number?.let { return 8 } // Spec: OD3d
+  boolean?.let { return 1 } // Spec: OD3b
+  bytes?.let { return Base64.getDecoder().decode(it).size } // Spec: OD3c
+  json?.let { return it.toString().byteSize } // Spec: OD3e
+  return 0
 }
 
 internal fun ObjectData?.isInvalid(): Boolean {
-  return this?.objectId.isNullOrEmpty() && this?.value == null
+  return this?.objectId.isNullOrEmpty() &&
+    this?.string == null &&
+    this?.number == null &&
+    this?.boolean == null &&
+    this?.bytes == null &&
+    this?.json == null
 }

liveobjects/src/main/kotlin/io/ably/lib/objects/serialization/JsonSerialization.kt

@@ -1,14 +1,11 @@
 package io.ably.lib.objects.serialization
 
 import com.google.gson.*
-import io.ably.lib.objects.Binary
 import io.ably.lib.objects.ObjectsMapSemantics
 import io.ably.lib.objects.ObjectData
 import io.ably.lib.objects.ObjectMessage
 import io.ably.lib.objects.ObjectOperationAction
-import io.ably.lib.objects.ObjectValue
 import java.lang.reflect.Type
-import java.util.*
 import kotlin.enums.EnumEntries
 
 // Gson instance for JSON serialization/deserialization
@@ -45,42 +42,26 @@ internal class ObjectDataJsonSerializer : JsonSerializer<ObjectData>, JsonDeseri
   override fun serialize(src: ObjectData, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
     val obj = JsonObject()
     src.objectId?.let { obj.addProperty("objectId", it) }
-
-    src.value?.let { v ->
-      when (v) {
-        is ObjectValue.Boolean -> obj.addProperty("boolean", v.value)
-        is ObjectValue.String -> obj.addProperty("string", v.value)
-        is ObjectValue.Number -> obj.addProperty("number", v.value.toDouble())
-        is ObjectValue.Binary -> obj.addProperty("bytes", Base64.getEncoder().encodeToString(v.value.data))
-        is ObjectValue.JsonObject, is ObjectValue.JsonArray -> obj.addProperty("json", v.value.toString()) // Spec: OD4c5
-      }
-    }
+    src.string?.let { obj.addProperty("string", it) }
+    src.number?.let { obj.addProperty("number", it) }
+    src.boolean?.let { obj.addProperty("boolean", it) }
+    src.bytes?.let { obj.addProperty("bytes", it) }
+    src.json?.let { obj.addProperty("json", it.toString()) } // Spec: OD4c5
     return obj
   }
 
   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 value = when {
-      obj.has("boolean") -> ObjectValue.Boolean(obj.get("boolean").asBoolean)
-      obj.has("string") -> ObjectValue.String(obj.get("string").asString)
-      obj.has("number") -> ObjectValue.Number(obj.get("number").asDouble)
-      obj.has("bytes") -> ObjectValue.Binary(Binary(Base64.getDecoder().decode(obj.get("bytes").asString)))
-      obj.has("json") -> {
-        val jsonElement = JsonParser.parseString(obj.get("json").asString)
-        when {
-          jsonElement.isJsonObject -> ObjectValue.JsonObject(jsonElement.asJsonObject)
-          jsonElement.isJsonArray -> ObjectValue.JsonArray(jsonElement.asJsonArray)
-          else -> throw JsonParseException("Invalid JSON structure")
-        }
-      }
-      else -> {
-        if (objectId != null)
-          null
-        else
-          throw JsonParseException("Since objectId is not present, at least one of the value fields must be present")
-      }
+    val string = if (obj.has("string")) obj.get("string").asString else null
+    val number = if (obj.has("number")) obj.get("number").asDouble else null
+    val boolean = if (obj.has("boolean")) obj.get("boolean").asBoolean else null
+    val bytes = if (obj.has("bytes")) obj.get("bytes").asString else null
+    val json = if (obj.has("json")) JsonParser.parseString(obj.get("json").asString) else null
+
+    if (objectId == null && string == null && number == null && boolean == null && bytes == null && json == null) {
+      throw JsonParseException("Since objectId is not present, at least one of the value fields must be present")
     }
-    return ObjectData(objectId, value)
+    return ObjectData(objectId = objectId, string = string, number = number, boolean = boolean, bytes = bytes, json = json)
   }
 }

liveobjects/src/main/kotlin/io/ably/lib/objects/serialization/MsgpackSerialization.kt

@@ -1,9 +1,9 @@
 package io.ably.lib.objects.serialization
 
+import com.google.gson.JsonElement
 import com.google.gson.JsonObject
 import com.google.gson.JsonParser
 import io.ably.lib.objects.*
-import io.ably.lib.objects.Binary
 import io.ably.lib.objects.CounterCreate
 import io.ably.lib.objects.CounterCreateWithObjectId
 import io.ably.lib.objects.CounterInc
@@ -22,7 +22,7 @@ import io.ably.lib.objects.ObjectMessage
 import io.ably.lib.objects.ObjectOperation
 import io.ably.lib.objects.ObjectOperationAction
 import io.ably.lib.objects.ObjectState
-import io.ably.lib.objects.ObjectValue
+import java.util.Base64
 import io.ably.lib.util.Serialisation
 import org.msgpack.core.MessageFormat
 import org.msgpack.core.MessagePacker
@@ -806,9 +806,11 @@ private fun ObjectData.writeMsgpack(packer: MessagePacker) {
   var fieldCount = 0
 
   if (objectId != null) fieldCount++
-  value?.let {
-    fieldCount++
-  }
+  if (string != null) fieldCount++
+  if (number != null) fieldCount++
+  if (boolean != null) fieldCount++
+  if (bytes != null) fieldCount++
+  if (json != null) fieldCount++
 
   packer.packMapHeader(fieldCount)
 
@@ -817,34 +819,31 @@ private fun ObjectData.writeMsgpack(packer: MessagePacker) {
     packer.packString(objectId)
   }
 
-  value?.let { v ->
-    when (v) {
-      is ObjectValue.Boolean -> {
-        packer.packString("boolean")
-        packer.packBoolean(v.value)
-      }
-      is ObjectValue.String -> {
-        packer.packString("string")
-        packer.packString(v.value)
-      }
-      is ObjectValue.Number -> {
-        packer.packString("number")
-        packer.packDouble(v.value.toDouble())
-      }
-      is ObjectValue.Binary -> {
-        packer.packString("bytes")
-        packer.packBinaryHeader(v.value.data.size)
-        packer.writePayload(v.value.data)
-      }
-      is ObjectValue.JsonObject -> {
-        packer.packString("json")
-        packer.packString(v.value.toString())
-      }
-      is ObjectValue.JsonArray -> {
-        packer.packString("json")
-        packer.packString(v.value.toString())
-      }
-    }
+  if (string != null) {
+    packer.packString("string")
+    packer.packString(string)
+  }
+
+  if (number != null) {
+    packer.packString("number")
+    packer.packDouble(number)
+  }
+
+  if (boolean != null) {
+    packer.packString("boolean")
+    packer.packBoolean(boolean)
+  }
+
+  if (bytes != null) {
+    val rawBytes = Base64.getDecoder().decode(bytes)
+    packer.packString("bytes")
+    packer.packBinaryHeader(rawBytes.size)
+    packer.writePayload(rawBytes)
+  }
+
+  if (json != null) {
+    packer.packString("json")
+    packer.packString(json.toString())
   }
 }
 
@@ -854,7 +853,11 @@ private fun ObjectData.writeMsgpack(packer: MessagePacker) {
 private fun readObjectData(unpacker: MessageUnpacker): ObjectData {
   val fieldCount = unpacker.unpackMapHeader()
   var objectId: String? = null
-  var value: ObjectValue? = null
+  var string: String? = null
+  var number: Double? = null
+  var boolean: Boolean? = null
+  var bytes: String? = null
+  var json: JsonElement? = null
 
   for (i in 0 until fieldCount) {
     val fieldName = unpacker.unpackString().intern()
@@ -867,28 +870,19 @@ private fun readObjectData(unpacker: MessageUnpacker): ObjectData {
 
     when (fieldName) {
       "objectId" -> objectId = unpacker.unpackString()
-      "boolean" -> value = ObjectValue.Boolean(unpacker.unpackBoolean())
-      "string" -> value = ObjectValue.String(unpacker.unpackString())
-      "number" -> value = ObjectValue.Number(unpacker.unpackDouble())
+      "string" -> string = unpacker.unpackString()
+      "number" -> number = unpacker.unpackDouble()
+      "boolean" -> boolean = unpacker.unpackBoolean()
       "bytes" -> {
         val size = unpacker.unpackBinaryHeader()
-        val bytes = ByteArray(size)
-        unpacker.readPayload(bytes)
-        value = ObjectValue.Binary(Binary(bytes))
-      }
-      "json" -> {
-        val jsonString = unpacker.unpackString()
-        val parsed = JsonParser.parseString(jsonString)
-        value = when {
-          parsed.isJsonObject -> ObjectValue.JsonObject(parsed.asJsonObject)
-          parsed.isJsonArray -> ObjectValue.JsonArray(parsed.asJsonArray)
-          else ->
-            throw ablyException("Invalid JSON string for json field", ErrorCode.MapValueDataTypeUnsupported, HttpStatusCode.InternalServerError)
-        }
+        val rawBytes = ByteArray(size)
+        unpacker.readPayload(rawBytes)
+        bytes = Base64.getEncoder().encodeToString(rawBytes)
       }
+      "json" -> json = JsonParser.parseString(unpacker.unpackString())
       else -> unpacker.skipValue()
     }
   }
 
-  return ObjectData(objectId = objectId, value = value)
+  return ObjectData(objectId = objectId, string = string, number = number, boolean = boolean, bytes = bytes, json = json)
 }