Deck action preparation hides database corruption

Open
#23,190 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
57/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
android, kotlin

Research direction

Start with the regression tests in AnkiDroid/src/test/java/com/ichi2/anki/DeckPickerPreparedActionCorruptionRegressionTest.kt and trace requestDeleteDeckConfirmation() and requestStudySelectedDeck() in DeckPickerViewModel. Follow how a corruption exception is handled during action preparation, then run the regression tests. Done means both cases mark corruption as detected and show DatabaseErrorDialog for recovery.

Written by the indexing model from the issue text.

Description

Originally posted by @david-allison in https://github.com/ankidroid/Anki-Android/pull/22504#pullrequestreview-5860114910

---
diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/DeckPickerPreparedActionCorruptionRegressionTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/DeckPickerPreparedActionCorruptionRegressionTest.kt
new file mode 100644
index 0000000000000000000000000000000000000000..3c2c4ac14d7d40656f0469e5241b26b2241b5175
--- /dev/null
+++ b/AnkiDroid/src/test/java/com/ichi2/anki/DeckPickerPreparedActionCorruptionRegressionTest.kt
@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+package com.ichi2.anki
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import anki.backend.backendError
+import com.ichi2.anki.backend.DatabaseCorruption
+import com.ichi2.anki.deckpicker.DeckPickerViewModel
+import com.ichi2.anki.dialogs.DatabaseErrorDialog
+import com.ichi2.testutils.rules.BackendOverrideRule
+import kotlinx.coroutines.Job
+import net.ankiweb.rsdroid.Backend
+import net.ankiweb.rsdroid.BackendException.BackendDbException.BackendDbCorruptException
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.shadows.ShadowDialog
+import java.util.concurrent.atomic.AtomicBoolean
+import kotlin.test.assertTrue
+
+@RunWith(AndroidJUnit4::class)
+class DeckPickerPreparedActionCorruptionRegressionTest : RobolectricTest() {
+    @get:Rule
+    val backendOverride = BackendOverrideRule()
+
+    @Test
+    fun `corruption reading the deck for deletion confirmation opens recovery`() = checkCorruption { requestDeleteDeckConfirmation() }
+
+    @Test
+    fun `corruption reading the deck for the study shortcut opens recovery`() = checkCorruption { requestStudySelectedDeck() }
+
+    private fun checkCorruption(request: DeckPickerViewModel.() -> Job) {
+        val failNextRead = AtomicBoolean(false)
+        backendOverride.replaceWith {
+            object : Backend() {
+                override fun getCurrentDeck(): anki.decks.Deck =
+                    if (failNextRead.getAndSet(false)) {
+                        throw BackendDbCorruptException(backendError { message = "database disk image is malformed" })
+                    } else {
+                        super.getCurrentDeck()
+                    }
+            }
+        }
+        addDeck("Target", setAsSelected = true)
+        val previouslyDetected = DatabaseCorruption.isDetected
+        DatabaseCorruption.isDetected = false
+        try {
+            withDeckPicker(deckCount = 0) { picker ->
+                advanceRobolectricLooperUntil { picker.viewModel.loadDeckCounts?.isCompleted == true }
+                advanceRobolectricLooper()
+                throwOnShowError = false
+                failNextRead.set(true)
+                val action = picker.viewModel.request()
+                advanceRobolectricLooperUntil { action.isCompleted && ShadowDialog.getLatestDialog()?.isShowing == true }
+                assertTrue(DatabaseCorruption.isDetected, "Preparing a deck action must preserve corruption detection")
+                assertTrue(
+                    picker.supportFragmentManager.fragments.any { it is DatabaseErrorDialog && it.dialog?.isShowing == true },
+                    "Preparing a deck action must open recovery instead of a generic error alert",
+                )
+            }
+        } finally {
+            DatabaseCorruption.isDetected = previouslyDetected
+        }
+    }
+}
Dominant language
Kotlin
Stars
12.3k
Forks
3.1k
Avg merge
1d 11h
Merged PRs (30d)
383

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ankidroid/Anki-Android

All issues in ankidroid/Anki-Android

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.