Fixes #317 - Adopt a split layout for iPad and Mac apps

Rename navigation components: SplitScreenCoordinator -> NavigationSplitCoordinator, StackScreenCoordinator -> NavigationStackCoordinator and SingleScreenCoordinator -> NavigationRootCoordinator
[0c161039] Tweak navigation logging
[826c19cf] Move the navigation dismissal callbacks to the NavigationModule, add SingleScreenCoordinator tests
[b8830d9c] Add tests
[252ad119] Merge the StackScreenCoordinator and SplitScreenCoordinators into a single file and stop publicly exposing their internal workings. Add more documentation.
[37671699] Cleanup navigation logging
[51406184] Use the parent SplitScreenCoordinator to present embedded StackScreenCoordinator sheets
[b94b04c9] Retract the room "syncing" indicator when dismissing a room
[1467b0ac] Correctly move to the no room selected state when popping in compact layouts
[10bf2ad8] Allow nilling root coordinators, replace present/dismiss sheet with setSheetCoordinator(?)
[33716784] Add single screen coordinator fade transition animation
[3cbe65e7] Prevent the timeline table view from being reused between different rooms
[9c94c50b] Move files around
[c10b6bc5] Adapt the user session state machine to the split layout
[7115a319] Fix unit and UI tests
[1ece59e8] Fix login flows
[6884dc3b] Use modules everywhere the underlying object is a NavigationModule
[ab08d44c] Rename navigation components to: SingleScreenCoordinator, SplitScreenCoordinator and StackScreenCoordinator
[ada2be57] Add SplitNavigationController

* Remove the navigationRootCoordinator from the UserSessionFlowCoordinator

ElementX/Sources/Screens/Authentication/AuthenticationCoordinator.swift

@@ -24,14 +24,14 @@ protocol AuthenticationCoordinatorDelegate: AnyObject {
 
 class AuthenticationCoordinator: CoordinatorProtocol {
     private let authenticationService: AuthenticationServiceProxyProtocol
-    private let navigationController: NavigationController
+    private let navigationStackCoordinator: NavigationStackCoordinator
     
     weak var delegate: AuthenticationCoordinatorDelegate?
     
     init(authenticationService: AuthenticationServiceProxyProtocol,
-         navigationController: NavigationController) {
+         navigationStackCoordinator: NavigationStackCoordinator) {
         self.authenticationService = authenticationService
-        self.navigationController = navigationController
+        self.navigationStackCoordinator = navigationStackCoordinator
     }
     
     func start() {
@@ -55,7 +55,7 @@ class AuthenticationCoordinator: CoordinatorProtocol {
             }
         }
         
-        navigationController.setRootCoordinator(coordinator)
+        navigationStackCoordinator.setRootCoordinator(coordinator)
     }
     
     private func startAuthentication() async {
@@ -88,12 +88,12 @@ class AuthenticationCoordinator: CoordinatorProtocol {
             }
         }
         
-        navigationController.push(coordinator)
+        navigationStackCoordinator.push(coordinator)
     }
     
     private func showLoginScreen() {
         let parameters = LoginCoordinatorParameters(authenticationService: authenticationService,
-                                                    navigationController: navigationController)
+                                                    navigationStackCoordinator: navigationStackCoordinator)
         let coordinator = LoginCoordinator(parameters: parameters)
 
         coordinator.callback = { [weak self] action in
@@ -105,7 +105,7 @@ class AuthenticationCoordinator: CoordinatorProtocol {
             }
         }
 
-        navigationController.push(coordinator)
+        navigationStackCoordinator.push(coordinator)
     }
     
     private func showAnalyticsPrompt(with userSession: UserSessionProtocol) {
@@ -117,7 +117,7 @@ class AuthenticationCoordinator: CoordinatorProtocol {
             self.delegate?.authenticationCoordinator(self, didLoginWithSession: userSession)
         }
                 
-        navigationController.setRootCoordinator(coordinator)
+        navigationStackCoordinator.setRootCoordinator(coordinator)
     }
     
     static let loadingIndicatorIdentifier = "AuthenticationCoordinatorLoading"

