mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-10-31 16:24:11 +00:00
Combine the Server Selection screen into the Server Confirmation screen and add autocompletion when entering an account provider. (#5949)
* Adjust login flow to exclusively use the ServerSelectionScreen * Move async code to server selection vm * ServerSelection supports pro picker options * Use homeserver address for both confirmation and picker modes * rename ServerSelectionScreenMode * remove ServerConfirmationScreen It's been superseded by the ServerSelectionScreen * rename userInput * Update strings with latest design strings * Add server input autocompletion * Store previous servers in AppSettings and autofill on server signin * Audit changes for logging * Enforce lowercase server history storage * Update tests * Update Xcode project * PR review fixups * Add HomeserverHistoryManager * Review fixups 2 * Review fixups 3
This commit is contained in:
Michael
GitHub
@@ -7,10 +7,17 @@
|
||||
//
|
||||
|
||||
@testable import ElementX
|
||||
import MatrixRustSDKMocks
|
||||
import SwiftUI
|
||||
import Testing
|
||||
|
||||
@MainActor
|
||||
struct ServerSelectionScreenViewModelTests {
|
||||
private static let passwordOnlyServer = "example.com" // password only, no OAuth
|
||||
private static let pickerProviders = ["matrix.org", "beta.matrix.org", passwordOnlyServer]
|
||||
|
||||
var appSettings: AppSettings!
|
||||
var client: ClientSDKMock!
|
||||
var clientFactory: AuthenticationClientFactoryMock!
|
||||
var service: AuthenticationServiceProtocol!
|
||||
var viewModel: ServerSelectionScreenViewModelProtocol!
|
||||
@@ -22,13 +29,13 @@ struct ServerSelectionScreenViewModelTests {
|
||||
@Test
|
||||
mutating func selectForLogin() async throws {
|
||||
// Given a view model for login.
|
||||
setup(authenticationFlow: .login)
|
||||
try setup(authenticationFlow: .login)
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
|
||||
// When selecting matrix.org.
|
||||
context.homeserverAddress = "matrix.org"
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0 == .updated }
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0.isContinueWithOAuth }
|
||||
context.send(viewAction: .confirm)
|
||||
try await deferred.fulfill()
|
||||
|
||||
@@ -40,7 +47,7 @@ struct ServerSelectionScreenViewModelTests {
|
||||
@Test
|
||||
mutating func loginNotSupportedAlert() async throws {
|
||||
// Given a view model for login.
|
||||
setup(authenticationFlow: .login)
|
||||
try setup(authenticationFlow: .login)
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
#expect(context.alertInfo == nil)
|
||||
@@ -59,13 +66,13 @@ struct ServerSelectionScreenViewModelTests {
|
||||
@Test
|
||||
mutating func selectForRegistration() async throws {
|
||||
// Given a view model for registration.
|
||||
setup(authenticationFlow: .register)
|
||||
try setup(authenticationFlow: .register)
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
|
||||
// When selecting matrix.org.
|
||||
context.homeserverAddress = "matrix.org"
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0 == .updated }
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0.isContinueWithOAuth }
|
||||
context.send(viewAction: .confirm)
|
||||
try await deferred.fulfill()
|
||||
|
||||
@@ -77,7 +84,7 @@ struct ServerSelectionScreenViewModelTests {
|
||||
@Test
|
||||
mutating func registrationNotSupportedAlert() async throws {
|
||||
// Given a view model for registration.
|
||||
setup(authenticationFlow: .register)
|
||||
try setup(authenticationFlow: .register)
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
#expect(context.alertInfo == nil)
|
||||
@@ -96,7 +103,7 @@ struct ServerSelectionScreenViewModelTests {
|
||||
@Test
|
||||
mutating func elementProRequiredAlert() async throws {
|
||||
// Given a view model for login.
|
||||
setup(authenticationFlow: .login)
|
||||
try setup(authenticationFlow: .login)
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
#expect(context.alertInfo == nil)
|
||||
@@ -115,10 +122,10 @@ struct ServerSelectionScreenViewModelTests {
|
||||
@Test
|
||||
mutating func invalidServer() async throws {
|
||||
// Given a new instance of the view model.
|
||||
setup(authenticationFlow: .login)
|
||||
try setup(authenticationFlow: .login)
|
||||
#expect(!context.viewState.isShowingFooterError, "There should not be an error message for a new view model.")
|
||||
#expect(context.viewState.footerErrorMessage == nil, "There should not be an error message for a new view model.")
|
||||
#expect(String(context.viewState.footerMessage) == L10n.screenChangeServerFormNotice,
|
||||
#expect(String(context.viewState.footerMessage) == L10n.screenChangeServerTextfieldFooterLogin,
|
||||
"The standard footer message should be shown.")
|
||||
|
||||
// When attempting to discover an invalid server
|
||||
@@ -130,7 +137,7 @@ struct ServerSelectionScreenViewModelTests {
|
||||
// Then the footer should now be showing an error.
|
||||
#expect(context.viewState.isShowingFooterError, "The error message should be stored.")
|
||||
#expect(context.viewState.footerErrorMessage != nil, "The error message should be stored.")
|
||||
#expect(String(context.viewState.footerMessage) != L10n.screenChangeServerFormNotice,
|
||||
#expect(String(context.viewState.footerMessage) != L10n.screenChangeServerTextfieldFooterLogin,
|
||||
"The error message should be shown.")
|
||||
|
||||
// And when clearing the error.
|
||||
@@ -141,16 +148,204 @@ struct ServerSelectionScreenViewModelTests {
|
||||
|
||||
// Then the error message should now be removed.
|
||||
#expect(context.viewState.footerErrorMessage == nil, "The error message should have been cleared.")
|
||||
#expect(String(context.viewState.footerMessage) == L10n.screenChangeServerFormNotice,
|
||||
#expect(String(context.viewState.footerMessage) == L10n.screenChangeServerTextfieldFooterLogin,
|
||||
"The standard footer message should be shown again.")
|
||||
}
|
||||
|
||||
// MARK: - userInput mode
|
||||
|
||||
@Test
|
||||
mutating func userInputPasswordLoginWithoutConfiguration() async throws {
|
||||
// Given a view model for login using a service that hasn't been configured against a server that doesn't support OAuth.
|
||||
try setup(authenticationFlow: .login)
|
||||
context.homeserverAddress = Self.passwordOnlyServer
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
|
||||
// When confirming from the server selection screen.
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0.isContinueWithPassword }
|
||||
context.send(viewAction: .confirm)
|
||||
try await deferred.fulfill()
|
||||
|
||||
// Then the service should be configured but no OAuth URL fetched.
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 1)
|
||||
#expect(service.homeserver.value.loginMode == .password)
|
||||
}
|
||||
|
||||
@Test
|
||||
mutating func userInputPasswordLoginAfterConfiguration() async throws {
|
||||
// Given a view model for login using a service that has already been configured against a server that doesn't support OAuth.
|
||||
try setup(authenticationFlow: .login)
|
||||
context.homeserverAddress = Self.passwordOnlyServer
|
||||
guard case .success = await service.configure(for: context.homeserverAddress, flow: .login) else {
|
||||
Issue.record("The configuration should succeed.")
|
||||
return
|
||||
}
|
||||
#expect(service.homeserver.value.loginMode == .password)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 1)
|
||||
|
||||
// When confirming from the server selection screen.
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0.isContinueWithPassword }
|
||||
context.send(viewAction: .confirm)
|
||||
try await deferred.fulfill()
|
||||
|
||||
// Then the service should be re-configured but no OAuth URL fetched.
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 2)
|
||||
}
|
||||
|
||||
// MARK: - Picker mode
|
||||
|
||||
@Test
|
||||
mutating func pickerWithoutConfiguration() async throws {
|
||||
// Given a view model for login using a service that hasn't been configured.
|
||||
try setup(authenticationFlow: .login, mode: .picker(Self.pickerProviders))
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(context.viewState.mode == .picker(Self.pickerProviders))
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
#expect(client.urlForOauthOauthConfigurationPromptLoginHintDeviceIdAdditionalScopesCallsCount == 0)
|
||||
|
||||
// When confirming from the picker.
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0.isContinueWithOAuth }
|
||||
context.send(viewAction: .confirm)
|
||||
try await deferred.fulfill()
|
||||
|
||||
// Then the service should be configured and the OAuth URL fetched.
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 1)
|
||||
#expect(client.urlForOauthOauthConfigurationPromptLoginHintDeviceIdAdditionalScopesCallsCount == 1)
|
||||
#expect(client.urlForOauthOauthConfigurationPromptLoginHintDeviceIdAdditionalScopesReceivedArguments?.prompt == .consent)
|
||||
#expect(service.homeserver.value.loginMode == .oAuth(supportsCreatePrompt: true))
|
||||
}
|
||||
|
||||
@Test
|
||||
mutating func pickerForPasswordLoginWithoutConfiguration() async throws {
|
||||
// Given a view model for login using a service that hasn't been configured against a server that doesn't support OAuth.
|
||||
try setup(authenticationFlow: .login, mode: .picker(Self.pickerProviders))
|
||||
context.homeserverAddress = Self.passwordOnlyServer
|
||||
#expect(service.homeserver.value.loginMode == .unknown)
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 0)
|
||||
|
||||
// When confirming from the picker.
|
||||
let deferred = deferFulfillment(viewModel.actions) { $0.isContinueWithPassword }
|
||||
context.send(viewAction: .confirm)
|
||||
try await deferred.fulfill()
|
||||
|
||||
// Then the service should be configured but no OAuth URL fetched.
|
||||
#expect(clientFactory.makeClientHomeserverAddressSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount == 1)
|
||||
#expect(service.homeserver.value.loginMode == .password)
|
||||
}
|
||||
|
||||
// MARK: - Autocomplete
|
||||
|
||||
@Test
|
||||
mutating func autocompleteMatchesPreviousServers() async throws {
|
||||
// Given a view model with a previous server in history.
|
||||
try setup(authenticationFlow: .login)
|
||||
appSettings.previousServers = ["myserver.com"]
|
||||
context.homeserverAddress = ""
|
||||
let textField = UITextField()
|
||||
context.send(viewAction: .updateTextField(textField))
|
||||
|
||||
// When the user types a prefix that matches the previous server.
|
||||
let typedSoFar = "my"
|
||||
let nextCharacter = "s"
|
||||
let typed = typedSoFar + nextCharacter
|
||||
let expectedAddress = "myserver.com"
|
||||
textField.text = typedSoFar
|
||||
let deferred = deferFulfillment(context.observe(\.homeserverAddress)) { $0 == expectedAddress }
|
||||
_ = textField.delegate?.textField?(textField, shouldChangeCharactersIn: NSRange(location: typedSoFar.count, length: 0), replacementString: nextCharacter)
|
||||
try await deferred.fulfill()
|
||||
|
||||
// Then the address should be completed and the appended portion selected.
|
||||
let selectionStart = expectedAddress.index(expectedAddress.startIndex, offsetBy: typed.count)
|
||||
#expect(context.homeserverAddress == expectedAddress)
|
||||
#expect(context.homeserverSelection == TextSelection(range: selectionStart..<expectedAddress.endIndex))
|
||||
}
|
||||
|
||||
@Test
|
||||
mutating func autocompleteFromAccountProviders() async throws {
|
||||
// Given a view model with no previous server history, falling back to the default account providers.
|
||||
try setup(authenticationFlow: .login)
|
||||
#expect(appSettings.previousServers.isEmpty)
|
||||
context.homeserverAddress = ""
|
||||
let textField = UITextField()
|
||||
context.send(viewAction: .updateTextField(textField))
|
||||
|
||||
// When the user types a prefix that matches an account provider.
|
||||
let typedSoFar = "ma"
|
||||
let nextCharacter = "t"
|
||||
let typed = typedSoFar + nextCharacter
|
||||
let expectedAddress = "matrix.org"
|
||||
textField.text = typedSoFar
|
||||
let deferred = deferFulfillment(context.observe(\.homeserverAddress)) { $0 == expectedAddress }
|
||||
_ = textField.delegate?.textField?(textField, shouldChangeCharactersIn: NSRange(location: typedSoFar.count, length: 0), replacementString: nextCharacter)
|
||||
try await deferred.fulfill()
|
||||
|
||||
// Then the address should be completed and the appended portion selected.
|
||||
let selectionStart = expectedAddress.index(expectedAddress.startIndex, offsetBy: typed.count)
|
||||
#expect(context.homeserverAddress == expectedAddress)
|
||||
#expect(context.homeserverSelection == TextSelection(range: selectionStart..<expectedAddress.endIndex))
|
||||
}
|
||||
|
||||
@Test
|
||||
mutating func autocompleteNoMatch() async throws {
|
||||
// Given a view model with a known set of servers.
|
||||
try setup(authenticationFlow: .login)
|
||||
appSettings.previousServers = ["myserver.com"]
|
||||
context.homeserverAddress = ""
|
||||
let textField = UITextField()
|
||||
context.send(viewAction: .updateTextField(textField))
|
||||
|
||||
// When the user types a string that doesn't match any known server prefix.
|
||||
textField.text = "xy"
|
||||
_ = textField.delegate?.textField?(textField, shouldChangeCharactersIn: NSRange(location: 2, length: 0), replacementString: "z")
|
||||
try await Task.sleep(for: .milliseconds(50))
|
||||
|
||||
// Then the address should remain unchanged.
|
||||
#expect(context.homeserverAddress == "")
|
||||
}
|
||||
|
||||
@Test
|
||||
mutating func autocompleteLRUOrder() async throws {
|
||||
// Given a view model with an ordered server history.
|
||||
try setup(authenticationFlow: .login)
|
||||
appSettings.previousServers = ["abc.foo", "matrix.org", "mantis.asdf"]
|
||||
context.homeserverAddress = ""
|
||||
let textField = UITextField()
|
||||
context.send(viewAction: .updateTextField(textField))
|
||||
|
||||
// Step 1: type "m" — first "m" match in history is "matrix.org".
|
||||
textField.text = ""
|
||||
var deferred = deferFulfillment(context.observe(\.homeserverAddress)) { $0 == "matrix.org" }
|
||||
_ = textField.delegate?.textField?(textField, shouldChangeCharactersIn: NSRange(location: 0, length: 0), replacementString: "m")
|
||||
try await deferred.fulfill()
|
||||
#expect(context.homeserverAddress == "matrix.org")
|
||||
|
||||
// Step 2: type "a" replacing the highlighted suffix — still matches "matrix.org".
|
||||
// textField.text = "matrix.org", "atrix.org" highlighted (loc: 1, len: 9).
|
||||
deferred = deferFulfillment(context.observe(\.homeserverAddress)) { $0 == "matrix.org" }
|
||||
_ = textField.delegate?.textField?(textField, shouldChangeCharactersIn: NSRange(location: 1, length: 9), replacementString: "a")
|
||||
try await deferred.fulfill()
|
||||
#expect(context.homeserverAddress == "matrix.org")
|
||||
|
||||
// Step 3: type "n" replacing the highlighted suffix — "man" now matches "mantis.asdf".
|
||||
// textField.text = "matrix.org", "trix.org" highlighted (loc: 2, len: 8).
|
||||
deferred = deferFulfillment(context.observe(\.homeserverAddress)) { $0 == "mantis.asdf" }
|
||||
_ = textField.delegate?.textField?(textField, shouldChangeCharactersIn: NSRange(location: 2, length: 8), replacementString: "n")
|
||||
try await deferred.fulfill()
|
||||
#expect(context.homeserverAddress == "mantis.asdf")
|
||||
}
|
||||
|
||||
// MARK: - Helpers
|
||||
|
||||
private mutating func setup(authenticationFlow: AuthenticationFlow) {
|
||||
let appSettings = AppSettings.volatile()
|
||||
private mutating func setup(authenticationFlow: AuthenticationFlow,
|
||||
mode: ServerSelectionScreenMode = .userInput) throws {
|
||||
appSettings = AppSettings.volatile()
|
||||
|
||||
let factoryConfiguration = AuthenticationClientFactoryMock.Configuration()
|
||||
// matrix.org: OAuth. example.com: password only. server.net: no login. secure.gov: OAuth + Element Pro required.
|
||||
client = factoryConfiguration.homeserverClients["matrix.org"]
|
||||
clientFactory = AuthenticationClientFactoryMock(factoryConfiguration)
|
||||
|
||||
clientFactory = AuthenticationClientFactoryMock(.init())
|
||||
service = AuthenticationService(userSessionStore: UserSessionStoreMock(.init()),
|
||||
encryptionKeyProvider: EncryptionKeyProvider(),
|
||||
classicAppManager: nil,
|
||||
@@ -159,8 +354,29 @@ struct ServerSelectionScreenViewModelTests {
|
||||
appHooks: AppHooks())
|
||||
|
||||
viewModel = ServerSelectionScreenViewModel(authenticationService: service,
|
||||
mode: mode,
|
||||
authenticationFlow: authenticationFlow,
|
||||
appSettings: appSettings,
|
||||
homeserverHistoryManager: HomeserverHistoryManager(appSettings: appSettings),
|
||||
userIndicatorController: UserIndicatorControllerMock())
|
||||
|
||||
let scene = try #require(UIApplication.shared.connectedScenes.first as? UIWindowScene)
|
||||
viewModel.context.send(viewAction: .updateWindow(UIWindow(windowScene: scene)))
|
||||
}
|
||||
}
|
||||
|
||||
private extension ServerSelectionScreenViewModelAction {
|
||||
var isContinueWithOAuth: Bool {
|
||||
switch self {
|
||||
case .continueWithOAuth: true
|
||||
default: false
|
||||
}
|
||||
}
|
||||
|
||||
var isContinueWithPassword: Bool {
|
||||
switch self {
|
||||
case .continueWithPassword: true
|
||||
default: false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user