Tag edits are lost after the browser is recreated

Open
#23,196 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
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
android, kotlin
Domain
mobile, testing

Research direction

Start with AnkiDroid/src/test/java/com/ichi2/anki/browser/EditTagsDialogRecreationTest.kt, which reproduces the failure by recreating the browser while the Edit tags dialog is open. Trace how TagsDialog restores its state and applies tag edits after recreation. Done means the regression test passes and the selected notes receive the added tag after confirming the restored dialog.

Written by the indexing model from the issue text.

Description

Subject: [EXISTING] Tag edits are lost after the browser is recreated

Rotating the browser while Edit tags is open, then confirming, silently leaves the selected notes' tags unchanged.

⚠️ This issue existed before the PR and should likely be split off into a separate issue.
---
diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/browser/EditTagsDialogRecreationTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/browser/EditTagsDialogRecreationTest.kt
new file mode 100644
index 0000000000..98ef0eeb0f
--- /dev/null
+++ b/AnkiDroid/src/test/java/com/ichi2/anki/browser/EditTagsDialogRecreationTest.kt
@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+package com.ichi2.anki.browser
+
+import android.content.DialogInterface
+import androidx.appcompat.app.AlertDialog
+import androidx.test.core.app.ActivityScenario
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.ichi2.anki.CardBrowser
+import com.ichi2.anki.RobolectricTest
+import com.ichi2.anki.browser.search.StandardSearchFragment
+import com.ichi2.anki.dialogs.tags.TagsDialog
+import com.ichi2.anki.settings.Prefs
+import com.ichi2.anki.utils.ext.DIALOG_FRAGMENT_TAG
+import org.junit.Test
+import org.junit.runner.RunWith
+import kotlin.test.assertEquals
+import kotlin.test.assertIs
+import kotlin.test.assertNotNull
+
+@RunWith(AndroidJUnit4::class)
+class EditTagsDialogRecreationTest : RobolectricTest() {
+    @Test
+    fun `edit tags dialog edits the note`() = editTags(recreate = false)
+
+    @Test
+    fun `edit tags dialog restored after recreation edits the note`() = editTags(recreate = true)
+
+    private fun editTags(recreate: Boolean) =
+        runTest {
+            val note =
+                addBasicNote("Tagged").apply {
+                    addTag("probe")
+                    flush()
+                }
+            Prefs.devUsingCardBrowserSearchView = true
+            try {
+                ActivityScenario.launch(CardBrowser::class.java).use { scenario ->
+                    lateinit var browser: CardBrowser
+                    scenario.onActivity { browser = it }
+                    browser.viewModel.searchJob?.join()
+                    advanceRobolectricLooper()
+                    assertNotNull(
+                        browser.cardBrowserFragment.childFragmentManager.findFragmentByTag(StandardSearchFragment.TAG),
+                        "StandardSearchFragment exists before the search view is opened",
+                    )
+                    browser.viewModel.selectAll()?.join()
+                    advanceRobolectricLooper()
+                    browser.cardBrowserFragment.showEditTagsDialog()
+                    advanceRobolectricLooperUntil { browser.supportFragmentManager.findFragmentByTag(DIALOG_FRAGMENT_TAG) is TagsDialog }
+                    if (recreate) {
+                        scenario.recreate()
+                        advanceRobolectricLooper()
+                        scenario.onActivity { browser = it }
+                    }
+                    val dialog = assertIs<TagsDialog>(browser.supportFragmentManager.findFragmentByTag(DIALOG_FRAGMENT_TAG))
+                    val button = (dialog.requireDialog() as AlertDialog).getButton(DialogInterface.BUTTON_POSITIVE)
+                    advanceRobolectricLooperUntil { button.isEnabled }
+                    dialog.viewModel.tags.await().apply {
+                        add("added")
+                        check("added")
+                    }
+                    button.performClick()
+                    advanceRobolectricLooper()
+                    browser.viewModel.searchJob?.join()
+                    advanceRobolectricLooper()
+                    val searchTags = browser.viewModel.searchRequestFlow.value.filters.tags
+                    val noteTags = col.getNote(note.id).tags.sorted()
+                    assertEquals(
+                        "search=[] note=[added, probe]",
+                        "search=$searchTags note=$noteTags",
+                        "recreate=$recreate rows=${browser.viewModel.rowCount}",
+                    )
+                }
+            } finally {
+                Prefs.devUsingCardBrowserSearchView = false
+            }
+        }
+}
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.