swift-composable-architecture-mirror/Tests/ComposableArchitectureTests/ViewStoreTests.swift

@preconcurrency import Combine
import ComposableArchitecture
import XCTest

final class ViewStoreTests: BaseTCATestCase {
  var cancellables: Set<AnyCancellable> = []

  override func setUpWithError() throws {
    try super.setUpWithError()
    equalityChecks.setValue(0)
    subEqualityChecks.setValue(0)
  }

  @MainActor
  func testPublisherFirehose() {
    let store = Store<Int, Void>(initialState: 0) {}
    let viewStore = ViewStore(store, observe: { $0 })

    var emissionCount = 0
    viewStore.publisher
      .sink { _ in emissionCount += 1 }
      .store(in: &self.cancellables)

    XCTAssertEqual(emissionCount, 1)
    viewStore.send(())
    XCTAssertEqual(emissionCount, 1)
    viewStore.send(())
    XCTAssertEqual(emissionCount, 1)
    viewStore.send(())
    XCTAssertEqual(emissionCount, 1)
  }

  @available(*, deprecated)
  @MainActor
  func testEqualityChecks() {
    let store = Store<State, Void>(initialState: State()) {}

    let store1 = store.scope(state: { $0 }, action: { $0 })
    let store2 = store1.scope(state: { $0 }, action: { $0 })
    let store3 = store2.scope(state: { $0 }, action: { $0 })
    let store4 = store3.scope(state: { $0 }, action: { $0 })

    let viewStore1 = ViewStore(store1, observe: { $0 })
    let viewStore2 = ViewStore(store2, observe: { $0 })
    let viewStore3 = ViewStore(store3, observe: { $0 })
    let viewStore4 = ViewStore(store4, observe: { $0 })

    viewStore1.publisher.sink { _ in }.store(in: &self.cancellables)
    viewStore2.publisher.sink { _ in }.store(in: &self.cancellables)
    viewStore3.publisher.sink { _ in }.store(in: &self.cancellables)
    viewStore4.publisher.sink { _ in }.store(in: &self.cancellables)
    viewStore1.publisher.substate.sink { _ in }.store(in: &self.cancellables)
    viewStore2.publisher.substate.sink { _ in }.store(in: &self.cancellables)
    viewStore3.publisher.substate.sink { _ in }.store(in: &self.cancellables)
    viewStore4.publisher.substate.sink { _ in }.store(in: &self.cancellables)

    XCTAssertEqual(0, equalityChecks.value)
    XCTAssertEqual(0, subEqualityChecks.value)
    viewStore4.send(())
    XCTAssertEqual(4, equalityChecks.value)
    XCTAssertEqual(4, subEqualityChecks.value)
    viewStore4.send(())
    XCTAssertEqual(8, equalityChecks.value)
    XCTAssertEqual(8, subEqualityChecks.value)
    viewStore4.send(())
    XCTAssertEqual(12, equalityChecks.value)
    XCTAssertEqual(12, subEqualityChecks.value)
    viewStore4.send(())
    XCTAssertEqual(16, equalityChecks.value)
    XCTAssertEqual(16, subEqualityChecks.value)
  }

  @MainActor
  func testAccessViewStoreStateInPublisherSink() {
    let reducer = Reduce<Int, Void> { count, _ in
      count += 1
      return .none
    }

    let store = Store(initialState: 0) { reducer }
    let viewStore = ViewStore(store, observe: { $0 })

    var results: [Int] = []

    viewStore.publisher
      .sink { _ in results.append(viewStore.state) }
      .store(in: &self.cancellables)

    viewStore.send(())
    viewStore.send(())
    viewStore.send(())

    XCTAssertEqual([0, 1, 2, 3], results)
  }

  @MainActor
  func testWillSet() {
    let reducer = Reduce<Int, Void> { count, _ in
      count += 1
      return .none
    }

    let store = Store(initialState: 0) { reducer }
    let viewStore = ViewStore(store, observe: { $0 })

    var results: [Int] = []

    viewStore.objectWillChange
      .sink { _ in results.append(viewStore.state) }
      .store(in: &self.cancellables)

    XCTAssertEqual([], results)
    viewStore.send(())
    XCTAssertEqual([0], results)
    viewStore.send(())
    XCTAssertEqual([0, 1], results)
    viewStore.send(())
    XCTAssertEqual([0, 1, 2], results)
  }

  @MainActor
  func testPublisherOwnsViewStore() {
    let reducer = Reduce<Int, Void> { count, _ in
      count += 1
      return .none
    }
    let store = Store(initialState: 0) { reducer }

    var results: [Int] = []
    ViewStore(store, observe: { $0 })
      .publisher
      .sink { results.append($0) }
      .store(in: &self.cancellables)

    ViewStore(store, observe: { $0 }).send(())
    XCTAssertEqual(results, [0, 1])
  }

