Skip to content

Commit a0beb19

Browse files
mbrandonwmbrandonw
authored
Do not propagate dependencies to effect actions. (#1954)
* wip * wip * wip * wip * wip * wip * wip
1 parent f081ed4 commit a0beb19

File tree

3 files changed

+200
-58
lines changed

3 files changed

+200
-58
lines changed

‎ComposableArchitecture.xcworkspace/xcshareddata/swiftpm/Package.resolved

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Sources/ComposableArchitecture/Store.swift

Lines changed: 63 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public final class Store<State, Action> {
131131
private let reducer: (inout State, Action) -> EffectTask<Action>
132132
fileprivate var scope: AnyStoreScope?
133133
#endif
134-
var state: CurrentValueSubject<State, Never>
134+
@_spi(Internals) public var state: CurrentValueSubject<State, Never>
135135
#if DEBUG
136136
private let mainThreadChecksEnabled: Bool
137137
#endif
@@ -385,28 +385,31 @@ public final class Store<State, Action> {
385385
var didComplete = false
386386
let boxedTask = Box<Task<Void, Never>?>(wrappedValue: nil)
387387
let uuid = UUID()
388-
let effectCancellable =
388+
let effectCancellable = withEscapedDependencies { continuation in
389389
publisher
390-
.handleEvents(
391-
receiveCancel: { [weak self] in
392-
self?.threadCheck(status: .effectCompletion(action))
393-
self?.effectCancellables[uuid] = nil
394-
}
395-
)
396-
.sink(
397-
receiveCompletion: { [weak self] _ in
398-
self?.threadCheck(status: .effectCompletion(action))
399-
boxedTask.wrappedValue?.cancel()
400-
didComplete = true
401-
self?.effectCancellables[uuid] = nil
402-
},
403-
receiveValue: { [weak self] effectAction in
404-
guard let self = self else { return }
405-
if let task = self.send(effectAction, originatingFrom: action) {
406-
tasks.wrappedValue.append(task)
390+
.handleEvents(
391+
receiveCancel: { [weak self] in
392+
self?.threadCheck(status: .effectCompletion(action))
393+
self?.effectCancellables[uuid] = nil
407394
}
408-
}
409-
)
395+
)
396+
.sink(
397+
receiveCompletion: { [weak self] _ in
398+
self?.threadCheck(status: .effectCompletion(action))
399+
boxedTask.wrappedValue?.cancel()
400+
didComplete = true
401+
self?.effectCancellables[uuid] = nil
402+
},
403+
receiveValue: { [weak self] effectAction in
404+
guard let self = self else { return }
405+
if let task = continuation.yield({
406+
self.send(effectAction, originatingFrom: action)
407+
}) {
408+
tasks.wrappedValue.append(task)
409+
}
410+
}
411+
)
412+
}
410413

411414
if !didComplete {
412415
let task = Task<Void, Never> { @MainActor in
@@ -418,43 +421,47 @@ public final class Store<State, Action> {
418421
self.effectCancellables[uuid] = effectCancellable
419422
}
420423
case let .run(priority, operation):
421-
tasks.wrappedValue.append(
422-
Task(priority: priority) { @MainActor in
423-
#if DEBUG
424-
var isCompleted = false
425-
defer { isCompleted = true }
426-
#endif
427-
await operation(
428-
EffectTask<Action>.Send {
429-
#if DEBUG
430-
if isCompleted {
431-
runtimeWarn(
432-
"""
433-
An action was sent from a completed effect:
434-
435-
Action:
436-
\(debugCaseOutput($0))
437-
438-
Effect returned from:
439-
\(debugCaseOutput(action))
440-
441-
Avoid sending actions using the 'send' argument from 'EffectTask.run' after \
442-
the effect has completed. This can happen if you escape the 'send' argument in \
443-
an unstructured context.
444-
445-
To fix this, make sure that your 'run' closure does not return until you're \
446-
done calling 'send'.
447-
"""
448-
)
424+
withEscapedDependencies { continuation in
425+
tasks.wrappedValue.append(
426+
Task(priority: priority) { @MainActor in
427+
#if DEBUG
428+
var isCompleted = false
429+
defer { isCompleted = true }
430+
#endif
431+
await operation(
432+
EffectTask<Action>.Send { effectAction in
433+
#if DEBUG
434+
if isCompleted {
435+
runtimeWarn(
436+
"""
437+
An action was sent from a completed effect:
438+
439+
Action:
440+
\(debugCaseOutput(effectAction))
441+
442+
Effect returned from:
443+
\(debugCaseOutput(action))
444+
445+
Avoid sending actions using the 'send' argument from 'EffectTask.run' after \
446+
the effect has completed. This can happen if you escape the 'send' argument in \
447+
an unstructured context.
448+
449+
To fix this, make sure that your 'run' closure does not return until you're \
450+
done calling 'send'.
451+
"""
452+
)
453+
}
454+
#endif
455+
if let task = continuation.yield({
456+
self.send(effectAction, originatingFrom: action)
457+
}) {
458+
tasks.wrappedValue.append(task)
449459
}
450-
#endif
451-
if let task = self.send($0, originatingFrom: action) {
452-
tasks.wrappedValue.append(task)
453460
}
454-
}
455-
)
456-
}
457-
)
461+
)
462+
}
463+
)
464+
}
458465
}
459466
}
460467

‎Tests/ComposableArchitectureTests/StoreTests.swift

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -559,4 +559,139 @@ final class StoreTests: XCTestCase {
559559

560560
XCTAssertEqual(viewStore.state, UUID(uuidString: "deadbeef-dead-beef-dead-beefdeadbeef")!)
561561
}
562+
563+
func testStoreVsTestStore() async {
564+
struct Feature: ReducerProtocol {
565+
struct State: Equatable {
566+
var count = 0
567+
}
568+
enum Action: Equatable {
569+
case tap
570+
case response1(Int)
571+
case response2(Int)
572+
case response3(Int)
573+
}
574+
@Dependency(\.count) var count
575+
func reduce(into state: inout State, action: Action) -> EffectTask<Action> {
576+
switch action {
577+
case .tap:
578+
return withDependencies {
579+
$0.count.value += 1
580+
} operation: {
581+
.task { .response1(self.count.value) }
582+
}
583+
case let .response1(count):
584+
state.count = count
585+
return withDependencies {
586+
$0.count.value += 1
587+
} operation: {
588+
.task { .response2(self.count.value) }
589+
}
590+
case let .response2(count):
591+
state.count = count
592+
return withDependencies {
593+
$0.count.value += 1
594+
} operation: {
595+
.task { .response3(self.count.value) }
596+
}
597+
case let .response3(count):
598+
state.count = count
599+
return .none
600+
}
601+
}
602+
}
603+
604+
let testStore = TestStore(
605+
initialState: Feature.State(),
606+
reducer: Feature()
607+
)
608+
await testStore.send(.tap)
609+
await testStore.receive(.response1(1)) {
610+
$0.count = 1
611+
}
612+
await testStore.receive(.response2(1))
613+
await testStore.receive(.response3(1))
614+
615+
let store = Store(
616+
initialState: Feature.State(),
617+
reducer: Feature()
618+
)
619+
await store.send(.tap)?.value
620+
XCTAssertEqual(store.state.value.count, testStore.state.count)
621+
}
622+
623+
func testStoreVsTestStore_Publisher() async {
624+
struct Feature: ReducerProtocol {
625+
struct State: Equatable {
626+
var count = 0
627+
}
628+
enum Action: Equatable {
629+
case tap
630+
case response1(Int)
631+
case response2(Int)
632+
case response3(Int)
633+
}
634+
@Dependency(\.count) var count
635+
func reduce(into state: inout State, action: Action) -> EffectTask<Action> {
636+
switch action {
637+
case .tap:
638+
return withDependencies {
639+
$0.count.value += 1
640+
} operation: {
641+
EffectTask.task { .response1(self.count.value) }
642+
}
643+
.eraseToEffect()
644+
case let .response1(count):
645+
state.count = count
646+
return withDependencies {
647+
$0.count.value += 1
648+
} operation: {
649+
EffectTask.task { .response2(self.count.value) }
650+
}
651+
.eraseToEffect()
652+
case let .response2(count):
653+
state.count = count
654+
return withDependencies {
655+
$0.count.value += 1
656+
} operation: {
657+
EffectTask.task { .response3(self.count.value) }
658+
}
659+
.eraseToEffect()
660+
case let .response3(count):
661+
state.count = count
662+
return .none
663+
}
664+
}
665+
}
666+
667+
let testStore = TestStore(
668+
initialState: Feature.State(),
669+
reducer: Feature()
670+
)
671+
await testStore.send(.tap)
672+
await testStore.receive(.response1(1)) {
673+
$0.count = 1
674+
}
675+
await testStore.receive(.response2(1))
676+
await testStore.receive(.response3(1))
677+
678+
let store = Store(
679+
initialState: Feature.State(),
680+
reducer: Feature()
681+
)
682+
await store.send(.tap)?.value
683+
XCTAssertEqual(store.state.value.count, testStore.state.count)
684+
}
685+
}
686+
687+
private struct Count: TestDependencyKey {
688+
var value: Int
689+
static let liveValue = Count(value: 0)
690+
static let testValue = Count(value: 0)
691+
}
692+
extension DependencyValues {
693+
fileprivate var count: Count {
694+
get { self[Count.self] }
695+
set { self[Count.self] = newValue }
696+
}
562697
}

0 commit comments

Comments
 (0)