Initial implementation for AppLockSetupFlowCoordinator. (#1949)

Rename AppLockSettingsScreen to AppLockSetupSettingsScreen. Implement forced logout and persist PIN entry attempts.
2026-11-05 11:58:32 +00:00 · 2023-10-25 12:03:37 +01:00
parent 30b18031a0
commit c6e4dc2a37
53 changed files with 773 additions and 234 deletions
@@ -22,11 +22,14 @@ enum AppLockFlowCoordinatorAction: Equatable {
    case lockApp
    /// Hide the unlock flow.
    case unlockApp
+    /// Forces a logout of the user.
+    case forceLogout
 }

 /// Coordinates the display of any screens shown when the app is locked.
 class AppLockFlowCoordinator: CoordinatorProtocol {
    let appLockService: AppLockServiceProtocol
+    let userIndicatorController: UserIndicatorController
    let navigationCoordinator: NavigationRootCoordinator
    
    private var cancellables: Set<AnyCancellable> = []
@@ -36,10 +39,18 @@ class AppLockFlowCoordinator: CoordinatorProtocol {
        actionsSubject.eraseToAnyPublisher()
    }
    
-    init(appLockService: AppLockServiceProtocol, navigationCoordinator: NavigationRootCoordinator) {
+    init(appLockService: AppLockServiceProtocol, userIndicatorController: UserIndicatorController, navigationCoordinator: NavigationRootCoordinator) {
        self.appLockService = appLockService
+        self.userIndicatorController = userIndicatorController
        self.navigationCoordinator = navigationCoordinator
        
+        appLockService.disabledPublisher
+            .sink { [weak self] _ in
+                // When the service is disabled via a force logout, we need to remove the activity indicator.
+                self?.userIndicatorController.retractAllIndicators()
+            }
+            .store(in: &cancellables)
+        
        NotificationCenter.default.publisher(for: UIApplication.didEnterBackgroundNotification)
            .sink { [weak self] _ in
                self?.applicationDidEnterBackground()
@@ -54,7 +65,7 @@ class AppLockFlowCoordinator: CoordinatorProtocol {
    }
    
    func toPresentable() -> AnyView {
-        AnyView(navigationCoordinator.toPresentable())
+        AnyView(userIndicatorController.toPresentable())
    }
    
    // MARK: - App unlock
@@ -91,6 +102,9 @@ class AppLockFlowCoordinator: CoordinatorProtocol {
            switch action {
            case .appUnlocked:
                actionsSubject.send(.unlockApp)
+            case .forceLogout:
+                userIndicatorController.submitIndicator(UserIndicator(type: .modal, title: L10n.commonSigningOut, persistent: true))
+                actionsSubject.send(.forceLogout)
            }
        }
        .store(in: &cancellables)
@@ -0,0 +1,260 @@
+//
+// Copyright 2023 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 SwiftState
+import SwiftUI
+
+enum AppLockSetupFlowCoordinatorAction: Equatable {
+    case complete
+}
+
+/// Coordinates the display of any screens used to configure the App Lock feature.
+class AppLockSetupFlowCoordinator: FlowCoordinatorProtocol {
+    private let presentingFlow: PresentationFlow
+    private let appLockService: AppLockServiceProtocol
+    private let navigationStackCoordinator: NavigationStackCoordinator
+    private let modalNavigationStackCoordinator = NavigationStackCoordinator()
+    
+    /// The presentation context of the flow.
+    enum PresentationFlow {
+        /// The flow is shown as for mandatory PIN creation in the authentication flow
+        case authentication
+        /// The flow is shown from the Settings screen.
+        case settings
+    }
+    
+    /// States the flow can find itself in
+    enum State: StateType {
+        /// The initial state, used before the flow starts
+        case initial
+        /// The unlock screen.
+        case unlock
+        /// The create PIN screen.
+        case createPIN
+        /// The allow biometrics screen.
+        case biometricsPrompt
+        /// The settings screen.
+        case settings
+        /// The flow is finished.
+        case complete
+    }
+
+    /// Events that can be triggered on the flow state machine
+    enum Event: EventType {
+        /// Start the flow.
+        case start
+        /// The user entered a PIN.
+        case pinEntered
+        /// The user completed the biometrics prompt.
+        case biometricsSet
+        /// The user wants to change their PIN.
+        case changePIN
+        /// The user wants to dismiss the flow.
+        case dismiss
+    }
+    
+    private let stateMachine: StateMachine<State, Event>
+    private var cancellables: Set<AnyCancellable> = []
+    
+    private let actionsSubject: PassthroughSubject<AppLockSetupFlowCoordinatorAction, Never> = .init()
+    var actions: AnyPublisher<AppLockSetupFlowCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(presentingFlow: PresentationFlow, appLockService: AppLockServiceProtocol, navigationStackCoordinator: NavigationStackCoordinator) {
+        self.presentingFlow = presentingFlow
+        self.appLockService = appLockService
+        self.navigationStackCoordinator = navigationStackCoordinator
+        
+        stateMachine = .init(state: .initial)
+        configureStateMachine()
+    }
+    
+    func start() {
+        stateMachine.tryEvent(.start)
+    }
+    
+    func handleAppRoute(_ appRoute: AppRoute, animated: Bool) {
+        // Deep links not supported.
+    }
+    
+    func clearRoute(animated: Bool) {
+        // Deep links not supported.
+    }
+    
+    // MARK: - Private
+    
+    private func configureStateMachine() {
+        stateMachine.addRouteMapping { [weak self] event, fromState, _ in
+            guard let self else { return nil }
+            
+            switch (event, fromState) {
+            case (.start, .initial):
+                if presentingFlow == .authentication { return .createPIN }
+                return appLockService.isEnabled ? .unlock : .createPIN
+            case (.pinEntered, .unlock):
+                return .settings
+            case (.pinEntered, .createPIN):
+                if presentingFlow == .authentication {
+                    return appLockService.biometryType != .none ? .biometricsPrompt : .complete
+                } else {
+                    return appLockService.biometricUnlockEnabled || appLockService.biometryType == .none ? .settings : .biometricsPrompt
+                }
+            case (.biometricsSet, .biometricsPrompt):
+                return presentingFlow == .settings ? .settings : .complete
+            case (.changePIN, .settings):
+                return .createPIN
+            case (.dismiss, _):
+                return .complete
+            default:
+                return nil
+            }
+        }
+        
+        stateMachine.addAnyHandler(.any => .any) { [weak self] context in
+            guard let self else { return }
+            
+            MXLog.info("Transitioning from `\(context.fromState)` to `\(context.toState)` with event `\(String(describing: context.event))`.")
+            switch (context.fromState, context.toState) {
+            case (.initial, .unlock):
+                showPINUnlock()
+            case (.initial, .createPIN):
+                showCreatePIN()
+            case (.unlock, .settings):
+                showSettings()
+            case (.createPIN, .biometricsPrompt):
+                showBiometricsPrompt()
+            case (.createPIN, .settings):
+                navigationStackCoordinator.setSheetCoordinator(nil)
+            case (.biometricsPrompt, .settings):
+                showSettings()
+            case (.settings, .createPIN):
+                showCreatePIN()
+            case (_, .complete):
+                complete(from: context.fromState)
+            default:
+                fatalError("Unhandled transition.")
+            }
+        }
+        
+        stateMachine.addErrorHandler { context in
+            fatalError("Unexpected transition from `\(context.fromState)` to `\(context.toState)` with event `\(String(describing: context.event))`.")
+        }
+    }
+
+    private func showCreatePIN() {
+        // Despite appLockService.isMandatory existing, we don't use that here,
+        // to allow for cancellation when changing the PIN code within settings.
+        let isMandatory = presentingFlow == .authentication
+        
+        let coordinator = AppLockSetupPINScreenCoordinator(parameters: .init(initialMode: .create,
+                                                                             isMandatory: isMandatory,
+                                                                             appLockService: appLockService))
+        coordinator.actions.sink { [weak self] action in
+            guard let self else { return }
+            switch action {
+            case .cancel:
+                stateMachine.tryEvent(.dismiss)
+            case .complete:
+                stateMachine.tryEvent(.pinEntered)
+            }
+        }
+        .store(in: &cancellables)
+        
+        if presentingFlow == .authentication {
+            navigationStackCoordinator.push(coordinator)
+        } else {
+            modalNavigationStackCoordinator.setRootCoordinator(coordinator)
+            navigationStackCoordinator.setSheetCoordinator(modalNavigationStackCoordinator)
+        }
+    }
+    
+    private func showBiometricsPrompt() {
+        let coordinator = AppLockSetupBiometricsScreenCoordinator(parameters: .init(appLockService: appLockService))
+        coordinator.actions.sink { [weak self] action in
+            guard let self else { return }
+            switch action {
+            case .continue:
+                stateMachine.tryEvent(.biometricsSet)
+            }
+        }
+        .store(in: &cancellables)
+        
+        if presentingFlow == .authentication {
+            navigationStackCoordinator.push(coordinator)
+        } else {
+            modalNavigationStackCoordinator.push(coordinator)
+        }
+    }
+    
+    private func showPINUnlock() {
+        let coordinator = AppLockSetupPINScreenCoordinator(parameters: .init(initialMode: .unlock,
+                                                                             isMandatory: false,
+                                                                             appLockService: appLockService))
+        coordinator.actions.sink { [weak self] action in
+            guard let self else { return }
+            switch action {
+            case .cancel:
+                stateMachine.tryEvent(.dismiss)
+            case .complete:
+                stateMachine.tryEvent(.pinEntered)
+            }
+        }
+        .store(in: &cancellables)
+        modalNavigationStackCoordinator.setRootCoordinator(coordinator)
+        navigationStackCoordinator.setSheetCoordinator(modalNavigationStackCoordinator)
+    }
+    
+    private func showSettings() {
+        let coordinator = AppLockSetupSettingsScreenCoordinator(parameters: .init(isMandatory: appLockService.isMandatory,
+                                                                                  appLockService: appLockService))
+        coordinator.actions.sink { [weak self] action in
+            guard let self else { return }
+            switch action {
+            case .changePINCode:
+                stateMachine.tryEvent(.changePIN)
+            case .appLockDisabled:
+                stateMachine.tryEvent(.dismiss)
+            }
+        }
+        .store(in: &cancellables)
+        
+        navigationStackCoordinator.push(coordinator, animated: false) { [weak self] in
+            self?.actionsSubject.send(.complete)
+        }
+        navigationStackCoordinator.setSheetCoordinator(nil)
+    }
+    
+    /// Tear down the flow for completion.
+    private func complete(from state: State) {
+        switch state {
+        case .initial, .complete: fatalError()
+        case .unlock:
+            navigationStackCoordinator.setSheetCoordinator(nil)
+            actionsSubject.send(.complete)
+        case .createPIN:
+            navigationStackCoordinator.setSheetCoordinator(nil)
+            actionsSubject.send(.complete)
+        case .biometricsPrompt:
+            navigationStackCoordinator.setSheetCoordinator(nil)
+            actionsSubject.send(.complete)
+        case .settings:
+            navigationStackCoordinator.pop()
+            actionsSubject.send(.complete)
+        }
+    }
+}