  @MainActor
  func testStorePublisherSubscriptionOrder() {
    let store = Store<Int, Void>(initialState: 0) {
      Reduce { state, _ in
        state += 1
        return .none
      }
    }
    let viewStore = ViewStore(store, observe: { $0 })

    var results: [Int] = []

    viewStore.publisher
      .sink { _ in results.append(0) }
      .store(in: &self.cancellables)

    viewStore.publisher
      .sink { _ in results.append(1) }
      .store(in: &self.cancellables)

    viewStore.publisher
      .sink { _ in results.append(2) }
      .store(in: &self.cancellables)

    XCTAssertEqual(results, [0, 1, 2])

    results = []
    viewStore.send(())
    XCTAssertEqual(results, [0, 1, 2])

    results = []
    viewStore.send(())
    XCTAssertEqual(results, [0, 1, 2])

    results = []
    viewStore.send(())
    XCTAssertEqual(results, [0, 1, 2])

    results = []
    for _ in 1...10 {
      viewStore.send(())
    }
    XCTAssertEqual(results, Array(repeating: [0, 1, 2], count: 10).flatMap { $0 })
  }

  func testSendWhile() async {
    enum Action {
      case response
      case tapped
    }
    let reducer = Reduce<Bool, Action> { state, action in
      switch action {
      case .response:
        state = false
        return .none
      case .tapped:
        state = true
        return .run { send in await send(.response) }
      }
    }

    let store = await Store(initialState: false) { reducer }
    let viewStore = await ViewStore(store, observe: { $0 })

    var state = await viewStore.state
    XCTAssertEqual(state, false)
    await viewStore.send(.tapped, while: { $0 })
    state = await viewStore.state
    XCTAssertEqual(state, false)
  }

  func testSuspend() {
    let expectation = self.expectation(description: "await")
    Task {
      enum Action {
        case response
        case tapped
      }
      let reducer = Reduce<Bool, Action> { state, action in
        switch action {
        case .response:
          state = false
          return .none
        case .tapped:
          state = true
          return .run { send in await send(.response) }
        }
      }

      let store = await Store(initialState: false) { reducer }
      let viewStore = await ViewStore(store, observe: { $0 })

      var state = await viewStore.state
      XCTAssertEqual(state, false)
      await viewStore.send(.tapped)
      state = await viewStore.state
      XCTAssertEqual(state, true)
      await viewStore.yield(while: { $0 })
      state = await viewStore.state
      XCTAssertEqual(state, false)
      expectation.fulfill()
    }
    self.wait(for: [expectation], timeout: 1)
  }

  func testAsyncSend() async throws {
    enum Action {
      case tap
      case response(Int)
    }
    let store = await Store(initialState: 0) {
      Reduce<Int, Action> { state, action in
        switch action {
        case .tap:
          return .run { send in
            await send(.response(42))
          }
        case let .response(value):
          state = value
          return .none
        }
      }
    }

    let viewStore = await ViewStore(store, observe: { $0 })

    var state = await viewStore.state
    XCTAssertEqual(state, 0)
    await viewStore.send(.tap).finish()
    state = await viewStore.state
    XCTAssertEqual(state, 42)
  }

  func testAsyncSendCancellation() async throws {
    enum Action {
      case tap
      case response(Int)
    }
    let store = await Store(initialState: 0) {
      Reduce<Int, Action> { state, action in
        switch action {
        case .tap:
          return .run { send in
            try await Task.sleep(nanoseconds: NSEC_PER_SEC)
            await send(.response(42))
          }
        case let .response(value):
          state = value
          return .none
        }
      }
    }

    let viewStore = await ViewStore(store, observe: { $0 })

    var state = await viewStore.state
    XCTAssertEqual(state, 0)
    let task = await viewStore.send(.tap)
    task.cancel()
    try await Task.sleep(nanoseconds: NSEC_PER_MSEC)
    state = await viewStore.state
    XCTAssertEqual(state, 0)
  }
}

private struct State: Equatable {
  var substate = Substate()

  static func == (lhs: Self, rhs: Self) -> Bool {
    equalityChecks.withValue { $0 += 1 }
    return lhs.substate == rhs.substate
  }
}

private struct Substate: Equatable {
  var name = "Blob"

  static func == (lhs: Self, rhs: Self) -> Bool {
    subEqualityChecks.withValue { $0 += 1 }
    return lhs.name == rhs.name
  }
}

private let equalityChecks = LockIsolated(0)
private let subEqualityChecks = LockIsolated(0)