Add App Lock settings screen (#1917)

ElementX/Sources/Screens/AppLock/AppLockScreen/View/AppLockScreen.swift

@@ -47,8 +47,7 @@ struct AppLockScreen: View {
 
 // Add TestablePreview conformance once we have designs.
 struct AppLockScreen_Previews: PreviewProvider {
-    static let viewModel = AppLockScreenViewModel(appLockService: AppLockService(keychainController: KeychainControllerMock(),
-                                                                                 appSettings: ServiceLocator.shared.settings))
+    static let viewModel = AppLockScreenViewModel(appLockService: AppLockServiceMock.mock())
     
     static var previews: some View {
         NavigationStack {

ElementX/Sources/Screens/AppLock/AppLockSettingsScreen/AppLockSettingsScreenCoordinator.swift

@@ -0,0 +1,62 @@
+//
+// Copyright 2022 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 SwiftUI
+
+struct AppLockSettingsScreenCoordinatorParameters {
+    let appLockService: AppLockServiceProtocol
+}
+
+enum AppLockSettingsScreenCoordinatorAction {
+    case done
+}
+
+final class AppLockSettingsScreenCoordinator: CoordinatorProtocol {
+    private let parameters: AppLockSettingsScreenCoordinatorParameters
+    private var viewModel: AppLockSettingsScreenViewModelProtocol
+    private let actionsSubject: PassthroughSubject<AppLockSettingsScreenCoordinatorAction, Never> = .init()
+    private var cancellables = Set<AnyCancellable>()
+    
+    var actions: AnyPublisher<AppLockSettingsScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: AppLockSettingsScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = AppLockSettingsScreenViewModel(appLockService: parameters.appLockService)
+    }
+    
+    func start() {
+        viewModel.actions.sink { [weak self] action in
+            MXLog.info("Coordinator: received view model action: \(action)")
+            
+            guard let self else { return }
+            switch action {
+            case .changePINCode:
+                break
+            case .done:
+                self.actionsSubject.send(.done)
+            }
+        }
+        .store(in: &cancellables)
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(AppLockSettingsScreen(context: viewModel.context))
+    }
+}

ElementX/Sources/Screens/AppLock/AppLockSettingsScreen/AppLockSettingsScreenModels.swift

@@ -0,0 +1,66 @@
+//
+// Copyright 2022 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 LocalAuthentication
+
+enum AppLockSettingsScreenViewModelAction {
+    /// The user would like to enter new PIN code.
+    case changePINCode
+    case done
+}
+
+struct AppLockSettingsScreenViewState: BindableState {
+    let biometryType: LABiometryType
+    var bindings: AppLockSettingsScreenViewStateBindings
+    
+    var supportsBiometry: Bool { biometryType != .none }
+    var enableBiometryTitle: String {
+        switch biometryType {
+        case .none:
+            return L10n.commonError
+        case .touchID:
+            return UntranslatedL10n.screenAppLockSettingsEnableTouchIdIos
+        case .faceID:
+            return UntranslatedL10n.screenAppLockSettingsEnableFaceIdIos
+        // Requires Xcode 15:
+        // case .opticID:
+        //    UntranslatedL10n.screenAppLockSettingsEnableOpticIdIos
+        @unknown default:
+            return UntranslatedL10n.screenAppLockSettingsEnableBiometricUnlock
+        }
+    }
+}
+
+struct AppLockSettingsScreenViewStateBindings {
+    var enableBiometrics: Bool
+    var alertInfo: AlertInfo<AppLockSettingsScreenAlertType>?
+}
+
+enum AppLockSettingsScreenAlertType {
+    /// The alert shown to confirm the user would like to remove their PIN.
+    case confirmRemovePINCode
+}
+
+enum AppLockSettingsScreenViewAction {
+    /// The user would like to enter a new PIN code.
+    case changePINCode
+    /// The user would like to disable the App Lock feature.
+    case disable
+    /// The user has toggled the biometrics setting.
+    case enableBiometricsChanged
+    case done
+}

ElementX/Sources/Screens/AppLock/AppLockSettingsScreen/AppLockSettingsScreenViewModel.swift

@@ -0,0 +1,69 @@
+//
+// Copyright 2022 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 SwiftUI
+
+typealias AppLockSettingsScreenViewModelType = StateStoreViewModel<AppLockSettingsScreenViewState, AppLockSettingsScreenViewAction>
+
+class AppLockSettingsScreenViewModel: AppLockSettingsScreenViewModelType, AppLockSettingsScreenViewModelProtocol {
+    private let appLockService: AppLockServiceProtocol
+    private var actionsSubject: PassthroughSubject<AppLockSettingsScreenViewModelAction, Never> = .init()
+    
+    var actions: AnyPublisher<AppLockSettingsScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(appLockService: AppLockServiceProtocol) {
+        self.appLockService = appLockService
+        super.init(initialViewState: AppLockSettingsScreenViewState(biometryType: appLockService.biometryType,
+                                                                    bindings: .init(enableBiometrics: appLockService.biometricUnlockEnabled)))
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: AppLockSettingsScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .changePINCode:
+            actionsSubject.send(.changePINCode)
+        case .disable:
+            showRemovePINAlert()
+        case .enableBiometricsChanged:
+            appLockService.biometricUnlockEnabled = state.bindings.enableBiometrics
+        case .done:
+            actionsSubject.send(.done)
+        }
+    }
+    
+    // MARK: - Private
+    
+    /// Shows a confirmation alert to the user before removing their PIN code.
+    private func showRemovePINAlert() {
+        state.bindings.alertInfo = .init(id: .confirmRemovePINCode,
+                                         title: UntranslatedL10n.screenAppLockSettingsRemovePinAlertTitle,
+                                         message: UntranslatedL10n.screenAppLockSettingsRemovePinAlertMessage,
+                                         primaryButton: .init(title: L10n.actionYes) { self.completeRemovePIN() },
+                                         secondaryButton: .init(title: L10n.actionCancel, role: .cancel, action: nil))
+    }
+    
+    /// Removes the user's PIN code, disabling the App Lock feature.
+    private func completeRemovePIN() {
+        appLockService.disable()
+        actionsSubject.send(.done)
+    }
+}

ElementX/Sources/Screens/AppLock/AppLockSettingsScreen/AppLockSettingsScreenViewModelProtocol.swift

@@ -0,0 +1,23 @@
+//
+// Copyright 2022 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
+
+@MainActor
+protocol AppLockSettingsScreenViewModelProtocol {
+    var actions: AnyPublisher<AppLockSettingsScreenViewModelAction, Never> { get }
+    var context: AppLockSettingsScreenViewModelType.Context { get }
+}

ElementX/Sources/Screens/AppLock/AppLockSettingsScreen/View/AppLockSettingsScreen.swift

@@ -0,0 +1,72 @@
+//
+// Copyright 2022 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 Compound
+import SwiftUI
+
+struct AppLockSettingsScreen: View {
+    @ObservedObject var context: AppLockSettingsScreenViewModel.Context
+    
+    var body: some View {
+        Form {
+            Section {
+                ListRow(label: .plain(title: UntranslatedL10n.screenAppLockSettingsChangePin),
+                        kind: .button { context.send(viewAction: .changePINCode) })
+                ListRow(label: .plain(title: UntranslatedL10n.screenAppLockSettingsRemovePin, role: .destructive),
+                        kind: .button { context.send(viewAction: .disable) })
+            }
+            
+            if context.viewState.supportsBiometry {
+                Section {
+                    ListRow(label: .plain(title: context.viewState.enableBiometryTitle),
+                            kind: .toggle($context.enableBiometrics))
+                        .onChange(of: context.enableBiometrics) { _ in
+                            context.send(viewAction: .enableBiometricsChanged)
+                        }
+                }
+            }
+        }
+        .compoundList()
+        .navigationTitle(UntranslatedL10n.commonScreenLock)
+        .navigationBarTitleDisplayMode(.inline)
+        .alert(item: $context.alertInfo)
+    }
+}
+
+// MARK: - Previews
+
+struct AppLockSettingsScreen_Previews: PreviewProvider, TestablePreview {
+    static let faceIDViewModel = AppLockSettingsScreenViewModel(appLockService: AppLockServiceMock.mock(biometryType: .faceID))
+    static let touchIDViewModel = AppLockSettingsScreenViewModel(appLockService: AppLockServiceMock.mock(biometryType: .touchID))
+    static let biometricsUnavailableViewModel = AppLockSettingsScreenViewModel(appLockService: AppLockServiceMock.mock(biometryType: .none))
+    
+    static var previews: some View {
+        NavigationStack {
+            AppLockSettingsScreen(context: faceIDViewModel.context)
+        }
+        .previewDisplayName("Face ID")
+        
+        NavigationStack {
+            AppLockSettingsScreen(context: touchIDViewModel.context)
+        }
+        .previewDisplayName("Touch ID")
+        
+        NavigationStack {
+            AppLockSettingsScreen(context: biometricsUnavailableViewModel.context)
+        }
+        .previewDisplayName("No Biometrics")
+    }
+}

ElementX/Sources/Screens/Settings/SettingsScreen/SettingsScreenCoordinator.swift

@@ -21,6 +21,7 @@ struct SettingsScreenCoordinatorParameters {
     weak var navigationStackCoordinator: NavigationStackCoordinator?
     weak var userIndicatorController: UserIndicatorControllerProtocol?
     let userSession: UserSessionProtocol
+    let appLockService: AppLockServiceProtocol
     let bugReportService: BugReportServiceProtocol
     let notificationSettings: NotificationSettingsProxyProtocol
     let appSettings: AppSettings
@@ -48,7 +49,7 @@ final class SettingsScreenCoordinator: CoordinatorProtocol {
     init(parameters: SettingsScreenCoordinatorParameters) {
         self.parameters = parameters
         
-        viewModel = SettingsScreenViewModel(userSession: parameters.userSession, appSettings: ServiceLocator.shared.settings)
+        viewModel = SettingsScreenViewModel(userSession: parameters.userSession, appSettings: parameters.appSettings)
         
         viewModel.actions
             .sink { [weak self] action in
@@ -63,6 +64,8 @@ final class SettingsScreenCoordinator: CoordinatorProtocol {
                     presentAccountProfileURL()
                 case .analytics:
                     presentAnalyticsScreen()
+                case .appLock:
+                    presentAppLockSettingsScreen()
                 case .reportBug:
                     presentBugReportScreen()
                 case .about:
@@ -133,11 +136,16 @@ final class SettingsScreenCoordinator: CoordinatorProtocol {
     }
     
     private func presentAnalyticsScreen() {
-        let coordinator = AnalyticsSettingsScreenCoordinator(parameters: .init(appSettings: ServiceLocator.shared.settings,
+        let coordinator = AnalyticsSettingsScreenCoordinator(parameters: .init(appSettings: parameters.appSettings,
                                                                                analytics: ServiceLocator.shared.analytics))
         parameters.navigationStackCoordinator?.push(coordinator)
     }
     
+    private func presentAppLockSettingsScreen() {
+        let coordinator = AppLockSettingsScreenCoordinator(parameters: .init(appLockService: parameters.appLockService))
+        parameters.navigationStackCoordinator?.push(coordinator)
+    }
+    
     private func presentBugReportScreen() {
         let params = BugReportScreenCoordinatorParameters(bugReportService: parameters.bugReportService,
                                                           userID: parameters.userSession.userID,

ElementX/Sources/Screens/Settings/SettingsScreen/SettingsScreenModels.swift

@@ -22,6 +22,7 @@ enum SettingsScreenViewModelAction {
     case userDetails
     case accountProfile
     case analytics
+    case appLock
     case reportBug
     case about
     case sessionVerification
@@ -40,6 +41,7 @@ struct SettingsScreenViewState: BindableState {
     var userAvatarURL: URL?
     var userDisplayName: String?
     var showSessionVerificationSection: Bool
+    var showAppLockSettings: Bool
     var showDeveloperOptions: Bool
     
     /// The presentation anchor used to display the OIDC account URL.
@@ -51,6 +53,7 @@ enum SettingsScreenViewAction {
     case userDetails
     case accountProfile
     case analytics
+    case appLock
     case reportBug
     case about
     case sessionVerification

ElementX/Sources/Screens/Settings/SettingsScreen/SettingsScreenViewModel.swift

@@ -43,6 +43,7 @@ class SettingsScreenViewModel: SettingsScreenViewModelType, SettingsScreenViewMo
                                            accountProfileURL: userSession.clientProxy.accountURL(action: .profile),
                                            accountSessionsListURL: userSession.clientProxy.accountURL(action: .sessionsList),
                                            showSessionVerificationSection: showSessionVerificationSection,
+                                           showAppLockSettings: appSettings.appLockFlowEnabled,
                                            showDeveloperOptions: appSettings.canShowDeveloperOptions),
                    imageProvider: userSession.mediaProvider)
         
@@ -55,6 +56,10 @@ class SettingsScreenViewModel: SettingsScreenViewModelType, SettingsScreenViewMo
             .receive(on: DispatchQueue.main)
             .weakAssign(to: \.state.userDisplayName, on: self)
             .store(in: &cancellables)
+        
+        appSettings.$appLockFlowEnabled
+            .weakAssign(to: \.state.showAppLockSettings, on: self)
+            .store(in: &cancellables)
                 
         Task {
             await userSession.clientProxy.loadUserAvatarURL()
@@ -86,6 +91,8 @@ class SettingsScreenViewModel: SettingsScreenViewModelType, SettingsScreenViewMo
             actionsSubject.send(.accountProfile)
         case .analytics:
             actionsSubject.send(.analytics)
+        case .appLock:
+            actionsSubject.send(.appLock)
         case .reportBug:
             actionsSubject.send(.reportBug)
         case .about:

ElementX/Sources/Screens/Settings/SettingsScreen/View/SettingsScreen.swift

@@ -118,6 +118,15 @@ struct SettingsScreen: View {
                     })
                     .accessibilityIdentifier(A11yIdentifiers.settingsScreen.analytics)
             
+            if context.viewState.showAppLockSettings {
+                ListRow(label: .default(title: UntranslatedL10n.commonScreenLock,
+                                        systemIcon: .lock),
+                        kind: .navigationLink {
+                            context.send(viewAction: .appLock)
+                        })
+                        .accessibilityIdentifier(A11yIdentifiers.settingsScreen.analytics)
+            }
+            
             ListRow(label: .default(title: L10n.commonReportABug,
                                     systemIcon: .ladybug),
                     kind: .navigationLink {