Log out (#174)

* Expose logout method from SDK * Use logout from SDK, refactor logging out states * Add some strings * Introduce `initialDisplayName` on `UIDevice` * Implement soft logout screen * Add `softLogout` test screen identifier * Add new fields into the client proxy and implement new delegate methods * Add new fields into the user session and observe new client callbacks * Implement updated login method * Add remote logout state and event into the state machine * Implement refreshing restore token on `UserSessionStore` * Update app coordinator with new states and display soft logout screen when appropriate * Add reference screenshots for soft logout screen * Disable auto requesting photos access on screenshot detection * Make initial device name optional, generate project file * Add changelog * Use logout from SDK, refactor logging out states * Implement soft logout screen * Implement updated login method * Make initial device name optional, generate project file * Fix renamed event * Fix logout race * Remove redundant strings * Reuse existing strings * Confirm clear all data * Expose logout method from SDK * Use logout from SDK, refactor logging out states * Add some strings * Introduce `initialDisplayName` on `UIDevice` * Implement soft logout screen * Add `softLogout` test screen identifier * Add new fields into the client proxy and implement new delegate methods * Add new fields into the user session and observe new client callbacks * Implement updated login method * Add remote logout state and event into the state machine * Implement refreshing restore token on `UserSessionStore` * Update app coordinator with new states and display soft logout screen when appropriate * Add reference screenshots for soft logout screen * Disable auto requesting photos access on screenshot detection * Make initial device name optional, generate project file * Add changelog * Use logout from SDK, refactor logging out states * Implement soft logout screen * Implement updated login method * Make initial device name optional, generate project file * Fix renamed event * Fix logout race * Remove redundant strings * Reuse existing strings * Confirm clear all data * Comment out new apis for now * Make the PR compile
2026-11-02 21:06:00 +00:00 · 2022-09-15 12:41:37 +03:00
parent 8967891e65
commit bf3c7e900f
37 changed files with 1237 additions and 63 deletions
@@ -0,0 +1,91 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import XCTest
+
+@testable import ElementX
+
+class SoftLogoutViewModelTests: XCTestCase {
+    let credentials = SoftLogoutCredentials(userId: "mock_user_id",
+                                            homeserverName: "https://matrix.org",
+                                            userDisplayName: "mock_username",
+                                            deviceId: "ABCDEFGH")
+
+    @MainActor func testInitialStateForMatrixOrg() {
+        let viewModel = SoftLogoutViewModel(credentials: credentials,
+                                            homeserver: .mockMatrixDotOrg,
+                                            keyBackupNeeded: true)
+        let context = viewModel.context
+
+        // Given a view model where the user hasn't yet sent the verification email.
+        XCTAssert(context.password.isEmpty, "The view model should start with an empty password.")
+        XCTAssertFalse(context.viewState.canSubmit, "The view model should start with an invalid password.")
+        XCTAssertEqual(context.viewState.loginMode, .password, "The view model should show login form for the given homeserver.")
+        XCTAssert(context.viewState.showRecoverEncryptionKeysMessage, "The view model should show recover encryption keys message.")
+    }
+
+    @MainActor func testInitialStateForMatrixOrgPasswordEntered() {
+        let viewModel = SoftLogoutViewModel(credentials: credentials,
+                                            homeserver: .mockMatrixDotOrg,
+                                            keyBackupNeeded: true,
+                                            password: "12345678")
+        let context = viewModel.context
+
+        // Given a view model where the user hasn't yet sent the verification email.
+        XCTAssertTrue(context.viewState.canSubmit, "The view model should start with a valid password.")
+        XCTAssertEqual(context.viewState.loginMode, .password, "The view model should show login form for the given homeserver.")
+        XCTAssert(context.viewState.showRecoverEncryptionKeysMessage, "The view model should show recover encryption keys message.")
+    }
+
+    @MainActor func testInitialStateForBasicServer() {
+        let viewModel = SoftLogoutViewModel(credentials: credentials,
+                                            homeserver: .mockBasicServer,
+                                            keyBackupNeeded: false)
+        let context = viewModel.context
+
+        // Given a view model where the user hasn't yet sent the verification email.
+        XCTAssert(context.password.isEmpty, "The view model should start with an empty password.")
+        XCTAssertFalse(context.viewState.canSubmit, "The view model should start with an invalid password.")
+        XCTAssertEqual(context.viewState.loginMode, .password, "The view model should show login form for the given homeserver.")
+        XCTAssertFalse(context.viewState.showRecoverEncryptionKeysMessage, "The view model should not show recover encryption keys message.")
+    }
+
+    @MainActor func testInitialStateForOIDC() {
+        let viewModel = SoftLogoutViewModel(credentials: credentials,
+                                            homeserver: .mockOIDC,
+                                            keyBackupNeeded: false)
+        let context = viewModel.context
+
+        // Given a view model where the user hasn't yet sent the verification email.
+        XCTAssert(context.password.isEmpty, "The view model should start with an empty password.")
+        XCTAssertFalse(context.viewState.canSubmit, "The view model should start with an invalid password.")
+        XCTAssertTrue(context.viewState.loginMode.supportsOIDCFlow, "The view model should show OIDC button for the given homeserver.")
+        XCTAssertFalse(context.viewState.showRecoverEncryptionKeysMessage, "The view model should not show recover encryption keys message.")
+    }
+
+    @MainActor func testInitialStateForUnsupported() {
+        let viewModel = SoftLogoutViewModel(credentials: credentials,
+                                            homeserver: .mockUnsupported,
+                                            keyBackupNeeded: false)
+        let context = viewModel.context
+
+        // Given a view model where the user hasn't yet sent the verification email.
+        XCTAssert(context.password.isEmpty, "The view model should start with an empty password.")
+        XCTAssertFalse(context.viewState.canSubmit, "The view model should start with an invalid password.")
+        XCTAssertEqual(context.viewState.loginMode, .unsupported, "The view model should show unsupported text for the given homeserver.")
+        XCTAssertFalse(context.viewState.showRecoverEncryptionKeysMessage, "The view model should not show recover encryption keys message.")
+    }
+}