chore: refactor SearchTask - WPB-20362

WireNetwork/Sources/WireNetwork/APIs/Rest/Search/SearchAPIV15.swift

@@ -82,6 +82,7 @@ private struct SearchResultContactV15: Decodable, ToAPIModelConvertible {
             documents: documents.map { $0.toAPIModel() }
         )
     }
+
 }
 
 private struct ContactV15: Decodable, ToAPIModelConvertible {

wire-ios-data-model/Source/Notifications/SearchUserObserverCenter.swift

@@ -37,7 +37,7 @@ extension NSManagedObjectContext {
     }
 }
 
-public class SearchUserSnapshot {
+public final class SearchUserSnapshot {
 
     /// Keys that we want to be notified for
     static let observableKeys: [String] = [

wire-ios-request-strategy/Sources/Request Strategies/Conversation/Actions/RemoveParticipantActionHandlerTests.swift

@@ -17,6 +17,7 @@
 //
 
 import XCTest
+
 @testable import WireRequestStrategy
 
 class RemoveParticipantActionHandlerTests: MessagingTestBase {

wire-ios-sync-engine/Source/Use cases/SearchUsersUseCase.swift

@@ -72,24 +72,14 @@ public final class SearchUsersUseCase: SearchUsersUseCaseProtocol {
             team: team
         )
 
-        return try await withCheckedThrowingContinuation { continuation in
-            // TODO: [WPB-23110] SWIFT TASK CONTINUATION MISUSE: invoke(query:options:messageProtocol:) leaked its continuation without resuming it. This may cause tasks waiting on it to remain suspended forever.
-            guard !Task.isCancelled else {
-                continuation.resume(throwing: CancellationError())
-                self.activeSearchTask = nil
-                return
+        let task = searchDirectory.createSearchTask(with: request)
+        activeSearchTask = task
+        defer {
+            if activeSearchTask === task {
+                activeSearchTask = nil
             }
-
-            let task = searchDirectory.perform(request)
-            task.addResultHandler { result, isCompleted in
-                if isCompleted {
-                    continuation.resume(returning: result)
-                    self.activeSearchTask = nil
-                }
-            }
-            task.start()
-            activeSearchTask = task
         }
+        return await task.start()
     }
 
     // MARK: - Private methods

wire-ios-sync-engine/Source/UserSession/Search/SearchDirectory.swift

@@ -18,14 +18,13 @@
 
 import Foundation
 
-@objcMembers
-public class SearchDirectory: NSObject {
+public final class SearchDirectory: NSObject {
 
-    let contextProvider: ContextProvider
-    let transportSession: TransportSessionType
+    private let contextProvider: ContextProvider
+    private let transportSession: TransportSessionType
     private let apiVersion: WireTransport.APIVersion?
 
-    var isTornDown = false
+    private var isTornDown = false
 
     private let refreshUsersMissingMetadataAction: RecurringAction
     private let refreshConversationsMissingMetadataAction: RecurringAction
@@ -64,50 +63,27 @@ public class SearchDirectory: NSObject {
         self.refreshConversationsMissingMetadataAction = refreshConversationsMissingMetadataAction
     }
 
-    /// Perform a search request.
-    ///
-    /// Returns a SearchTask which should be retained until the results arrive.
-    public func perform(_ request: SearchRequest) -> SearchTask {
-        let task = SearchTask(
-            task: .search(searchRequest: request),
+    public func createSearchTask(with request: SearchRequest) -> SearchTask {
+        SearchTask(
+            type: .search(searchRequest: request),
             contextProvider: contextProvider,
             transportSession: transportSession,
             searchUsersCache: searchUsersCache,
             apiVersion: apiVersion
         )
-
-        task.addResultHandler { [weak self] result, _ in
-            self?.observeSearchUsers(result)
-        }
-
-        return task
     }
 
     /// Lookup a user by user Id and domain (qualifiedID), returns a search user in the directory results. If the user
     /// doesn't exists
     /// an empty directory result is returned.
-    ///
-    /// Returns a SearchTask which should be retained until the results arrive.
-    public func lookup(qualifiedID: QualifiedID) -> SearchTask {
-        let task = SearchTask(
-            task: .lookup(qualifiedID: qualifiedID),
+    public func createLookupTask(with qualifiedID: QualifiedID) -> SearchTask {
+        SearchTask(
+            type: .lookup(qualifiedID: qualifiedID),
             contextProvider: contextProvider,
             transportSession: transportSession,
             searchUsersCache: searchUsersCache,
             apiVersion: apiVersion
         )
-
-        task.addResultHandler { [weak self] result, _ in
-            self?.observeSearchUsers(result)
-        }
-
-        return task
-    }
-
-    func observeSearchUsers(_ result: SearchResult) {
-        let searchUserObserverCenter = contextProvider.viewContext.searchUserObserverCenter
-        result.directory.forEach(searchUserObserverCenter.addSearchUser)
-        result.services.compactMap { $0 as? ZMSearchUser }.forEach(searchUserObserverCenter.addSearchUser)
     }
 
     public func updateIncompleteMetadataIfNeeded() async {

wire-ios-sync-engine/Source/UserSession/Search/SearchRequest.swift

@@ -16,10 +16,10 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-import Foundation
 import WireDataModel
 
 public struct SearchOptions: OptionSet {
+
     public let rawValue: Int
 
     /// Users you are connected to via connection request.
@@ -66,6 +66,7 @@ public struct SearchOptions: OptionSet {
 }
 
 public extension SearchOptions {
+
     mutating func updateForSelfUserTeamRole(selfUser: UserType) {
         if selfUser.teamRole == .partner {
             insert(.excludeNonActiveTeamMembers)
@@ -74,6 +75,7 @@ public extension SearchOptions {
             insert(.excludeNonActivePartners)
         }
     }
+
 }
 
 public struct SearchRequest {
@@ -169,4 +171,5 @@ private extension String {
         guard let normalized = self.normalizedForSearch() as String? else { return "" }
         return normalized.trimmingCharacters(in: .whitespaces)
     }
+
 }

wire-ios-sync-engine/Source/UserSession/Search/SearchResult.swift

@@ -52,6 +52,16 @@ public struct SearchResult {
 
 extension SearchResult {
 
+    init() {
+        self.context = .init(concurrencyType: .privateQueueConcurrencyType)
+        self.contacts = []
+        self.teamMembers = []
+        self.directory = []
+        self.conversations = []
+        self.services = []
+        self.searchUsersCache = nil
+    }
+
     public init?(
         payload: [AnyHashable: Any],
         query: SearchRequest.Query,
@@ -223,4 +233,16 @@ extension SearchResult {
         )
     }
 
+    func union(prependingDirectory result: SearchResult) -> SearchResult {
+        SearchResult(
+            context: context,
+            contacts: contacts,
+            teamMembers: teamMembers,
+            directory: result.directory + directory,
+            conversations: conversations,
+            services: services,
+            searchUsersCache: searchUsersCache
+        )
+    }
+
 }