Migrate from fabric to firebase crashlytics (#789)

2020-05-01 19:00:42 +02:00 · 2020-05-01 19:00:42 +02:00 · 98f2f0e74f
commit 98f2f0e74f
parent 4a3b746d48
8 changed files with 66 additions and 51 deletions
--- a/.travis.yml
+++ b/.travis.yml
@ -48,20 +48,15 @@ before_script:
 script:
  - ./gradlew dependencies --stacktrace --daemon
  - fossa --no-ansi || true
-  #- ./gradlew lintPlayRelease -x fabricGenerateResourcesPlayRelease --stacktrace --daemon
-  - ./gradlew -Pcoverage testPlayDebugUnitTest -x fabricGenerateResourcesPlay --stacktrace --daemon
+  - ./gradlew -Pcoverage testPlayDebugUnitTest --stacktrace --daemon
  - ./gradlew -Pcoverage createFdroidDebugCoverageReport --stacktrace --daemon
  - ./gradlew -Pcoverage jacocoTestReport --stacktrace --daemon
-  - if [ -z ${SONAR_HOST+x} ]; then echo "sonar scan skipped"; else
-      git fetch --unshallow;
-      ./gradlew sonarqube -x test -x lint -x fabricGenerateResourcesPlayRelease -x fabricGenerateResourcesFdroidRelease -Dsonar.host.url=$SONAR_HOST -Dsonar.organization=$SONAR_ORG -Dsonar.login=$SONAR_KEY -Dsonar.branch.name=${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH} --stacktrace --daemon;
-    fi
  - |
    if [ $TRAVIS_TAG ]; then
      gpg --yes --batch --passphrase=$SERVICES_ENCRYPT_KEY ./app/src/release/google-services.json.gpg;
      gpg --yes --batch --passphrase=$ENCRYPT_KEY ./app/key.p12.gpg;
      gpg --yes --batch --passphrase=$ENCRYPT_KEY ./app/upload-key.jks.gpg;
-      ./gradlew publishPlayRelease -PenableCrashlytics --stacktrace;
+      ./gradlew publishPlayRelease -PenableFirebase --stacktrace;
    fi

 after_success:
--- a/app/build.gradle
+++ b/app/build.gradle
@ -2,7 +2,7 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-kapt'
 apply plugin: 'kotlin-android-extensions'
-apply plugin: 'io.fabric'
+apply plugin: 'com.google.firebase.crashlytics'
 apply plugin: 'com.github.triplet.play'
 apply plugin: 'com.mikepenz.aboutlibraries.plugin'
 apply from: 'jacoco.gradle'
@ -24,8 +24,7 @@ android {
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        vectorDrawables.useSupportLibrary = true
        manifestPlaceholders = [
-                fabric_api_key     : System.getenv("FABRIC_API_KEY") ?: "null",
-                crashlytics_enabled: project.hasProperty("enableCrashlytics")
+                firebase_enabled: project.hasProperty("enableFirebase")
        ]
        javaCompileOptions {
            annotationProcessorOptions {
@ -52,18 +51,16 @@ android {

    buildTypes {
        release {
-            buildConfigField "boolean", "CRASHLYTICS_ENABLED", "true"
            minifyEnabled true
            shrinkResources true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
        debug {
-            buildConfigField "boolean", "CRASHLYTICS_ENABLED", project.hasProperty("enableCrashlytics") ? "true" : "false"
            applicationIdSuffix ".dev"
            versionNameSuffix "-dev"
            testCoverageEnabled = project.hasProperty('coverage')
-            ext.enableCrashlytics = project.hasProperty("enableCrashlytics")
+            ext.enableCrashlytics = project.hasProperty("enableFirebase")
        }
    }

@ -75,7 +72,6 @@ android {
        }

        fdroid {
-            buildConfigField "boolean", "CRASHLYTICS_ENABLED", "false"
            dimension "platform"
        }
    }
@ -190,8 +186,8 @@ dependencies {
    playImplementation 'com.google.firebase:firebase-analytics:17.4.0'
    playImplementation 'com.google.firebase:firebase-inappmessaging-display-ktx:19.0.6'
    playImplementation "com.google.firebase:firebase-inappmessaging-ktx:19.0.6"
-    playImplementation "com.google.firebase:firebase-messaging:20.1.0"
-    playImplementation "com.crashlytics.sdk.android:crashlytics:2.10.1"
+    playImplementation 'com.google.firebase:firebase-messaging:20.1.6'
+    playImplementation 'com.google.firebase:firebase-crashlytics:17.0.0'
    playImplementation 'com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava'

    releaseImplementation "com.github.ChuckerTeam.Chucker:library-no-op:$chucker"
--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@ -107,12 +107,33 @@
                android:resource="@xml/provider_paths" />
        </provider>

+        <!-- workaround for https://github.com/firebase/firebase-android-sdk/issues/473 enabled:false -->
+        <!-- https://firebase.googleblog.com/2017/03/take-control-of-your-firebase-init-on.html -->
+        <provider
+            android:name="com.google.firebase.provider.FirebaseInitProvider"
+            android:authorities="${applicationId}.firebaseinitprovider"
+            android:enabled="${firebase_enabled}"
+            android:exported="false" />
+
        <meta-data
-            android:name="io.fabric.ApiKey"
-            android:value="${fabric_api_key}" />
+            android:name="firebase_analytics_collection_enabled"
+            android:value="${firebase_enabled}" />
+
+        <meta-data
+            android:name="google_analytics_adid_collection_enabled"
+            android:value="${firebase_enabled}" />
+
        <meta-data
            android:name="firebase_crashlytics_collection_enabled"
-            android:value="${crashlytics_enabled}" />
+            android:value="${firebase_enabled}" />
+
+        <meta-data
+            android:name="firebase_messaging_auto_init_enabled"
+            android:value="${firebase_enabled}" />
+
+        <meta-data
+            android:name="firebase_inapp_messaging_auto_data_collection_enabled"
+            android:value="${firebase_enabled}" />

        <meta-data
            android:name="com.google.firebase.messaging.default_notification_icon"
--- a/app/src/main/java/io/github/wulkanowy/WulkanowyApp.kt
+++ b/app/src/main/java/io/github/wulkanowy/WulkanowyApp.kt
@ -19,7 +19,6 @@ import io.github.wulkanowy.utils.AppInfo
 import io.github.wulkanowy.utils.CrashlyticsExceptionTree
 import io.github.wulkanowy.utils.CrashlyticsTree
 import io.github.wulkanowy.utils.DebugLogTree
-import io.github.wulkanowy.utils.initCrashlytics
 import io.reactivex.exceptions.UndeliverableException
 import io.reactivex.plugins.RxJavaPlugins
 import timber.log.Timber
@ -50,7 +49,6 @@ class WulkanowyApp : DaggerApplication(), Configuration.Provider {
        themeManager.applyDefaultTheme()

        initLogging()
-        initCrashlytics(this, appInfo)
    }

    private fun initLogging() {
--- a/app/src/main/java/io/github/wulkanowy/utils/AppInfo.kt
+++ b/app/src/main/java/io/github/wulkanowy/utils/AppInfo.kt
@ -4,7 +4,6 @@ import android.content.res.Resources
 import android.os.Build.MANUFACTURER
 import android.os.Build.MODEL
 import android.os.Build.VERSION.SDK_INT
-import io.github.wulkanowy.BuildConfig.CRASHLYTICS_ENABLED
 import io.github.wulkanowy.BuildConfig.DEBUG
 import io.github.wulkanowy.BuildConfig.VERSION_CODE
 import io.github.wulkanowy.BuildConfig.VERSION_NAME
@ -13,8 +12,6 @@ import javax.inject.Singleton
@Singleton
 open class AppInfo {

-    open val isCrashlyticsEnabled get() = CRASHLYTICS_ENABLED
-
    open val isDebug get() = DEBUG

    open val versionCode get() = VERSION_CODE
--- a/app/src/play/java/io/github/wulkanowy/utils/CrashlyticsUtils.kt
+++ b/app/src/play/java/io/github/wulkanowy/utils/CrashlyticsUtils.kt
@ -1,36 +1,46 @@
 package io.github.wulkanowy.utils

-import android.content.Context
 import android.util.Log
-import com.crashlytics.android.Crashlytics
-import com.crashlytics.android.core.CrashlyticsCore
-import fr.bipi.tressence.crash.CrashlyticsLogExceptionTree
-import fr.bipi.tressence.crash.CrashlyticsLogTree
-import io.fabric.sdk.android.Fabric
+import com.google.firebase.crashlytics.FirebaseCrashlytics
+import fr.bipi.tressence.base.FormatterPriorityTree
+import fr.bipi.tressence.common.StackTraceRecorder
 import io.github.wulkanowy.sdk.exception.FeatureDisabledException
 import io.github.wulkanowy.sdk.exception.FeatureNotAvailableException
 import java.net.UnknownHostException

-fun initCrashlytics(context: Context, appInfo: AppInfo) {
-    Fabric.with(Fabric.Builder(context)
-        .kits(
-            Crashlytics.Builder()
-                .core(CrashlyticsCore.Builder()
-                    .disabled(!appInfo.isCrashlyticsEnabled)
-                    .build())
-                .build()
-        )
-        .debuggable(appInfo.isDebug)
-        .build())
-}
+class CrashlyticsTree : FormatterPriorityTree(Log.VERBOSE) {

-class CrashlyticsTree : CrashlyticsLogTree(Log.VERBOSE) {
+    private val crashlytics by lazy { FirebaseCrashlytics.getInstance() }
+
+    override fun skipLog(priority: Int, tag: String?, message: String, t: Throwable?): Boolean {
+        if (t is FeatureDisabledException || t is FeatureNotAvailableException || t is UnknownHostException) {
+            return true
+        }
+
+        return super.skipLog(priority, tag, message, t)
+    }

    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
-        if (t is FeatureDisabledException || t is FeatureNotAvailableException || t is UnknownHostException) return
+        if (skipLog(priority, tag, message, t)) return

-        super.log(priority, tag, message, t)
+        crashlytics.log(format(priority, tag, message))
    }
 }

-class CrashlyticsExceptionTree : CrashlyticsLogExceptionTree()
+class CrashlyticsExceptionTree : FormatterPriorityTree(Log.ERROR) {
+
+    private val crashlytics by lazy { FirebaseCrashlytics.getInstance() }
+
+    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
+        if (skipLog(priority, tag, message, t)) return
+
+        crashlytics.setCustomKey("priority", priority)
+        crashlytics.setCustomKey("tag", tag.orEmpty())
+        crashlytics.setCustomKey("message", message)
+        if (t != null) {
+            crashlytics.recordException(t)
+        } else {
+            crashlytics.recordException(StackTraceRecorder(format(priority, tag, message)))
+        }
+    }
+}
--- a/build.gradle
+++ b/build.gradle
@ -6,15 +6,13 @@ buildscript {
        google()
        jcenter()
        maven { url "https://plugins.gradle.org/m2/" }
-        maven { url 'https://maven.fabric.io/public' }
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.android.tools.build:gradle:3.6.3'
        classpath 'com.google.gms:google-services:4.3.3'
-        //noinspection GradleDependency https://github.com/firebase/firebase-android-sdk/issues/1276#issuecomment-592098283
-        classpath "io.fabric.tools:gradle:1.31.0"
-        classpath "com.github.triplet.gradle:play-publisher:2.7.3"
+        classpath 'com.google.firebase:firebase-crashlytics-gradle:2.0.0'
+        classpath "com.github.triplet.gradle:play-publisher:2.7.5"
        classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.8"
        classpath "gradle.plugin.com.star-zero.gradle:githook:1.2.0"
        classpath "com.mikepenz.aboutlibraries.plugin:aboutlibraries-plugin:${about_libraries}"
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists