Address comments, show unencrypted rooms,

retain viewModel and services in ScreenSates so you can interact with Previews after the first state.

RiotSwiftUI/Modules/Common/Mock/MockScreenState.swift

@@ -21,7 +21,7 @@ import SwiftUI
 protocol MockScreenState {
     static var screenStates: [MockScreenState] { get }
     var screenType: Any.Type { get }
-    var screenView: AnyView { get }
+    var screenView: ([Any], AnyView) { get }
     var stateTitle: String { get }
 }
 
@@ -29,8 +29,24 @@ protocol MockScreenState {
 extension MockScreenState {
     
     /// Get a list of the screens for every screen state.
-    static var screensViews: [AnyView] {
-        screenStates.map(\.screenView)
+    static var stateRenderer: StateRenderer {
+        let depsAndViews  = screenStates.map(\.screenView)
+        let deps = depsAndViews.map({ $0.0 })
+        let views = depsAndViews.map({ $0.1 })
+        let stateTitles = screenStates.map(\.stateTitle)
+        let fullScreenTitles = screenStates.map(\.fullScreenTitle)
+        
+        var states = [ScreenStateInfo]()
+        for i in 0..<deps.count {
+            let dep = deps[i]
+            let view = views[i]
+            let stateTitle = stateTitles[i]
+            let stateKey = screenStateKeys[i]
+            let fullScreenTitle = fullScreenTitles[i]
+            states.append(ScreenStateInfo(dependencies: dep, view: view, stateTitle: stateTitle, fullScreenTitle:fullScreenTitle, stateKey: stateKey))
+        }
+        
+        return StateRenderer(states: states)
     }
     
     /// A unique key to identify each screen state.
@@ -40,42 +56,6 @@ extension MockScreenState {
         }
     }
     
-    /// Render each of the screen states in a group applying
-    /// any optional environment variables.
-    /// - Parameters:
-    ///   - themeId: id of theme to render the screens with.
-    ///   - locale: Locale to render the screens with.
-    ///   - sizeCategory: type sizeCategory to render the screens with.
-    ///   - addNavigation: Wether to wrap the screens in a navigation view.
-    /// - Returns: The group of screens
-    static func screenGroup(
-        themeId: ThemeIdentifier = .light,
-        locale: Locale = Locale.current,
-        sizeCategory: ContentSizeCategory = ContentSizeCategory.medium,
-        addNavigation: Bool = false
-    ) -> some View {
-        Group {
-            ForEach(0..<screensViews.count) { i in
-                wrapWithNavigation(addNavigation, view: screensViews[i])
-                    .previewDisplayName(screenStates[i].stateTitle)
-            }
-        }
-        .theme(themeId)
-        .environment(\.locale, locale)
-        .environment(\.sizeCategory, sizeCategory)
-    }
-    
-    @ViewBuilder
-    static func wrapWithNavigation<V: View>(_ wrap: Bool, view: V) -> some View {
-        if wrap {
-            NavigationView{
-                view
-            }
-        } else {
-            view
-        }
-    }
-
     /// A title to represent the screen and it's screen state
     var screenName: String {
         "\(String(describing: screenType.self))"
@@ -90,7 +70,6 @@ extension MockScreenState {
     var fullScreenTitle: String {
         "\(screenName): \(stateTitle)"
     }
-    
 
 }
 

RiotSwiftUI/Modules/Common/Mock/ScreenList.swift

@@ -19,12 +19,12 @@ import SwiftUI
 @available(iOS 14.0, *)
 struct ScreenList: View {
     
-    private var allStates: [MockScreenState]
-    private var allKeys: [String]
+    private var allStates: [ScreenStateInfo]
     
     init(screens: [MockScreenState.Type]) {
-        self.allStates = screens.flatMap{ $0.screenStates }
-        self.allKeys = screens.flatMap{ $0.screenStateKeys }
+        allStates = screens
+            .map({ $0.stateRenderer })
+            .flatMap{( $0.states )}
     }
     
     var body: some View {
@@ -32,9 +32,9 @@ struct ScreenList: View {
             List {
                 ForEach(0..<allStates.count) { i in
                     let state = allStates[i]
-                    NavigationLink(destination: state.screenView) {
+                    NavigationLink(destination: state.view) {
                         Text(state.fullScreenTitle)
-                            .accessibilityIdentifier(allKeys[i])
+                            .accessibilityIdentifier(state.stateKey)
                     }
                 }
             }

RiotSwiftUI/Modules/Common/Mock/ScreenStateInfo.swift

@@ -0,0 +1,27 @@
+// 
+// Copyright 2021 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 Foundation
+import SwiftUI
+
+@available(iOS 14.0, *)
+struct ScreenStateInfo {
+    var dependencies: [Any]
+    var view: AnyView
+    var stateTitle: String
+    var fullScreenTitle: String
+    var stateKey: String
+}

RiotSwiftUI/Modules/Common/Mock/StateRenderer.swift

@@ -0,0 +1,63 @@
+// 
+// Copyright 2021 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 Foundation
+import SwiftUI
+
+@available(iOS 14.0, *)
+class StateRenderer {
+    var states: [ScreenStateInfo]
+    init(states: [ScreenStateInfo]) {
+        self.states = states
+    }
+    
+    /// Render each of the screen states in a group applying
+    /// any optional environment variables.
+    /// - Parameters:
+    ///   - themeId: id of theme to render the screens with.
+    ///   - locale: Locale to render the screens with.
+    ///   - sizeCategory: type sizeCategory to render the screens with.
+    ///   - addNavigation: Wether to wrap the screens in a navigation view.
+    /// - Returns: The group of screens
+    func screenGroup(
+        themeId: ThemeIdentifier = .light,
+        locale: Locale = Locale.current,
+        sizeCategory: ContentSizeCategory = ContentSizeCategory.medium,
+        addNavigation: Bool = false
+    ) -> some View {
+        Group {
+            ForEach(0..<states.count) { i in
+                let state = self.states[i]
+                Self.wrapWithNavigation(addNavigation, view: state.view)
+                    .previewDisplayName(state.stateTitle)
+            }
+        }
+        .theme(themeId)
+        .environment(\.locale, locale)
+        .environment(\.sizeCategory, sizeCategory)
+    }
+    
+    @ViewBuilder
+    static func wrapWithNavigation<V: View>(_ wrap: Bool, view: V) -> some View {
+        if wrap {
+            NavigationView{
+                view
+            }
+        } else {
+            view
+        }
+    }
+}

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Service/Mock/MockTemplateUserProfileScreenState.swift

@@ -42,7 +42,7 @@ enum MockTemplateUserProfileScreenState: MockScreenState, CaseIterable {
     }
     
     /// Generate the view struct for the screen state.
-    var screenView: AnyView {
+    var screenView: ([Any], AnyView)  {
         let service: MockTemplateUserProfileService
         switch self {
         case .presence(let presence):
@@ -54,7 +54,10 @@ enum MockTemplateUserProfileScreenState: MockScreenState, CaseIterable {
         
         // can simulate service and viewModel actions here if needs be.
         
-        return AnyView(TemplateUserProfile(viewModel: viewModel.context)
+        return (
+            [service, viewModel],
+            AnyView(TemplateUserProfile(viewModel: viewModel.context)
                 .addDependency(MockAvatarService.example))
+        )
     }
 }

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/View/TemplateUserProfile.swift

@@ -73,7 +73,8 @@ struct TemplateUserProfile: View {
 
 @available(iOS 14.0, *)
 struct TemplateUserProfile_Previews: PreviewProvider {
+    static let stateRenderer = MockTemplateUserProfileScreenState.stateRenderer
     static var previews: some View {
-        MockTemplateUserProfileScreenState.screenGroup()
+        stateRenderer.screenGroup()
     }
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomChat/Service/MatrixSDK/TemplateRoomChatService.swift

@@ -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])
-    }
-    
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomChat/Service/Mock/MockTemplateRoomChatScreenState.swift

@@ -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))
+        )
     }
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomChat/Service/Mock/MockTemplateRoomChatService.swift

@@ -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
     }
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomChat/View/TemplateRoomChat.swift

@@ -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)
     }
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomChat/ViewModel/TemplateRoomChatViewModel.swift

@@ -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

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomList/Service/MatrixSDK/TemplateRoomListService.swift

@@ -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)
     }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomList/Service/Mock/MockTemplateRoomListScreenState.swift

@@ -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))
+        )
     }
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomList/View/TemplateRoomList.swift

@@ -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)
     }
 }

RiotSwiftUI/Modules/Template/TemplateAdvancedRoomsExample/TemplateRoomList/ViewModel/TemplateRoomListViewModel.swift

@@ -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