Bucket effect cancel IDs. (pointfreeco#3374)

mbrandonw · web-flow · commit 03ad0cce2d03 · 2024-09-12T13:48:39.000-04:00
* Bucket effect cancel IDs.

* wip

* wip

* remove cache reset

* wip

* wip

* wip
diff --git a/.github/package.xcworkspace/xcshareddata/swiftpm/Package.resolved b/.github/package.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -77,17 +77,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-dependencies",
       "state" : {
-        "revision" : "3ef38bb702a1a2f39c7e19fc0578403b8ee52b17",
-        "version" : "1.3.9"
+        "revision" : "fd1fb25b68fdb9756cd61d23dbd9e2614b340085",
+        "version" : "1.4.0"
       }
     },
     {
       "identity" : "swift-docc-plugin",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/swiftlang/swift-docc-plugin",
       "state" : {
-        "revision" : "2eb22993b3dfd0c0d32729b357c8dabb6cd44680",
-        "version" : "1.4.2"
+        "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
+        "version" : "1.4.3"
       }
     },
     {
@@ -140,8 +140,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-snapshot-testing",
       "state" : {
-        "revision" : "6d932a79e7173b275b96c600c86c603cf84f153c",
-        "version" : "1.17.4"
+        "revision" : "7b0bbbae90c41f848f90ac7b4df6c4f50068256d",
+        "version" : "1.17.5"
       }
     },
     {
@@ -158,8 +158,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",
       "state" : {
-        "revision" : "96beb108a57f24c8476ae1f309239270772b2940",
-        "version" : "1.2.5"
+        "revision" : "bc2a151366f2cd0e347274544933bc2acb00c9fe",
+        "version" : "1.4.0"
       }
     }
   ],
diff --git a/ComposableArchitecture.xcworkspace/xcshareddata/swiftpm/Package.resolved b/ComposableArchitecture.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -77,17 +77,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-dependencies",
       "state" : {
-        "revision" : "3ef38bb702a1a2f39c7e19fc0578403b8ee52b17",
-        "version" : "1.3.9"
+        "revision" : "fd1fb25b68fdb9756cd61d23dbd9e2614b340085",
+        "version" : "1.4.0"
       }
     },
     {
       "identity" : "swift-docc-plugin",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/swiftlang/swift-docc-plugin",
       "state" : {
-        "revision" : "2eb22993b3dfd0c0d32729b357c8dabb6cd44680",
-        "version" : "1.4.2"
+        "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
+        "version" : "1.4.3"
       }
     },
     {
@@ -140,8 +140,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-snapshot-testing.git",
       "state" : {
-        "revision" : "6d932a79e7173b275b96c600c86c603cf84f153c",
-        "version" : "1.17.4"
+        "revision" : "7b0bbbae90c41f848f90ac7b4df6c4f50068256d",
+        "version" : "1.17.5"
       }
     },
     {
@@ -167,8 +167,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",
       "state" : {
-        "revision" : "96beb108a57f24c8476ae1f309239270772b2940",
-        "version" : "1.2.5"
+        "revision" : "bc2a151366f2cd0e347274544933bc2acb00c9fe",
+        "version" : "1.4.0"
       }
     }
   ],
diff --git a/Package.resolved b/Package.resolved
@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-case-paths",
       "state" : {
-        "revision" : "71344dd930fde41e8f3adafe260adcbb2fc2a3dc",
-        "version" : "1.5.4"
+        "revision" : "642e6aab8e03e5f992d9c83e38c5be98cfad5078",
+        "version" : "1.5.5"
       }
     },
     {
@@ -50,8 +50,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/apple/swift-collections",
       "state" : {
-        "revision" : "3d2dc41a01f9e49d84f0a3925fb858bed64f702d",
-        "version" : "1.1.2"
+        "revision" : "9bf03ff58ce34478e66aaee630e491823326fd06",
+        "version" : "1.1.3"
       }
     },
     {
@@ -77,17 +77,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-dependencies",
       "state" : {
-        "revision" : "3ef38bb702a1a2f39c7e19fc0578403b8ee52b17",
-        "version" : "1.3.9"
+        "revision" : "fd1fb25b68fdb9756cd61d23dbd9e2614b340085",
+        "version" : "1.4.0"
       }
     },
     {
       "identity" : "swift-docc-plugin",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/swiftlang/swift-docc-plugin",
       "state" : {
-        "revision" : "0510d9160330025fb5823f7845c26af3cd56a405",
-        "version" : "1.4.1"
+        "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
+        "version" : "1.4.3"
       }
     },
     {
@@ -122,8 +122,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-navigation",
       "state" : {
-        "revision" : "4d04eb04807dc3176515184abe08c3adcbb04713",
-        "version" : "2.1.0"
+        "revision" : "e834b3760731160d7d448509ee6a1408c8582a6b",
+        "version" : "2.2.0"
       }
     },
     {
@@ -140,8 +140,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/swift-snapshot-testing",
       "state" : {
-        "revision" : "6d932a79e7173b275b96c600c86c603cf84f153c",
-        "version" : "1.17.4"
+        "revision" : "7b0bbbae90c41f848f90ac7b4df6c4f50068256d",
+        "version" : "1.17.5"
       }
     },
     {
@@ -150,16 +150,16 @@
       "location" : "https://github.com/swiftlang/swift-syntax",
       "state" : {
         "revision" : "515f79b522918f83483068d99c68daeb5116342d",
-        "version" : "600.0.0-prerelease-2024-08-20"
+        "version" : "600.0.0-prerelease-2024-09-04"
       }
     },
     {
       "identity" : "xctest-dynamic-overlay",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",
       "state" : {
-        "revision" : "96beb108a57f24c8476ae1f309239270772b2940",
-        "version" : "1.2.5"
+        "revision" : "bc2a151366f2cd0e347274544933bc2acb00c9fe",
+        "version" : "1.4.0"
       }
     }
   ],
