chore: offload conversation calculation - WPB-17293

WireFoundation/Sources/WireFoundation/LeadingTrailingDebouncer.swift

@@ -0,0 +1,81 @@
+//
+// Wire
+// Copyright (C) 2025 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+public import Foundation
+
+public final class LeadingTrailingDebouncer<ID: Hashable> {
+
+    private struct DebounceState {
+        var isCooldown = false
+        var pendingCall: (() -> Void)?
+    }
+
+    private let cooldownTime: TimeInterval
+    private let queue: DispatchQueue
+    private var states: [AnyHashable: DebounceState] = [:]
+
+    // Unique key for `nil` ID
+    private let nilKey = UUID()
+
+    public init(cooldownTime: TimeInterval, queue: DispatchQueue = .main) {
+        self.cooldownTime = cooldownTime
+        self.queue = queue
+    }
+
+    public func call(id: ID?, block: @escaping () -> Void) {
+
+        let key: AnyHashable = id.map { AnyHashable($0) } ?? AnyHashable(nilKey)
+
+        if states[key] == nil {
+            states[key] = DebounceState()
+        }
+
+        var state = states[key]!
+
+        if !state.isCooldown {
+            // LEADING: run immediately
+            block()
+            state.isCooldown = true
+
+            queue.asyncAfter(deadline: .now() + cooldownTime) { [weak self] in
+                guard let self else { return }
+
+                var updatedState = states[key] ?? DebounceState()
+                updatedState.isCooldown = false
+
+                if let trailing = updatedState.pendingCall {
+                    trailing()
+                    updatedState.pendingCall = nil
+                    updatedState.isCooldown = true
+
+                    queue.asyncAfter(deadline: .now() + cooldownTime) {
+                        self.states[key]?.isCooldown = false
+                        self.states[key]?.pendingCall = nil
+                    }
+                }
+
+                states[key] = updatedState
+            }
+        } else {
+            // Store for TRAILING
+            state.pendingCall = block
+        }
+
+        states[key] = state
+    }
+}

WireFoundation/Sources/WireFoundation/ThreadSafeDictionary.swift

@@ -0,0 +1,57 @@
+//
+// Wire
+// Copyright (C) 2025 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+import Foundation
+
+public class ThreadSafeDictionary<Key: Hashable, Value> {
+
+    public init() {}
+
+    private var dictionary = [Key: Value]()
+    private let queue = DispatchQueue(label: "com.example.dictionaryQueue")
+
+    public func set(value: Value?, for key: Key) {
+        queue.async {
+            self.dictionary[key] = value
+        }
+    }
+
+    public func get(for key: Key) -> Value? {
+        queue.sync {
+            self.dictionary[key]
+        }
+    }
+
+    public func remove(for key: Key) {
+        queue.async {
+            self.dictionary.removeValue(forKey: key)
+        }
+    }
+
+    public func allItems() -> [Key: Value] {
+        queue.sync {
+            self.dictionary
+        }
+    }
+
+    public func reset() {
+        queue.async {
+            self.dictionary.removeAll()
+        }
+    }
+}

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

@@ -121,7 +121,7 @@
     public let accountContainer: URL
     public let applicationContainer: URL
 
-    let messagesContainer: PersistentContainer
+    public let messagesContainer: PersistentContainer
     let eventsContainer: PersistentContainer
     let dispatchGroup: ZMSDispatchGroup?
 
@@ -562,14 +562,14 @@
 
 // MARK: -
 
