Make TestStore.receive actually match the action predicate (#1780)

* Assert that TestStore.receive(...) actually calls its predicate

* Fix TestStore.receive to respect its action predicate

* Update TestStore failure tests to use new description strings

Author: pyrtsa

Sources/ComposableArchitecture/TestStore.swift

@@ -1174,30 +1174,18 @@ extension TestStore where ScopedState: Equatable, Action: Equatable {
   ) {
     self.receiveAction(
       matching: { expectedAction == $0 },
-      failureMessage: "Expected to receive an action \(expectedAction), but didn't get one.",
-      onReceive: { receivedAction in
-        if expectedAction != receivedAction {
-          let difference = TaskResultDebugging.$emitRuntimeWarnings.withValue(false) {
-            diff(expectedAction, receivedAction, format: .proportional)
-              .map { "\($0.indent(by: 4))\n\n(Expected: −, Received: +)" }
-              ?? """
-              Expected:
-              \(String(describing: expectedAction).indent(by: 2))
-
-              Received:
-              \(String(describing: receivedAction).indent(by: 2))
-              """
-          }
-
-          XCTFailHelper(
+      failureMessage: #"Expected to receive an action "\#(expectedAction)", but didn't get one."#,
+      unexpectedActionDescription: { receivedAction in
+        TaskResultDebugging.$emitRuntimeWarnings.withValue(false) {
+          diff(expectedAction, receivedAction, format: .proportional)
+            .map { "\($0.indent(by: 4))\n\n(Expected: −, Received: +)" }
+            ?? """
+            Expected:
+            \(String(describing: expectedAction).indent(by: 2))
+
+            Received:
+            \(String(describing: receivedAction).indent(by: 2))
             """
-            Received unexpected action: …
-
-            \(difference)
-            """,
-            file: file,
-            line: line
-          )
         }
       },
       updateStateToExpectedResult,
@@ -1231,22 +1219,11 @@ extension TestStore where ScopedState: Equatable, Action: Equatable {
   ) {
     self.receiveAction(
       matching: matching,
-      failureMessage: "Expected to receive a matching action, but didn't get one.",
-      onReceive: { receivedAction in
+      failureMessage: "Expected to receive an action matching predicate, but didn't get one.",
+      unexpectedActionDescription: { receivedAction in
         var action = ""
         customDump(receivedAction, to: &action, indent: 2)
-        XCTFailHelper(
-          """
-          Received action without asserting on payload:
-
-          \(action)
-          """,
-          overrideExhaustivity: self.exhaustivity == .on
-            ? .off(showSkippedAssertions: true)
-            : self.exhaustivity,
-          file: file,
-          line: line
-        )
+        return action
       },
       updateStateToExpectedResult,
       file: file,
@@ -1277,22 +1254,11 @@ extension TestStore where ScopedState: Equatable, Action: Equatable {
   ) {
     self.receiveAction(
       matching: { casePath.extract(from: $0) != nil },
-      failureMessage: "Expected to receive a matching action, but didn't get one.",
-      onReceive: { receivedAction in
+      failureMessage: "Expected to receive an action matching case path, but didn't get one.",
+      unexpectedActionDescription: { receivedAction in
         var action = ""
         customDump(receivedAction, to: &action, indent: 2)
-        XCTFailHelper(
-          """
-          Received action without asserting on payload:
-
-          \(action)
-          """,
-          overrideExhaustivity: self.exhaustivity == .on
-            ? .off(showSkippedAssertions: true)
-            : self.exhaustivity,
-          file: file,
-          line: line
-        )
+        return action
       },
       updateStateToExpectedResult,
       file: file,
@@ -1569,16 +1535,14 @@ extension TestStore where ScopedState: Equatable, Action: Equatable {
   private func receiveAction(
     matching predicate: (Action) -> Bool,
     failureMessage: @autoclosure () -> String,
-    onReceive: (Action) -> Void,
+    unexpectedActionDescription: (Action) -> String,
     _ updateStateToExpectedResult: ((inout ScopedState) throws -> Void)?,
     file: StaticString,
     line: UInt
   ) {
     guard !self.reducer.receivedActions.isEmpty else {
       XCTFail(
-        """
-        Expected to receive an action, but received none.
-        """,
+        failureMessage(),
         file: file,
         line: line
       )
@@ -1622,7 +1586,17 @@ extension TestStore where ScopedState: Equatable, Action: Equatable {
     }
 
     let (receivedAction, state) = self.reducer.receivedActions.removeFirst()
-    onReceive(receivedAction)
+    if !predicate(receivedAction) {
+      XCTFailHelper(
+        """
+        Received unexpected action: …
+
+        \(unexpectedActionDescription(receivedAction))
+        """,
+        file: file,
+        line: line
+      )
+    }
     let expectedState = self.toScopedState(self.state)
     do {
       try self.expectedStateShouldMatch(

Tests/ComposableArchitectureTests/TestStoreFailureTests.swift

@@ -216,7 +216,7 @@
       XCTExpectFailure {
         store.receive(.action)
       } issueMatcher: { issue in
-        issue.compactDescription == "Expected to receive an action, but received none."
+        issue.compactDescription == #"Expected to receive an action "action", but didn't get one."#
       }
     }
 

Tests/ComposableArchitectureTests/TestStoreNonExhaustiveTests.swift

@@ -606,7 +606,7 @@
 
       XCTExpectFailure {
         $0.compactDescription == """
-          Expected to receive a matching action, but didn't get one.
+          Expected to receive an action matching case path, but didn't get one.
           """
       }
 
@@ -627,7 +627,7 @@
 
       XCTExpectFailure {
         $0.compactDescription == """
-          Expected to receive an action, but received none.
+          Expected to receive an action matching case path, but didn't get one.
           """
       }
 

Tests/ComposableArchitectureTests/TestStoreTests.swift

@@ -167,6 +167,41 @@ final class TestStoreTests: XCTestCase {
         }
       }
     }
+
+    func testReceiveActionMatchingPredicate() async {
+      enum Action: Equatable {
+        case noop, finished
+      }
+
+      let reducer = Reduce<Int, Action> { state, action in
+        switch action {
+        case .noop:
+          return EffectTask(value: .finished)
+        case .finished:
+          return .none
+        }
+      }
+
+      let store = TestStore(initialState: 0, reducer: reducer)
+
+      let predicateShouldBeCalledExpectation = expectation(description: "predicate should be called")
+      await store.send(.noop)
+      await store.receive { action in
+        predicateShouldBeCalledExpectation.fulfill()
+        return action == .finished
+      }
+      wait(for: [predicateShouldBeCalledExpectation], timeout: 0)
+
+      XCTExpectFailure {
+        store.send(.noop)
+        store.receive(.noop)
+      }
+
+      XCTExpectFailure {
+        store.send(.noop)
+        store.receive { $0 == .noop }
+      }
+    }
   #endif
 
   func testStateAccess() async {