docs: Add explanatory comment about .asReversed() when deleting Rea…

…lm objects
Infomaniak · Mar 5, 2025 · 6913618 · 6913618
1 parent d15d066
commit 6913618
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/FolderController.kt b/app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/FolderController.kt
@@ -105,6 +105,11 @@ class FolderController @Inject constructor(
     }
 
     private fun MutableRealm.deleteOutdatedFolders(mailbox: Mailbox, remoteFolders: List<Folder>) {
+        /**
+         * This list is reversed because we'll delete items while looping over it.
+         * Doing so for managed Realm objects will lively update the list we're iterating through, making us skip the next item.
+         * Looping in reverse enables us to not skip any item.
+         */
         getFolders(exceptionsFoldersIds = remoteFolders.map { it.id }, realm = this).asReversed().forEach { folder ->
             deleteLocalFolder(mailbox, folder)
         }

diff --git a/app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/MessageController.kt b/app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/MessageController.kt
@@ -229,6 +229,11 @@ class MessageController @Inject constructor(private val mailboxContentRealm: Rea
         }
 
         fun deleteMessages(context: Context, mailbox: Mailbox, messages: List<Message>, realm: MutableRealm) {
+            /**
+             * This list is reversed because we'll delete items while looping over it.
+             * Doing so for managed Realm objects will lively update the list we're iterating through, making us skip the next item.
+             * Looping in reverse enables us to not skip any item.
+             */
             messages.asReversed().forEach { message ->
                 deleteMessage(context, mailbox, message, realm)
             }

diff --git a/app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/RefreshController.kt b/app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/RefreshController.kt
@@ -452,6 +452,11 @@ class RefreshController @Inject constructor(
 
             val message = MessageController.getMessage(uid = shortUid.toLongUid(folderId), realm = this) ?: return@forEach
 
+            /**
+             * This list is reversed because we'll delete items while looping over it.
+             * Doing so for managed Realm objects will lively update the list we're iterating through, making us skip the next item.
+             * Looping in reverse enables us to not skip any item.
+             */
             message.threads.asReversed().forEach { thread ->
                 scope.ensureActive()
 

diff --git a/app/src/main/java/com/infomaniak/mail/workers/DraftsActionsWorker.kt b/app/src/main/java/com/infomaniak/mail/workers/DraftsActionsWorker.kt
@@ -139,6 +139,11 @@ class DraftsActionsWorker @AssistedInject constructor(
 
         var haveAllDraftsSucceeded = true
 
+        /**
+         * This list is reversed because we'll delete items while looping over it.
+         * Doing so for managed Realm objects will lively update the list we're iterating through, making us skip the next item.
+         * Looping in reverse enables us to not skip any item.
+         */
         drafts.asReversed().forEach { draft ->
 
             val isTargetDraft = draft.localUuid == draftLocalUuid