4b61cebe8b
We don't have visibility into timeline item read status so can't do this continuously yet. * Simplify RoomTimelineProvider's responsibilities.
125 lines
4.3 KiB
Swift
125 lines
4.3 KiB
Swift
//
|
|
// Copyright 2022 New Vector Ltd
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
import Combine
|
|
import Foundation
|
|
|
|
class MockRoomTimelineController: RoomTimelineControllerProtocol {
|
|
/// An array of timeline item arrays that will be inserted in order for each back pagination request.
|
|
var backPaginationResponses: [[RoomTimelineItemProtocol]] = []
|
|
/// The time delay added to each back pagination request.
|
|
var backPaginationDelay: Duration = .milliseconds(500)
|
|
|
|
/// An array of timeline items that will be appended in order when ``simulateIncomingItems()`` is called.
|
|
var incomingItems: [RoomTimelineItemProtocol] = []
|
|
|
|
let roomID = "MockRoomIdentifier"
|
|
|
|
let callbacks = PassthroughSubject<RoomTimelineControllerCallback, Never>()
|
|
|
|
var timelineItems: [RoomTimelineItemProtocol] = RoomTimelineItemFixtures.default
|
|
|
|
private var connection: UITestsSignalling.Connection?
|
|
|
|
init(listenForSignals: Bool = false) {
|
|
if listenForSignals {
|
|
connection = .init()
|
|
Task { try await startListening() }
|
|
}
|
|
}
|
|
|
|
func paginateBackwards(requestSize: UInt, untilNumberOfItems: UInt) async -> Result<Void, RoomTimelineControllerError> {
|
|
callbacks.send(.canBackPaginate(false))
|
|
return .success(())
|
|
}
|
|
|
|
func markRoomAsRead() async -> Result<Void, RoomTimelineControllerError> { .success(()) }
|
|
|
|
func processItemAppearance(_ itemID: String) async { }
|
|
|
|
func processItemDisappearance(_ itemID: String) async { }
|
|
|
|
func processItemTap(_ itemID: String) async -> RoomTimelineControllerAction { .none }
|
|
|
|
func sendMessage(_ message: String, inReplyTo itemID: String?) async { }
|
|
|
|
func sendReaction(_ reaction: String, to itemID: String) async { }
|
|
|
|
func editMessage(_ newMessage: String, original itemID: String) async { }
|
|
|
|
func redact(_ itemID: String) async { }
|
|
|
|
func debugDescription(for itemID: String) -> String {
|
|
"Mock debug description"
|
|
}
|
|
|
|
func retryDecryption(for sessionID: String) async { }
|
|
|
|
// MARK: - UI Test signalling
|
|
|
|
/// Allows the simulation of server responses by listening for signals from UI tests.
|
|
private func startListening() async throws {
|
|
try await connection?.connect()
|
|
|
|
Task {
|
|
while let connection {
|
|
do {
|
|
try await handleSignal(connection.receive())
|
|
} catch {
|
|
connection.disconnect()
|
|
self.connection = nil
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Handles a UI test signal as necessary.
|
|
private func handleSignal(_ signal: UITestsSignal) async throws {
|
|
switch signal {
|
|
case .paginate:
|
|
try await simulateBackPagination()
|
|
case .incomingMessage:
|
|
try await simulateIncomingItem()
|
|
default:
|
|
break
|
|
}
|
|
}
|
|
|
|
/// Appends the next incoming item to the `timelineItems` array.
|
|
private func simulateIncomingItem() async throws {
|
|
guard !incomingItems.isEmpty else { return }
|
|
|
|
let incomingItem = incomingItems.removeFirst()
|
|
timelineItems.append(incomingItem)
|
|
callbacks.send(.updatedTimelineItems)
|
|
|
|
try? await connection?.send(.success)
|
|
}
|
|
|
|
/// Prepends the next chunk of items to the `timelineItems` array.
|
|
private func simulateBackPagination() async throws {
|
|
guard !backPaginationResponses.isEmpty else { return }
|
|
callbacks.send(.isBackPaginating(true))
|
|
|
|
let newItems = backPaginationResponses.removeFirst()
|
|
timelineItems.insert(contentsOf: newItems, at: 0)
|
|
callbacks.send(.updatedTimelineItems)
|
|
callbacks.send(.isBackPaginating(false))
|
|
|
|
try? await connection?.send(.success)
|
|
}
|
|
}
|