Merge pull request #1701 from Infomaniak/fix-search-wrong-folder-id

Fix wrong Folder ID in Search Messages

Author: LunarX

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

@@ -70,17 +70,17 @@ class ThreadController @Inject constructor(
     }
 
     /**
-     * Initialize and retrieve the search threads obtained from the API.
+     * Initialize and retrieve the search Threads obtained from the API.
      * - Format the remote threads to make them compatible with the existing logic.
      * - Preserve old message data if it already exists locally.
      * - Handle duplicates using the existing logic.
-     * @param remoteThreads The list of API threads that need to be processed.
-     * @param folderRole The role of the selected folder. This is only useful when selecting the spam or trash folder.
-     * @return A list of search threads. The search only returns messages from spam or trash if we explicitly selected those folders
+     * @param remoteThreads The list of API Threads that need to be processed.
+     * @param filterFolder The selected Folder on which we filter the Search.
+     * @return A list of search Threads. The search only returns Messages from SPAM or TRASH if we explicitly selected those folders
      */
     suspend fun initAndGetSearchFolderThreads(
         remoteThreads: List<Thread>,
-        folderRole: FolderRole?,
+        filterFolder: Folder?,
     ): List<Thread> = withContext(ioDispatcher) {
 
         fun MutableRealm.keepOldMessagesAndAddToSearchFolder(remoteThread: Thread, searchFolder: Folder) {
@@ -90,12 +90,12 @@ class ThreadController @Inject constructor(
 
                 val localMessage = MessageController.getMessage(remoteMessage.uid, realm = this)
 
-                // The Search only returns Messages from SPAM or TRASH if we explicitly selected those folders,
-                // which is the reason why we can compute `isSpam` and `isTrashed` values so loosely.
+                // The Search only returns Messages from TRASH if we explicitly selected this folder,
+                // which is the reason why we can compute the `isTrashed` value so loosely.
                 remoteMessage.initLocalValues(
                     date = localMessage?.date ?: remoteMessage.date,
                     isFullyDownloaded = localMessage?.isFullyDownloaded() ?: false,
-                    isTrashed = folderRole == FolderRole.TRASH,
+                    isTrashed = filterFolder?.role == FolderRole.TRASH,
                     isFromSearch = localMessage == null,
                     draftLocalUuid = localMessage?.draftLocalUuid,
                     latestCalendarEventResponse = null,
@@ -113,7 +113,13 @@ class ThreadController @Inject constructor(
             remoteThreads.map { remoteThread ->
                 ensureActive()
                 remoteThread.isFromSearch = true
-                remoteThread.folderId = remoteThread.messages.first().folderId
+
+                val folderId = if (remoteThread.messages.count() == 1) {
+                    remoteThread.messages.single().folderId
+                } else {
+                    filterFolder!!.id
+                }
+                remoteThread.folderId = folderId
 
                 keepOldMessagesAndAddToSearchFolder(remoteThread, searchFolder)
 

app/src/main/java/com/infomaniak/mail/ui/main/search/SearchFragment.kt

@@ -174,8 +174,8 @@ class SearchFragment : TwoPaneFragment() {
             popupMenu.setAdapter(searchAdapter)
 
             updateFolderDropDownUi(
-                folder = searchViewModel.currentFolder,
-                title = requireContext().getLocalizedNameOrAllFolders(searchViewModel.currentFolder),
+                folder = searchViewModel.filterFolder,
+                title = requireContext().getLocalizedNameOrAllFolders(searchViewModel.filterFolder),
             )
         }
 

app/src/main/java/com/infomaniak/mail/ui/main/search/SearchViewModel.kt

@@ -64,7 +64,7 @@ class SearchViewModel @Inject constructor(
     /** Needed to pass API request's validation, but won't be used by the API */
     private val dummyFolderId inline get() = savedStateHandle.get<String>(SearchFragmentArgs::dummyFolderId.name)!!
 
-    var currentFolder: Folder? = null
+    var filterFolder: Folder? = null
         private set
     var currentSearchQuery: String = ""
         private set
@@ -95,7 +95,7 @@ class SearchViewModel @Inject constructor(
 
     fun executePendingSearch() = viewModelScope.launch(ioCoroutineContext) {
         val hasPendingSearch = (lastExecutedSearchQuery != currentSearchQuery)
-                || (lastExecutedFolder != currentFolder)
+                || (lastExecutedFolder != filterFolder)
                 || (lastExecutedFilters != currentFilters)
 
         if (hasPendingSearch) search()
@@ -111,7 +111,7 @@ class SearchViewModel @Inject constructor(
     }
 
     fun selectFolder(folder: Folder?) = viewModelScope.launch(ioCoroutineContext) {
-        search(folder = folder.also { currentFolder = it })
+        search(folder = folder.also { filterFolder = it })
     }
 
     fun setFilter(filter: ThreadFilter, isEnabled: Boolean = true) = viewModelScope.launch(ioCoroutineContext) {
@@ -164,7 +164,7 @@ class SearchViewModel @Inject constructor(
         query: String = currentSearchQuery,
         saveInHistory: Boolean = false,
         filters: Set<ThreadFilter> = currentFilters,
-        folder: Folder? = currentFolder,
+        folder: Folder? = filterFolder,
         shouldGetNextPage: Boolean = false,
     ) = withContext(ioCoroutineContext) {
         searchJob?.cancel()
@@ -191,7 +191,7 @@ class SearchViewModel @Inject constructor(
 
         val newFilters = if (folder == null) filters else (filters + ThreadFilter.FOLDER)
 
-        return if (newFilters.isEmpty() && query.isNullOrBlank() && currentFolder == null) {
+        return if (newFilters.isEmpty() && query.isNullOrBlank() && filterFolder == null) {
             searchUtils.deleteRealmSearchData()
             visibilityMode.postValue(VisibilityMode.RECENT_SEARCHES)
             null
@@ -209,11 +209,8 @@ class SearchViewModel @Inject constructor(
 
         suspend fun ApiResponse<ThreadResult>.initSearchFolderThreads() {
             runCatching {
-                data?.threads?.let {
-                    threadController.initAndGetSearchFolderThreads(
-                        remoteThreads = it,
-                        folderRole = folder?.role
-                    )
+                data?.threads?.let { remoteThreads ->
+                    threadController.initAndGetSearchFolderThreads(remoteThreads, folder)
                 }
             }.getOrElse { exception ->
                 exception.printStackTrace()