refactor: migrate K9.isSyncLoggingEnabled to PreferenceDataStore

shamim-emon · shamim-emon · commit 6004e72d9685 · 2025-08-11T22:07:49.000+06:00
diff --git a/core/logging/impl-legacy/build.gradle.kts b/core/logging/impl-legacy/build.gradle.kts
@@ -10,6 +10,8 @@ kotlin {
     sourceSets {
         androidMain.dependencies {
             implementation(libs.timber)
+            implementation(projects.core.logging.implComposite)
+            implementation(projects.core.logging.implFile)
         }
 
         commonMain.dependencies {
diff --git a/core/logging/impl-legacy/src/androidMain/kotlin/net/thunderbird/core/logging/legacy/DebugLogConfigurator.kt b/core/logging/impl-legacy/src/androidMain/kotlin/net/thunderbird/core/logging/legacy/DebugLogConfigurator.kt
@@ -1,14 +1,27 @@
 package net.thunderbird.core.logging.legacy
 
+import net.thunderbird.core.logging.composite.CompositeLogSink
+import net.thunderbird.core.logging.file.FileLogSink
 import timber.log.Timber
+import timber.log.Timber.DebugTree
 
 // TODO: Implementation https://github.com/thunderbird/thunderbird-android/issues/9573
-class DebugLogConfigurator {
-
+class DebugLogConfigurator(
+    private val syncDebugCompositeSink: CompositeLogSink,
+    private val syncDebugFileLogSink: FileLogSink,
+) {
     fun updateLoggingStatus(isDebugLoggingEnabled: Boolean) {
         Timber.uprootAll()
         if (isDebugLoggingEnabled) {
-            Timber.plant(Timber.DebugTree())
+            Timber.plant(DebugTree())
+        }
+    }
+
+    fun updateSyncLogging(isSyncLoggingEnabled: Boolean) {
+        if (isSyncLoggingEnabled) {
+            syncDebugCompositeSink.manager.add(syncDebugFileLogSink)
+        } else {
+            syncDebugCompositeSink.manager.remove(syncDebugFileLogSink)
         }
     }
 }
diff --git a/core/preference/api/src/commonMain/kotlin/net/thunderbird/core/preference/debugging/DebuggingSettings.kt b/core/preference/api/src/commonMain/kotlin/net/thunderbird/core/preference/debugging/DebuggingSettings.kt
@@ -1,7 +1,9 @@
 package net.thunderbird.core.preference.debugging
 
+const val DEBUGGING_SETTINGS_DEFAULT_IS_SYNC_LOGGING_ENABLED = false
 val DEBUGGING_SETTINGS_DEFAULT_IS_DEBUGGING_LOGGING_ENABLED = isDebug
 
 data class DebuggingSettings(
     val isDebugLoggingEnabled: Boolean = DEBUGGING_SETTINGS_DEFAULT_IS_DEBUGGING_LOGGING_ENABLED,
+    val isSyncLoggingEnabled: Boolean = DEBUGGING_SETTINGS_DEFAULT_IS_SYNC_LOGGING_ENABLED,
 )
diff --git a/core/preference/api/src/commonMain/kotlin/net/thunderbird/core/preference/debugging/DebuggingSettingsPreferenceManager.kt b/core/preference/api/src/commonMain/kotlin/net/thunderbird/core/preference/debugging/DebuggingSettingsPreferenceManager.kt
@@ -3,5 +3,6 @@ package net.thunderbird.core.preference.debugging
 import net.thunderbird.core.preference.PreferenceManager
 
 const val KEY_ENABLE_DEBUG_LOGGING = "enableDebugLogging"
+const val KEY_ENABLE_SYNC_DEBUG_LOGGING = "enableSyncDebugLogging"
 
 interface DebuggingSettingsPreferenceManager : PreferenceManager<DebuggingSettings>
diff --git a/core/preference/impl/src/commonMain/kotlin/net/thunderbird/core/preference/debugging/DefaultDebuggingSettingsPreferenceManager.kt b/core/preference/impl/src/commonMain/kotlin/net/thunderbird/core/preference/debugging/DefaultDebuggingSettingsPreferenceManager.kt
@@ -40,13 +40,18 @@ class DefaultDebuggingSettingsPreferenceManager(
             KEY_ENABLE_DEBUG_LOGGING,
             DEBUGGING_SETTINGS_DEFAULT_IS_DEBUGGING_LOGGING_ENABLED,
         ),
+        isSyncLoggingEnabled = storage.getBoolean(
+            KEY_ENABLE_SYNC_DEBUG_LOGGING,
+            DEBUGGING_SETTINGS_DEFAULT_IS_SYNC_LOGGING_ENABLED,
+        ),
     )
 
     private fun writeConfig(config: DebuggingSettings) {
         logger.debug(TAG) { "writeConfig() called with: config = $config" }
         scope.launch(ioDispatcher) {
             mutex.withLock {
                 storageEditor.putBoolean(KEY_ENABLE_DEBUG_LOGGING, config.isDebugLoggingEnabled)
+                storageEditor.putBoolean(KEY_ENABLE_SYNC_DEBUG_LOGGING, config.isSyncLoggingEnabled)
                 storageEditor.commit().also { commited ->
                     logger.verbose(TAG) { "writeConfig: storageEditor.commit() resulted in: $commited" }
                 }
diff --git a/legacy/core/src/main/java/com/fsck/k9/K9.kt b/legacy/core/src/main/java/com/fsck/k9/K9.kt
@@ -16,23 +16,18 @@ import net.thunderbird.core.common.action.SwipeAction
 import net.thunderbird.core.common.action.SwipeActions
 import net.thunderbird.core.featureflag.FeatureFlagProvider
 import net.thunderbird.core.featureflag.toFeatureFlagKey
-import net.thunderbird.core.logging.composite.CompositeLogSink
-import net.thunderbird.core.logging.file.FileLogSink
 import net.thunderbird.core.preference.storage.Storage
 import net.thunderbird.core.preference.storage.StorageEditor
 import net.thunderbird.core.preference.storage.getEnumOrDefault
 import org.koin.core.component.KoinComponent
 import org.koin.core.component.inject
-import org.koin.core.qualifier.named
 import timber.log.Timber
 
 // TODO "Use GeneralSettingsManager and GeneralSettings instead"
 object K9 : KoinComponent {
     private val generalSettingsManager: DefaultGeneralSettingsManager by inject()
     private val telemetryManager: TelemetryManager by inject()
     private val featureFlagProvider: FeatureFlagProvider by inject()
-    private val syncDebugCompositeSink: CompositeLogSink by inject(named("syncDebug"))
-    private val syncDebugFileLogSink: FileLogSink by inject(named("syncDebug"))
 
     /**
      * Name of the [SharedPreferences] file used to store the last known version of the
@@ -118,13 +113,6 @@ object K9 : KoinComponent {
         }
     }
 
-    @JvmStatic
-    var isSyncLoggingEnabled: Boolean = false
-        set(debug) {
-            field = debug
-            updateSyncLogging()
-        }
-
     @JvmStatic
     var isSensitiveDebugLoggingEnabled: Boolean = false
 
@@ -261,7 +249,6 @@ object K9 : KoinComponent {
     @JvmStatic
     @Suppress("LongMethod")
     fun loadPrefs(storage: Storage) {
-        isSyncLoggingEnabled = storage.getBoolean("enableSyncDebugLogging", false)
         isSensitiveDebugLoggingEnabled = storage.getBoolean("enableSensitiveLogging", false)
         isUseVolumeKeysForNavigation = storage.getBoolean("useVolumeKeysForNavigation", false)
         isShowAccountSelector = storage.getBoolean("showAccountSelector", true)
@@ -330,7 +317,6 @@ object K9 : KoinComponent {
 
     @Suppress("LongMethod")
     internal fun save(editor: StorageEditor) {
-        editor.putBoolean("enableSyncDebugLogging", isSyncLoggingEnabled)
         editor.putBoolean("enableSensitiveLogging", isSensitiveDebugLoggingEnabled)
         editor.putBoolean("useVolumeKeysForNavigation", isUseVolumeKeysForNavigation)
         editor.putBoolean("notificationDuringQuietTimeEnabled", isNotificationDuringQuietTimeEnabled)
@@ -379,14 +365,6 @@ object K9 : KoinComponent {
         fontSizes.save(editor)
     }
 
-    private fun updateSyncLogging() {
-        if (isSyncLoggingEnabled) {
-            syncDebugCompositeSink.manager.add(syncDebugFileLogSink)
-        } else {
-            syncDebugCompositeSink.manager.remove(syncDebugFileLogSink)
-        }
-    }
-
     @JvmStatic
     fun saveSettingsAsync() {
         generalSettingsManager.saveSettingsAsync()
diff --git a/legacy/core/src/main/java/com/fsck/k9/job/KoinModule.kt b/legacy/core/src/main/java/com/fsck/k9/job/KoinModule.kt
@@ -50,7 +50,8 @@ val jobModule = module {
             baseLogger = get<Logger>(),
             fileLogSink = get<FileLogSink>(named("syncDebug")),
             syncDebugCompositeSink = get<CompositeLogSink>(named("syncDebug")),
-            parameters,
+            generalSettingsManager = get(),
+            parameters = parameters,
         )
     }
 }
diff --git a/legacy/core/src/main/java/com/fsck/k9/job/SyncDebugWorker.kt b/legacy/core/src/main/java/com/fsck/k9/job/SyncDebugWorker.kt
@@ -3,18 +3,20 @@ package com.fsck.k9.job
 import android.content.Context
 import androidx.work.CoroutineWorker
 import androidx.work.WorkerParameters
-import com.fsck.k9.K9
 import java.io.IOException
 import net.thunderbird.core.logging.Logger
 import net.thunderbird.core.logging.composite.CompositeLogSink
 import net.thunderbird.core.logging.file.FileLogSink
+import net.thunderbird.core.preference.GeneralSettingsManager
+import net.thunderbird.core.preference.update
 
 class SyncDebugWorker(
     context: Context,
     val baseLogger: Logger,
     val fileLogSink: FileLogSink,
     val syncDebugCompositeSink: CompositeLogSink,
     parameters: WorkerParameters,
+    val generalSettingsManager: GeneralSettingsManager,
 ) : CoroutineWorker(context, parameters) {
 
     override suspend fun doWork(): Result {
@@ -25,8 +27,9 @@ class SyncDebugWorker(
             return Result.failure()
         }
         syncDebugCompositeSink.manager.remove(fileLogSink)
-        K9.isSyncLoggingEnabled = false
-        K9.saveSettingsAsync()
+        generalSettingsManager.update { settings ->
+            settings.copy(debugging = settings.debugging.copy(isSyncLoggingEnabled = false))
+        }
         return Result.success()
     }
 }
diff --git a/legacy/core/src/main/java/com/fsck/k9/preferences/DefaultGeneralSettingsManager.kt b/legacy/core/src/main/java/com/fsck/k9/preferences/DefaultGeneralSettingsManager.kt
@@ -76,6 +76,7 @@ internal class DefaultGeneralSettingsManager(
                 debugging = debuggingSettings,
             ).also {
                 debugLogConfigurator.updateLoggingStatus(debuggingSettings.isDebugLoggingEnabled)
+                debugLogConfigurator.updateSyncLogging(debuggingSettings.isSyncLoggingEnabled)
             }
         }
         .stateIn(
diff --git a/legacy/core/src/main/java/com/fsck/k9/preferences/KoinModule.kt b/legacy/core/src/main/java/com/fsck/k9/preferences/KoinModule.kt
@@ -74,7 +74,10 @@ val preferencesModule = module {
         )
     }
     single<DebugLogConfigurator> {
-        DebugLogConfigurator()
+        DebugLogConfigurator(
+            syncDebugCompositeSink = get(named("syncDebug")),
+            syncDebugFileLogSink = get(named("syncDebug")),
+        )
     }
     single {
         DefaultGeneralSettingsManager(
diff --git a/legacy/ui/legacy/src/main/java/com/fsck/k9/ui/settings/general/GeneralSettingsDataStore.kt b/legacy/ui/legacy/src/main/java/com/fsck/k9/ui/settings/general/GeneralSettingsDataStore.kt
@@ -71,7 +71,7 @@ class GeneralSettingsDataStore(
             "privacy_hide_useragent" -> generalSettingsManager.getConfig().privacy.isHideUserAgent
             "privacy_hide_timezone" -> generalSettingsManager.getConfig().privacy.isHideTimeZone
             "debug_logging" -> generalSettingsManager.getConfig().debugging.isDebugLoggingEnabled
-            "sync_debug_logging" -> K9.isSyncLoggingEnabled
+            "sync_debug_logging" -> generalSettingsManager.getConfig().debugging.isSyncLoggingEnabled
             "sensitive_logging" -> K9.isSensitiveDebugLoggingEnabled
             "volume_navigation" -> K9.isUseVolumeKeysForNavigation
             "enable_telemetry" -> K9.isTelemetryEnabled
@@ -111,7 +111,7 @@ class GeneralSettingsDataStore(
             "privacy_hide_useragent" -> setIsHideUserAgent(isHideUserAgent = value)
             "privacy_hide_timezone" -> setIsHideTimeZone(isHideTimeZone = value)
             "debug_logging" -> setIsDebugLoggingEnabled(isDebugLoggingEnabled = value)
-            "sync_debug_logging" -> K9.isSyncLoggingEnabled = value
+            "sync_debug_logging" -> setIsSyncLoggingEnabled(isSyncLoggingEnabled = value)
             "sensitive_logging" -> K9.isSensitiveDebugLoggingEnabled = value
             "volume_navigation" -> K9.isUseVolumeKeysForNavigation = value
             "enable_telemetry" -> setTelemetryEnabled(value)
@@ -479,6 +479,17 @@ class GeneralSettingsDataStore(
         }
     }
 
+    private fun setIsSyncLoggingEnabled(isSyncLoggingEnabled: Boolean) {
+        skipSaveSettings = true
+        generalSettingsManager.update { settings ->
+            settings.copy(
+                debugging = settings.debugging.copy(
+                    isSyncLoggingEnabled = isSyncLoggingEnabled,
+                ),
+            )
+        }
+    }
+
     private fun setIsHideUserAgent(isHideUserAgent: Boolean) {
         skipSaveSettings = true
         generalSettingsManager.update { settings ->

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ kotlin {`
`10`	`10`	`sourceSets {`
`11`	`11`	`androidMain.dependencies {`
`12`	`12`	`implementation(libs.timber)`
	`13`	`+ implementation(projects.core.logging.implComposite)`
	`14`	`+ implementation(projects.core.logging.implFile)`
`13`	`15`	`}`
`14`	`16`
`15`	`17`	`commonMain.dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`package net.thunderbird.core.preference.debugging`
`2`	`2`
	`3`	`+const val DEBUGGING_SETTINGS_DEFAULT_IS_SYNC_LOGGING_ENABLED = false`
`3`	`4`	`val DEBUGGING_SETTINGS_DEFAULT_IS_DEBUGGING_LOGGING_ENABLED = isDebug`
`4`	`5`
`5`	`6`	`data class DebuggingSettings(`
`6`	`7`	`val isDebugLoggingEnabled: Boolean = DEBUGGING_SETTINGS_DEFAULT_IS_DEBUGGING_LOGGING_ENABLED,`
	`8`	`+ val isSyncLoggingEnabled: Boolean = DEBUGGING_SETTINGS_DEFAULT_IS_SYNC_LOGGING_ENABLED,`
`7`	`9`	`)`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ val jobModule = module {`
`50`	`50`	`baseLogger = get<Logger>(),`
`51`	`51`	`fileLogSink = get<FileLogSink>(named("syncDebug")),`
`52`	`52`	`syncDebugCompositeSink = get<CompositeLogSink>(named("syncDebug")),`
`53`		`- parameters,`
	`53`	`+ generalSettingsManager = get(),`
	`54`	`+ parameters = parameters,`
`54`	`55`	`)`
`55`	`56`	`}`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ internal class DefaultGeneralSettingsManager(`
`76`	`76`	`debugging = debuggingSettings,`
`77`	`77`	`).also {`
`78`	`78`	`debugLogConfigurator.updateLoggingStatus(debuggingSettings.isDebugLoggingEnabled)`
	`79`	`+ debugLogConfigurator.updateSyncLogging(debuggingSettings.isSyncLoggingEnabled)`
`79`	`80`	`}`
`80`	`81`	`}`
`81`	`82`	`.stateIn(`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,10 @@ val preferencesModule = module {`
`74`	`74`	`)`
`75`	`75`	`}`
`76`	`76`	`single<DebugLogConfigurator> {`
`77`		`- DebugLogConfigurator()`
	`77`	`+ DebugLogConfigurator(`
	`78`	`+ syncDebugCompositeSink = get(named("syncDebug")),`
	`79`	`+ syncDebugFileLogSink = get(named("syncDebug")),`
	`80`	`+ )`
`78`	`81`	`}`
`79`	`82`	`single {`
`80`	`83`	`DefaultGeneralSettingsManager(`