A better test failure message for long live effect

[yuyuUI]

Hi, thanks for the fantastic test tool. I am still trying to figure out what long live effect is running. Can we add a hint for what action causes?

Something like:

diff --git a/Sources/ComposableArchitecture/TestStore.swift b/Sources/ComposableArchitecture/TestStore.swift
index a8d128be87..0f6d8b3d74 100644
--- a/Sources/ComposableArchitecture/TestStore.swift
+++ b/Sources/ComposableArchitecture/TestStore.swift
@@ -889,6 +889,7 @@ public final class TestStore<State, Action, ScopedState, ScopedAction, Environme
         """
         An effect returned for this action is still running. It must complete before the end of \
         the test. …
+        effect description: \(effect.action.description)
 
         To fix, inspect any effects the reducer returns for this action and ensure that all of \
         them complete by the end of the test. There are a few reasons why an effect may not have \
@@ -2406,6 +2407,14 @@ class TestReducer<State, Action>: ReducerProtocol {
     let origin: Origin
     let file: StaticString
     let line: UInt
+    var description: String {
+      switch origin {
+      case let .receive(action):
+        return "by receive \(action)"
+      case let .send(action):
+        return "by send \(action)"
+      }
+    }
 
     enum Origin {
       case receive(Action)
diff --git a/Tests/ComposableArchitectureTests/TestStoreFailureTests.swift b/Tests/ComposableArchitectureTests/TestStoreFailureTests.swift
index b1e13acfe3..7124dd50c8 100644
--- a/Tests/ComposableArchitectureTests/TestStoreFailureTests.swift
+++ b/Tests/ComposableArchitectureTests/TestStoreFailureTests.swift
@@ -152,6 +152,7 @@
         $0.compactDescription == """
           An effect returned for this action is still running. It must complete before the end of \
           the test. …
+          effect description: by send ()
 
           To fix, inspect any effects the reducer returns for this action and ensure that all of \
           them complete by the end of the test. There are a few reasons why an effect may not have \

[yuyuUI]

No idea why, but sometimes the failure report show on the last send line instead of the one actually subscribes to the long Live effect.

[stephencelis]

Hi @yuyuUI! The current behavior is to tie effects to the originating send. It sounds like you may be seeing an effect that was kicked off from a received action, and we further tie that to the original sent action.

We're open to revisiting this but an example would help. Want to sketch out a failing test to explore what it would look like?