diff --git a/Package.swift b/Package.swift
@@ -24,12 +24,12 @@ let package = Package(
     .package(url: "https://github.com/pointfreeco/swift-case-paths", from: "1.5.4"),
     .package(url: "https://github.com/pointfreeco/swift-concurrency-extras", from: "1.1.0"),
     .package(url: "https://github.com/pointfreeco/swift-custom-dump", from: "1.3.2"),
-    .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.3.5"),
+    .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.4.0"),
     .package(url: "https://github.com/pointfreeco/swift-identified-collections", from: "1.1.0"),
     .package(url: "https://github.com/pointfreeco/swift-macro-testing", from: "0.2.0"),
     .package(url: "https://github.com/pointfreeco/swift-navigation", from: "2.1.0"),
     .package(url: "https://github.com/pointfreeco/swift-perception", from: "1.3.4"),
-    .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.2.2"),
+    .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.3.0"),
     .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
     .package(url: "https://github.com/swiftlang/swift-syntax", "509.0.0"..<"601.0.0-prerelease"),
   ],
diff --git a/Package@swift-6.0.swift b/Package@swift-6.0.swift
@@ -24,12 +24,12 @@ let package = Package(
     .package(url: "https://github.com/pointfreeco/swift-case-paths", from: "1.5.4"),
     .package(url: "https://github.com/pointfreeco/swift-concurrency-extras", from: "1.1.0"),
     .package(url: "https://github.com/pointfreeco/swift-custom-dump", from: "1.3.2"),
-    .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.3.5"),
+    .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.4.0"),
     .package(url: "https://github.com/pointfreeco/swift-identified-collections", from: "1.1.0"),
     .package(url: "https://github.com/pointfreeco/swift-macro-testing", from: "0.2.0"),
     .package(url: "https://github.com/pointfreeco/swift-navigation", from: "2.1.0"),
     .package(url: "https://github.com/pointfreeco/swift-perception", from: "1.3.4"),
-    .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.2.2"),
+    .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.3.0"),
     .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
     .package(url: "https://github.com/swiftlang/swift-syntax", "509.0.0"..<"601.0.0-prerelease"),
   ],
diff --git a/Sources/ComposableArchitecture/Effects/Cancellation.swift b/Sources/ComposableArchitecture/Effects/Cancellation.swift
@@ -244,11 +244,18 @@ extension Task<Never, Never> {
   let discriminator: ObjectIdentifier
   let id: AnyHashable
   let navigationIDPath: NavigationIDPath
+  let testIdentifier: TestContext.Testing.Test.ID?
 
   init(id: some Hashable, navigationIDPath: NavigationIDPath) {
     self.discriminator = ObjectIdentifier(type(of: id))
     self.id = id
     self.navigationIDPath = navigationIDPath
+    switch TestContext.current {
+    case let .swiftTesting(.some(testing)):
+      self.testIdentifier = testing.test.id
+    default:
+      self.testIdentifier = nil
+    }
   }
 }
 
