Bug 1853108 - Extract interesting crash on Android r=kaya,geckoview-reviewers,android-reviewers,owlish,boek,android-l10n-reviewers,delphine,ohall

Differential Revision: https://phabricator.services.mozilla.com/D225780

Author: Alexandre Lissy

mobile/android/android-components/components/browser/engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/crash/GeckoCrashPullDelegate.kt

@@ -0,0 +1,26 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.browser.engine.gecko.crash
+
+import org.mozilla.geckoview.CrashPullController
+import org.mozilla.geckoview.CrashPullController.Delegate
+
+/**
+ * [CrashPullController.Delegate] implementation
+ *
+ * An abstraction that allows a dispatcher to get the list of CrashIDs coming
+ * from Remote Settings and in charge of performing the correct AppStore
+ * dispatch for proper UI handling.
+ *
+ * @param dispatcher The dispatcher callback that is in charge of performing the
+ *                   heavy lifting of dispatching the CrashIDs to the AppStore
+ */
+class GeckoCrashPullDelegate(
+    private val dispatcher: (crashIDs: Array<String>) -> Unit,
+) : CrashPullController.Delegate {
+    override fun onCrashPull(crashIDs: Array<String>) {
+        dispatcher(crashIDs)
+    }
+}

mobile/android/android-components/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt

@@ -190,6 +190,16 @@ class CrashReporter internal constructor(
             .map { it.toCrash() }
     }
 
+    /**
+     * Fetches specific crash reports that are identified by they ID.
+     *
+     * @param crashIDs The list of strings representing the crash IDs to find.
+     */
+    suspend fun findCrashReports(crashIDs: Array<String>): List<Crash> {
+        return database.crashDao().getCrashesFromID(crashIDs)
+            .map { it.toCrash() }
+    }
+
     /**
      * Get a copy of the crashBreadcrumbs
      */

mobile/android/android-components/components/lib/crash/src/main/java/mozilla/components/lib/crash/db/CrashDao.kt

@@ -52,6 +52,20 @@ internal interface CrashDao {
     )
     suspend fun getCrashesWithoutReportsSince(timestampMillis: Long): List<CrashEntity>
 
+    /**
+     * Returns saved crashes that are part of a specific list of IDs.
+     */
+    @RewriteQueriesToDropUnusedColumns
+    @Transaction
+    @Query(
+        """
+        SELECT * FROM crashes
+        LEFT JOIN reports ON crashes.uuid = reports.crash_uuid
+        WHERE crashes.minidumpPath IN (:crashIDs)
+        """,
+    )
+    suspend fun getCrashesFromID(crashIDs: Array<String>): List<CrashEntity>
+
     /**
      * Returns saved crashes that haven't been reported.
      */

mobile/android/android-components/components/lib/crash/src/main/java/mozilla/components/lib/crash/store/CrashAction.kt

