Merge branch 'feat/error-reporting-v2' into 'master'

fmasa · fmasa · commit d2a14dca91d5 · 2020-06-20T13:04:20.000Z
Přidány logy a další kontext pro crash reporting

See merge request fmasa/pv239-project!64
diff --git a/app/build.gradle b/app/build.gradle
@@ -137,4 +137,6 @@ dependencies {
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
 
     implementation "io.arrow-kt:arrow-core:0.10.4"
+
+    implementation 'com.jakewharton.timber:timber:4.7.1'
 }
diff --git a/app/src/main/java/cz/muni/fi/rpg/Application.kt b/app/src/main/java/cz/muni/fi/rpg/Application.kt
@@ -1,10 +1,13 @@
 package cz.muni.fi.rpg
 
+import com.google.firebase.crashlytics.FirebaseCrashlytics
+import cz.muni.fi.rpg.common.log.CrashlyticsTree
+import cz.muni.fi.rpg.common.log.KoinTimberLogger
 import cz.muni.fi.rpg.di.appModule
 import org.koin.android.ext.koin.androidContext
-import org.koin.android.ext.koin.androidLogger
 import org.koin.androidx.fragment.koin.fragmentFactory
 import org.koin.core.context.startKoin
+import timber.log.Timber
 import android.app.Application as BaseApplication
 
 class Application : BaseApplication() {
@@ -16,9 +19,15 @@ class Application : BaseApplication() {
 
             // declare used Android context
             androidContext(this@Application)
-            androidLogger()
+            logger(KoinTimberLogger())
             // declare modules
             modules(appModule)
         }
+
+        Timber.plant(
+            if (BuildConfig.DEBUG)
+                Timber.DebugTree()
+            else CrashlyticsTree(FirebaseCrashlytics.getInstance())
+        )
     }
 }
diff --git a/app/src/main/java/cz/muni/fi/rpg/common/log/CrashlyticsTree.kt b/app/src/main/java/cz/muni/fi/rpg/common/log/CrashlyticsTree.kt
@@ -0,0 +1,21 @@
+package cz.muni.fi.rpg.common.log
+
+import android.util.Log
+import com.google.firebase.crashlytics.FirebaseCrashlytics
+import timber.log.Timber
+
+/**
+ * Handles log entries as either log context or error reporting to Crashlytics
+ */
+class CrashlyticsTree(
+    private val crashlytics: FirebaseCrashlytics
+) : Timber.Tree() {
+
+    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
+        crashlytics.log(message)
+
+        if (priority == Log.WARN || priority == Log.ERROR) {
+            crashlytics.recordException(t ?: Exception(message))
+        }
+    }
+}
diff --git a/app/src/main/java/cz/muni/fi/rpg/common/log/KoinTimberLogger.kt b/app/src/main/java/cz/muni/fi/rpg/common/log/KoinTimberLogger.kt
@@ -0,0 +1,20 @@
+package cz.muni.fi.rpg.common.log
+
+import org.koin.core.logger.KOIN_TAG
+import org.koin.core.logger.Level
+import org.koin.core.logger.Logger
+import timber.log.Timber
+
+class KoinTimberLogger(level: Level = Level.INFO) : Logger(level) {
+
+    private val tree = Timber.tag(KOIN_TAG)
+
+    override fun log(level: Level, msg: String) {
+        when (level) {
+            Level.DEBUG -> tree.d(msg)
+            Level.INFO -> tree.i(msg)
+            Level.ERROR -> tree.e(msg)
+            else -> tree.e(msg)
+        }
+    }
+}
diff --git a/app/src/main/java/cz/muni/fi/rpg/common/log/Reporter.kt b/app/src/main/java/cz/muni/fi/rpg/common/log/Reporter.kt
@@ -0,0 +1,15 @@
+package cz.muni.fi.rpg.common.log
+
+import com.google.firebase.crashlytics.FirebaseCrashlytics
+
+class Reporter {
+    companion object {
+        private val crashlytics by lazy { FirebaseCrashlytics.getInstance() }
+
+        fun setUserId(id: String) {
+            crashlytics.setUserId(id)
+        }
+    }
+}
+
+
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/firestore/jackson/JacksonAggregateMapper.kt b/app/src/main/java/cz/muni/fi/rpg/model/firestore/jackson/JacksonAggregateMapper.kt
@@ -1,13 +1,13 @@
 package cz.muni.fi.rpg.model.firestore.jackson
 
