Address comments, show unencrypted rooms,

retain viewModel and services in ScreenSates so you can interact with Previews after the first state.
This commit is contained in:
David Langley
2021-09-23 23:57:54 +01:00
parent bd4d9974a8
commit d560e513d4
16 changed files with 185 additions and 114 deletions
@@ -26,9 +26,11 @@ class TemplateRoomChatService: TemplateRoomChatServiceProtocol {
private let room: MXRoom
private let eventFormatter: EventFormatter
private var roomState: MXRoomState?
private var timeline: MXEventTimeline?
private var eventBatch: [MXEvent]
private var roomListenerReference: Any?
// MARK: Public
private(set) var chatMessagesSubject: CurrentValueSubject<[TemplateRoomChatMessage], Never>
private(set) var roomInitializationStatus: CurrentValueSubject<TemplateRoomChatRoomInitializationStatus, Never>
@@ -43,7 +45,7 @@ class TemplateRoomChatService: TemplateRoomChatServiceProtocol {
self.eventFormatter = EventFormatter(matrixSession: room.mxSession)
self.chatMessagesSubject = CurrentValueSubject([])
self.roomInitializationStatus = CurrentValueSubject(.notInitialized)
self.eventBatch = [MXEvent]()
initializeRoom()
}
@@ -61,35 +63,31 @@ class TemplateRoomChatService: TemplateRoomChatServiceProtocol {
// MARK: Private
private func initializeRoom(){
room.state { [weak self] roomState in
guard let self = self else { return }
if let roomState = roomState {
self.roomState = roomState
self.roomInitializationStatus.value = .initialized
self.loadInitialMessages()
self.startListeningToRoomEvents()
} else {
self.roomInitializationStatus.value = .failedToInitialize
}
}
}
private func loadInitialMessages() {
let batch = room.enumeratorForStoredMessages.nextEventsBatch(200)
let messageBatch = self.mapChatMessages(from: batch ?? [])
self.chatMessagesSubject.value = messageBatch
}
private func startListeningToRoomEvents(){
roomListenerReference = room.listen { [weak self] event, directionId, roomState in
let direction = MXTimelineDirection(identifer: directionId)
room.liveTimeline { [weak self] timeline in
guard let self = self,
let event = event else { return }
if let roomState = roomState {
self.roomState = roomState
let timeline = timeline
else {
return
}
if direction == .forwards && event.type == kMXEventTypeStringRoomMessage {
self.appendNewMessage(event: event)
self.timeline = timeline
timeline.resetPagination()
self.roomListenerReference = timeline.listenToEvents([.roomMessage], { [weak self] event, direction, roomState in
guard let self = self else { return }
if direction == .backwards {
self.eventBatch.append(event)
} else {
self.chatMessagesSubject.value += self.mapChatMessages(from: [event])
}
})
timeline.paginate(200, direction: .backwards, onlyFromStore: false) { result in
guard result.isSuccess else {
self.roomInitializationStatus.value = .failedToInitialize
return
}
let sortedBatch = self.eventBatch.sorted(by: { $0.originServerTs < $1.originServerTs})
self.chatMessagesSubject.value = self.mapChatMessages(from: sortedBatch)
self.roomInitializationStatus.value = .initialized
}
}
}
@@ -119,16 +117,11 @@ class TemplateRoomChatService: TemplateRoomChatServiceProtocol {
}
private func senderForMessage(event: MXEvent) -> TemplateRoomChatMember? {
guard let sender = event.sender, let roomState = roomState else {
guard let sender = event.sender, let roomState = timeline?.state else {
return nil
}
let displayName = eventFormatter.senderDisplayName(for: event, with: roomState)
let avatarUrl = eventFormatter.senderAvatarUrl(for: event, with: roomState)
return TemplateRoomChatMember(id: sender, avatarUrl: avatarUrl, displayName: displayName)
}
private func appendNewMessage(event: MXEvent) {
chatMessagesSubject.value += mapChatMessages(from: [event])
}
}
@@ -36,17 +36,17 @@ enum MockTemplateRoomChatScreenState: MockScreenState, CaseIterable {
}
/// Generate the view struct for the screen state.
var screenView: AnyView {
var screenView: ([Any], AnyView) {
let service: MockTemplateRoomChatService
switch self {
case .noMessages:
service = MockTemplateRoomChatService(messages: [])
service.simulateUpdate(initializationStatus: .initialized)
case .messages:
service = MockTemplateRoomChatService()
service.simulateUpdate(initializationStatus: .initialized)
service = MockTemplateRoomChatService()
service.simulateUpdate(initializationStatus: .initialized)
case .initializingRoom:
service = MockTemplateRoomChatService()
service = MockTemplateRoomChatService()
case .failedToInitializeRoom:
service = MockTemplateRoomChatService()
service.simulateUpdate(initializationStatus: .failedToInitialize)
@@ -54,8 +54,11 @@ enum MockTemplateRoomChatScreenState: MockScreenState, CaseIterable {
let viewModel = TemplateRoomChatViewModel(templateRoomChatService: service)
// can simulate service and viewModel actions here if needs be.
return AnyView(TemplateRoomChat(viewModel: viewModel.context)
.addDependency(MockAvatarService.example))
return (
[service, viewModel],
AnyView(TemplateRoomChat(viewModel: viewModel.context)
.addDependency(MockAvatarService.example))
)
}
}
@@ -46,7 +46,8 @@ class MockTemplateRoomChatService: TemplateRoomChatServiceProtocol {
func simulateUpdate(initializationStatus: TemplateRoomChatRoomInitializationStatus) {
self.roomInitializationStatus.value = initializationStatus
}
func simulateUpdate(messages: [TemplateRoomChatMessage]) {
self.chatMessagesSubject.send(messages)
self.chatMessagesSubject.value = messages
}
}
@@ -15,6 +15,7 @@
//
import SwiftUI
import Combine
@available(iOS 14.0, *)
struct TemplateRoomChat: View {
@@ -88,15 +89,15 @@ struct TemplateRoomChat: View {
.id(bubble.id)
}
}
.onAppear {
// Start at the bottom
reader.scrollTo(viewModel.viewState.bubbles.last?.id, anchor: .bottom)
.onAppear{
guard let lastBubbleId = viewModel.viewState.bubbles.last?.id
else { return }
reader.scrollTo(lastBubbleId, anchor: .bottom)
}
.onChange(of: itemCount) { _ in
// When new items are added animate to the new items
withAnimation {
reader.scrollTo(viewModel.viewState.bubbles.last?.id, anchor: .bottom)
}
guard let lastBubbleId = viewModel.viewState.bubbles.last?.id
else { return }
reader.scrollTo(lastBubbleId, anchor: .bottom)
}
// When the scroll content takes less than the screen space align at the top
.frame(maxHeight: .infinity, alignment: .top)
@@ -113,7 +114,6 @@ struct TemplateRoomChat: View {
}
}
private var itemCount: Int {
return viewModel.viewState
.bubbles
@@ -127,7 +127,8 @@ struct TemplateRoomChat: View {
@available(iOS 14.0, *)
struct TemplateRoomChat_Previews: PreviewProvider {
static let stateRenderer = MockTemplateRoomChatScreenState.stateRenderer
static var previews: some View {
MockTemplateRoomChatScreenState.screenGroup(addNavigation: true)
stateRenderer.screenGroup(addNavigation: true)
}
}
@@ -43,8 +43,8 @@ class TemplateRoomChatViewModel: TemplateRoomChatViewModelType, TemplateRoomChat
init(templateRoomChatService: TemplateRoomChatServiceProtocol) {
self.templateRoomChatService = templateRoomChatService
super.init(initialViewState: Self.defaultState(templateRoomChatService: templateRoomChatService))
setupRoomInitializationObserving()
setupMessageObserving()
setupRoomInitializationObserving()
}
private func setupRoomInitializationObserving() {
@@ -52,7 +52,7 @@ class TemplateRoomChatViewModel: TemplateRoomChatViewModelType, TemplateRoomChat
.roomInitializationStatus
.map(TemplateRoomChatStateAction.updateRoomInitializationStatus)
.eraseToAnyPublisher()
dispatch(actionPublisher: initializationPublisher)
}
@@ -66,9 +66,8 @@ class TemplateRoomChatViewModel: TemplateRoomChatViewModelType, TemplateRoomChat
}
private static func defaultState(templateRoomChatService: TemplateRoomChatServiceProtocol) -> TemplateRoomChatViewState {
let bubbles = makeBubbles(messages: templateRoomChatService.chatMessagesSubject.value)
let bindings = TemplateRoomChatViewModelBindings(messageInput: "")
return TemplateRoomChatViewState(roomInitializationStatus: templateRoomChatService.roomInitializationStatus.value, roomName: templateRoomChatService.roomName, bubbles: bubbles, bindings: bindings)
return TemplateRoomChatViewState(roomInitializationStatus: .notInitialized, roomName: templateRoomChatService.roomName, bubbles: [], bindings: bindings)
}
private static func makeBubbles(messages: [TemplateRoomChatMessage]) -> [TemplateRoomChatBubble] {
@@ -134,7 +133,6 @@ class TemplateRoomChatViewModel: TemplateRoomChatViewModelType, TemplateRoomChat
case .updateBubbles(let bubbles):
state.bubbles = bubbles
}
UILog.debug("[TemplateRoomChatViewModel] reducer with action \(action) produced state: \(state)")
}
// MARK: - Private
@@ -36,7 +36,7 @@ class TemplateRoomListService: TemplateRoomListServiceProtocol {
self.session = session
let unencryptedRooms = session.rooms
.filter(\.summary.isEncrypted)
.filter({ !$0.summary.isEncrypted })
.map(TemplateRoomListRoom.init(mxRoom:))
self.roomsSubject = CurrentValueSubject(unencryptedRooms)
}
@@ -34,7 +34,7 @@ enum MockTemplateRoomListScreenState: MockScreenState, CaseIterable {
}
/// Generate the view struct for the screen state.
var screenView: AnyView {
var screenView: ([Any], AnyView) {
let service: MockTemplateRoomListService
switch self {
case .noRooms:
@@ -46,7 +46,10 @@ enum MockTemplateRoomListScreenState: MockScreenState, CaseIterable {
// can simulate service and viewModel actions here if needs be.
return AnyView(TemplateRoomList(viewModel: viewModel.context)
return (
[service, viewModel],
AnyView(TemplateRoomList(viewModel: viewModel.context)
.addDependency(MockAvatarService.example))
)
}
}
@@ -68,9 +68,9 @@ struct TemplateRoomList: View {
@available(iOS 14.0, *)
struct TemplateRoomList_Previews: PreviewProvider {
static let stateRenderer = MockTemplateRoomListScreenState.stateRenderer
static var previews: some View {
MockTemplateRoomListScreenState
.screenGroup(addNavigation: true)
stateRenderer.screenGroup(addNavigation: true)
}
}
@@ -50,7 +50,7 @@ class TemplateRoomListViewModel: TemplateRoomListViewModelType, TemplateRoomList
let roomsUpdatePublisher = templateRoomListService.roomsSubject
.map(TemplateRoomListStateAction.updateRooms)
.eraseToAnyPublisher()
dispatch(actionPublisher: roomsUpdatePublisher)
dispatch(actionPublisher: roomsUpdatePublisher)
}
// MARK: - Public
@@ -69,7 +69,6 @@ class TemplateRoomListViewModel: TemplateRoomListViewModelType, TemplateRoomList
case .updateRooms(let rooms):
state.rooms = rooms
}
UILog.debug("[TemplateRoomListViewModel] reducer with action \(action) produced state: \(state)")
}
// MARK: - Private