Clean code before SuperCollapsedBlock feature

Author: KevinBoulongne

app/src/main/assets/icon_print_email.svg

@@ -69,14 +69,14 @@ object ApiRoutes {
     //endregion
 
     //region Calendar
-    fun calendarEvent(resource: String): String {
-        return "${resource(resource)}?format=render"
-    }
-
     fun infomaniakCalendarEventReply(calendarEventId: Int): String {
         return "${pim()}/event/$calendarEventId/reply"
     }
 
+    fun calendarEvent(resource: String): String {
+        return "${resource(resource)}?format=render"
+    }
+
     fun icsCalendarEventReply(resource: String): String {
         return "${resource(resource)}/reply"
     }

app/src/main/java/com/infomaniak/mail/data/api/ApiRoutes.kt

@@ -33,8 +33,6 @@ import io.realm.kotlin.notifications.ResultsChange
 import io.realm.kotlin.query.RealmQuery
 import io.realm.kotlin.query.RealmSingleQuery
 import io.realm.kotlin.query.Sort
-import io.sentry.Sentry
-import io.sentry.SentryLevel
 import kotlinx.coroutines.flow.Flow
 import javax.inject.Inject
 

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

@@ -210,8 +210,8 @@ class Message : RealmObject {
         draftLocalUuid?.let { this.draftLocalUuid = it }
         this.isFromSearch = isFromSearch
         this.messageIds = messageIds ?: computeMessageIds()
-        shortUid = uid.toShortUid()
         this.latestCalendarEventResponse = latestCalendarEventResponse
+        shortUid = uid.toShortUid()
     }
 
     fun keepHeavyData(message: Message) {

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

@@ -118,6 +118,31 @@ class ThreadListAdapter @Inject constructor(
         this.recyclerView = recyclerView
     }
 
+    override fun getItemViewType(position: Int): Int = runCatchingRealm {
+        val item = dataSet[position]
+        return when {
+            item is String -> DisplayType.DATE_SEPARATOR.layout
+            item is FolderRole -> DisplayType.FLUSH_FOLDER_BUTTON.layout
+            item is Unit -> DisplayType.LOAD_MORE_BUTTON.layout
+            displaySeeAllButton -> DisplayType.SEE_ALL_BUTTON.layout
+            else -> DisplayType.THREAD.layout
+        }
+    }.getOrDefault(super.getItemViewType(position))
+
+    override fun getItemId(position: Int): Long = runCatchingRealm {
+        return when (val item = dataSet[position]) {
+            is Thread -> item.uid.hashCode().toLong()
+            is String -> item.hashCode().toLong()
+            else -> super.getItemId(position)
+        }
+    }.getOrDefault(super.getItemId(position))
+
+    fun getItemPosition(threadUid: String): Int? {
+        return dataSet
+            .indexOfFirst { it is Thread && it.uid == threadUid }
+            .takeIf { position -> position != -1 }
+    }
+
     override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ThreadListViewHolder {
         val layoutInflater = LayoutInflater.from(parent.context)
         val binding = when (viewType) {
@@ -132,13 +157,17 @@ class ThreadListAdapter @Inject constructor(
     }
 
     override fun onBindViewHolder(holder: ThreadListViewHolder, position: Int, payloads: MutableList<Any>) = runCatchingRealm {
+
         val payload = payloads.firstOrNull()
+        if (payload !is NotificationType) {
+            super.onBindViewHolder(holder, position, payloads)
+            return@runCatchingRealm
+        }
+
         if (payload == NotificationType.SELECTED_STATE && holder.itemViewType == DisplayType.THREAD.layout) {
             val binding = holder.binding as CardviewThreadItemBinding
             val thread = dataSet[position] as Thread
             binding.updateSelectedUi(thread)
-        } else {
-            super.onBindViewHolder(holder, position, payloads)
         }
     }.getOrDefault(Unit)
 
@@ -152,31 +181,6 @@ class ThreadListAdapter @Inject constructor(
         }
     }
 
-    override fun getItemViewType(position: Int): Int = runCatchingRealm {
-        val item = dataSet[position]
-        return when {
-            item is String -> DisplayType.DATE_SEPARATOR.layout
-            item is FolderRole -> DisplayType.FLUSH_FOLDER_BUTTON.layout
-            item is Unit -> DisplayType.LOAD_MORE_BUTTON.layout
-            displaySeeAllButton -> DisplayType.SEE_ALL_BUTTON.layout
-            else -> DisplayType.THREAD.layout
-        }
-    }.getOrDefault(super.getItemViewType(position))
-
-    override fun getItemId(position: Int): Long = runCatchingRealm {
-        return when (val item = dataSet[position]) {
-            is Thread -> item.uid.hashCode().toLong()
-            is String -> item.hashCode().toLong()
-            else -> super.getItemId(position)
-        }
-    }.getOrDefault(super.getItemId(position))
-
-    fun getItemPosition(threadUid: String): Int? {
-        return dataSet
-            .indexOfFirst { it is Thread && it.uid == threadUid }
-            .takeIf { position -> position != -1 }
-    }
-
     private fun CardviewThreadItemBinding.displayThread(thread: Thread, position: Int) {
 
         refreshCachedSelectedPosition(thread.uid, position) // If item changed position, update cached position.

app/src/main/java/com/infomaniak/mail/ui/main/folder/ThreadListAdapter.kt

@@ -86,7 +86,9 @@ abstract class TwoPaneFragment : Fragment() {
     }
 
     private fun setupSlidingPane() = with(slidingPaneLayout) {
+
         lockMode = SlidingPaneLayout.LOCK_MODE_LOCKED
+
         addPanelSlideListener(object : SlidingPaneLayout.PanelSlideListener {
             override fun onPanelOpened(panel: View) = Unit
             override fun onPanelClosed(panel: View) = Unit

app/src/main/java/com/infomaniak/mail/ui/main/folder/TwoPaneFragment.kt

@@ -29,7 +29,7 @@ import androidx.navigation.fragment.navArgs
 import com.infomaniak.lib.core.utils.safeBinding
 import com.infomaniak.mail.R
 import com.infomaniak.mail.data.LocalSettings
-import com.infomaniak.mail.data.LocalSettings.*
+import com.infomaniak.mail.data.LocalSettings.AccentColor
 import com.infomaniak.mail.databinding.FragmentPermissionsOnboardingBinding
 import dagger.hilt.android.AndroidEntryPoint
 import javax.inject.Inject

app/src/main/java/com/infomaniak/mail/ui/main/onboarding/PermissionsOnboardingFragment.kt

@@ -45,7 +45,6 @@ class PrintMailFragment : Fragment() {
     private val printMailViewModel: PrintMailViewModel by viewModels()
     private val threadAdapter inline get() = binding.messagesList.adapter as ThreadAdapter
 
-
     @Inject
     lateinit var localSettings: LocalSettings
 

app/src/main/java/com/infomaniak/mail/ui/main/thread/PrintMailFragment.kt

@@ -46,7 +46,7 @@ import com.infomaniak.mail.data.models.calendar.Attendee.AttendanceState
 import com.infomaniak.mail.data.models.correspondent.Recipient
 import com.infomaniak.mail.data.models.message.Message
 import com.infomaniak.mail.databinding.ItemMessageBinding
-import com.infomaniak.mail.ui.main.thread.ThreadAdapter.ThreadViewHolder
+import com.infomaniak.mail.ui.main.thread.ThreadAdapter.MessageViewHolder
 import com.infomaniak.mail.utils.*
 import com.infomaniak.mail.utils.AttachmentIntentUtils.AttachmentIntentType
 import com.infomaniak.mail.utils.MailDateFormatUtils.mailFormattedDate
@@ -69,19 +69,21 @@ class ThreadAdapter(
     private val isForPrinting: Boolean = false,
     private val isCalendarEventExpandedMap: MutableMap<String, Boolean> = mutableMapOf(),
     private var threadAdapterCallbacks: ThreadAdapterCallbacks? = null,
-) : ListAdapter<Message, ThreadViewHolder>(MessageDiffCallback()) {
+) : ListAdapter<Message, MessageViewHolder>(MessageDiffCallback()) {
 
     inline val messages: MutableList<Message> get() = currentList
 
     var isExpandedMap = mutableMapOf<String, Boolean>()
+
+    //region Auto-scroll at Thread opening
     var initialSetOfExpandedMessagesUids = setOf<String>()
     private val currentSetOfLoadedExpandedMessagesUids = mutableSetOf<String>()
     private var hasNotScrolledYet = true
+    //endregion
 
     private val manuallyAllowedMessageUids = mutableSetOf<String>()
     var isThemeTheSameMap = mutableMapOf<String, Boolean>()
 
-
     private lateinit var recyclerView: RecyclerView
     private val webViewUtils by lazy { WebViewUtils(recyclerView.context) }
 
@@ -104,8 +106,8 @@ class ThreadAdapter(
 
     override fun getItemCount(): Int = runCatchingRealm { messages.count() }.getOrDefault(0)
 
-    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ThreadViewHolder {
-        return ThreadViewHolder(
+    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): MessageViewHolder {
+        return MessageViewHolder(
             ItemMessageBinding.inflate(LayoutInflater.from(parent.context), parent, false),
             shouldLoadDistantResources,
             threadAdapterCallbacks?.onContactClicked,
@@ -114,12 +116,12 @@ class ThreadAdapter(
         )
     }
 
-    override fun onBindViewHolder(holder: ThreadViewHolder, position: Int, payloads: MutableList<Any>) = runCatchingRealm {
+    override fun onBindViewHolder(holder: MessageViewHolder, position: Int, payloads: MutableList<Any>) = runCatchingRealm {
         with(holder.binding) {
             val payload = payloads.firstOrNull()
             if (payload !is NotifyType) {
                 super.onBindViewHolder(holder, position, payloads)
-                return
+                return@runCatchingRealm
             }
 
             val message = messages[position]
@@ -143,7 +145,7 @@ class ThreadAdapter(
         }
     }.getOrDefault(Unit)
 
-    override fun onBindViewHolder(holder: ThreadViewHolder, position: Int) = with(holder) {
+    override fun onBindViewHolder(holder: MessageViewHolder, position: Int) = with(holder) {
         val message = messages[position]
 
         initMapForNewMessage(message, position)
@@ -157,7 +159,7 @@ class ThreadAdapter(
         onExpandOrCollapseMessage(message, shouldTrack = false)
     }
 
-    private fun ThreadViewHolder.bindCalendarEvent(message: Message) {
+    private fun MessageViewHolder.bindCalendarEvent(message: Message) {
         val calendarAttachment = message.calendarAttachment ?: return
         val calendarEvent = message.latestCalendarEventResponse?.calendarEvent
 
@@ -200,14 +202,14 @@ class ThreadAdapter(
         if (isThemeTheSameMap[message.uid] == null) isThemeTheSameMap[message.uid] = true
     }
 
-    private fun ThreadViewHolder.toggleContentAndQuoteTheme(messageUid: String) = with(binding) {
+    private fun MessageViewHolder.toggleContentAndQuoteTheme(messageUid: String) = with(binding) {
         val isThemeTheSame = isThemeTheSameMap[messageUid]!!
         bodyWebView.toggleWebViewTheme(isThemeTheSame)
         fullMessageWebView.toggleWebViewTheme(isThemeTheSame)
         toggleFrameLayoutsTheme(isThemeTheSame)
     }
 
-    private fun ThreadViewHolder.loadContentAndQuote(message: Message) {
+    private fun MessageViewHolder.loadContentAndQuote(message: Message) {
         val body = message.body
         val splitBody = message.splitBody
 
@@ -221,16 +223,16 @@ class ThreadAdapter(
         }
     }
 
-    private fun ThreadViewHolder.loadBodyInWebView(uid: String, body: String, type: String) = with(binding) {
+    private fun MessageViewHolder.loadBodyInWebView(uid: String, body: String, type: String) = with(binding) {
         bodyWebView.applyWebViewContent(uid, body, type)
     }
 
-    private fun ThreadViewHolder.loadQuoteInWebView(uid: String, quote: String?, type: String) = with(binding) {
+    private fun MessageViewHolder.loadQuoteInWebView(uid: String, quote: String?, type: String) = with(binding) {
         if (quote == null) return@with
         fullMessageWebView.applyWebViewContent(uid, quote, type)
     }
 
-    private fun ThreadViewHolder.toggleWebViews(message: Message) = with(binding) {
+    private fun MessageViewHolder.toggleWebViews(message: Message) = with(binding) {
         isQuoteCollapsed = !isQuoteCollapsed
         loadContentAndQuote(message)
     }
@@ -279,7 +281,7 @@ class ThreadAdapter(
         }
     }
 
-    private fun ThreadViewHolder.bindHeader(message: Message) = with(binding) {
+    private fun MessageViewHolder.bindHeader(message: Message) = with(binding) {
         val messageDate = message.date.toDate()
 
         if (message.isDraft) {
@@ -321,7 +323,7 @@ class ThreadAdapter(
         bccGroup.isVisible = message.bcc.isNotEmpty()
     }
 
-    private fun ThreadViewHolder.handleHeaderClick(message: Message) = with(binding) {
+    private fun MessageViewHolder.handleHeaderClick(message: Message) = with(binding) {
         messageHeader.setOnClickListener {
             if (isExpandedMap[message.uid] == true) {
                 isExpandedMap[message.uid] = false
@@ -347,7 +349,7 @@ class ThreadAdapter(
         }
     }
 
-    private fun ThreadViewHolder.bindRecipientDetails(message: Message, messageDate: Date) = with(binding) {
+    private fun MessageViewHolder.bindRecipientDetails(message: Message, messageDate: Date) = with(binding) {
 
         fromAdapter.updateList(message.from.toList())
         toAdapter.updateList(message.to.toList())
@@ -363,7 +365,7 @@ class ThreadAdapter(
         detailedMessageDate.text = mostDetailedDate(context, messageDate)
     }
 
-    private fun ThreadViewHolder.bindAlerts(messageUid: String) = with(binding) {
+    private fun MessageViewHolder.bindAlerts(messageUid: String) = with(binding) {
         distantImagesAlert.onAction1 {
             bodyWebViewClient.unblockDistantResources()
             fullMessageWebViewClient.unblockDistantResources()
@@ -388,7 +390,7 @@ class ThreadAdapter(
     private fun ItemMessageBinding.areOneOrMoreAlertsVisible() = alerts.children.any { it.isVisible }
 
     @SuppressLint("SetTextI18n")
-    private fun ThreadViewHolder.bindAttachment(message: Message) = with(binding) {
+    private fun MessageViewHolder.bindAttachment(message: Message) = with(binding) {
         val attachments = message.attachments
         val fileSize = formatAttachmentFileSize(attachments)
         attachmentLayout.attachmentsSizeText.text = context.resources.getQuantityString(
@@ -413,12 +415,12 @@ class ThreadAdapter(
         return Formatter.formatShortFileSize(context, totalAttachmentsFileSizeInBytes)
     }
 
-    private fun ThreadViewHolder.bindContent(message: Message) {
+    private fun MessageViewHolder.bindContent(message: Message) {
         binding.messageLoader.isVisible = message.splitBody == null
         message.splitBody?.let { splitBody -> bindBody(message, hasQuote = splitBody.quote != null) }
     }
 
-    private fun ThreadViewHolder.bindBody(message: Message, hasQuote: Boolean) = with(binding) {
+    private fun MessageViewHolder.bindBody(message: Message, hasQuote: Boolean) = with(binding) {
         bodyWebView.setupLinkContextualMenu { data, type ->
             threadAdapterCallbacks?.promptLink?.invoke(data, type)
         }
@@ -495,7 +497,7 @@ class ThreadAdapter(
         }
     }
 
-    private fun ThreadViewHolder.onExpandOrCollapseMessage(message: Message, shouldTrack: Boolean = true) = with(binding) {
+    private fun MessageViewHolder.onExpandOrCollapseMessage(message: Message, shouldTrack: Boolean = true) = with(binding) {
         val isExpanded = isExpandedMap[message.uid]!!
 
         if (shouldTrack) context.trackMessageEvent("openMessage", isExpanded)
@@ -579,7 +581,7 @@ class ThreadAdapter(
         }
 
         override fun getChangePayload(oldItem: Message, newItem: Message): Any? {
-            // If everything but attendees is the same, then we know the only thing that could've changed is attendees
+            // If everything but Attendees is the same, then we know the only thing that could've changed is Attendees.
             return if (everythingButAttendeesIsTheSame(oldItem, newItem)) NotifyType.ONLY_REBIND_CALENDAR_ATTENDANCE else null
         }
 
@@ -600,7 +602,25 @@ class ThreadAdapter(
         }
     }
 
-    class ThreadViewHolder(
+    data class ThreadAdapterCallbacks(
+        var onBodyWebViewFinishedLoading: (() -> Unit)? = null,
+        var onContactClicked: ((contact: Recipient) -> Unit)? = null,
+        var onDeleteDraftClicked: ((message: Message) -> Unit)? = null,
+        var onDraftClicked: ((message: Message) -> Unit)? = null,
+        var onAttachmentClicked: ((attachment: Attachment) -> Unit)? = null,
+        var onAttachmentOptionsClicked: ((attachment: Attachment) -> Unit)? = null,
+        var onDownloadAllClicked: ((message: Message) -> Unit)? = null,
+        var onReplyClicked: ((Message) -> Unit)? = null,
+        var onMenuClicked: ((Message) -> Unit)? = null,
+        var onAllExpandedMessagesLoaded: (() -> Unit)? = null,
+        var navigateToNewMessageActivity: ((Uri) -> Unit)? = null,
+        var navigateToAttendeeBottomSheet: ((List<Attendee>) -> Unit)? = null,
+        var navigateToDownloadProgressDialog: ((Attachment, AttachmentIntentType) -> Unit)? = null,
+        var replyToCalendarEvent: ((AttendanceState, Message) -> Unit)? = null,
+        var promptLink: ((String, ContextMenuType) -> Unit)? = null,
+    )
+
+    class MessageViewHolder(
         val binding: ItemMessageBinding,
         private val shouldLoadDistantResources: Boolean,
         onContactClicked: ((contact: Recipient) -> Unit)?,
@@ -674,24 +694,6 @@ class ThreadAdapter(
         }
     }
 
-    data class ThreadAdapterCallbacks(
-        var onBodyWebViewFinishedLoading: (() -> Unit)? = null,
-        var onContactClicked: ((contact: Recipient) -> Unit)? = null,
-        var onDeleteDraftClicked: ((message: Message) -> Unit)? = null,
-        var onDraftClicked: ((message: Message) -> Unit)? = null,
-        var onAttachmentClicked: ((attachment: Attachment) -> Unit)? = null,
-        var onAttachmentOptionsClicked: ((attachment: Attachment) -> Unit)? = null,
-        var onDownloadAllClicked: ((message: Message) -> Unit)? = null,
-        var onReplyClicked: ((Message) -> Unit)? = null,
-        var onMenuClicked: ((Message) -> Unit)? = null,
-        var onAllExpandedMessagesLoaded: (() -> Unit)? = null,
-        var navigateToNewMessageActivity: ((Uri) -> Unit)? = null,
-        var navigateToAttendeeBottomSheet: ((List<Attendee>) -> Unit)? = null,
-        var navigateToDownloadProgressDialog: ((Attachment, AttachmentIntentType) -> Unit)? = null,
-        var replyToCalendarEvent: ((AttendanceState, Message) -> Unit)? = null,
-        var promptLink: ((String, ContextMenuType) -> Unit)? = null,
-    )
-
     companion object {
 
         private val contextMenuTypeForHitTestResultType = mapOf(