ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-03 16:10:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Show recovery instead of verification if this is the last session and recovery is set up

Browse Source 
* Show recovery instead of verification if this is the last session and recovery is set up

* Rename `recoveryKeyState` to `recoveryState`

* Remove duplicates on session security state changes.

* Fix missing "Save recovery key" button

* Fix unit tests

* Rename `isLastDevice` to `isOnlyDeviceLeft`

* Address PR comments
This commit is contained in:
Stefan Ceriu
2024-02-16 11:38:49 +02:00
committed by GitHub
parent e0c9f43026
commit db05540cc5
23 changed files with 255 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Screens/HomeScreen/HomeScreenModels.swift
+9 -21
View File
@@ -75,33 +75,21 @@ enum HomeScreenRoomListMode: CustomStringConvertible {
}
}
enum SecurityBannerMode {
case none
case dismissed
case sessionVerification
case recoveryKeyConfirmation
}
struct HomeScreenViewState: BindableState {
let userID: String
var userDisplayName: String?
var userAvatarURL: URL?
var isSessionVerified: Bool?
var hasSessionVerificationBannerBeenDismissed = false
var showSessionVerificationBanner: Bool {
guard let isSessionVerified else {
return false
}
var securityBannerMode = SecurityBannerMode.none
var requiresExtraAccountSetup = false
return !isSessionVerified && !hasSessionVerificationBannerBeenDismissed
}
var requiresSecureBackupSetup = false
var needsRecoveryKeyConfirmation = false
var hasRecoveryKeyConfirmationBannerBeenDismissed = false
var showRecoveryKeyConfirmationBanner: Bool {
guard let isSessionVerified else {
return false
}
return isSessionVerified && needsRecoveryKeyConfirmation && !hasRecoveryKeyConfirmationBannerBeenDismissed
}
var rooms: [HomeScreenRoom] = []
var roomListMode: HomeScreenRoomListMode = .skeletons
ElementX/Sources/Screens/HomeScreen/HomeScreenViewModel.swift
+28 -13
View File
@@ -61,20 +61,35 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
.weakAssign(to: \.state.userDisplayName, on: self)
.store(in: &cancellables)
userSession.sessionVerificationState
userSession.sessionSecurityStatePublisher
.receive(on: DispatchQueue.main)
.weakAssign(to: \.state.isSessionVerified, on: self)
.store(in: &cancellables)
userSession.clientProxy.secureBackupController.recoveryKeyState
.receive(on: DispatchQueue.main)
.sink { [weak self] recoveryKeyState in
.sink { [weak self] securityState in
guard let self else { return }
let requiresSecureBackupSetup = recoveryKeyState == .disabled || recoveryKeyState == .incomplete
state.requiresSecureBackupSetup = requiresSecureBackupSetup
state.needsRecoveryKeyConfirmation = recoveryKeyState == .incomplete
switch (securityState.verificationState, securityState.recoveryState) {
case (.unverified, _):
state.requiresExtraAccountSetup = true
if state.securityBannerMode != .dismissed {
state.securityBannerMode = .sessionVerification
}
case (.unverifiedLastSession, .incomplete):
state.requiresExtraAccountSetup = true
if state.securityBannerMode != .dismissed {
state.securityBannerMode = .recoveryKeyConfirmation
}
case (.verified, .disabled):
state.requiresExtraAccountSetup = true
state.securityBannerMode = .none
case (.verified, .incomplete):
state.requiresExtraAccountSetup = true
if state.securityBannerMode != .dismissed {
state.securityBannerMode = .recoveryKeyConfirmation
}
default:
state.securityBannerMode = .none
state.requiresExtraAccountSetup = false
}
}
.store(in: &cancellables)
@@ -149,9 +164,9 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
case .confirmRecoveryKey:
actionsSubject.send(.presentSecureBackupSettings)
case .skipSessionVerification:
state.hasSessionVerificationBannerBeenDismissed = true
state.securityBannerMode = .dismissed
case .skipRecoveryKeyConfirmation:
state.hasRecoveryKeyConfirmationBannerBeenDismissed = true
state.securityBannerMode = .dismissed
case .updateVisibleItemRange(let range, let isScrolling):
visibleItemRangePublisher.send((range, isScrolling))
case .startChat:
ElementX/Sources/Screens/HomeScreen/View/HomeScreenContent.swift
+5 -2
View File
@@ -116,10 +116,13 @@ struct HomeScreenContent: View {
filters
}
if context.viewState.showSessionVerificationBanner {
switch context.viewState.securityBannerMode {
case .sessionVerification:
HomeScreenSessionVerificationBanner(context: context)
} else if context.viewState.showRecoveryKeyConfirmationBanner {
case .recoveryKeyConfirmation:
HomeScreenRecoveryKeyConfirmationBanner(context: context)
default:
EmptyView()
}
if context.viewState.hasPendingInvitations, !context.isSearchFieldFocused {
ElementX/Sources/Screens/HomeScreen/View/HomeScreenUserMenuButton.swift
+2 -2
View File
@@ -29,7 +29,7 @@ struct HomeScreenUserMenuButton: View {
Label {
Text(L10n.commonSettings)
} icon: {
if context.viewState.requiresSecureBackupSetup, context.viewState.isSessionVerified == true {
if context.viewState.requiresExtraAccountSetup {
CompoundIcon(asset: Asset.Images.settingsIconWithBadge)
} else {
CompoundIcon(\.settings)
@@ -50,7 +50,7 @@ struct HomeScreenUserMenuButton: View {
avatarSize: .user(on: .home),
imageProvider: context.imageProvider)
.accessibilityIdentifier(A11yIdentifiers.homeScreen.userAvatar)
.overlayBadge(10, isBadged: context.viewState.requiresSecureBackupSetup && context.viewState.isSessionVerified == true)
.overlayBadge(10, isBadged: context.viewState.requiresExtraAccountSetup)
.compositingGroup()
}
.accessibilityLabel(L10n.a11yUserMenu)
ElementX/Sources/Screens/SecureBackup/SecureBackupRecoveryKeyScreen/SecureBackupRecoveryKeyScreenViewModel.swift
+3 -3
View File
@@ -32,9 +32,9 @@ class SecureBackupRecoveryKeyScreenViewModel: SecureBackupRecoveryKeyScreenViewM
self.secureBackupController = secureBackupController
self.userIndicatorController = userIndicatorController
super.init(initialViewState: .init(mode: secureBackupController.recoveryKeyState.value.viewMode, bindings: .init()))
super.init(initialViewState: .init(mode: secureBackupController.recoveryState.value.viewMode, bindings: .init()))
secureBackupController.recoveryKeyState
secureBackupController.recoveryState
.receive(on: DispatchQueue.main)
.sink(receiveValue: { [weak userIndicatorController] state in
let loadingIndicatorIdentifier = "SecureBackupRecoveryKeyScreenLoading"
@@ -100,7 +100,7 @@ class SecureBackupRecoveryKeyScreenViewModel: SecureBackupRecoveryKeyScreenViewM
}
}
extension SecureBackupRecoveryKeyState {
extension SecureBackupRecoveryState {
var viewMode: SecureBackupRecoveryKeyScreenViewMode {
switch self {
case .disabled:
ElementX/Sources/Screens/SecureBackup/SecureBackupRecoveryKeyScreen/View/SecureBackupRecoveryKeyScreen.swift
+19 -13
View File
@@ -65,6 +65,20 @@ struct SecureBackupRecoveryKeyScreen: View {
private var footer: some View {
switch context.viewState.mode {
case .setupRecovery, .changeRecovery:
recoveryCreatedActionButtons
case .fixRecovery:
Button {
context.send(viewAction: .confirmKey)
} label: {
Text(L10n.actionConfirm)
}
.buttonStyle(.compound(.primary))
.disabled(context.confirmationRecoveryKey.isEmpty)
}
}
private var recoveryCreatedActionButtons: some View {
VStack(spacing: 8.0) {
if let recoveryKey = context.viewState.recoveryKey {
ShareLink(item: recoveryKey) {
Label(L10n.screenRecoveryKeySaveAction, icon: \.download)
@@ -82,14 +96,6 @@ struct SecureBackupRecoveryKeyScreen: View {
}
.buttonStyle(.compound(.primary))
.disabled(context.viewState.recoveryKey == nil || context.viewState.doneButtonEnabled == false)
case .fixRecovery:
Button {
context.send(viewAction: .confirmKey)
} label: {
Text(L10n.actionConfirm)
}
.buttonStyle(.compound(.primary))
.disabled(context.confirmationRecoveryKey.isEmpty)
}
}
@@ -204,9 +210,9 @@ struct SecureBackupRecoveryKeyScreen: View {
// 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 let setupViewModel = viewModel(recoveryState: .enabled)
static let notSetUpViewModel = viewModel(recoveryState: .disabled)
static let incompleteViewModel = viewModel(recoveryState: .incomplete)
static var previews: some View {
NavigationStack {
@@ -225,9 +231,9 @@ struct SecureBackupRecoveryKeyScreen_Previews: PreviewProvider, TestablePreview
.previewDisplayName("Incomplete")
}
static func viewModel(recoveryKeyState: SecureBackupRecoveryKeyState) -> SecureBackupRecoveryKeyScreenViewModelType {
static func viewModel(recoveryState: SecureBackupRecoveryState) -> SecureBackupRecoveryKeyScreenViewModelType {
let backupController = SecureBackupControllerMock()
backupController.underlyingRecoveryKeyState = CurrentValueSubject<SecureBackupRecoveryKeyState, Never>(recoveryKeyState).asCurrentValuePublisher()
backupController.underlyingRecoveryState = CurrentValueSubject<SecureBackupRecoveryState, Never>(recoveryState).asCurrentValuePublisher()
return SecureBackupRecoveryKeyScreenViewModel(secureBackupController: backupController, userIndicatorController: UserIndicatorControllerMock())
}
ElementX/Sources/Screens/SecureBackup/SecureBackupScreen/SecureBackupScreenModels.swift
+1 -1
View File
@@ -23,7 +23,7 @@ enum SecureBackupScreenViewModelAction {
struct SecureBackupScreenViewState: BindableState {
let chatBackupDetailsURL: URL
var recoveryKeyState = SecureBackupRecoveryKeyState.unknown
var recoveryState = SecureBackupRecoveryState.unknown
var keyBackupState = SecureBackupKeyBackupState.unknown
var bindings = SecureBackupScreenViewStateBindings()
}
ElementX/Sources/Screens/SecureBackup/SecureBackupScreen/SecureBackupScreenViewModel.swift
+2 -2
View File
@@ -36,9 +36,9 @@ class SecureBackupScreenViewModel: SecureBackupScreenViewModelType, SecureBackup
super.init(initialViewState: .init(chatBackupDetailsURL: chatBackupDetailsURL))
secureBackupController.recoveryKeyState
secureBackupController.recoveryState
.receive(on: DispatchQueue.main)
.weakAssign(to: \.state.recoveryKeyState, on: self)
.weakAssign(to: \.state.recoveryState, on: self)
.store(in: &cancellables)
secureBackupController.keyBackupState
ElementX/Sources/Screens/SecureBackup/SecureBackupScreen/View/SecureBackupScreen.swift
+9 -9
View File
@@ -25,7 +25,7 @@ struct SecureBackupScreen: View {
Form {
// Show recovery options for confirming the recovery key and
// getting access to secrets and implicitly the key backup
if context.viewState.recoveryKeyState == .incomplete {
if context.viewState.recoveryState == .incomplete {
recoveryKeySection
} else {
keyBackupSection
@@ -93,7 +93,7 @@ struct SecureBackupScreen: View {
@ViewBuilder
private var recoveryKeySection: some View {
Section {
switch context.viewState.recoveryKeyState {
switch context.viewState.recoveryState {
case .enabled:
ListRow(label: .plain(title: L10n.screenChatBackupRecoveryActionChange),
kind: .navigationLink { context.send(viewAction: .recoveryKey) })
@@ -116,7 +116,7 @@ struct SecureBackupScreen: View {
@ViewBuilder
private var recoveryKeySectionFooter: some View {
switch context.viewState.recoveryKeyState {
switch context.viewState.recoveryState {
case .disabled:
Text(L10n.screenChatBackupRecoveryActionSetupDescription(InfoPlistReader.main.bundleDisplayName))
case .incomplete:
@@ -130,10 +130,10 @@ struct SecureBackupScreen: View {
// 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: .unknown, recoveryKeyState: .disabled)
static let recoveryIncompleteViewModel = viewModel(keyBackupState: .enabled, recoveryKeyState: .incomplete)
static let bothSetupViewModel = viewModel(keyBackupState: .enabled, recoveryState: .enabled)
static let onlyKeyBackupSetUpViewModel = viewModel(keyBackupState: .enabled, recoveryState: .disabled)
static let keyBackupDisabledViewModel = viewModel(keyBackupState: .unknown, recoveryState: .disabled)
static let recoveryIncompleteViewModel = viewModel(keyBackupState: .enabled, recoveryState: .incomplete)
static var previews: some View {
Group {
@@ -161,10 +161,10 @@ struct SecureBackupScreen_Previews: PreviewProvider, TestablePreview {
}
static func viewModel(keyBackupState: SecureBackupKeyBackupState,
recoveryKeyState: SecureBackupRecoveryKeyState) -> SecureBackupScreenViewModelType {
recoveryState: SecureBackupRecoveryState) -> SecureBackupScreenViewModelType {
let backupController = SecureBackupControllerMock()
backupController.underlyingKeyBackupState = CurrentValueSubject<SecureBackupKeyBackupState, Never>(keyBackupState).asCurrentValuePublisher()
backupController.underlyingRecoveryKeyState = CurrentValueSubject<SecureBackupRecoveryKeyState, Never>(recoveryKeyState).asCurrentValuePublisher()
backupController.underlyingRecoveryState = CurrentValueSubject<SecureBackupRecoveryState, Never>(recoveryState).asCurrentValuePublisher()
return SecureBackupScreenViewModel(secureBackupController: backupController,
userIndicatorController: UserIndicatorControllerMock(),
ElementX/Sources/Screens/Settings/SettingsScreen/SettingsScreenModels.swift
+9 -2
View File
@@ -34,6 +34,12 @@ enum SettingsScreenViewModelAction {
case logout
}
enum SettingsScreenSecuritySectionMode {
case none
case sessionVerification
case secureBackup
}
struct SettingsScreenViewState: BindableState {
var deviceID: String?
var userID: String
@@ -41,9 +47,10 @@ struct SettingsScreenViewState: BindableState {
var accountSessionsListURL: URL?
var userAvatarURL: URL?
var userDisplayName: String?
var isSessionVerified: Bool?
var showSecureBackupBadge = false
var showDeveloperOptions: Bool
var securitySectionMode = SettingsScreenSecuritySectionMode.none
var showSecuritySectionBadge = false
}
enum SettingsScreenViewAction {
ElementX/Sources/Screens/Settings/SettingsScreen/SettingsScreenViewModel.swift
+22 -8
View File
@@ -44,17 +44,31 @@ class SettingsScreenViewModel: SettingsScreenViewModelType, SettingsScreenViewMo
.weakAssign(to: \.state.userDisplayName, on: self)
.store(in: &cancellables)
userSession.sessionVerificationState
userSession.sessionSecurityStatePublisher
.receive(on: DispatchQueue.main)
.weakAssign(to: \.state.isSessionVerified, on: self)
.store(in: &cancellables)
userSession.clientProxy.secureBackupController.recoveryKeyState
.receive(on: DispatchQueue.main)
.sink { [weak self] state in
.sink { [weak self] securityState in
guard let self else { return }
self.state.showSecureBackupBadge = (state == .incomplete || state == .disabled)
switch (securityState.verificationState, securityState.recoveryState) {
case (.unverified, _):
state.showSecuritySectionBadge = true
state.securitySectionMode = .sessionVerification
case (.unverifiedLastSession, .incomplete):
state.showSecuritySectionBadge = true
state.securitySectionMode = .secureBackup
case (.verified, .disabled):
state.showSecuritySectionBadge = true
state.securitySectionMode = .secureBackup
case (.verified, .incomplete):
state.showSecuritySectionBadge = true
state.securitySectionMode = .secureBackup
case (.unknown, _):
state.showSecuritySectionBadge = false
state.securitySectionMode = .none
default:
state.showSecuritySectionBadge = false
state.securitySectionMode = .secureBackup
}
}
.store(in: &cancellables)
ElementX/Sources/Screens/Settings/SettingsScreen/View/SettingsScreen.swift
+16 -14
View File
@@ -80,18 +80,20 @@ struct SettingsScreen: View {
@ViewBuilder
private var accountSecuritySection: some View {
Section {
if let isSessionVerified = context.viewState.isSessionVerified {
if !isSessionVerified {
ListRow(label: .default(title: L10n.actionCompleteVerification,
icon: \.checkCircle),
kind: .button { context.send(viewAction: .sessionVerification) })
} else {
ListRow(label: .default(title: L10n.commonChatBackup,
icon: \.key),
details: context.viewState.showSecureBackupBadge ? .icon(secureBackupBadge) : nil,
kind: .navigationLink { context.send(viewAction: .secureBackup) })
.accessibilityIdentifier(A11yIdentifiers.settingsScreen.secureBackup)
}
switch context.viewState.securitySectionMode {
case .sessionVerification:
ListRow(label: .default(title: L10n.actionCompleteVerification,
icon: \.checkCircle),
details: context.viewState.showSecuritySectionBadge ? .icon(securitySectionBadge) : nil,
kind: .button { context.send(viewAction: .sessionVerification) })
case .secureBackup:
ListRow(label: .default(title: L10n.commonChatBackup,
icon: \.key),
details: context.viewState.showSecuritySectionBadge ? .icon(securitySectionBadge) : nil,
kind: .navigationLink { context.send(viewAction: .secureBackup) })
.accessibilityIdentifier(A11yIdentifiers.settingsScreen.secureBackup)
default:
EmptyView()
}
}
}
@@ -210,8 +212,8 @@ struct SettingsScreen: View {
}
@ViewBuilder
private var secureBackupBadge: some View {
if context.viewState.showSecureBackupBadge {
private var securitySectionBadge: some View {
if context.viewState.showSecuritySectionBadge {
BadgeView(size: 10)
}
}