Lock the Link New Device flow to portrait and improve Cancel/Try Again handling. (#5094)

* Lock the LinkNewDeviceScreen to portrait.

* Add cancel buttons to the QR Code errors and handle cancel/startOver correctly.

* Use the shared QRCodeErrorView in the LinkNewDeviceScreen.

* Clarify the different QR Error/ErrorStates a bit more.

* Update snapshots.

ElementX/Sources/Screens/LinkNewDeviceScreen/LinkNewDeviceScreenCoordinator.swift

@@ -16,10 +16,12 @@ enum LinkNewDeviceScreenCoordinatorAction {
 
 struct LinkNewDeviceScreenCoordinatorParameters {
     let clientProxy: ClientProxyProtocol
+    let orientationManager: OrientationManagerProtocol
 }
 
 final class LinkNewDeviceScreenCoordinator: CoordinatorProtocol {
     private let viewModel: LinkNewDeviceScreenViewModelProtocol
+    private let orientationManager: OrientationManagerProtocol
     
     private var cancellables = Set<AnyCancellable>()
  
@@ -30,6 +32,7 @@ final class LinkNewDeviceScreenCoordinator: CoordinatorProtocol {
     
     init(parameters: LinkNewDeviceScreenCoordinatorParameters) {
         viewModel = LinkNewDeviceScreenViewModel(clientProxy: parameters.clientProxy)
+        orientationManager = parameters.orientationManager
     }
     
     func start() {
@@ -47,6 +50,13 @@ final class LinkNewDeviceScreenCoordinator: CoordinatorProtocol {
             }
         }
         .store(in: &cancellables)
+        
+        orientationManager.setOrientation(.portrait)
+        orientationManager.lockOrientation(.portrait)
+    }
+    
+    func stop() {
+        orientationManager.lockOrientation(.all)
     }
         
     func toPresentable() -> AnyView {

ElementX/Sources/Screens/LinkNewDeviceScreen/LinkNewDeviceScreenModels.swift

@@ -14,7 +14,12 @@ enum LinkNewDeviceScreenViewModelAction {
 }
 
 struct LinkNewDeviceScreenViewState: BindableState {
-    enum Mode: Equatable { case loading, readyToLink(isGeneratingCode: Bool), notSupported }
+    enum Mode: Equatable {
+        case loading
+        case readyToLink(isGeneratingCode: Bool)
+        case error(QRCodeLoginState.ErrorState)
+    }
+    
     var mode: Mode = .loading
     
     let showLinkDesktopComputerButton: Bool
@@ -23,5 +28,6 @@ struct LinkNewDeviceScreenViewState: BindableState {
 enum LinkNewDeviceScreenViewAction {
     case linkMobileDevice
     case linkDesktopComputer
+    case errorAction(QRCodeErrorView.Action)
     case dismiss
 }

ElementX/Sources/Screens/LinkNewDeviceScreen/LinkNewDeviceScreenViewModel.swift

@@ -39,6 +39,8 @@ class LinkNewDeviceScreenViewModel: LinkNewDeviceScreenViewModelType, LinkNewDev
             Task { await linkMobileDevice() }
         case .linkDesktopComputer:
             actionsSubject.send(.linkDesktopComputer)
+        case .errorAction(let action):
+            handleErrorAction(action)
         case .dismiss:
             actionsSubject.send(.dismiss)
         }
@@ -50,7 +52,7 @@ class LinkNewDeviceScreenViewModel: LinkNewDeviceScreenViewModelType, LinkNewDev
         if await clientProxy.isLoginWithQRCodeSupported {
             state.mode = .readyToLink(isGeneratingCode: false)
         } else {
-            state.mode = .notSupported
+            state.mode = .error(.notSupported)
         }
     }
     
@@ -73,8 +75,22 @@ class LinkNewDeviceScreenViewModel: LinkNewDeviceScreenViewModelType, LinkNewDev
             actionsSubject.send(.linkMobileDevice(progressPublisher))
             state.mode = .readyToLink(isGeneratingCode: false)
         } catch {
-            #warning("Needs some form of re-usable error handling, will handle with the next screen.")
-            state.mode = .notSupported
+            // This is hard to share a mapping from the QRCodeLoginError with the
+            // QRCodeLoginScreen given that some of those are scan errors…
+            state.mode = .error(.unknown)
+        }
+    }
+    
+    private func handleErrorAction(_ action: QRCodeErrorView.Action) {
+        switch action {
+        case .startOver:
+            // Reset to ready state to allow trying again.
+            state.mode = .readyToLink(isGeneratingCode: false)
+        case .openSettings, .signInManually:
+            MXLog.error("Unexpected error action: \(action)")
+            actionsSubject.send(.dismiss)
+        case .cancel:
+            actionsSubject.send(.dismiss)
         }
     }
 }

ElementX/Sources/Screens/LinkNewDeviceScreen/View/LinkNewDeviceScreen.swift

@@ -5,6 +5,7 @@
 // Please see LICENSE files in the repository root for full details.
 //
 
+import Combine
 import Compound
 import SwiftUI
 
@@ -12,16 +13,24 @@ struct LinkNewDeviceScreen: View {
     @Bindable var context: LinkNewDeviceScreenViewModel.Context
     
     var body: some View {
-        FullscreenDialog(topPadding: 24, horizontalPadding: 24) {
-            mainContent
-        } bottomContent: {
-            buttons
+        switch context.viewState.mode {
+        case .error(let errorState):
+            QRCodeErrorView(errorState: errorState, canSignInManually: false) { action in
+                context.send(viewAction: .errorAction(action))
+            }
+            .backgroundStyle(.compound.bgCanvasDefault)
+        default:
+            FullscreenDialog(topPadding: 24, horizontalPadding: 24) {
+                mainContent
+            } bottomContent: {
+                buttons
+            }
+            .background()
+            .backgroundStyle(.compound.bgSubtleSecondary)
+            .navigationTitle(L10n.commonLinkNewDevice)
+            .navigationBarTitleDisplayMode(.inline)
+            .toolbar { toolbar }
         }
-        .background()
-        .backgroundStyle(.compound.bgSubtleSecondary)
-        .navigationTitle(L10n.commonLinkNewDevice)
-        .navigationBarTitleDisplayMode(.inline)
-        .toolbar { toolbar }
     }
     
     @ViewBuilder
@@ -31,11 +40,8 @@ struct LinkNewDeviceScreen: View {
             TitleAndIcon(title: L10n.screenLinkNewDeviceRootTitle,
                          icon: \.computer,
                          iconStyle: .default)
-        case .notSupported:
-            TitleAndIcon(title: L10n.screenLinkNewDeviceErrorNotSupportedTitle,
-                         subtitle: L10n.screenLinkNewDeviceErrorNotSupportedSubtitle,
-                         icon: \.errorSolid,
-                         iconStyle: .alertSolid)
+        case .error:
+            EmptyView() // Not reachable.
         }
     }
     
@@ -79,11 +85,8 @@ struct LinkNewDeviceScreen: View {
                 }
             }
             .disabled(isGeneratingCode)
-        case .notSupported:
-            Button(L10n.actionDismiss) {
-                context.send(viewAction: .dismiss)
-            }
-            .buttonStyle(.compound(.primary))
+        case .error:
+            EmptyView() // Not reachable.
         }
     }
     
