[coroutines] Allow ignoring specified Effect types in `MobiusEffectRo…

…uter`
DrewCarlson · Feb 15, 2023 · 1479747 · 1479747
1 parent a5cfa7b
commit 1479747
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 11 deletions.
diff --git a/mobiuskt-coroutines/api/mobiuskt-coroutines.api b/mobiuskt-coroutines/api/mobiuskt-coroutines.api
@@ -34,7 +34,7 @@ public final class kt/mobius/flow/FlowTransformerKt {
 }
 
 public final class kt/mobius/flow/SubtypeEffectHandlerBuilder {
-	public fun <init> ()V
+	public fun <init> (Ljava/util/List;)V
 	public final fun addAction (Lkotlin/reflect/KClass;Lkotlin/jvm/functions/Function1;)V
 	public final fun addConsumer (Lkotlin/reflect/KClass;Lkotlin/jvm/functions/Function2;)V
 	public final fun addFunction (Lkotlin/reflect/KClass;Lkotlin/jvm/functions/Function2;)V
@@ -43,7 +43,8 @@ public final class kt/mobius/flow/SubtypeEffectHandlerBuilder {
 }
 
 public final class kt/mobius/flow/SubtypeEffectHandlerKt {
-	public static final fun subtypeEffectHandler (Lkotlin/jvm/functions/Function1;)Lkt/mobius/flow/FlowTransformer;
+	public static final fun subtypeEffectHandler (Ljava/util/List;Lkotlin/jvm/functions/Function1;)Lkt/mobius/flow/FlowTransformer;
+	public static synthetic fun subtypeEffectHandler$default (Ljava/util/List;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lkt/mobius/flow/FlowTransformer;
 }
 
 public final class kt/mobius/flow/SubtypeEffectHandlerKt$sam$i$kt_mobius_flow_FlowTransformer$0 : kotlin/jvm/internal/FunctionAdapter, kt/mobius/flow/FlowTransformer {

diff --git a/mobiuskt-coroutines/src/commonMain/kotlin/MobiusEffectRouter.kt b/mobiuskt-coroutines/src/commonMain/kotlin/MobiusEffectRouter.kt
@@ -5,17 +5,19 @@ import kotlin.reflect.KClass
 
 internal class MobiusEffectRouter<F : Any, E>(
     private val effectClasses: Set<KClass<*>>,
-    private val effectPerformers: List<FlowTransformer<F, E>>
+    private val effectPerformers: List<FlowTransformer<F, E>>,
+    private val ignoredEffects: List<KClass<*>>
 ) : FlowTransformer<F, E> {
 
     private val unhandledEffectHandler =
         flowTransformer<F, E> { effects: Flow<F> ->
             effects
                 .filter { effect ->
-                    effectClasses
-                        .none { effectClass ->
-                            effectClass.isInstance(effect)
-                        }
+                    ignoredEffects.none { effectClass ->
+                        effectClass.isInstance(effect)
+                    } && effectClasses.none { effectClass ->
+                        effectClass.isInstance(effect)
+                    }
                 }
                 .map { effect -> throw UnknownEffectException(effect) }
         }

diff --git a/mobiuskt-coroutines/src/commonMain/kotlin/SubtypeEffectHandler.kt b/mobiuskt-coroutines/src/commonMain/kotlin/SubtypeEffectHandler.kt
@@ -9,14 +9,17 @@ import kotlin.reflect.KClass
 import kotlin.reflect.cast
 
 public fun <F : Any, E> subtypeEffectHandler(
+    ignoredEffects: List<KClass<*>> = emptyList(),
     block: SubtypeEffectHandlerBuilder<F, E>.() -> Unit
 ): FlowTransformer<F, E> =
-    SubtypeEffectHandlerBuilder<F, E>()
+    SubtypeEffectHandlerBuilder<F, E>(ignoredEffects)
         .apply(block)
         .build()
 
 @Suppress("RemoveExplicitTypeArguments")
-public class SubtypeEffectHandlerBuilder<F : Any, E> {
+public class SubtypeEffectHandlerBuilder<F : Any, E>(
+    private val ignoredEffects: List<KClass<*>>
+) {
     private val effectPerformerMap = hashMapOf<KClass<*>, FlowTransformer<F, E>>()
 
     public inline fun <reified G : F> addTransformer(
@@ -97,6 +100,7 @@ public class SubtypeEffectHandlerBuilder<F : Any, E> {
     public fun build(): FlowTransformer<F, E> =
         MobiusEffectRouter(
             effectClasses = effectPerformerMap.keys.toImmutableSet(),
-            effectPerformers = effectPerformerMap.values.toImmutableList()
+            effectPerformers = effectPerformerMap.values.toImmutableList(),
+            ignoredEffects = ignoredEffects.toImmutableList()
         )
 }
diff --git a/mobiuskt-coroutines/src/commonTest/kotlin/FlowSubtypeEffectHandlerTest.kt b/mobiuskt-coroutines/src/commonTest/kotlin/FlowSubtypeEffectHandlerTest.kt
@@ -14,9 +14,11 @@ class FlowSubtypeEffectHandlerTest {
     private lateinit var action: RecordingConsumer<Effect.Test4>
     private lateinit var handler: FlowTransformer<Effect, Event>
 
+    private interface IEffect
+
     private sealed class Effect {
         data class Test1(val value: Int) : Effect()
-        data class Test2(val value: Int) : Effect()
+        data class Test2(val value: Int) : Effect(), IEffect
         data class Test3(val value: Int) : Effect()
         object Test4 : Effect()
 
@@ -86,4 +88,16 @@ class FlowSubtypeEffectHandlerTest {
             }
         }
     }
+
+    @Test
+    fun testIgnoredEffectsDontThrow() = runTest {
+        handler = subtypeEffectHandler(
+            ignoredEffects = listOf(IEffect::class)
+        ) {
+            addConsumer<Effect.Test1> { }
+        }
+        handler(flowOf(Effect.Test2(1))).test {
+            awaitComplete()
+        }
+    }
 }