refactor: Use transaction based APIs for Mail (#1398)

Mail/Proxy/Implementation/MessageActionHandler.swift

@@ -98,10 +98,7 @@ public struct MessageActionHandler: MessageActionHandlable {
 
     /// Silently move mail to a specified folder
     private func moveMessage(uid: String, to folderRole: FolderRole, mailboxManager: MailboxManager) async throws {
-        let realm = mailboxManager.getRealm()
-        realm.refresh()
-
-        guard let notificationMessage = realm.object(ofType: Message.self, forPrimaryKey: uid) else {
+        guard let notificationMessage = mailboxManager.fetchObject(ofType: Message.self, forPrimaryKey: uid) else {
             throw ErrorDomain.messageNotFoundInDatabase
         }
 

Mail/Utils/DraftUtils.swift

@@ -31,7 +31,7 @@ enum DraftUtils {
     ) {
         guard let message = thread.messages.first else { return }
         // If we already have the draft locally, present it directly
-        if let draft = mailboxManager.draft(messageUid: message.uid, using: nil)?.detached() {
+        if let draft = mailboxManager.draft(messageUid: message.uid)?.detached() {
             matomoOpenDraft(isLoadedRemotely: false)
             composeMessageIntent.wrappedValue = ComposeMessageIntent.existing(draft: draft, originMailboxManager: mailboxManager)
         } else {
@@ -45,7 +45,7 @@ enum DraftUtils {
         composeMessageIntent: Binding<ComposeMessageIntent?>
     ) {
         // If we already have the draft locally, present it directly
-        if let draft = mailboxManager.draft(messageUid: message.uid, using: nil)?.detached() {
+        if let draft = mailboxManager.draft(messageUid: message.uid)?.detached() {
             matomoOpenDraft(isLoadedRemotely: false)
             composeMessageIntent.wrappedValue = ComposeMessageIntent.existing(draft: draft, originMailboxManager: mailboxManager)
             // Draft comes from API, we will update it after showing the ComposeMessageView

Mail/Views/AI Writer/AIModel.swift

@@ -276,7 +276,7 @@ extension AIModel {
 
 extension AIModel {
     private func getLiveDraft() -> Draft? {
-        return mailboxManager.getRealm().object(ofType: Draft.self, forPrimaryKey: draft.localUUID)
+        return mailboxManager.fetchObject(ofType: Draft.self, forPrimaryKey: draft.localUUID)
     }
 
     private func shouldOverrideSubject() -> Bool {

Mail/Views/Bottom sheets/Actions/ContactActionsView/ContactActionsView.swift

@@ -30,7 +30,7 @@ struct ContactActionsView: View {
     let recipient: Recipient
 
     private var actions: [Action] {
-        let contact = mailboxManager.contactManager.getContact(for: recipient, realm: nil)
+        let contact = mailboxManager.contactManager.getContact(for: recipient)
 
         if contact?.isRemote == true {
             return [.writeEmailAction, .copyEmailAction]

Mail/Views/Menu Drawer/FolderListView.swift

@@ -40,7 +40,7 @@ struct FolderListView: View {
             UserFoldersListView(folders: viewModel.userFolders)
         }
         .onChange(of: mailboxManager) { newMailboxManager in
-            viewModel.updateFolderListForMailboxManager(newMailboxManager, animateInitialChanges: true)
+            viewModel.updateFolderListForMailboxManager(transactionable: newMailboxManager, animateInitialChanges: true)
         }
     }
 }

Mail/Views/Menu Drawer/FolderListViewModel.swift

@@ -18,6 +18,7 @@
 
 import Combine
 import Foundation
+import InfomaniakCoreDB
 import MailCore
 import RealmSwift
 import SwiftUI
@@ -38,7 +39,7 @@ import SwiftUI
 
     init(mailboxManager: MailboxManageable, foldersQuery: @escaping (Query<Folder>) -> Query<Bool> = { $0.toolType == nil }) {
         self.foldersQuery = foldersQuery
-        updateFolderListForMailboxManager(mailboxManager, animateInitialChanges: false)
+        updateFolderListForMailboxManager(transactionable: mailboxManager, animateInitialChanges: false)
 
         searchQueryObservation = $searchQuery
             .debounce(for: .milliseconds(150), scheduler: DispatchQueue.main)
@@ -49,23 +50,25 @@ import SwiftUI
             }
     }
 
-    func updateFolderListForMailboxManager(_ mailboxManager: MailboxManageable, animateInitialChanges: Bool) {
-        foldersObservationToken = mailboxManager.getRealm()
-            .objects(Folder.self).where(foldersQuery)
-            .observe(on: DispatchQueue.main) { [weak self] results in
-                guard let self else {
-                    return
-                }
-
-                switch results {
-                case .initial(let folders):
-                    processObservedFolders(folders, animated: animateInitialChanges)
-                case .update(let folders, _, _, _):
-                    processObservedFolders(folders, animated: true)
-                case .error:
-                    break
-                }
+    func updateFolderListForMailboxManager(transactionable: Transactionable, animateInitialChanges: Bool) {
+        let objects = transactionable.fetchResults(ofType: Folder.self) { partial in
+            partial.where(foldersQuery)
+        }
+
+        foldersObservationToken = objects.observe(on: DispatchQueue.main) { [weak self] results in
+            guard let self else {
+                return
             }
+
+            switch results {
+            case .initial(let folders):
+                processObservedFolders(folders, animated: animateInitialChanges)
+            case .update(let folders, _, _, _):
+                processObservedFolders(folders, animated: true)
+            case .error:
+                break
+            }
+        }
     }
 
     private func processObservedFolders(_ folders: Results<Folder>, animated: Bool) {

Mail/Views/New Message/ComposeMessageIntentView.swift

@@ -16,6 +16,7 @@
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+import InfomaniakCoreDB
 import InfomaniakDI
 import MailCore
 import MailCoreUI
@@ -98,7 +99,8 @@ struct ComposeMessageIntentView: View, IntentViewable {
         case .writeTo(let recipient):
             draftToWrite = Draft.writing(to: recipient)
         case .reply(let messageUid, let replyMode):
-            if let frozenMessage = mailboxManager.getRealm().object(ofType: Message.self, forPrimaryKey: messageUid)?.freeze() {
+            // TODO: Can we move this transaction away from the main actor ?
+            if let frozenMessage = mailboxManager.fetchObject(ofType: Message.self, forPrimaryKey: messageUid)?.freeze() {
                 let messageReply = MessageReply(frozenMessage: frozenMessage, replyMode: replyMode)
                 maybeMessageReply = messageReply
                 draftToWrite = Draft.replying(
@@ -114,7 +116,7 @@ struct ComposeMessageIntentView: View, IntentViewable {
 
         if let draftToWrite {
             let draftLocalUUID = draftToWrite.localUUID
-            writeDraftToRealm(mailboxManager.getRealm(), draft: draftToWrite)
+            writeDraftToRealm(mailboxManager, draft: draftToWrite)
 
             Task { @MainActor [maybeMessageReply] in
                 guard let liveDraft = mailboxManager.draft(localUuid: draftLocalUUID) else {
@@ -135,8 +137,8 @@ struct ComposeMessageIntentView: View, IntentViewable {
         }
     }
 
-    func writeDraftToRealm(_ realm: Realm, draft: Draft) {
-        try? realm.write {
+    func writeDraftToRealm(_ transactionable: Transactionable, draft: Draft) {
+        try? transactionable.writeTransaction { realm in
             draft.action = draft.action == nil && draft.remoteUUID.isEmpty ? .initialSave : .save
             draft.delay = UserDefaults.shared.cancelSendDelay.rawValue
 

Mail/Views/Search/SearchViewModel+Observation.swift

@@ -71,8 +71,9 @@ extension SearchViewModel {
 
         let allThreadsUIDs = frozenThreads.map(\.uid)
         let containAnyOf = NSPredicate(format: Self.containAnyOfUIDs, allThreadsUIDs)
-        let realm = mailboxManager.getRealm()
-        let allThreads = realm.objects(Thread.self).filter(containAnyOf)
+        let allThreads = mailboxManager.fetchResults(ofType: Thread.self) { partial in
+            partial.filter(containAnyOf)
+        }
 
         observationSearchResultsChangesToken = allThreads.observe(on: observeQueue) { [weak self] changes in
             guard let self else {

Mail/Views/Search/SearchViewModel.swift

@@ -125,7 +125,7 @@ enum SearchState {
 
         frozenRealFolder = folder.freezeIfNeeded()
         frozenSearchFolder = mailboxManager.initSearchFolder().freezeIfNeeded()
-        frozenFolderList = mailboxManager.getFrozenFolders(using: nil)
+        frozenFolderList = mailboxManager.getFrozenFolders()
 
         searchFieldObservation = $searchValue
             .debounce(for: .seconds(0.3), scheduler: DispatchQueue.main)

Mail/Views/SplitView.swift

@@ -238,7 +238,7 @@ struct SplitView: View {
             try await mailboxManager.refreshAllFolders()
 
             let selectedFolderId = mainViewState.selectedFolder.remoteId
-            guard mailboxManager.getRealm().object(ofType: Folder.self, forPrimaryKey: selectedFolderId) == nil else {
+            guard mailboxManager.fetchObject(ofType: Folder.self, forPrimaryKey: selectedFolderId) == nil else {
                 return
             }
 
@@ -306,10 +306,10 @@ struct SplitView: View {
                 try? await Task.sleep(nanoseconds: UInt64(0.5 * Double(NSEC_PER_SEC)))
             }
 
-            let realm = notificationMailboxManager.getRealm()
-
-            let tappedNotificationMessage = realm.object(ofType: Message.self, forPrimaryKey: notificationPayload.messageId)?
+            let tappedNotificationMessage = notificationMailboxManager.fetchObject(ofType: Message.self,
+                                                                                   forPrimaryKey: notificationPayload.messageId)?
                 .freezeIfNeeded()
+
             if notification.name == .onUserTappedNotification {
                 // Original parent should always be in the inbox but maybe change in a later stage to always find the parent in
                 // inbox

Mail/Views/Switch User/AccountListView.swift

@@ -39,21 +39,22 @@ final class AccountListViewModel: ObservableObject {
     private var mailboxObservationToken: NotificationToken?
 
     init() {
-        mailboxObservationToken = mailboxInfosManager.getRealm()
-            .objects(Mailbox.self)
-            .sorted(by: \.mailboxId)
-            .observe(on: DispatchQueue.main) { [weak self] results in
-                switch results {
-                case .initial(let mailboxes):
+        let mailboxes = mailboxInfosManager.fetchResults(ofType: Mailbox.self) { partial in
+            partial.sorted(by: \.mailboxId)
+        }
+
+        mailboxObservationToken = mailboxes.observe(on: DispatchQueue.main) { [weak self] results in
+            switch results {
+            case .initial(let mailboxes):
+                self?.handleMailboxChanged(Array(mailboxes))
+            case .update(let mailboxes, _, _, _):
+                withAnimation {
                     self?.handleMailboxChanged(Array(mailboxes))
-                case .update(let mailboxes, _, _, _):
-                    withAnimation {
-                        self?.handleMailboxChanged(Array(mailboxes))
-                    }
-                case .error:
-                    break
                 }
+            case .error:
+                break
             }
+        }
     }
 
     private func handleMailboxChanged(_ mailboxes: [Mailbox]) {

Mail/Views/Thread List/ThreadListViewModel+Observation.swift

@@ -133,10 +133,11 @@ extension ThreadListViewModel {
         }
 
         let containAnyOf = NSPredicate(format: Self.containAnyOfUIDs, allThreadsUIDs)
-        let realm = mailboxManager.getRealm()
-        let allThreads = realm.objects(Thread.self)
-            .filter(containAnyOf)
-            .sorted(by: \.date, ascending: false)
+        let allThreads = mailboxManager.fetchResults(ofType: Thread.self) { partial in
+            partial
+                .filter(containAnyOf)
+                .sorted(by: \.date, ascending: false)
+        }
 
         observeFilteredThreadsToken = allThreads.observe(on: observeQueue) { [weak self] changes in
             guard let self else { return }

Mail/Views/Thread/Message/MessageView+Preprocessing.swift

@@ -72,9 +72,7 @@ final class InlineAttachmentWorker {
 
     /// Private accessor on the message
     private var frozenMessage: Message? {
-        let realm = mailboxManager.getRealm()
-        let message = realm.object(ofType: Message.self, forPrimaryKey: messageUid)?.freezeIfNeeded()
-        return message
+        mailboxManager.fetchObject(ofType: Message.self, forPrimaryKey: messageUid)?.freezeIfNeeded()
     }
 
     /// A binding on the `PresentableBody` from `MessageView`

Mail/Views/Thread/OpenThreadIntentView.swift

@@ -72,10 +72,10 @@ struct OpenThreadIntentView: View, IntentViewable {
         }
 
         Task { @MainActor in
-            let realm = mailboxManager.getRealm()
-            guard let folder = realm.object(ofType: Folder.self, forPrimaryKey: openThreadIntent.folderId),
-                  let thread = mailboxManager.getRealm().object(ofType: Thread.self, forPrimaryKey: openThreadIntent.threadUid)
-            else {
+            guard let folder = mailboxManager.fetchObject(ofType: Folder.self,
+                                                          forPrimaryKey: openThreadIntent.folderId),
+                let thread = mailboxManager.fetchObject(ofType: Thread.self,
+                                                        forPrimaryKey: openThreadIntent.threadUid) else {
                 snackbarPresenter.show(message: MailError.localMessageNotFound.errorDescription ?? "")
                 return
             }

MailCore/Cache/Attachments/AttachmentsManagerWorker/AttachmentsManagerWorker.swift

@@ -20,6 +20,7 @@ import CocoaLumberjackSwift
 import Foundation
 import InfomaniakConcurrency
 import InfomaniakCore
+import InfomaniakCoreDB
 import UniformTypeIdentifiers
 
 /// Abstracts that some attachment was updated
@@ -69,6 +70,8 @@ public final class AttachmentsManagerWorker {
     private let backgroundRealm: BackgroundRealm
     private let draftLocalUUID: String
 
+    public let transactionExecutor: Transactionable
+
     private lazy var filenameDateFormatter: DateFormatter = {
         let formatter = DateFormatter()
         formatter.dateFormat = "yyyyMMdd_HHmmssSS"
@@ -88,8 +91,7 @@ public final class AttachmentsManagerWorker {
                 return
             }
 
-            let realm = backgroundRealm.getRealm()
-            guard let draft = realm.object(ofType: Draft.self, forPrimaryKey: draftLocalUUID),
+            guard let draft = transactionExecutor.fetchObject(ofType: Draft.self, forPrimaryKey: draftLocalUUID),
                   !draft.isInvalidated,
                   draft.subject.isEmpty else {
                 return
@@ -99,8 +101,11 @@ public final class AttachmentsManagerWorker {
                 return
             }
 
-            try? realm.write {
-                draft.subject = attachmentTitle
+            try? transactionExecutor.writeTransaction { writableRealm in
+                guard let liveDraft = writableRealm.object(ofType: Draft.self, forPrimaryKey: draftLocalUUID) else {
+                    return
+                }
+                liveDraft.subject = attachmentTitle
             }
         }
     }
@@ -109,6 +114,7 @@ public final class AttachmentsManagerWorker {
         self.backgroundRealm = backgroundRealm
         self.draftLocalUUID = draftLocalUUID
         self.mailboxManager = mailboxManager
+        transactionExecutor = TransactionExecutor(realmAccessible: backgroundRealm)
     }
 
     func addLocalAttachment(attachment: Attachment) async -> Attachment? {
@@ -295,7 +301,7 @@ public final class AttachmentsManagerWorker {
 
 extension AttachmentsManagerWorker: AttachmentsManagerWorkable {
     public var liveDraft: Draft? {
-        guard let liveDraft = backgroundRealm.getRealm().object(ofType: Draft.self, forPrimaryKey: draftLocalUUID),
+        guard let liveDraft = transactionExecutor.fetchObject(ofType: Draft.self, forPrimaryKey: draftLocalUUID),
               !liveDraft.isInvalidated else {
             return nil
         }