Only apply Bugsnag to gplay build flavor (#88)

* wip

* Setup bugsnag only in gplay builds.

* Bugsnag does not support uploading mapping files or build information from library modules. This should be done from the application module which produces your APK instead.

* Only apply Bugsnag plugin for the right flavors.

* Run unit tests in debug, otherwise we run issues requiring api keys in the env

app-common/build.gradle.kts

@@ -21,6 +21,10 @@ android {
         buildConfigField("String", "APPLICATION_ID", "\"${ProjectConfig.packageName}\"")
         buildConfigField("String", "GITSHA", "\"${lastCommitHash()}\"")
         buildConfigField("String", "BUILDTIME", "\"${buildTime()}\"")
+
+        manifestPlaceholders["bugsnagApiKey"] = getBugSnagApiKey(
+            File(System.getProperty("user.home"), ".appconfig/${ProjectConfig.packageName}/bugsnag.properties")
+        ) ?: "bugsnag_apikey_placeholder"
     }
 
     buildFeatures {
@@ -95,6 +99,7 @@ dependencies {
 
     addTesting()
 
-    implementation("com.bugsnag:bugsnag-android:5.9.2")
+    "gplayImplementation"("com.bugsnag:bugsnag-android:5.9.2")
+    "gplayImplementation"("com.getkeepsafe.relinker:relinker:1.4.3")
 
 }

app-common/src/foss/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest>
+
+</manifest>

app-common/src/foss/java/eu/darken/capod/debug/autoreport/AutoReportingModule.kt

@@ -0,0 +1,17 @@
+package eu.darken.capod.debug.autoreport
+
+import dagger.Binds
+import dagger.Module
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import eu.darken.capod.common.debug.autoreport.AutomaticBugReporter
+import eu.darken.capod.debug.autoreport.FossAutoReporting
+import javax.inject.Singleton
+
+@InstallIn(SingletonComponent::class)
+@Module
+abstract class AutoReportingModule {
+    @Binds
+    @Singleton
+    abstract fun autoreporting(foss: FossAutoReporting): AutomaticBugReporter
+}

app-common/src/foss/java/eu/darken/capod/debug/autoreport/FossAutoReporting.kt

@@ -0,0 +1,17 @@
+package eu.darken.capod.debug.autoreport
+
+import android.app.Application
+import eu.darken.capod.common.debug.autoreport.AutomaticBugReporter
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+class FossAutoReporting @Inject constructor() : AutomaticBugReporter {
+    override fun setup(application: Application) {
+        // NOOP
+    }
+
+    override fun notify(throwable: Throwable) {
+        throw IllegalStateException("Who initliazed this? Without setup no calls to here!")
+    }
+}

app-common/src/gplay/AndroidManifest.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <application>
+        <meta-data
+            android:name="com.bugsnag.android.API_KEY"
+            android:value="${bugsnagApiKey}" />
+    </application>
+
+</manifest>

app-common/src/gplay/java/eu/darken/capod/debug/autoreport/AutoReportingModule.kt

@@ -0,0 +1,16 @@
+package eu.darken.capod.debug.autoreport
+
+import dagger.Binds
+import dagger.Module
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import eu.darken.capod.common.debug.autoreport.AutomaticBugReporter
+import javax.inject.Singleton
+
+@InstallIn(SingletonComponent::class)
+@Module
+abstract class AutoReportingModule {
+    @Binds
+    @Singleton
+    abstract fun autoreporting(foss: GplayAutoReporting): AutomaticBugReporter
+}

app-common/src/gplay/java/eu/darken/capod/debug/autoreport/BugsnagErrorHandler.kt

@@ -1,4 +1,4 @@
-package eu.darken.capod.common.debug.autoreport.bugsnag
+package eu.darken.capod.debug.autoreport
 
 import android.annotation.SuppressLint
 import android.content.Context
@@ -7,7 +7,7 @@ import com.bugsnag.android.Event
 import com.bugsnag.android.OnErrorCallback
 import dagger.hilt.android.qualifiers.ApplicationContext
 import eu.darken.capod.common.BuildConfigWrap
-import eu.darken.capod.common.debug.autoreport.DebugSettings
+import eu.darken.capod.common.debug.DebugSettings
 import eu.darken.capod.common.debug.logging.Logging.Priority.WARN
 import eu.darken.capod.common.debug.logging.asLog
 import eu.darken.capod.common.debug.logging.log

app-common/src/gplay/java/eu/darken/capod/debug/autoreport/BugsnagLogger.kt

@@ -1,4 +1,4 @@
-package eu.darken.capod.common.debug.autoreport.bugsnag
+package eu.darken.capod.debug.autoreport
 
 import com.bugsnag.android.Event
 import eu.darken.capod.common.debug.logging.Logging

app-common/src/gplay/java/eu/darken/capod/debug/autoreport/GplayAutoReporting.kt

@@ -1,15 +1,16 @@
-package eu.darken.capod.common.debug.autoreport
+package eu.darken.capod.debug.autoreport
 
+import android.app.Application
 import android.content.Context
 import com.bugsnag.android.Bugsnag
 import com.bugsnag.android.Configuration
+import com.getkeepsafe.relinker.ReLinker
 import dagger.hilt.android.qualifiers.ApplicationContext
 import eu.darken.capod.common.BuildConfigWrap
 import eu.darken.capod.common.InstallId
 import eu.darken.capod.common.debug.Bugs
-import eu.darken.capod.common.debug.autoreport.bugsnag.BugsnagErrorHandler
-import eu.darken.capod.common.debug.autoreport.bugsnag.BugsnagLogger
-import eu.darken.capod.common.debug.autoreport.bugsnag.NOPBugsnagErrorHandler
+import eu.darken.capod.common.debug.DebugSettings
+import eu.darken.capod.common.debug.autoreport.AutomaticBugReporter
 import eu.darken.capod.common.debug.logging.Logging
 import eu.darken.capod.common.debug.logging.log
 import eu.darken.capod.common.debug.logging.logTag
@@ -18,19 +19,25 @@ import javax.inject.Provider
 import javax.inject.Singleton
 
 @Singleton
-class AutoReporting @Inject constructor(
+class GplayAutoReporting @Inject constructor(
     @ApplicationContext private val context: Context,
     private val debugSettings: DebugSettings,
     private val installId: InstallId,
     private val bugsnagLogger: Provider<BugsnagLogger>,
     private val bugsnagErrorHandler: Provider<BugsnagErrorHandler>,
     private val nopBugsnagErrorHandler: Provider<NOPBugsnagErrorHandler>,
-) {
+) : AutomaticBugReporter {
 
-    fun setup() {
+    override fun setup(application: Application) {
         val isEnabled = debugSettings.isAutoReportingEnabled.value
         log(TAG) { "setup(): isEnabled=$isEnabled" }
 
+        if (!isEnabled) return
+
+        ReLinker
+            .log { message -> log(TAG) { "ReLinker: $message" } }
+            .loadLibrary(application, "bugsnag-plugin-android-anr")
+
         try {
             val bugsnagConfig = Configuration.load(context).apply {
                 if (debugSettings.isAutoReportingEnabled.value) {
@@ -48,13 +55,18 @@ class AutoReporting @Inject constructor(
             }
 
             Bugsnag.start(context, bugsnagConfig)
-            Bugs.ready = true
+            Bugs.reporter = this
         } catch (e: IllegalStateException) {
             log(TAG) { "Bugsnag API Key not configured." }
         }
     }
 
+    override fun notify(throwable: Throwable) {
+        Bugsnag.notify(throwable)
+    }
+
     companion object {
         private val TAG = logTag("Debug", "AutoReport")
     }
+
 }

app-common/src/gplay/java/eu/darken/capod/debug/autoreport/NOPBugsnagErrorHandler.kt

@@ -1,4 +1,4 @@
-package eu.darken.capod.common.debug.autoreport.bugsnag
+package eu.darken.capod.debug.autoreport
 
 import com.bugsnag.android.Event
 import com.bugsnag.android.OnErrorCallback

app-common/src/main/java/eu/darken/capod/common/bluetooth/FakeBleData.kt

@@ -2,7 +2,7 @@ package eu.darken.capod.common.bluetooth
 
 import dagger.Reusable
 import eu.darken.capod.common.SystemClockWrap
-import eu.darken.capod.common.debug.autoreport.DebugSettings
+import eu.darken.capod.common.debug.DebugSettings
 import java.time.Instant
 import javax.inject.Inject
 import kotlin.random.Random

app-common/src/main/java/eu/darken/capod/common/debug/Bugs.kt

@@ -1,13 +1,13 @@
 package eu.darken.capod.common.debug
 
-import com.bugsnag.android.Bugsnag
+import eu.darken.capod.common.debug.autoreport.AutomaticBugReporter
 import eu.darken.capod.common.debug.logging.Logging.Priority.*
 import eu.darken.capod.common.debug.logging.asLog
 import eu.darken.capod.common.debug.logging.log
 import eu.darken.capod.common.debug.logging.logTag
 
 object Bugs {
-    var ready = false
+    var reporter: AutomaticBugReporter? = null
     fun report(
         tag: String,
         message: String,
@@ -16,11 +16,9 @@ object Bugs {
         log(TAG, VERBOSE) { "Reporting $exception" }
         log(tag, ERROR) { "$message\n${exception.asLog()}" }
 
-        if (!ready) {
+        reporter?.notify(exception) ?: run {
             log(TAG, WARN) { "Bug tracking not initialized yet." }
-            return
         }
-        Bugsnag.notify(exception)
     }
 
     private val TAG = logTag("Bugs")

app-common/src/main/java/eu/darken/capod/common/debug/DebugSettings.kt

@@ -1,4 +1,4 @@
-package eu.darken.capod.common.debug.autoreport
+package eu.darken.capod.common.debug
 
 import android.content.Context
 import android.content.SharedPreferences

app-common/src/main/java/eu/darken/capod/common/debug/autoreport/AutomaticBugReporter.kt

@@ -0,0 +1,10 @@
+package eu.darken.capod.common.debug.autoreport
+
+import android.app.Application
+
+interface AutomaticBugReporter {
+
+    fun setup(application: Application)
+
+    fun notify(throwable: Throwable)
+}

app-common/src/main/java/eu/darken/capod/main/core/GeneralSettings.kt

@@ -6,7 +6,7 @@ import androidx.preference.PreferenceDataStore
 import com.squareup.moshi.Moshi
 import dagger.hilt.android.qualifiers.ApplicationContext
 import eu.darken.capod.common.bluetooth.ScannerMode
-import eu.darken.capod.common.debug.autoreport.DebugSettings
+import eu.darken.capod.common.debug.DebugSettings
 import eu.darken.capod.common.preferences.PreferenceStoreMapper
 import eu.darken.capod.common.preferences.Settings
 import eu.darken.capod.common.preferences.createFlowPreference

app-common/src/main/java/eu/darken/capod/monitor/core/PodMonitor.kt

@@ -6,7 +6,7 @@ import eu.darken.capod.common.bluetooth.BleScanner
 import eu.darken.capod.common.bluetooth.BluetoothManager2
 import eu.darken.capod.common.bluetooth.ScannerMode
 import eu.darken.capod.common.coroutine.AppScope
-import eu.darken.capod.common.debug.autoreport.DebugSettings
+import eu.darken.capod.common.debug.DebugSettings
 import eu.darken.capod.common.debug.logging.Logging.Priority.VERBOSE
 import eu.darken.capod.common.debug.logging.Logging.Priority.WARN
 import eu.darken.capod.common.debug.logging.asLog