Merge pull request #9863 from shamim-emon/fix-issue-9573

Migrate DebugLogConfigurator to Use New Logger Infrastructure and Isolate from Timber, While Supporting Timber Setup in Android Module

Author: wmontwe

core/logging/config/build.gradle.kts

@@ -0,0 +1,20 @@
+plugins {
+    id(ThunderbirdPlugins.Library.kmp)
+}
+
+android {
+    namespace = "net.thunderbird.core.logging.config"
+}
+
+kotlin {
+    sourceSets {
+        androidMain.dependencies {
+            implementation(libs.timber)
+        }
+        commonMain.dependencies {
+            api(projects.core.logging.api)
+            implementation(projects.core.logging.implComposite)
+            implementation(projects.core.logging.implFile)
+        }
+    }
+}

core/logging/config/src/androidMain/kotlin/net/thunderbird/core/logging/config/PlatformInitializer.android.kt

@@ -0,0 +1,12 @@
+package net.thunderbird.core.logging.config
+
+import timber.log.Timber
+
+actual class PlatformInitializer {
+    actual fun setUp(plantTimber: Boolean) {
+        Timber.uprootAll()
+        if (plantTimber) {
+            Timber.plant(Timber.DebugTree())
+        }
+    }
+}

…e/logging/legacy/DebugLogConfigurator.kt …e/logging/config/DebugLogConfigurator.ktcore/logging/impl-legacy/src/androidMain/kotlin/net/thunderbird/core/logging/legacy/DebugLogConfigurator.kt renamed to core/logging/config/src/commonMain/kotlin/net/thunderbird/core/logging/config/DebugLogConfigurator.kt core/logging/impl-legacy/src/androidMain/kotlin/net/thunderbird/core/logging/legacy/DebugLogConfigurator.kt renamed to core/logging/config/src/commonMain/kotlin/net/thunderbird/core/logging/config/DebugLogConfigurator.kt

@@ -1,20 +1,15 @@
-package net.thunderbird.core.logging.legacy
+package net.thunderbird.core.logging.config
 
 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(
     private val syncDebugCompositeSink: CompositeLogSink,
     private val syncDebugFileLogSink: FileLogSink,
+    private val platformInitializer: PlatformInitializer,
 ) {
     fun updateLoggingStatus(isDebugLoggingEnabled: Boolean) {
-        Timber.uprootAll()
-        if (isDebugLoggingEnabled) {
-            Timber.plant(DebugTree())
-        }
+        platformInitializer.setUp(isDebugLoggingEnabled)
     }
 
     fun updateSyncLogging(isSyncLoggingEnabled: Boolean) {

core/logging/config/src/commonMain/kotlin/net/thunderbird/core/logging/config/PlatformInitializer.kt

@@ -0,0 +1,5 @@
+package net.thunderbird.core.logging.config
+
+expect class PlatformInitializer {
+    fun setUp(plantTimber: Boolean)
+}

core/logging/config/src/jvmMain/kotlin/net/thunderbird/core/logging/config/PlatformInitializer.jvm.kt

@@ -0,0 +1,7 @@
+package net.thunderbird.core.logging.config
+
+actual class PlatformInitializer {
+    actual fun setUp(plantTimber: Boolean) {
+        error("PlatformInitializer is not implemented for JVM platform")
+    }
+}

core/logging/impl-legacy/build.gradle.kts

@@ -12,6 +12,7 @@ kotlin {
             implementation(libs.timber)
             implementation(projects.core.logging.implComposite)
             implementation(projects.core.logging.implFile)
+            implementation(projects.core.logging.config)
         }
 
         commonMain.dependencies {

legacy/core/build.gradle.kts

@@ -14,6 +14,7 @@ dependencies {
     api(projects.core.android.logging)
     api(projects.core.logging.implFile)
     api(projects.core.logging.implComposite)
+    api(projects.core.logging.config)
     api(projects.core.android.network)
     api(projects.core.outcome)
     api(projects.feature.mail.folder.api)

legacy/core/src/main/java/com/fsck/k9/preferences/DefaultGeneralSettingsManager.kt

@@ -13,7 +13,7 @@ import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
-import net.thunderbird.core.logging.legacy.DebugLogConfigurator
+import net.thunderbird.core.logging.config.DebugLogConfigurator
 import net.thunderbird.core.preference.GeneralSettings
 import net.thunderbird.core.preference.GeneralSettingsManager
 import net.thunderbird.core.preference.PreferenceChangePublisher

legacy/core/src/main/java/com/fsck/k9/preferences/KoinModule.kt

@@ -3,7 +3,8 @@ package com.fsck.k9.preferences
 import com.fsck.k9.Preferences
 import kotlin.time.ExperimentalTime
 import net.thunderbird.core.android.account.LegacyAccountDtoManager
-import net.thunderbird.core.logging.legacy.DebugLogConfigurator
+import net.thunderbird.core.logging.config.DebugLogConfigurator
+import net.thunderbird.core.logging.config.PlatformInitializer
 import net.thunderbird.core.preference.DefaultPreferenceChangeBroker
 import net.thunderbird.core.preference.GeneralSettingsManager
 import net.thunderbird.core.preference.PreferenceChangeBroker
@@ -119,10 +120,14 @@ val preferencesModule = module {
             logLevelManager = get(),
         )
     }
+    single<PlatformInitializer> {
+        PlatformInitializer()
+    }
     single<DebugLogConfigurator> {
         DebugLogConfigurator(
             syncDebugCompositeSink = get(named("syncDebug")),
             syncDebugFileLogSink = get(named("syncDebug")),
+            platformInitializer = get(),
         )
     }
     single {

quality/konsist/src/test/kotlin/net/thunderbird/quality/ValidateLogger.kt

@@ -27,10 +27,10 @@ class ValidateLogger {
     @Test
     fun `no class should use Timber logging`() {
         projectScope.files
-            .filterNot { it.hasNameMatching("ConsoleLogSink.android|ConsoleLogSinkTest.android".toRegex()) }
+            .filterNot { it.hasNameMatching("ConsoleLogSink.android|ConsoleLogSinkTest.android|PlatformInitializer.android".toRegex()) }
             .filterNot {
                 // Exclude legacy code that still uses Timber
-                it.hasNameMatching("LogFileWriter|FileLoggerTree|K9|DebugLogConfigurator".toRegex())
+                it.hasNameMatching("LogFileWriter|FileLoggerTree|K9".toRegex())
             }
             .assertFalse(
                 additionalMessage = "No class should use timber.log.Timber import, use net.thunderbird.core.logging.Logger instead."