Migrate from Timber to logcat (#6133)

Task/Issue URL:
https://app.asana.com/1/137249556945/project/488551667048375/task/1210367591024989

### Description
This pull request replaces the `Timber` logging library with Square's
`logcat` library across the codebase. The change improves logging
readability, consistency, and performance by adopting Kotlin string
interpolation and `logcat`'s structured logging features.

- Updated the `STYLEGUIDE.md` to reflect the switch from `Timber` to
`logcat`, including examples of logging with different priorities and
handling exceptions using the `asLog()` extension.
- Replaced the `Timber` dependency with the `logcat` library in all
classes

### Steps to test this PR

- [ ] Build and run all variants

### UI changes
N/A

Author: mikescamell

STYLEGUIDE.md

@@ -15,15 +15,21 @@ If you want to do this automatically upon commit we recommend the existing [pre-
 ##  Code conventions
 
 ### Logging
-When logging with Timber we use the new Kotlin styles strings
+We use Square's logcat library for logging. When logging, we use Kotlin string interpolation:
 
-```Timber.w("Loading $url")```
+```logcat { "Loading $url" }```
 
-Rather than C style strings
+By default, calling logcat without a priority logs at DEBUG level.
 
-```Timber.w("Loading %s", url)```
+For different log levels, specify the priority:
 
-Mixing the two styles within a single statement can lead to crashes so we have standardized on the more readable Kotlin style. This is slightly less efficient - should efficiency become an issue we can use proguard to optimize away log statements for releases.
+```logcat(WARN) { "Loading $url" }```
+
+For logging exceptions, use the `asLog()` extension:
+
+```logcat(ERROR) { "Failed to load: ${exception.asLog()}" }```
+
+This approach provides better performance and readability compared to traditional string formatting.
 
 ### Package Names
 Case in package names is problematic as some file system and tools do not handle case sensitive file changes well. For this reason, we opt for lowercase packages in our project. Thus we have:

ad-click/ad-click-impl/build.gradle

@@ -83,7 +83,7 @@ dependencies {
         exclude group: "org.jetbrains.kotlinx", module: "kotlinx-coroutines-debug"
     }
 
-    implementation JakeWharton.timber
+    implementation "com.squareup.logcat:logcat:_"
 
     implementation Square.retrofit2.converter.moshi
     implementation Square.okHttp3.okHttp

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/DataRemovalAdClickWorker.kt

@@ -33,7 +33,8 @@ import com.squareup.anvil.annotations.ContributesMultibinding
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 import kotlinx.coroutines.withContext
-import timber.log.Timber
+import logcat.LogPriority.VERBOSE
+import logcat.logcat
 
 @ContributesWorker(AppScope::class)
 class DataRemovalAdClickWorker(context: Context, workerParameters: WorkerParameters) :
@@ -64,7 +65,7 @@ class DataRemovalAdClickWorkerScheduler @Inject constructor(
 
     override fun onCreate(owner: LifecycleOwner) {
         super.onCreate(owner)
-        Timber.v("Scheduling ad click data removal worker")
+        logcat(VERBOSE) { "Scheduling ad click data removal worker" }
         val workerRequest = PeriodicWorkRequestBuilder<DataRemovalAdClickWorker>(12, TimeUnit.HOURS)
             .addTag(DATA_REMOVAL_AD_CLICK_WORKER_TAG)
             .setBackoffCriteria(BackoffPolicy.LINEAR, 10, TimeUnit.MINUTES)

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/DuckDuckGoAdClickData.kt

@@ -24,7 +24,7 @@ import com.duckduckgo.common.utils.DispatcherProvider
 import java.util.concurrent.ConcurrentHashMap
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
-import timber.log.Timber
+import logcat.logcat
 
 interface AdClickData {
 
@@ -72,30 +72,30 @@ class DuckDuckGoAdClickData(
 
     override fun setAdDomainTldPlusOne(adDomainTldPlusOne: String) {
         tabAdDomains[activeTabId] = adDomainTldPlusOne
-        Timber.d("Detected ad. Tab ad domains: $tabAdDomains")
+        logcat { "Detected ad. Tab ad domains: $tabAdDomains" }
     }
 
     override fun removeAdDomain() {
         tabAdDomains.remove(activeTabId)
-        Timber.d("Removed previously detected ad. Tab ad domains: $tabAdDomains")
+        logcat { "Removed previously detected ad. Tab ad domains: $tabAdDomains" }
     }
 
     override fun removeAdDomain(tabId: String) {
         tabAdDomains.remove(tabId)
-        Timber.d("Removed previously detected ad for $tabId. Current active tabId is $activeTabId. Tab ad domains: $tabAdDomains")
+        logcat { "Removed previously detected ad for $tabId. Current active tabId is $activeTabId. Tab ad domains: $tabAdDomains" }
     }
 
     override fun setActiveTab(tabId: String) {
         this.activeTabId = tabId
     }
 
     override fun getAdDomainTldPlusOne(): String? {
-        Timber.d("Is ad? ${tabAdDomains[activeTabId] != null} Tab ad domains: $tabAdDomains")
+        logcat { "Is ad? ${tabAdDomains[activeTabId] != null} Tab ad domains: $tabAdDomains" }
         return tabAdDomains[activeTabId]
     }
 
     override fun getAdDomainTldPlusOne(tabId: String): String? {
-        Timber.d("Is ad for tabId $tabId? ${tabAdDomains[tabId] != null}. Active tab is $activeTabId. Tab ad domains: $tabAdDomains")
+        logcat { "Is ad for tabId $tabId? ${tabAdDomains[tabId] != null}. Active tab is $activeTabId. Tab ad domains: $tabAdDomains" }
         return tabAdDomains[tabId]
     }
 
@@ -106,7 +106,7 @@ class DuckDuckGoAdClickData(
                 adClickExemptionsDao.deleteTabExemption(activeTabId)
             }
         }
-        Timber.d("Removed exemption for active tab $activeTabId. Tab exemptions: $tabExemptions")
+        logcat { "Removed exemption for active tab $activeTabId. Tab exemptions: $tabExemptions" }
     }
 
     override fun addExemption(exemption: Exemption) {
@@ -124,7 +124,7 @@ class DuckDuckGoAdClickData(
                 )
             }
         }
-        Timber.d("Added exemption for active tab $activeTabId. Tab exemptions: $tabExemptions")
+        logcat { "Added exemption for active tab $activeTabId. Tab exemptions: $tabExemptions" }
     }
 
     override fun addExemption(tabId: String, exemption: Exemption) {
@@ -142,11 +142,11 @@ class DuckDuckGoAdClickData(
                 )
             }
         }
-        Timber.d("Added exemption for tab $tabId. Tab exemptions: $tabExemptions")
+        logcat { "Added exemption for tab $tabId. Tab exemptions: $tabExemptions" }
     }
 
     override fun getExemption(): Exemption? {
-        Timber.d("Get exemption for tab $activeTabId. Tab exemptions: $tabExemptions")
+        logcat { "Get exemption for tab $activeTabId. Tab exemptions: $tabExemptions" }
         return tabExemptions[activeTabId]
     }
 
