feat: migration togs to Timber so we won't post logs in release app (#…

…2283)
novasamatech · Jan 16, 2024 · a221c55 · a221c55
1 parent 4e3d1ef
commit a221c55
Show file tree

Hide file tree

Showing 26 changed files with 73 additions and 66 deletions.
diff --git a/android/build.gradle b/android/build.gradle
@@ -116,6 +116,7 @@ dependencies {
 	implementation "com.appmattus.crypto:cryptohash:0.10.1" //black2b hash for dot icon
 	implementation "io.coil-kt:coil-compose:$coilVersion"
 	implementation "io.coil-kt:coil-svg:$coilVersion"
+	implementation 'com.jakewharton.timber:timber:5.0.1'
 	testImplementation 'junit:junit:4.13.2'
 	testImplementation "org.mockito:mockito-core:5.8.0"
 	testImplementation "androidx.test:core:1.5.0"

diff --git a/android/src/main/java/io/parity/signer/PolkadotVaultApp.kt b/android/src/main/java/io/parity/signer/PolkadotVaultApp.kt
@@ -1,13 +1,15 @@
 package io.parity.signer
 
 import android.app.Application
-import android.util.Log
 import io.parity.signer.dependencygraph.ServiceLocator
 import io.parity.signer.domain.submitErrorState
 import io.parity.signer.uniffi.ErrorDisplayed
 import io.parity.signer.uniffi.initLogging
+import timber.log.Timber
+import timber.log.Timber.*
 import java.lang.Thread.UncaughtExceptionHandler
 
+
 class PolkadotVaultApp : Application() {
 	override fun onCreate() {
 		super.onCreate()
@@ -16,6 +18,10 @@ class PolkadotVaultApp : Application() {
 
 		initLogging("SIGNER_RUST_LOG")
 
+		if (BuildConfig.DEBUG) {
+			Timber.plant(DebugTree())
+		}
+
 		val defaultHandler = Thread.getDefaultUncaughtExceptionHandler()
 		Thread.setDefaultUncaughtExceptionHandler(
 			RootExceptionHandler(defaultHandler)
@@ -34,7 +40,7 @@ class RootExceptionHandler(
 	override fun uncaughtException(t: Thread, e: Throwable) {
 		val rustStr = findErrorDisplayedStr(e)
 		if (rustStr != null) {
-			Log.e(TAG, "Rust caused ErrorDisplay message was: ${rustStr.s}")
+			Timber.e(TAG, "Rust caused ErrorDisplay message was: ${rustStr.s}")
 			submitErrorState("rust error not handled, fix it!")
 		} else {
 			defaultHandler?.uncaughtException(t, e) ?: throw e

diff --git a/android/src/main/java/io/parity/signer/domain/Helpers.kt b/android/src/main/java/io/parity/signer/domain/Helpers.kt
@@ -1,12 +1,12 @@
 package io.parity.signer.domain
 
-import android.util.Log
+import timber.log.Timber
 import io.parity.signer.BuildConfig
 import io.parity.signer.uniffi.ErrorDisplayed
 import java.lang.RuntimeException
 
 fun submitErrorState(message: String) {
-	Log.e("error state", message)
+	Timber.e("error state", message)
 	if (BuildConfig.DEBUG) {
 		throw RuntimeException(message)
 	}

diff --git a/android/src/main/java/io/parity/signer/domain/MainFlowViewModel.kt b/android/src/main/java/io/parity/signer/domain/MainFlowViewModel.kt
@@ -2,7 +2,7 @@ package io.parity.signer.domain
 
 import android.annotation.SuppressLint
 import android.content.*
-import android.util.Log
+import timber.log.Timber
 import androidx.fragment.app.FragmentActivity
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
@@ -34,7 +34,7 @@ class MainFlowViewModel() : ViewModel() {
 				AuthResult.AuthError,
 				AuthResult.AuthFailed,
 				AuthResult.AuthUnavailable -> {
-					Log.e("Signer", "Auth failed, not unlocked")
+					Timber.e("Signer", "Auth failed, not unlocked")
 				}
 			}
 		}

diff --git a/android/src/main/java/io/parity/signer/domain/Navigation.kt b/android/src/main/java/io/parity/signer/domain/Navigation.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.domain
 
 import android.content.Context
-import android.util.Log
+import timber.log.Timber
 import android.widget.Toast
 import io.parity.signer.R
 import io.parity.signer.dependencygraph.ServiceLocator
@@ -44,7 +44,7 @@ class FakeNavigator : Navigator {
 		try {
 			backendAction(action, details, seedPhrase)
 		} catch (e: ErrorDisplayed) {
-			Log.e("fake navigation error", e.message ?: e.toString())
+			Timber.e("fake navigation error", e.message ?: e.toString())
 		}
 		//do nothing with result
 	}

diff --git a/android/src/main/java/io/parity/signer/domain/NavigationLogger.kt b/android/src/main/java/io/parity/signer/domain/NavigationLogger.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.domain
 
 import android.os.Bundle
-import android.util.Log
+import timber.log.Timber
 import androidx.navigation.NavController
 import androidx.navigation.NavDestination
 import androidx.navigation.NavHostController
@@ -19,7 +19,7 @@ private class NavLogger(val tag: String) :
 		destination: NavDestination,
 		arguments: Bundle?
 	) {
-		Log.d(tag, "destination is " + destination.route)
+		Timber.d(tag, "destination is " + destination.route)
 	}
 
 }
diff --git a/android/src/main/java/io/parity/signer/domain/Utils.kt b/android/src/main/java/io/parity/signer/domain/Utils.kt
@@ -2,7 +2,7 @@ package io.parity.signer.domain
 
 import android.content.Context
 import android.graphics.BitmapFactory
-import android.util.Log
+import timber.log.Timber
 import androidx.compose.ui.graphics.ImageBitmap
 import androidx.compose.ui.graphics.asImageBitmap
 import kotlinx.coroutines.CoroutineScope
@@ -65,7 +65,7 @@ fun List<UByte>.intoImageBitmap(): ImageBitmap {
 	return try {
 		BitmapFactory.decodeByteArray(picture, 0, picture.size).asImageBitmap()
 	} catch (e: java.lang.Exception) {
-		Log.d("image decoding error", e.toString())
+		Timber.d("image decoding error", e.toString())
 		ImageBitmap(1, 1)
 	}
 }

diff --git a/android/src/main/java/io/parity/signer/domain/storage/SeedRepository.kt b/android/src/main/java/io/parity/signer/domain/storage/SeedRepository.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.domain.storage
 
 import android.security.keystore.UserNotAuthenticatedException
-import android.util.Log
+import timber.log.Timber
 import android.widget.Toast
 import androidx.fragment.app.FragmentActivity
 import io.parity.signer.domain.AuthResult
@@ -67,7 +67,7 @@ class SeedRepository(
 				}
 			}
 		} catch (e: java.lang.Exception) {
-			Log.d("get seed failure", e.toString())
+			Timber.d("get seed failure", e.toString())
 			Toast.makeText(activity, "get seed failure: $e", Toast.LENGTH_LONG).show()
 			RepoResult.Failure(RuntimeException("Unexpected Exception", e))
 		}
@@ -111,7 +111,7 @@ class SeedRepository(
 				}
 			}
 		} catch (e: java.lang.Exception) {
-			Log.d("get seed failure", e.toString())
+			Timber.d("get seed failure", e.toString())
 			Toast.makeText(activity, "get seed failure: $e", Toast.LENGTH_LONG).show()
 			RepoResult.Failure(RuntimeException("Unexpected Exception", e))
 		}
@@ -141,12 +141,12 @@ class SeedRepository(
 				AuthResult.AuthError,
 				AuthResult.AuthFailed,
 				AuthResult.AuthUnavailable -> {
-					Log.e(TAG, "auth error - $authResult")
+					Timber.e(TAG, "auth error - $authResult")
 					false
 				}
 			}
 		} catch (e: java.lang.Exception) {
-			Log.e(TAG, e.toString())
+			Timber.e(TAG, e.toString())
 			return false
 		}
 	}
