refactor: create local stores and UTS - WPB-12100

WireDomain/Sources/WireDomain/Event Processing/UserEventProcessor/UserClientAddEventProcessor.swift

@@ -41,11 +41,11 @@ struct UserClientAddEventProcessor: UserClientAddEventProcessorProtocol {
     func processEvent(_ event: UserClientAddEvent) async throws {
         do {
             let localUserClient = try await repository.fetchOrCreateClient(
-                with: event.client.id
+                id: event.client.id
             )
 
             try await repository.updateClient(
-                with: event.client.id,
+                id: event.client.id,
                 from: event.client,
                 isNewClient: localUserClient.isNew
             )

WireDomain/Sources/WireDomain/Repositories/Connections/ConnectionsLocalStore.swift

@@ -16,15 +16,16 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-import CoreData
-import Foundation
-import WireAPI
 import WireDataModel
 
-protocol ConnectionsLocalStoreProtocol {
+// sourcery: AutoMockable
+public protocol ConnectionsLocalStoreProtocol {
 
+    /// Save connection and related objects to local storage.
+    /// - Parameter connectionInfo: connection object
+
     func storeConnection(
-        _ connectionPayload: Connection
+        _ connectionInfo: ConnectionInfo
     ) async throws
 }
 
@@ -44,15 +45,12 @@ final class ConnectionsLocalStore: ConnectionsLocalStoreProtocol {
 
     // MARK: - Public
 
-    /// Save connection and related objects to local storage.
-    /// - Parameter connectionPayload: connection object from WireAPI
-
-    public func storeConnection(_ connectionPayload: Connection) async throws {
+    public func storeConnection(_ connectionInfo: ConnectionInfo) async throws {
         try await context.perform { [self] in
 
-            let connection = try storedConnection(from: connectionPayload)
+            let connection = try storedConnection(from: connectionInfo)
 
-            let conversation = try storedConversation(from: connectionPayload, with: connection)
+            let conversation = try storedConversation(from: connectionInfo, with: connection)
 
             connection.to.oneOnOneConversation = conversation
 
@@ -66,7 +64,10 @@ final class ConnectionsLocalStore: ConnectionsLocalStoreProtocol {
     ///   - storedConnection: ZMConnection object stored locally
     /// - Returns: conversation object stored locally
 
-    private func storedConversation(from connection: Connection, with storedConnection: ZMConnection) throws -> ZMConversation {
+    private func storedConversation(
+        from connection: ConnectionInfo,
+        with storedConnection: ZMConnection
+    ) throws -> ZMConversation {
         guard let conversationID = connection.conversationID ?? connection.qualifiedConversationID?.uuid else {
             throw ConnectionsRepositoryError.missingConversationId
         }
@@ -87,7 +88,9 @@ final class ConnectionsLocalStore: ConnectionsLocalStoreProtocol {
     /// - Parameter connection: connection payload from WireAPI
     /// - Returns: connection object stored locally
 
-    private func storedConnection(from connection: Connection) throws -> ZMConnection {
+    private func storedConnection(
+        from connection: ConnectionInfo
+    ) throws -> ZMConnection {
         guard let userID = connection.receiverID ?? connection.receiverQualifiedID?.uuid else {
             throw ConnectionsRepositoryError.missingReceiverId
         }
@@ -98,7 +101,7 @@ final class ConnectionsLocalStore: ConnectionsLocalStoreProtocol {
             in: context
         )
 
-        storedConnection.status = connection.status.toDomainModel()
+        storedConnection.status = connection.status
         storedConnection.lastUpdateDateInGMT = connection.lastUpdate
         return storedConnection
     }

WireDomain/Sources/WireDomain/Repositories/Connections/ConnectionsModelMappings.swift

@@ -41,3 +41,18 @@ extension WireAPI.ConnectionStatus {
     }
 
 }
+
+extension WireAPI.Connection {
+
+    func toDomainModel() -> ConnectionInfo {
+        .init(
+            senderID: senderID,
+            receiverID: receiverID,
+            receiverQualifiedID: receiverQualifiedID?.toDomainModel(),
+            conversationID: conversationID,
+            qualifiedConversationID: qualifiedConversationID?.toDomainModel(),
+            lastUpdate: lastUpdate,
+            status: status.toDomainModel()
+        )
+    }
+}

WireDomain/Sources/WireDomain/Repositories/Connections/ConnectionsRepository.swift

@@ -70,7 +70,7 @@ public struct ConnectionsRepository: ConnectionsRepositoryProtocol {
             await withThrowingTaskGroup(of: Void.self) { taskGroup in
                 for connection in connections {
                     taskGroup.addTask {
-                        try await connectionsLocalStore.storeConnection(connection)
+                        try await connectionsLocalStore.storeConnection(connection.toDomainModel())
                     }
                 }
             }
@@ -80,7 +80,7 @@ public struct ConnectionsRepository: ConnectionsRepositoryProtocol {
     public func updateConnection(
         _ connection: Connection
     ) async throws {
-        try await connectionsLocalStore.storeConnection(connection)
+        try await connectionsLocalStore.storeConnection(connection.toDomainModel())
     }
 
 }

WireDomain/Sources/WireDomain/Repositories/Connections/Models/ConnectionInfo.swift

@@ -0,0 +1,29 @@
+//
+// Wire
+// Copyright (C) 2024 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 WireDataModel
+
+public struct ConnectionInfo: Sendable {
+    public let senderID: UUID?
+    public let receiverID: UUID?
+    public let receiverQualifiedID: WireDataModel.QualifiedID?
+    public let conversationID: UUID?
+    public let qualifiedConversationID: WireDataModel.QualifiedID?
+    public let lastUpdate: Date
+    public let status: WireDataModel.ZMConnectionStatus
+}

WireDomain/Sources/WireDomain/Repositories/Conversations/ConversationLocalStore.swift

@@ -16,7 +16,6 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-import CoreData
 import WireAPI
 import WireDataModel
 

WireDomain/Sources/WireDomain/Repositories/ConversationsLabels/ConversationLabelsLocalStore.swift

@@ -0,0 +1,154 @@
+//
+// Wire
+// Copyright (C) 2024 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 WireDataModel
+
+// sourcery: AutoMockable
+public protocol ConversationLabelsLocalStoreProtocol {
+
+    /// Save label and related conversations objects to local storage.
+    /// - Parameter conversationLabel: conversation label from WireAPI
+
+    func storeLabel(
+        _ conversationLabel: ConversationLabelInfo
+    ) async throws
+
+    /// Delete old `folder` labels and related conversations objects from local storage.
+    /// - Parameter excludedLabels: remote labels that should be excluded from deletion.
+    /// - Only old labels of type `folder` are deleted, `favorite` labels always remain in the local storage.
+
+    func deleteOldLabelsLocally(
+        excludedLabels: [ConversationLabelInfo]
+    ) async throws
+}
+
+public final class ConversationLabelsLocalStore: ConversationLabelsLocalStoreProtocol {
+
+    // MARK: - Error
+
+    enum Error: Swift.Error {
+        case failedToStoreLabelLocally(UUID)
+    }
+
+    // MARK: - Properties
+
+    private let context: NSManagedObjectContext
+    private let logger = WireLogger(tag: "conversation-labels")
+
+    // MARK: - Object lifecycle
+
+    init(
+        context: NSManagedObjectContext
+    ) {
+        self.context = context
+    }
+
+    // MARK: - Public
+
+    /// Save label and related conversations objects to local storage.
+    /// - Parameter conversationLabel: conversation label from WireAPI
+
+    public func storeLabel(
+        _ conversationLabel: ConversationLabelInfo
+    ) async throws {
+        try await context.perform { [context] in
+            var created = false
+            let label: Label? = if conversationLabel.type == Label.Kind.favorite.rawValue {
+                Label.fetchFavoriteLabel(in: context)
+            } else {
+                Label.fetchOrCreate(remoteIdentifier: conversationLabel.id, create: true, in: context, created: &created)
+            }
+
+            guard let label else {
+                throw Error.failedToStoreLabelLocally(conversationLabel.id)
+            }
+
+            label.name = conversationLabel.name
+            label.kind = Label.Kind(rawValue: conversationLabel.type) ?? .folder
+
+            let conversations = ZMConversation.fetchObjects(
+                withRemoteIdentifiers: Set(conversationLabel.conversationIDs),
+                in: context
+            ) as? Set<ZMConversation> ?? Set()
+
+            label.conversations = conversations
+            label.modifiedKeys = nil
+
+            do {
+                try context.save()
+            } catch {
+                throw Error.failedToStoreLabelLocally(conversationLabel.id)
+            }
+        }
+    }
+
+    public func deleteOldLabelsLocally(
+        excludedLabels: [ConversationLabelInfo]
+    ) async throws {
+        try await context.perform { [self] in
+            let uuids = excludedLabels.map { $0.id.uuidData as NSData }
+            let predicateFormat = "type == \(Label.Kind.folder.rawValue) AND NOT remoteIdentifier_data IN %@"
+
+            let predicate = NSPredicate(
+                format: predicateFormat,
+                uuids as CVarArg
+            )
+
+            let fetchRequest: NSFetchRequest<NSFetchRequestResult>
+            fetchRequest = NSFetchRequest(entityName: Label.entityName())
+            fetchRequest.predicate = predicate
+
+            /// Since batch operations bypass the context processing,
+            /// relationships rules are often ignored (e.g delete rule)
+            /// Nevertheless, CoreData automatically handles two specific scenarios:
+            /// `Cascade` delete rule and `Nullify` delete rule on an optional property
+            /// Since `conversations` is nullify and optional, we can safely perform a batch delete.
+
+            let deleteRequest = NSBatchDeleteRequest(
+                fetchRequest: fetchRequest
+            )
+
+            deleteRequest.resultType = .resultTypeObjectIDs
+
+            do {
+                let batchDelete = try context.execute(deleteRequest) as? NSBatchDeleteResult
+
+                guard let deleteResult = batchDelete?.result as? [NSManagedObjectID] else {
+                    throw ConversationLabelsRepositoryError.failedToDeleteStoredLabels
+                }
+
+                let deletedObjects: [AnyHashable: Any] = [
+                    NSDeletedObjectsKey: deleteResult
+                ]
+
+                /// Since `NSBatchDeleteRequest` only operates at the SQL level (in the persistent store itself),
+                /// we need to manually update our in-memory objects after execution.
+
+                NSManagedObjectContext.mergeChanges(
+                    fromRemoteContextSave: deletedObjects,
+                    into: [context]
+                )
+
+            } catch {
+                logger.error("Failed to delete old labels: \(error)")
+                throw error
+            }
+        }
+    }
+
+}

WireDomain/Sources/WireDomain/Repositories/ConversationsLabels/ConversationLabelsModelMappings.swift

@@ -0,0 +1,32 @@
+//
+// Wire
+// Copyright (C) 2024 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 WireAPI
+
+extension WireAPI.ConversationLabel {
+
+    func toDomainModel() -> ConversationLabelInfo {
+        .init(
+            id: id,
+            name: name,
+            type: type,
+            conversationIDs: conversationIDs
+        )
+    }
+
+}