Skip to content
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.

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

Fix/crashlytics groups Napier error messages #76

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 31 additions & 2 deletions app/src/main/kotlin/nl/q42/template/logging/CrashlyticsLogger.kt
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,44 @@ class CrashlyticsLogger : Antilog() {

val limitedMessage = message?.take(MAX_CHARS_IN_LOG) ?: "(no message)" // to avoid OutOfMemoryError's

// at least one of message or throwable is not null
if (priority < LogLevel.ERROR) {
// at least one of message or throwable is not null
val errorMessage = throwable?.let {
" with error: ${throwable}: ${throwable.message}".take(MAX_CHARS_IN_LOG)
} ?: ""
Firebase.crashlytics.log(limitedMessage + errorMessage)
} else {
Firebase.crashlytics.log("recordException with message: $limitedMessage")
Firebase.crashlytics.recordException(throwable ?: Exception(message))
Firebase.crashlytics.recordException(throwable ?: buildCrashlyticsSyntheticException(limitedMessage))
}
}

/** Strip the stacktrace so that the calls implementing error logging are removed and the actual
* code that called Napier.e() remains.
*
* This is a workaround for the fact that Crashlytics groups errors by stacktrace
* [https://stackoverflow.com/a/59779764](https://stackoverflow.com/a/59779764)
*/
private fun buildCrashlyticsSyntheticException(message: String): Exception {
val stackTrace = Thread.currentThread().stackTrace
val numToRemove = 9
val lastToRemove = stackTrace[numToRemove - 1]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't never be 💯 % sure there are 8 items in the stacktrace array, so this could either throw an IndexOutOfBounds exception or return null, in the later case, then the if below should crash accessing the className, but since this code compiles I assume the array accessor is not nullable and simply throws an exception.
Would you mind checking if this is the case and if so try to prevent it?

if (lastToRemove.className != "io.github.aakira.napier.Napier" || lastToRemove.methodName != "e\$default"){
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (lastToRemove.className != "io.github.aakira.napier.Napier" || lastToRemove.methodName != "e\$default"){
if (lastToRemove.className != io.github.aakira.napier.Napier::class.java.name || lastToRemove.methodName != "e\$default"){

Could we substitute io.github.aakira.napier.Napier as a string for the actual reference to the library? That should make the solution less fragile

logcatLogger.log(priority = LogLevel.ERROR, tag = null, throwable = null,
message = "Got unexpected stacktrace: class: ${lastToRemove.className}, method: ${lastToRemove.methodName}"
)
}
val abbreviatedStackTrace = stackTrace.takeLast(stackTrace.size - numToRemove).toTypedArray()
return SyntheticException("Synthetic Exception: $message", abbreviatedStackTrace)
}

}

class SyntheticException(
message: String,
private val abbreviatedStackTrace: Array<StackTraceElement>
) : Exception(message) {
override fun getStackTrace(): Array<StackTraceElement> {
return abbreviatedStackTrace
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ class HomeViewModel @Inject constructor(
init {
startObservingUserChanges()
fetchUser()
Napier.e("Nino test error")
}

fun onScreenResumed() {
Expand Down