@@ -38,6 +38,12 @@ sealed class CrashAction {
      */
     data class Defer(val now: TimeInMillis) : CrashAction()
 
+    /**
+     * [CrashAction] to ask user consent for sending crashes requested over
+     * Remote Settings.
+     */
+    data class PullCrashes(val crashIDs: Array<String>) : CrashAction()
+
     /**
      * [CrashAction] show the user a prompt to send unsent crashes.
      */
@@ -48,8 +54,14 @@ sealed class CrashAction {
      */
     data object CancelTapped : CrashAction()
 
+    /**
+     * [CrashAction] to record a setting and a pref that the user does not want
+     * to see the Remote Settings crash dialog.
+     */
+    data object CancelForEverTapped : CrashAction()
+
     /**
      * [CrashAction] to send when a user taps the send report button.
      */
-    data class ReportTapped(val automaticallySendChecked: Boolean) : CrashAction()
+    data class ReportTapped(val automaticallySendChecked: Boolean, val crashIDs: Array<String>?) : CrashAction()
 }

mobile/android/android-components/components/lib/crash/src/main/java/mozilla/components/lib/crash/store/CrashMiddleware.kt

@@ -46,6 +46,12 @@ interface CrashReportCache {
      * Stores the users response to always send crashes.
      */
     suspend fun setAlwaysSend(alwaysSend: Boolean)
+
+    /**
+     * Records that the user does not want to see the remote settings crash pull
+     * anymore
+     */
+    suspend fun setCrashPullNeverShowAgain(neverShowAgain: Boolean)
 }
 
 /**
@@ -62,7 +68,6 @@ class CrashMiddleware(
     private val currentTimeInMillis: () -> TimeInMillis = { System.currentTimeMillis() },
     private val scope: CoroutineScope = CoroutineScope(Dispatchers.IO),
 ) {
-
     /**
      * Handle any middleware logic before an action reaches the [crashReducer].
      *
@@ -117,18 +122,26 @@ class CrashMiddleware(
                 }
             }
             CrashAction.CancelTapped -> dispatch(CrashAction.Defer(now = currentTimeInMillis()))
+            CrashAction.CancelForEverTapped -> scope.launch {
+                cache.setCrashPullNeverShowAgain(true)
+            }
             is CrashAction.Defer -> scope.launch {
                 val state = getState()
                 if (state is CrashState.Deferred) {
                     cache.setDeferredUntil(state.until)
                 }
             }
             is CrashAction.ReportTapped -> scope.launch {
-                if (action.automaticallySendChecked) {
-                    cache.setAlwaysSend(true)
+                if (action.crashIDs != null && action.crashIDs.size > 0) {
+                    sendCrashReports(action.crashIDs)
+                } else {
+                    if (action.automaticallySendChecked) {
+                        cache.setAlwaysSend(true)
+                    }
+                    sendUnsentCrashReports()
                 }
-                sendUnsentCrashReports()
             }
+            is CrashAction.PullCrashes -> {} // noop
             CrashAction.ShowPrompt -> {} // noop
         }
     }
@@ -144,4 +157,10 @@ class CrashMiddleware(
             crashReporter.submitReport(it)
         }
     }
+
+    private suspend fun sendCrashReports(crashIDs: Array<String>) {
+        crashReporter.findCrashReports(crashIDs).forEach {
+            crashReporter.submitReport(it)
+        }
+    }
 }

mobile/android/android-components/components/lib/crash/src/main/java/mozilla/components/lib/crash/store/CrashReducer.kt

@@ -28,7 +28,9 @@ fun crashReducer(
         }
         is CrashAction.Defer -> CrashState.Deferred(action.now + FIVE_DAYS_IN_MILLIS)
         CrashAction.ShowPrompt -> CrashState.Reporting
+        is CrashAction.PullCrashes -> CrashState.ReportingPull(action.crashIDs)
         CrashAction.CancelTapped,
+        CrashAction.CancelForEverTapped,
         is CrashAction.ReportTapped,
         -> CrashState.Done
     }

mobile/android/android-components/components/lib/crash/src/main/java/mozilla/components/lib/crash/store/CrashState.kt

@@ -32,6 +32,12 @@ sealed class CrashState {
      */
     data object Reporting : CrashState()
 
+    /**
+     * Crash reporter is presenting UI to the user to send crash reports that
+     * were requested over Remote Settings.
+     */
+    data class ReportingPull(val crashIDs: Array<String>) : CrashState()
+
     /**
      * Crash reporter is done.
      */

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/HomeActivity.kt

@@ -161,6 +161,8 @@ import org.mozilla.fenix.theme.StatusBarColorManager
 import org.mozilla.fenix.theme.ThemeManager
 import org.mozilla.fenix.utils.Settings
 import org.mozilla.fenix.utils.changeAppLauncherIcon
+import java.lang.Math
+import java.lang.System
 import java.lang.ref.WeakReference
 import java.util.Locale
 
@@ -216,6 +218,7 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity {
 
     private val crashReporterBinding by lazy {
         CrashReporterBinding(
+            context = this,
             store = components.appStore,
             onReporting = ::showCrashReporter,
         )
@@ -1435,12 +1438,23 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity {
         messaging.onMessageDisplayed(nextMessage, currentBootUniqueIdentifier)
     }
 
-    private fun showCrashReporter() {
+    private fun showCrashReporter(crashIDs: Array<String>?, ctxt: Context) {
         if (!settings().useNewCrashReporterDialog) {
             return
         }
+
+        var now = Math.round(System.currentTimeMillis() / DateUtils.SECOND_IN_MILLIS * 1.0)
+        if (now < settings().crashPullDontShowBefore) {
+            return
+        }
+
         UnsubmittedCrashDialog(
-            dispatcher = { action -> components.appStore.dispatch(AppAction.CrashActionWrapper(action)) },
+            dispatcher = { action ->
+                components.appStore.dispatch(AppAction.CrashActionWrapper(action))
+                settings().crashPullDontShowBefore = now + CRASH_PULL_SILENCE_FOR_DAYS_IN_S
+            },
+            crashIDs = crashIDs,
+            localContext = ctxt,
         ).show(supportFragmentManager, UnsubmittedCrashDialog.TAG)
     }
 
@@ -1456,5 +1470,7 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity {
         // PWA must have been used within last 30 days to be considered "recently used" for the
         // telemetry purposes.
         private const val PWA_RECENTLY_USED_THRESHOLD = DateUtils.DAY_IN_MILLIS * 30L
+
+        private const val CRASH_PULL_SILENCE_FOR_DAYS_IN_S = 7L * 86400L
     }
 }

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/crashes/CrashReporterBinding.kt

@@ -4,6 +4,7 @@
 
 package org.mozilla.fenix.crashes
 
+import android.content.Context
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.distinctUntilChangedBy
 import mozilla.components.lib.crash.store.CrashState
@@ -14,18 +15,23 @@ import org.mozilla.fenix.components.appstate.AppState
 /**
  * A binding for observing the [CrashState] in the [AppStore] and displaying the crash reporter.
  *
+ * @param context The [Context] used to open links via Intents.
  * @param store The [AppStore] used to observe the [CrashState].
  * @param onReporting a callback that is called when [CrashState] is [CrashState.Reporting].
  */
 class CrashReporterBinding(
+    private val context: Context,
     store: AppStore,
-    private val onReporting: () -> Unit,
+    private val onReporting: (Array<String>?, Context) -> Unit,
 ) : AbstractBinding<AppState>(store) {
     override suspend fun onState(flow: Flow<AppState>) {
         flow.distinctUntilChangedBy { state -> state.crashState }
             .collect { state ->
                 if (state.crashState == CrashState.Reporting) {
-                    onReporting()
+                    onReporting(null, context)
+                }
+                if (state.crashState is CrashState.ReportingPull) {
+                    onReporting(state.crashState.crashIDs, context)
                 }
             }
     }

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/crashes/SettingsCrashReportCache.kt

@@ -33,4 +33,8 @@ class SettingsCrashReportCache(private val settings: Settings) : CrashReportCach
     override suspend fun setAlwaysSend(alwaysSend: Boolean) {
         settings.crashReportAlwaysSend = alwaysSend
     }
+
+    override suspend fun setCrashPullNeverShowAgain(neverShowAgain: Boolean) {
+        settings.crashPullNeverShowAgain = neverShowAgain
+    }
 }