ElementX/Sources/Screens/Authentication/LoginScreen/LoginCoordinator.swift

@@ -21,7 +21,7 @@ struct LoginCoordinatorParameters {
     /// The service used to authenticate the user.
     let authenticationService: AuthenticationServiceProxyProtocol
     /// The navigation router used to present the server selection screen.
-    let navigationController: NavigationController
+    let navigationStackCoordinator: NavigationStackCoordinator
 }
 
 enum LoginCoordinatorAction {
@@ -43,7 +43,7 @@ final class LoginCoordinator: CoordinatorProtocol {
     }
     
     private var authenticationService: AuthenticationServiceProxyProtocol { parameters.authenticationService }
-    private var navigationController: NavigationController { parameters.navigationController }
+    private var navigationStackCoordinator: NavigationStackCoordinator { parameters.navigationStackCoordinator }
 
     var callback: (@MainActor (LoginCoordinatorAction) -> Void)?
     
@@ -195,9 +195,9 @@ final class LoginCoordinator: CoordinatorProtocol {
     
     /// Presents the server selection screen as a modal.
     private func presentServerSelectionScreen() {
-        let serverSelectionNavigationController = NavigationController()
+        let serverSelectionNavigationStackCoordinator = NavigationStackCoordinator()
         
-        let userNotificationController = UserNotificationController(rootCoordinator: serverSelectionNavigationController)
+        let userNotificationController = UserNotificationController(rootCoordinator: serverSelectionNavigationStackCoordinator)
         
         let parameters = ServerSelectionCoordinatorParameters(authenticationService: authenticationService,
                                                               userNotificationController: userNotificationController,
@@ -209,9 +209,9 @@ final class LoginCoordinator: CoordinatorProtocol {
             self.serverSelectionCoordinator(coordinator, didCompleteWith: action)
         }
         
-        serverSelectionNavigationController.setRootCoordinator(coordinator)
+        serverSelectionNavigationStackCoordinator.setRootCoordinator(coordinator)
         
-        navigationController.presentSheet(userNotificationController)
+        navigationStackCoordinator.setSheetCoordinator(userNotificationController)
     }
     
     /// Handles the result from the server selection modal, dismissing it after updating the view.
@@ -221,7 +221,7 @@ final class LoginCoordinator: CoordinatorProtocol {
             updateViewModel()
         }
         
-        navigationController.dismissSheet()
+        navigationStackCoordinator.setSheetCoordinator(nil)
     }
 
     /// Shows the forgot password screen.

ElementX/Sources/Screens/HomeScreen/HomeScreenCoordinator.swift

@@ -21,7 +21,7 @@ struct HomeScreenCoordinatorParameters {
     let userSession: UserSessionProtocol
     let attributedStringBuilder: AttributedStringBuilderProtocol
     let bugReportService: BugReportServiceProtocol
-    let navigationController: NavigationController
+    let navigationStackCoordinator: NavigationStackCoordinator
 }
 
 enum HomeScreenCoordinatorAction {
@@ -94,6 +94,6 @@ final class HomeScreenCoordinator: CoordinatorProtocol {
     }
 
     private func presentInviteFriends() {
-        parameters.navigationController.presentSheet(InviteFriendsCoordinator(userId: parameters.userSession.userID))
+        parameters.navigationStackCoordinator.setSheetCoordinator(InviteFriendsCoordinator(userId: parameters.userSession.userID))
     }
 }

ElementX/Sources/Screens/RoomScreen/RoomScreenCoordinator.swift

@@ -17,7 +17,7 @@
 import SwiftUI
 
 struct RoomScreenCoordinatorParameters {
-    let navigationController: NavigationController
+    let navigationStackCoordinator: NavigationStackCoordinator
     let timelineController: RoomTimelineControllerProtocol
     let mediaProvider: MediaProviderProtocol
     let roomName: String?
@@ -29,12 +29,12 @@ final class RoomScreenCoordinator: CoordinatorProtocol {
     private var parameters: RoomScreenCoordinatorParameters?
 
     private var viewModel: RoomScreenViewModelProtocol?
-    private var navigationController: NavigationController {
+    private var navigationStackCoordinator: NavigationStackCoordinator {
         guard let parameters else {
             fatalError()
         }
         
-        return parameters.navigationController
+        return parameters.navigationStackCoordinator
     }
     
     init(parameters: RoomScreenCoordinatorParameters) {
@@ -86,19 +86,19 @@ final class RoomScreenCoordinator: CoordinatorProtocol {
 
         if params.isModallyPresented {
             coordinator.callback = { [weak self] _ in
-                self?.navigationController.dismissSheet()
+                self?.navigationStackCoordinator.setSheetCoordinator(nil)
             }
 
-            let controller = NavigationController()
+            let controller = NavigationStackCoordinator()
             controller.setRootCoordinator(coordinator)
 
-            navigationController.presentSheet(controller)
+            navigationStackCoordinator.setSheetCoordinator(controller)
         } else {
             coordinator.callback = { [weak self] _ in
-                self?.navigationController.pop()
+                self?.navigationStackCoordinator.pop()
             }
 
-            navigationController.push(coordinator)
+            navigationStackCoordinator.push(coordinator)
         }
     }
 
@@ -106,10 +106,10 @@ final class RoomScreenCoordinator: CoordinatorProtocol {
         let params = FilePreviewCoordinatorParameters(fileURL: fileURL, title: title)
         let coordinator = FilePreviewCoordinator(parameters: params)
         coordinator.callback = { [weak self] _ in
-            self?.navigationController.pop()
+            self?.navigationStackCoordinator.pop()
         }
         
-        navigationController.push(coordinator)
+        navigationStackCoordinator.push(coordinator)
     }
     
     private func displayEmojiPickerScreen(for itemId: String) {
@@ -123,13 +123,14 @@ final class RoomScreenCoordinator: CoordinatorProtocol {
         coordinator.callback = { [weak self] action in
             switch action {
             case let .emojiSelected(emoji: emoji, itemId: itemId):
-                self?.navigationController.dismissSheet()
+                self?.navigationStackCoordinator.setSheetCoordinator(nil)
+                MXLog.debug("Save \(emoji) for \(itemId)")
                 Task {
                     await timelineController.sendReaction(emoji, for: itemId)
                 }
             }
         }
         
-        navigationController.presentSheet(coordinator)
+        navigationStackCoordinator.setSheetCoordinator(coordinator)
     }
 }

ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift

@@ -31,6 +31,10 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
 
     // MARK: - Setup
     
+    deinit {
+        ServiceLocator.shared.userNotificationController.retractNotificationWithId(Constants.backPaginationIndicatorID)
+    }
+    
     init(timelineController: RoomTimelineControllerProtocol,
          timelineViewFactory: RoomTimelineViewFactoryProtocol,
          mediaProvider: MediaProviderProtocol,

ElementX/Sources/Screens/RoomScreen/View/RoomScreen.swift

@@ -33,6 +33,7 @@ struct RoomScreen: View {
     
     var timeline: some View {
         TimelineTableView()
+            .id(context.viewState.roomId)
             .environmentObject(context)
             .timelineStyle(settings.timelineStyle)
             .overlay(alignment: .bottomTrailing) { scrollToBottomButton }

ElementX/Sources/Screens/Settings/SettingsCoordinator.swift

@@ -17,7 +17,7 @@
 import SwiftUI
 
 struct SettingsCoordinatorParameters {
-    let navigationController: NavigationController
+    let navigationStackCoordinator: NavigationStackCoordinator
     let userNotificationController: UserNotificationControllerProtocol
     let userSession: UserSessionProtocol
     let bugReportService: BugReportServiceProtocol
@@ -88,10 +88,10 @@ final class SettingsCoordinator: CoordinatorProtocol {
                 break
             }
             
-            self?.parameters.navigationController.pop()
+            self?.parameters.navigationStackCoordinator.pop()
         }
         
-        parameters.navigationController.push(coordinator)
+        parameters.navigationStackCoordinator.push(coordinator)
     }
 
     private func showSuccess(label: String) {