Require acknowledgement to send to verified users who have unsigned devices or have changed their identity. (#3215)

* Refactor HeroImage style. * Add a screen to resolve (crypto-related) timeline item send failures. * Refactor send failures. * Update the SDK.
2026-11-02 12:07:55 +00:00 · 2024-09-10 09:56:11 +01:00
parent f6c8aae09e
commit cc4942fb78
86 changed files with 1422 additions and 158 deletions
@@ -0,0 +1,121 @@
+//
+// 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
+
+@MainActor
+class ResolveVerifiedUserSendFailureScreenViewModelTests: XCTestCase {
+    let roomProxy = JoinedRoomProxyMock(.init())
+    var viewModel: ResolveVerifiedUserSendFailureScreenViewModel!
+    var context: ResolveVerifiedUserSendFailureScreenViewModel.Context { viewModel.context }
+    
+    func testUnsignedDevice() async throws {
+        // Given a failure where a single user has an unverified device
+        let userID = "@alice:matrix.org"
+        viewModel = makeViewModel(with: .hasUnsignedDevice(devices: [userID: ["DEVICE1"]]))
+        
+        try await verifyResolving(userIDs: [userID])
+    }
+    
+    func testMultipleUnsignedDevices() async throws {
+        // Given a failure where a multiple users have unverified devices.
+        let userIDs = ["@alice:matrix.org", "@bob:matrix.org", "@charlie:matrix.org"]
+        let devices = Dictionary(uniqueKeysWithValues: userIDs.map { (key: $0, value: ["DEVICE1, DEVICE2"]) })
+        viewModel = makeViewModel(with: .hasUnsignedDevice(devices: devices))
+        
+        try await verifyResolving(userIDs: userIDs, assertStrings: false)
+    }
+    
+    func testChangedIdentity() async throws {
+        // Given a failure where a single user's identity has changed.
+        let userID = "@alice:matrix.org"
+        viewModel = makeViewModel(with: .changedIdentity(users: [userID]))
+        
+        try await verifyResolving(userIDs: [userID])
+    }
+    
+    func testMultipleChangedIdentities() async throws {
+        // Given a failure where a multiple users have unverified devices.
+        let userIDs = ["@alice:matrix.org", "@bob:matrix.org", "@charlie:matrix.org"]
+        viewModel = makeViewModel(with: .changedIdentity(users: userIDs))
+        
+        try await verifyResolving(userIDs: userIDs)
+    }
+    
+    // MARK: Helpers
+    
+    private func makeViewModel(with failure: TimelineItemSendFailure.VerifiedUser) -> ResolveVerifiedUserSendFailureScreenViewModel {
+        ResolveVerifiedUserSendFailureScreenViewModel(failure: failure, itemID: .random, roomProxy: roomProxy)
+    }
+    
+    private func verifyResolving(userIDs: [String], assertStrings: Bool = true) async throws {
+        var remainingUserIDs = userIDs
+        
+        while remainingUserIDs.count > 1 {
+            // Verify that the strings are being updated.
+            if assertStrings {
+                verifyDisplayName(from: remainingUserIDs)
+            }
+            
+            // When resolving the first failure.
+            let deferredFailure = deferFailure(viewModel.actionsPublisher, timeout: 1) { $0.isDismiss }
+            context.send(viewAction: .resolveAndResend)
+            
+            // Then the sheet should remain open for the next failure.
+            try await deferredFailure.fulfill()
+            
+            remainingUserIDs.removeFirst()
+        }
+        
+        // Verify the final string.
+        if assertStrings {
+            verifyDisplayName(from: remainingUserIDs)
+        }
+        
+        // When resolving the final failure.
+        let deferred = deferFulfillment(viewModel.actionsPublisher) { $0.isDismiss }
+        context.send(viewAction: .resolveAndResend)
+        
+        // Then the sheet should be dismissed.
+        try await deferred.fulfill()
+    }
+    
+    private func verifyDisplayName(from remainingUserIDs: [String]) {
+        guard let userID = remainingUserIDs.first else {
+            XCTFail("There should be a user ID to check.")
+            return
+        }
+        
+        guard let displayName = roomProxy.membersPublisher.value.first(where: { $0.userID == userID })?.displayName else {
+            XCTFail("There should be a matching mock user")
+            return
+        }
+        
+        XCTAssertTrue(context.viewState.title.contains(displayName))
+        XCTAssertTrue(context.viewState.subtitle.contains(displayName))
+    }
+}
+
+private extension ResolveVerifiedUserSendFailureScreenViewModelAction {
+    var isDismiss: Bool {
+        switch self {
+        case .dismiss: true
+        default: false
+        }
+    }
+}