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

2026-11-02 21:33:26 +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,74 @@
+//
+// 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 SecureBackupRecoveryKeyScreenCoordinatorParameters {
+    let secureBackupController: SecureBackupControllerProtocol
+    weak var userIndicatorController: UserIndicatorControllerProtocol?
+}
+
+enum SecureBackupRecoveryKeyScreenCoordinatorAction {
+    case cancel
+    case recoverySetUp
+    case recoveryChanged
+    case recoveryFixed
+}
+
+final class SecureBackupRecoveryKeyScreenCoordinator: CoordinatorProtocol {
+    private let parameters: SecureBackupRecoveryKeyScreenCoordinatorParameters
+    private var viewModel: SecureBackupRecoveryKeyScreenViewModelProtocol
+    private let actionsSubject: PassthroughSubject<SecureBackupRecoveryKeyScreenCoordinatorAction, Never> = .init()
+    private var cancellables = Set<AnyCancellable>()
+    
+    var actions: AnyPublisher<SecureBackupRecoveryKeyScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: SecureBackupRecoveryKeyScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = SecureBackupRecoveryKeyScreenViewModel(secureBackupController: parameters.secureBackupController,
+                                                           userIndicatorController: parameters.userIndicatorController)
+    }
+    
+    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 .cancel:
+                self.actionsSubject.send(.cancel)
+            case .done(let mode):
+                switch mode {
+                case .setupRecovery:
+                    self.actionsSubject.send(.recoverySetUp)
+                case .changeRecovery:
+                    self.actionsSubject.send(.recoveryChanged)
+                case .fixRecovery:
+                    self.actionsSubject.send(.recoveryFixed)
+                }
+            }
+        }
+        .store(in: &cancellables)
+    }
+    
+    func toPresentable() -> AnyView {
+        AnyView(SecureBackupRecoveryKeyScreen(context: viewModel.context))
+    }
+}
@@ -0,0 +1,84 @@
+//
+// 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 SecureBackupRecoveryKeyScreenViewModelAction {
+    case done(mode: SecureBackupRecoveryKeyScreenViewMode)
+    case cancel
+}
+
+enum SecureBackupRecoveryKeyScreenViewMode {
+    case setupRecovery
+    case changeRecovery
+    case fixRecovery
+}
+
+struct SecureBackupRecoveryKeyScreenViewState: BindableState {
+    let mode: SecureBackupRecoveryKeyScreenViewMode
+    
+    var recoveryKey: String?
+    var doneButtonEnabled = false
+    
+    var bindings: SecureBackupRecoveryKeyScreenViewBindings
+    
+    var title: String {
+        switch mode {
+        case .setupRecovery:
+            return recoveryKey == nil ? L10n.screenRecoveryKeySetupTitle : L10n.screenRecoveryKeySaveTitle
+        case .changeRecovery:
+            return recoveryKey == nil ? L10n.screenRecoveryKeyChangeTitle : L10n.screenRecoveryKeySaveTitle
+        case .fixRecovery:
+            return L10n.screenRecoveryKeyConfirmTitle
+        }
+    }
+    
+    var subtitle: String {
+        switch mode {
+        case .setupRecovery:
+            return recoveryKey == nil ? L10n.screenRecoveryKeySetupDescription : L10n.screenRecoveryKeySaveDescription
+        case .changeRecovery:
+            return recoveryKey == nil ? L10n.screenRecoveryKeyChangeDescription : L10n.screenRecoveryKeySaveDescription
+        case .fixRecovery:
+            return L10n.screenRecoveryKeyConfirmDescription
+        }
+    }
+    
+    var recoveryKeySubtitle: String {
+        switch mode {
+        case .setupRecovery:
+            return recoveryKey == nil ? L10n.screenRecoveryKeySetupGenerateKeyDescription : L10n.screenRecoveryKeySaveKeyDescription
+        case .changeRecovery:
+            return recoveryKey == nil ? L10n.screenRecoveryKeyChangeGenerateKeyDescription : L10n.screenRecoveryKeySaveKeyDescription
+        case .fixRecovery:
+            return L10n.screenRecoveryKeyConfirmKeyDescription
+        }
+    }
+}
+
+struct SecureBackupRecoveryKeyScreenViewBindings {
+    var confirmationRecoveryKey = ""
+    var alertInfo: AlertInfo<UUID>?
+}
+
+enum SecureBackupRecoveryKeyScreenViewAction {
+    case generateKey
+    case copyKey
+    case keySaved
+    case confirmKey
+    case done
+    case cancel
+}
@@ -0,0 +1,111 @@
+//
+// 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 SecureBackupRecoveryKeyScreenViewModelType = StateStoreViewModel<SecureBackupRecoveryKeyScreenViewState, SecureBackupRecoveryKeyScreenViewAction>
+
+class SecureBackupRecoveryKeyScreenViewModel: SecureBackupRecoveryKeyScreenViewModelType, SecureBackupRecoveryKeyScreenViewModelProtocol {
+    private let secureBackupController: SecureBackupControllerProtocol
+    private weak var userIndicatorController: UserIndicatorControllerProtocol?
+    
+    private var actionsSubject: PassthroughSubject<SecureBackupRecoveryKeyScreenViewModelAction, Never> = .init()
+    var actions: AnyPublisher<SecureBackupRecoveryKeyScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(secureBackupController: SecureBackupControllerProtocol, userIndicatorController: UserIndicatorControllerProtocol?) {
+        self.secureBackupController = secureBackupController
+        self.userIndicatorController = userIndicatorController
+        
+        super.init(initialViewState: .init(mode: secureBackupController.recoveryKeyState.value.viewMode, bindings: .init()))
+        
+        secureBackupController.recoveryKeyState
+            .receive(on: DispatchQueue.main)
+            .sink(receiveValue: { [weak userIndicatorController] state in
+                let loadingIndicatorIdentifier = "SecureBackupRecoveryKeyScreenLoading"
+                switch state {
+                case .settingUp:
+                    userIndicatorController?.submitIndicator(.init(id: loadingIndicatorIdentifier, type: .modal, title: L10n.commonLoading, persistent: true))
+                default:
+                    userIndicatorController?.retractIndicatorWithId(loadingIndicatorIdentifier)
+                }
+            })
+            .store(in: &cancellables)
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: SecureBackupRecoveryKeyScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .generateKey:
+            Task {
+                switch await secureBackupController.generateRecoveryKey() {
+                case .success(let key):
+                    state.recoveryKey = key
+                case .failure(let error):
+                    MXLog.error("Failed generating recovery key with error: \(error)")
+                    state.bindings.alertInfo = .init(id: .init())
+                }
+            }
+        case .copyKey:
+            UIPasteboard.general.string = state.recoveryKey
+            userIndicatorController?.submitIndicator(.init(title: "Copied recovery key"))
+            state.doneButtonEnabled = true
+        case .keySaved:
+            state.doneButtonEnabled = true
+        case .confirmKey:
+            Task {
+                switch await secureBackupController.confirmRecoveryKey(state.bindings.confirmationRecoveryKey) {
+                case .success:
+                    actionsSubject.send(.done(mode: context.viewState.mode))
+                case .failure(let error):
+                    MXLog.error("Failed confirming recovery key with error: \(error)")
+                    state.bindings.alertInfo = .init(id: .init())
+                }
+            }
+        case .cancel:
+            actionsSubject.send(.cancel)
+        case .done:
+            state.bindings.alertInfo = .init(id: .init(),
+                                             title: L10n.screenRecoveryKeySetupConfirmationTitle,
+                                             message: L10n.screenRecoveryKeySetupConfirmationDescription,
+                                             primaryButton: .init(title: L10n.actionCancel, role: .cancel, action: nil),
+                                             secondaryButton: .init(title: L10n.actionContinue, action: { [weak self] in
+                                                 guard let self else { return }
+                                                 actionsSubject.send(.done(mode: context.viewState.mode))
+                                             }))
+        }
+    }
+}
+
+extension SecureBackupRecoveryKeyState {
+    var viewMode: SecureBackupRecoveryKeyScreenViewMode {
+        switch self {
+        case .disabled:
+            return .setupRecovery
+        case .enabled:
+            return .changeRecovery
+        case .incomplete:
+            return .fixRecovery
+        default:
+            fatalError("Invalid recovery state")
+        }
+    }
+}
@@ -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 SecureBackupRecoveryKeyScreenViewModelProtocol {
+    var actions: AnyPublisher<SecureBackupRecoveryKeyScreenViewModelAction, Never> { get }
+    var context: SecureBackupRecoveryKeyScreenViewModelType.Context { get }
+}
@@ -0,0 +1,213 @@
+//
+// 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 SecureBackupRecoveryKeyScreen: View {
+    @ObservedObject var context: SecureBackupRecoveryKeyScreenViewModel.Context
+    
+    @ScaledMetric private var iconSize = 70
+    
+    var body: some View {
+        mainContent
+            .padding()
+            .interactiveDismissDisabled()
+            .toolbar { toolbar }
+            .toolbar(.visible, for: .navigationBar)
+            .background(Color.compound.bgCanvasDefault.ignoresSafeArea())
+            .alert(item: $context.alertInfo)
+    }
+    
+    @ViewBuilder
+    private var mainContent: some View {
+        VStack(spacing: 48) {
+            switch context.viewState.mode {
+            case .setupRecovery, .changeRecovery:
+                header
+                newRecoveryKeySection
+            case .fixRecovery:
+                header
+                confirmRecoveryKeySection
+            }
+        }
+    }
+    
+    @ToolbarContentBuilder
+    private var toolbar: some ToolbarContent {
+        if context.viewState.recoveryKey == nil {
+            ToolbarItem(placement: .cancellationAction) {
+                Button(L10n.actionCancel) {
+                    context.send(viewAction: .cancel)
+                }
+            }
+        }
+    }
+    
+    private var header: some View {
+        VStack(spacing: 16) {
+            HeroImage(image: Image(asset: Asset.Images.secureBackupOn))
+            
+            Text(context.viewState.title)
+                .foregroundColor(.compound.textPrimary)
+                .font(.compound.headingMDBold)
+                .multilineTextAlignment(.center)
+            
+            Text(context.viewState.subtitle)
+                .foregroundColor(.compound.textSecondary)
+                .font(.compound.bodyMD)
+                .multilineTextAlignment(.center)
+        }
+    }
+    
+    @ViewBuilder
+    private var newRecoveryKeySection: some View {
+        generateRecoveryKeySection
+        
+        Spacer()
+        
+        if let recoveryKey = context.viewState.recoveryKey {
+            ShareLink(item: recoveryKey) {
+                Label(L10n.screenRecoveryKeySaveAction, icon: \.download)
+            }
+            .buttonStyle(.compound(.primary))
+            .simultaneousGesture(TapGesture().onEnded { _ in
+                context.send(viewAction: .keySaved)
+            })
+        }
+        
+        Button {
+            context.send(viewAction: .done)
+        } label: {
+            Text(L10n.actionDone)
+        }
+        .buttonStyle(.compound(.primary))
+        .disabled(context.viewState.recoveryKey == nil || context.viewState.doneButtonEnabled == false)
+    }
+    
+    private var generateRecoveryKeySection: some View {
+        VStack(alignment: .leading) {
+            Text(L10n.commonRecoveryKey)
+                .foregroundColor(.compound.textPrimary)
+                .font(.compound.bodySM)
+         
+            HStack {
+                if context.viewState.recoveryKey == nil {
+                    Button(generateButtonTitle) {
+                        context.send(viewAction: .generateKey)
+                    }
+                    .font(.compound.bodyLGSemibold)
+                } else {
+                    HStack(alignment: .top) {
+                        Text(context.viewState.recoveryKey ?? "")
+                            .foregroundColor(.compound.textPrimary)
+                            .font(.compound.bodyLG)
+                        
+                        Spacer()
+                        
+                        Button {
+                            context.send(viewAction: .copyKey)
+                        } label: {
+                            Image(asset: Asset.Images.copy)
+                        }
+                        .tint(.compound.iconSecondary)
+                        .accessibilityLabel(L10n.actionCopy)
+                    }
+                }
+            }
+            .frame(maxWidth: .infinity)
+            .padding()
+            .background(Color.compound.bgSubtleSecondaryLevel0)
+            .clipShape(RoundedRectangle(cornerRadius: 8))
+            
+            HStack(alignment: .top) {
+                if context.viewState.recoveryKey == nil {
+                    CompoundIcon(\.info, size: .small, relativeTo: .compound.bodySM)
+                }
+                
+                Text(context.viewState.recoveryKeySubtitle)
+                    .foregroundColor(.compound.textSecondary)
+                    .font(.compound.bodySM)
+            }
+        }
+    }
+    
+    private var generateButtonTitle: String {
+        context.viewState.mode == .setupRecovery ? L10n.screenRecoveryKeySetupGenerateKey : L10n.screenRecoveryKeyChangeGenerateKey
+    }
+    
+    @ViewBuilder
+    private var confirmRecoveryKeySection: some View {
+        VStack(alignment: .leading) {
+            Text(L10n.commonRecoveryKey)
+                .foregroundColor(.compound.textPrimary)
+                .font(.compound.bodySM)
+            
+            TextField(L10n.screenRecoveryKeyConfirmKeyPlaceholder, text: $context.confirmationRecoveryKey, axis: .vertical)
+                .frame(maxWidth: .infinity)
+                .padding()
+                .background(Color.compound.bgSubtleSecondaryLevel0)
+                .clipShape(RoundedRectangle(cornerRadius: 8))
+            
+            Text(context.viewState.recoveryKeySubtitle)
+                .foregroundColor(.compound.textSecondary)
+                .font(.compound.bodySM)
+            
+            Spacer()
+            
+            Button {
+                context.send(viewAction: .confirmKey)
+            } label: {
+                Text(L10n.actionConfirm)
+            }
+            .buttonStyle(.compound(.primary))
+            .disabled(context.confirmationRecoveryKey.isEmpty)
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct SecureBackupRecoveryKeyScreen_Previews: PreviewProvider, TestablePreview {
+    static let setupViewModel = viewModel(recoveryKeyState: .enabled)
+    static let notSetUpViewModel = viewModel(recoveryKeyState: .disabled)
+    static let incompleteViewModel = viewModel(recoveryKeyState: .incomplete)
+    
+    static var previews: some View {
+        NavigationStack {
+            SecureBackupRecoveryKeyScreen(context: notSetUpViewModel.context)
+        }
+        .previewDisplayName("Not set up")
+        
+        NavigationStack {
+            SecureBackupRecoveryKeyScreen(context: setupViewModel.context)
+        }
+        .previewDisplayName("Set up")
+
+        NavigationStack {
+            SecureBackupRecoveryKeyScreen(context: incompleteViewModel.context)
+        }
+        .previewDisplayName("Incomplete")
+    }
+    
+    static func viewModel(recoveryKeyState: SecureBackupRecoveryKeyState) -> SecureBackupRecoveryKeyScreenViewModelType {
+        let backupController = SecureBackupControllerMock()
+        backupController.underlyingRecoveryKeyState = CurrentValueSubject<SecureBackupRecoveryKeyState, Never>(recoveryKeyState).asCurrentValuePublisher()
+        
+        return SecureBackupRecoveryKeyScreenViewModel(secureBackupController: backupController, userIndicatorController: nil)
+    }
+}