Move the core logic in LoginScreenCoordinator into the ViewModel. (#3348)

2026-10-31 16:24:11 +00:00 · 2024-10-01 13:09:45 +01:00
parent 5f4c2890f6
commit 268d9f7479
29 changed files with 382 additions and 388 deletions
@@ -0,0 +1,141 @@
+//
+// Copyright 2022-2024 New Vector Ltd.
+//
+// SPDX-License-Identifier: AGPL-3.0-only
+// Please see LICENSE in the repository root for full details.
+//
+
+import XCTest
+
+@testable import ElementX
+
+@MainActor
+class ServerSelectionScreenViewModelTests: XCTestCase {
+    var clientBuilderFactory: AuthenticationClientBuilderFactoryMock!
+    var service: AuthenticationServiceProtocol!
+    
+    var viewModel: ServerSelectionScreenViewModelProtocol!
+    var context: ServerSelectionScreenViewModelType.Context { viewModel.context }
+    
+    func testSelectForLogin() async throws {
+        // Given a view model for login.
+        setupViewModel(authenticationFlow: .login)
+        XCTAssertEqual(service.homeserver.value.loginMode, .unknown)
+        XCTAssertFalse(service.homeserver.value.supportsRegistration)
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 0)
+        
+        // When selecting matrix.org.
+        context.homeserverAddress = "matrix.org"
+        let deferred = deferFulfillment(viewModel.actions) { $0 == .updated }
+        context.send(viewAction: .confirm)
+        try await deferred.fulfill()
+        
+        // Then selection should succeed.
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 1)
+        XCTAssertEqual(service.homeserver.value, .mockMatrixDotOrg)
+    }
+    
+    func testLoginNotSupportedAlert() async throws {
+        // Given a view model for login.
+        setupViewModel(authenticationFlow: .login)
+        XCTAssertEqual(service.homeserver.value.loginMode, .unknown)
+        XCTAssertFalse(service.homeserver.value.supportsRegistration)
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 0)
+        XCTAssertNil(context.alertInfo)
+        
+        // When selecting a server that doesn't support login.
+        context.homeserverAddress = "server.net"
+        let deferred = deferFulfillment(context.$viewState) { $0.bindings.alertInfo != nil }
+        context.send(viewAction: .confirm)
+        try await deferred.fulfill()
+        
+        // Then selection should fail with an alert about not supporting registration.
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 1)
+        XCTAssertEqual(context.alertInfo?.id, .loginAlert)
+    }
+    
+    func testSelectForRegistration() async throws {
+        // Given a view model for registration.
+        setupViewModel(authenticationFlow: .register)
+        XCTAssertEqual(service.homeserver.value.loginMode, .unknown)
+        XCTAssertFalse(service.homeserver.value.supportsRegistration)
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 0)
+        
+        // When selecting matrix.org.
+        context.homeserverAddress = "matrix.org"
+        let deferred = deferFulfillment(viewModel.actions) { $0 == .updated }
+        context.send(viewAction: .confirm)
+        try await deferred.fulfill()
+        
+        // Then selection should succeed.
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 1)
+        XCTAssertEqual(service.homeserver.value, .mockMatrixDotOrg)
+    }
+    
+    func testRegistrationNotSupportedAlert() async throws {
+        // Given a view model for registration.
+        setupViewModel(authenticationFlow: .register)
+        XCTAssertEqual(service.homeserver.value.loginMode, .unknown)
+        XCTAssertFalse(service.homeserver.value.supportsRegistration)
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 0)
+        XCTAssertNil(context.alertInfo)
+        
+        // When selecting a server that doesn't support registration.
+        context.homeserverAddress = "example.com"
+        let deferred = deferFulfillment(context.$viewState) { $0.bindings.alertInfo != nil }
+        context.send(viewAction: .confirm)
+        try await deferred.fulfill()
+        
+        // Then selection should fail with an alert about not supporting registration.
+        XCTAssertEqual(clientBuilderFactory.makeBuilderSessionDirectoriesPassphraseClientSessionDelegateAppSettingsAppHooksCallsCount, 1)
+        XCTAssertEqual(context.alertInfo?.id, .registrationAlert)
+    }
+    
+    func testInvalidServer() async throws {
+        // Given a new instance of the view model.
+        setupViewModel(authenticationFlow: .login)
+        XCTAssertFalse(context.viewState.isShowingFooterError, "There should not be an error message for a new view model.")
+        XCTAssertNil(context.viewState.footerErrorMessage, "There should not be an error message for a new view model.")
+        XCTAssertEqual(String(context.viewState.footerMessage.characters), L10n.screenChangeServerFormNotice(L10n.actionLearnMore),
+                       "The standard footer message should be shown.")
+        
+        // When attempting to discover an invalid server
+        var deferred = deferFulfillment(context.$viewState) { $0.isShowingFooterError }
+        context.homeserverAddress = "idontexist"
+        context.send(viewAction: .confirm)
+        try await deferred.fulfill()
+        
+        // Then the footer should now be showing an error.
+        XCTAssertTrue(context.viewState.isShowingFooterError, "The error message should be stored.")
+        XCTAssertNotNil(context.viewState.footerErrorMessage, "The error message should be stored.")
+        XCTAssertNotEqual(String(context.viewState.footerMessage.characters), L10n.screenChangeServerFormNotice(L10n.actionLearnMore),
+                          "The error message should be shown.")
+        
+        // And when clearing the error.
+        deferred = deferFulfillment(context.$viewState) { !$0.isShowingFooterError }
+        context.homeserverAddress = ""
+        context.send(viewAction: .clearFooterError)
+        try await deferred.fulfill()
+        
+        // Then the error message should now be removed.
+        XCTAssertNil(context.viewState.footerErrorMessage, "The error message should have been cleared.")
+        XCTAssertEqual(String(context.viewState.footerMessage.characters), L10n.screenChangeServerFormNotice(L10n.actionLearnMore),
+                       "The standard footer message should be shown again.")
+    }
+    
+    // MARK: - Helpers
+    
+    private func setupViewModel(authenticationFlow: AuthenticationFlow) {
+        clientBuilderFactory = AuthenticationClientBuilderFactoryMock(configuration: .init())
+        service = AuthenticationService(userSessionStore: UserSessionStoreMock(configuration: .init()),
+                                        encryptionKeyProvider: EncryptionKeyProvider(),
+                                        clientBuilderFactory: clientBuilderFactory,
+                                        appSettings: ServiceLocator.shared.settings,
+                                        appHooks: AppHooks())
+        
+        viewModel = ServerSelectionScreenViewModel(authenticationService: service,
+                                                   authenticationFlow: authenticationFlow,
+                                                   slidingSyncLearnMoreURL: ServiceLocator.shared.settings.slidingSyncLearnMoreURL,
+                                                   userIndicatorController: UserIndicatorControllerMock())
+    }
+}