Add App Lock settings screen (#1917)

ElementX/Sources/Screens/AppLock/AppLockScreen/AppLockScreenCoordinator.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 AppLockScreenCoordinatorParameters {
+    /// The service used to unlock the app.
+    let appLockService: AppLockServiceProtocol
+}
+
+enum AppLockScreenCoordinatorAction {
+    /// The user has successfully unlocked the app.
+    case appUnlocked
+}
+
+final class AppLockScreenCoordinator: CoordinatorProtocol {
+    private let parameters: AppLockScreenCoordinatorParameters
+    private var viewModel: AppLockScreenViewModelProtocol
+    private let actionsSubject: PassthroughSubject<AppLockScreenCoordinatorAction, Never> = .init()
+    private var cancellables = Set<AnyCancellable>()
+    
+    var actions: AnyPublisher<AppLockScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: AppLockScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = AppLockScreenViewModel(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 .appUnlocked:
+                self.actionsSubject.send(.appUnlocked)
+            }
+        }
+        .store(in: &cancellables)
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(AppLockScreen(context: viewModel.context))
+    }
+}

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

@@ -0,0 +1,40 @@
+//
+// 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
+
+enum AppLockScreenViewModelAction {
+    /// The user has successfully unlocked the app.
+    case appUnlocked
+}
+
+struct AppLockScreenViewState: BindableState {
+    var bindings: AppLockScreenViewStateBindings
+}
+
+struct AppLockScreenViewStateBindings { }
+
+enum AppLockScreenViewAction: CustomStringConvertible {
+    /// Attempt to unlock the app with the supplied PIN code.
+    case submitPINCode(String)
+    
+    var description: String {
+        switch self {
+        case .submitPINCode:
+            return "submitPINCode"
+        }
+    }
+}

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

@@ -0,0 +1,51 @@
+//
+// 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 AppLockScreenViewModelType = StateStoreViewModel<AppLockScreenViewState, AppLockScreenViewAction>
+
+class AppLockScreenViewModel: AppLockScreenViewModelType, AppLockScreenViewModelProtocol {
+    private let appLockService: AppLockServiceProtocol
+    private var actionsSubject: PassthroughSubject<AppLockScreenViewModelAction, Never> = .init()
+    
+    var actions: AnyPublisher<AppLockScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(appLockService: AppLockServiceProtocol) {
+        self.appLockService = appLockService
+        
+        super.init(initialViewState: AppLockScreenViewState(bindings: .init()))
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: AppLockScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .submitPINCode(let pinCode):
+            guard appLockService.unlock(with: pinCode) else {
+                MXLog.warning("Invalid PIN code entered.")
+                // Indicate failure here.
+                return
+            }
+            actionsSubject.send(.appUnlocked)
+        }
+    }
+}

ElementX/Sources/Screens/AppLock/AppLockScreen/AppLockScreenViewModelProtocol.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 AppLockScreenViewModelProtocol {
+    var actions: AnyPublisher<AppLockScreenViewModelAction, Never> { get }
+    var context: AppLockScreenViewModelType.Context { get }
+}

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

@@ -0,0 +1,57 @@
+//
+// 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
+
+// This implementation is only for development purposes.
+
+struct AppLockScreen: View {
+    @ObservedObject var context: AppLockScreenViewModel.Context
+    
+    var body: some View {
+        FullscreenDialog {
+            VStack(spacing: 8) {
+                AuthenticationIconImage(image: Image(systemSymbol: .lock))
+                    .symbolVariant(.fill)
+                    .padding(.bottom, 8)
+                
+                Text(UntranslatedL10n.screenAppLockTitle(InfoPlistReader.main.bundleDisplayName))
+                    .font(.compound.headingMDBold)
+                    .multilineTextAlignment(.center)
+                    .foregroundColor(.compound.textPrimary)
+            }
+        } bottomContent: {
+            Button(UntranslatedL10n.commonUnlock) {
+                context.send(viewAction: .submitPINCode("0000"))
+            }
+            .buttonStyle(.compound(.primary))
+        }
+    }
+}
+
+// MARK: - Previews
+
+// Add TestablePreview conformance once we have designs.
+struct AppLockScreen_Previews: PreviewProvider {
+    static let viewModel = AppLockScreenViewModel(appLockService: AppLockServiceMock.mock())
+    
+    static var previews: some View {
+        NavigationStack {
+            AppLockScreen(context: viewModel.context)
+        }
+    }
+}

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