Move from timber to Logger

stripe · Oct 16, 2024 · 9372621 · 9372621
1 parent 3db4ef5
commit 9372621
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 34 deletions.
diff --git a/dependencies.gradle b/dependencies.gradle
@@ -70,7 +70,6 @@ ext.versions = [
         tensorflowLite              : '2.11.0',
         tensorflowLiteSupport       : '0.4.3',
         testParameterInjector       : '1.17',
-        timber                      : '5.0.1',
         truth                       : '1.4.4',
         turbine                     : '1.1.0',
         uiAutomator                 : '2.3.0',
@@ -191,7 +190,6 @@ ext.libs = [
         tensorflowLiteSupport               : "org.tensorflow:tensorflow-lite-support:${versions.tensorflowLiteSupport}",
         tensorflowLitePlayServices          : "com.google.android.gms:play-services-tflite-java:${versions.playServicesTfLite}",
         tensorflowLitePlayServicesSupport   : "com.google.android.gms:play-services-tflite-support:${versions.playServicesTfLite}",
-        timber                              : "com.jakewharton.timber:timber:${versions.timber}",
         zxing                               : "com.google.zxing:core:${versions.zxing}",
 ]
 

diff --git a/stripe-connect-example/build.gradle b/stripe-connect-example/build.gradle
@@ -13,9 +13,6 @@ dependencies {
     implementation libs.kotlin.coroutinesAndroid
     implementation libs.kotlin.serialization
 
-    // Logging
-    implementation libs.timber
-
     // Networking
     implementation libs.fuel
     implementation libs.fuelCoroutines

diff --git a/stripe-connect-example/dependencies/dependencies.txt b/stripe-connect-example/dependencies/dependencies.txt
@@ -654,9 +654,6 @@
 +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3 (*)
 +--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3 (*)
 +--- org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2 (*)
-+--- com.jakewharton.timber:timber:5.0.1
-|    +--- org.jetbrains.kotlin:kotlin-stdlib:1.5.21 -> 1.9.24 (*)
-|    \--- org.jetbrains:annotations:20.1.0 -> 23.0.0
 +--- com.github.kittinunf.fuel:fuel:2.3.1
 |    +--- com.github.kittinunf.result:result:3.1.0
 |    |    \--- org.jetbrains.kotlin:kotlin-stdlib:1.4.0 -> 1.9.24 (*)

diff --git a/stripe-connect-example/src/main/java/com/stripe/android/connectsdk/example/App.kt b/stripe-connect-example/src/main/java/com/stripe/android/connectsdk/example/App.kt
@@ -2,7 +2,6 @@ package com.stripe.android.connectsdk.example
 
 import android.app.Application
 import android.os.StrictMode
-import timber.log.Timber
 
 class App : Application() {
     override fun onCreate() {
@@ -24,9 +23,5 @@ class App : Application() {
                 .penaltyLog()
                 .build()
         )
-
-        if (BuildConfig.DEBUG) {
-            Timber.plant(Timber.DebugTree())
-        }
     }
 }
diff --git a/...rc/main/java/com/stripe/android/connectsdk/example/networking/EmbeddedComponentService.kt b/...rc/main/java/com/stripe/android/connectsdk/example/networking/EmbeddedComponentService.kt
@@ -7,6 +7,7 @@ import com.github.kittinunf.fuel.core.Request
 import com.github.kittinunf.fuel.core.Response
 import com.github.kittinunf.fuel.core.awaitResult
 import com.github.kittinunf.result.Result
+import com.stripe.android.core.Logger
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
@@ -16,8 +17,8 @@ class EmbeddedComponentService {
     private val fuel = FuelManager.instance
         .apply {
             // add logging
-            addRequestInterceptor(TimberRequestLogger("EmbeddedComponentService"))
-            addResponseInterceptor(TimberResponseLogger("EmbeddedComponentService"))
+            addRequestInterceptor(RequestLogger(tag = "EmbeddedComponentService"))
+            addResponseInterceptor(ResponseLogger(tag = "EmbeddedComponentService"))
 
             // add headers
             addRequestInterceptor(ApplicationJsonHeaderInterceptor)

diff --git a/.../src/main/java/com/stripe/android/connectsdk/example/networking/NetworkingInterceptors.kt b/.../src/main/java/com/stripe/android/connectsdk/example/networking/NetworkingInterceptors.kt
@@ -6,8 +6,9 @@ import com.github.kittinunf.fuel.core.FoldableResponseInterceptor
 import com.github.kittinunf.fuel.core.RequestTransformer
 import com.github.kittinunf.fuel.core.ResponseTransformer
 import com.github.kittinunf.fuel.core.extensions.cUrlString
+import com.stripe.android.connectsdk.example.BuildConfig
+import com.stripe.android.core.Logger
 import com.stripe.android.core.version.StripeSdkVersion
-import timber.log.Timber
 
 object ApplicationJsonHeaderInterceptor : FoldableRequestInterceptor {
     override fun invoke(next: RequestTransformer): RequestTransformer {
@@ -36,23 +37,25 @@ object UserAgentHeader : FoldableRequestInterceptor {
     }
 }
 
-class TimberRequestLogger(private val tag: String) : FoldableRequestInterceptor {
-    private val timber get() = Timber.tag(tag)
-
+class RequestLogger(
+    private val tag: String,
+    private val logger: Logger = Logger.getInstance(enableLogging = BuildConfig.DEBUG),
+) : FoldableRequestInterceptor {
     override fun invoke(next: RequestTransformer): RequestTransformer {
         return { request ->
-            timber.i("Request: ${request.cUrlString()}")
+            logger.info("($tag) Request: ${request.cUrlString()}")
             next(request)
         }
     }
 }
 
-class TimberResponseLogger(private val tag: String) : FoldableResponseInterceptor {
-    private val timber get() = Timber.tag(tag)
-
+class ResponseLogger(
+    private val tag: String,
+    private val logger: Logger = Logger.getInstance(enableLogging = BuildConfig.DEBUG),
+) : FoldableResponseInterceptor {
     override fun invoke(next: ResponseTransformer): ResponseTransformer {
         return { request, response ->
-            timber.i("Response: $response")
+            logger.info("($tag) Response: $response")
             next(request, response)
         }
     }

diff --git a/...oid/connectsdk/example/ui/features/accountonboarding/AccountOnboardingExampleViewModel.kt b/...oid/connectsdk/example/ui/features/accountonboarding/AccountOnboardingExampleViewModel.kt
@@ -4,24 +4,24 @@ import androidx.lifecycle.ViewModel
 import com.github.kittinunf.fuel.core.FuelError
 import com.stripe.android.connectsdk.FetchClientSecretCallback.ClientSecretResultCallback
 import com.stripe.android.connectsdk.PrivateBetaConnectSDK
+import com.stripe.android.connectsdk.example.BuildConfig
 import com.stripe.android.connectsdk.example.networking.EmbeddedComponentService
 import com.stripe.android.connectsdk.example.networking.Merchant
+import com.stripe.android.core.Logger
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
-import timber.log.Timber
 
 class AccountOnboardingExampleViewModel(
     private val embeddedComponentService: EmbeddedComponentService = EmbeddedComponentService(),
     private val networkingScope: CoroutineScope = CoroutineScope(Dispatchers.IO),
+    private val logger: Logger = Logger.getInstance(enableLogging = BuildConfig.DEBUG),
 ) : ViewModel() {
 
-    private val timber get() = Timber.tag("AccountOnboardingExampleViewModel")
-
     private val _state = MutableStateFlow(PayoutsExampleState())
     val state: StateFlow<PayoutsExampleState> = _state.asStateFlow()
 
@@ -38,7 +38,7 @@ class AccountOnboardingExampleViewModel(
                 resultCallback.onResult(clientSecret)
             } catch (e: FuelError) {
                 resultCallback.onError()
-                timber.e("Error fetching client secret: $e")
+                logger.error("(AccountOnboardingExampleViewModel) Error fetching client secret: $e")
             }
         }
     }
@@ -60,7 +60,7 @@ class AccountOnboardingExampleViewModel(
                     )
                 }
             } catch (e: FuelError) {
-                timber.e("Error getting accounts: $e")
+                logger.error("(AccountOnboardingExampleViewModel) Error getting accounts: $e")
             }
         }
     }

diff --git a/...java/com/stripe/android/connectsdk/example/ui/features/payouts/PayoutsExampleViewModel.kt b/...java/com/stripe/android/connectsdk/example/ui/features/payouts/PayoutsExampleViewModel.kt
@@ -4,24 +4,24 @@ import androidx.lifecycle.ViewModel
 import com.github.kittinunf.fuel.core.FuelError
 import com.stripe.android.connectsdk.FetchClientSecretCallback.ClientSecretResultCallback
 import com.stripe.android.connectsdk.PrivateBetaConnectSDK
+import com.stripe.android.connectsdk.example.BuildConfig
 import com.stripe.android.connectsdk.example.networking.EmbeddedComponentService
 import com.stripe.android.connectsdk.example.networking.Merchant
+import com.stripe.android.core.Logger
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
-import timber.log.Timber
 
 class PayoutsExampleViewModel(
     private val embeddedComponentService: EmbeddedComponentService = EmbeddedComponentService(),
     private val networkingScope: CoroutineScope = CoroutineScope(Dispatchers.IO),
+    private val logger: Logger = Logger.getInstance(enableLogging = BuildConfig.DEBUG),
 ) : ViewModel() {
 
-    private val timber get() = Timber.tag("PayoutsExampleViewModel")
-
     private val _state = MutableStateFlow(PayoutsExampleState())
     val state: StateFlow<PayoutsExampleState> = _state.asStateFlow()
 
@@ -38,7 +38,7 @@ class PayoutsExampleViewModel(
                 resultCallback.onResult(clientSecret)
             } catch (e: FuelError) {
                 resultCallback.onError()
-                timber.e("Error fetching client secret: $e")
+                logger.error("(PayoutsExampleViewModel) Error fetching client secret: $e")
             }
         }
     }
@@ -60,7 +60,7 @@ class PayoutsExampleViewModel(
                     )
                 }
             } catch (e: FuelError) {
-                timber.e("Error getting accounts: $e")
+                logger.error("(PayoutsExampleViewModel) Error getting accounts: $e")
             }
         }
     }