[ECO-5076] Implemented code for getRoot method

Author: sacOO7

lib/src/main/java/io/ably/lib/objects/Adapter.java

@@ -1,8 +1,10 @@
 package io.ably.lib.objects;
 
 import io.ably.lib.realtime.AblyRealtime;
+import io.ably.lib.realtime.ChannelState;
 import io.ably.lib.realtime.CompletionListener;
 import io.ably.lib.types.AblyException;
+import io.ably.lib.types.ChannelMode;
 import io.ably.lib.types.ProtocolMessage;
 import io.ably.lib.util.Log;
 import org.jetbrains.annotations.NotNull;
@@ -34,4 +36,22 @@ public void send(@NotNull ProtocolMessage msg, @NotNull CompletionListener liste
     public int maxMessageSizeLimit() {
         return ably.connection.connectionManager.maxMessageSize;
     }
+
+    @Override
+    public ChannelMode[] getChannelMode(@NotNull String channelName) {
+        if (ably.channels.containsKey(channelName)) {
+            return ably.channels.get(channelName).getModes();
+        }
+        Log.e(TAG, "getChannelMode(): channel not found: " + channelName);
+        return null;
+    }
+
+    @Override
+    public ChannelState getChannelState(@NotNull String channelName) {
+        if (ably.channels.containsKey(channelName)) {
+            return ably.channels.get(channelName).state;
+        }
+        Log.e(TAG, "getChannelState(): channel not found: " + channelName);
+        return null;
+    }
 }

lib/src/main/java/io/ably/lib/objects/LiveObjectsAdapter.java

@@ -1,9 +1,12 @@
 package io.ably.lib.objects;
 
+import io.ably.lib.realtime.ChannelState;
 import io.ably.lib.realtime.CompletionListener;
 import io.ably.lib.types.AblyException;
+import io.ably.lib.types.ChannelMode;
 import io.ably.lib.types.ProtocolMessage;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public interface LiveObjectsAdapter {
     /**
@@ -31,5 +34,23 @@ public interface LiveObjectsAdapter {
      * @return the maximum message size limit in bytes.
      */
     int maxMessageSizeLimit();
+
+    /**
+     * Retrieves the channel modes for a specific channel.
+     * This method returns the modes that are set for the specified channel.
+     *
+     * @param channelName the name of the channel for which to retrieve the modes
+     * @return the array of channel modes for the specified channel, or null if the channel is not found
+     */
+    @Nullable ChannelMode[] getChannelMode(@NotNull String channelName);
+
+    /**
+     * Retrieves the current state of a specific channel.
+     * This method returns the state of the specified channel, which indicates its connection status.
+     *
+     * @param channelName the name of the channel for which to retrieve the state
+     * @return the current state of the specified channel, or null if the channel is not found
+     */
+    @Nullable ChannelState getChannelState(@NotNull String channelName);
 }
 

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

