refactor: managing TreeFolder conversion in UseCase

ClemRiviere · wmontwe · commit 5a843cc9aac2 · 2025-04-04T18:48:00.000+02:00
diff --git a/feature/navigation/drawer/dropdown/src/debug/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/folder/FolderListPreview.kt b/feature/navigation/drawer/dropdown/src/debug/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/folder/FolderListPreview.kt
@@ -4,6 +4,7 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.tooling.preview.Preview
 import app.k9mail.core.ui.compose.designsystem.PreviewWithTheme
 import kotlinx.collections.immutable.persistentListOf
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.TreeFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.ui.FakeData.DISPLAY_FOLDER
 import net.thunderbird.feature.navigation.drawer.dropdown.ui.FakeData.UNIFIED_FOLDER
 
@@ -12,8 +13,8 @@ import net.thunderbird.feature.navigation.drawer.dropdown.ui.FakeData.UNIFIED_FO
 internal fun FolderListPreview() {
     PreviewWithTheme {
         FolderList(
-            folders = persistentListOf(
-                DISPLAY_FOLDER,
+            rootFolder = TreeFolder.createFromFolders(
+                persistentListOf(DISPLAY_FOLDER),
             ),
             selectedFolder = null,
             onFolderClick = {},
@@ -27,8 +28,8 @@ internal fun FolderListPreview() {
 internal fun FolderListPreviewSelected() {
     PreviewWithTheme {
         FolderList(
-            folders = persistentListOf(
-                DISPLAY_FOLDER,
+            rootFolder = TreeFolder.createFromFolders(
+                persistentListOf(DISPLAY_FOLDER),
             ),
             selectedFolder = DISPLAY_FOLDER,
             onFolderClick = {},
@@ -42,9 +43,11 @@ internal fun FolderListPreviewSelected() {
 internal fun FolderListWithUnifiedFolderPreview() {
     PreviewWithTheme {
         FolderList(
-            folders = persistentListOf(
-                UNIFIED_FOLDER,
-                DISPLAY_FOLDER,
+            rootFolder = TreeFolder.createFromFolders(
+                persistentListOf(
+                    UNIFIED_FOLDER,
+                    DISPLAY_FOLDER,
+                ),
             ),
             selectedFolder = DISPLAY_FOLDER,
             onFolderClick = {},
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/NavigationDrawerModule.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/NavigationDrawerModule.kt
@@ -6,6 +6,7 @@ import net.thunderbird.feature.navigation.drawer.dropdown.domain.DomainContract.
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.GetDisplayAccounts
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.GetDisplayFoldersForAccount
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.GetDrawerConfig
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.GetTreeFolders
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.SaveDrawerConfig
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.SyncAccount
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase.SyncAllAccounts
@@ -48,6 +49,10 @@ val navigationDropDownDrawerModule: Module = module {
         )
     }
 
+    single<UseCase.GetTreeFolders> {
+        GetTreeFolders()
+    }
+
     single<UseCase.SyncAccount> {
         SyncAccount(
             accountManager = get(),
@@ -67,6 +72,7 @@ val navigationDropDownDrawerModule: Module = module {
             saveDrawerConfig = get(),
             getDisplayAccounts = get(),
             getDisplayFoldersForAccount = get(),
+            getTreeFolders = get(),
             syncAccount = get(),
             syncAllAccounts = get(),
         )
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/domain/DomainContract.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/domain/DomainContract.kt
@@ -6,6 +6,7 @@ import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayA
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayUnifiedFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayUnifiedFolderType
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.TreeFolder
 
 internal interface DomainContract {
 
@@ -26,6 +27,10 @@ internal interface DomainContract {
             operator fun invoke(accountId: String, includeUnifiedFolders: Boolean): Flow<List<DisplayFolder>>
         }
 
+        fun interface GetTreeFolders {
+            operator fun invoke(folders: List<DisplayFolder>, maxDepth: Int): TreeFolder
+        }
+
         /**
          * Synchronize the given account uuid.
          */
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/domain/entity/TreeFolder.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/domain/entity/TreeFolder.kt
@@ -1,8 +1,72 @@
 package net.thunderbird.feature.navigation.drawer.dropdown.domain.entity
 
+import app.k9mail.core.mail.folder.api.Folder
+import app.k9mail.core.mail.folder.api.FolderType
+
 internal data class TreeFolder(
     var value: DisplayFolder? = null,
 ) {
+    companion object {
+        fun createFromFolders(folders: List<DisplayFolder>, maxDepth: Int = 3): TreeFolder {
+            // Converting folders to TreeFolder
+            val rootFolder = TreeFolder()
+            var currentTree = rootFolder
+
+            for (displayFolder in folders) {
+                if (displayFolder is DisplayUnifiedFolder) {
+                    currentTree.children.add(TreeFolder(displayFolder))
+                }
+                if (displayFolder !is DisplayAccountFolder) continue
+                val splittedFolderName = displayFolder.folder.name.split("/", limit = maxDepth + 1)
+                var subFolderEntireName = ""
+                for (subFolderName in splittedFolderName) {
+                    subFolderEntireName += subFolderName
+                    var foundInChildren = false
+                    for (children in currentTree.children) {
+                        var childDisplayFolder = children.value
+                        if (childDisplayFolder !is DisplayAccountFolder) continue
+                        if (childDisplayFolder.folder.name == subFolderEntireName) {
+                            currentTree = children
+                            foundInChildren = true
+                            break
+                        }
+                    }
+                    if (!foundInChildren) {
+                        var newChildren = TreeFolder()
+                        if (subFolderEntireName == displayFolder.folder.name) {
+                            newChildren = TreeFolder(displayFolder)
+                        } else {
+                            newChildren = TreeFolder(
+                                DisplayAccountFolder(
+                                    displayFolder.accountId,
+                                    Folder(
+                                        0,
+                                        subFolderEntireName,
+                                        FolderType.REGULAR,
+                                        displayFolder.folder.isLocalOnly,
+                                    ),
+                                    displayFolder.isInTopGroup,
+                                    0,
+                                    0,
+                                ),
+                            )
+                        }
+                        currentTree.children.add(newChildren)
+                        currentTree = newChildren
+                    } else {
+                        if (subFolderEntireName == displayFolder.folder.name) {
+                            currentTree.value = displayFolder
+                        }
+                    }
+                    subFolderEntireName += "/"
+                }
+                currentTree = rootFolder
+            }
+
+            return rootFolder
+        }
+    }
+
     val children: ArrayList<TreeFolder> = ArrayList()
 
     fun getAllUnreadMessageCount(): Int {
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/domain/usecase/GetTreeFolders.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/domain/usecase/GetTreeFolders.kt
@@ -0,0 +1,11 @@
+package net.thunderbird.feature.navigation.drawer.dropdown.domain.usecase
+
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.DomainContract.UseCase
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayFolder
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.TreeFolder
+
+internal class GetTreeFolders() : UseCase.GetTreeFolders {
+    override fun invoke(folders: List<DisplayFolder>, maxDepth: Int): TreeFolder {
+        return TreeFolder.createFromFolders(folders, maxDepth)
+    }
+}
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/DrawerContent.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/DrawerContent.kt
@@ -75,7 +75,7 @@ internal fun DrawerContent(
                         .fillMaxSize(),
                 ) {
                     FolderList(
-                        folders = state.folders,
+                        rootFolder = state.rootFolder,
                         selectedFolder = state.folders.firstOrNull { it.id == state.selectedFolderId },
                         onFolderClick = { folder ->
                             onEvent(Event.OnFolderClick(folder))
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/DrawerContract.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/DrawerContract.kt
@@ -4,23 +4,25 @@ import androidx.compose.runtime.Stable
 import app.k9mail.core.ui.compose.common.mvi.UnidirectionalViewModel
 import kotlinx.collections.immutable.ImmutableList
 import kotlinx.collections.immutable.persistentListOf
-import net.thunderbird.feature.navigation.drawer.api.NavigationDrawerExternalContract
+import net.thunderbird.feature.navigation.drawer.api.NavigationDrawerExternalContract.DrawerConfig
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayAccount
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayFolder
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.TreeFolder
 
 internal interface DrawerContract {
 
     interface ViewModel : UnidirectionalViewModel<State, Event, Effect>
 
     @Stable
     data class State(
-        val config: NavigationDrawerExternalContract.DrawerConfig = NavigationDrawerExternalContract.DrawerConfig(
+        val config: DrawerConfig = DrawerConfig(
             showUnifiedFolders = false,
             showStarredCount = false,
             showAccountSelector = true,
         ),
         val accounts: ImmutableList<DisplayAccount> = persistentListOf(),
         val selectedAccountId: String? = null,
+        val rootFolder: TreeFolder = TreeFolder(),
         val folders: ImmutableList<DisplayFolder> = persistentListOf(),
         val selectedFolderId: String? = null,
         val isLoading: Boolean = false,
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/DrawerViewModel.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/DrawerViewModel.kt
@@ -19,6 +19,7 @@ import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayA
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayAccountFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayUnifiedFolder
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.TreeFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.ui.DrawerContract.Effect
 import net.thunderbird.feature.navigation.drawer.dropdown.ui.DrawerContract.Event
 import net.thunderbird.feature.navigation.drawer.dropdown.ui.DrawerContract.State
@@ -36,6 +37,7 @@ internal class DrawerViewModel(
     private val saveDrawerConfig: UseCase.SaveDrawerConfig,
     private val getDisplayAccounts: UseCase.GetDisplayAccounts,
     private val getDisplayFoldersForAccount: UseCase.GetDisplayFoldersForAccount,
+    private val getTreeFolders: UseCase.GetTreeFolders,
     private val syncAccount: UseCase.SyncAccount,
     private val syncAllAccounts: UseCase.SyncAllAccounts,
     initialState: State = State(),
@@ -91,17 +93,18 @@ internal class DrawerViewModel(
             .flatMapLatest { (accountId, showUnifiedInbox) ->
                 getDisplayFoldersForAccount(accountId, showUnifiedInbox)
             }.collect { folders ->
-                updateFolders(folders)
+                updateFolders(folders, getTreeFolders(folders, 3))
             }
     }
 
-    private fun updateFolders(displayFolders: List<DisplayFolder>) {
+    private fun updateFolders(displayFolders: List<DisplayFolder>, rootFolder: TreeFolder) {
         val selectedFolder = displayFolders.find {
             it.id == state.value.selectedFolderId
         } ?: displayFolders.firstOrNull()
 
         updateState {
             it.copy(
+                rootFolder = rootFolder,
                 folders = displayFolders.toImmutableList(),
                 selectedFolderId = selectedFolder?.id,
             )
diff --git a/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/folder/FolderList.kt b/feature/navigation/drawer/dropdown/src/main/kotlin/net/thunderbird/feature/navigation/drawer/dropdown/ui/folder/FolderList.kt
@@ -10,20 +10,17 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalContext
-import app.k9mail.core.mail.folder.api.Folder
-import app.k9mail.core.mail.folder.api.FolderType
 import app.k9mail.core.ui.compose.designsystem.atom.DividerHorizontal
 import app.k9mail.core.ui.compose.theme2.MainTheme
 import app.k9mail.legacy.ui.folder.FolderNameFormatter
-import kotlinx.collections.immutable.ImmutableList
-import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayAccountFolder
+import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.DisplayUnifiedFolder
 import net.thunderbird.feature.navigation.drawer.dropdown.domain.entity.TreeFolder
 
 @Composable
 internal fun FolderList(
-    folders: ImmutableList<DisplayFolder>,
+    rootFolder: TreeFolder,
     selectedFolder: DisplayFolder?,
     onFolderClick: (DisplayFolder) -> Unit,
     showStarredCount: Boolean,
@@ -33,57 +30,6 @@ internal fun FolderList(
     val folderNameFormatter = remember { FolderNameFormatter(resources) }
     val listState = rememberLazyListState()
 
-    // Converting folders to TreeFolder
-    val rootFolder = TreeFolder()
-    val maxDepth = 2
-    var currentTree = rootFolder
-
-    for (displayFolder in folders) {
-        if (displayFolder is DisplayUnifiedFolder) {
-            currentTree.children.add(TreeFolder(displayFolder))
-        }
-        if (displayFolder !is DisplayAccountFolder) continue
-        val splittedFolderName = displayFolder.folder.name.split("/", limit = maxDepth + 1)
-        var subFolderEntireName = ""
-        for (subFolderName in splittedFolderName) {
-            subFolderEntireName += subFolderName
-            var foundInChildren = false
-            for (children in currentTree.children) {
-                var childDisplayFolder = children.value
-                if (childDisplayFolder !is DisplayAccountFolder) continue
-                if (childDisplayFolder.folder.name == subFolderEntireName) {
-                    currentTree = children
-                    foundInChildren = true
-                    break
-                }
-            }
-            if (!foundInChildren) {
-                var newChildren = TreeFolder()
-                if (subFolderEntireName == displayFolder.folder.name) {
-                    newChildren = TreeFolder(displayFolder)
-                } else {
-                    newChildren = TreeFolder(
-                        DisplayAccountFolder(
-                            displayFolder.accountId,
-                            Folder(0, subFolderEntireName, FolderType.REGULAR, displayFolder.folder.isLocalOnly),
-                            displayFolder.isInTopGroup,
-                            0,
-                            0,
-                        ),
-                    )
-                }
-                currentTree.children.add(newChildren)
-                currentTree = newChildren
-            } else {
-                if (subFolderEntireName == displayFolder.folder.name) {
-                    currentTree.value = displayFolder
-                }
-            }
-            subFolderEntireName += "/"
-        }
-        currentTree = rootFolder
-    }
-
     LazyColumn(
         state = listState,
         modifier = modifier
