Disconnect on dispose option (#40)

* Disconnect on dispose option

* spotless changeset

* Update livekit android sdk to 2.16.0

Author: davidliu

.changeset/beige-teachers-fetch.md

@@ -0,0 +1,5 @@
+---
+"components-android": minor
+---
+
+Add disconnectOnDispose argument to RoomScope and rememberLiveKitRoom

.changeset/forty-spiders-run.md

@@ -0,0 +1,5 @@
+---
+"components-android": patch
+---
+
+Update livekit sdk to 2.16.0

.gitignore

@@ -21,4 +21,5 @@ local.properties
 node_modules/
 npm-debug.log
 yarn-debug.log
-yarn-error.log
+yarn-error.log
+runConfigurations.xml

livekit-compose-components/build.gradle

@@ -86,7 +86,7 @@ dokkaHtml {
     }
 }
 
-var livekitVersion = "2.14.0"
+var livekitVersion = "2.16.0"
 dependencies {
     // For local development with the LiveKit Android SDK only.
     // api "io.livekit:livekit-android-sdk"

livekit-compose-components/src/main/java/io/livekit/android/compose/local/RoomLocal.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023-2024 LiveKit, Inc.
+ * Copyright 2023-2025 LiveKit, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -104,6 +104,10 @@ private val DEFAULT_ERROR_HANDLER: ((Room, Exception?) -> Unit) = { _, e ->
  * @param onDisconnected a listener to be called upon room disconnection.
  * @param onError a listener to be called upon room error.
  * @param passedRoom if a [Room] is provided, it will be used. If null, a new Room will be created instead.
+ * @param disconnectOnDispose by default, this composable handles the connection management and will disconnect the room
+ * when the composable goes out of scope. Setting this to false will disable this behavior. This is effective in combination
+ * with [passedRoom], when you need to keep the [Room] object alive and connected separately from the UI
+ * (for example, with a background service).
  */
 @Composable
 fun rememberLiveKitRoom(
@@ -119,6 +123,7 @@ fun rememberLiveKitRoom(
     onDisconnected: (suspend CoroutineScope.(Room) -> Unit)? = null,
     onError: ((Room, Exception?) -> Unit)? = DEFAULT_ERROR_HANDLER,
     passedRoom: Room? = null,
+    disconnectOnDispose: Boolean = true,
 ): Room {
     val context = LocalContext.current
     val room = remember(passedRoom) {
@@ -210,7 +215,7 @@ fun rememberLiveKitRoom(
 
     DisposableEffect(room, connect) {
         onDispose {
-            if (connect) {
+            if (connect && disconnectOnDispose) {
                 room.disconnect()
             }
         }
@@ -242,6 +247,10 @@ fun rememberLiveKitRoom(
  * @param onDisconnected a listener to be called upon room disconnection.
  * @param onError a listener to be called upon room error.
  * @param passedRoom if a [Room] is provided, it will be used. If null, a new Room will be created instead.
+ * @param disconnectOnDispose by default, this composable handles the connection management and will disconnect the room
+ * when the composable goes out of scope. Setting this to false will disable this behavior. This is effective in combination
+ * with [passedRoom], when you need to keep the [Room] object alive and connected separately from the UI
+ * (for example, with a background service).
  */
 @Composable
 fun RoomScope(
@@ -257,6 +266,7 @@ fun RoomScope(
     onDisconnected: (suspend CoroutineScope.(Room) -> Unit)? = null,
     onError: ((Room, Exception?) -> Unit)? = null,
     passedRoom: Room? = null,
+    disconnectOnDispose: Boolean = true,
     content: @Composable (room: Room) -> Unit
 ) {
     val room = rememberLiveKitRoom(
@@ -271,7 +281,8 @@ fun RoomScope(
         onConnected = onConnected,
         onDisconnected = onDisconnected,
         onError = onError,
-        passedRoom = passedRoom
+        passedRoom = passedRoom,
+        disconnectOnDispose = disconnectOnDispose,
     )
 
     CompositionLocalProvider(

livekit-compose-components/src/test/java/io/livekit/android/compose/local/RoomScopeTest.kt

@@ -18,13 +18,20 @@ package io.livekit.android.compose.local
 
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
 import androidx.compose.ui.platform.LocalContext
 import app.cash.molecule.RecompositionMode
 import app.cash.molecule.moleculeFlow
 import app.cash.turbine.test
 import io.livekit.android.room.Room
 import io.livekit.android.test.MockE2ETest
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.delay
+import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNotNull
 import org.junit.Test
 
@@ -62,6 +69,65 @@ class RoomScopeTest : MockE2ETest() {
         }
     }
 
+    @Test
+    fun disconnectOnDispose() = runTest {
+        // mock room needs connecting manually
+        connect()
+        moleculeFlow(RecompositionMode.Immediate) {
+            var useScope by remember { mutableStateOf(true) }
+            LaunchedEffect(Unit) {
+                delay(1)
+                useScope = false
+            }
+            if (useScope) {
+                RoomScopeSetup {
+                    RoomScope(
+                        connect = true,
+                        disconnectOnDispose = true,
+                        passedRoom = room
+                    ) {}
+                }
+            }
+            1
+        }.test {
+            awaitItem()
+            assertEquals(Room.State.CONNECTED, room.state)
+            delay(1000)
+            awaitItem()
+            assertEquals(Room.State.DISCONNECTED, room.state)
+        }
+    }
+
+    @Test
+    fun noDisconnectOnDispose() = runTest {
+        // mock room needs connecting manually
+        connect()
+        moleculeFlow(RecompositionMode.Immediate) {
+            var useScope by remember { mutableStateOf(true) }
+            LaunchedEffect(Unit) {
+                delay(1)
+                useScope = false
+            }
+            if (useScope) {
+                RoomScopeSetup {
+                    RoomScope(
+                        connect = true,
+                        disconnectOnDispose = false,
+                        passedRoom = room
+                    ) {
+                    }
+                }
+            }
+            1
+        }.test {
+            awaitItem()
+            assertEquals(Room.State.CONNECTED, room.state)
+            delay(1000)
+            awaitItem()
+            assertEquals(Room.State.CONNECTED, room.state)
+        }
+    }
+
     /**
      * RoomScope requires a LocalContext, which would normally be
      * provided in a ComposeView.