Update demos to use failing environments (#650)

Author: stephencelis

Examples/CaseStudies/SwiftUICaseStudies/00-Core.swift

@@ -202,7 +202,7 @@ let rootReducer = Reducer<RootState, RootAction, RootEnvironment>.combine(
         .init(
           date: env.date,
           environment: .init(fetchNumber: env.fetchNumber),
-          mainQueue: { env.mainQueue },
+          mainQueue: env.mainQueue,
           uuid: env.uuid
         )
       }

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

@@ -46,7 +46,7 @@ let multipleDependenciesReducer = Reducer<
   switch action {
   case .alertButtonTapped:
     return Effect(value: .alertDelayReceived)
-      .delay(for: 1, scheduler: environment.mainQueue())
+      .delay(for: 1, scheduler: environment.mainQueue)
       .eraseToEffect()
 
   case .alertDelayReceived:
@@ -159,7 +159,7 @@ struct MultipleDependenciesView_Previews: PreviewProvider {
 struct SystemEnvironment<Environment> {
   var date: () -> Date
   var environment: Environment
-  var mainQueue: () -> AnySchedulerOf<DispatchQueue>
+  var mainQueue: AnySchedulerOf<DispatchQueue>
   var uuid: () -> UUID
 
   subscript<Dependency>(
@@ -177,7 +177,7 @@ struct SystemEnvironment<Environment> {
     Self(
       date: Date.init,
       environment: environment,
-      mainQueue: { .main },
+      mainQueue: .main,
       uuid: UUID.init
     )
   }
@@ -196,17 +196,25 @@ struct SystemEnvironment<Environment> {
 }
 
 #if DEBUG
+  import XCTestDynamicOverlay
+
   extension SystemEnvironment {
-    static func mock(
-      date: @escaping () -> Date = { fatalError("date dependency is unimplemented.") },
+    static func failing(
+      date: @escaping () -> Date = {
+        XCTFail("date dependency is unimplemented.")
+        return Date()
+      },
       environment: Environment,
-      mainQueue: @escaping () -> AnySchedulerOf<DispatchQueue> = { fatalError() },
-      uuid: @escaping () -> UUID = { fatalError("UUID dependency is unimplemented.") }
+      mainQueue: AnySchedulerOf<DispatchQueue> = .failing,
+      uuid: @escaping () -> UUID = {
+        XCTFail("UUID dependency is unimplemented.")
+        return UUID()
+      }
     ) -> Self {
       Self(
         date: date,
         environment: environment,
-        mainQueue: { mainQueue().eraseToAnyScheduler() },
+        mainQueue: mainQueue,
         uuid: uuid
       )
     }

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

@@ -9,17 +9,18 @@ class WebSocketTests: XCTestCase {
     let socketSubject = PassthroughSubject<WebSocketClient.Action, Never>()
     let receiveSubject = PassthroughSubject<WebSocketClient.Message, NSError>()
 
+    var webSocket = WebSocketClient.failing
+    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
+    webSocket.receive = { _ in receiveSubject.eraseToEffect() }
+    webSocket.send = { _, _ in Effect(value: nil) }
+    webSocket.sendPing = { _ in .none }
+
     let store = TestStore(
       initialState: .init(),
       reducer: webSocketReducer,
       environment: WebSocketEnvironment(
         mainQueue: .immediate,
-        webSocket: .mock(
-          open: { _, _, _ in socketSubject.eraseToEffect() },
-          receive: { _ in receiveSubject.eraseToEffect() },
-          send: { _, _ in Effect(value: nil) },
-          sendPing: { _ in .none }
-        )
+        webSocket: webSocket
       )
     )
 
@@ -57,17 +58,18 @@ class WebSocketTests: XCTestCase {
     let socketSubject = PassthroughSubject<WebSocketClient.Action, Never>()
     let receiveSubject = PassthroughSubject<WebSocketClient.Message, NSError>()
 
+    var webSocket = WebSocketClient.failing
+    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
+    webSocket.receive = { _ in receiveSubject.eraseToEffect() }
+    webSocket.send = { _, _ in Effect(value: NSError(domain: "", code: 1)) }
+    webSocket.sendPing = { _ in .none }
+
     let store = TestStore(
       initialState: .init(),
       reducer: webSocketReducer,
       environment: WebSocketEnvironment(
         mainQueue: .immediate,
-        webSocket: .mock(
-          open: { _, _, _ in socketSubject.eraseToEffect() },
-          receive: { _ in receiveSubject.eraseToEffect() },
-          send: { _, _ in Effect(value: NSError(domain: "", code: 1)) },
-          sendPing: { _ in .none }
-        )
+        webSocket: webSocket
       )
     )
 
@@ -101,17 +103,18 @@ class WebSocketTests: XCTestCase {
     let socketSubject = PassthroughSubject<WebSocketClient.Action, Never>()
     let pingSubject = PassthroughSubject<NSError?, Never>()
 
+    var webSocket = WebSocketClient.failing
+    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
+    webSocket.receive = { _ in .none }
+    webSocket.sendPing = { _ in pingSubject.eraseToEffect() }
+
     let scheduler = DispatchQueue.test
     let store = TestStore(
       initialState: .init(),
       reducer: webSocketReducer,
       environment: WebSocketEnvironment(
         mainQueue: scheduler.eraseToAnyScheduler(),
-        webSocket: .mock(
-          open: { _, _, _ in socketSubject.eraseToEffect() },
-          receive: { _ in .none },
-          sendPing: { _ in pingSubject.eraseToEffect() }
-        )
+        webSocket: webSocket
       )
     )
 
@@ -138,17 +141,18 @@ class WebSocketTests: XCTestCase {
   func testWebSocketConnectError() {
     let socketSubject = PassthroughSubject<WebSocketClient.Action, Never>()
 
+    var webSocket = WebSocketClient.failing
+    webSocket.cancel = { _, _, _ in .fireAndForget { socketSubject.send(completion: .finished) } }
+    webSocket.open = { _, _, _ in socketSubject.eraseToEffect() }
+    webSocket.receive = { _ in .none }
+    webSocket.sendPing = { _ in .none }
+
     let store = TestStore(
       initialState: .init(),
       reducer: webSocketReducer,
       environment: WebSocketEnvironment(
         mainQueue: .immediate,
-        webSocket: .mock(
-          cancel: { _, _, _ in .fireAndForget { socketSubject.send(completion: .finished) } },
-          open: { _, _, _ in socketSubject.eraseToEffect() },
-          receive: { _ in .none },
-          sendPing: { _ in .none }
-        )
+        webSocket: webSocket
       )
     )
 
@@ -164,25 +168,11 @@ class WebSocketTests: XCTestCase {
 }
 
 extension WebSocketClient {
-  static func mock(
-    cancel: @escaping (AnyHashable, URLSessionWebSocketTask.CloseCode, Data?) -> Effect<
-      Never, Never
-    > = { _, _, _ in fatalError() },
-    open: @escaping (AnyHashable, URL, [String]) -> Effect<Action, Never> = { _, _, _ in
-      fatalError()
-    },
-    receive: @escaping (AnyHashable) -> Effect<Message, NSError> = { _ in fatalError() },
-    send: @escaping (AnyHashable, URLSessionWebSocketTask.Message) -> Effect<NSError?, Never> = {
-      _, _ in fatalError()
-    },
-    sendPing: @escaping (AnyHashable) -> Effect<NSError?, Never> = { _ in fatalError() }
-  ) -> Self {
-    Self(
-      cancel: cancel,
-      open: open,
-      receive: receive,
-      send: send,
-      sendPing: sendPing
-    )
-  }
+  static let failing = Self(
+    cancel: { _, _, _ in .failing("WebSocketClient.cancel") },
+    open: { _, _, _ in .failing("WebSocketClient.open") },
+    receive: { _ in .failing("WebSocketClient.receive") },
+    send: { _, _ in .failing("WebSocketClient.send") },
+    sendPing: { _ in .failing("WebSocketClient.sendPing") }
+  )
 }

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

@@ -18,6 +18,9 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   let scheduler = DispatchQueue.test
 
   func testDownloadFlow() {
+    var downloadClient = DownloadClient.failing
+    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+
     let store = TestStore(
       initialState: DownloadComponentState(
         id: 1,
@@ -26,9 +29,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
       ),
       reducer: reducer,
       environment: DownloadComponentEnvironment(
-        downloadClient: .mock(
-          download: { _, _ in self.downloadSubject.eraseToEffect() }
-        ),
+        downloadClient: downloadClient,
         mainQueue: self.scheduler.eraseToAnyScheduler()
       )
     )
@@ -52,6 +53,9 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testDownloadThrottling() {
+    var downloadClient = DownloadClient.failing
+    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+
     let store = TestStore(
       initialState: DownloadComponentState(
         id: 1,
@@ -60,9 +64,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
       ),
       reducer: reducer,
       environment: DownloadComponentEnvironment(
-        downloadClient: .mock(
-          download: { _, _ in self.downloadSubject.eraseToEffect() }
-        ),
+        downloadClient: downloadClient,
         mainQueue: self.scheduler.eraseToAnyScheduler()
       )
     )
@@ -91,6 +93,12 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testCancelDownloadFlow() {
+    var downloadClient = DownloadClient.failing
+    downloadClient.cancel = { _ in
+      .fireAndForget { self.downloadSubject.send(completion: .finished) }
+    }
+    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+
     let store = TestStore(
       initialState: DownloadComponentState(
         id: 1,
@@ -99,10 +107,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
       ),
       reducer: reducer,
       environment: DownloadComponentEnvironment(
-        downloadClient: .mock(
-          cancel: { _ in .fireAndForget { self.downloadSubject.send(completion: .finished) } },
-          download: { _, _ in self.downloadSubject.eraseToEffect() }
-        ),
+        downloadClient: downloadClient,
         mainQueue: self.scheduler.eraseToAnyScheduler()
       )
     )
@@ -128,6 +133,12 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testDownloadFinishesWhileTryingToCancel() {
+    var downloadClient = DownloadClient.failing
+    downloadClient.cancel = { _ in
+      .fireAndForget { self.downloadSubject.send(completion: .finished) }
+    }
+    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+
     let store = TestStore(
       initialState: DownloadComponentState(
         id: 1,
@@ -136,10 +147,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
       ),
       reducer: reducer,
       environment: DownloadComponentEnvironment(
-        downloadClient: .mock(
-          cancel: { _ in .fireAndForget { self.downloadSubject.send(completion: .finished) } },
-          download: { _, _ in self.downloadSubject.eraseToEffect() }
-        ),
+        downloadClient: downloadClient,
         mainQueue: self.scheduler.eraseToAnyScheduler()
       )
     )
@@ -166,6 +174,12 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testDeleteDownloadFlow() {
+    var downloadClient = DownloadClient.failing
+    downloadClient.cancel = { _ in
+      .fireAndForget { self.downloadSubject.send(completion: .finished) }
+    }
+    downloadClient.download = { _, _ in self.downloadSubject.eraseToEffect() }
+
     let store = TestStore(
       initialState: DownloadComponentState(
         id: 1,
@@ -174,10 +188,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
       ),
       reducer: reducer,
       environment: DownloadComponentEnvironment(
-        downloadClient: .mock(
-          cancel: { _ in .fireAndForget { self.downloadSubject.send(completion: .finished) } },
-          download: { _, _ in self.downloadSubject.eraseToEffect() }
-        ),
+        downloadClient: downloadClient,
         mainQueue: self.scheduler.eraseToAnyScheduler()
       )
     )
@@ -198,13 +209,8 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
 }
 
 extension DownloadClient {
-  static func mock(
-    cancel: @escaping (AnyHashable) -> Effect<Never, Never> = { _ in fatalError() },
-    download: @escaping (AnyHashable, URL) -> Effect<Action, Error> = { _, _ in fatalError() }
-  ) -> Self {
-    Self(
-      cancel: cancel,
-      download: download
-    )
-  }
+  static let failing = Self(
+    cancel: { _ in .failing("DownloadClient.cancel") },
+    download: { _, _ in .failing("DownloadClient.download") }
+  )
 }

Examples/Search/Search/WeatherClient.swift

@@ -65,17 +65,10 @@ extension WeatherClient {
 // MARK: - Mock API implementations
 
 extension WeatherClient {
-  static func mock(
-    searchLocation: @escaping (String) -> Effect<[Location], Failure> = { _ in
-      fatalError("Unmocked")
-    },
-    weather: @escaping (Int) -> Effect<LocationWeather, Failure> = { _ in fatalError("Unmocked") }
-  ) -> Self {
-    Self(
-      searchLocation: searchLocation,
-      weather: weather
-    )
-  }
+  static let failing = Self(
+    searchLocation: { _ in .failing("WeatherClient.searchLocation") },
+    weather: { _ in .failing("WeatherClient.weather") }
+  )
 }
 
 // MARK: - Private helpers