swift-tca-extras/Sources/ComposableSubscriber/Effect+fail.swift

import ComposableArchitecture
import OSLog

extension Effect {
  
  /// An effect that throws a runtime warning and optionally logs an error message.
  ///
  /// This effect uses `XCTFail`  to throw a runtime warning and will also log the message
  /// if a logger is supplied.
  ///
  /// ## Example
  ///
  ///```swift
  /// @Reducer
  /// struct MyFeature {
  ///  ...
  ///  enum Action {
  ///    case receive(TaskResult<Int>)
  ///    ...
  ///  }
  ///
  ///  @Dependency(\.logger) var logger
  ///
  ///  var body: some ReducerOf<Self> {
  ///    Reduce { state, action in
  ///      switch action {
  ///        case .receive(.failure(_)):
  ///          return .fail("Failed retreiving number fact.", log: { logger.debug("\($0)") })
  ///        ...
  ///
  ///      }
  ///    }
  ///  }
  /// }
  ///```
  ///
  /// - Parameters:
  ///   - message: The message for the failure reason.
  ///   - logger: An optional logger to use to log the message.
  public static func fail(
    _ message: String,
    log: (@Sendable (String) -> Void)? = nil
  ) -> Self {
    XCTFail("\(message)")
    log?(message)
    return .none
  }
  
  /// An effect that throws a runtime warning and optionally logs an error message.
  ///
  /// This effect uses `XCTFail`  to throw a runtime warning and will also log the message
  /// if a logger is supplied.
  ///
  /// ## Example
  ///
  ///```swift
  /// @Reducer
  /// struct MyFeature {
  ///  ...
  ///  enum Action {
  ///    case receive(TaskResult<Int>)
  ///    ...
  ///  }
  ///
  ///  @Dependency(\.logger) var logger
  ///
  ///  var body: some ReducerOf<Self> {
  ///    Reduce { state, action in
  ///      switch action {
  ///        case .receive(.failure(_)):
  ///          return .fail("Failed retreiving number fact.", logger: logger)
  ///        ...
  ///
  ///      }
  ///    }
  ///  }
  /// }
  ///```
  ///
  /// - Parameters:
  ///   - message: The message for the failure reason.
  ///   - logger: An optional logger to use to log the message.
  @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
  public static func fail(
    _ message: String,
    logger: Logger? = nil
  ) -> Self {
    .fail(message, log: { logger?.error("\($0)") })
  }



  /// An effect that throws a runtime warning and optionally logs an error message.
  ///
  ///
  /// This effect uses `XCTFail`  to throw a runtime warning and will also log the message
  /// if a logger is supplied.
  ///
  /// ## Example
  ///
  ///```swift
  /// @Reducer
  /// struct MyFeature {
  ///  ...
  ///  enum Action {
  ///    case receive(TaskResult<Int>)
  ///    ...
  ///  }
  ///
  ///  @Dependency(\.logger) var logger
  ///
  ///  var body: some ReducerOf<Self> {
  ///    Reduce { state, action in
  ///      switch action {
  ///        case let .receive(.failure(error)):
  ///          return .fail(error: error, logger: logger)
  ///        ...
  ///
  ///      }
  ///    }
  ///  }
  /// }
  ///```
  ///
  /// - Parameters:
  ///   - prefix: The prefix for the error message for the failure.
  ///   - error: The error for the failure..
  ///   - logger: A logger to use to log the message.
  @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
  public static func fail(
    prefix: String = "Failed error:",
    error: any Error,
    logger: Logger
  ) -> Self {
    .fail(prefix: prefix, error: error, log: { logger.error("\($0)") })
  }
  
  /// An effect that throws a runtime warning and optionally logs an error message.
  ///
  ///
  /// This effect uses `XCTFail`  to throw a runtime warning and will also log the message
  /// if a logger is supplied.
  ///
  /// ## Example
  ///
  ///```swift
  /// @Reducer
  /// struct MyFeature {
  ///  ...
  ///  enum Action {
  ///    case receive(TaskResult<Int>)
  ///    ...
  ///  }
  ///
  ///  @Dependency(\.logger) var logger
  ///
  ///  var body: some ReducerOf<Self> {
  ///    Reduce { state, action in
  ///      switch action {
  ///        case .receive(.failure(_)):
  ///          return .fail("Failed retreiving number fact.", log: { logger.debug("\($0)") })
  ///        ...
  ///
  ///      }
  ///    }
  ///  }
  /// }
  ///```
  ///
  /// - Parameters:
  ///   - prefix: The prefix for the error message for the failure.
  ///   - error: The error for the failure..
  ///   - log: A log handler to use to log the message.
  public static func fail(
    prefix: String = "Failed error:",
    error: any Error,
    log: (@Sendable (String) -> Void)? = nil
  ) -> Self {
    return .fail("\(prefix) \(error.localizedDescription)", log: log)
  }

}