Merge pull request #7174 from thundernest/add_account_updater

Add account updater

app-feature-preview/build.gradle.kts

@@ -70,6 +70,7 @@ dependencies {
 
     implementation(projects.feature.onboarding)
     implementation(projects.feature.account.setup)
+    implementation(projects.feature.account.edit)
 
     implementation(libs.appauth)
     implementation(libs.okhttp)

app-feature-preview/src/main/java/app/k9mail/feature/preview/FeatureModule.kt

@@ -1,10 +1,11 @@
 package app.k9mail.feature.preview
 
 import app.k9mail.core.common.oauth.OAuthConfigurationFactory
+import app.k9mail.feature.account.edit.AccountEditExternalContract
 import app.k9mail.feature.account.setup.AccountSetupExternalContract
 import app.k9mail.feature.account.setup.featureAccountSetupModule
-import app.k9mail.feature.preview.account.AccountCreator
 import app.k9mail.feature.preview.account.AccountOwnerNameProvider
+import app.k9mail.feature.preview.account.InMemoryAccountStore
 import app.k9mail.feature.preview.auth.AndroidKeyStoreDirectoryProvider
 import app.k9mail.feature.preview.auth.AppOAuthConfigurationFactory
 import app.k9mail.feature.preview.auth.DefaultTrustedSocketFactory
@@ -15,11 +16,18 @@ import com.fsck.k9.mail.ssl.LocalKeyStore
 import com.fsck.k9.mail.ssl.TrustManagerFactory
 import com.fsck.k9.mail.ssl.TrustedSocketFactory
 import org.koin.core.module.Module
+import org.koin.dsl.binds
 import org.koin.dsl.module
 
 val accountModule: Module = module {
+    single { InMemoryAccountStore() }
+        .binds(
+            arrayOf(
+                AccountSetupExternalContract.AccountCreator::class,
+                AccountEditExternalContract.AccountUpdater::class,
+            ),
+        )
     factory<AccountSetupExternalContract.AccountOwnerNameProvider> { AccountOwnerNameProvider() }
-    factory<AccountSetupExternalContract.AccountCreator> { AccountCreator() }
 }
 
 val featureModule: Module = module {
@@ -31,5 +39,8 @@ val featureModule: Module = module {
     single<TrustedSocketFactory> { DefaultTrustedSocketFactory(get(), get()) }
     single<OAuth2TokenProviderFactory> { RealOAuth2TokenProviderFactory(context = get()) }
 
-    includes(featureAccountSetupModule, accountModule)
+    includes(
+        accountModule,
+        featureAccountSetupModule,
+    )
 }

app-feature-preview/src/main/java/app/k9mail/feature/preview/account/InMemoryAccountStore.kt

@@ -0,0 +1,28 @@
+package app.k9mail.feature.preview.account
+
+import app.k9mail.feature.account.common.domain.entity.Account
+import app.k9mail.feature.account.edit.AccountEditExternalContract.AccountUpdater
+import app.k9mail.feature.account.edit.AccountEditExternalContract.AccountUpdater.AccountUpdaterResult
+import app.k9mail.feature.account.setup.AccountSetupExternalContract.AccountCreator
+import app.k9mail.feature.account.setup.AccountSetupExternalContract.AccountCreator.AccountCreatorResult
+
+class InMemoryAccountStore(
+    private val accountMap: MutableMap<String, Account> = mutableMapOf(),
+) : AccountCreator, AccountUpdater {
+
+    override suspend fun createAccount(account: Account): AccountCreatorResult {
+        accountMap[account.uuid] = account
+
+        return AccountCreatorResult.Success(account.uuid)
+    }
+
+    override suspend fun updateAccount(account: Account): AccountUpdaterResult {
+        return if (!accountMap.containsKey(account.uuid)) {
+            AccountUpdaterResult.Error("Account not found")
+        } else {
+            accountMap[account.uuid] = account
+
+            AccountUpdaterResult.Success(account.uuid)
+        }
+    }
+}

app/core/src/main/java/com/fsck/k9/Preferences.kt

@@ -122,7 +122,6 @@ class Preferences internal constructor(
         }
     }
 
-    @OptIn(ExperimentalCoroutinesApi::class)
     override fun getAccountFlow(accountUuid: String): Flow<Account> {
         return callbackFlow {
             val initialAccount = getAccount(accountUuid)
@@ -169,6 +168,10 @@ class Preferences internal constructor(
 
     fun newAccount(): Account {
         val accountUuid = UUID.randomUUID().toString()
+        return newAccount(accountUuid)
+    }
+
+    fun newAccount(accountUuid: String): Account {
         val account = Account(accountUuid)
         accountPreferenceSerializer.loadDefaults(account)
 

app/k9mail/build.gradle.kts

@@ -21,6 +21,7 @@ dependencies {
     implementation(projects.feature.launcher)
 
     implementation(projects.feature.account.setup)
+    implementation(projects.feature.account.edit)
 
     implementation(libs.androidx.appcompat)
     implementation(libs.androidx.core.ktx)

app/k9mail/src/main/java/com/fsck/k9/account/AccountCreator.kt

@@ -40,7 +40,7 @@ class AccountCreator(
     }
 
     private fun create(account: Account): String {
-        val newAccount = preferences.newAccount()
+        val newAccount = preferences.newAccount(account.uuid)
 
         newAccount.email = account.emailAddress
 

app/k9mail/src/main/java/com/fsck/k9/account/AccountModule.kt

@@ -1,5 +1,6 @@
 package com.fsck.k9.account
 
+import app.k9mail.feature.account.edit.AccountEditExternalContract
 import app.k9mail.feature.account.setup.AccountSetupExternalContract
 import org.koin.android.ext.koin.androidApplication
 import org.koin.dsl.module
@@ -19,4 +20,10 @@ val newAccountModule = module {
             context = androidApplication(),
         )
     }
+
+    factory<AccountEditExternalContract.AccountUpdater> {
+        AccountUpdater(
+            preferences = get(),
+        )
+    }
 }

app/k9mail/src/main/java/com/fsck/k9/account/AccountUpdater.kt

@@ -0,0 +1,44 @@
+package com.fsck.k9.account
+
+import app.k9mail.feature.account.common.domain.entity.Account
+import app.k9mail.feature.account.edit.AccountEditExternalContract
+import app.k9mail.feature.account.edit.AccountEditExternalContract.AccountUpdater.AccountUpdaterResult
+import com.fsck.k9.Preferences
+import com.fsck.k9.logging.Timber
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+
+class AccountUpdater(
+    private val preferences: Preferences,
+    private val coroutineDispatcher: CoroutineDispatcher = Dispatchers.IO,
+) : AccountEditExternalContract.AccountUpdater {
+
+    @Suppress("TooGenericExceptionCaught")
+    override suspend fun updateAccount(account: Account): AccountUpdaterResult {
+        return try {
+            withContext(coroutineDispatcher) {
+                AccountUpdaterResult.Success(update(account))
+            }
+        } catch (e: Exception) {
+            Timber.e(e, "Error while updating account")
+
+            AccountUpdaterResult.Error(e.message ?: "Unknown update account error")
+        }
+    }
+
+    private fun update(account: Account): String {
+        val uuid = account.uuid
+        require(uuid.isNotEmpty()) { "Can't update account without uuid" }
+
+        val existingAccount = preferences.getAccount(uuid)
+        require(existingAccount != null) { "Can't update non-existing account" }
+
+        existingAccount.incomingServerSettings = account.incomingServerSettings
+        existingAccount.outgoingServerSettings = account.outgoingServerSettings
+
+        preferences.saveAccount(existingAccount)
+
+        return uuid
+    }
+}

feature/account/common/src/main/kotlin/app/k9mail/feature/account/common/domain/entity/Account.kt

@@ -3,6 +3,7 @@ package app.k9mail.feature.account.common.domain.entity
 import com.fsck.k9.mail.ServerSettings
 
 data class Account(
+    val uuid: String,
     val emailAddress: String,
     val incomingServerSettings: ServerSettings,
     val outgoingServerSettings: ServerSettings,

feature/account/common/src/main/kotlin/app/k9mail/feature/account/common/domain/entity/AccountState.kt

@@ -3,6 +3,7 @@ package app.k9mail.feature.account.common.domain.entity
 import com.fsck.k9.mail.ServerSettings
 
 data class AccountState(
+    val uuid: String? = null,
     val emailAddress: String? = null,
     val incomingServerSettings: ServerSettings? = null,
     val outgoingServerSettings: ServerSettings? = null,

feature/account/common/src/test/kotlin/app/k9mail/feature/account/common/data/InMemoryAccountStateRepositoryTest.kt

@@ -20,6 +20,7 @@ class InMemoryAccountStateRepositoryTest {
 
         assertThat(result).isEqualTo(
             AccountState(
+                uuid = null,
                 emailAddress = null,
                 incomingServerSettings = null,
                 outgoingServerSettings = null,
@@ -33,6 +34,7 @@ class InMemoryAccountStateRepositoryTest {
     fun `should save state`() {
         val testSubject = InMemoryAccountStateRepository(
             AccountState(
+                uuid = "uuid",
                 emailAddress = "emailAddress",
                 incomingServerSettings = INCOMING_SERVER_SETTINGS,
                 outgoingServerSettings = OUTGOING_SERVER_SETTINGS,
@@ -41,6 +43,7 @@ class InMemoryAccountStateRepositoryTest {
             ),
         )
         val newState = AccountState(
+            uuid = "uuid2",
             emailAddress = "emailAddress2",
             incomingServerSettings = INCOMING_SERVER_SETTINGS.copy(host = "imap2.example.org"),
             outgoingServerSettings = OUTGOING_SERVER_SETTINGS.copy(host = "smtp2.example.org"),
@@ -114,6 +117,7 @@ class InMemoryAccountStateRepositoryTest {
     fun `should clear state`() {
         val testSubject = InMemoryAccountStateRepository(
             AccountState(
+                uuid = "uuid",
                 emailAddress = "emailAddress",
                 incomingServerSettings = INCOMING_SERVER_SETTINGS,
                 outgoingServerSettings = OUTGOING_SERVER_SETTINGS,
@@ -126,6 +130,7 @@ class InMemoryAccountStateRepositoryTest {
 
         assertThat(testSubject.getState()).isEqualTo(
             AccountState(
+                uuid = null,
                 emailAddress = null,
                 incomingServerSettings = null,
                 outgoingServerSettings = null,

feature/account/edit/build.gradle.kts

@@ -0,0 +1,28 @@
+plugins {
+    id(ThunderbirdPlugins.Library.androidCompose)
+}
+
+android {
+    namespace = "app.k9mail.feature.account.edit"
+    resourcePrefix = "account_edit_"
+
+    buildTypes {
+        debug {
+            manifestPlaceholders["appAuthRedirectScheme"] = "FIXME: override this in your app project"
+        }
+        release {
+            manifestPlaceholders["appAuthRedirectScheme"] = "FIXME: override this in your app project"
+        }
+    }
+}
+
+dependencies {
+    implementation(projects.core.ui.compose.designsystem)
+    implementation(projects.core.common)
+
+    implementation(projects.feature.account.common)
+    implementation(projects.feature.account.oauth)
+    implementation(projects.feature.account.server.validation)
+
+    testImplementation(projects.core.ui.compose.testing)
+}

feature/account/edit/src/main/kotlin/app/k9mail/feature/account/edit/AccountEditExternalContract.kt

@@ -0,0 +1,15 @@
+package app.k9mail.feature.account.edit
+
+import app.k9mail.feature.account.common.domain.entity.Account
+
+interface AccountEditExternalContract {
+
+    fun interface AccountUpdater {
+        suspend fun updateAccount(account: Account): AccountUpdaterResult
+
+        sealed interface AccountUpdaterResult {
+            data class Success(val accountId: String) : AccountUpdaterResult
+            data class Error(val message: String) : AccountUpdaterResult
+        }
+    }
+}

feature/account/edit/src/main/kotlin/app/k9mail/feature/account/edit/AccountEditModule.kt

@@ -0,0 +1,9 @@
+package app.k9mail.feature.account.edit
+
+import app.k9mail.core.common.coreCommonModule
+import app.k9mail.feature.account.oauth.featureAccountOAuthModule
+import org.koin.dsl.module
+
+val accountEditModule = module {
+    includes(coreCommonModule, featureAccountOAuthModule)
+}

feature/account/setup/src/main/kotlin/app/k9mail/feature/account/setup/domain/usecase/CreateAccount.kt

@@ -6,9 +6,11 @@ import app.k9mail.feature.account.setup.AccountSetupExternalContract.AccountCrea
 import app.k9mail.feature.account.setup.AccountSetupExternalContract.AccountCreator.AccountCreatorResult
 import app.k9mail.feature.account.setup.domain.DomainContract.UseCase
 import com.fsck.k9.mail.ServerSettings
+import java.util.UUID
 
 class CreateAccount(
     private val accountCreator: AccountCreator,
+    private val uuidGenerator: () -> String = { UUID.randomUUID().toString() },
 ) : UseCase.CreateAccount {
     override suspend fun execute(
         emailAddress: String,
@@ -18,6 +20,7 @@ class CreateAccount(
         options: AccountOptions,
     ): String {
         val account = Account(
+            uuid = uuidGenerator(),
             emailAddress = emailAddress,
             incomingServerSettings = incomingServerSettings,
             outgoingServerSettings = outgoingServerSettings,

feature/account/setup/src/test/kotlin/app/k9mail/feature/account/setup/domain/usecase/CreateAccountTest.kt

@@ -21,6 +21,7 @@ class CreateAccountTest {
                 recordedAccount = account
                 AccountCreatorResult.Success(accountUuid = "uuid")
             },
+            uuidGenerator = { "uuid" },
         )
 
         val emailAddress = "[email protected]"
@@ -65,6 +66,7 @@ class CreateAccountTest {
         assertThat(result).isEqualTo("uuid")
         assertThat(recordedAccount).isEqualTo(
             Account(
+                uuid = "uuid",
                 emailAddress = emailAddress,
                 incomingServerSettings = incomingServerSettings,
                 outgoingServerSettings = outgoingServerSettings,

settings.gradle.kts

@@ -45,6 +45,7 @@ include(
 
 include(
     ":feature:account:common",
+    ":feature:account:edit",
     ":feature:account:oauth",
     ":feature:account:setup",
     ":feature:account:server:certificate",