chore: refactor SearchTask - WPB-23110

wire-ios-data-model/Source/ManagedObjectContext/CoreDataStack.swift

@@ -48,7 +48,6 @@
     var viewContext: NSManagedObjectContext { get }
     func newBackgroundContext() -> NSManagedObjectContext
     var syncContext: NSManagedObjectContext { get }
-    var searchContext: NSManagedObjectContext { get }
     var eventContext: NSManagedObjectContext { get }
 
 }
@@ -138,8 +137,6 @@
         return context
     }()
 
-    public lazy var searchContext: NSManagedObjectContext = messagesContainer.newBackgroundContext()
-
     public lazy var eventContext: NSManagedObjectContext = eventsContainer.newBackgroundContext()
 
     public let accountContainer: URL
@@ -253,7 +250,6 @@
 
         viewContext.tearDown()
         syncContext.tearDown()
-        searchContext.tearDown()
         eventContext.tearDown()
         closeStores()
     }
@@ -311,7 +307,6 @@
             await configureContextReferences()
             await configureViewContext(viewContext)
             await configureSyncContext(syncContext)
-            await configureSearchContext(searchContext)
 
         } catch {
             WireLogger.localStorage.critical(
@@ -374,7 +369,7 @@
 
     func configureViewContext(_ context: NSManagedObjectContext) async {
         context.markAsUIContext()
         await context.perform {
             context.localDomain = self.localDomain
             context.isFederationEnabled = self.isFederationEnabled
             context.createDispatchGroups()
@@ -386,17 +381,17 @@
     }
 
     func configureContextReferences() async {
         await viewContext.perform {
             self.viewContext.zm_sync = self.syncContext
         }
         await syncContext.perform {
             self.syncContext.zm_userInterface = self.viewContext
         }
     }
 
     func configureSyncContext(_ context: NSManagedObjectContext) async {
         // Note: markAsSyncContext() is now called in the lazy initializer
         await context.perform {
             context.localDomain = self.localDomain
             context.isFederationEnabled = self.isFederationEnabled
             context.createDispatchGroups()
@@ -413,22 +408,9 @@
         }
     }
 
-    func configureSearchContext(_ context: NSManagedObjectContext) async {
-        context.markAsSearch()
-        await context.perform {
-            context.localDomain = self.localDomain
-            context.isFederationEnabled = self.isFederationEnabled
-            context.createDispatchGroups()
-            self.dispatchGroup.map(context.addGroup(_:))
-            context.setupLocalCachedSessionAndSelfUser()
-            context.undoManager = nil
-            context.mergePolicy = NSMergePolicy(merge: .rollbackMergePolicyType)
-        }
-    }
-
     func configureEventContext(_ context: NSManagedObjectContext) async {
         await context.perform {
             context.createDispatchGroups()
             self.dispatchGroup.map(context.addGroup(_:))
         }
     }
@@ -557,7 +539,7 @@
 }
 
 // MARK: -
 
 public class PersistentContainer: NSPersistentContainer {
 
     var storeURL: URL? {

wire-ios-data-model/Source/ManagedObjectContext/NSManagedObjectContext+tests.h

@@ -22,7 +22,6 @@
 @interface NSManagedObjectContext (zmessagingTests)
 
 - (void)markAsSyncContext;
-- (void)markAsSearchContext;
 - (void)markAsUIContext;
 - (void)disableObjectRefresh;
 

wire-ios-data-model/Source/ManagedObjectContext/NSManagedObjectContext+zmessaging.h

@@ -25,7 +25,6 @@
 
 extern NSString * _Nonnull const IsUserInterfaceContextKey;
 extern NSString * _Nonnull const IsSyncContextKey;
-extern NSString * _Nonnull const IsSearchContextKey;
 extern NSString * _Nonnull const IsEventContextKey;
 
 @interface NSManagedObjectContext (zmessaging)
@@ -37,9 +36,6 @@ extern NSString * _Nonnull const IsEventContextKey;
 /// Inverse of @c zm_isSyncContext
 @property (readonly) BOOL zm_isUserInterfaceContext;
 
-/// Returns @c YES if the receiver is a context that is used for searching.
-@property (readonly) BOOL zm_isSearchContext;
-
 /// Returns @c YES if the context should refresh objects following the policy for the sync context
 @property (readonly) BOOL zm_shouldRefreshObjectsWithSyncContextPolicy;
 

wire-ios-data-model/Source/ManagedObjectContext/NSManagedObjectContext+zmessaging.m

@@ -31,7 +31,6 @@
 #import <WireDataModel/WireDataModel-Swift.h>
 
 NSString * const IsSyncContextKey = @"ZMIsSyncContext";
-NSString * const IsSearchContextKey = @"ZMIsSearchContext";
 NSString * const IsUserInterfaceContextKey = @"ZMIsUserInterfaceContext";
 NSString * const IsEventContextKey = @"ZMIsEventDecoderContext";
 
@@ -88,7 +87,7 @@ @implementation NSManagedObjectContext (zmessaging)
 
 - (BOOL)zm_isValidContext
 {
-    return self.zm_isSyncContext || self.zm_isUserInterfaceContext || self.zm_isSearchContext;
+    return self.zm_isSyncContext || self.zm_isUserInterfaceContext;
 }
 
 - (id)validUserInfoValueOfClass:(Class)class forKey:(NSString *)key
@@ -128,11 +127,6 @@ - (BOOL)zm_isUserInterfaceContext
     return [[self validUserInfoValueOfClass:[NSNumber class] forKey:IsUserInterfaceContextKey] boolValue];
 }
 
-- (BOOL)zm_isSearchContext
-{
-    return [self.userInfo[IsSearchContextKey] boolValue];
-}
-
 - (NSManagedObjectContext*)zm_syncContext
 {
     if (self.zm_isSyncContext) {
@@ -539,13 +533,6 @@ - (void)markAsSyncContext;
     }];
 }
 
-- (void)markAsSearchContext;
-{
-    [self performBlockAndWait:^{
-        self.userInfo[IsSearchContextKey] = @YES;
-    }];
-}
-
 - (void)markAsUIContext
 {
     [self performBlockAndWait:^{
@@ -558,7 +545,6 @@ - (void)resetContextType
     [self performBlockAndWait:^{
         self.userInfo[IsSyncContextKey] = @NO;
         self.userInfo[IsUserInterfaceContextKey] = @NO;
-        self.userInfo[IsSearchContextKey] = @NO;
     }];
 }
 

wire-ios-data-model/Source/Model/User/UserType+Federation.swift

@@ -16,8 +16,6 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-import Foundation
-
 extension UserType {
 
     func isFederating(with otherUser: UserType) -> Bool {

wire-ios-data-model/Source/Model/User/ZMSearchUser.swift

@@ -105,7 +105,7 @@ public class ZMSearchUser: NSObject, UserType {
         user?.objectId ?? remoteIdentifier!
     }
 
-    fileprivate weak var contextProvider: ContextProvider?
+    fileprivate weak var viewContext: NSManagedObjectContext?
     private let searchUsersCache: SearchUsersCache?
 
     fileprivate var internalDomain: String?
@@ -162,16 +162,12 @@ public class ZMSearchUser: NSObject, UserType {
     }
 
     public var isFederated: Bool {
-        guard let contextProvider else {
-            return false
-        }
-
-        return ZMUser.selfUser(inUserSession: contextProvider).isFederating(with: self)
+        guard let viewContext else { return false }
+        return ZMUser.selfUser(in: viewContext).isFederating(with: self)
     }
 
     public var isSelfUser: Bool {
         guard let user else { return false }
-
         return user.isSelfUser
     }
 
@@ -265,8 +261,8 @@ public class ZMSearchUser: NSObject, UserType {
     }
 
     public var oneToOneConversation: ZMConversation? {
-        if isTeamMember, let uiContext = contextProvider?.viewContext {
-            materialize(in: uiContext)?.oneToOneConversation
+        if isTeamMember, let viewContext {
+            materialize(in: viewContext)?.oneToOneConversation
         } else {
             user?.oneToOneConversation
         }
@@ -482,7 +478,7 @@ public class ZMSearchUser: NSObject, UserType {
 
     @objc
     public required init(
-        contextProvider: ContextProvider,
+        viewContext: NSManagedObjectContext,
         name: String,
         handle: String?,
         accentColor: ZMAccentColor?,
@@ -503,10 +499,10 @@ public class ZMSearchUser: NSObject, UserType {
         self.internalDomain = domain
         self.remoteIdentifier = existingUser?.remoteIdentifier ?? remoteIdentifier
         self.teamIdentifier = existingUser?.teamIdentifier ?? teamIdentifier
-        self.contextProvider = contextProvider
+        self.viewContext = viewContext
         self.searchUsersCache = searchUsersCache
 
-        let selfUser = ZMUser.selfUser(inUserSession: contextProvider)
+        let selfUser = ZMUser.selfUser(in: viewContext)
         self.internalIsTeamMember = teamIdentifier != nil && selfUser.teamIdentifier == teamIdentifier
         self.internalIsConnected = internalIsTeamMember
 
@@ -524,7 +520,7 @@ public class ZMSearchUser: NSObject, UserType {
         searchUsersCache: SearchUsersCache?
     ) {
         self.init(
-            contextProvider: contextProvider,
+            viewContext: contextProvider.viewContext,
             name: user.name ?? "",
             handle: user.handle,
             accentColor: user.zmAccentColor,
@@ -556,7 +552,7 @@ public class ZMSearchUser: NSObject, UserType {
         let accentColorRawValue = (payload["accent_id"] as? NSNumber)?.int16Value ?? 0
 
         self.init(
-            contextProvider: contextProvider,
+            viewContext: contextProvider.viewContext,
             name: name,
             handle: handle,
             accentColor: .from(rawValue: accentColorRawValue) ?? .default,
@@ -611,7 +607,7 @@ public class ZMSearchUser: NSObject, UserType {
     }
 
     public func connect(completion: @escaping (Error?) -> Void) {
-        let selfUser = ZMUser.selfUser(inUserSession: contextProvider!)
+        let selfUser = ZMUser.selfUser(in: viewContext!)
         selfUser.sendConnectionRequest(to: self) { [weak self] result in
             switch result {
             case .success:
@@ -628,7 +624,7 @@ public class ZMSearchUser: NSObject, UserType {
     private func updateLocalUser() {
         guard
             let userID = remoteIdentifier,
-            let viewContext = contextProvider?.viewContext
+            let viewContext
         else {
             return
         }
@@ -637,7 +633,7 @@ public class ZMSearchUser: NSObject, UserType {
     }
 
     private func notifySearchUserChanged() {
-        contextProvider?.viewContext.searchUserObserverCenter.notifyUpdatedSearchUser(self)
+        viewContext?.searchUserObserverCenter.notifyUpdatedSearchUser(self)
     }
 
     public func accept(completion: @escaping (Error?) -> Void) {
@@ -671,7 +667,7 @@ public class ZMSearchUser: NSObject, UserType {
 
         if let user {
             user.requestPreviewProfileImage()
-        } else if let notificationContext = contextProvider?.viewContext.notificationContext {
+        } else if let notificationContext = viewContext?.notificationContext {
             NotificationInContext(
                 name: .searchUserDidRequestPreviewAsset,
                 context: notificationContext,
@@ -686,7 +682,7 @@ public class ZMSearchUser: NSObject, UserType {
 
         if let user {
             user.requestCompleteProfileImage()
-        } else if let notificationContext = contextProvider?.viewContext.notificationContext {
+        } else if let notificationContext = viewContext?.notificationContext {
             NotificationInContext(
                 name: .searchUserDidRequestCompleteAsset,
                 context: notificationContext,
@@ -731,7 +727,7 @@ public class ZMSearchUser: NSObject, UserType {
             internalCompleteImageData = imageData
         }
 
-        contextProvider?.viewContext.searchUserObserverCenter.notifyUpdatedSearchUser(self)
+        viewContext?.searchUserObserverCenter.notifyUpdatedSearchUser(self)
     }
 
     public func update(from payload: [String: Any]) {

wire-ios-data-model/Source/Model/User/ZMUser.m

@@ -154,7 +154,7 @@
 @end
 
 
 
 @implementation ZMUser
 
 + (NSSet<NSString *> *)keyPathsForValuesAffectingIsApp
@@ -717,17 +717,6 @@
 @end
 
 
-@implementation ZMUser (Utilities)
-
-+ (ZMUser<ZMEditableUserType> *)selfUserInUserSession:(id<ZMContextProvider>)session
-{
-    VerifyReturnNil(session != nil);
-    return [self selfUserInContext:session.viewContext];
-}
-
-@end
-
-
 
 
 @implementation ZMUser (Editable)

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-data-model/Source/Public/ZMUser.h

@@ -83,15 +83,6 @@ typedef NS_ENUM(int16_t, ZMBlockState) {
 @end
 
 
-@protocol ZMEditableUserType;
-
-@interface ZMUser (Utilities)
-
-+ (ZMUser<ZMEditableUserType> *_Nonnull)selfUserInUserSession:(id<ZMContextProvider> _Nonnull)session;
-
-@end
-
-
 
 
 @interface ZMUser (Connections)

wire-ios-data-model/Tests/Source/Model/Observer/SearchUserObserverCenterTests.swift

@@ -170,7 +170,7 @@ final class SearchUserObserverCenterTests: ModelObjectsTests {
         user: ZMUser? = nil
     ) -> ZMSearchUser {
         ZMSearchUser(
-            contextProvider: coreDataStack,
+            viewContext: coreDataStack.viewContext,
             name: name,
             handle: handle,
             accentColor: accentColor,

wire-ios-data-model/Tests/Source/Model/Observer/SearchUserObserverTests.swift

@@ -137,7 +137,7 @@ final class SearchUserObserverTests: NotificationDispatcherTestBase {
         user: ZMUser? = nil
     ) -> ZMSearchUser {
         ZMSearchUser(
-            contextProvider: coreDataStack,
+            viewContext: coreDataStack.viewContext,
             name: name,
             handle: name.lowercased(),
             accentColor: .amber,

wire-ios-data-model/Tests/Source/Model/Observer/SearchUserSnapshotTests.swift

@@ -225,7 +225,7 @@ final class SearchUserSnapshotTests: ZMBaseManagedObjectTest {
         user: ZMUser? = nil
     ) -> ZMSearchUser {
         ZMSearchUser(
-            contextProvider: coreDataStack,
+            viewContext: coreDataStack.viewContext,
             name: name,
             handle: handle,
             accentColor: accentColor,

wire-ios-data-model/Tests/Source/Model/User/ZMSearchUserTests+Connections.swift

@@ -24,7 +24,7 @@ final class ZMSearchUserTests_Connections: ModelObjectsTests {
     func testThatConnectSendsAConnectToUserNotification() {
         // given
         let searchUser = ZMSearchUser(
-            contextProvider: coreDataStack,
+            viewContext: coreDataStack.viewContext,
             name: "John Doe",
             handle: "johndoe",
             accentColor: .turquoise,

wire-ios-data-model/Tests/Source/Model/User/ZMSearchUserTests+ProfileImages.swift

@@ -177,7 +177,7 @@ final class ZMSearchUserTests_ProfileImages: ZMBaseManagedObjectTest {
         user: ZMUser? = nil
     ) -> ZMSearchUser {
         ZMSearchUser(
-            contextProvider: coreDataStack,
+            viewContext: coreDataStack.viewContext,
             name: name,
             handle: name.lowercased(),
             accentColor: .amber,

wire-ios-data-model/Tests/Source/Model/User/ZMSearchUserTests+TeamUser.swift

@@ -73,7 +73,7 @@ final class ZMSearchUserTests_TeamUser: ModelObjectsTests {
 
     private func makeSearchUser(teamIdentifier: UUID?) -> ZMSearchUser {
         ZMSearchUser(
-            contextProvider: coreDataStack,
+            viewContext: coreDataStack.viewContext,
             name: "Foo",
             handle: "foo",
             accentColor: .amber,