ACRA: switch from email to HTTP sending for automotive flavor

ev-map · Sep 2, 2023 · 92619ea · 92619ea
1 parent a700728
commit 92619ea
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 5 deletions.
diff --git a/.github/workflows/apikeys-ci.xml b/.github/workflows/apikeys-ci.xml
@@ -5,4 +5,5 @@
    <string name="chargeprice_key" translatable="false">ci</string>
    <string name="openchargemap_key" translatable="false">ci</string>
    <string name="fronyx_key" translatable="false">ci</string>
+   <string name="acra_credentials" translatable="false">ci:ci</string>
 </resources>
diff --git a/app/build.gradle b/app/build.gradle
@@ -147,6 +147,13 @@ android {
         if (fronyxKey != null) {
             variant.resValue "string", "fronyx_key", fronyxKey
         }
+        def acraKey = env.ACRA_CRASHREPORT_CREDENTIALS ?: project.findProperty("ACRA_CRASHREPORT_CREDENTIALS")
+        if (acraKey == null && project.hasProperty("ACRA_CRASHREPORT_CREDENTIALS_ENCRYPTED")) {
+            acraKey = decode(project.findProperty("ACRA_CRASHREPORT_CREDENTIALS_ENCRYPTED"), "FmK.d,-f*p+rD+WK!eds")
+        }
+        if (acraKey != null) {
+            variant.resValue "string", "acra_credentials", acraKey
+        }
     }
 
     packagingOptions {
@@ -249,6 +256,7 @@ dependencies {
     // ACRA (crash reporting)
     def acraVersion = "5.11.1"
     implementation("ch.acra:acra-mail:$acraVersion")
+    implementation("ch.acra:acra-http:$acraVersion")
     implementation("ch.acra:acra-dialog:$acraVersion")
     implementation("ch.acra:acra-limiter:$acraVersion")
 

diff --git a/app/src/main/java/net/vonforst/evmap/EvMapApplication.kt b/app/src/main/java/net/vonforst/evmap/EvMapApplication.kt
@@ -1,5 +1,6 @@
 package net.vonforst.evmap
 
+import android.app.Activity
 import android.app.Application
 import android.os.Build
 import androidx.work.*
@@ -8,10 +9,12 @@ import net.vonforst.evmap.storage.PreferenceDataSource
 import net.vonforst.evmap.ui.updateAppLocale
 import net.vonforst.evmap.ui.updateNightMode
 import org.acra.config.dialog
+import org.acra.config.httpSender
 import org.acra.config.limiter
 import org.acra.config.mailSender
 import org.acra.data.StringFormat
 import org.acra.ktx.initAcra
+import org.acra.sender.HttpSender
 import java.time.Duration
 
 class EvMapApplication : Application(), Configuration.Provider {
@@ -33,10 +36,22 @@ class EvMapApplication : Application(), Configuration.Provider {
         if (!BuildConfig.DEBUG) {
             initAcra {
                 buildConfigClass = BuildConfig::class.java
-                reportFormat = StringFormat.KEY_VALUE_LIST
 
-                mailSender {
-                    mailTo = "evmap+crashreport@vonforst.net"
+                reportFormat = StringFormat.JSON
+
+                if (BuildConfig.FLAVOR_automotive == "automotive") {
+                    // Vehicles often don't have an email app, so use HTTP to send instead
+                    httpSender {
+                        uri = getString(R.string.acra_backend_url)
+                        val creds = getString(R.string.acra_credentials).split(":")
+                        basicAuthLogin = creds[0]
+                        basicAuthPassword = creds[1]
+                        httpMethod = HttpSender.Method.POST
+                    }
+                } else {
+                    mailSender {
+                        mailTo = "evmap+crashreport@vonforst.net"
+                    }
                 }
 
                 dialog {
@@ -46,7 +61,8 @@ class EvMapApplication : Application(), Configuration.Provider {
                     resIcon = R.drawable.ic_launcher_foreground
                     resTheme = R.style.AppTheme
                     if (BuildConfig.FLAVOR_automotive == "automotive") {
-                        reportDialogClass = androidx.car.app.activity.CarAppActivity::class.java
+                        reportDialogClass =
+                            Class.forName("androidx.car.app.activity.CarAppActivity") as Class<out Activity>?
                     }
                 }
 

diff --git a/app/src/main/res/values/donottranslate.xml b/app/src/main/res/values/donottranslate.xml
@@ -35,4 +35,5 @@
     <string name="donate_link" translatable="false">https://ev-map.app/donate/</string>
     <string name="tesla_referral_link" translatable="false">http://ts.la/johan94494</string>
     <string name="copyright_summary">©2020–2023 Johan von Forstner and contributors</string>
+    <string name="acra_backend_url" translatable="false">https://acra.muc.vonforst.net/report</string>
 </resources>
diff --git a/doc/api_keys.md b/doc/api_keys.md
@@ -29,6 +29,9 @@ be put into the app in the form of a resource file called `apikeys.xml` under
    <string name="fronyx_key" translatable="false">
       insert your Fronyx key here
    </string>
+   <string name="acra_credentials" translatable="false">
+      insert your ACRA crash reporting credentials here
+   </string>
 </resources>
 ```
 
@@ -186,4 +189,12 @@ The API is not publically available, contact [fronyx](https://fronyx.io/contact-
 key and documentation.
 
 If you don't want to test this functionality, simply leave the API key blank.
-</details>
+</details>
+
+Crash reporting
+---------------
+
+Crash reporting for release builds is done using [ACRA](https://github.com/ACRA/acra).
+This should not be needed for debugging.
+If you still want to try it out, you can host any compatible backend such as
+[Acrarium](https://github.com/F43nd1r/Acrarium/) yourself.