Move search users into a dedicated service (#789)

* add users provider with test * add ui test for search users * add changelog * Update ElementX/Sources/Services/Users/UsersProvider.swift Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com> * add error handling in usersprovider * remove empty section * add search in invite users * add CancellableTask, add setup App Settings in UnitTest, screenshots * rename of UserDiscoveryService * Update ElementX/Sources/Other/Extensions/Publisher.swift Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com> * new error management for User Discovery Service * Update ElementX/Sources/Other/CancellableTask.swift Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com> * Update ElementX/Sources/Services/Users/UserDiscoveryService.swift Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com> * fix invite users and start chat errors * use only one task to fetch user profile --------- Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com> Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>
2026-11-02 12:07:55 +00:00 · 2023-04-21 10:11:15 +02:00
parent b564036b68
commit 88d3faf77d
48 changed files with 549 additions and 236 deletions
@@ -0,0 +1,99 @@
+//
+// Copyright 2023 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 UserDiscoveryServiceTest: XCTestCase {
+    var service: UserDiscoveryService!
+    var clientProxy: MockClientProxy!
+    
+    override func setUpWithError() throws {
+        clientProxy = .init(userID: "")
+        service = UserDiscoveryService(clientProxy: clientProxy)
+    }
+    
+    func testQueryShowingResults() async throws {
+        clientProxy.searchUsersResult = .success(.init(results: [UserProfile.mockAlice], limited: true))
+        
+        let results = await (try? search(query: "AAA").get()) ?? []
+        assertSearchResults(results, toBe: 1)
+    }
+    
+    func testGetProfileIsNotCalled() async {
+        clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
+        clientProxy.getProfileResult = .success(.init(userID: "@alice:matrix.org"))
+        
+        let results = await (try? search(query: "AAA").get()) ?? []
+        assertSearchResults(results, toBe: 3)
+        XCTAssertFalse(clientProxy.getProfileCalled)
+    }
+    
+    func testLocalResultShows() async {
+        clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
+        clientProxy.getProfileResult = .success(.init(userID: "@some:matrix.org"))
+        
+        let results = await (try? search(query: "@a:b.com").get()) ?? []
+        
+        assertSearchResults(results, toBe: 4)
+        XCTAssertTrue(clientProxy.getProfileCalled)
+    }
+    
+    func testLocalResultWithDuplicates() async {
+        clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
+        clientProxy.getProfileResult = .success(.init(userID: "@bob:matrix.org"))
+        
+        let results = await (try? search(query: "@a:b.com").get()) ?? []
+        
+        assertSearchResults(results, toBe: 3)
+        let firstUserID = results.first?.userID
+        XCTAssertEqual(firstUserID, "@bob:matrix.org")
+        XCTAssertTrue(clientProxy.getProfileCalled)
+    }
+    
+    func testSearchResultsShowWhenGetProfileFails() async {
+        clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
+        clientProxy.getProfileResult = .failure(.failedGettingUserProfile)
+        
+        let results = await (try? search(query: "@a:b.com").get()) ?? []
+        
+        let firstUserID = results.first?.userID
+        XCTAssertEqual(firstUserID, "@a:b.com")
+        XCTAssertTrue(clientProxy.getProfileCalled)
+    }
+    
+    // MARK: - Private
+    
+    private func assertSearchResults(_ results: [UserProfile], toBe count: Int) {
+        XCTAssertTrue(count >= 0)
+        XCTAssertEqual(results.count, count)
+        XCTAssertEqual(results.isEmpty, count == 0)
+    }
+    
+    private func search(query: String) async -> Result<[UserProfile], UserDiscoveryErrorType> {
+        await service.searchProfiles(with: query)
+    }
+    
+    private var searchResults: [UserProfile] {
+        [
+            .mockAlice,
+            .mockBob,
+            .mockCharlie
+        ]
+    }
+}