From 54f972b2ee4c3afe55b9bbc50dae6db10d1757fa Mon Sep 17 00:00:00 2001 From: Davide Depau Date: Sun, 23 Mar 2025 21:28:41 +0100 Subject: [PATCH] Add support for Crashlytics as well --- app/build.gradle.kts | 11 +++++-- app/src/gplay/AndroidManifest.xml | 5 +++ .../etchdroid/plugins/telemetry/Telemetry.kt | 33 +++++++++++++++++-- build.gradle.kts | 5 +++ gradle/libs.versions.toml | 9 +++-- 5 files changed, 56 insertions(+), 7 deletions(-) diff --git a/app/build.gradle.kts b/app/build.gradle.kts index 5f8744e..b066d07 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -11,11 +11,12 @@ plugins { alias(libs.plugins.android.junit5) if (System.getProperty("etchdroid.isGPlayFlavor") == "true" || System.getenv("ETCHDROID_ENABLE_SENTRY") == "true") { - println("EtchDroid: Sentry enabled") -// alias(libs.plugins.gplay.sentry) + println("EtchDroid: Sentry and Crashlytics enabled") alias(libs.plugins.gplay.sentry.kotlin) + alias(libs.plugins.google.gms.google.services) + alias(libs.plugins.google.firebase.crashlytics) } else { - println("EtchDroid: Sentry not enabled") + println("EtchDroid: Sentry and Crashlytics not enabled") } } @@ -134,4 +135,8 @@ dependencies { testImplementation(libs.junit.jupiter) testImplementation(libs.mockito.core) testImplementation(libs.test.core) + + if (System.getProperty("etchdroid.isGPlayFlavor") == "true" || System.getenv("ETCHDROID_ENABLE_SENTRY") == "true") { + implementation(libs.firebase.crashlytics) + } } diff --git a/app/src/gplay/AndroidManifest.xml b/app/src/gplay/AndroidManifest.xml index e176992..2abb6a9 100644 --- a/app/src/gplay/AndroidManifest.xml +++ b/app/src/gplay/AndroidManifest.xml @@ -25,5 +25,10 @@ + + + diff --git a/app/src/gplay/java/eu/depau/etchdroid/plugins/telemetry/Telemetry.kt b/app/src/gplay/java/eu/depau/etchdroid/plugins/telemetry/Telemetry.kt index d978a00..bbf768c 100644 --- a/app/src/gplay/java/eu/depau/etchdroid/plugins/telemetry/Telemetry.kt +++ b/app/src/gplay/java/eu/depau/etchdroid/plugins/telemetry/Telemetry.kt @@ -7,6 +7,11 @@ import androidx.compose.foundation.layout.BoxScope import androidx.compose.runtime.Composable import androidx.compose.ui.ExperimentalComposeUiApi import androidx.compose.ui.Modifier +import androidx.core.content.edit +import com.google.firebase.crashlytics.CustomKeysAndValues +import com.google.firebase.crashlytics.FirebaseCrashlytics +import com.google.firebase.crashlytics.ktx.crashlytics +import com.google.firebase.ktx.Firebase import eu.depau.etchdroid.BuildConfig import io.sentry.Breadcrumb import io.sentry.IScope @@ -15,7 +20,6 @@ import io.sentry.SentryLevel import io.sentry.android.core.SentryAndroid import io.sentry.compose.SentryModifier.sentryTag import io.sentry.compose.SentryTraced -import androidx.core.content.edit internal const val SENTRY_DSN = "https://39a6e220c97c585acd25ced5a6855b4d@o4508123221590016.ingest.de.sentry.io/4508123222704209" @@ -62,6 +66,17 @@ internal fun TelemetryBreadcrumb.toSentry(): Breadcrumb { return sentry } +internal fun TelemetryBreadcrumb.toFirebase(): CustomKeysAndValues { + return CustomKeysAndValues.Builder().apply { + message?.let { putString("message", it) } + category?.let { putString("category", it) } + level?.let { putString("level", it.name) } + type?.let { putString("type", it) } + data.forEach { (key, value) -> putString(key, value.toString()) } + origin?.let { putString("origin", it) } + }.build() +} + internal fun sentryScopeAdapter(scope: IScope): ITelemetryScope { return object : ITelemetryScope { override var logLevel: TelemetryLevel? @@ -85,6 +100,7 @@ internal fun sentryScopeAdapter(scope: IScope): ITelemetryScope { override fun setTag(key: String, value: String) { scope.setTag(key, value) + Firebase.crashlytics.setCustomKey(key, value) } override fun removeTag(key: String) { @@ -93,6 +109,7 @@ internal fun sentryScopeAdapter(scope: IScope): ITelemetryScope { override fun setExtra(key: String, value: String) { scope.setExtra(key, value) + Firebase.crashlytics.setCustomKey(key, value) } override fun removeExtra(key: String) { @@ -122,6 +139,8 @@ object Telemetry : ITelemetry { _enabled = enabled Log.i("Telemetry", "Enabled: $enabled") + FirebaseCrashlytics.getInstance().isCrashlyticsCollectionEnabled = enabled + if (!enabled) { Sentry.close() } else { @@ -179,6 +198,7 @@ object Telemetry : ITelemetry { } override fun captureException(throwable: Throwable): String { + Firebase.crashlytics.recordException(throwable) return Sentry.captureException(throwable).toString() } @@ -186,21 +206,26 @@ object Telemetry : ITelemetry { throwable: Throwable, callback: ITelemetryScope.() -> Unit, ): String { - return Sentry.captureException(throwable) { + val result = Sentry.captureException(throwable) { sentryScopeAdapter(it).callback() }.toString() + Firebase.crashlytics.recordException(throwable) + return result } override fun addBreadcrumb(breadcrumb: TelemetryBreadcrumb) { breadcrumb.log() + Firebase.crashlytics.setCustomKeys(breadcrumb.toFirebase()) Sentry.addBreadcrumb(breadcrumb.toSentry()) } override fun addBreadcrumb(message: String) { + Firebase.crashlytics.log(message) addBreadcrumb(TelemetryBreadcrumb.info(message)) } override fun addBreadcrumb(message: String, category: String) { + Firebase.crashlytics.log("$category: $message") addBreadcrumb(TelemetryBreadcrumb.info(message, category)) } @@ -212,6 +237,7 @@ object Telemetry : ITelemetry { override fun captureMessage(message: String): String { TelemetryBreadcrumb.error(message).log() + Firebase.crashlytics.log(message) return Sentry.captureMessage(message).toString() } @@ -220,6 +246,7 @@ object Telemetry : ITelemetry { callback: ITelemetryScope.() -> Unit, ): String { TelemetryBreadcrumb.error(message).log() + Firebase.crashlytics.log(message) return Sentry.captureMessage(message) { sentryScopeAdapter(it).callback() }.toString() @@ -230,6 +257,7 @@ object Telemetry : ITelemetry { level: TelemetryLevel, ): String { TelemetryBreadcrumb(level = level, message = message).log() + Firebase.crashlytics.log(message) return Sentry.captureMessage(message, level.toSentry()).toString() } @@ -239,6 +267,7 @@ object Telemetry : ITelemetry { callback: ITelemetryScope.() -> Unit, ): String { TelemetryBreadcrumb(level = level, message = message).log() + Firebase.crashlytics.log(message) return Sentry.captureMessage(message, level.toSentry()) { sentryScopeAdapter(it).callback() }.toString() diff --git a/build.gradle.kts b/build.gradle.kts index ccface1..4cc0d8f 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -3,4 +3,9 @@ plugins { alias(libs.plugins.android.library) apply false alias(libs.plugins.kotlin.android) apply false alias(libs.plugins.compose.compiler) apply false + + if (System.getProperty("etchdroid.isGPlayFlavor") == "true" || System.getenv("ETCHDROID_ENABLE_SENTRY") == "true") { + alias(libs.plugins.google.gms.google.services) apply false + alias(libs.plugins.google.firebase.crashlytics) apply false + } } diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 1d9c688..28b5d46 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -24,19 +24,23 @@ mockito = "5.8.0" test-core = "1.6.1" test-runner = "1.6.2" -# Note for F-Droid developers: Sentry is not enabled for F-Droid builds +# Note for F-Droid developers: Sentry and Firebase are not enabled for F-Droid builds sentry-lib = "8.4.0" sentry-plugin = "4.12.0" +firebase-crashlytics = "19.4.2" +google-gms-google-services = "4.4.2" +google-firebase-crashlytics = "3.0.3" [plugins] android-application = { id = "com.android.application", version.ref = "android-gradle-plugin" } android-junit5 = { id = "de.mannodermaus.android-junit5", version.ref = "android-junit5" } android-library = { id = "com.android.library", version.ref = "android-gradle-plugin" } compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" } -gplay-sentry = { id = "io.sentry.android.gradle", version.ref = "sentry-plugin" } gplay-sentry-kotlin = { id = "io.sentry.kotlin.compiler.gradle", version.ref = "sentry-plugin" } kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" } kotlin-parcelize = { id = "kotlin-parcelize" } +google-gms-google-services = { id = "com.google.gms.google-services", version.ref = "google-gms-google-services" } +google-firebase-crashlytics = { id = "com.google.firebase.crashlytics", version.ref = "google-firebase-crashlytics" } [libraries] accompanist-navigation-animation = { group = "com.google.accompanist", name = "accompanist-navigation-animation", version.ref = "accompanist" } @@ -73,3 +77,4 @@ material3-adaptive = { group = "androidx.compose.material3.adaptive", name = "ad mockito-core = { group = "org.mockito", name = "mockito-core", version.ref = "mockito" } test-core = { group = "androidx.test", name = "core", version.ref = "test-core" } test-runner = { group = "androidx.test", name = "runner", version.ref = "test-runner" } +firebase-crashlytics = { group = "com.google.firebase", name = "firebase-crashlytics", version.ref = "firebase-crashlytics" }