fix(fsrs-error): add link to deck options

If the following error appears:

The provided FSRS parameters are invalid. Leave them blank to use the default parameters.

Then the user could not perform any actions to fix this.

Provide a 'help' link which opens the deck options

Fixes 18984

(cherry picked from commit 5fb9997)

Author: david-allison

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

@@ -36,9 +36,13 @@ import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.CollectionManager.withCol
 import com.ichi2.anki.CrashReportData.Companion.throwIfDialogUnusable
 import com.ichi2.anki.CrashReportData.Companion.toCrashReportData
+import com.ichi2.anki.CrashReportData.HelpAction
+import com.ichi2.anki.CrashReportData.HelpAction.AnkiBackendLink
+import com.ichi2.anki.CrashReportData.HelpAction.OpenDeckOptions
 import com.ichi2.anki.common.annotations.UseContextParameter
 import com.ichi2.anki.exception.StorageAccessException
 import com.ichi2.anki.libanki.Collection
+import com.ichi2.anki.pages.DeckOptionsDestination
 import com.ichi2.anki.snackbar.showSnackbar
 import com.ichi2.anki.utils.openUrl
 import com.ichi2.utils.create
@@ -260,17 +264,24 @@ fun Context.showError(
                 title(R.string.vague_error)
                 message(text = message)
                 positiveButton(R.string.dialog_ok)
-                if (crashReportData?.helpLink != null) {
+                if (crashReportData?.helpAction != null) {
                     neutralButton(R.string.help)
                 }
-                if (crashReportData?.reportException == true) {
+                if (crashReportData?.reportableException == true) {
                     Timber.w("sending crash report on close")
                     setOnDismissListener { crashReportData.sendCrashReport() }
                 }
             }.apply {
                 // setup the help link. Link is non-null if neutralButton exists.
                 setOnShowListener {
-                    neutralButton?.setOnClickListener { openUrl(crashReportData!!.helpLink!!) }
+                    neutralButton?.setOnClickListener {
+                        lifecycle.coroutineScope.launch {
+                            val shouldDismiss = crashReportData!!.helpAction!!.execute(context = context)
+                            if (shouldDismiss) {
+                                dismiss()
+                            }
+                        }
+                    }
                 }
                 setupEnterKeyHandler()
                 show()
@@ -282,6 +293,26 @@ fun Context.showError(
     }
 }
 
+/**
+ * @return Whether the dialog should be dismissed
+ */
+suspend fun HelpAction.execute(context: Context): Boolean {
+    when (this) {
+        is AnkiBackendLink -> {
+            context.openUrl(this.link)
+            return false
+        }
+        OpenDeckOptions -> {
+            // if we're in the error dialog, we have no context of the deck which caused the exception
+            // assume it's the current deck
+            val openCurrentDeckOptions = DeckOptionsDestination.fromCurrentDeck()
+            context.startActivity(openCurrentDeckOptions.toIntent(context))
+            // dismiss the dialog - the user should have resolved the issue
+            return true
+        }
+    }
+}
+
 /** In most cases, you'll want [AnkiActivity.withProgress]
  * instead. This lower-level routine can be used to integrate your own
  * progress UI.
@@ -575,29 +606,66 @@ private fun Activity.showError(
 data class CrashReportData(
     val exception: Throwable,
     val origin: String,
-    val reportException: Boolean,
+    val reportableException: Boolean,
 ) {
     /**
      * Optional link to a help page regarding the error
      *
      * For example: https://docs.ankiweb.net/templates/errors.html#no-cloze-filter-on-cloze-notetype
+     * Or opening the deck options
      */
-    val helpLink: Uri?
-        get() =
-            try {
-                (exception as? BackendException)
-                    ?.getDesktopHelpPageLink(CollectionManager.getBackend())
-                    ?.toUri()
-            } catch (e: Exception) {
-                Timber.w(e)
-                null
-            }
+    val helpAction: HelpAction?
+        get() = HelpAction.from(exception)
+
+    fun shouldReportException(): Boolean {
+        if (!reportableException) return false
+        if (exception.isInvalidFsrsParametersException()) return false
+        return true
+    }
 
     fun sendCrashReport() {
-        if (!reportException) return
+        if (!shouldReportException()) {
+            Timber.i("skipped crash report due to further validation")
+            return
+        }
         CrashReportService.sendExceptionReport(exception, origin)
     }
 
+    /**
+     * Optional action to provide more information about an error
+     *
+     * Examples:
+     * - Open https://docs.ankiweb.net/templates/errors.html#no-cloze-filter-on-cloze-notetype
+     * - Open the deck options
+     */
+    sealed class HelpAction {
+        data class AnkiBackendLink(
+            val link: Uri,
+        ) : HelpAction()
+
+        /** Open the deck options for the current deck */
+        data object OpenDeckOptions : HelpAction()
+
+        companion object {
+            fun from(e: Throwable): HelpAction? {
+                val link =
+                    try {
+                        (e as? BackendException)
+                            ?.getDesktopHelpPageLink(CollectionManager.getBackend())
+                            ?.toUri()
+                    } catch (e: Exception) {
+                        Timber.w(e)
+                        null
+                    }
+
+                if (link != null) return AnkiBackendLink(link)
+                if (e.isInvalidFsrsParametersException()) return OpenDeckOptions
+
+                return null
+            }
+        }
+    }
+
     companion object {
         @UseContextParameter("context")
         fun Throwable.toCrashReportData(
@@ -607,15 +675,15 @@ data class CrashReportData(
             exception = this,
             // Appears as 'ManageNotetypes'
             origin = context::class.java.simpleName,
-            reportException = reportException,
+            reportableException = reportException,
         )
 
         /**
          * If [throwOnShowError] is set, throws the exception from the crash report data
          *
          * So unit tests can fail if an unexpected exception is thrown
          *
-         * Note: this occurs regardless of the status of [reportException]
+         * Note: this occurs regardless of the status of [reportableException]
          *
          * @param message The message of the thrown [IllegalStateException]
          * @throws IllegalStateException with [exception] as an innerException if the receiver
@@ -627,5 +695,13 @@ data class CrashReportData(
             if (this == null) throw IllegalStateException(message)
             throw IllegalStateException(message, exception)
         }
+
+        private fun Throwable.isInvalidFsrsParametersException(): Boolean =
+            try {
+                // `TR` may fail in an error-reporting context
+                message == TR.deckConfigInvalidParameters()
+            } catch (_: Throwable) {
+                false
+            }
     }
 }

AnkiDroid/src/main/java/com/ichi2/anki/pages/CongratsPage.kt

@@ -19,6 +19,7 @@ import android.content.Context
 import android.content.Intent
 import android.os.Bundle
 import android.view.View
+import androidx.annotation.CheckResult
 import androidx.appcompat.app.AlertDialog
 import androidx.fragment.app.FragmentActivity
 import androidx.fragment.app.setFragmentResultListener
@@ -295,6 +296,16 @@ class DeckOptionsDestination(
                 deckId = deckId,
                 isFiltered = withCol { decks.isFiltered(deckId) },
             )
+
+        @CheckResult
+        suspend fun fromCurrentDeck() =
+            withCol {
+                val deckId = decks.getCurrentId()
+                DeckOptionsDestination(
+                    deckId = deckId,
+                    isFiltered = decks.isFiltered(deckId),
+                )
+            }
     }
 }