[ECO-5482] Updated LiveMap interface to return and perform ops using LiveMapValue

- Updated implementation for the same to return LiveMapValue
- Fixed related integration tests with the same

Author: sacOO7

lib/src/main/java/io/ably/lib/objects/type/map/LiveMap.java

@@ -30,7 +30,7 @@ public interface LiveMap extends LiveMapChange {
      * @return the value associated with the specified key, or null if the key does not exist.
      */
     @Nullable
-    Object get(@NotNull String keyName);
+    LiveMapValue get(@NotNull String keyName);
 
     /**
      * Retrieves all entries (key-value pairs) in the map.
@@ -40,7 +40,7 @@ public interface LiveMap extends LiveMapChange {
      */
     @NotNull
     @Unmodifiable
-    Iterable<Map.Entry<String, Object>> entries();
+    Iterable<Map.Entry<String, LiveMapValue>> entries();
 
     /**
      * Retrieves all keys in the map.
@@ -60,27 +60,29 @@ public interface LiveMap extends LiveMapChange {
      */
     @NotNull
     @Unmodifiable
-    Iterable<Object> values();
+    Iterable<LiveMapValue> values();
 
     /**
      * Sets the specified key to the given value in the map.
      * Send a MAP_SET operation to the realtime system to set a key on this LiveMap object to a specified value.
      * This does not modify the underlying data of this LiveMap object. Instead, the change will be applied when
      * the published MAP_SET operation is echoed back to the client and applied to the object following the regular
      * operation application procedure.
+     * Spec: RTLM20
      *
      * @param keyName the key to be set.
      * @param value the value to be associated with the key.
      */
     @Blocking
-    void set(@NotNull String keyName, @NotNull Object value);
+    void set(@NotNull String keyName, @NotNull LiveMapValue value);
 
     /**
      * Removes the specified key and its associated value from the map.
      * Send a MAP_REMOVE operation to the realtime system to tombstone a key on this LiveMap object.
      * This does not modify the underlying data of this LiveMap object. Instead, the change will be applied when
      * the published MAP_REMOVE operation is echoed back to the client and applied to the object following the regular
      * operation application procedure.
+     * Spec: RTLM21
      *
      * @param keyName the key to be removed.
      */
@@ -103,6 +105,7 @@ public interface LiveMap extends LiveMapChange {
      * This does not modify the underlying data of this LiveMap object. Instead, the change will be applied when
      * the published MAP_SET operation is echoed back to the client and applied to the object following the regular
      * operation application procedure.
+     * Spec: RTLM20
      *
      * @param keyName the key to be set.
      * @param value the value to be associated with the key.
@@ -117,6 +120,7 @@ public interface LiveMap extends LiveMapChange {
      * This does not modify the underlying data of this LiveMap object. Instead, the change will be applied when
      * the published MAP_REMOVE operation is echoed back to the client and applied to the object following the regular
      * operation application procedure.
+     * Spec: RTLM21
      *
      * @param keyName  the key to be removed.
      * @param callback the callback to handle the result or any errors.

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

@@ -1,5 +1,7 @@
 package io.ably.lib.objects
 
+import io.ably.lib.objects.type.BaseLiveObject
+import io.ably.lib.objects.type.map.LiveMapValue
 import io.ably.lib.realtime.ChannelState
 import io.ably.lib.realtime.CompletionListener
 import io.ably.lib.types.ChannelMode

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

@@ -27,7 +27,7 @@ internal val LiveObjectUpdate.noOp get() = this.update == null
  */
 internal abstract class BaseLiveObject(
   internal val objectId: String, // // RTLO3a
-  private val objectType: ObjectType,
+  internal val objectType: ObjectType,
 ) {
 
   protected open val tag = "BaseLiveObject"

live-objects/src/main/kotlin/io/ably/lib/objects/type/livemap/DefaultLiveMap.kt

@@ -11,6 +11,7 @@ import io.ably.lib.objects.type.ObjectType
 import io.ably.lib.objects.type.map.LiveMap
 import io.ably.lib.objects.type.map.LiveMapChange
 import io.ably.lib.objects.type.map.LiveMapUpdate
+import io.ably.lib.objects.type.map.LiveMapValue
 import io.ably.lib.objects.type.noOp
 import io.ably.lib.types.Callback
 import io.ably.lib.util.Log
@@ -45,7 +46,7 @@ internal class DefaultLiveMap private constructor(
   private val adapter: LiveObjectsAdapter get() = liveObjects.adapter
   internal val objectsPool: ObjectsPool get() = liveObjects.objectsPool
 
-  override fun get(keyName: String): Any? {
+  override fun get(keyName: String): LiveMapValue? {
     adapter.throwIfInvalidAccessApiConfiguration(channelName) // RTLM5b, RTLM5c
     if (isTombstoned) {
       return null
@@ -56,10 +57,10 @@ internal class DefaultLiveMap private constructor(
     return null // RTLM5d1
   }
 
-  override fun entries(): Iterable<Map.Entry<String, Any>> {
+  override fun entries(): Iterable<Map.Entry<String, LiveMapValue>> {
     adapter.throwIfInvalidAccessApiConfiguration(channelName) // RTLM11b, RTLM11c
 
-    return sequence<Map.Entry<String, Any>> {
+    return sequence<Map.Entry<String, LiveMapValue>> {
       for ((key, entry) in data.entries) {
         val value = entry.getResolvedValue(objectsPool) // RTLM11d, RTLM11d2
         value?.let {
@@ -78,7 +79,7 @@ internal class DefaultLiveMap private constructor(
     }.asIterable()
   }
 
-  override fun values(): Iterable<Any> {
+  override fun values(): Iterable<LiveMapValue> {
     val iterableEntries = entries()
     return sequence {
       for (entry in iterableEntries) {
@@ -92,7 +93,7 @@ internal class DefaultLiveMap private constructor(
     return data.values.count { !it.isEntryOrRefTombstoned(objectsPool) }.toLong() // RTLM10d
   }
 
-  override fun set(keyName: String, value: Any) {
+  override fun set(keyName: String, value: LiveMapValue) {
     TODO("Not yet implemented")
   }
 

live-objects/src/main/kotlin/io/ably/lib/objects/type/livemap/LiveMapEntry.kt

@@ -1,8 +1,17 @@
 package io.ably.lib.objects.type.livemap
 
+import com.google.gson.JsonArray
+import com.google.gson.JsonObject
+import io.ably.lib.objects.*
+import io.ably.lib.objects.Binary
 import io.ably.lib.objects.ObjectData
 import io.ably.lib.objects.ObjectsPool
 import io.ably.lib.objects.ObjectsPoolDefaults
+import io.ably.lib.objects.type.BaseLiveObject
+import io.ably.lib.objects.type.ObjectType
+import io.ably.lib.objects.type.counter.LiveCounter
+import io.ably.lib.objects.type.map.LiveMap
+import io.ably.lib.objects.type.map.LiveMapValue
 
 /**
  * @spec RTLM3 - Map data structure storing entries
@@ -36,17 +45,17 @@ internal fun LiveMapEntry.isEntryOrRefTombstoned(objectsPool: ObjectsPool): Bool
  * Returns value as is if object data stores a primitive type or
  * a reference to another LiveObject from the pool if it stores an objectId.
  */
-internal fun LiveMapEntry.getResolvedValue(objectsPool: ObjectsPool): Any? {
+internal fun LiveMapEntry.getResolvedValue(objectsPool: ObjectsPool): LiveMapValue? {
   if (isTombstoned) { return null } // RTLM5d2a
 
-  data?.value?.let { return it.value } // RTLM5d2b, RTLM5d2c, RTLM5d2d, RTLM5d2e
+  data?.value?.let { return fromObjectValue(it) } // RTLM5d2b, RTLM5d2c, RTLM5d2d, RTLM5d2e
 
   data?.objectId?.let { refId -> // RTLM5d2f -has an objectId reference
     objectsPool.get(refId)?.let { refObject ->
       if (refObject.isTombstoned) {
         return null // tombstoned objects must not be surfaced to the end users
       }
-      return refObject // RTLM5d2f2
+      return fromLiveObject(refObject) // RTLM5d2f2
     }
   }
   return null // RTLM5d2g, RTLM5d2f1
@@ -59,3 +68,22 @@ internal fun LiveMapEntry.isEligibleForGc(): Boolean {
   val currentTime = System.currentTimeMillis()
   return isTombstoned && tombstonedAt?.let { currentTime - it >= ObjectsPoolDefaults.GC_GRACE_PERIOD_MS } == true
 }
+
+private fun fromObjectValue(objValue: ObjectValue): LiveMapValue {
+  return when (val value = objValue.value) {
+    is String -> LiveMapValue.of(value)
+    is Number -> LiveMapValue.of(value)
+    is Boolean -> LiveMapValue.of(value)
+    is Binary -> LiveMapValue.of(value.data)
+    is JsonObject -> LiveMapValue.of(value)
+    is JsonArray -> LiveMapValue.of(value)
+    else -> throw IllegalArgumentException("Unsupported value type: ${value::class.java}")
+  }
+}
+
+private fun fromLiveObject(baseLiveObject: BaseLiveObject): LiveMapValue {
+  return when (baseLiveObject.objectType) {
+    ObjectType.Map -> LiveMapValue.of(baseLiveObject as LiveMap)
+    ObjectType.Counter -> LiveMapValue.of(baseLiveObject as LiveCounter)
+  }
+}

live-objects/src/test/kotlin/io/ably/lib/objects/integration/DefaultLiveCounterTest.kt

@@ -1,7 +1,5 @@
 package io.ably.lib.objects.integration
 
-import io.ably.lib.objects.type.counter.LiveCounter
-import io.ably.lib.objects.type.map.LiveMap
 import io.ably.lib.objects.assertWaiter
 import io.ably.lib.objects.integration.helpers.ObjectId
 import io.ably.lib.objects.integration.helpers.fixtures.createUserEngagementMatrixMap
@@ -29,64 +27,64 @@ class DefaultLiveCounterTest: IntegrationTest() {
     val rootMap = channel.objects.root
 
     // Get the user map object from the root map
-    val userMap = rootMap.get("user") as LiveMap
+    val userMap = rootMap.get("user")?.asLiveMap
     assertNotNull(userMap, "User map should be synchronized")
     assertEquals(7L, userMap.size(), "User map should contain 7 top-level entries")
 
     // Assert direct counter objects at the top level of the user map
     // Test profileViews counter - should have initial value of 127
-    val profileViewsCounter = userMap.get("profileViews") as LiveCounter
+    val profileViewsCounter = userMap.get("profileViews")?.asLiveCounter
     assertNotNull(profileViewsCounter, "Profile views counter should exist")
     assertEquals(127.0, profileViewsCounter.value(), "Profile views counter should have initial value of 127")
 
     // Test postLikes counter - should have initial value of 45
-    val postLikesCounter = userMap.get("postLikes") as LiveCounter
+    val postLikesCounter = userMap.get("postLikes")?.asLiveCounter
     assertNotNull(postLikesCounter, "Post likes counter should exist")
     assertEquals(45.0, postLikesCounter.value(), "Post likes counter should have initial value of 45")
 
     // Test commentCount counter - should have initial value of 23
-    val commentCountCounter = userMap.get("commentCount") as LiveCounter
+    val commentCountCounter = userMap.get("commentCount")?.asLiveCounter
     assertNotNull(commentCountCounter, "Comment count counter should exist")
     assertEquals(23.0, commentCountCounter.value(), "Comment count counter should have initial value of 23")
 
     // Test followingCount counter - should have initial value of 89
-    val followingCountCounter = userMap.get("followingCount") as LiveCounter
+    val followingCountCounter = userMap.get("followingCount")?.asLiveCounter
     assertNotNull(followingCountCounter, "Following count counter should exist")
     assertEquals(89.0, followingCountCounter.value(), "Following count counter should have initial value of 89")
 
     // Test followersCount counter - should have initial value of 156
-    val followersCountCounter = userMap.get("followersCount") as LiveCounter
+    val followersCountCounter = userMap.get("followersCount")?.asLiveCounter
     assertNotNull(followersCountCounter, "Followers count counter should exist")
     assertEquals(156.0, followersCountCounter.value(), "Followers count counter should have initial value of 156")
 
     // Test loginStreak counter - should have initial value of 7
-    val loginStreakCounter = userMap.get("loginStreak") as LiveCounter
+    val loginStreakCounter = userMap.get("loginStreak")?.asLiveCounter
     assertNotNull(loginStreakCounter, "Login streak counter should exist")
     assertEquals(7.0, loginStreakCounter.value(), "Login streak counter should have initial value of 7")
 
     // Assert the nested engagement metrics map
-    val engagementMetrics = userMap.get("engagementMetrics") as LiveMap
+    val engagementMetrics = userMap.get("engagementMetrics")?.asLiveMap
     assertNotNull(engagementMetrics, "Engagement metrics map should exist")
     assertEquals(4L, engagementMetrics.size(), "Engagement metrics map should contain 4 counter entries")
 
     // Assert counter objects within the engagement metrics map
     // Test totalShares counter - should have initial value of 34
-    val totalSharesCounter = engagementMetrics.get("totalShares") as LiveCounter
+    val totalSharesCounter = engagementMetrics.get("totalShares")?.asLiveCounter
     assertNotNull(totalSharesCounter, "Total shares counter should exist")
     assertEquals(34.0, totalSharesCounter.value(), "Total shares counter should have initial value of 34")
 
     // Test totalBookmarks counter - should have initial value of 67
-    val totalBookmarksCounter = engagementMetrics.get("totalBookmarks") as LiveCounter
+    val totalBookmarksCounter = engagementMetrics.get("totalBookmarks")?.asLiveCounter
     assertNotNull(totalBookmarksCounter, "Total bookmarks counter should exist")
     assertEquals(67.0, totalBookmarksCounter.value(), "Total bookmarks counter should have initial value of 67")
 
     // Test totalReactions counter - should have initial value of 189
-    val totalReactionsCounter = engagementMetrics.get("totalReactions") as LiveCounter
+    val totalReactionsCounter = engagementMetrics.get("totalReactions")?.asLiveCounter
     assertNotNull(totalReactionsCounter, "Total reactions counter should exist")
     assertEquals(189.0, totalReactionsCounter.value(), "Total reactions counter should have initial value of 189")
 
     // Test dailyActiveStreak counter - should have initial value of 12
-    val dailyActiveStreakCounter = engagementMetrics.get("dailyActiveStreak") as LiveCounter
+    val dailyActiveStreakCounter = engagementMetrics.get("dailyActiveStreak")?.asLiveCounter
     assertNotNull(dailyActiveStreakCounter, "Daily active streak counter should exist")
     assertEquals(12.0, dailyActiveStreakCounter.value(), "Daily active streak counter should have initial value of 12")
 
@@ -130,7 +128,7 @@ class DefaultLiveCounterTest: IntegrationTest() {
     assertWaiter { rootMap.get("testCounter") != null }
 
     // Assert initial state after creation
-    val testCounter = rootMap.get("testCounter") as LiveCounter
+    val testCounter = rootMap.get("testCounter")?.asLiveCounter
     assertNotNull(testCounter, "Test counter should be created and accessible")
     assertEquals(10.0, testCounter.value(), "Counter should have initial value of 10")
 
@@ -201,7 +199,7 @@ class DefaultLiveCounterTest: IntegrationTest() {
     assertNotNull(testCounter, "Counter should still be accessible at the end")
 
     // Verify we can still access it from the root map
-    val finalCounterCheck = rootMap.get("testCounter") as LiveCounter
+    val finalCounterCheck = rootMap.get("testCounter")?.asLiveCounter
     assertNotNull(finalCounterCheck, "Counter should still be accessible from root map")
     assertEquals(30.0, finalCounterCheck.value(), "Final counter value should be 30 when accessed from root map")
   }
@@ -215,11 +213,11 @@ class DefaultLiveCounterTest: IntegrationTest() {
     val channel = getRealtimeChannel(channelName)
     val rootMap = channel.objects.root
 
-    val userEngagementMap = rootMap.get("userMatrix") as LiveMap
-    assertEquals(4L, userEngagementMap.size(), "User engagement map should contain 4 top-level entries")
+    val userEngagementMap = rootMap.get("userMatrix")?.asLiveMap
+    assertEquals(4L, userEngagementMap!!.size(), "User engagement map should contain 4 top-level entries")
 
-    val totalReactions = userEngagementMap.get("totalReactions") as LiveCounter
-    assertEquals(189.0, totalReactions.value(), "Total reactions counter should have initial value of 189")
+    val totalReactions = userEngagementMap.get("totalReactions")?.asLiveCounter
+    assertEquals(189.0, totalReactions!!.value(), "Total reactions counter should have initial value of 189")
 
     // Subscribe to changes on the totalReactions counter
     val counterUpdates = mutableListOf<Double>()