Files
element-x-ios/ElementX/Sources/Screens/Authentication/ServerSelectionScreen/ServerSelectionScreenViewModel.swift
T
Mauro Romito 09ecec4306 Ignore repeated confirms on the server selection screen
Tapping Continue and then the keyboard's Done key (or double tapping
Continue) started two server configurations. With a password-only server
both asked the flow to show the login screen, and the second request hit
the authentication state machine's unexpected transition fatalError.

Keep the running confirmation task and ignore further confirms until it
finishes, so the flow continues once. The guard clears afterwards so
confirming again after going back from the login screen still works.

Fixes ELEMENT-X-IOS-XED
2026-10-15 12:34:50 +02:00

235 lines
11 KiB
Swift

//
// Copyright 2025 Element Creations Ltd.
// Copyright 2022-2025 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
// Please see LICENSE files in the repository root for full details.
//
import Combine
import MatrixRustSDK
import SwiftUI
typealias ServerSelectionScreenViewModelType = StateStoreViewModelV2<ServerSelectionScreenViewState, ServerSelectionScreenViewAction>
class ServerSelectionScreenViewModel: ServerSelectionScreenViewModelType, ServerSelectionScreenViewModelProtocol {
private let authenticationService: AuthenticationServiceProtocol
private let authenticationFlow: AuthenticationFlow
private let appSettings: AppSettings
private let userIndicatorController: UserIndicatorControllerProtocol
/// Debounces autocompletion from user input
private var debouncedAutocompleteTask: Task<Void, Never>?
/// The confirmation in progress, used to ignore repeated confirms (e.g. Continue then keyboard Done).
private var confirmTask: Task<Void, Never>?
private var actionsSubject: PassthroughSubject<ServerSelectionScreenViewModelAction, Never> = .init()
var actions: AnyPublisher<ServerSelectionScreenViewModelAction, Never> {
actionsSubject.eraseToAnyPublisher()
}
private let homeserverHistoryManager: HomeserverHistoryManager
init(authenticationService: AuthenticationServiceProtocol,
mode: ServerSelectionScreenMode,
authenticationFlow: AuthenticationFlow,
appSettings: AppSettings,
homeserverHistoryManager: HomeserverHistoryManager,
userIndicatorController: UserIndicatorControllerProtocol) {
self.authenticationService = authenticationService
self.authenticationFlow = authenticationFlow
self.appSettings = appSettings
self.userIndicatorController = userIndicatorController
self.homeserverHistoryManager = homeserverHistoryManager
let serverNameOrBaseURL = if case .picker(let providers) = mode {
providers[0]
} else {
authenticationService.homeserver.value.accountProvider.serverNameOrBaseURL
}
let bindings = ServerSelectionScreenBindings(serverNameOrBaseURL: serverNameOrBaseURL)
super.init(initialViewState: ServerSelectionScreenViewState(mode: mode, authenticationFlow: authenticationFlow, bindings: bindings))
context.viewState.textFieldAdapter.keystrokePublisher
.sink { [weak self] in
self?.didUpdateTextFromKeystroke(userProvidedString: $0)
}
.store(in: &cancellables)
}
override func process(viewAction: ServerSelectionScreenViewAction) {
switch viewAction {
case .updateWindow(let window):
guard state.window != window else { return } // stop the infinite loop
state.window = window
case .updateTextField(let textField):
guard state.textField != textField else { return } // stop the infinite loop
state.textField = textField
case .confirm:
guard confirmTask == nil else { return }
confirmTask = Task {
switch state.mode {
case .userInput:
await configureHomeserver()
case .picker:
await pickServer()
}
confirmTask = nil
}
case .clearFooterError:
clearFooterError()
}
}
// MARK: - Private
private func pickServer() async {
let serverNameOrBaseURL = state.bindings.serverNameOrBaseURL
guard serverNameOrBaseURL.isEmpty == false else {
fatalError("It shouldn't be possible to confirm without a selection.")
}
startLoading()
switch await authenticationService.configure(for: serverNameOrBaseURL, flow: authenticationFlow) {
case .success:
MXLog.info("Selected server: \(serverNameOrBaseURL)")
await fetchLoginURLIfNeededAndContinue()
stopLoading()
case .failure:
MXLog.info("Invalid server: \(serverNameOrBaseURL)")
stopLoading()
// When the servers are hard-coded they should have a valid configuration, so show a generic error.
state.bindings.alertInfo = AlertInfo(id: .unknownError)
}
}
/// Updates the login flow using the supplied server name or base URL, or shows an error when this isn't possible.
private func configureHomeserver() async {
let userInput = state.bindings.serverNameOrBaseURL
// People often enter their Matrix ID here, so use the server name from it when they do.
let serverNameOrBaseURL = (try? serverNameFromUserId(userId: userInput)) ?? userInput
startLoading()
switch await authenticationService.configure(for: serverNameOrBaseURL, flow: authenticationFlow) {
case .success:
MXLog.info("Selected homeserver: \(serverNameOrBaseURL)")
await fetchLoginURLIfNeededAndContinue()
stopLoading()
case .failure(let error):
MXLog.info("Invalid homeserver: \(serverNameOrBaseURL)")
stopLoading()
handleError(error)
}
}
private func fetchLoginURLIfNeededAndContinue() async {
guard authenticationService.homeserver.value.loginMode.supportsOAuthFlow else {
actionsSubject.send(.continueWithPassword)
return
}
guard let window = state.window else {
MXLog.error("No window available for OAuth presentation")
showFooterMessage(L10n.errorUnknown)
return
}
switch await authenticationService.urlForOAuthLogin(loginHint: nil) {
case .success(let oAuthData):
actionsSubject.send(.continueWithOAuth(data: oAuthData, window: window))
case .failure(let error):
MXLog.error("Failed to get OAuth login URL: \(error)")
showFooterMessage(L10n.errorUnknown)
}
}
private func startLoading(label: String = L10n.commonLoading) {
userIndicatorController.submitIndicator(UserIndicator(type: .modal,
title: label,
persistent: true))
}
private func stopLoading() {
userIndicatorController.retractAllIndicators()
}
/// Processes an error to either update the flow or display it to the user.
private func handleError(_ error: AuthenticationServiceError) {
switch error {
case .invalidServer, .invalidServerNameOrBaseURL:
showFooterMessage(L10n.screenChangeServerErrorInvalidHomeserver)
case .invalidWellKnown(let error):
state.bindings.alertInfo = AlertInfo(id: .invalidWellKnownAlert(error),
title: L10n.commonServerNotSupported,
message: L10n.screenChangeServerErrorInvalidWellKnown(error))
case .slidingSyncNotAvailable:
let nonBreakingAppName = InfoPlistReader.main.bundleDisplayName.replacingOccurrences(of: " ", with: "\u{00A0}")
state.bindings.alertInfo = AlertInfo(id: .slidingSyncAlert,
title: L10n.commonServerNotSupported,
message: L10n.screenChangeServerErrorNoSlidingSyncMessage(nonBreakingAppName))
case .loginNotSupported:
state.bindings.alertInfo = AlertInfo(id: .loginAlert,
title: L10n.commonServerNotSupported,
message: L10n.screenLoginErrorUnsupportedAuthentication)
case .registrationNotSupported:
state.bindings.alertInfo = AlertInfo(id: .registrationAlert,
title: L10n.commonServerNotSupported,
message: L10n.errorAccountCreationNotPossible)
case .elementProRequired(let serverName):
state.bindings.alertInfo = AlertInfo(id: .elementProAlert,
title: L10n.screenChangeServerErrorElementProRequiredTitle,
message: L10n.screenChangeServerErrorElementProRequiredMessage(serverName),
primaryButton: .init(title: L10n.screenChangeServerErrorElementProRequiredActionIos) {
UIApplication.shared.open(self.appSettings.elementProAppStoreURL)
},
secondaryButton: .init(title: L10n.actionCancel, role: .cancel, action: nil))
default:
showFooterMessage(L10n.errorUnknown)
}
}
/// Set a new error message to be shown in the text field footer.
private func showFooterMessage(_ message: String) {
withElementAnimation {
state.footerErrorMessage = message
}
}
/// Clear any errors shown in the text field footer.
private func clearFooterError() {
guard state.footerErrorMessage != nil else { return }
withElementAnimation { state.footerErrorMessage = nil }
}
/// Given the textfield's complete text from the user's latest keystroke, evaluate if it matches any historical
/// server prefixes. If there's a match, update the text value with the complete server, highlighting the portion
/// that was appended.
private func didUpdateTextFromKeystroke(userProvidedString: String) {
let new = userProvidedString
let lowerNew = new.lowercased()
guard
lowerNew.isEmpty == false,
let expectedMatch = homeserverHistoryManager.server(matchingPrefix: lowerNew),
lowerNew != expectedMatch
else { return }
let appendage = expectedMatch.dropFirst(new.count)
let newInput = "\(new)\(appendage)"
let selectionRange = newInput.index(newInput.startIndex, offsetBy: new.count)..<newInput.endIndex
// debounce a delay to assure that we are not in the same swiftui update cycle
debouncedAutocompleteTask?.cancel()
debouncedAutocompleteTask = Task { @MainActor in
try? await Task.sleep(for: .milliseconds(10))
guard Task.isCancelled == false else { return }
context.serverNameOrBaseURL = newInput
context.viewState.textField?.text = newInput
context.serverNameOrBaseURLSelection = TextSelection(range: selectionRange)
}
}
}