@@ -103,7 +106,8 @@ struct LinkNewDeviceScreen_Previews: PreviewProvider, TestablePreview {
     static let viewModel = makeViewModel(mode: .readyToLink(isGeneratingCode: false))
     static let generatingViewModel = makeViewModel(mode: .readyToLink(isGeneratingCode: true))
     static let loadingViewModel = makeViewModel(mode: .loading)
-    static let unsupportedViewModel = makeViewModel(mode: .notSupported)
+    static let unsupportedViewModel = makeViewModel(mode: .error(.notSupported))
+    static let unknownErrorViewModel = makeViewModel(mode: .error(.unknown))
     
     static var previews: some View {
         NavigationStack {
@@ -127,7 +131,13 @@ struct LinkNewDeviceScreen_Previews: PreviewProvider, TestablePreview {
             LinkNewDeviceScreen(context: unsupportedViewModel.context)
         }
         .previewDisplayName("Unsupported")
-        .snapshotPreferences(expect: unsupportedViewModel.context.observe(\.viewState.mode).map { $0 == .notSupported })
+        .snapshotPreferences(expect: unsupportedViewModel.context.observe(\.viewState.mode).map { $0 == .error(.notSupported) })
+        
+        NavigationStack {
+            LinkNewDeviceScreen(context: unknownErrorViewModel.context)
+        }
+        .previewDisplayName("Unknown error")
+        .snapshotPreferences(expect: unknownErrorViewModel.context.observe(\.viewState.mode).map { $0 == .error(.unknown) })
     }
     
     static func makeViewModel(mode: LinkNewDeviceScreenViewState.Mode) -> LinkNewDeviceScreenViewModel {
@@ -137,19 +147,25 @@ struct LinkNewDeviceScreen_Previews: PreviewProvider, TestablePreview {
             case .loading:
                 try? await Task.sleep(for: .seconds(20))
                 return false
-            case .readyToLink:
-                return true
-            case .notSupported:
+            case .error(.notSupported):
                 return false
+            case .readyToLink, .error:
+                return true
             }
         }
         
+        let linkMobileProgressSubject = CurrentValueSubject<LinkNewDeviceService.LinkMobileProgress, QRCodeLoginError>(.starting)
+        clientProxy.linkNewDeviceServiceReturnValue = LinkNewDeviceServiceMock(.init(linkMobileProgressPublisher: linkMobileProgressSubject.asCurrentValuePublisher()))
+        
         let viewModel = LinkNewDeviceScreenViewModel(clientProxy: clientProxy)
         
         Task {
             try? await Task.sleep(for: .milliseconds(100))
             if case .readyToLink(isGeneratingCode: true) = mode {
                 viewModel.context.send(viewAction: .linkMobileDevice)
+            } else if case .error = mode {
+                viewModel.context.send(viewAction: .linkMobileDevice)
+                linkMobileProgressSubject.send(completion: .failure(.unknown))
             }
         }