Merge pull request #108 from hoc081098/better_flowredux

better flowredux SideEffect

Author: hoc081098

flowredux/src/commonMain/kotlin/com/hoc081098/flowredux/SideEffect.kt

@@ -59,3 +59,19 @@ public fun <Action, State, Output : Any> allActionsToOutputChannelSideEffect(
 
   return sideEffect to actionChannel
 }
+
+/**
+ * Create a [SideEffect] that consumes all actions.
+ * The [SideEffect] will be cancelled when the [SideEffect] is cancelled (when calling [FlowReduxStore.close]).
+ *
+ * @param consumer A function that consumes an [Action].
+ */
+public fun <Action, State> allActionsConsumerSideEffect(
+  consumer: suspend (Action) -> Unit,
+): SideEffect<Action, State> = SideEffect { actionFlow, _, coroutineScope ->
+  actionFlow
+    .onEach(consumer)
+    .launchIn(coroutineScope)
+
+  emptyFlow()
+}

shared/src/commonMain/kotlin/com/hoc081098/github_search_kmm/presentation/GithubSearchSideEffectsContainer.kt

@@ -4,9 +4,10 @@ import com.hoc081098.flowext.flatMapFirst
 import com.hoc081098.flowext.flowFromSuspend
 import com.hoc081098.flowext.takeUntil
 import com.hoc081098.flowredux.SideEffect
-import com.hoc081098.flowredux.allActionsToOutputChannelSideEffect
+import com.hoc081098.flowredux.allActionsConsumerSideEffect
 import com.hoc081098.github_search_kmm.domain.usecase.SearchRepoItemsUseCase
 import com.hoc081098.github_search_kmm.presentation.GithubSearchState.Companion.FIRST_PAGE
+import com.hoc081098.github_search_kmm.presentation.common.SingleEventChannel
 import com.hoc081098.github_search_kmm.utils.eitherLceFlow
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
@@ -24,14 +25,10 @@ import kotlinx.coroutines.flow.shareIn
 import kotlinx.coroutines.flow.take
 
 @Suppress("NOTHING_TO_INLINE")
-internal class GithubSearchSideEffectsContainer(private val searchRepoItemsUseCase: SearchRepoItemsUseCase) {
-  private val sendSingleEventSideEffect = allActionsToOutputChannelSideEffect<
-    GithubSearchAction,
-    GithubSearchState,
-    GithubSearchSingleEvent,
-    > { it.toGithubSearchSingleEventOrNull() }
-
-  internal val eventChannel get() = sendSingleEventSideEffect.second
+internal class GithubSearchSideEffectsContainer(
+  private val searchRepoItemsUseCase: SearchRepoItemsUseCase,
+  private val singleEventChannel: SingleEventChannel<GithubSearchSingleEvent>,
+) {
 
   /**
    * @return A list of [SideEffect]s contained in this class.
@@ -49,9 +46,15 @@ internal class GithubSearchSideEffectsContainer(private val searchRepoItemsUseCa
       // [Retry] -> [SearchLCE]s
       retry(),
       // Send single event
-      sendSingleEventSideEffect.first,
+      sendSingleEvent(),
     )
 
+  private inline fun sendSingleEvent() = allActionsConsumerSideEffect<GithubSearchAction, GithubSearchState> { action ->
+    action
+      .toGithubSearchSingleEventOrNull()
+      ?.let { singleEventChannel.sendEvent(it) }
+  }
+
   /**
    * [GithubSearchAction.Search]s to [SideEffectAction.TextChanged]s
    */

shared/src/commonMain/kotlin/com/hoc081098/github_search_kmm/presentation/GithubSearchViewModel.kt

@@ -12,19 +12,18 @@ import com.hoc081098.kmp.viewmodel.ViewModel
 import com.hoc081098.kmp.viewmodel.wrapper.NonNullFlowWrapper
 import com.hoc081098.kmp.viewmodel.wrapper.NonNullStateFlowWrapper
 import com.hoc081098.kmp.viewmodel.wrapper.wrap
-import kotlinx.coroutines.channels.consumeEach
-import kotlinx.coroutines.launch
 
 open class GithubSearchViewModel(
   searchRepoItemsUseCase: SearchRepoItemsUseCase,
   private val savedStateHandle: SavedStateHandle,
   private val singleEventChannel: SingleEventChannel<GithubSearchSingleEvent>,
 ) : ViewModel(singleEventChannel) {
-  private val effectsContainer = GithubSearchSideEffectsContainer(searchRepoItemsUseCase)
-
   private val store = viewModelScope.createFlowReduxStore(
     initialState = GithubSearchState.initial(),
-    sideEffects = effectsContainer.sideEffects,
+    sideEffects = GithubSearchSideEffectsContainer(
+      searchRepoItemsUseCase = searchRepoItemsUseCase,
+      singleEventChannel = singleEventChannel,
+    ).sideEffects,
     reducer = Reducer(flip(GithubSearchAction::reduce))
       .withLogger(githubSearchFlowReduxLogger()),
   )
@@ -34,13 +33,6 @@ open class GithubSearchViewModel(
   val eventFlow: NonNullFlowWrapper<GithubSearchSingleEvent> = singleEventChannel.singleEventFlow.wrap()
 
   init {
-    // Forward all events from `effectsContainer.eventChannel` to `singleEventChannel`
-    viewModelScope.launch {
-      effectsContainer
-        .eventChannel
-        .consumeEach { singleEventChannel.sendEvent(it) }
-    }
-
     store.dispatch(InitialSearchAction(termStateFlow.value))
   }