#1899, #1900, #1901 - Implement chat backup setting screens

2026-11-03 16:10:20 +00:00 · 2023-10-19 15:34:10 +03:00
parent 15b5b44422
commit c8b9d95122
70 changed files with 2293 additions and 48 deletions
@@ -0,0 +1,116 @@
+//
+// 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 SecureBackupScreenCoordinatorParameters {
+    let appSettings: AppSettings
+    let secureBackupController: SecureBackupControllerProtocol
+    weak var navigationStackCoordinator: NavigationStackCoordinator?
+    weak var userIndicatorController: UserIndicatorControllerProtocol?
+}
+
+enum SecureBackupScreenCoordinatorAction { }
+
+final class SecureBackupScreenCoordinator: CoordinatorProtocol {
+    private let parameters: SecureBackupScreenCoordinatorParameters
+    private var viewModel: SecureBackupScreenViewModelProtocol
+    private let actionsSubject: PassthroughSubject<SecureBackupScreenCoordinatorAction, Never> = .init()
+    private var cancellables = Set<AnyCancellable>()
+    
+    var actions: AnyPublisher<SecureBackupScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: SecureBackupScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = SecureBackupScreenViewModel(secureBackupController: parameters.secureBackupController,
+                                                userIndicatorController: parameters.userIndicatorController,
+                                                chatBackupDetailsURL: parameters.appSettings.chatBackupDetailsURL)
+    }
+    
+    func start() {
+        viewModel.actions.sink { [weak self] action in
+            guard let self else { return }
+            
+            switch action {
+            case .recoveryKey:
+                let navigationStackCoordinator = NavigationStackCoordinator()
+                let userIndicatorController = UserIndicatorController(rootCoordinator: navigationStackCoordinator)
+                
+                let recoveryKeyCoordinator = SecureBackupRecoveryKeyScreenCoordinator(parameters: .init(secureBackupController: parameters.secureBackupController,
+                                                                                                        userIndicatorController: userIndicatorController))
+                
+                recoveryKeyCoordinator.actions.sink { [weak self] action in
+                    guard let self else { return }
+                    
+                    parameters.navigationStackCoordinator?.setSheetCoordinator(nil)
+                    
+                    switch action {
+                    case .cancel:
+                        break
+                    case .recoverySetUp:
+                        showSuccessIndicator(title: L10n.screenRecoveryKeySetupSuccess)
+                    case .recoveryChanged:
+                        showSuccessIndicator(title: L10n.screenRecoveryKeyChangeSuccess)
+                    case .recoveryFixed:
+                        showSuccessIndicator(title: L10n.screenRecoveryKeyConfirmSuccess)
+                    }
+                }
+                .store(in: &cancellables)
+                
+                navigationStackCoordinator.setRootCoordinator(recoveryKeyCoordinator, animated: true)
+                
+                parameters.navigationStackCoordinator?.setSheetCoordinator(userIndicatorController)
+            case .keyBackup:
+                let navigationStackCoordinator = NavigationStackCoordinator()
+                let userIndicatorController = UserIndicatorController(rootCoordinator: navigationStackCoordinator)
+                
+                let keyBackupCoordinator = SecureBackupKeyBackupScreenCoordinator(parameters: .init(secureBackupController: parameters.secureBackupController,
+                                                                                                    userIndicatorController: userIndicatorController))
+                
+                keyBackupCoordinator.actions.sink { [weak self] action in
+                    switch action {
+                    case .done:
+                        self?.parameters.navigationStackCoordinator?.setSheetCoordinator(nil)
+                    }
+                }
+                .store(in: &cancellables)
+                
+                navigationStackCoordinator.setRootCoordinator(keyBackupCoordinator, animated: true)
+                
+                parameters.navigationStackCoordinator?.setSheetCoordinator(userIndicatorController)
+            }
+        }
+        .store(in: &cancellables)
+    }
+    
+    func toPresentable() -> AnyView {
+        AnyView(SecureBackupScreen(context: viewModel.context))
+    }
+    
+    // MARK: - Private
+    
+    private func showSuccessIndicator(title: String) {
+        parameters.userIndicatorController?.submitIndicator(.init(id: .init(),
+                                                                  type: .modal(progress: .none, interactiveDismissDisabled: false, allowsInteraction: false),
+                                                                  title: title,
+                                                                  iconName: "checkmark",
+                                                                  persistent: false))
+    }
+}
@@ -0,0 +1,38 @@
+//
+// 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 SecureBackupScreenViewModelAction {
+    case recoveryKey
+    case keyBackup
+}
+
+struct SecureBackupScreenViewState: BindableState {
+    let chatBackupDetailsURL: URL
+    var recoveryKeyState = SecureBackupRecoveryKeyState.unknown
+    var keyBackupState = SecureBackupKeyBackupState.unknown
+    var bindings = SecureBackupScreenViewStateBindings()
+}
+
+struct SecureBackupScreenViewStateBindings {
+    var alertInfo: AlertInfo<UUID>?
+}
+
+enum SecureBackupScreenViewAction {
+    case recoveryKey
+    case keyBackup
+}
@@ -0,0 +1,85 @@
+//
+// 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 SecureBackupScreenViewModelType = StateStoreViewModel<SecureBackupScreenViewState, SecureBackupScreenViewAction>
+
+class SecureBackupScreenViewModel: SecureBackupScreenViewModelType, SecureBackupScreenViewModelProtocol {
+    private let secureBackupController: SecureBackupControllerProtocol
+    private weak var userIndicatorController: UserIndicatorControllerProtocol?
+    
+    private var actionsSubject: PassthroughSubject<SecureBackupScreenViewModelAction, Never> = .init()
+    var actions: AnyPublisher<SecureBackupScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(secureBackupController: SecureBackupControllerProtocol,
+         userIndicatorController: UserIndicatorControllerProtocol?,
+         chatBackupDetailsURL: URL) {
+        self.secureBackupController = secureBackupController
+        self.userIndicatorController = userIndicatorController
+        
+        super.init(initialViewState: .init(chatBackupDetailsURL: chatBackupDetailsURL))
+        
+        secureBackupController.recoveryKeyState
+            .receive(on: DispatchQueue.main)
+            .weakAssign(to: \.state.recoveryKeyState, on: self)
+            .store(in: &cancellables)
+        
+        secureBackupController.keyBackupState
+            .receive(on: DispatchQueue.main)
+            .weakAssign(to: \.state.keyBackupState, on: self)
+            .store(in: &cancellables)
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: SecureBackupScreenViewAction) {
+        switch viewAction {
+        case .recoveryKey:
+            actionsSubject.send(.recoveryKey)
+        case .keyBackup:
+            switch secureBackupController.keyBackupState.value {
+            case .disabled:
+                enableKeyBackup()
+            case .enabled:
+                actionsSubject.send(.keyBackup)
+            default:
+                break
+            }
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func enableKeyBackup() {
+        Task {
+            let loadingIndicatorIdentifier = "SecureBackupScreenLoading"
+            userIndicatorController?.submitIndicator(.init(id: loadingIndicatorIdentifier, type: .modal, title: L10n.commonLoading, persistent: true))
+            switch await secureBackupController.enableBackup() {
+            case .success:
+                break
+            case .failure(let error):
+                MXLog.error("Failed enabling key backup with error: \(error)")
+                state.bindings.alertInfo = .init(id: .init())
+            }
+            
+            userIndicatorController?.retractIndicatorWithId(loadingIndicatorIdentifier)
+        }
+    }
+}
@@ -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 SecureBackupScreenViewModelProtocol {
+    var actions: AnyPublisher<SecureBackupScreenViewModelAction, Never> { get }
+    var context: SecureBackupScreenViewModelType.Context { get }
+}
@@ -0,0 +1,168 @@
+//
+// 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 Compound
+import SwiftUI
+
+struct SecureBackupScreen: View {
+    @ObservedObject var context: SecureBackupScreenViewModel.Context
+    
+    var body: some View {
+        Form {
+            if context.viewState.keyBackupState != .enabled {
+                keyBackupSection
+            } else {
+                keyBackupSection
+                recoveryKeySection
+            }
+        }
+        .compoundList()
+        .navigationTitle(L10n.commonChatBackup)
+        .navigationBarTitleDisplayMode(.inline)
+        .alert(item: $context.alertInfo)
+    }
+    
+    // MARK: - Private
+    
+    @ViewBuilder
+    private var keyBackupSection: some View {
+        Section {
+            ListRow(kind: .custom {
+                VStack(alignment: .leading, spacing: 2) {
+                    Text(L10n.screenChatBackupKeyBackupTitle)
+                        .font(.compound.bodyLGSemibold)
+                        .foregroundColor(.compound.textPrimary)
+                    
+                    Text(keyBackupDescriptionWithLearnMoreLink)
+                        .font(.compound.bodySM)
+                        .foregroundColor(.compound.textSecondary)
+                }
+                .padding(.horizontal, ListRowPadding.horizontal)
+                .padding(.vertical, ListRowPadding.vertical)
+                .accessibilityElement(children: .combine)
+            })
+            
+            keyBackupButton
+        }
+    }
+    
+    private var keyBackupDescriptionWithLearnMoreLink: AttributedString {
+        let linkPlaceholder = "{link}"
+        var description = AttributedString(L10n.screenChatBackupKeyBackupDescription(linkPlaceholder))
+        var linkString = AttributedString(L10n.actionLearnMore)
+        linkString.link = context.viewState.chatBackupDetailsURL
+        linkString.bold()
+        description.replace(linkPlaceholder, with: linkString)
+        return description
+    }
+    
+    @ViewBuilder
+    private var keyBackupButton: some View {
+        switch context.viewState.keyBackupState {
+        case .enabled, .disabling:
+            ListRow(label: .plain(title: L10n.screenChatBackupKeyBackupActionDisable, role: .destructive), kind: .navigationLink {
+                context.send(viewAction: .keyBackup)
+            })
+        case .disabled, .enabling:
+            ListRow(label: .plain(title: L10n.screenChatBackupKeyBackupActionEnable), kind: .navigationLink {
+                context.send(viewAction: .keyBackup)
+            })
+        default:
+            ListRow(label: .plain(title: L10n.commonLoading), details: .isWaiting(true), kind: .label)
+        }
+    }
+    
+    @ViewBuilder
+    private var recoveryKeySection: some View {
+        Section {
+            switch context.viewState.recoveryKeyState {
+            case .enabled:
+                ListRow(label: .plain(title: L10n.screenChatBackupRecoveryActionChange),
+                        kind: .navigationLink { context.send(viewAction: .recoveryKey) })
+            case .disabled:
+                ListRow(label: .plain(title: L10n.screenChatBackupRecoveryActionSetup),
+                        details: .icon(BadgeView(size: 10)),
+                        kind: .navigationLink { context.send(viewAction: .recoveryKey) })
+            case .incomplete:
+                ListRow(label: .plain(title: L10n.screenChatBackupRecoveryActionConfirm),
+                        kind: .navigationLink { context.send(viewAction: .recoveryKey) })
+            default:
+                ListRow(label: .plain(title: L10n.commonLoading), details: .isWaiting(true), kind: .label)
+            }
+        } footer: {
+            recoveryKeySectionFooter
+                .compoundFormSectionFooter()
+        }
+    }
+    
+    @ViewBuilder
+    private var recoveryKeySectionFooter: some View {
+        switch context.viewState.recoveryKeyState {
+        case .disabled:
+            Text(L10n.screenChatBackupRecoveryActionSetupDescription(InfoPlistReader.main.bundleDisplayName))
+        case .incomplete:
+            Text(L10n.screenChatBackupRecoveryActionConfirmDescription)
+        default:
+            EmptyView()
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct SecureBackupScreen_Previews: PreviewProvider, TestablePreview {
+    static let bothSetupViewModel = viewModel(keyBackupState: .enabled, recoveryKeyState: .enabled)
+    static let onlyKeyBackupSetUpViewModel = viewModel(keyBackupState: .enabled, recoveryKeyState: .disabled)
+    static let keyBackupDisabledViewModel = viewModel(keyBackupState: .disabled, recoveryKeyState: .disabled)
+    static let recoveryIncompleteViewModel = viewModel(keyBackupState: .enabled, recoveryKeyState: .incomplete)
+    
+    static var previews: some View {
+        Group {
+            NavigationStack {
+                SecureBackupScreen(context: bothSetupViewModel.context)
+            }
+            .previewDisplayName("Both setup")
+            
+            NavigationStack {
+                SecureBackupScreen(context: onlyKeyBackupSetUpViewModel.context)
+            }
+            .previewDisplayName("Only key backup setup")
+            
+            NavigationStack {
+                SecureBackupScreen(context: keyBackupDisabledViewModel.context)
+            }
+            .previewDisplayName("Key backup disabled")
+            
+            NavigationStack {
+                SecureBackupScreen(context: recoveryIncompleteViewModel.context)
+            }
+            .previewDisplayName("Recovery incomplete")
+        }
+        .snapshot(delay: 0.25)
+    }
+    
+    static func viewModel(keyBackupState: SecureBackupKeyBackupState,
+                          recoveryKeyState: SecureBackupRecoveryKeyState) -> SecureBackupScreenViewModelType {
+        let backupController = SecureBackupControllerMock()
+        backupController.underlyingKeyBackupState = CurrentValueSubject<SecureBackupKeyBackupState, Never>(keyBackupState).asCurrentValuePublisher()
+        backupController.underlyingRecoveryKeyState = CurrentValueSubject<SecureBackupRecoveryKeyState, Never>(recoveryKeyState).asCurrentValuePublisher()
+        
+        return SecureBackupScreenViewModel(secureBackupController: backupController,
+                                           userIndicatorController: nil,
+                                           chatBackupDetailsURL: .sharedPublicDirectory)
+    }
+}