@@ -181,15 +181,15 @@ class SeedRepository(
 						is UniffiResult.Success -> OperationResult.Ok(Unit)
 					}
 				} catch (e: java.lang.Exception) {
-					Log.d("remove seed error", e.toString())
+					Timber.d("remove seed error", e.toString())
 					OperationResult.Err(e)
 				}
 			}
 
 			AuthResult.AuthError,
 			AuthResult.AuthFailed,
 			AuthResult.AuthUnavailable -> {
-				Log.d("remove seed auth error ", authResult.toString())
+				Timber.d("remove seed auth error ", authResult.toString())
 				OperationResult.Err(Exception("remove seed auth error $authResult"))
 			}
 		}
@@ -223,7 +223,7 @@ class SeedRepository(
 				AuthResult.AuthError,
 				AuthResult.AuthFailed,
 				AuthResult.AuthUnavailable -> {
-					Log.e(TAG, "auth error - $authResult")
+					Timber.e(TAG, "auth error - $authResult")
 					false
 				}
 			}

diff --git a/android/src/main/java/io/parity/signer/domain/storage/SeedStorage.kt b/android/src/main/java/io/parity/signer/domain/storage/SeedStorage.kt
@@ -5,7 +5,7 @@ import android.content.SharedPreferences
 import android.content.pm.PackageManager
 import android.os.Build
 import android.security.keystore.UserNotAuthenticatedException