-import android.util.Log
 import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility
 import com.fasterxml.jackson.annotation.PropertyAccessor
 import com.fasterxml.jackson.core.type.TypeReference
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.google.firebase.firestore.DocumentSnapshot
 import cz.muni.fi.rpg.model.firestore.AggregateMapper
 import cz.muni.fi.rpg.model.firestore.DocumentData
+import timber.log.Timber
 import kotlin.reflect.KClass
 
 internal class JacksonAggregateMapper<T : Any>(
@@ -21,7 +21,7 @@ internal class JacksonAggregateMapper<T : Any>(
         .setVisibility(PropertyAccessor.IS_GETTER, Visibility.NONE)
 
     override fun fromDocumentSnapshot(snapshot: DocumentSnapshot): T {
-        Log.d("JacksonAggregateMapper", "Mapping document $snapshot to ${aggregateType.simpleName}")
+        Timber.d("Mapping document $snapshot to ${aggregateType.simpleName}")
         return mapper.convertValue(snapshot.data, aggregateType.java)
     }
 
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestoreCharacterRepository.kt b/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestoreCharacterRepository.kt
@@ -1,6 +1,5 @@
 package cz.muni.fi.rpg.model.firestore.repositories
 
-import android.util.Log
 import androidx.lifecycle.LiveData
 import arrow.core.Either
 import com.google.firebase.firestore.FirebaseFirestore
@@ -12,19 +11,19 @@ import cz.muni.fi.rpg.model.domain.character.CharacterNotFound
 import cz.muni.fi.rpg.model.domain.character.CharacterRepository
 import cz.muni.fi.rpg.model.firestore.*
 import kotlinx.coroutines.tasks.await
+import timber.log.Timber
 import java.util.*
 
 internal class FirestoreCharacterRepository(
     firestore: FirebaseFirestore,
     private val mapper: AggregateMapper<Character>
 ) : CharacterRepository {
-    private val tag = this::class.simpleName
     private val parties = firestore.collection(COLLECTION_PARTIES)
 
     override suspend fun save(partyId: UUID, character: Character) {
         val data = mapper.toDocumentData(character)
 
-        Log.d(tag,"Saving character $data in party $partyId to firestore")
+        Timber.d("Saving character $data in party $partyId to firestore")
         characters(partyId).document(character.userId).set(data, SetOptions.merge()).await()
     }
 
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestoreInventoryItemRepository.kt b/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestoreInventoryItemRepository.kt
@@ -1,6 +1,5 @@
 package cz.muni.fi.rpg.model.firestore.repositories
 
-import android.util.Log
 import com.google.firebase.firestore.CollectionReference
 import com.google.firebase.firestore.FirebaseFirestore
 import com.google.firebase.firestore.FirebaseFirestoreException
@@ -12,12 +11,12 @@ import cz.muni.fi.rpg.model.domain.inventory.InventoryItemNotFound
 import cz.muni.fi.rpg.model.domain.inventory.InventoryItemRepository
 import cz.muni.fi.rpg.model.firestore.*
 import kotlinx.coroutines.tasks.await
+import timber.log.Timber
 
 internal class FirestoreInventoryItemRepository(
     firestore: FirebaseFirestore,
     private val mapper: AggregateMapper<InventoryItem>
 ) : InventoryItemRepository {
-    private val tag = this::class.simpleName
     private val parties = firestore.collection(COLLECTION_PARTIES)
 
     override fun findAllForCharacter(characterId: CharacterId) =
@@ -28,7 +27,7 @@ internal class FirestoreInventoryItemRepository(
 
     override suspend fun save(characterId: CharacterId, item: InventoryItem) {
         val data = mapper.toDocumentData(item)
-        Log.d(tag,"Saving inventory item $data for character $characterId")
+        Timber.d("Saving inventory item $data for character $characterId")
 
         inventoryItems(characterId)
             .document(item.id.toString())
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestorePartyRepository.kt b/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestorePartyRepository.kt
@@ -1,6 +1,5 @@
 package cz.muni.fi.rpg.model.firestore.repositories
 
-import android.util.Log
 import androidx.lifecycle.LiveData
 import arrow.core.Either
 import com.google.firebase.firestore.FirebaseFirestore
@@ -14,19 +13,19 @@ import cz.muni.fi.rpg.model.firestore.AggregateMapper
 import cz.muni.fi.rpg.model.firestore.DocumentLiveData
 import cz.muni.fi.rpg.model.firestore.QueryLiveData
 import kotlinx.coroutines.tasks.await
+import timber.log.Timber
 import java.util.*
 
 internal class FirestorePartyRepository(
     private val firestore: FirebaseFirestore,
     private val mapper: AggregateMapper<Party>
 ) : PartyRepository {
-    private val tag = this::class.simpleName
     private val parties = firestore.collection("parties")
 
     override suspend fun save(party: Party) {
         val data = mapper.toDocumentData(party)
 
-        Log.d(tag,"Saving party $data to firestore")
+        Timber.d("Saving party $data to firestore")
         try {
             firestore.runTransaction { transaction ->
                 transaction.set(parties.document(party.id.toString()), data, SetOptions.merge())
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/StartupActivity.kt b/app/src/main/java/cz/muni/fi/rpg/ui/StartupActivity.kt
@@ -4,6 +4,7 @@ import android.content.Intent
 import android.widget.Toast
 import androidx.appcompat.app.AppCompatActivity
 import cz.muni.fi.rpg.R
+import cz.muni.fi.rpg.common.log.Reporter
 import cz.muni.fi.rpg.viewModels.AuthenticationViewModel
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
@@ -21,6 +22,7 @@ class StartupActivity : AppCompatActivity(R.layout.activity_startup),
 
         launch {
             if (viewModel.isAuthenticated() || viewModel.authenticateAnonymously()) {
+                Reporter.setUserId(viewModel.getUserId())
                 showPartyList()
             } else {
                 withContext(Dispatchers.Main) {
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/character/CharacterFragment.kt b/app/src/main/java/cz/muni/fi/rpg/ui/character/CharacterFragment.kt
@@ -1,7 +1,6 @@
 package cz.muni.fi.rpg.ui.character
 
 import android.os.Bundle
-import android.util.Log
 import android.view.Menu
 import android.view.MenuInflater
 import android.view.MenuItem
@@ -11,6 +10,7 @@ import androidx.navigation.fragment.findNavController
 import androidx.navigation.fragment.navArgs
 import com.google.android.material.tabs.TabLayoutMediator
 import cz.muni.fi.rpg.R
+import cz.muni.fi.rpg.model.domain.character.CharacterNotFound
 import cz.muni.fi.rpg.model.right
 import cz.muni.fi.rpg.ui.character.skills.CharacterSkillsFragment
 import cz.muni.fi.rpg.ui.common.AdManager
@@ -21,6 +21,7 @@ import cz.muni.fi.rpg.viewModels.PartyViewModel
 import kotlinx.android.synthetic.main.fragment_character.*
 import org.koin.android.viewmodel.ext.android.viewModel
 import org.koin.core.parameter.parametersOf
+import timber.log.Timber
 
 
 class CharacterFragment(
@@ -33,11 +34,12 @@ class CharacterFragment(
 
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
+        Timber.d("Created view for CharacterFragment (characterId = ${args.characterId})")
 
         setHasOptionsMenu(true)
 
         viewModel.character.observe(viewLifecycleOwner) {
-            it.mapLeft { openCharacterCreation() }
+            it.mapLeft { e -> openCharacterCreation(e) }
             it.map {
                 character -> setTitle(character.getName())
                 mainView.visibility = View.VISIBLE
@@ -104,8 +106,8 @@ class CharacterFragment(
         return super.onOptionsItemSelected(item)
     }
 
-    private fun openCharacterCreation() {
-        Log.e("CharacterFragment", "Character not found")
+    private fun openCharacterCreation(e: CharacterNotFound) {
+        Timber.e(e, "Character not found")
 
         findNavController()
             .navigate(CharacterFragmentDirections.createCharacter(args.characterId.partyId))
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/character/inventory/InventoryItemDialog.kt b/app/src/main/java/cz/muni/fi/rpg/ui/character/inventory/InventoryItemDialog.kt
@@ -20,6 +20,7 @@ import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.koin.android.viewmodel.ext.android.viewModel
 import org.koin.core.parameter.parametersOf
+import timber.log.Timber
 
 class InventoryItemDialog : DialogFragment(),
     CoroutineScope by CoroutineScope(Dispatchers.Default) {
@@ -106,8 +107,9 @@ class InventoryItemDialog : DialogFragment(),
 
                 toast(getString(R.string.inventory_toast_item_saved))
                 dismiss()
-            } catch (e: java.lang.Exception) {
+            } catch (e: Throwable) {
                 toast("Item couldn't be added to your inventory.")
+                Timber.e(e)
             }
         }
     }
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/characterCreation/CharacterCreationFragment.kt b/app/src/main/java/cz/muni/fi/rpg/ui/characterCreation/CharacterCreationFragment.kt
@@ -1,6 +1,5 @@
 package cz.muni.fi.rpg.ui.characterCreation
 
-import android.util.Log
 import android.view.View
 import android.widget.Toast
 import androidx.fragment.app.Fragment
@@ -17,6 +16,7 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.koin.android.viewmodel.ext.android.sharedViewModel
+import timber.log.Timber
 
 class CharacterCreationFragment(
     private val characters: CharacterRepository
@@ -129,7 +129,7 @@ class CharacterCreationFragment(
         points: Points
     ) {
         launch {
-            Log.d(tag, "Creating character")
+            Timber.d("Creating character")
             characters.save(
                 args.partyId,
                 Character(
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/gameMaster/GameMasterFragment.kt b/app/src/main/java/cz/muni/fi/rpg/ui/gameMaster/GameMasterFragment.kt
@@ -19,6 +19,7 @@ import cz.muni.fi.rpg.viewModels.PartyViewModel
 import kotlinx.android.synthetic.main.fragment_game_master.*
 import org.koin.core.parameter.parametersOf
 import org.koin.android.viewmodel.ext.android.viewModel
+import timber.log.Timber
 
 class GameMasterFragment(
     private val jsonMapper: JsonMapper,
@@ -44,6 +45,7 @@ class GameMasterFragment(
 
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
+        Timber.d("Created view for GameMasterFragment (partyId = ${args.partyId}")
 
 
         partyViewModel.party.right().observe(viewLifecycleOwner) { party ->
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/gameMaster/InvitationDialog.kt b/app/src/main/java/cz/muni/fi/rpg/ui/gameMaster/InvitationDialog.kt
@@ -4,7 +4,6 @@ import android.app.Dialog
 import android.content.Intent
 import android.net.Uri
 import android.os.Bundle
-import android.util.Log
 import android.view.View
 import androidx.appcompat.app.AlertDialog
 import androidx.fragment.app.DialogFragment
@@ -20,6 +19,7 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.tasks.await
 import kotlinx.coroutines.withContext
+import timber.log.Timber
 
 class InvitationDialog(
     private val invitation: Invitation,
@@ -58,7 +58,7 @@ class InvitationDialog(
             domainUriPrefix = "https://wfrp.page.link"
         }.await()
 
-        Log.d(tag, "Invitation link was generated: ${link.shortLink}")
+        Timber.d("Invitation link was generated: ${link.shortLink}")
 
         withContext(Dispatchers.Main) {
             view.shareButton.setOnClickListener {
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/joinParty/InvitationLinkActivity.kt b/app/src/main/java/cz/muni/fi/rpg/ui/joinParty/InvitationLinkActivity.kt
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/joinParty/JoinPartyActivity.kt b/app/src/main/java/cz/muni/fi/rpg/ui/joinParty/JoinPartyActivity.kt
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/joinParty/JoinPartyDialog.kt b/app/src/main/java/cz/muni/fi/rpg/ui/joinParty/JoinPartyDialog.kt
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/partyList/AssemblePartyDialog.kt b/app/src/main/java/cz/muni/fi/rpg/ui/partyList/AssemblePartyDialog.kt
diff --git a/app/src/main/java/cz/muni/fi/rpg/viewModels/AuthenticationViewModel.kt b/app/src/main/java/cz/muni/fi/rpg/viewModels/AuthenticationViewModel.kt

Original file line number	Diff line number	Diff line change
`@@ -137,4 +137,6 @@ dependencies {`
`137`	`137`	`androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'`
`138`	`138`
`139`	`139`	`implementation "io.arrow-kt:arrow-core:0.10.4"`
	`140`	`+`
	`141`	`+ implementation 'com.jakewharton.timber:timber:4.7.1'`
`140`	`142`	`}`