refactor(common): extract CrashReportService interface to :common

Create CrashReporter interface and CrashReportService delegate object
in :common (package com.ichi2.anki) so all modules can report crashes
without depending on the app module. Move runCatchingWithReport to
:common.

Rename the ACRA-backed implementation to AcraCrashReporter (internal)
in :AnkiDroid. Wire up via CrashReportService.setReporter() in
AnkiDroidApp.onCreate().

Existing call sites keep using CrashReportService.sendExceptionReport
with the same package — no import changes needed for ~40 files.
Only 7 files using ACRA-specific methods updated to AcraCrashReporter.

Author: criticalAY

AnkiDroid/src/androidTest/java/com/ichi2/anki/tests/ACRATest.kt

@@ -21,10 +21,10 @@ import androidx.annotation.StringRes
 import androidx.core.content.edit
 import androidx.test.annotation.UiThreadTest
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.ichi2.anki.AcraCrashReporter
+import com.ichi2.anki.AcraCrashReporter.FEEDBACK_REPORT_ALWAYS
+import com.ichi2.anki.AcraCrashReporter.FEEDBACK_REPORT_ASK
 import com.ichi2.anki.AnkiDroidApp
-import com.ichi2.anki.CrashReportService
-import com.ichi2.anki.CrashReportService.FEEDBACK_REPORT_ALWAYS
-import com.ichi2.anki.CrashReportService.FEEDBACK_REPORT_ASK
 import com.ichi2.anki.R
 import com.ichi2.anki.analytics.UsageAnalytics
 import com.ichi2.anki.logging.ProductionCrashReportingTree