-import android.util.Log
+import timber.log.Timber
 import androidx.security.crypto.EncryptedSharedPreferences
 import androidx.security.crypto.MasterKey
 import io.parity.signer.domain.FeatureFlags
@@ -51,7 +51,7 @@ class SeedStorage {
 			false
 		}
 
-		Log.d("strongbox available:", hasStrongbox.toString())
+		Timber.d("strongbox available:", hasStrongbox.toString())
 
 		// Init crypto for seeds:
 		// https://developer.android.com/training/articles/keystore
@@ -74,7 +74,7 @@ class SeedStorage {
 				.build()
 		}
 
-		Log.e("ENCRY", "$appContext $KEYSTORE_NAME $masterKey")
+		Timber.e("ENCRY", "$appContext $KEYSTORE_NAME $masterKey")
 		//we need to be authenticated for this
 		sharedPreferences =
 			if (FeatureFlags.isEnabled(FeatureOption.SKIP_UNLOCK_FOR_DEVELOPMENT)) {

diff --git a/android/src/main/java/io/parity/signer/screens/createderivation/DerivationCreateViewModel.kt b/android/src/main/java/io/parity/signer/screens/createderivation/DerivationCreateViewModel.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.screens.createderivation
 
 import android.content.Context
-import android.util.Log
+import timber.log.Timber
 import android.widget.Toast
 import androidx.lifecycle.ViewModel
 import io.parity.signer.R
@@ -157,10 +157,10 @@ class DerivationCreateViewModel : ViewModel() {
 					}
 				}
 			} else {
-				Log.e(TAG, "Seed phrase received but it's empty")
+				Timber.e(TAG, "Seed phrase received but it's empty")
 			}
 		} catch (e: java.lang.Exception) {
-			Log.e(TAG, e.toString())
+			Timber.e(TAG, e.toString())
 		}
 	}
 

diff --git a/android/src/main/java/io/parity/signer/screens/initial/UnlockScreen.kt b/android/src/main/java/io/parity/signer/screens/initial/UnlockScreen.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.screens.initial
 
 import android.content.res.Configuration
-import android.util.Log
+import timber.log.Timber
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.layout.*
 import androidx.compose.material.MaterialTheme

diff --git a/...n/java/io/parity/signer/screens/initial/eachstartchecks/screenlock/SetScreenLockScreen.kt b/...n/java/io/parity/signer/screens/initial/eachstartchecks/screenlock/SetScreenLockScreen.kt
@@ -3,7 +3,7 @@ package io.parity.signer.screens.initial.eachstartchecks.screenlock
 import android.content.Intent
 import android.content.res.Configuration
 import android.provider.Settings
-import android.util.Log
+import timber.log.Timber
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.layout.*
 import androidx.compose.material.MaterialTheme
@@ -83,7 +83,7 @@ fun SetScreenLockScreen() {
 						null
 					)
 				} else {
-					Log.e("screen lock", "Settings activity not found")
+					Timber.e("screen lock", "Settings activity not found")
 				}
 			}
 		}

diff --git a/android/src/main/java/io/parity/signer/screens/keysetdetails/KeySetDetailsViewModel.kt b/android/src/main/java/io/parity/signer/screens/keysetdetails/KeySetDetailsViewModel.kt
@@ -1,6 +1,6 @@
 package io.parity.signer.screens.keysetdetails
 