@@ -41,6 +41,11 @@ internal class DefaultLiveObjects(private val channelName: String, internal val
   private val sequentialScope =
     CoroutineScope(Dispatchers.Default.limitedParallelism(1) + CoroutineName(channelName) + SupervisorJob())
 
+  /**
+   * Coroutine scope for handling callbacks asynchronously.
+   */
+  private val callbackScope = CoroutineScope(Dispatchers.Default + CoroutineName("LiveObjectsCallback-$channelName"))
+
   /**
    * Event bus for handling incoming object messages sequentially.
    */
@@ -51,11 +56,20 @@ internal class DefaultLiveObjects(private val channelName: String, internal val
     incomingObjectsHandler = initializeHandlerForIncomingObjectMessages()
   }
 
-  /**
-   * @spec RTO1 - Returns the root LiveMap object with proper validation and sync waiting
-   */
+  private suspend fun getRootAsync(): LiveMap {
+    return withContext(sequentialScope.coroutineContext) {
+      adapter.throwIfInvalidAccessApiConfiguration(channelName)
+      // TODO - wait for state in synced state
+      objectsPool.get(ROOT_OBJECT_ID) as LiveMap
+    }
+  }
+
   override fun getRoot(): LiveMap {
-    TODO("Not yet implemented")
+    return runBlocking { getRootAsync() }
+  }
+
+  override fun getRootAsync(callback: Callback<LiveMap>) {
+    callbackScope.with(callback) { getRootAsync() }
   }
 
   override fun createMap(liveMap: LiveMap): LiveMap {
@@ -70,10 +84,6 @@ internal class DefaultLiveObjects(private val channelName: String, internal val
     TODO("Not yet implemented")
   }
 
-  override fun getRootAsync(callback: Callback<LiveMap>) {
-    TODO("Not yet implemented")
-  }
-
   override fun createMapAsync(liveMap: LiveMap, callback: Callback<LiveMap>) {
     TODO("Not yet implemented")
   }

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

@@ -1,6 +1,8 @@
 package io.ably.lib.objects
 
+import io.ably.lib.realtime.ChannelState
 import io.ably.lib.realtime.CompletionListener
+import io.ably.lib.types.ChannelMode
 import io.ably.lib.types.ErrorInfo
 import io.ably.lib.types.ProtocolMessage
 import kotlinx.coroutines.suspendCancellableCoroutine
@@ -39,6 +41,15 @@ internal fun LiveObjectsAdapter.setChannelSerial(channelName: String, protocolMe
   setChannelSerial(channelName, channelSerial)
 }
 
+internal fun LiveObjectsAdapter.throwIfInvalidAccessApiConfiguration(channelName: String): String? {
+}
+
+internal fun LiveObjectsAdapter.throwIfMissingChannelMode(channelName: String, channelMode: ChannelMode): String? {
+}
+
+internal fun LiveObjectsAdapter.throwIfInChannelState(channelName: String, channelStates: Array<ChannelState>): String? {
+}
+
 internal enum class ProtocolMessageFormat(private val value: String) {
   Msgpack("msgpack"),
   Json("json");

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

@@ -48,22 +48,12 @@ internal class ObjectsPool(
   private var gcJob: Job // Job for the garbage collection coroutine
 
   init {
-    // Initialize pool with root object
-    createInitialPool()
+    // RTO3b - Initialize pool with root object
+    pool[ROOT_OBJECT_ID] = DefaultLiveMap.zeroValue(ROOT_OBJECT_ID, adapter, this)
     // Start garbage collection coroutine
     gcJob = startGCJob()
   }
 
-  /**
-   * Creates the initial pool with root object.
-   *
-   * @spec RTO3b - Creates root LiveMap object
-   */
-  private fun createInitialPool() {
-    val root = DefaultLiveMap.zeroValue(ROOT_OBJECT_ID, adapter, this)
-    pool[ROOT_OBJECT_ID] = root
-  }
-
   /**
    * Gets a live object from the pool by object ID.
    */

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

@@ -1,7 +1,9 @@
 package io.ably.lib.objects
 
 import io.ably.lib.types.AblyException
+import io.ably.lib.types.Callback
 import io.ably.lib.types.ErrorInfo
+import kotlinx.coroutines.*
 
 internal fun ablyException(
   errorMessage: String,
@@ -44,3 +46,26 @@ internal fun objectError(errorMessage: String, cause: Throwable? = null): AblyEx
  */
 internal val String.byteSize: Int
   get() = this.toByteArray(Charsets.UTF_8).size
+
+/**
+ * Executes a suspend function within a coroutine and handles the result via a callback.
+ *
+ * This utility bridges between coroutine-based implementation code and callback-based APIs.
+ * It launches a coroutine in the current scope to execute the provided suspend block,
+ * then routes the result or any error to the appropriate callback method.
+ *
+ * @param T The type of result expected from the operation
+ * @param callback The callback to invoke with the operation result or error
+ * @param block The suspend function to execute that returns a value of type T
+ */
+internal fun <T> CoroutineScope.with(callback: Callback<T>, block: suspend () -> T) {
+  launch {
+    try {
+      val result = block()
+      callback.onSuccess(result)
+    } catch (throwable: Throwable) {
+      val exception = throwable as? AblyException
+      callback.onError(exception?.errorInfo)
+    }
+  }
+}