-class PersistentContainer: NSPersistentContainer {
+public class PersistentContainer: NSPersistentContainer {
 
     var storeURL: URL? {
         persistentStoreDescriptions.first?.url
     }
 
     var storeExists: Bool {
         guard let storeURL else {
             return false
         }
 

wire-ios-data-model/Source/Model/Conversation/ConversationLike.swift

@@ -24,6 +24,10 @@ public typealias Conversation = ConversationLike & SwiftConversationLike
 // sourcery: AutoMockable
 @objc
 public protocol ConversationLike: AnyObject {
+
+    // Any as type eraser to hide NSManagedObjectID behind it
+    var objectId: Any { get }
+
     var conversationType: ZMConversationType { get }
     var isSelfAnActiveMember: Bool { get }
     var teamRemoteIdentifier: UUID? { get }
@@ -70,6 +74,11 @@ public protocol SwiftConversationLike {
 }
 
 extension ZMConversation: ConversationLike {
+
+    public var objectId: Any {
+        objectID
+    }
+
     public var localParticipantsCount: Int {
         localParticipants.count
     }

wire-ios-data-model/Source/Model/Message/ConversationMessage.swift

@@ -152,9 +152,6 @@ public protocol ZMConversationMessage: NSObjectProtocol {
     /// The replies quoting this message.
     var replies: Set<ZMMessage> { get }
 
-    /// An in-memory identifier for tracking the message during its life cycle.
-    var objectIdentifier: String { get }
-
     /// The links attached to the message.
     var linkAttachments: [LinkAttachment]? { get set }
 
@@ -245,10 +242,6 @@ extension ZMMessage: ZMConversationMessage {
             .sortedAscendingPrependingNil(by: \.serverTimestamp)
     }
 
-    public var objectIdentifier: String {
-        nonpersistedObjectIdentifer
-    }
-
     public var causedSecurityLevelDegradation: Bool {
         false
     }

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

@@ -24,6 +24,9 @@ public protocol UserType: NSObjectProtocol, UserConnections {
     /// The identifier which uniquely idenitifies the user in its domain
     var remoteIdentifier: UUID! { get }
 
+    /// Any as type eraser to hide NSManagedObjectID behind it
+    var objectId: Any { get }
+
     /// The domain which the user originates from
     var domain: String? { get }
 

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

@@ -100,6 +100,9 @@ public class ZMSearchUser: NSObject, UserType {
     public var teamIdentifier: UUID?
     @objc public var user: ZMUser?
     public private(set) var hasDownloadedFullUserProfile: Bool = false
+    public var objectId: Any {
+        user?.objectId ?? remoteIdentifier!
+    }
 
     fileprivate weak var contextProvider: ContextProvider?
     private let searchUsersCache: SearchUsersCache?

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

@@ -312,6 +312,10 @@
         }
     }
 
+    var objectId: Any {
+        objectID
+    }
+
     /// combination of domain and remoteIdentifier
     @NSManaged private var primaryKey: String
 
@@ -479,7 +483,7 @@
         Set(participantRoles.compactMap(\.conversation))
     }
 }
 
 extension NSManagedObject: SafeForLoggingStringConvertible {
     public var safeForLoggingDescription: String {
         let moc: String = managedObjectContext?.description ?? "nil"

wire-ios-data-model/Source/Model/ZMManagedObject.m

@@ -768,33 +768,3 @@ - (BOOL)validateValue:(id *)ioValue forKey:(NSString *)key error:(NSError **)out
 }
 
 @end
-
-
-
-
-@implementation ZMManagedObject (NonpersistedObjectIdentifer)
-
-- (NSString *)nonpersistedObjectIdentifer;
-{
-    return [NSString stringWithFormat:@"Z%tx", (unsigned long) self];
-}
-
-+ (instancetype)existingObjectWithNonpersistedObjectIdentifer:(NSString *)identifier inUserSession:(id<ContextProvider>)userSession;
-{
-    VerifyReturnNil(identifier != nil);
-    intptr_t value = 0;
-    if (sscanf([identifier UTF8String], "Z%tx", &value) != 1) {
-        return nil;
-    }
-
-    NSManagedObjectContext *moc = userSession.viewContext;
-    for (ZMManagedObject *mo in moc.registeredObjects) {
-        intptr_t otherValue = (intptr_t) ((__bridge void *) mo);
-        if (otherValue == value) {
-            return mo;
-        }
-    }
-    return nil;
-}
-
-@end

wire-ios-data-model/Source/Public/ZMManagedObject.h

@@ -34,11 +34,3 @@ extern NSString * _Nonnull const ZMDataPropertySuffix;
 - (nullable NSString *)objectIDURLString;
 
 @end
-
-@interface ZMManagedObject (NonpersistedObjectIdentifer)
-
-@property (nonatomic, readonly, nonnull) NSString *nonpersistedObjectIdentifer;
-
-+ (nullable instancetype)existingObjectWithNonpersistedObjectIdentifer:(nullable NSString *)identifier inUserSession:(nonnull id<ContextProvider>)userSession;
-
-@end

wire-ios-data-model/Support/Sourcery/generated/AutoMockable.manual.swift

@@ -210,15 +210,6 @@ public class MockZMConversationMessage: NSObject, ZMConversationMessage {
 
     public var underlyingReplies: Set<ZMMessage>!
 
-    // MARK: - objectIdentifier
-
-    public var objectIdentifier: String {
-        get { return underlyingObjectIdentifier }
-        set(value) { underlyingObjectIdentifier = value }
-    }
-
-    public var underlyingObjectIdentifier: String!
-
     // MARK: - linkAttachments
 
     public var linkAttachments: [LinkAttachment]?

wire-ios-data-model/Tests/Source/Model/Messages/ZMClientMessageTests+Editing.swift

@@ -692,39 +692,4 @@ extension ZMClientMessageTests_Editing {
         XCTAssertEqual(editedMessage.textMessageData?.messageText, editedText)
         XCTAssertEqual(editedMessage, newMessage)
     }
-
-    func testThatMessageNonPersistedIdentifierDoesNotChangeAfterEdit() {
-        // given
-        let oldText = "Mamma mia"
-        let newText = "here we go again"
-        let oldNonce = UUID.create()
-
-        let sender = ZMUser.insertNewObject(in: uiMOC)
-        sender.remoteIdentifier = UUID.create()
-
-        let conversation = ZMConversation.insertNewObject(in: uiMOC)
-        conversation.remoteIdentifier = UUID.create()
-        let message: ZMMessage = try! conversation.appendText(content: oldText) as! ZMMessage
-        message.sender = sender
-        message.nonce = oldNonce
-
-        let oldIdentifier = message.nonpersistedObjectIdentifer
-        let updateEvent = createMessageEditUpdateEvent(
-            oldNonce: message.nonce!,
-            newNonce: UUID.create(),
-            conversationID: conversation.remoteIdentifier!,
-            senderID: message.sender!.remoteIdentifier!,
-            newText: newText
-        )
-
-        // when
-        var newMessage: ZMClientMessage?
-        performPretendingUiMocIsSyncMoc {
-            newMessage = ZMClientMessage.createOrUpdate(from: updateEvent!, in: self.uiMOC, prefetchResult: nil)
-        }
-
-        // then
-        XCTAssertNotEqual(oldNonce, newMessage!.nonce)
-        XCTAssertEqual(oldIdentifier, newMessage!.nonpersistedObjectIdentifer)
-    }
 }