-import android.util.Log
+import timber.log.Timber
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import io.parity.signer.dependencygraph.ServiceLocator
@@ -104,7 +104,7 @@ class KeySetDetailsViewModel : ViewModel() {
 
 		return when (result) {
 			null, is OperationResult.Err -> {
-				Log.d(
+				Timber.d(
 					"Keyset",
 					"wrong seed name requested or wrong last known seed getting another one"
 				)

diff --git a/android/src/main/java/io/parity/signer/screens/keysets/create/NewKeysetNameScreen.kt b/android/src/main/java/io/parity/signer/screens/keysets/create/NewKeysetNameScreen.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.screens.keysets.create
 
 import android.content.res.Configuration
-import android.util.Log
+import timber.log.Timber
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.fillMaxSize

diff --git a/.../main/java/io/parity/signer/screens/keysets/restore/keysetname/KeysetRecoverNameScreen.kt b/.../main/java/io/parity/signer/screens/keysets/restore/keysetname/KeysetRecoverNameScreen.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.screens.keysets.restore.keysetname
 
 import android.content.res.Configuration
-import android.util.Log
+import timber.log.Timber
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.fillMaxSize

diff --git a/android/src/main/java/io/parity/signer/screens/scan/ScanViewModel.kt b/android/src/main/java/io/parity/signer/screens/scan/ScanViewModel.kt
@@ -1,7 +1,7 @@
 package io.parity.signer.screens.scan
 
 import android.content.Context
-import android.util.Log
+import timber.log.Timber
 import android.widget.Toast
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
@@ -76,7 +76,7 @@ class ScanViewModel : ViewModel() {
 	suspend fun performTransactionPayload(payload: String, context: Context) {
 		val fakeNavigator = FakeNavigator()
 		if (transactionIsInProgress.value) {
-			Log.e(TAG, "started transaction while it was in progress, ignoring")
+			Timber.e(TAG, "started transaction while it was in progress, ignoring")
 			return
 		}
 		transactionIsInProgress.value = true
@@ -92,7 +92,7 @@ class ScanViewModel : ViewModel() {
 				val screenData = navigateResponse.result.screenData
 				val transactions: List<MTransaction> =
 					(screenData as? ScreenData.Transaction)?.f ?: run {
-						Log.e(
+						Timber.e(
 							TAG,
 							"Error in getting transaction from qr payload, " + "screenData is $screenData, navigation resp is $navigateResponse"
 						)
@@ -224,7 +224,7 @@ class ScanViewModel : ViewModel() {
 	) {
 		when (val phrases = seedRepository.getAllSeeds()) {
 			is RepoResult.Failure -> {
-				Log.e(
+				Timber.e(
 					TAG,
 					"cannot get seeds to show import dynamic derivations ${phrases.error}"
 				)
@@ -255,7 +255,7 @@ class ScanViewModel : ViewModel() {
 	) {
 		when (val phrases = seedRepository.getAllSeeds()) {
 			is RepoResult.Failure -> {
-				Log.e(
+				Timber.e(
 					TAG,
 					"cannot get seeds to show import dynamic derivations ${phrases.error}"
 				)
@@ -435,7 +435,7 @@ class ScanViewModel : ViewModel() {
 	): ActionResult? {
 		return when (val phrases = seedRepository.getSeedPhrases(seedNames)) {
 			is RepoResult.Failure -> {
-				Log.w(TAG, "signature transactions failure ${phrases.error}")
+				Timber.w(TAG, "signature transactions failure ${phrases.error}")
 				null
 			}
 
@@ -453,7 +453,7 @@ class ScanViewModel : ViewModel() {
 			scanFlowInteractor.handlePasswordEntered(password)
 		val actionResult =
 			(navigateResponse as? OperationResult.Ok)?.result ?: run {
-				Log.e(
+				Timber.e(
 					TAG,
 					"Error in entering password for a key, " + "navigation resp is $navigateResponse"
 				)
@@ -478,7 +478,7 @@ class ScanViewModel : ViewModel() {
 			}
 			//ignore the rest modals
 			else -> {
-				Log.e(
+				Timber.e(
 					TAG,
 					"Password is entered for transaction, but neither new password or signature is passed! Should not happen" + "actionResult is $actionResult"
 				)