Fix launchOrThrow crashes (#2044)

common/ui/circuit/src/commonMain/kotlin/app/tivi/EventSink.kt

@@ -0,0 +1,25 @@
+// Copyright 2024, Christopher Banes and the Tivi project contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package app.tivi
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.rememberCoroutineScope
+import co.touchlab.kermit.Logger
+import com.slack.circuit.runtime.CircuitUiEvent
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.isActive
+
+@Composable
+inline fun <E : CircuitUiEvent> wrapEventSink(
+ crossinline eventSink: CoroutineScope.(E) -> Unit,
+ coroutineScope: CoroutineScope = rememberCoroutineScope(),
+): (E) -> Unit = { event ->
+ if (coroutineScope.isActive) {
+ coroutineScope.eventSink(event)
+ } else {
+ Logger.i(IllegalStateException()) {
+ "Received event, but CoroutineScope is no longer active. See stack trace for caller."
+ }
+ }
+}

ui/account/src/commonMain/kotlin/app/tivi/account/AccountPresenter.kt

@@ -6,7 +6,6 @@ package app.tivi.account
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
-import androidx.compose.runtime.rememberCoroutineScope
 import app.tivi.data.traktauth.TraktAuthState
 import app.tivi.domain.interactors.LoginTrakt
 import app.tivi.domain.interactors.LogoutTrakt
@@ -16,11 +15,13 @@ import app.tivi.domain.observers.ObserveUserDetails
 import app.tivi.screens.AccountScreen
 import app.tivi.screens.SettingsScreen
 import app.tivi.util.launchOrThrow
+import app.tivi.wrapEventSink
 import com.slack.circuit.retained.collectAsRetainedState
 import com.slack.circuit.runtime.CircuitContext
 import com.slack.circuit.runtime.Navigator
 import com.slack.circuit.runtime.presenter.Presenter
 import com.slack.circuit.runtime.screen.Screen
+import kotlinx.coroutines.CoroutineScope
 import me.tatarka.inject.annotations.Assisted
 import me.tatarka.inject.annotations.Inject
 
@@ -50,25 +51,27 @@ class AccountPresenter(
  val user by observeUserDetails.value.flow.collectAsRetainedState(null)
  val authState by observeTraktAuthState.value.flow
  .collectAsRetainedState(TraktAuthState.LOGGED_OUT)
- val scope = rememberCoroutineScope()
 
  LaunchedEffect(Unit) {
  observeTraktAuthState.value.invoke(Unit)
  observeUserDetails.value.invoke(ObserveUserDetails.Params("me"))
  }
 
- return AccountUiState(
- user = user,
- authState = authState,
- ) { event ->
+ val eventSink: CoroutineScope.(AccountUiEvent) -> Unit = { event ->
  when (event) {
  AccountUiEvent.NavigateToSettings -> {
  navigator.pop() // dismiss ourselves
  navigator.goTo(SettingsScreen)
  }
- AccountUiEvent.Login -> scope.launchOrThrow { loginTrakt.value.invoke() }
- AccountUiEvent.Logout -> scope.launchOrThrow { logoutTrakt.value.invoke() }
+ AccountUiEvent.Login -> launchOrThrow { loginTrakt.value.invoke() }
+ AccountUiEvent.Logout -> launchOrThrow { logoutTrakt.value.invoke() }
  }
  }
+
+ return AccountUiState(
+ user = user,
+ authState = authState,
+ eventSink = wrapEventSink(eventSink),
+ )
  }
 }

ui/anticipated/build.gradle.kts

@@ -19,6 +19,7 @@ kotlin {
  implementation(projects.core.base)
  implementation(projects.domain)
  implementation(projects.common.ui.compose)
+ implementation(projects.common.ui.circuit)
 
  api(projects.common.ui.screens)
  api(libs.circuit.foundation)

ui/anticipated/src/commonMain/kotlin/app/tivi/home/anticipated/AnticipatedShowsPresenter.kt

@@ -11,11 +11,13 @@ import app.tivi.common.compose.rememberRetainedCachedPagingFlow
 import app.tivi.domain.observers.ObservePagedAnticipatedShows
 import app.tivi.screens.AnticipatedShowsScreen
 import app.tivi.screens.ShowDetailsScreen
+import app.tivi.wrapEventSink
 import com.slack.circuit.retained.rememberRetained
 import com.slack.circuit.runtime.CircuitContext
 import com.slack.circuit.runtime.Navigator
 import com.slack.circuit.runtime.presenter.Presenter
 import com.slack.circuit.runtime.screen.Screen
+import kotlinx.coroutines.CoroutineScope
 import me.tatarka.inject.annotations.Assisted
 import me.tatarka.inject.annotations.Inject
 
@@ -54,7 +56,7 @@ class AnticipatedShowsPresenter(
  retainedPagingInteractor(ObservePagedAnticipatedShows.Params(PAGING_CONFIG))
  }
 
- val eventSink: (AnticipatedShowsUiEvent) -> Unit = { event ->
+ val eventSink: CoroutineScope.(AnticipatedShowsUiEvent) -> Unit = { event ->
  when (event) {
  AnticipatedShowsUiEvent.NavigateUp -> navigator.pop()
  is AnticipatedShowsUiEvent.OpenShowDetails -> {
@@ -65,7 +67,7 @@ class AnticipatedShowsPresenter(
 
  return AnticipatedShowsUiState(
  items = items,
- eventSink = eventSink,
+ eventSink = wrapEventSink(eventSink),
  )
  }
 

ui/developer/log/build.gradle.kts

@@ -18,6 +18,7 @@ kotlin {
  dependencies {
  implementation(projects.core.base)
  implementation(projects.common.ui.compose)
+ implementation(projects.common.ui.circuit)
  implementation(projects.core.logging)
 
  api(projects.common.ui.screens)

ui/developer/log/src/commonMain/kotlin/app/tivi/developer/log/DevLogPresenter.kt

@@ -9,10 +9,12 @@ import androidx.compose.runtime.getValue
 import androidx.compose.runtime.remember
 import app.tivi.screens.DevLogScreen
 import app.tivi.util.RecordingLoggerWriter
+import app.tivi.wrapEventSink
 import com.slack.circuit.runtime.CircuitContext
 import com.slack.circuit.runtime.Navigator
 import com.slack.circuit.runtime.presenter.Presenter
 import com.slack.circuit.runtime.screen.Screen
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.map
 import me.tatarka.inject.annotations.Assisted
 import me.tatarka.inject.annotations.Inject
@@ -42,15 +44,15 @@ class DevLogPresenter(
  RecordingLoggerWriter.buffer.map { it.asReversed() }
  }.collectAsState(emptyList())
 
- val eventSink: (DevLogUiEvent) -> Unit = { event ->
+ val eventSink: CoroutineScope.(DevLogUiEvent) -> Unit = { event ->
  when (event) {
  DevLogUiEvent.NavigateUp -> navigator.pop()
  }
  }
 
  return DevLogUiState(
  logs = logs,
- eventSink = eventSink,
+ eventSink = wrapEventSink(eventSink),
  )
  }
 }

ui/developer/notifications/build.gradle.kts

@@ -21,6 +21,7 @@ kotlin {
  api(projects.domain)
 
  implementation(projects.common.ui.compose)
+ implementation(projects.common.ui.circuit)
 
  api(projects.common.ui.screens)
  api(libs.circuit.foundation)

ui/developer/notifications/src/commonMain/kotlin/app/tivi/developer/notifications/DevNotificationsPresenter.kt

@@ -8,20 +8,21 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
-import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.runtime.setValue
 import app.tivi.core.notifications.NotificationManager
 import app.tivi.data.models.Notification
 import app.tivi.data.models.NotificationChannel
 import app.tivi.domain.interactors.ScheduleDebugEpisodeNotification
 import app.tivi.screens.DevNotificationsScreen
 import app.tivi.util.launchOrThrow
+import app.tivi.wrapEventSink
 import com.slack.circuit.runtime.CircuitContext
 import com.slack.circuit.runtime.Navigator
 import com.slack.circuit.runtime.presenter.Presenter
 import com.slack.circuit.runtime.screen.Screen
 import kotlin.time.Duration.Companion.minutes
 import kotlin.time.Duration.Companion.seconds
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.isActive
 import kotlinx.datetime.Clock
@@ -51,7 +52,6 @@ class DevNotificationsPresenter(
 
  @Composable
  override fun present(): DevNotificationsUiState {
- val coroutineScope = rememberCoroutineScope()
  var pending by remember { mutableStateOf(emptyList<Notification>()) }
 
  LaunchedEffect(notificationsManager) {
@@ -61,18 +61,18 @@ class DevNotificationsPresenter(
  }
  }
 
- val eventSink: (DevNotificationsUiEvent) -> Unit = { event ->
+ val eventSink: CoroutineScope.(DevNotificationsUiEvent) -> Unit = { event ->
  when (event) {
  DevNotificationsUiEvent.NavigateUp -> navigator.pop()
  DevNotificationsUiEvent.ShowEpisodeAiringNotification -> {
- coroutineScope.launchOrThrow {
+ launchOrThrow {
  scheduleDebugEpisodeNotification(
  ScheduleDebugEpisodeNotification.Params(3.seconds),
  )
  }
  }
  DevNotificationsUiEvent.ScheduleNotification -> {
- coroutineScope.launchOrThrow {
+ launchOrThrow {
  notificationsManager.schedule(
  Notification(
  id = "scheduled_test",
@@ -86,7 +86,7 @@ class DevNotificationsPresenter(
  }
 
  DevNotificationsUiEvent.ShowNotification -> {
- coroutineScope.launchOrThrow {
+ launchOrThrow {
  notificationsManager.schedule(
  Notification(
  id = "immediate_test",
@@ -103,7 +103,7 @@ class DevNotificationsPresenter(
 
  return DevNotificationsUiState(
  pendingNotifications = pending,
- eventSink = eventSink,
+ eventSink = wrapEventSink(eventSink),
  )
  }
 }

ui/developer/settings/build.gradle.kts

@@ -20,6 +20,7 @@ kotlin {
  implementation(projects.core.preferences)
  implementation(projects.domain)
  implementation(projects.common.ui.compose)
+ implementation(projects.common.ui.circuit)
 
  api(projects.common.ui.screens)
  api(libs.circuit.foundation)

ui/developer/settings/src/commonMain/kotlin/app/tivi/settings/developer/DevSettingsPresenter.kt

@@ -5,18 +5,19 @@ package app.tivi.settings.developer
 
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
-import androidx.compose.runtime.rememberCoroutineScope
 import app.tivi.common.compose.collectAsState
 import app.tivi.screens.DevLogScreen
 import app.tivi.screens.DevNotificationsScreen
 import app.tivi.screens.DevSettingsScreen
 import app.tivi.settings.TiviPreferences
 import app.tivi.settings.toggle
 import app.tivi.util.launchOrThrow
+import app.tivi.wrapEventSink
 import com.slack.circuit.runtime.CircuitContext
 import com.slack.circuit.runtime.Navigator
 import com.slack.circuit.runtime.presenter.Presenter
 import com.slack.circuit.runtime.screen.Screen
+import kotlinx.coroutines.CoroutineScope
 import me.tatarka.inject.annotations.Assisted
 import me.tatarka.inject.annotations.Inject
 
@@ -44,22 +45,20 @@ class DevSettingsPresenter(
  override fun present(): DevSettingsUiState {
  val hideArtwork by preferences.value.developerHideArtwork.collectAsState()
 
- val coroutineScope = rememberCoroutineScope()
-
- val eventSink: (DevSettingsUiEvent) -> Unit = { event ->
+ val eventSink: CoroutineScope.(DevSettingsUiEvent) -> Unit = { event ->
  when (event) {
  DevSettingsUiEvent.NavigateUp -> navigator.pop()
  DevSettingsUiEvent.NavigateLog -> navigator.goTo(DevLogScreen)
  DevSettingsUiEvent.NavigateNotifications -> navigator.goTo(DevNotificationsScreen)
  DevSettingsUiEvent.ToggleHideArtwork -> {
- coroutineScope.launchOrThrow { preferences.value.developerHideArtwork.toggle() }
+ launchOrThrow { preferences.value.developerHideArtwork.toggle() }
  }
  }
  }
 
  return DevSettingsUiState(
  hideArtwork = hideArtwork,
- eventSink = eventSink,
+ eventSink = wrapEventSink(eventSink),
  )
  }
 }

ui/discover/src/commonMain/kotlin/app/tivi/home/discover/DiscoverPresenter.kt

@@ -8,7 +8,6 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.remember
-import androidx.compose.runtime.rememberCoroutineScope
 import app.tivi.common.compose.UiMessage
 import app.tivi.common.compose.UiMessageManager
 import app.tivi.data.traktauth.TraktAuthState
@@ -32,12 +31,14 @@ import app.tivi.screens.RecommendedShowsScreen
 import app.tivi.screens.ShowDetailsScreen
 import app.tivi.screens.TrendingShowsScreen
 import app.tivi.util.launchOrThrow
+import app.tivi.wrapEventSink
 import co.touchlab.kermit.Logger
 import com.slack.circuit.retained.collectAsRetainedState
 import com.slack.circuit.runtime.CircuitContext
 import com.slack.circuit.runtime.Navigator
 import com.slack.circuit.runtime.presenter.Presenter
 import com.slack.circuit.runtime.screen.Screen
+import kotlinx.coroutines.CoroutineScope
 import me.tatarka.inject.annotations.Assisted
 import me.tatarka.inject.annotations.Inject
 
@@ -74,7 +75,6 @@ class DiscoverPresenter(
 
  @Composable
  override fun present(): DiscoverUiState {
- val scope = rememberCoroutineScope()
  val uiMessageManager = remember { UiMessageManager() }
 
  val trendingItems by observeTrendingShows.value.flow.collectAsRetainedState(emptyList())
@@ -95,16 +95,16 @@ class DiscoverPresenter(
 
  val message by uiMessageManager.message.collectAsState(null)
 
- val eventSink: (DiscoverUiEvent) -> Unit = { event ->
+ val eventSink: CoroutineScope.(DiscoverUiEvent) -> Unit = { event ->
  when (event) {
  is DiscoverUiEvent.ClearMessage -> {
- scope.launchOrThrow {
+ launchOrThrow {
  uiMessageManager.clearMessage(event.id)
  }
  }
 
  is DiscoverUiEvent.Refresh -> {
- scope.launchOrThrow {
+ launchOrThrow {
  updatePopularShows.value.invoke(
  UpdatePopularShows.Params(
  page = UpdatePopularShows.Page.REFRESH,
@@ -115,7 +115,7 @@ class DiscoverPresenter(
  uiMessageManager.emitMessage(UiMessage(e))
  }
  }
- scope.launchOrThrow {
+ launchOrThrow {
  updateTrendingShows.value.invoke(
  UpdateTrendingShows.Params(
  page = UpdateTrendingShows.Page.REFRESH,
@@ -126,7 +126,7 @@ class DiscoverPresenter(
  uiMessageManager.emitMessage(UiMessage(e))
  }
  }
- scope.launchOrThrow {
+ launchOrThrow {
  updateAntipicatedShows.value.invoke(
  UpdateAnticipatedShows.Params(
  page = UpdateAnticipatedShows.Page.REFRESH,
@@ -138,7 +138,7 @@ class DiscoverPresenter(
  }
  }
  if (authState == TraktAuthState.LOGGED_IN) {
- scope.launchOrThrow {
+ launchOrThrow {
  updateRecommendedShows.value.invoke(
  UpdateRecommendedShows.Params(isUserInitiated = event.fromUser),
  ).onFailure { e ->
@@ -190,7 +190,7 @@ class DiscoverPresenter(
  anticipatedRefreshing = anticipatedLoading,
  nextEpisodesToWatch = nextEpisodesToWatch,
  message = message,
- eventSink = eventSink,
+ eventSink = wrapEventSink(eventSink),
  )
  }
 }