@@ -70,10 +70,10 @@ class ACRATest : InstrumentedTest() {
     @Throws(Exception::class)
     fun testDebugConfiguration() {
         // Debug mode overrides all saved state so no setup needed
-        CrashReportService.setDebugACRAConfig(sharedPrefs)
+        AcraCrashReporter.setDebugACRAConfig(sharedPrefs)
         assertArrayEquals(
             "Debug logcat arguments not set correctly",
-            CrashReportService.acraCoreConfigBuilder
+            AcraCrashReporter.acraCoreConfigBuilder
                 .build()
                 .logcatArguments
                 .toTypedArray(),
@@ -90,21 +90,21 @@ class ACRATest : InstrumentedTest() {
         )
         assertEquals(
             "ACRA feedback was not turned off correctly",
-            CrashReportService.FEEDBACK_REPORT_NEVER,
+            AcraCrashReporter.FEEDBACK_REPORT_NEVER,
             sharedPrefs
-                .getString(CrashReportService.FEEDBACK_REPORT_KEY, "undefined"),
+                .getString(AcraCrashReporter.FEEDBACK_REPORT_KEY, "undefined"),
         )
     }
 
     @Test
     @Throws(Exception::class)
     fun testProductionConfigurationUserDisabled() {
         // set up as if the user had prefs saved to disable completely
-        setReportConfig(CrashReportService.FEEDBACK_REPORT_NEVER)
+        setReportConfig(AcraCrashReporter.FEEDBACK_REPORT_NEVER)
 
         // ACRA initializes production logcat via annotation and we can't mock Build.DEBUG
         // That means we are restricted from verifying production logcat args and this is the debug case again
-        CrashReportService.setProductionACRAConfig(sharedPrefs)
+        AcraCrashReporter.setProductionACRAConfig(sharedPrefs)
         verifyDebugACRAPreferences()
     }
 
@@ -115,7 +115,7 @@ class ACRATest : InstrumentedTest() {
         setReportConfig(FEEDBACK_REPORT_ASK)
 
         // If the user is set to ask, then it's production, with interaction mode dialog
-        CrashReportService.setProductionACRAConfig(sharedPrefs)
+        AcraCrashReporter.setProductionACRAConfig(sharedPrefs)
         verifyACRANotDisabled()
 
         assertToastMessage(R.string.feedback_for_manual_toast_text)
@@ -134,7 +134,7 @@ class ACRATest : InstrumentedTest() {
 
         // If the user is set to always, then it's production, with interaction mode toast
         // will be useful with ACRA 5.2.0
-        CrashReportService.setProductionACRAConfig(sharedPrefs)
+        AcraCrashReporter.setProductionACRAConfig(sharedPrefs)
 
         // The same class/method combo is only sent once, so we face a new method each time (should test that system later)
         val crash = Exception("testCrashReportSend at " + System.currentTimeMillis())
@@ -153,12 +153,12 @@ class ACRATest : InstrumentedTest() {
         val crashData =
             CrashReportDataFactory(
                 testContext,
-                CrashReportService.acraCoreConfigBuilder.build(),
+                AcraCrashReporter.acraCoreConfigBuilder.build(),
             ).createCrashData(ReportBuilder().exception(crash))
         assertTrue(
             LimitingReportAdministrator().shouldSendReport(
                 testContext,
-                CrashReportService.acraCoreConfigBuilder.build(),
+                AcraCrashReporter.acraCoreConfigBuilder.build(),
                 crashData,
             ),
         )
@@ -167,19 +167,19 @@ class ACRATest : InstrumentedTest() {
         assertFalse(
             LimitingReportAdministrator().shouldSendReport(
                 testContext,
-                CrashReportService.acraCoreConfigBuilder.build(),
+                AcraCrashReporter.acraCoreConfigBuilder.build(),
                 crashData,
             ),
         )
 
         // Now let's clear data
-        CrashReportService.deleteACRALimiterData(testContext)
+        AcraCrashReporter.deleteACRALimiterData(testContext)
 
         // A third send should work again
         assertTrue(
             LimitingReportAdministrator().shouldSendReport(
                 testContext,
-                CrashReportService.acraCoreConfigBuilder.build(),
+                AcraCrashReporter.acraCoreConfigBuilder.build(),
                 crashData,
             ),
         )
@@ -192,7 +192,7 @@ class ACRATest : InstrumentedTest() {
         setReportConfig(FEEDBACK_REPORT_ALWAYS)
 
         // If the user is set to always, then it's production, with interaction mode toast
-        CrashReportService.setProductionACRAConfig(sharedPrefs)
+        AcraCrashReporter.setProductionACRAConfig(sharedPrefs)
         verifyACRANotDisabled()
 
         assertToastMessage(R.string.feedback_auto_toast_text)
@@ -207,7 +207,7 @@ class ACRATest : InstrumentedTest() {
         setReportConfig(FEEDBACK_REPORT_ALWAYS)
 
         // If the user is set to ask, then it's production, with interaction mode dialog
-        CrashReportService.setProductionACRAConfig(sharedPrefs)
+        AcraCrashReporter.setProductionACRAConfig(sharedPrefs)
         verifyACRANotDisabled()
 
         assertDialogEnabledStatus("dialog should be disabled when status is ALWAYS", false)
@@ -226,7 +226,7 @@ class ACRATest : InstrumentedTest() {
         setReportConfig(FEEDBACK_REPORT_ASK)
 
         // If the user is set to ask, then it's production, with interaction mode dialog
-        CrashReportService.setProductionACRAConfig(sharedPrefs)
+        AcraCrashReporter.setProductionACRAConfig(sharedPrefs)
         verifyACRANotDisabled()
 
         assertToastMessage(R.string.feedback_for_manual_toast_text)
@@ -262,7 +262,7 @@ class ACRATest : InstrumentedTest() {
         ThrowableFilterService.installDefaultExceptionHandler()
 
         // reinitialize things and make sure they came through correctly again
-        CrashReportService.onPreferenceChanged(app!!.applicationContext, FEEDBACK_REPORT_ASK)
+        AcraCrashReporter.onPreferenceChanged(app!!.applicationContext, FEEDBACK_REPORT_ASK)
         firstExceptionHandler = Thread.getDefaultUncaughtExceptionHandler()
         assertThat("First handler is ThrowableFilterService", firstExceptionHandler is ThrowableFilterService.FilteringExceptionHandler)
         ThrowableFilterService.unInstallDefaultExceptionHandler()
@@ -282,15 +282,15 @@ class ACRATest : InstrumentedTest() {
     }
 
     private fun setAcraReportingMode(feedbackReportAlways: String) {
-        CrashReportService.setAcraReportingMode(feedbackReportAlways)
+        AcraCrashReporter.setAcraReportingMode(feedbackReportAlways)
     }
 
     @Throws(ACRAConfigurationException::class)
     private fun assertDialogEnabledStatus(
         message: String,
         isEnabled: Boolean,
     ) {
-        val config = CrashReportService.acraCoreConfigBuilder.build()
+        val config = AcraCrashReporter.acraCoreConfigBuilder.build()
         for (configuration in config.pluginConfigurations) {
             // Make sure the dialog is set to pop up
             if (configuration.javaClass.toString().contains("Dialog")) {
@@ -301,7 +301,7 @@ class ACRATest : InstrumentedTest() {
 
     @Throws(ACRAConfigurationException::class)
     private fun assertToastIsEnabled() {
-        val config = CrashReportService.acraCoreConfigBuilder.build()
+        val config = AcraCrashReporter.acraCoreConfigBuilder.build()
         for (configuration in config.pluginConfigurations) {
             if (configuration.javaClass.toString().contains("Toast")) {
                 assertThat("Toast should be enabled", configuration.enabled(), equalTo(true))
@@ -313,7 +313,7 @@ class ACRATest : InstrumentedTest() {
     private fun assertToastMessage(
         @StringRes res: Int,
     ) {
-        val config = CrashReportService.acraCoreConfigBuilder.build()
+        val config = AcraCrashReporter.acraCoreConfigBuilder.build()
         for (configuration in config.pluginConfigurations) {
             if (configuration.javaClass.toString().contains("Toast")) {
                 assertEquals(
@@ -333,7 +333,7 @@ class ACRATest : InstrumentedTest() {
     }
 
     private fun setReportConfig(feedbackReportAsk: String) {
-        sharedPrefs.edit { putString(CrashReportService.FEEDBACK_REPORT_KEY, feedbackReportAsk) }
+        sharedPrefs.edit { putString(AcraCrashReporter.FEEDBACK_REPORT_KEY, feedbackReportAsk) }
     }
 
     private val sharedPrefs: SharedPreferences

…ava/com/ichi2/anki/CrashReportService.kt …java/com/ichi2/anki/AcraCrashReporter.ktAnkiDroid/src/main/java/com/ichi2/anki/CrashReportService.kt renamed to AnkiDroid/src/main/java/com/ichi2/anki/AcraCrashReporter.kt AnkiDroid/src/main/java/com/ichi2/anki/CrashReportService.kt renamed to AnkiDroid/src/main/java/com/ichi2/anki/AcraCrashReporter.kt

@@ -43,7 +43,7 @@ import org.acra.config.ToastConfigurationBuilder
 import org.acra.sender.HttpSender
 import timber.log.Timber
 
-object CrashReportService {
+internal object AcraCrashReporter : CrashReporter {
     // ACRA constants used for stored preferences
     const val FEEDBACK_REPORT_KEY = "reportErrorMode"
     const val FEEDBACK_REPORT_ASK = "2"
@@ -166,15 +166,15 @@ object CrashReportService {
      */
     @JvmStatic
     fun initialize(application: Application) {
-        CrashReportService.application = application
+        this.application = application
         // FIXME ACRA needs to reinitialize after language is changed, but with the new language
         //   this is difficult because the Application (AnkiDroidApp) does not change it's baseContext
         //   perhaps a solution could be to change AnkiDroidApp to have a context wrapper that it sets
         //   as baseContext, and that wrapper allows a resources/configuration update, then
         //   in GeneralSettingsFragment for the language dialog change listener, the context wrapper
         //   could be updated directly with the new locale code so that calling getString on would fetch
         //   the new language string ?
-        toastText = ToastType.AUTO_TOAST.getToastMessage(CrashReportService.application)
+        toastText = ToastType.AUTO_TOAST.getToastMessage(application)
 
         // Setup logging and crash reporting
         if (BuildConfig.DEBUG) {
@@ -262,17 +262,32 @@ object CrashReportService {
     }
 
     /** Used when we don't have an exception to throw, but we know something is wrong and want to diagnose it  */
-    fun sendExceptionReport(
+    override fun sendExceptionReport(
         message: String?,
         origin: String?,
     ) = sendExceptionReport(ManuallyReportedException(message), origin)
 
+    override fun sendExceptionReport(
+        e: Throwable,
+        origin: String?,
+        additionalInfo: String?,
+        onlyIfSilent: Boolean,
+    ) = sendExceptionReportInternal(e, origin, additionalInfo, onlyIfSilent, application.applicationContext)
+
     fun sendExceptionReport(
         e: Throwable,
         origin: String?,
         additionalInfo: String? = null,
         onlyIfSilent: Boolean = false,
-        context: Context = application.applicationContext,
+        context: Context,
+    ) = sendExceptionReportInternal(e, origin, additionalInfo, onlyIfSilent, context)
+
+    private fun sendExceptionReportInternal(
+        e: Throwable,
+        origin: String?,
+        additionalInfo: String?,
+        onlyIfSilent: Boolean,
+        context: Context,
     ) {
         sendAnalyticsException(e, false)
         AnkiDroidApp.sentExceptionReportHack = true
@@ -383,37 +398,3 @@ object CrashReportService {
             .filter { it.exceptionClass == UserSubmittedException::class.java.name }
             .maxOfOrNull { it.timestamp?.timeInMillis ?: -1L } ?: -1L
 }
-
-/**
- * Runs the provided block, catching [Exception], logging it and reporting it to [CrashReportService]
- *
- * **Example**
- * ```
- * runCatchingWithReport("callingMethod", onlyIfSilent = true) {
- *     doSomethingRisky()
- * }
- * ```
- *
- * **Note**: This differs from [runCatching] - `Error` is thrown
- *
- * @param origin Data logged to Timber, and provided as the 'origin' field in the error report
- * @param onlyIfSilent Skip crash report if the crash reporting service is not 'always accept'
- * @param block Code to execute
- *
- * @throws Error If raised, this will be reported and rethrown
- *
- * @return A Result containing either the successful result of [block] or the [Exception] thrown
- */
-fun <T> runCatchingWithReport(
-    origin: String?,
-    onlyIfSilent: Boolean = false,
-    block: () -> T,
-): Result<T> =
-    try {
-        Result.success(block())
-    } catch (e: Throwable) {
-        Timber.w(e, origin)
-        CrashReportService.sendExceptionReport(e, origin, onlyIfSilent = onlyIfSilent)
-        if (e is Error) throw e
-        Result.failure(e)
-    }

AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidApp.kt

@@ -34,8 +34,8 @@ import androidx.core.net.toUri
 import androidx.fragment.app.FragmentActivity
 import androidx.lifecycle.MutableLiveData
 import anki.collection.OpChanges
+import com.ichi2.anki.AcraCrashReporter.sendExceptionReport
 import com.ichi2.anki.AnkiDroidApp.Companion.sharedPreferencesTestingOverride
-import com.ichi2.anki.CrashReportService.sendExceptionReport
 import com.ichi2.anki.analytics.UsageAnalytics
 import com.ichi2.anki.browser.SharedPreferencesLastDeckIdRepository
 import com.ichi2.anki.common.annotations.LegacyNotifications
@@ -134,7 +134,8 @@ open class AnkiDroidApp :
         // Ensures any change is propagated to widgets
         ChangeManager.subscribe(this)
 
-        CrashReportService.initialize(this)
+        AcraCrashReporter.initialize(this)
+        CrashReportService.setReporter(AcraCrashReporter)
         val logType = LogType.value
         when (logType) {
             LogType.DEBUG -> Timber.plant(DebugTree())
@@ -165,7 +166,7 @@ open class AnkiDroidApp :
         }
 
         // Stop after analytics and logging are initialised.
-        if (CrashReportService.isProperServiceProcess()) {
+        if (AcraCrashReporter.isProperServiceProcess()) {
             Timber.d("Skipping AnkiDroidApp.onCreate from ACRA sender process")
             return
         }

AnkiDroid/src/main/java/com/ichi2/anki/analytics/AnkiDroidCrashReportDialog.kt

@@ -22,7 +22,7 @@ import android.content.DialogInterface
 import android.os.Bundle
 import android.view.View
 import androidx.core.content.edit
-import com.ichi2.anki.CrashReportService
+import com.ichi2.anki.AcraCrashReporter
 import com.ichi2.anki.R
 import com.ichi2.anki.databinding.DialogFeedbackBinding
 import com.ichi2.anki.preferences.sharedPrefs
@@ -87,11 +87,11 @@ class AnkiDroidCrashReportDialog :
             if (autoReport) {
                 preferences.edit {
                     putString(
-                        CrashReportService.FEEDBACK_REPORT_KEY,
-                        CrashReportService.FEEDBACK_REPORT_ALWAYS,
+                        AcraCrashReporter.FEEDBACK_REPORT_KEY,
+                        AcraCrashReporter.FEEDBACK_REPORT_ALWAYS,
                     )
                 }
-                CrashReportService.setAcraReportingMode(CrashReportService.FEEDBACK_REPORT_ALWAYS)
+                AcraCrashReporter.setAcraReportingMode(AcraCrashReporter.FEEDBACK_REPORT_ALWAYS)
             }
             // Send the crash report
             helper!!.sendCrash(binding.userComment.text.toString(), "")
@@ -100,7 +100,7 @@ class AnkiDroidCrashReportDialog :
             // The limiter persists it's limit info *before* the user cancels.
             // Therefore, on cancel, purge limits to make sure the user may actually send in future.
             // Better to maybe send to many reports than definitely too few.
-            CrashReportService.deleteACRALimiterData(this)
+            AcraCrashReporter.deleteACRALimiterData(this)
             helper!!.cancelReports()
         }
         finish()

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/help/HelpItemActionsDispatcher.kt

@@ -14,9 +14,9 @@
 package com.ichi2.anki.dialogs.help
 
 import androidx.annotation.StringRes
+import com.ichi2.anki.AcraCrashReporter
 import com.ichi2.anki.AnkiActivity
 import com.ichi2.anki.AnkiDroidApp
-import com.ichi2.anki.CrashReportService
 import com.ichi2.anki.R
 import com.ichi2.anki.snackbar.showSnackbar
 import com.ichi2.utils.AdaptionUtil
@@ -62,7 +62,7 @@ class AnkiActivityHelpActionsDispatcher(
         if (AdaptionUtil.isUserATestClient) {
             ankiActivity.showSnackbar(ankiActivity.getString(R.string.user_is_a_robot))
         } else {
-            val wasReportSent = CrashReportService.sendReport(ankiActivity)
+            val wasReportSent = AcraCrashReporter.sendReport(ankiActivity)
             if (!wasReportSent) {
                 ankiActivity.showSnackbar(ankiActivity.getString(R.string.help_dialog_exception_report_debounce))
                 return

AnkiDroid/src/main/java/com/ichi2/anki/preferences/DeveloperOptionsFragment.kt

@@ -20,11 +20,11 @@ import androidx.core.app.ActivityCompat
 import androidx.core.content.edit
 import androidx.preference.Preference
 import androidx.preference.SwitchPreferenceCompat
+import com.ichi2.anki.AcraCrashReporter
 import com.ichi2.anki.AnkiDroidApp
 import com.ichi2.anki.BuildConfig
 import com.ichi2.anki.CollectionHelper
 import com.ichi2.anki.CollectionManager.withCol
-import com.ichi2.anki.CrashReportService
 import com.ichi2.anki.R
 import com.ichi2.anki.analytics.UsageAnalytics
 import com.ichi2.anki.dialogs.TtsVoicesDialogFragment
@@ -60,7 +60,7 @@ class DeveloperOptionsFragment : SettingsFragment() {
         requirePreference<Preference>(R.string.pref_trigger_crash_key).setOnPreferenceClickListener {
             // If we don't delete the limiter data, our test crash may not go through,
             // but we are triggering it very much on purpose, we want to see the crash in ACRA
-            this.context?.let { c -> CrashReportService.deleteACRALimiterData(c) }
+            this.context?.let { c -> AcraCrashReporter.deleteACRALimiterData(c) }
 
             Timber.w("Crash triggered on purpose from advanced preferences in debug mode")
             throw RuntimeException("This is a test crash")