Experiments with rememberRetainedCoroutineScope

chrisbanes · Mar 21, 2024 · 3f2cc71 · 3f2cc71
1 parent 11d7d02
commit 3f2cc71
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 6 deletions.
diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml
diff --git a/common/ui/compose/src/commonMain/kotlin/app/tivi/common/compose/LazyPagingExtensions.kt b/common/ui/compose/src/commonMain/kotlin/app/tivi/common/compose/LazyPagingExtensions.kt
@@ -6,11 +6,11 @@
 package app.tivi.common.compose
 
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.remember
 import app.cash.paging.CombinedLoadStates
 import app.cash.paging.LoadStateError
 import app.cash.paging.PagingData
 import app.cash.paging.cachedIn
+import com.slack.circuit.retained.rememberRetained
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.Flow
 
@@ -31,5 +31,5 @@ fun CombinedLoadStates.refreshErrorOrNull(): UiMessage? {
 
 @Composable
 inline fun <T : Any> Flow<PagingData<T>>.rememberCachedPagingFlow(
-  scope: CoroutineScope = rememberCoroutineScope(),
-): Flow<PagingData<T>> = remember(this, scope) { cachedIn(scope) }
+  scope: CoroutineScope = rememberRetainedCoroutineScope(),
+): Flow<PagingData<T>> = rememberRetained(scope) { cachedIn(scope) }
diff --git a/common/ui/compose/src/commonMain/kotlin/app/tivi/common/compose/StableCoroutineScope.kt b/common/ui/compose/src/commonMain/kotlin/app/tivi/common/compose/StableCoroutineScope.kt
@@ -4,9 +4,14 @@
 package app.tivi.common.compose
 
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.RememberObserver
 import androidx.compose.runtime.Stable
 import androidx.compose.runtime.remember
+import com.slack.circuit.retained.rememberRetained
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.cancel
 
 /**
  * Returns a [StableCoroutineScope] around a [androidx.compose.runtime.rememberCoroutineScope].
@@ -22,3 +27,23 @@ fun rememberCoroutineScope(): StableCoroutineScope {
 /** @see rememberCoroutineScope */
 @Stable
 class StableCoroutineScope(scope: CoroutineScope) : CoroutineScope by scope
+
+@Composable
+fun rememberRetainedCoroutineScope(): StableCoroutineScope {
+  return rememberRetained("coroutine_scope") {
+    object : RememberObserver {
+      val scope = StableCoroutineScope(CoroutineScope(Dispatchers.Main + Job()))
+
+      override fun onAbandoned() = onForgotten()
+
+      override fun onForgotten() {
+        println("[RetainedCoroutineScope] Forgotten: Cancelling scope")
+        scope.cancel()
+      }
+
+      override fun onRemembered() {
+        println("[RetainedCoroutineScope] Remembered")
+      }
+    }
+  }.scope
+}
diff --git a/ui/library/src/commonMain/kotlin/app/tivi/home/library/LibraryPresenter.kt b/ui/library/src/commonMain/kotlin/app/tivi/home/library/LibraryPresenter.kt
@@ -72,7 +72,7 @@ class LibraryPresenter(
     val uiMessageManager = remember { UiMessageManager() }
 
     val items = observePagedLibraryShows.value.flow
-      .rememberCachedPagingFlow(scope)
+      .rememberCachedPagingFlow()
       .collectAsLazyPagingItems()
 
     var filter by remember { mutableStateOf<String?>(null) }

diff --git a/ui/popular/src/commonMain/kotlin/app/tivi/home/popular/PopularShowsPresenter.kt b/ui/popular/src/commonMain/kotlin/app/tivi/home/popular/PopularShowsPresenter.kt
@@ -8,6 +8,7 @@ import androidx.compose.runtime.LaunchedEffect
 import app.cash.paging.PagingConfig
 import app.cash.paging.compose.collectAsLazyPagingItems
 import app.tivi.common.compose.rememberCachedPagingFlow
+import app.tivi.common.compose.rememberRetainedCoroutineScope
 import app.tivi.domain.observers.ObservePagedPopularShows
 import app.tivi.screens.PopularShowsScreen
 import app.tivi.screens.ShowDetailsScreen

diff --git a/ui/recommended/src/commonMain/kotlin/app/tivi/home/recommended/RecommendedShowsPresenter.kt b/ui/recommended/src/commonMain/kotlin/app/tivi/home/recommended/RecommendedShowsPresenter.kt
@@ -8,6 +8,7 @@ import androidx.compose.runtime.LaunchedEffect
 import app.cash.paging.PagingConfig
 import app.cash.paging.compose.collectAsLazyPagingItems
 import app.tivi.common.compose.rememberCachedPagingFlow
+import app.tivi.common.compose.rememberRetainedCoroutineScope
 import app.tivi.domain.observers.ObservePagedRecommendedShows
 import app.tivi.screens.RecommendedShowsScreen
 import app.tivi.screens.ShowDetailsScreen

diff --git a/ui/trending/src/commonMain/kotlin/app/tivi/home/trending/TrendingShowsPresenter.kt b/ui/trending/src/commonMain/kotlin/app/tivi/home/trending/TrendingShowsPresenter.kt
@@ -8,6 +8,7 @@ import androidx.compose.runtime.LaunchedEffect
 import app.cash.paging.PagingConfig
 import app.cash.paging.compose.collectAsLazyPagingItems
 import app.tivi.common.compose.rememberCachedPagingFlow
+import app.tivi.common.compose.rememberRetainedCoroutineScope
 import app.tivi.domain.observers.ObservePagedTrendingShows
 import app.tivi.screens.ShowDetailsScreen
 import app.tivi.screens.TrendingShowsScreen

diff --git a/ui/upnext/src/commonMain/kotlin/app/tivi/home/upnext/UpNextPresenter.kt b/ui/upnext/src/commonMain/kotlin/app/tivi/home/upnext/UpNextPresenter.kt
@@ -16,6 +16,7 @@ import app.tivi.common.compose.UiMessage
 import app.tivi.common.compose.UiMessageManager
 import app.tivi.common.compose.rememberCachedPagingFlow
 import app.tivi.common.compose.rememberCoroutineScope
+import app.tivi.common.compose.rememberRetainedCoroutineScope
 import app.tivi.data.models.SortOption
 import app.tivi.data.traktauth.TraktAuthState
 import app.tivi.domain.interactors.GetTraktAuthState
@@ -72,7 +73,7 @@ class UpNextPresenter(
     val uiMessageManager = remember { UiMessageManager() }
 
     val items = observePagedUpNextShows.value.flow
-      .rememberCachedPagingFlow(scope)
+      .rememberCachedPagingFlow()
       .collectAsLazyPagingItems()
 
     var sort by remember { mutableStateOf(SortOption.LAST_WATCHED) }