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,77 @@
+//
+// 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 Foundation
+
+final class UserDiscoveryService: UserDiscoveryServiceProtocol {
+    private let clientProxy: ClientProxyProtocol
+    
+    init(clientProxy: ClientProxyProtocol) {
+        self.clientProxy = clientProxy
+    }
+    
+    func fetchSuggestions() async -> Result<[UserProfile], UserDiscoveryErrorType> {
+        .success([.mockAlice, .mockBob, .mockCharlie])
+    }
+    
+    func searchProfiles(with searchQuery: String) async -> Result<[UserProfile], UserDiscoveryErrorType> {
+        do {
+            async let queriedProfile = try? profileIfPossible(with: searchQuery).get()
+            async let searchedUsers = clientProxy.searchUsers(searchTerm: searchQuery, limit: 5)
+            let users = try await merge(searchQuery: searchQuery, queriedProfile: queriedProfile, searchResults: searchedUsers.get())
+            return .success(users)
+        } catch {
+            return .failure(.failedSearchingUsers)
+        }
+    }
+    
+    private func merge(searchQuery: String, queriedProfile: UserProfile?, searchResults: SearchUsersResults) -> [UserProfile] {
+        let localProfile = queriedProfile ?? UserProfile(searchQuery: searchQuery)
+        let searchResults = searchResults.results
+        guard let localProfile else {
+            return searchResults
+        }
+        
+        let filteredSearchResult = searchResults.filter {
+            $0.userID != localProfile.userID
+        }
+
+        return [localProfile] + filteredSearchResult
+    }
+    
+    private func profileIfPossible(with searchQuery: String) async -> Result<UserProfile, ClientProxyError> {
+        guard searchQuery.isMatrixIdentifier else {
+            return .failure(.failedGettingUserProfile)
+        }
+        
+        return await clientProxy.profile(for: searchQuery)
+    }
+}
+
+private extension String {
+    var isMatrixIdentifier: Bool {
+        MatrixEntityRegex.isMatrixUserIdentifier(self)
+    }
+}
+
+private extension UserProfile {
+    init?(searchQuery: String) {
+        guard searchQuery.isMatrixIdentifier else {
+            return nil
+        }
+        self.init(userID: searchQuery)
+    }
+}
@@ -0,0 +1,28 @@
+//
+// 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 Foundation
+
+enum UserDiscoveryErrorType: Error {
+    case failedSearchingUsers
+    case failedFetchingSuggestedUsers
+}
+
+// sourcery: AutoMockable
+protocol UserDiscoveryServiceProtocol {
+    func searchProfiles(with searchQuery: String) async -> Result<[UserProfile], UserDiscoveryErrorType>
+    func fetchSuggestions() async -> Result<[UserProfile], UserDiscoveryErrorType>
+}