Add step in Breadcrumbs to know where we are

Author: KevinBoulongne

app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/DraftController.kt

@@ -101,7 +101,7 @@ class DraftController @Inject constructor(
                         resource = previousMessage.attachments.find { it.name == name }?.resource
                         setUploadStatus(UploadStatus.FINISHED)
                     }
-                    SentryDebug.addAttachmentsBreadcrumb(draft)
+                    SentryDebug.addAttachmentsBreadcrumb(draft, step = "set previousMessage when reply/replyAll/Forward")
                 }
 
                 draft.uiQuote = replyForwardFooterManager.createForwardFooter(previousMessage, draft.attachments)

app/src/main/java/com/infomaniak/mail/data/models/Attachment.kt

@@ -85,11 +85,11 @@ class Attachment : EmbeddedRealmObject, Attachable {
     fun backupLocalData(oldAttachment: Attachment, uploadStatus: UploadStatus, draft: Draft) {
         localUuid = oldAttachment.localUuid
         uploadLocalUri = oldAttachment.uploadLocalUri
-        setUploadStatus(uploadStatus, draft)
+        setUploadStatus(uploadStatus, draft, "backupLocalData -> setUploadStatus")
     }
 
-    fun setUploadStatus(uploadStatus: UploadStatus, draft: Draft? = null) {
-        draft?.let(SentryDebug::addAttachmentsBreadcrumb)
+    fun setUploadStatus(uploadStatus: UploadStatus, draft: Draft? = null, step: String = "") {
+        draft?.let { SentryDebug.addAttachmentsBreadcrumb(it, step) }
         _uploadStatus = uploadStatus.name
     }
 

app/src/main/java/com/infomaniak/mail/ui/newMessage/NewMessageViewModel.kt

@@ -340,7 +340,7 @@ class NewMessageViewModel @Inject constructor(
 
         if (mailToUri != null) handleMailTo(draft, mailToUri)
 
-        SentryDebug.addAttachmentsBreadcrumb(draft)
+        SentryDebug.addAttachmentsBreadcrumb(draft, step = "populate Draft with external mail data")
     }
 
     private fun Draft.flagRecipientsAsAutomaticallyEntered() {
@@ -749,7 +749,12 @@ class NewMessageViewModel @Inject constructor(
     fun uploadAttachmentsToServer(uiAttachments: List<Attachment>) = viewModelScope.launch(ioDispatcher) {
         val localUuid = draftLocalUuid ?: return@launch
         val localDraft = mailboxContentRealm().writeBlocking {
-            DraftController.getDraft(localUuid, realm = this)?.also { it.updateDraftAttachmentsWithLiveData(uiAttachments) }
+            DraftController.getDraft(localUuid, realm = this)?.also {
+                it.updateDraftAttachmentsWithLiveData(
+                    uiAttachments = uiAttachments,
+                    step = "observeAttachments -> uploadAttachmentsToServer",
+                )
+            }
         } ?: return@launch
 
         runCatching {
@@ -815,7 +820,10 @@ class NewMessageViewModel @Inject constructor(
         cc = ccLiveData.valueOrEmpty().toRealmList()
         bcc = bccLiveData.valueOrEmpty().toRealmList()
 
-        updateDraftAttachmentsWithLiveData(attachmentsLiveData.valueOrEmpty())
+        updateDraftAttachmentsWithLiveData(
+            uiAttachments = attachmentsLiveData.valueOrEmpty(),
+            step = "executeDraftActionWhenStopping (action = ${draftAction.name}) -> updateDraftFromLiveData",
+        )
 
         subject = subjectValue
 
@@ -850,7 +858,7 @@ class NewMessageViewModel @Inject constructor(
         }
     }
 
-    private fun Draft.updateDraftAttachmentsWithLiveData(uiAttachments: List<Attachment>) {
+    private fun Draft.updateDraftAttachmentsWithLiveData(uiAttachments: List<Attachment>, step: String) {
 
         /**
          * If :
@@ -885,7 +893,7 @@ class NewMessageViewModel @Inject constructor(
             addAll(updatedAttachments)
         }
 
-        SentryDebug.addAttachmentsBreadcrumb(draft = this)
+        SentryDebug.addAttachmentsBreadcrumb(draft = this, step)
     }
 
     private fun Draft.getWholeBody(): String = uiBody.textToHtml() + (uiSignature ?: "") + (uiQuote ?: "")

app/src/main/java/com/infomaniak/mail/utils/DraftUtils.kt

@@ -49,10 +49,10 @@ private suspend fun Draft.uploadAttachments(mailbox: Mailbox, draftController: D
 
     fun getAwaitingAttachments(): List<Attachment> = attachments.filter { it.uploadStatus == UploadStatus.AWAITING }
 
-    fun setUploadStatus(attachment: Attachment, uploadStatus: UploadStatus) {
+    fun setUploadStatus(attachment: Attachment, uploadStatus: UploadStatus, step :String) {
         realm.writeBlocking {
             draftController.updateDraft(localUuid, realm = this) {
-                it.attachments.findSpecificAttachment(attachment)?.setUploadStatus(uploadStatus, draft = it)
+                it.attachments.findSpecificAttachment(attachment)?.setUploadStatus(uploadStatus, draft = it, step)
             }
         }
     }
@@ -69,10 +69,10 @@ private suspend fun Draft.uploadAttachments(mailbox: Mailbox, draftController: D
 
     attachmentsToUpload.forEach { attachment ->
         runCatching {
-            setUploadStatus(attachment, UploadStatus.ONGOING)
+            setUploadStatus(attachment, UploadStatus.ONGOING, step = "before starting upload")
             attachment.startUpload(localUuid, mailbox, draftController, realm)
         }.onFailure { exception ->
-            setUploadStatus(attachment, UploadStatus.AWAITING)
+            setUploadStatus(attachment, UploadStatus.AWAITING, step = "after failing upload")
             SentryLog.d(ATTACHMENT_TAG, "${exception.message}", exception)
             if ((exception as Exception).isNetworkException()) throw ApiController.NetworkException()
             throw exception

app/src/main/java/com/infomaniak/mail/utils/SentryDebug.kt

@@ -104,7 +104,7 @@ object SentryDebug {
         )
     }
 
-    fun addAttachmentsBreadcrumb(draft: Draft) = with(draft) {
+    fun addAttachmentsBreadcrumb(draft: Draft, step: String) = with(draft) {
 
         var count = 1
         val data = mutableMapOf<String, Any>()
@@ -114,6 +114,7 @@ object SentryDebug {
         fun count(): String = "${count.countPad().also { count++ }}."
         fun format(index: Int): String = (index + 1).countPad()
 
+        data[count() + "step".keyPad()] = step
         data[count() + "email".keyPad()] = AccountUtils.currentMailboxEmail.toString()
 
         data[count() + "draft".keyPad() + " - localUuid"] = localUuid

app/src/main/java/com/infomaniak/mail/utils/extensions/AttachmentExtensions.kt

@@ -201,7 +201,7 @@ object AttachmentExtensions {
                     add(remoteAttachment)
                 }
 
-                SentryDebug.addAttachmentsBreadcrumb(draft)
+                SentryDebug.addAttachmentsBreadcrumb(draft, step = "update local Attachment after success upload")
             }
         }
     }

app/src/main/java/com/infomaniak/mail/workers/DraftsActionsWorker.kt

@@ -302,7 +302,7 @@ class DraftsActionsWorker @AssistedInject constructor(
         var scheduledDate: String? = null
         var savedDraftUuid: String? = null
 
-        SentryDebug.addAttachmentsBreadcrumb(draft)
+        SentryDebug.addAttachmentsBreadcrumb(draft, step = "executeDraftAction (action = ${draft.action?.name.toString()})")
 
         // TODO: Remove this whole `draft.attachments.any { … }` + `addAttachmentsBreadcrumb()` when the Attachments issue is fixed.
         if (draft.attachments.any { it.uploadStatus != UploadStatus.FINISHED }) {