Skip to content

Decouple DebugLogConfigurator From Timber And Relocate to New Logger Infra #9816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wmontwe merged 3 commits into from
Sep 26, 2025
Merged

Decouple DebugLogConfigurator From Timber And Relocate to New Logger Infra #9816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a90b20d
refactor: move DebugLogConfigurator to core:logging:config module
shamim-emon Sep 17, 2025
feb8c23
test: remove the DebugLogConfigurator from the exclusion list of Timb…
shamim-emon Sep 17, 2025
b55b2e3
refactor: eliminate direct dependency on timber.log.Timber in DebugLo…
shamim-emon Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions core/logging/config/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
plugins {
id(ThunderbirdPlugins.Library.kmp)
}

android {
namespace = "net.thunderbird.core.logging.config"
}

kotlin {
sourceSets {
commonMain.dependencies {
api(projects.core.logging.api)
implementation(projects.core.logging.implComposite)
implementation(projects.core.logging.implFile)
}
}
}
10 changes: 4 additions & 6 deletions ...re/logging/legacy/DebugLogConfigurator.kt → ...re/logging/config/DebugLogConfigurator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
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,
) {
fun updateLoggingStatus(isDebugLoggingEnabled: Boolean) {
Timber.uprootAll()
syncDebugCompositeSink.manager.removeAll()
if (isDebugLoggingEnabled) {
Timber.plant(DebugTree())
syncDebugCompositeSink.manager.add(syncDebugCompositeSink)
syncDebugCompositeSink.manager.add(syncDebugFileLogSink)
}
}

Expand Down
1 change: 1 addition & 0 deletions legacy/core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ dependencies {
api(projects.core.preference.impl)
api(projects.core.android.logging)
api(projects.core.logging.implFile)
api(projects.core.logging.config)
api(projects.core.logging.implComposite)
api(projects.core.android.network)
api(projects.core.outcome)
Expand Down
2 changes: 1 addition & 1 deletion legacy/core/src/main/java/com/fsck/k9/preferences/DefaultGeneralSettingsManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion legacy/core/src/main/java/com/fsck/k9/preferences/KoinModule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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.preference.DefaultPreferenceChangeBroker
import net.thunderbird.core.preference.GeneralSettingsManager
import net.thunderbird.core.preference.PreferenceChangeBroker
Expand Down
2 changes: 1 addition & 1 deletion quality/konsist/src/test/kotlin/net/thunderbird/quality/ValidateLogger.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class ValidateLogger {
.filterNot { it.hasNameMatching("ConsoleLogSink.android|ConsoleLogSinkTest.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."
Expand Down
1 change: 1 addition & 0 deletions settings.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ include(
":core:configstore:impl-backend",
":core:featureflag",
":core:logging:api",
":core:logging:config",
":core:logging:impl-composite",
":core:logging:impl-console",
":core:logging:impl-legacy",
Expand Down
Loading