diff --git a/Sources/ComposableArchitecture/TestStore.swift b/Sources/ComposableArchitecture/TestStore.swift
@@ -535,9 +535,6 @@ public final class TestStore<State, Action> {
   where State: Equatable, R.State == State, R.Action == Action {
     let sharedChangeTracker = SharedChangeTracker()
     let reducer = Dependencies.withDependencies {
-      if TestContext.current == .swiftTesting {
-        $0.resetCache()
-      }
       prepareDependencies(&$0)
       $0.sharedChangeTrackers.insert(sharedChangeTracker)
     } operation: {
diff --git a/Tests/ComposableArchitectureTests/EffectCancellationIsolationTests.swift b/Tests/ComposableArchitectureTests/EffectCancellationIsolationTests.swift
@@ -0,0 +1,62 @@
+#if canImport(Testing)
+import ComposableArchitecture
+import Testing
+
+@Suite
+struct EffectCancellationIsolationTests {
+  @Test
+  func testIsolation1() async {
+    let store = await TestStore(initialState: Feature.State()) {
+      Feature()
+    }
+    await store.send(.start)
+    await store.receive(\.response) {
+      $0.value = 42
+    }
+    await store.send(.stop)
+  }
+
+  @Test
+  func testIsolation2() async {
+    let store = await TestStore(initialState: Feature.State()) {
+      Feature()
+    }
+    await store.send(.start)
+    await store.receive(\.response) {
+      $0.value = 42
+    }
+    await store.send(.stop)
+  }
+}
+
+@Reducer
+private struct Feature {
+  struct State: Equatable {
+    var value = 0
+  }
+  enum Action {
+    case response(Int)
+    case start
+    case stop
+  }
+  enum CancelID { case longLiving }
+  var body: some ReducerOf<Self> {
+    Reduce { state, action in
+      switch action {
+      case .response(let value):
+        state.value = value
+        return .none
+      case .start:
+        return .run { send in
+          await send(.response(42))
+          try await Task.never()
+        }
+          .cancellable(id: CancelID.longLiving, cancelInFlight: true)
+      case .stop:
+        return .cancel(id: CancelID.longLiving)
+      }
+    }
+  }
+}
+
+#endif
diff --git a/Tests/ComposableArchitectureTests/EffectCancellationTests.swift b/Tests/ComposableArchitectureTests/EffectCancellationTests.swift
@@ -11,6 +11,12 @@ final class EffectCancellationTests: BaseTCATestCase {
     self.cancellables.removeAll()
   }
 
+  override func invokeTest() {
+    withMainSerialExecutor {
+      super.invokeTest()
+    }
+  }
+
   func testCancellation() async {
     let values = LockIsolated<[Int]>([])
 

Original file line number	Diff line number	Diff line change
`@@ -77,17 +77,17 @@`
`77`	`77`	`"kind" : "remoteSourceControl",`
`78`	`78`	`"location" : "https://github.com/pointfreeco/swift-dependencies",`
`79`	`79`	`"state" : {`
`80`		`- "revision" : "3ef38bb702a1a2f39c7e19fc0578403b8ee52b17",`
`81`		`- "version" : "1.3.9"`
	`80`	`+ "revision" : "fd1fb25b68fdb9756cd61d23dbd9e2614b340085",`
	`81`	`+ "version" : "1.4.0"`
`82`	`82`	`}`
`83`	`83`	`},`
`84`	`84`	`{`
`85`	`85`	`"identity" : "swift-docc-plugin",`
`86`	`86`	`"kind" : "remoteSourceControl",`
`87`	`87`	`"location" : "https://github.com/swiftlang/swift-docc-plugin",`
`88`	`88`	`"state" : {`
`89`		`- "revision" : "2eb22993b3dfd0c0d32729b357c8dabb6cd44680",`
`90`		`- "version" : "1.4.2"`
	`89`	`+ "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",`
	`90`	`+ "version" : "1.4.3"`
`91`	`91`	`}`
`92`	`92`	`},`
`93`	`93`	`{`
`@@ -140,8 +140,8 @@`
`140`	`140`	`"kind" : "remoteSourceControl",`
`141`	`141`	`"location" : "https://github.com/pointfreeco/swift-snapshot-testing",`
`142`	`142`	`"state" : {`
`143`		`- "revision" : "6d932a79e7173b275b96c600c86c603cf84f153c",`
`144`		`- "version" : "1.17.4"`
	`143`	`+ "revision" : "7b0bbbae90c41f848f90ac7b4df6c4f50068256d",`
	`144`	`+ "version" : "1.17.5"`
`145`	`145`	`}`
`146`	`146`	`},`
`147`	`147`	`{`
`@@ -158,8 +158,8 @@`
`158`	`158`	`"kind" : "remoteSourceControl",`
`159`	`159`	`"location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",`
`160`	`160`	`"state" : {`
`161`		`- "revision" : "96beb108a57f24c8476ae1f309239270772b2940",`
`162`		`- "version" : "1.2.5"`
	`161`	`+ "revision" : "bc2a151366f2cd0e347274544933bc2acb00c9fe",`
	`162`	`+ "version" : "1.4.0"`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`	`],`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,8 @@`
`32`	`32`	`"kind" : "remoteSourceControl",`
`33`	`33`	`"location" : "https://github.com/pointfreeco/swift-case-paths",`
`34`	`34`	`"state" : {`
`35`		`- "revision" : "71344dd930fde41e8f3adafe260adcbb2fc2a3dc",`
`36`		`- "version" : "1.5.4"`
	`35`	`+ "revision" : "642e6aab8e03e5f992d9c83e38c5be98cfad5078",`
	`36`	`+ "version" : "1.5.5"`
`37`	`37`	`}`
`38`	`38`	`},`
`39`	`39`	`{`
`@@ -50,8 +50,8 @@`
`50`	`50`	`"kind" : "remoteSourceControl",`
`51`	`51`	`"location" : "https://github.com/apple/swift-collections",`
`52`	`52`	`"state" : {`
`53`		`- "revision" : "3d2dc41a01f9e49d84f0a3925fb858bed64f702d",`
`54`		`- "version" : "1.1.2"`
	`53`	`+ "revision" : "9bf03ff58ce34478e66aaee630e491823326fd06",`
	`54`	`+ "version" : "1.1.3"`
`55`	`55`	`}`
`56`	`56`	`},`
`57`	`57`	`{`
`@@ -77,17 +77,17 @@`
`77`	`77`	`"kind" : "remoteSourceControl",`
`78`	`78`	`"location" : "https://github.com/pointfreeco/swift-dependencies",`
`79`	`79`	`"state" : {`
`80`		`- "revision" : "3ef38bb702a1a2f39c7e19fc0578403b8ee52b17",`
`81`		`- "version" : "1.3.9"`
	`80`	`+ "revision" : "fd1fb25b68fdb9756cd61d23dbd9e2614b340085",`
	`81`	`+ "version" : "1.4.0"`
`82`	`82`	`}`
`83`	`83`	`},`
`84`	`84`	`{`
`85`	`85`	`"identity" : "swift-docc-plugin",`
`86`	`86`	`"kind" : "remoteSourceControl",`
`87`	`87`	`"location" : "https://github.com/swiftlang/swift-docc-plugin",`
`88`	`88`	`"state" : {`
`89`		`- "revision" : "0510d9160330025fb5823f7845c26af3cd56a405",`
`90`		`- "version" : "1.4.1"`
	`89`	`+ "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",`
	`90`	`+ "version" : "1.4.3"`
`91`	`91`	`}`
`92`	`92`	`},`
`93`	`93`	`{`
`@@ -122,8 +122,8 @@`
`122`	`122`	`"kind" : "remoteSourceControl",`
`123`	`123`	`"location" : "https://github.com/pointfreeco/swift-navigation",`
`124`	`124`	`"state" : {`
`125`		`- "revision" : "4d04eb04807dc3176515184abe08c3adcbb04713",`
`126`		`- "version" : "2.1.0"`
	`125`	`+ "revision" : "e834b3760731160d7d448509ee6a1408c8582a6b",`
	`126`	`+ "version" : "2.2.0"`
`127`	`127`	`}`
`128`	`128`	`},`
`129`	`129`	`{`
`@@ -140,8 +140,8 @@`
`140`	`140`	`"kind" : "remoteSourceControl",`
`141`	`141`	`"location" : "https://github.com/pointfreeco/swift-snapshot-testing",`
`142`	`142`	`"state" : {`
`143`		`- "revision" : "6d932a79e7173b275b96c600c86c603cf84f153c",`
`144`		`- "version" : "1.17.4"`
	`143`	`+ "revision" : "7b0bbbae90c41f848f90ac7b4df6c4f50068256d",`
	`144`	`+ "version" : "1.17.5"`
`145`	`145`	`}`
`146`	`146`	`},`
`147`	`147`	`{`
`@@ -150,16 +150,16 @@`
`150`	`150`	`"location" : "https://github.com/swiftlang/swift-syntax",`
`151`	`151`	`"state" : {`
`152`	`152`	`"revision" : "515f79b522918f83483068d99c68daeb5116342d",`
`153`		`- "version" : "600.0.0-prerelease-2024-08-20"`
	`153`	`+ "version" : "600.0.0-prerelease-2024-09-04"`
`154`	`154`	`}`
`155`	`155`	`},`
`156`	`156`	`{`
`157`	`157`	`"identity" : "xctest-dynamic-overlay",`
`158`	`158`	`"kind" : "remoteSourceControl",`
`159`	`159`	`"location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",`
`160`	`160`	`"state" : {`
`161`		`- "revision" : "96beb108a57f24c8476ae1f309239270772b2940",`
`162`		`- "version" : "1.2.5"`
	`161`	`+ "revision" : "bc2a151366f2cd0e347274544933bc2acb00c9fe",`
	`162`	`+ "version" : "1.4.0"`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`	`],`