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

- Update `ObjectOperation` fields to protocol v6 names (`mapCreate`, `mapSet`, `mapRemove`, `counterCreate`, `counterInc`). Internally and externally

- Remove previous field names on `ObjectOperation`

Author: ttypic

lib/src/main/java/io/ably/lib/transport/Defaults.java

@@ -12,7 +12,7 @@ public class Defaults {
      * spec: G4
      * </p>
      */
-    public static final String ABLY_PROTOCOL_VERSION = "5";
+    public static final String ABLY_PROTOCOL_VERSION = "6";
 
     public static final String ABLY_AGENT_VERSION   = String.format("%s/%s", "ably-java", BuildConfig.VERSION);
 

lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java

@@ -81,7 +81,7 @@ public void realtime_websocket_param_test() {
              * Defaults.ABLY_VERSION_PARAM, as ultimately the request param has been derived from those values.
              */
             assertEquals("Verify correct version", requestParameters.get("v"),
-                    Collections.singletonList("5"));
+                    Collections.singletonList("6"));
 
             /* Spec RSC7d3
              * This test should not directly validate version against Defaults.ABLY_AGENT_VERSION, nor

lib/src/test/java/io/ably/lib/test/rest/HttpHeaderTest.java

@@ -81,7 +81,7 @@ public void header_lib_channel_publish() {
              * from those values.
              */
             Assert.assertNotNull("Expected headers", headers);
-            Assert.assertEquals(headers.get("x-ably-version"), "5");
+            Assert.assertEquals(headers.get("x-ably-version"), "6");
             Assert.assertEquals(headers.get("ably-agent"), expectedAblyAgentHeader);
             // RSA7e2
             Assert.assertNull("Shouldn't include 'x-ably-clientid' if `clientId` is not specified", headers.get("x-ably-clientid"));

lib/src/test/java/io/ably/lib/transport/DefaultsTest.java

@@ -9,7 +9,7 @@ public class DefaultsTest {
 
     @Test
     public void protocol_version_CSV2() {
-        assertThat(Defaults.ABLY_PROTOCOL_VERSION, is("5"));
+        assertThat(Defaults.ABLY_PROTOCOL_VERSION, is("6"));
     }
 
     @Test

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

@@ -126,9 +126,8 @@ internal class DefaultRealtimeObjects(internal val channelName: String, internal
       operation = ObjectOperation(
         action = ObjectOperationAction.MapCreate,
         objectId = objectId,
-        map = initialMapValue.map,
-        nonce = nonce,
-        initialValue = initialValueJSONString,
+        mapCreate = initialMapValue,
+        mapCreateWithObjectId = MapCreateWithObjectId(nonce = nonce, initialValue = initialValueJSONString),
       )
     )
 
@@ -161,9 +160,8 @@ internal class DefaultRealtimeObjects(internal val channelName: String, internal
       operation = ObjectOperation(
         action = ObjectOperationAction.CounterCreate,
         objectId = objectId,
-        counter = initialCounterValue.counter,
-        nonce = nonce,
-        initialValue = initialValueJSONString
+        counterCreate = initialCounterValue,
+        counterCreateWithObjectId = CounterCreateWithObjectId(nonce = nonce, initialValue = initialValueJSONString),
       )
     )
 

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

@@ -177,10 +177,3 @@ internal fun Binary.size(): Int {
   return data.size
 }
 
-internal data class CounterCreatePayload(
-  val counter: ObjectsCounter
-)
-
-internal data class MapCreatePayload(
-  val map: ObjectsMap
-)

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

@@ -66,33 +66,70 @@ internal sealed class ObjectValue {
 }
 
 /**
- * A MapOp describes an operation to be applied to a Map object.
- * Spec: OMO1
+ * Payload for MAP_CREATE operation.
+ * Spec: MCR*
  */
-internal data class ObjectsMapOp(
-  /**
-   * The key of the map entry to which the operation should be applied.
-   * Spec: OMO2a
-   */
-  val key: String,
+internal data class MapCreate(
+  val semantics: ObjectsMapSemantics, // MCR2a
+  val entries: Map<String, ObjectsMapEntry> // MCR2b
+)
 
-  /**
-   * The data that the map entry should contain if the operation is a MAP_SET operation.
-   * Spec: OMO2b
-   */
-  val data: ObjectData? = null
+/**
+ * Payload for MAP_SET operation.
+ * Spec: MST*
+ */
+internal data class MapSet(
+  val key: String, // MST2a
+  val value: ObjectData // MST2b - REQUIRED
 )
 
 /**
- * A CounterOp describes an operation to be applied to a Counter object.
- * Spec: OCO1
+ * Payload for MAP_REMOVE operation.
+ * Spec: MRM*
  */
-internal data class ObjectsCounterOp(
-  /**
-   * The data value that should be added to the counter
-   * Spec: OCO2a
-   */
-  val amount: Double? = null
+internal data class MapRemove(
+  val key: String // MRM2a
+)
+
+/**
+ * Payload for COUNTER_CREATE operation.
+ * Spec: CCR*
+ */
+internal data class CounterCreate(
+  val count: Double // CCR2a - REQUIRED
+)
+
+/**
+ * Payload for COUNTER_INC operation.
+ * Spec: CIN*
+ */
+internal data class CounterInc(
+  val number: Double // CIN2a - REQUIRED
+)
+
+/**
+ * Payload for OBJECT_DELETE operation.
+ * Spec: ODE*
+ * No fields - action is sufficient
+ */
+internal object ObjectDelete
+
+/**
+ * Payload for MAP_CREATE_WITH_OBJECT_ID operation.
+ * Spec: MCRO*
+ */
+internal data class MapCreateWithObjectId(
+  val initialValue: String, // MCRO2a
+  val nonce: String // MCRO2b
+)
+
+/**
+ * Payload for COUNTER_CREATE_WITH_OBJECT_ID operation.
+ * Spec: CCRO*
+ */
+internal data class CounterCreateWithObjectId(
+  val initialValue: String, // CCRO2a
+  val nonce: String // CCRO2b
 )
 
 /**
@@ -175,48 +212,52 @@ internal data class ObjectOperation(
   val objectId: String,
 
   /**
-   * The payload for the operation if it is an operation on a Map object type.
-   * i.e. MAP_SET, MAP_REMOVE.
-   * Spec: OOP3c
+   * Payload for MAP_CREATE operation.
+   * Spec: OOP3j
    */
-  val mapOp: ObjectsMapOp? = null,
+  val mapCreate: MapCreate? = null,
 
   /**
-   * The payload for the operation if it is an operation on a Counter object type.
-   * i.e. COUNTER_INC.
-   * Spec: OOP3d
+   * Payload for MAP_SET operation.
+   * Spec: OOP3k
    */
-  val counterOp: ObjectsCounterOp? = null,
+  val mapSet: MapSet? = null,
 
   /**
-   * The payload for the operation if the operation is MAP_CREATE.
-   * Defines the initial value for the Map object.
-   * Spec: OOP3e
+   * Payload for MAP_REMOVE operation.
+   * Spec: OOP3l
    */
-  val map: ObjectsMap? = null,
+  val mapRemove: MapRemove? = null,
+
+  /**
+   * Payload for COUNTER_CREATE operation.
+   * Spec: OOP3m
+   */
+  val counterCreate: CounterCreate? = null,
+
+  /**
+   * Payload for COUNTER_INC operation.
+   * Spec: OOP3n
+   */
+  val counterInc: CounterInc? = null,
 
   /**
-   * The payload for the operation if the operation is COUNTER_CREATE.
-   * Defines the initial value for the Counter object.
-   * Spec: OOP3f
+   * Payload for OBJECT_DELETE operation.
+   * Spec: OOP3o
    */
-  val counter: ObjectsCounter? = null,
+  val objectDelete: ObjectDelete? = null,
 
   /**
-   * The nonce, must be present on create operations. This is the random part
-   * that has been hashed with the type and initial value to create the object ID.
-   * Spec: OOP3g
+   * Payload for MAP_CREATE_WITH_OBJECT_ID operation.
+   * Spec: OOP3p
    */
-  val nonce: String? = null,
+  val mapCreateWithObjectId: MapCreateWithObjectId? = null,
 
   /**
-   * The initial value json string for the object. This value should be used along with the nonce
-   * and timestamp to create the object ID. Frontdoor will use this to verify the object ID.
-   * After verification the json string will be decoded into the Map or Counter objects and
-   * the initialValue and nonce will be removed.
-   * Spec: OOP3h
+   * Payload for COUNTER_CREATE_WITH_OBJECT_ID operation.
+   * Spec: OOP3q
    */
-  val initialValue: String? = null,
+  val counterCreateWithObjectId: CounterCreateWithObjectId? = null,
 )
 
 /**
@@ -362,12 +403,17 @@ internal fun ObjectMessage.size(): Int {
  * Spec: OOP4
  */
 private fun ObjectOperation.size(): Int {
-  val mapOpSize = mapOp?.size() ?: 0 // Spec: OOP4b, OMO3
-  val counterOpSize = counterOp?.size() ?: 0 // Spec: OOP4c, OCO3
-  val mapSize = map?.size() ?: 0 // Spec: OOP4d, OMP4
-  val counterSize = counter?.size() ?: 0 // Spec: OOP4e, OCN3
-
-  return mapOpSize + counterOpSize + mapSize + counterSize
+  val mapCreateSize = mapCreate?.size() ?: 0
+  val mapSetSize = mapSet?.size() ?: 0
+  val mapRemoveSize = mapRemove?.size() ?: 0
+  val counterCreateSize = counterCreate?.size() ?: 0
+  val counterIncSize = counterInc?.size() ?: 0
+  val mapCreateWithObjectIdSize = mapCreateWithObjectId?.size() ?: 0
+  val counterCreateWithObjectIdSize = counterCreateWithObjectId?.size() ?: 0
+
+  return mapCreateSize + mapSetSize + mapRemoveSize +
+    counterCreateSize + counterIncSize +
+    mapCreateWithObjectIdSize + counterCreateWithObjectIdSize
 }
 
 /**
@@ -383,22 +429,52 @@ private fun ObjectState.size(): Int {
 }
 
 /**
- * Calculates the size of an ObjectMapOp in bytes.
- * Spec: OMO3
+ * Calculates the size of a MapCreate payload in bytes.
+ */
+private fun MapCreate.size(): Int {
+  return entries.entries.sumOf { it.key.length + it.value.size() }
+}
+
+/**
+ * Calculates the size of a MapSet payload in bytes.
+ */
+private fun MapSet.size(): Int {
+  return key.length + value.size()
+}
+
+/**
+ * Calculates the size of a MapRemove payload in bytes.
+ */
+private fun MapRemove.size(): Int {
+  return key.length
+}
+
+/**
+ * Calculates the size of a CounterCreate payload in bytes.
+ */
+private fun CounterCreate.size(): Int {
+  return 8 // Double is 8 bytes
+}
+
+/**
+ * Calculates the size of a CounterInc payload in bytes.
+ */
+private fun CounterInc.size(): Int {
+  return 8 // Double is 8 bytes
+}
+
+/**
+ * Calculates the size of a MapCreateWithObjectId payload in bytes.
  */
-private fun ObjectsMapOp.size(): Int {
-  val keySize = key.length // Spec: OMO3d - Size of the key
-  val dataSize = data?.size() ?: 0 // Spec: OMO3b - Size of the data, calculated per "OD3"
-  return keySize + dataSize
+private fun MapCreateWithObjectId.size(): Int {
+  return initialValue.length + nonce.length
 }
 
 /**
- * Calculates the size of a CounterOp in bytes.
- * Spec: OCO3
+ * Calculates the size of a CounterCreateWithObjectId payload in bytes.
  */
-private fun ObjectsCounterOp.size(): Int {
-  // Size is 8 if amount is a number, 0 if amount is null or omitted
-  return if (amount != null) 8 else 0 // Spec: OCO3a, OCO3b
+private fun CounterCreateWithObjectId.size(): Int {
+  return initialValue.length + nonce.length
 }
 
 /**