Onboarding flow coordinator and FTUE changes (#2578)

Fixes #2595, fixes #2594, fixes #2593, fixes #2592, fixes #2591
2026-11-02 21:33:26 +00:00 · 2024-03-21 14:01:23 +02:00
parent 9e6b6ba60a
commit a62c96f1c5
176 changed files with 1886 additions and 912 deletions
@@ -0,0 +1,70 @@
+//
+// 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.
+//
+
+// periphery:ignore:all - this is just a identityConfirmation remove this comment once generating the final file
+
+import Combine
+import SwiftUI
+
+struct IdentityConfirmationScreenCoordinatorParameters {
+    let userSession: UserSessionProtocol
+    let appSettings: AppSettings
+    let userIndicatorController: UserIndicatorControllerProtocol
+}
+
+enum IdentityConfirmationScreenCoordinatorAction {
+    case otherDevice
+    case recoveryKey
+}
+
+final class IdentityConfirmationScreenCoordinator: CoordinatorProtocol {
+    private let parameters: IdentityConfirmationScreenCoordinatorParameters
+    private let viewModel: IdentityConfirmationScreenViewModelProtocol
+    
+    private var cancellables = Set<AnyCancellable>()
+ 
+    private let actionsSubject: PassthroughSubject<IdentityConfirmationScreenCoordinatorAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<IdentityConfirmationScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: IdentityConfirmationScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = IdentityConfirmationScreenViewModel(userSession: parameters.userSession,
+                                                        appSettings: parameters.appSettings,
+                                                        userIndicatorController: parameters.userIndicatorController)
+    }
+    
+    func start() {
+        viewModel.actionsPublisher.sink { [weak self] action in
+            guard let self else { return }
+            
+            MXLog.info("Coordinator: received view model action: \(action)")
+            switch action {
+            case .otherDevice:
+                actionsSubject.send(.otherDevice)
+            case .recoveryKey:
+                actionsSubject.send(.recoveryKey)
+            }
+        }
+        .store(in: &cancellables)
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(IdentityConfirmationScreen(context: viewModel.context))
+    }
+}
@@ -0,0 +1,37 @@
+//
+// 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 IdentityConfirmationScreenViewModelAction {
+    case otherDevice
+    case recoveryKey
+}
+
+struct IdentityConfirmationScreenViewState: BindableState {
+    enum Mode {
+        case recoveryOnly
+        case recoveryAndVerification
+    }
+    
+    var mode = Mode.recoveryOnly
+    let learnMoreURL: URL
+}
+
+enum IdentityConfirmationScreenViewAction {
+    case otherDevice
+    case recoveryKey
+}
@@ -0,0 +1,95 @@
+//
+// 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 IdentityConfirmationScreenViewModelType = StateStoreViewModel<IdentityConfirmationScreenViewState, IdentityConfirmationScreenViewAction>
+
+class IdentityConfirmationScreenViewModel: IdentityConfirmationScreenViewModelType, IdentityConfirmationScreenViewModelProtocol {
+    private let userSession: UserSessionProtocol
+    private let userIndicatorController: UserIndicatorControllerProtocol
+    
+    private let actionsSubject: PassthroughSubject<IdentityConfirmationScreenViewModelAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<IdentityConfirmationScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(userSession: UserSessionProtocol, appSettings: AppSettings, userIndicatorController: UserIndicatorControllerProtocol) {
+        self.userSession = userSession
+        self.userIndicatorController = userIndicatorController
+        
+        super.init(initialViewState: IdentityConfirmationScreenViewState(learnMoreURL: appSettings.encryptionURL))
+        
+        userSession.sessionSecurityStatePublisher
+            .receive(on: DispatchQueue.main)
+            .sink { [weak self] state in
+                Task {
+                    await self?.updateWithSessionSecurityState(state)
+                }
+            }
+            .store(in: &cancellables)
+        
+        Task {
+            await updateWithSessionSecurityState(userSession.sessionSecurityStatePublisher.value)
+        }
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: IdentityConfirmationScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        switch viewAction {
+        case .otherDevice:
+            actionsSubject.send(.otherDevice)
+        case .recoveryKey:
+            actionsSubject.send(.recoveryKey)
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func updateWithSessionSecurityState(_ sessionSecurityState: SessionSecurityState) async {
+        if sessionSecurityState.verificationState == .unknown {
+            showLoadingIndicator()
+        } else {
+            hideLoadingIndicator()
+        }
+        
+        guard sessionSecurityState.verificationState == .unverified else {
+            return
+        }
+        
+        guard case let .success(isOnlyDeviceLeft) = await userSession.clientProxy.isOnlyDeviceLeft() else {
+            return
+        }
+        
+        state.mode = isOnlyDeviceLeft ? .recoveryOnly : .recoveryAndVerification
+    }
+    
+    private static let loadingIndicatorIdentifier = "\(IdentityConfirmationScreenViewModel.self)-Loading"
+    
+    private func showLoadingIndicator() {
+        userIndicatorController.submitIndicator(UserIndicator(id: Self.loadingIndicatorIdentifier,
+                                                              type: .modal,
+                                                              title: L10n.commonLoading,
+                                                              persistent: true))
+    }
+    
+    private func hideLoadingIndicator() {
+        userIndicatorController.retractIndicatorWithId(Self.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 IdentityConfirmationScreenViewModelProtocol {
+    var actionsPublisher: AnyPublisher<IdentityConfirmationScreenViewModelAction, Never> { get }
+    var context: IdentityConfirmationScreenViewModelType.Context { get }
+}
@@ -0,0 +1,107 @@
+//
+// 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 IdentityConfirmationScreen: View {
+    @ObservedObject var context: IdentityConfirmationScreenViewModel.Context
+    
+    var body: some View {
+        FullscreenDialog(topPadding: UIConstants.startScreenBreakerScreenTopPadding) {
+            screenHeader
+        } bottomContent: {
+            actionButtons
+        }
+        .background()
+        .environment(\.backgroundStyle, AnyShapeStyle(Color.compound.bgCanvasDefault))
+        .navigationBarHidden(true)
+        .navigationBarBackButtonHidden(true)
+        .interactiveDismissDisabled()
+    }
+    
+    // MARK: - Private
+    
+    @ViewBuilder
+    private var screenHeader: some View {
+        VStack(spacing: 0) {
+            HeroImage(icon: \.lockSolid)
+                .padding(.bottom, 16)
+            
+            Text(L10n.screenIdentityConfirmationTitle)
+                .font(.compound.headingMDBold)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.compound.textPrimary)
+                .padding(.bottom, 8)
+
+            Text(L10n.screenIdentityConfirmationSubtitle)
+                .font(.compound.bodyMD)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.compound.textSecondary)
+            
+            Button(L10n.actionLearnMore) {
+                UIApplication.shared.open(context.viewState.learnMoreURL)
+            }
+            .buttonStyle(.compound(.plain))
+            .padding(.top, 16)
+        }
+    }
+    
+    @ViewBuilder
+    private var actionButtons: some View {
+        VStack(spacing: 32) {
+            switch context.viewState.mode {
+            case .recoveryOnly:
+                Button(L10n.screenSessionVerificationEnterRecoveryKey) {
+                    context.send(viewAction: .recoveryKey)
+                }
+                .buttonStyle(.compound(.primary))
+                
+            case .recoveryAndVerification:
+                Button(L10n.actionStartVerification) {
+                    context.send(viewAction: .otherDevice)
+                }
+                .buttonStyle(.compound(.primary))
+                
+                Button(L10n.screenSessionVerificationEnterRecoveryKey) {
+                    context.send(viewAction: .recoveryKey)
+                }
+                .buttonStyle(.compound(.plain))
+            }
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct IdentityConfirmationScreen_Previews: PreviewProvider, TestablePreview {
+    static var previews: some View {
+        NavigationStack {
+            IdentityConfirmationScreen(context: viewModel.context)
+        }
+    }
+    
+    private static var viewModel: IdentityConfirmationScreenViewModel {
+        let userSession = MockUserSession(clientProxy: ClientProxyMock(.init(userID: "@user:example.com",
+                                                                             roomSummaryProvider: RoomSummaryProviderMock(.init(state: .loaded([]))))),
+                                          mediaProvider: MockMediaProvider(),
+                                          voiceMessageMediaManager: VoiceMessageMediaManagerMock())
+        
+        return IdentityConfirmationScreenViewModel(userSession: userSession,
+                                                   appSettings: ServiceLocator.shared.settings,
+                                                   userIndicatorController: ServiceLocator.shared.userIndicatorController)
+    }
+}