refactor(db-repository): extract folder query operations to FolderQueryRepository

legacy/mailstore/src/main/java/app/k9mail/legacy/mailstore/FolderRepository.kt → feature/mail/folder/api/src/commonMain/kotlin/net/thunderbird/feature/mail/folder/api/data/repository/FolderQueryRepository.kt

@@ -1,47 +1,41 @@
-package app.k9mail.legacy.mailstore
+package net.thunderbird.feature.mail.folder.api.data.repository
 
+import net.thunderbird.core.outcome.Outcome
 import net.thunderbird.feature.account.AccountId
 import net.thunderbird.feature.mail.folder.api.Folder
-import net.thunderbird.feature.mail.folder.api.data.repository.PushFolderTrackingRepository
+import net.thunderbird.feature.mail.folder.api.FolderServerId
+import net.thunderbird.feature.mail.folder.api.data.FolderError
 
-/**
- * Provides access to local and remote folder information and management.
- *
- * TODO: Refactor FolderRepository into focused contracts.
- *       Problem: This interface mixes unrelated responsibilities (read models, remote listing, push tracking,
- *       and per-flag mutations), which makes it hard to test and evolve.
- */
-@Suppress("TooManyFunctions")
-interface FolderRepository : PushFolderTrackingRepository {
+interface FolderQueryRepository {
     /**
      * Returns a [Folder] for the given [accountId] and [folderId].
      *
      * @param accountId The account identifier.
      * @param folderId The folder identifier.
      */
-    suspend fun getFolder(accountId: AccountId, folderId: Long): Folder?
+    suspend fun findById(accountId: AccountId, folderId: Long): Outcome<Folder?, FolderError>
 
     /**
      * Returns the server ID for the given [accountId] and [folderId].
      *
      * @param accountId The account identifier.
      * @param folderId The folder identifier.
      */
-    fun getFolderServerId(accountId: AccountId, folderId: Long): String?
+    suspend fun findFolderServerIdById(accountId: AccountId, folderId: Long): Outcome<FolderServerId?, FolderError>
 
     /**
      * Returns the folder ID for the given [accountId] and [folderServerId].
      *
      * @param accountId The account identifier.
      * @param folderServerId The folder server identifier.
      */
-    fun getFolderId(accountId: AccountId, folderServerId: String): Long?
+    suspend fun findIdByServerId(accountId: AccountId, folderServerId: FolderServerId): Outcome<Long?, FolderError>
 
     /**
      * Returns `true` if the folder with [folderId] is present for the given [accountId].
      *
      * @param accountId The account identifier.
      * @param folderId The folder identifier.
      */
-    fun isFolderPresent(accountId: AccountId, folderId: Long): Boolean
+    suspend fun isPresent(accountId: AccountId, folderId: Long): Boolean
 }

feature/mail/message/list/internal/src/main/kotlin/net/thunderbird/feature/mail/message/list/internal/ui/state/sideeffect/LoadFolderInformationSideEffect.kt

@@ -1,7 +1,6 @@
 package net.thunderbird.feature.mail.message.list.internal.ui.state.sideeffect
 
 import androidx.compose.ui.graphics.Color
-import app.k9mail.legacy.mailstore.FolderRepository
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.first
 import net.thunderbird.core.logging.Logger
@@ -10,6 +9,7 @@ import net.thunderbird.feature.account.AccountId
 import net.thunderbird.feature.account.UnifiedAccountId
 import net.thunderbird.feature.account.profile.AccountProfileRepository
 import net.thunderbird.feature.mail.folder.api.FolderType
+import net.thunderbird.feature.mail.folder.api.data.repository.FolderQueryRepository
 import net.thunderbird.feature.mail.folder.api.data.repository.RemoteFolderQueryRepository
 import net.thunderbird.feature.mail.message.list.ui.effect.MessageListEffect
 import net.thunderbird.feature.mail.message.list.ui.event.FolderEvent
@@ -27,7 +27,7 @@ internal class LoadFolderInformationSideEffect(
     private val folderId: Long?,
     dispatch: suspend (MessageListEvent) -> Unit,
     private val logger: Logger,
-    private val folderRepository: FolderRepository,
+    private val folderQueryRepository: FolderQueryRepository,
     private val remoteFolderQueryRepository: RemoteFolderQueryRepository,
     private val profileRepository: AccountProfileRepository,
 ) : MessageListStateSideEffectHandler(logger, dispatch) {
@@ -64,7 +64,9 @@ internal class LoadFolderInformationSideEffect(
 
     private suspend fun consumeSingleAccountFolder(folderId: Long): ConsumeResult {
         val accountId = accountIds.first()
-        val folder = folderRepository.getFolder(accountId, folderId)
+        val folder = folderQueryRepository
+            .findById(accountId, folderId)
+            .fold(onSuccess = { it }, onFailure = { null })
         return if (folder != null) {
             val remoteFolder = if (!folder.isLocalOnly) {
                 remoteFolderQueryRepository
@@ -97,7 +99,7 @@ internal class LoadFolderInformationSideEffect(
         private val accountIds: Set<AccountId>,
         private val folderId: Long?,
         private val logger: Logger,
-        private val folderRepository: FolderRepository,
+        private val folderQueryRepository: FolderQueryRepository,
         private val remoteFolderQueryRepository: RemoteFolderQueryRepository,
         private val profileRepository: AccountProfileRepository,
     ) : MessageListStateSideEffectHandlerFactory {
@@ -110,7 +112,7 @@ internal class LoadFolderInformationSideEffect(
             folderId = folderId,
             dispatch = dispatch,
             logger = logger,
-            folderRepository = folderRepository,
+            folderQueryRepository = folderQueryRepository,
             remoteFolderQueryRepository = remoteFolderQueryRepository,
             profileRepository = profileRepository,
         )

feature/mail/message/list/internal/src/main/kotlin/net/thunderbird/feature/mail/message/list/internal/ui/state/sideeffect/inject/MessageListSideEffectsModule.kt

@@ -53,7 +53,7 @@ internal val messageListSideEffectsModule = module {
                 accountIds = args.accountIds,
                 folderId = args.folderId,
                 logger = get(),
-                folderRepository = get(),
+                folderQueryRepository = get(),
                 remoteFolderQueryRepository = get(),
                 profileRepository = get(),
             )

feature/mail/message/list/internal/src/test/kotlin/net/thunderbird/feature/mail/message/list/internal/fakes/FakeFolderQueryRepository.kt

@@ -0,0 +1,27 @@
+package net.thunderbird.feature.mail.message.list.internal.fakes
+
+import net.thunderbird.core.outcome.Outcome
+import net.thunderbird.feature.account.AccountId
+import net.thunderbird.feature.mail.folder.api.Folder
+import net.thunderbird.feature.mail.folder.api.FolderServerId
+import net.thunderbird.feature.mail.folder.api.data.FolderError
+import net.thunderbird.feature.mail.folder.api.data.repository.FolderQueryRepository
+
+class FakeFolderQueryRepository(
+    private val localFolders: Map<AccountId, List<Folder>> = emptyMap(),
+) : FolderQueryRepository {
+    override suspend fun findById(accountId: AccountId, folderId: Long): Outcome<Folder?, FolderError> =
+        Outcome.success(localFolders[accountId]?.find { it.id == folderId })
+
+    override suspend fun findFolderServerIdById(
+        accountId: AccountId,
+        folderId: Long,
+    ): Outcome<FolderServerId?, FolderError> = error("Not implemented")
+
+    override suspend fun findIdByServerId(
+        accountId: AccountId,
+        folderServerId: FolderServerId,
+    ): Outcome<Long?, FolderError> = error("Not implemented")
+
+    override suspend fun isPresent(accountId: AccountId, folderId: Long): Boolean = error("Not implemented")
+}

feature/mail/message/list/internal/src/test/kotlin/net/thunderbird/feature/mail/message/list/internal/ui/state/sideeffect/LoadFolderInformationSideEffectTest.kt

@@ -4,7 +4,6 @@ package net.thunderbird.feature.mail.message.list.internal.ui.state.sideeffect
 
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.toArgb
-import app.k9mail.legacy.mailstore.FolderRepository
 import assertk.assertThat
 import assertk.assertions.containsExactly
 import assertk.assertions.isEmpty
@@ -30,8 +29,9 @@ import net.thunderbird.feature.account.profile.AccountProfile
 import net.thunderbird.feature.account.profile.AccountProfileRepository
 import net.thunderbird.feature.mail.folder.api.FolderType
 import net.thunderbird.feature.mail.folder.api.RemoteFolder
+import net.thunderbird.feature.mail.folder.api.data.repository.FolderQueryRepository
 import net.thunderbird.feature.mail.folder.api.data.repository.RemoteFolderQueryRepository
-import net.thunderbird.feature.mail.message.list.internal.fakes.FakeFolderRepository
+import net.thunderbird.feature.mail.message.list.internal.fakes.FakeFolderQueryRepository
 import net.thunderbird.feature.mail.message.list.internal.fakes.FakeRemoteFolderQueryRepository
 import net.thunderbird.feature.mail.message.list.internal.fakes.RecordingSuspendFunction
 import net.thunderbird.feature.mail.message.list.ui.event.FolderEvent
@@ -52,7 +52,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             val testSubject = createTestSubject(
                 accountIds = setOf(accountId),
                 folderId = folderId,
-                folderRepository = createFolderRepository(
+                folderQueryRepository = createFolderQueryRepository(
                     accountId = accountId,
                     folderId = folderId,
                     folder = folder,
@@ -151,7 +151,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             accountIds = setOf(firstAccountId, secondAccountId),
             folderId = folderId,
             dispatch = dispatch.function,
-            folderRepository = createFolderRepository(
+            folderQueryRepository = createFolderQueryRepository(
                 accountId = firstAccountId,
                 folderId = folderId,
                 folder = folder,
@@ -192,7 +192,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
         val folderId = 7L
         val folder = createMailFolder(id = folderId, name = "Local", isLocalOnly = true)
         val dispatch = RecordingSuspendFunction<MessageListEvent>()
-        val folderRepository = createFolderRepository(
+        val folderQueryRepository = createFolderQueryRepository(
             accountId = accountId,
             folderId = folderId,
             folder = folder,
@@ -202,7 +202,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             accountIds = setOf(accountId),
             folderId = folderId,
             dispatch = dispatch.function,
-            folderRepository = folderRepository,
+            folderQueryRepository = folderQueryRepository,
             profileRepository = FakeAccountProfileRepository(
                 profiles = listOf(createAccountProfile(accountId = accountId, expectedColor)),
             ),
@@ -241,7 +241,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             type = FolderType.INBOX,
         )
         val dispatch = RecordingSuspendFunction<MessageListEvent>()
-        val folderRepository = createFolderRepository(
+        val folderQueryRepository = createFolderQueryRepository(
             accountId = accountId,
             folderId = folderId,
             folder = folder,
@@ -255,7 +255,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             accountIds = setOf(accountId),
             folderId = folderId,
             dispatch = dispatch.function,
-            folderRepository = folderRepository,
+            folderQueryRepository = folderQueryRepository,
             remoteFolderQueryRepository = remoteFolderQueryRepository,
             profileRepository = FakeAccountProfileRepository(
                 profiles = listOf(createAccountProfile(accountId = accountId, expectedColor)),
@@ -294,7 +294,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             accountIds = setOf(accountId),
             folderId = folderId,
             dispatch = dispatch.function,
-            folderRepository = createFolderRepository(
+            folderQueryRepository = createFolderQueryRepository(
                 accountId = accountId,
                 folderId = folderId,
                 folder = folder,
@@ -337,7 +337,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
         val accountId = AccountIdFactory.create()
         val folderId = 10L
         val dispatch = RecordingSuspendFunction<MessageListEvent>()
-        val folderRepository = createFolderRepository(
+        val folderQueryRepository = createFolderQueryRepository(
             accountId = accountId,
             folderId = folderId,
             folder = null,
@@ -346,7 +346,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             accountIds = setOf(accountId),
             folderId = folderId,
             dispatch = dispatch.function,
-            folderRepository = folderRepository,
+            folderQueryRepository = folderQueryRepository,
         )
 
         // Act
@@ -374,7 +374,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
                 type = FolderType.INBOX,
             )
             val dispatch = RecordingSuspendFunction<MessageListEvent>()
-            val folderRepository = createFolderRepository(
+            val folderQueryRepository = createFolderQueryRepository(
                 accountId = accountId,
                 folderId = folderId,
                 folder = folder,
@@ -388,7 +388,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
                 accountIds = setOf(accountId),
                 folderId = folderId,
                 dispatch = dispatch.function,
-                folderRepository = folderRepository,
+                folderQueryRepository = folderQueryRepository,
                 remoteFolderQueryRepository = remoteFolderQueryRepository,
                 profileRepository = FakeAccountProfileRepository(
                     profiles = listOf(createAccountProfile(accountId = accountId, expectedColor)),
@@ -422,7 +422,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
             accountIds = setOf(AccountIdFactory.create()),
             folderId = 1L,
             logger = TestLogger(),
-            folderRepository = createFolderRepository(
+            folderQueryRepository = createFolderQueryRepository(
                 accountId = AccountIdFactory.create(),
                 folderId = 1L,
                 folder = null,
@@ -447,7 +447,7 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
         folderId: Long? = 1L,
         dispatch: suspend (MessageListEvent) -> Unit = {},
         logger: Logger = TestLogger(),
-        folderRepository: FolderRepository = FakeFolderRepository(),
+        folderQueryRepository: FolderQueryRepository = FakeFolderQueryRepository(),
         remoteFolderQueryRepository: RemoteFolderQueryRepository = FakeRemoteFolderQueryRepository(),
         profileRepository: AccountProfileRepository = FakeAccountProfileRepository(
             profiles = accountIds.map(::createAccountProfile),
@@ -457,16 +457,16 @@ class LoadFolderInformationSideEffectTest : BaseSideEffectHandlerTest() {
         folderId = folderId,
         dispatch = dispatch,
         logger = logger,
-        folderRepository = folderRepository,
+        folderQueryRepository = folderQueryRepository,
         remoteFolderQueryRepository = remoteFolderQueryRepository,
         profileRepository = profileRepository,
     )
 
-    private fun createFolderRepository(
+    private fun createFolderQueryRepository(
         accountId: AccountId,
         folderId: Long,
         folder: MailFolder?,
-    ): FolderRepository = FakeFolderRepository(
+    ): FolderQueryRepository = FakeFolderQueryRepository(
         localFolders = mapOf(accountId to listOfNotNull(folder?.copy(id = folderId))),
     )
 

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/KoinModule.kt

@@ -16,7 +16,7 @@ val unreadWidgetModule = module {
             preferences = get(),
             messageCountsProvider = get(),
             defaultFolderProvider = get(),
-            folderRepository = get(),
+            folderQueryRepository = get(),
             folderNameFormatter = get(),
             coreResourceProvider = get(),
             logger = get(),
@@ -34,5 +34,5 @@ val unreadWidgetModule = module {
             logger = get(),
         )
     }
-    single { UnreadWidgetMigrations(accountRepository = get(), folderRepository = get()) }
+    single { UnreadWidgetMigrations(accountRepository = get(), folderQueryRepository = get()) }
 }

feature/widget/unread/src/main/kotlin/app/k9mail/feature/widget/unread/UnreadWidgetDataProvider.kt

@@ -2,7 +2,6 @@ package app.k9mail.feature.widget.unread
 
 import android.content.Context
 import android.content.Intent
-import app.k9mail.legacy.mailstore.FolderRepository
 import app.k9mail.legacy.message.controller.MessageCountsProvider
 import app.k9mail.legacy.ui.folder.FolderNameFormatter
 import com.fsck.k9.CoreResourceProvider
@@ -13,6 +12,8 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import net.thunderbird.core.android.account.LegacyAccountDto
 import net.thunderbird.core.logging.Logger
+import net.thunderbird.core.outcome.fold
+import net.thunderbird.feature.mail.folder.api.data.repository.FolderQueryRepository
 import net.thunderbird.feature.search.legacy.LocalMessageSearch
 import net.thunderbird.feature.search.legacy.SearchAccount
 
@@ -24,7 +25,7 @@ class UnreadWidgetDataProvider(
     private val preferences: Preferences,
     private val messageCountsProvider: MessageCountsProvider,
     private val defaultFolderProvider: DefaultFolderProvider,
-    private val folderRepository: FolderRepository,
+    private val folderQueryRepository: FolderQueryRepository,
     private val folderNameFormatter: FolderNameFormatter,
     private val coreResourceProvider: CoreResourceProvider,
     private val logger: Logger,
@@ -103,7 +104,8 @@ class UnreadWidgetDataProvider(
     }
 
     private suspend fun getFolderDisplayName(account: LegacyAccountDto, folderId: Long): String {
-        val folder = folderRepository.getFolder(account.id, folderId)
+        val folder = folderQueryRepository.findById(account.id, folderId)
+            .fold(onSuccess = { it }, onFailure = { null })
         return if (folder != null) {
             folderNameFormatter.displayName(folder)
         } else {