Added ReactiveSwift FailingScheduler.

Author: mluisbrown

Examples/CaseStudies/SwiftUICaseStudies/03-Effects-SystemEnvironment.swift

@@ -176,7 +176,7 @@ struct SystemEnvironment<Environment> {
     Self(
       date: Date.init,
       environment: environment,
-      mainQueue: .main,
+      mainQueue: QueueScheduler.main,
       uuid: UUID.init
     )
   }
@@ -204,7 +204,7 @@ struct SystemEnvironment<Environment> {
         return Date()
       },
       environment: Environment,
-      mainQueue: AnySchedulerOf<DispatchQueue> = .failing,
+      mainQueue: DateScheduler = FailingScheduler(),
       uuid: @escaping () -> UUID = {
         XCTFail("UUID dependency is unimplemented.")
         return UUID()

Examples/CaseStudies/SwiftUICaseStudiesTests/02-Effects-WebSocketTests.swift

@@ -10,8 +10,8 @@ class WebSocketTests: XCTestCase {
     let receiveSubject = Signal<WebSocketClient.Message, NSError>.pipe()
 
     var webSocket = WebSocketClient.failing
-    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
-    webSocket.receive = { _ in receiveSubject.eraseToEffect() }
+    webSocket.open = { _, _, _ in socketSubject.output.producer }
+    webSocket.receive = { _ in receiveSubject.output.producer }
     webSocket.send = { _, _ in Effect(value: nil) }
     webSocket.sendPing = { _ in .none }
 
@@ -59,8 +59,8 @@ class WebSocketTests: XCTestCase {
     let receiveSubject = Signal<WebSocketClient.Message, NSError>.pipe()
 
     var webSocket = WebSocketClient.failing
-    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
-    webSocket.receive = { _ in receiveSubject.eraseToEffect() }
+    webSocket.open = { _, _, _ in socketSubject.output.producer }
+    webSocket.receive = { _ in receiveSubject.output.producer }
     webSocket.send = { _, _ in Effect(value: NSError(domain: "", code: 1)) }
     webSocket.sendPing = { _ in .none }
 
@@ -104,11 +104,11 @@ class WebSocketTests: XCTestCase {
     let pingSubject = Signal<NSError?, Never>.pipe()
 
     var webSocket = WebSocketClient.failing
-    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
+    webSocket.open = { _, _, _ in socketSubject.output.producer }
     webSocket.receive = { _ in .none }
-    webSocket.sendPing = { _ in pingSubject.eraseToEffect() }
+    webSocket.sendPing = { _ in pingSubject.output.producer }
 
-    let scheduler = DispatchQueue.test
+    let scheduler = TestScheduler()
     let store = TestStore(
       initialState: .init(),
       reducer: webSocketReducer,
@@ -142,8 +142,8 @@ class WebSocketTests: XCTestCase {
     let socketSubject = Signal<WebSocketClient.Action, Never>.pipe()
 
     var webSocket = WebSocketClient.failing
-    webSocket.cancel = { _, _, _ in .fireAndForget { socketSubject.send(completion: .finished) } }
-    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
+    webSocket.cancel = { _, _, _ in .fireAndForget { socketSubject.input.sendCompleted() } }
+    webSocket.open = { _, _, _ in socketSubject.output.producer }
     webSocket.receive = { _ in .none }
     webSocket.sendPing = { _ in .none }
 

Examples/CaseStudies/SwiftUICaseStudiesTests/04-HigherOrderReducers-ReusableOfflineDownloadsTests.swift

@@ -19,7 +19,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
 
   func testDownloadFlow() {
     var downloadClient = DownloadClient.failing
-    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+    downloadClient.download = { _, _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
       initialState: DownloadComponentState(
@@ -55,7 +55,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
 
   func testDownloadThrottling() {
     var downloadClient = DownloadClient.failing
-    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+    downloadClient.download = { _, _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
       initialState: DownloadComponentState(
@@ -96,9 +96,9 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   func testCancelDownloadFlow() {
     var downloadClient = DownloadClient.failing
     downloadClient.cancel = { _ in
-      .fireAndForget { self.downloadSubject.send(completion: .finished) }
+      .fireAndForget { self.downloadSubject.input.sendCompleted() }
     }
-    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+    downloadClient.download = { _, _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
       initialState: DownloadComponentState(
@@ -136,9 +136,9 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   func testDownloadFinishesWhileTryingToCancel() {
     var downloadClient = DownloadClient.failing
     downloadClient.cancel = { _ in
-      .fireAndForget { self.downloadSubject.send(completion: .finished) }
+      .fireAndForget { self.downloadSubject.input.sendCompleted() }
     }
-    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+    downloadClient.download = { _, _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
       initialState: DownloadComponentState(
@@ -178,9 +178,9 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   func testDeleteDownloadFlow() {
     var downloadClient = DownloadClient.failing
     downloadClient.cancel = { _ in
-      .fireAndForget { self.downloadSubject.send(completion: .finished) }
+      .fireAndForget { self.downloadSubject.input.sendCompleted() }
     }
-    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+    downloadClient.download = { _, _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
       initialState: DownloadComponentState(

Examples/Search/SearchTests/SearchTests.swift

@@ -142,7 +142,7 @@ class SearchTests: XCTestCase {
       reducer: searchReducer,
       environment: SearchEnvironment(
         weatherClient: weatherClient,
-        mainQueue: self.scheduler.eraseToAnyScheduler()
+        mainQueue: self.scheduler
       )
     )
 

Examples/SpeechRecognition/SpeechRecognitionTests/SpeechRecognitionTests.swift

@@ -62,9 +62,9 @@ class SpeechRecognitionTests: XCTestCase {
   func testAllowAndRecord() {
     var speechClient = SpeechClient.failing
     speechClient.finishTask = { _ in
-      .fireAndForget { self.recognitionTaskSubject.send(completion: .finished) }
+      .fireAndForget { self.recognitionTaskSubject.input.sendCompleted() }
     }
-    speechClient.recognitionTask = { _, _ in self.recognitionTaskSubject.eraseToEffect() }
+    speechClient.recognitionTask = { _, _ in self.recognitionTaskSubject.output.producer }
     speechClient.requestAuthorization = { Effect(value: .authorized) }
 
     let store = TestStore(
@@ -111,7 +111,7 @@ class SpeechRecognitionTests: XCTestCase {
 
   func testAudioSessionFailure() {
     var speechClient = SpeechClient.failing
-    speechClient.recognitionTask = { _, _ in self.recognitionTaskSubject.eraseToEffect() }
+    speechClient.recognitionTask = { _, _ in self.recognitionTaskSubject.output.producer }
     speechClient.requestAuthorization = { Effect(value: .authorized) }
 
     let store = TestStore(
@@ -141,7 +141,7 @@ class SpeechRecognitionTests: XCTestCase {
 
   func testAudioEngineFailure() {
     var speechClient = SpeechClient.failing
-    speechClient.recognitionTask = { _, _ in self.recognitionTaskSubject.eraseToEffect() }
+    speechClient.recognitionTask = { _, _ in self.recognitionTaskSubject.output.producer }
     speechClient.requestAuthorization = { Effect(value: .authorized) }
 
     let store = TestStore(

Examples/TicTacToe/Tests/LoginCoreTests.swift

@@ -65,7 +65,7 @@ class LoginCoreTests: XCTestCase {
     authenticationClient.twoFactor = { _ in
       Effect(value: .init(token: "deadbeefdeadbeef", twoFactorRequired: false))
     }
-    let scheduler = DispatchQueue.test
+    let scheduler = TestScheduler()
 
     let store = TestStore(
       initialState: LoginState(),

Examples/VoiceMemos/VoiceMemosTests/VoiceMemosTests.swift

@@ -1,3 +1,4 @@
+import Foundation
 import ComposableArchitecture
 import ReactiveSwift
 import XCTest
@@ -6,9 +7,6 @@ import XCTest
 
 class VoiceMemosTests: XCTestCase {
   func testRecordMemoHappyPath() {
-    // NB: Combine's concatenation behavior is different in 13.3
-    guard #available(iOS 13.4, *) else { return }
-
     let audioRecorderSubject = Signal<
       AudioRecorderClient.Action, AudioRecorderClient.Failure
     >.pipe()
@@ -18,7 +16,7 @@ class VoiceMemosTests: XCTestCase {
     environment.audioRecorder.currentTime = { _ in Effect(value: 2.5) }
     environment.audioRecorder.requestRecordPermission = { Effect(value: true) }
     environment.audioRecorder.startRecording = { _, _ in
-      audioRecorderSubject.eraseToEffect()
+      audioRecorderSubject.output.producer
     }
     environment.audioRecorder.stopRecording = { _ in
             .fireAndForget {
@@ -27,7 +25,7 @@ class VoiceMemosTests: XCTestCase {
             }
           }
     environment.date = { Date(timeIntervalSinceReferenceDate: 0) }
-    environment.mainQueue = scheduler.eraseToAnyScheduler()
+    environment.mainQueue = scheduler
     environment.temporaryDirectory = { URL(fileURLWithPath: "/tmp") }
     environment.uuid = { UUID(uuidString: "DEADBEEF-DEAD-BEEF-DEAD-BEEFDEADBEEF")! }
 
@@ -81,7 +79,7 @@ class VoiceMemosTests: XCTestCase {
 
     var environment = VoiceMemosEnvironment.failing
     environment.audioRecorder.requestRecordPermission = { Effect(value: false) }
-    environment.mainQueue = .immediate
+    environment.mainQueue = ImmediateScheduler()
     environment.openSettings = .fireAndForget { didOpenSettings = true }
 
     let store = TestStore(
@@ -111,10 +109,10 @@ class VoiceMemosTests: XCTestCase {
     environment.audioRecorder.currentTime = { _ in Effect(value: 2.5) }
     environment.audioRecorder.requestRecordPermission = { Effect(value: true) }
     environment.audioRecorder.startRecording = { _, _ in
-      audioRecorderSubject.eraseToEffect()
+      audioRecorderSubject.output.producer
     }
     environment.date = { Date(timeIntervalSinceReferenceDate: 0) }
-    environment.mainQueue = .immediate
+    environment.mainQueue = ImmediateScheduler()
     environment.temporaryDirectory = { .init(fileURLWithPath: "/tmp") }
     environment.uuid = { UUID(uuidString: "DEADBEEF-DEAD-BEEF-DEAD-BEEFDEADBEEF")! }
 
@@ -144,14 +142,13 @@ class VoiceMemosTests: XCTestCase {
   }
 
   func testPlayMemoHappyPath() {
-    let scheduler = DispatchQueue.test
+    let scheduler = TestScheduler()
     var environment = VoiceMemosEnvironment.failing
     environment.audioPlayer.play = { _, _ in
       Effect(value: .didFinishPlaying(successfully: true))
-        .delay(for: 1, scheduler: scheduler)
-        .eraseToEffect()
+        .delay(1, on: scheduler)
     }
-    environment.mainQueue = scheduler.eraseToAnyScheduler()
+    environment.mainQueue = scheduler
 
     let url = URL(string: "https://www.pointfree.co/functions")!
     let store = TestStore(
@@ -195,7 +192,7 @@ class VoiceMemosTests: XCTestCase {
   func testPlayMemoFailure() {
     var environment = VoiceMemosEnvironment.failing
     environment.audioPlayer.play = { _, _ in Effect(error: .decodeErrorDidOccur) }
-    environment.mainQueue = .immediate
+    environment.mainQueue = ImmediateScheduler()
 
     let url = URL(string: "https://www.pointfree.co/functions")!
     let store = TestStore(
@@ -285,7 +282,7 @@ class VoiceMemosTests: XCTestCase {
     var environment = VoiceMemosEnvironment.failing
     environment.audioPlayer.play = { _, _ in .none }
     environment.audioPlayer.stop = { _ in .none }
-    environment.mainQueue = .immediate
+    environment.mainQueue = ImmediateScheduler()
 
     let store = TestStore(
       initialState: VoiceMemosState(
@@ -320,7 +317,7 @@ extension VoiceMemosEnvironment {
       XCTFail("VoiceMemosEnvironment.date is unimplemented")
       return Date()
     },
-    mainQueue: .failing,
+    mainQueue: FailingScheduler(),
     openSettings: .failing("VoiceMemosEnvironment.openSettings"),
     temporaryDirectory: {
       XCTFail("VoiceMemosEnvironment.temporaryDirectory is unimplemented")

Sources/ComposableArchitecture/SchedulerExtensions/SchedulerExtensions.swift

@@ -0,0 +1,44 @@
+import Foundation
+import ReactiveSwift
+import XCTestDynamicOverlay
+
+public final class FailingScheduler: DateScheduler {
+  public init() {}
+
+  public var currentDate: Date {
+    XCTFail(
+      """
+      A failing scheduler was asked the current time.
+      """
+    )
+    return Date()
+  }
+
+  public func schedule(after date: Date, action: @escaping () -> Void) -> Disposable? {
+    XCTFail(
+       """
+       A failing scheduler scheduled an action to run later.
+       """
+     )
+    return nil
+  }
+
+  public func schedule(after date: Date, interval: DispatchTimeInterval, leeway: DispatchTimeInterval, action: @escaping () -> Void) -> Disposable? {
+    XCTFail(
+       """
+       A failing scheduler scheduled an action to run later.
+       """
+     )
+    return nil
+  }
+
+  public func schedule(_ action: @escaping () -> Void) -> Disposable? {
+    XCTFail(
+       """
+       A failing scheduler scheduled an action to run immediately.
+       """
+     )
+
+    return nil
+  }
+}