@@ -167,7 +167,7 @@ class DuckDuckGoAdClickData(
                 adClickExemptionsDao.deleteTabExemption(tabId)
             }
         }
-        Timber.d("Removed data for tab $tabId. Tab ad domains: $tabAdDomains. Tab exemptions: $tabExemptions")
+        logcat { "Removed data for tab $tabId. Tab ad domains: $tabAdDomains. Tab exemptions: $tabExemptions" }
     }
 
     override fun removeAll() {
@@ -178,7 +178,7 @@ class DuckDuckGoAdClickData(
                 adClickExemptionsDao.deleteAllTabExemptions()
             }
         }
-        Timber.d("Removed all data. Ad clicked map is empty ${tabAdDomains.isEmpty()}. Empty tab exemptions? ${tabExemptions.isEmpty()}")
+        logcat { "Removed all data. Ad clicked map is empty ${tabAdDomains.isEmpty()}. Empty tab exemptions? ${tabExemptions.isEmpty()}" }
     }
 
     override fun removeAllExpired() {
@@ -195,7 +195,7 @@ class DuckDuckGoAdClickData(
                 adClickExemptionsDao.deleteAllExpiredTabExemptions(currentTime)
             }
         }
-        Timber.d("Removed all expired data. Tab exemptions: $tabExemptions")
+        logcat { "Removed all expired data. Tab exemptions: $tabExemptions" }
     }
 
     override fun setCurrentPage(currentPageUrl: String) {

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/DuckDuckGoAdClickManager.kt

@@ -24,8 +24,8 @@ import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import dagger.SingleInstanceIn
 import javax.inject.Inject
+import logcat.logcat
 import okhttp3.internal.publicsuffix.PublicSuffixDatabase
-import timber.log.Timber
 
 @SingleInstanceIn(AppScope::class)
 @ContributesBinding(AppScope::class)
@@ -70,17 +70,17 @@ class DuckDuckGoAdClickManager @Inject constructor(
     }
 
     override fun clearTabId(tabId: String) {
-        Timber.d("Clear data for tab $tabId.")
+        logcat { "Clear data for tab $tabId." }
         adClickData.remove(tabId)
     }
 
     override fun clearAll() {
-        Timber.d("Clear all data.")
+        logcat { "Clear all data." }
         adClickData.removeAll()
     }
 
     override fun clearAllExpiredAsync() {
-        Timber.d("Clear all expired entries (asynchronous).")
+        logcat { "Clear all expired entries (asynchronous)." }
         adClickData.removeAllExpired()
     }
 
@@ -105,13 +105,13 @@ class DuckDuckGoAdClickManager @Inject constructor(
 
         val expired = adClickData.getExemption()?.isExpired() ?: false
         if (expired) {
-            Timber.d("isExemption: Url $url is EXPIRED.")
+            logcat { "isExemption: Url $url is EXPIRED." }
             adClickData.removeExemption()
             return false
         }
 
         if (adClickAttribution.isAllowed(url)) {
-            Timber.d("isExemption: Url $url MATCHES the allow list")
+            logcat { "isExemption: Url $url MATCHES the allow list" }
             val exemption = adClickData.getExemption()
             if (adClickData.getCurrentPage().isNotEmpty()) {
                 adClickData.setCurrentPage("")

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/pixels/AdClickDailyReportingWorker.kt

@@ -32,7 +32,8 @@ import com.squareup.anvil.annotations.ContributesMultibinding
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 import kotlinx.coroutines.withContext
-import timber.log.Timber
+import logcat.LogPriority.VERBOSE
+import logcat.logcat
 
 @ContributesWorker(AppScope::class)
 class AdClickDailyReportingWorker(context: Context, workerParameters: WorkerParameters) :
@@ -62,7 +63,7 @@ class AdClickDailyReportingWorkerScheduler @Inject constructor(
 
     override fun onCreate(owner: LifecycleOwner) {
         super.onCreate(owner)
-        Timber.v("Scheduling ad click daily reporting worker")
+        logcat(VERBOSE) { "Scheduling ad click daily reporting worker" }
         val workerRequest = PeriodicWorkRequestBuilder<AdClickDailyReportingWorker>(24, TimeUnit.HOURS)
             .addTag(DAILY_REPORTING_AD_CLICK_WORKER_TAG)
             .setBackoffCriteria(BackoffPolicy.LINEAR, 10, TimeUnit.MINUTES)

anrs/anrs-impl/src/main/java/com/duckduckgo/app/anr/GlobalUncaughtExceptionHandler.kt

@@ -30,7 +30,7 @@ import javax.inject.Inject
 import javax.inject.Qualifier
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
-import logcat.LogPriority
+import logcat.LogPriority.ERROR
 import logcat.asLog
 import logcat.logcat
 
@@ -82,7 +82,7 @@ class GlobalUncaughtExceptionHandler @Inject constructor(
                     )
                 }
             } catch (e: Throwable) {
-                logcat(LogPriority.ERROR) { e.asLog() }
+                logcat(ERROR) { e.asLog() }
             } finally {
                 originalHandler.uncaughtException(thread, originalException)
             }

app-tracking-protection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/app/tracking/AppTPVpnConnectivityLossListener.kt

@@ -32,7 +32,7 @@ import javax.inject.Inject
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
-import logcat.LogPriority
+import logcat.LogPriority.WARN
 import logcat.logcat
 
 @ContributesMultibinding(
@@ -73,11 +73,11 @@ class AppTPVpnConnectivityLossListener @Inject constructor(
             if (isActive() && connectivityLostEvents++ > 1) {
                 connectivityLostEvents = 0
                 if (reconnectAttempts++ > 2) {
-                    logcat(LogPriority.WARN) { "AppTP detected connectivity loss, again, give up..." }
+                    logcat(WARN) { "AppTP detected connectivity loss, again, give up..." }
                     reconnectAttempts = 0
                     appTrackingProtection.stop()
                 } else {
-                    logcat(LogPriority.WARN) { "AppTP detected connectivity loss, re-configuring..." }
+                    logcat(WARN) { "AppTP detected connectivity loss, re-configuring..." }
                     appTrackingProtection.restart()
                 }
             }

app-tracking-protection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/vpn/blocklist/AppTrackerListDownloader.kt

@@ -26,7 +26,8 @@ import com.duckduckgo.mobile.android.vpn.trackers.AppTrackerPackage
 import com.duckduckgo.mobile.android.vpn.trackers.JsonAppBlockingList
 import com.squareup.anvil.annotations.ContributesBinding
 import javax.inject.Inject
-import logcat.LogPriority
+import logcat.LogPriority.WARN
+import logcat.asLog
 import logcat.logcat
 import okhttp3.ResponseBody.Companion.toResponseBody
 import retrofit2.Response
@@ -57,12 +58,12 @@ class RealAppTrackerListDownloader @Inject constructor(
         val response = runCatching {
             appTrackerListService.appTrackerBlocklist().execute()
         }.getOrElse {
-            logcat(LogPriority.WARN) { "Error downloading tracker rules list: $it" }
+            logcat(WARN) { "Error downloading tracker rules list: ${it.asLog()}" }
             Response.error(400, "".toResponseBody(null))
         }
 
         if (!response.isSuccessful) {
-            logcat(LogPriority.WARN) { "Fail to download the app tracker blocklist, error code: ${response.code()}" }
+            logcat(WARN) { "Fail to download the app tracker blocklist, error code: ${response.code()}" }
             return AppTrackerBlocklist()
         }
 

app-tracking-protection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/vpn/blocklist/AppTrackerListUpdateWorker.kt

@@ -38,7 +38,7 @@ import javax.inject.Inject
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import kotlinx.coroutines.withContext
-import logcat.LogPriority
+import logcat.LogPriority.WARN
 import logcat.logcat
 
 @ContributesWorker(AppScope::class)
@@ -78,7 +78,7 @@ class AppTrackerListUpdateWorker(context: Context, workerParameters: WorkerParam
 
             val success = Result.success()
             if (updateBlocklistResult != success) {
-                logcat(LogPriority.WARN) { "One of the app tracker list updates failed, scheduling a retry" }
+                logcat(WARN) { "One of the app tracker list updates failed, scheduling a retry" }
                 return@withContext Result.retry()
             }
 
@@ -115,7 +115,7 @@ class AppTrackerListUpdateWorker(context: Context, workerParameters: WorkerParam
                 return Result.success()
             }
             else -> {
-                logcat(LogPriority.WARN) { "Received app tracker blocklist with invalid eTag" }
+                logcat(WARN) { "Received app tracker blocklist with invalid eTag" }
                 return Result.retry()
             }
         }