ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-02 21:33:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Incoming session verification support (#3428)

Browse Source 
* Fixes #1227 - Add support for receiving and interacting with incoming session verification requests.
* Fix a couple of random small warnings
* Move static view config to the view state
* Update snapshots
This commit is contained in:
Stefan Ceriu
2024-10-29 15:21:17 +02:00
committed by GitHub
parent cf5e9fb313
commit d77bb935b7
104 changed files with 995 additions and 483 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Screens/Onboarding/SessionVerificationScreen/SessionVerificationScreenCoordinator.swift
+9 -1
View File
@@ -6,14 +6,21 @@
//
import Combine
import MatrixRustSDK
import SwiftUI
enum SessionVerificationScreenCoordinatorAction {
case done
}
enum SessionVerificationScreenFlow {
case initiator
case responder(details: SessionVerificationRequestDetails)
}
struct SessionVerificationScreenCoordinatorParameters {
let sessionVerificationControllerProxy: SessionVerificationControllerProxyProtocol
let flow: SessionVerificationScreenFlow
}
final class SessionVerificationScreenCoordinator: CoordinatorProtocol {
@@ -27,7 +34,8 @@ final class SessionVerificationScreenCoordinator: CoordinatorProtocol {
}
init(parameters: SessionVerificationScreenCoordinatorParameters) {
viewModel = SessionVerificationScreenViewModel(sessionVerificationControllerProxy: parameters.sessionVerificationControllerProxy)
viewModel = SessionVerificationScreenViewModel(sessionVerificationControllerProxy: parameters.sessionVerificationControllerProxy,
flow: parameters.flow)
}
// MARK: - Public
ElementX/Sources/Screens/Onboarding/SessionVerificationScreen/SessionVerificationScreenModels.swift
+62 -15
View File
@@ -11,13 +11,61 @@ enum SessionVerificationScreenViewModelAction {
case finished
}
enum SessionVerificationScreenViewAction {
case acceptVerificationRequest
case ignoreVerificationRequest
case requestVerification
case startSasVerification
case restart
case accept
case decline
case done
}
struct SessionVerificationScreenViewState: BindableState {
var verificationState: SessionVerificationScreenStateMachine.State = .initial
let flow: SessionVerificationScreenFlow
var verificationState: SessionVerificationScreenStateMachine.State
var headerImageName: String {
switch verificationState {
case .initial:
return "lock"
case .acceptingVerificationRequest:
return "hourglass"
case .requestingVerification:
return "hourglass"
case .verificationRequestAccepted:
return "face.smiling"
case .startingSasVerification:
return "hourglass"
case .sasVerificationStarted:
return "hourglass"
case .cancelling:
return "hourglass"
case .acceptingChallenge:
return "hourglass"
case .decliningChallenge:
return "hourglass"
case .showingChallenge:
return "face.smiling"
case .verified:
return "checkmark.shield"
case .cancelled:
return "exclamationmark.shield"
}
}
var title: String? {
switch verificationState {
case .initial:
return L10n.screenSessionVerificationOpenExistingSessionTitle
switch flow {
case .initiator:
return L10n.screenSessionVerificationOpenExistingSessionTitle
case .responder:
return L10n.screenSessionVerificationRequestTitle
}
case .acceptingVerificationRequest:
return L10n.screenSessionVerificationRequestTitle
case .requestingVerification:
return L10n.screenSessionVerificationWaitingToAcceptTitle
case .verificationRequestAccepted:
@@ -31,13 +79,13 @@ struct SessionVerificationScreenViewState: BindableState {
case .acceptingChallenge:
return L10n.screenSessionVerificationCompareEmojisTitle
case .decliningChallenge:
return nil
return L10n.screenSessionVerificationCompareEmojisTitle
case .verified:
return L10n.commonVerificationComplete
case .cancelling:
return nil
case .cancelled:
return L10n.commonVerificationCancelled
return L10n.commonVerificationFailed
}
}
@@ -48,7 +96,14 @@ struct SessionVerificationScreenViewState: BindableState {
var message: String {
switch verificationState {
case .initial:
return L10n.screenSessionVerificationOpenExistingSessionSubtitle
switch flow {
case .initiator:
return L10n.screenSessionVerificationOpenExistingSessionSubtitle
case .responder:
return L10n.screenSessionVerificationRequestSubtitle
}
case .acceptingVerificationRequest:
return L10n.screenSessionVerificationRequestSubtitle
case .requestingVerification:
return L10n.screenSessionVerificationWaitingToAcceptSubtitle
case .verificationRequestAccepted:
@@ -60,7 +115,7 @@ struct SessionVerificationScreenViewState: BindableState {
case .acceptingChallenge:
return L10n.screenSessionVerificationCompareEmojisSubtitle
case .decliningChallenge:
return L10n.commonWaiting
return L10n.screenSessionVerificationCompareEmojisSubtitle
case .cancelling:
return L10n.commonWaiting
case .showingChallenge:
@@ -68,15 +123,7 @@ struct SessionVerificationScreenViewState: BindableState {
case .verified:
return L10n.screenSessionVerificationCompleteSubtitle
case .cancelled:
return L10n.screenSessionVerificationCancelledSubtitle
return L10n.screenSessionVerificationFailedSubtitle
}
}
}
enum SessionVerificationScreenViewAction {
case requestVerification
case startSasVerification
case restart
case accept
case decline
}
ElementX/Sources/Screens/Onboarding/SessionVerificationScreen/SessionVerificationScreenStateMachine.swift
+15 -4
View File
@@ -13,6 +13,8 @@ class SessionVerificationScreenStateMachine {
enum State: StateType {
/// The initial state, before verification started
case initial
/// Accepting the remote verification request
case acceptingVerificationRequest
/// Waiting for verification acceptance
case requestingVerification
/// Verification request accepted. Waiting for start
@@ -37,6 +39,8 @@ class SessionVerificationScreenStateMachine {
/// Events that can be triggered on the SessionVerification state machine
enum Event: EventType {
/// Accept the remote verification request
case acceptVerificationRequest
/// Request verification
case requestVerification
/// The current verification request has been accepted
@@ -69,16 +73,23 @@ class SessionVerificationScreenStateMachine {
stateMachine.state
}
init() {
stateMachine = StateMachine(state: .initial)
init(state: State) {
stateMachine = StateMachine(state: state)
configure()
}
private func configure() {
stateMachine.addRoutes(event: .acceptVerificationRequest, transitions: [.initial => .acceptingVerificationRequest])
stateMachine.addRoutes(event: .requestVerification, transitions: [.initial => .requestingVerification])
stateMachine.addRoutes(event: .didAcceptVerificationRequest, transitions: [.requestingVerification => .verificationRequestAccepted])
stateMachine.addRoutes(event: .didAcceptVerificationRequest, transitions: [.acceptingVerificationRequest => .verificationRequestAccepted,
.requestingVerification => .verificationRequestAccepted])
stateMachine.addRoutes(event: .startSasVerification, transitions: [.verificationRequestAccepted => .startingSasVerification])
stateMachine.addRoutes(event: .didFail, transitions: [.requestingVerification => .initial])
stateMachine.addRoutes(event: .didFail, transitions: [.requestingVerification => .initial,
.acceptingVerificationRequest => .initial])
stateMachine.addRoutes(event: .restart, transitions: [.cancelled => .initial])
// Transitions with associated values need to be handled through `addRouteMapping`
ElementX/Sources/Screens/Onboarding/SessionVerificationScreen/SessionVerificationScreenViewModel.swift
+45 -6
View File
@@ -12,6 +12,7 @@ typealias SessionVerificationViewModelType = StateStoreViewModel<SessionVerifica
class SessionVerificationScreenViewModel: SessionVerificationViewModelType, SessionVerificationScreenViewModelProtocol {
private let sessionVerificationControllerProxy: SessionVerificationControllerProxyProtocol
private let flow: SessionVerificationScreenFlow
private var stateMachine: SessionVerificationScreenStateMachine
@@ -22,21 +23,25 @@ class SessionVerificationScreenViewModel: SessionVerificationViewModelType, Sess
}
init(sessionVerificationControllerProxy: SessionVerificationControllerProxyProtocol,
flow: SessionVerificationScreenFlow,
verificationState: SessionVerificationScreenStateMachine.State = .initial) {
self.sessionVerificationControllerProxy = sessionVerificationControllerProxy
self.flow = flow
stateMachine = SessionVerificationScreenStateMachine()
stateMachine = SessionVerificationScreenStateMachine(state: verificationState)
super.init(initialViewState: .init(verificationState: verificationState))
super.init(initialViewState: .init(flow: flow, verificationState: verificationState))
setupStateMachine()
sessionVerificationControllerProxy.callbacks
sessionVerificationControllerProxy.actions
.receive(on: DispatchQueue.main)
.sink { [weak self] callback in
guard let self else { return }
switch callback {
case .receivedVerificationRequest:
break // Incoming verification requests are handled on the higher levels
case .acceptedVerificationRequest:
self.stateMachine.processEvent(.didAcceptVerificationRequest)
case .startedSasVerification:
@@ -57,10 +62,20 @@ class SessionVerificationScreenViewModel: SessionVerificationViewModelType, Sess
}
}
.store(in: &cancellables)
if case .responder(let details) = flow {
Task {
await self.sessionVerificationControllerProxy.acknowledgeVerificationRequest(details: details)
}
}
}
override func process(viewAction: SessionVerificationScreenViewAction) {
switch viewAction {
case .acceptVerificationRequest:
stateMachine.processEvent(.acceptVerificationRequest)
case .ignoreVerificationRequest:
actionsSubject.send(.finished)
case .requestVerification:
stateMachine.processEvent(.requestVerification)
case .startSasVerification:
@@ -71,13 +86,16 @@ class SessionVerificationScreenViewModel: SessionVerificationViewModelType, Sess
stateMachine.processEvent(.acceptChallenge)
case .decline:
stateMachine.processEvent(.declineChallenge)
case .done:
actionsSubject.send(.finished)
}
}
func stop() {
let uncancellableStates: [SessionVerificationScreenStateMachine.State] = [.initial, .verified, .cancelled]
if !uncancellableStates.contains(stateMachine.state) {
switch stateMachine.state {
case .initial, .verified, .cancelled: // non-cancellable states
return
default:
stateMachine.processEvent(.cancel)
}
}
@@ -91,6 +109,8 @@ class SessionVerificationScreenViewModel: SessionVerificationViewModelType, Sess
state.verificationState = context.toState
switch (context.fromState, context.event, context.toState) {
case (.initial, .acceptVerificationRequest, .acceptingVerificationRequest):
acceptVerificationRequest()
case (.initial, .requestVerification, .requestingVerification):
requestVerification()
case (.verificationRequestAccepted, .startSasVerification, .startingSasVerification):
@@ -103,6 +123,10 @@ class SessionVerificationScreenViewModel: SessionVerificationViewModelType, Sess
cancelVerification()
case (_, _, .verified):
actionsSubject.send(.finished)
case (.initial, _, .cancelled):
if case .responder = flow {
actionsSubject.send(.finished)
}
default:
break
}
@@ -113,6 +137,21 @@ class SessionVerificationScreenViewModel: SessionVerificationViewModelType, Sess
}
}
private func acceptVerificationRequest() {
Task {
guard case .responder = flow else {
fatalError("Incorrect API usage.")
}
switch await sessionVerificationControllerProxy.acceptVerificationRequest() {
case .success:
stateMachine.processEvent(.didAcceptVerificationRequest)
case .failure:
stateMachine.processEvent(.didFail)
}
}
}
private func requestVerification() {
Task {
switch await sessionVerificationControllerProxy.requestVerification() {
ElementX/Sources/Screens/Onboarding/SessionVerificationScreen/View/SessionVerificationRequestDetailsView.swift
+80
View File
@@ -0,0 +1,80 @@
//
// Copyright 2024 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only
// Please see LICENSE in the repository root for full details.
//
import Compound
import MatrixRustSDK
import SwiftUI
struct SessionVerificationRequestDetailsView: View {
@ScaledMetric private var iconSize = 30.0
private let outerShape = RoundedRectangle(cornerRadius: 8)
let details: SessionVerificationRequestDetails
var body: some View {
VStack(spacing: 24) {
VStack(alignment: .leading, spacing: 12) {
HStack(spacing: 16) {
CompoundIcon(\.devices)
.frame(width: iconSize, height: iconSize)
.foregroundColor(.compound.iconSecondary)
.padding(6)
.background(.compound.bgSubtleSecondary)
.clipShape(RoundedRectangle(cornerRadius: 8))
Text(details.displayName ?? details.senderID)
.font(.compound.bodyMDSemibold)
.foregroundColor(.compound.textPrimary)
.frame(maxWidth: .infinity, alignment: .leading)
}
HStack(spacing: 40) {
VStack(alignment: .leading, spacing: 0) {
Text(L10n.screenSessionVerificationRequestDetailsTimestamp)
.font(.compound.bodySM)
.foregroundColor(.compound.textSecondary)
Text(details.firstSeenDate.formattedMinimal())
.font(.compound.bodyMD)
.foregroundColor(.compound.textPrimary)
}
VStack(alignment: .leading, spacing: 0) {
Text(L10n.commonDeviceId)
.font(.compound.bodySM)
.foregroundColor(.compound.textSecondary)
Text(details.deviceID)
.font(.compound.bodyMD)
.foregroundColor(.compound.textPrimary)
}
}
}
.padding(24)
.clipShape(outerShape)
.overlay {
outerShape
.inset(by: 0.25)
.stroke(.compound.borderDisabled)
}
Text(L10n.screenSessionVerificationRequestFooter)
.font(.compound.bodyMDSemibold)
.foregroundColor(.compound.textPrimary)
}
}
}
struct SessionVerificationRequestDetailsView_Previews: PreviewProvider, TestablePreview {
static var previews: some View {
let details = SessionVerificationRequestDetails(senderID: "@bob:matrix.org",
flowID: "123",
deviceID: "CODEMISTAKE",
displayName: "Bob's Element X iOS",
firstSeenDate: .init(timeIntervalSince1970: 0))
SessionVerificationRequestDetailsView(details: details)
}
}
ElementX/Sources/Screens/Onboarding/SessionVerificationScreen/View/SessionVerificationScreen.swift
+71 -68
View File
@@ -5,6 +5,8 @@
// Please see LICENSE in the repository root for full details.
//
import Compound
import MatrixRustSDK
import SwiftUI
struct SessionVerificationScreen: View {
@@ -14,7 +16,6 @@ struct SessionVerificationScreen: View {
FullscreenDialog {
VStack(spacing: 32) {
screenHeader
Spacer()
mainContent
}
} bottomContent: {
@@ -27,33 +28,6 @@ struct SessionVerificationScreen: View {
// MARK: - Private
private var headerImageName: String {
switch context.viewState.verificationState {
case .initial:
return "lock"
case .cancelled:
return "exclamationmark.shield"
case .requestingVerification:
return "hourglass"
case .verificationRequestAccepted:
return "face.smiling"
case .startingSasVerification:
return "hourglass"
case .sasVerificationStarted:
return "hourglass"
case .cancelling:
return "hourglass"
case .acceptingChallenge:
return "hourglass"
case .decliningChallenge:
return "hourglass"
case .showingChallenge:
return "face.smiling"
case .verified:
return "checkmark.shield"
}
}
@ViewBuilder
private var screenHeader: some View {
VStack(spacing: 0) {
@@ -61,11 +35,11 @@ struct SessionVerificationScreen: View {
BigIcon(icon: \.lockSolid)
.padding(.bottom, 16)
} else {
Image(systemName: headerImageName)
Image(systemName: context.viewState.headerImageName)
.bigIcon()
.padding(.bottom, 16)
}
Text(context.viewState.title ?? "")
.font(.compound.headingMDBold)
.multilineTextAlignment(.center)
@@ -83,18 +57,17 @@ struct SessionVerificationScreen: View {
@ViewBuilder
private var mainContent: some View {
switch context.viewState.verificationState {
case .showingChallenge(let emojis):
case .initial:
switch context.viewState.flow {
case .responder(let details):
SessionVerificationRequestDetailsView(details: details)
default:
EmptyView()
}
case .showingChallenge(let emojis), .acceptingChallenge(let emojis), .decliningChallenge(let emojis):
emojisPanel(with: emojis)
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.emojiWrapper)
case .acceptingChallenge(let emojis):
emojisPanel(with: emojis)
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.emojiWrapper)
case .requestingVerification:
ProgressView()
.tint(.compound.textSecondary)
.scaleEffect(2)
default:
// In All other cases, we just want an empty view
EmptyView()
}
}
@@ -119,18 +92,41 @@ struct SessionVerificationScreen: View {
private var actionButtons: some View {
switch context.viewState.verificationState {
case .initial:
VStack(spacing: 32) {
switch context.viewState.flow {
case .initiator:
Button(L10n.actionStartVerification) {
context.send(viewAction: .requestVerification)
}
.buttonStyle(.compound(.primary))
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.requestVerification)
case .responder:
VStack(spacing: 16) {
Button(L10n.actionStart) {
context.send(viewAction: .acceptVerificationRequest)
}
.buttonStyle(.compound(.primary))
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.acceptVerificationRequest)
Button(L10n.actionIgnore) {
context.send(viewAction: .ignoreVerificationRequest)
}
.buttonStyle(.compound(.plain))
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.ignoreVerificationRequest)
}
}
case .cancelled:
Button(L10n.actionRetry) {
context.send(viewAction: .restart)
switch context.viewState.flow {
case .initiator:
Button(L10n.actionRetry) {
context.send(viewAction: .restart)
}
.buttonStyle(.compound(.primary))
case .responder:
Button(L10n.actionDone) {
context.send(viewAction: .done)
}
.buttonStyle(.compound(.primary))
}
.buttonStyle(.compound(.primary))
case .verificationRequestAccepted:
Button(L10n.actionStart) {
@@ -150,31 +146,15 @@ struct SessionVerificationScreen: View {
Button(L10n.screenSessionVerificationTheyDontMatch) {
context.send(viewAction: .decline)
}
.font(.compound.bodyLGSemibold)
.buttonStyle(.compound(.plain))
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.declineChallenge)
}
case .acceptingChallenge:
VStack(spacing: 32) {
Button { context.send(viewAction: .accept) } label: {
HStack(spacing: 16) {
ProgressView()
.tint(.compound.textOnSolidPrimary)
Text(L10n.screenSessionVerificationTheyMatch)
}
}
case .acceptingVerificationRequest, .acceptingChallenge, .decliningChallenge, .requestingVerification:
Button(L10n.screenIdentityWaitingOnOtherDevice) { }
.buttonStyle(.compound(.primary))
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.acceptChallenge)
.disabled(true)
Button(L10n.screenSessionVerificationTheyDontMatch) {
context.send(viewAction: .decline)
}
.font(.compound.bodyLGSemibold)
.accessibilityIdentifier(A11yIdentifiers.sessionVerificationScreen.declineChallenge)
.disabled(true)
}
default:
EmptyView()
}
@@ -196,27 +176,50 @@ struct SessionVerificationScreen: View {
}
}
// MARK: - Previews
struct SessionVerification_Previews: PreviewProvider, TestablePreview {
static var previews: some View {
sessionVerificationScreen(state: .initial)
.previewDisplayName("Initial")
.previewDisplayName("Initial - Initiator")
let details = SessionVerificationRequestDetails(senderID: "@bob:matrix.org",
flowID: "123",
deviceID: "CODEMISTAKE",
displayName: "Bob's Element X iOS",
firstSeenDate: .init(timeIntervalSince1970: 0))
sessionVerificationScreen(state: .initial, flow: .responder(details: details))
.previewDisplayName("Initial - Responder")
sessionVerificationScreen(state: .acceptingVerificationRequest)
.previewDisplayName("Accepting Verification Request")
sessionVerificationScreen(state: .requestingVerification)
.previewDisplayName("Requesting Verification")
sessionVerificationScreen(state: .verificationRequestAccepted)
.previewDisplayName("Request Accepted")
sessionVerificationScreen(state: .cancelled)
.previewDisplayName("Cancelled")
sessionVerificationScreen(state: .startingSasVerification)
.previewDisplayName("Starting SAS Verification")
sessionVerificationScreen(state: .sasVerificationStarted)
.previewDisplayName("SAS Verification started")
sessionVerificationScreen(state: .showingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
.previewDisplayName("Showing Challenge")
sessionVerificationScreen(state: .acceptingChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
.previewDisplayName("Accepting Challenge")
sessionVerificationScreen(state: .decliningChallenge(emojis: SessionVerificationControllerProxyMock.emojis))
.previewDisplayName("Declining Challenge")
sessionVerificationScreen(state: .verified)
.previewDisplayName("Verified")
sessionVerificationScreen(state: .cancelled)
.previewDisplayName("Cancelled")
}
static func sessionVerificationScreen(state: SessionVerificationScreenStateMachine.State) -> some View {
static func sessionVerificationScreen(state: SessionVerificationScreenStateMachine.State,
flow: SessionVerificationScreenFlow = .initiator) -> some View {
let viewModel = SessionVerificationScreenViewModel(sessionVerificationControllerProxy: SessionVerificationControllerProxyMock.configureMock(),
flow: flow,
verificationState: state)
return SessionVerificationScreen(context: viewModel.context)