Skip to content

Refactor: Move deck operations business logic from DeckPicker to DeckPickerViewModel #19245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+193 −80
Open

Refactor: Move deck operations business logic from DeckPicker to DeckPickerViewModel #19245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 38 additions & 79 deletions AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@

package com.ichi2.anki

import android.content.Context
import android.content.Intent
import android.content.SharedPreferences
import android.content.res.Configuration
Expand Down Expand Up @@ -115,6 +114,7 @@ import com.ichi2.anki.deckpicker.DeckPickerViewModel.FlattenedDeckList
import com.ichi2.anki.deckpicker.DeckPickerViewModel.StartupResponse
import com.ichi2.anki.deckpicker.EmptyCardsResult
import com.ichi2.anki.deckpicker.OptionsMenuState
import com.ichi2.anki.deckpicker.ShortcutData
import com.ichi2.anki.deckpicker.SyncIconState
import com.ichi2.anki.dialogs.AsyncDialogFragment
import com.ichi2.anki.dialogs.BackupPromptDialog
Expand Down Expand Up @@ -145,7 +145,6 @@ import com.ichi2.anki.export.ExportDialogFragment
import com.ichi2.anki.introduction.CollectionPermissionScreenLauncher
import com.ichi2.anki.introduction.hasCollectionStoragePermissions
import com.ichi2.anki.libanki.DeckId
import com.ichi2.anki.libanki.Decks
import com.ichi2.anki.libanki.exception.ConfirmModSchemaException
import com.ichi2.anki.libanki.sched.DeckNode
import com.ichi2.anki.libanki.undoAvailable
Expand Down Expand Up @@ -699,6 +698,10 @@ open class DeckPicker :
startActivity(destination.toIntent(this))
}

fun onExportDeck(deckId: DeckId) {
ExportDialogFragment.newInstance(deckId).show(supportFragmentManager, "exportOptions")
}

fun onPromptUserToUpdateScheduler(op: Unit) {
SchedulerUpgradeDialog(
activity = this,
Expand Down Expand Up @@ -800,7 +803,7 @@ open class DeckPicker :
}

fun onFocusedDeckChanged(deckId: DeckId?) {
val position = deckId?.let { findDeckPosition(it) } ?: 0
val position = deckId?.let { viewModel.findDeckPosition(it) } ?: 0
// HACK: a small delay is required before scrolling works
recyclerView.postDelayed({
recyclerViewLayoutManager.scrollToPositionWithOffset(position, recyclerView.height / 2)
Expand Down Expand Up @@ -859,6 +862,9 @@ open class DeckPicker :
viewModel.emptyCardsNotification.launchCollectionInLifecycleScope(::onCardsEmptied)
viewModel.flowOfDeckCountsChanged.launchCollectionInLifecycleScope(::onDeckCountsChanged)
viewModel.flowOfDestination.launchCollectionInLifecycleScope(::onDestinationChanged)
viewModel.flowOfExportDeck.launchCollectionInLifecycleScope(::onExportDeck)
viewModel.flowOfCreateShortcut.launchCollectionInLifecycleScope(::createIcon)
viewModel.flowOfDisableShortcuts.launchCollectionInLifecycleScope(::disableDeckAndChildrenShortcuts)
viewModel.onError.launchCollectionInLifecycleScope(::onError)
viewModel.flowOfPromptUserToUpdateScheduler.launchCollectionInLifecycleScope(::onPromptUserToUpdateScheduler)
viewModel.flowOfUndoUpdated.launchCollectionInLifecycleScope(::onUndoUpdated)
Expand Down Expand Up @@ -909,7 +915,7 @@ open class DeckPicker :
* if fixed or given free hand to delete the shortcut with the help of API update this method and use the new one
*/
// TODO: it feels buggy that this is not called on all deck deletion paths
disableDeckAndChildrenShortcuts(deckId)
viewModel.disableDeckAndChildrenShortcuts(deckId)
dismissAllDialogFragments()
deleteDeck(deckId)
}
Expand All @@ -924,7 +930,7 @@ open class DeckPicker :
}
DeckPickerContextMenuOption.CREATE_SHORTCUT -> {
Timber.i("ContextMenu: Create icon for a deck")
createIcon(this, deckId)
viewModel.createIcon(deckId)
}
DeckPickerContextMenuOption.RENAME_DECK -> {
Timber.i("ContextMenu: Rename deck selected")
Expand All @@ -933,7 +939,7 @@ open class DeckPicker :
}
DeckPickerContextMenuOption.EXPORT_DECK -> {
Timber.i("ContextMenu: Export deck selected")
exportDeck(deckId)
viewModel.exportDeck(deckId)
}
DeckPickerContextMenuOption.UNBURY -> {
Timber.i("ContextMenu: Unbury deck selected")
Expand Down Expand Up @@ -2171,40 +2177,22 @@ open class DeckPicker :
// Also forget the last deck used by the Browser
CardBrowser.clearLastDeckId()
viewModel.focusedDeck = did
val deck = getNodeByDid(did)
if (deck.hasCardsReadyToStudy()) {

val deck = withCol { sched.deckDueTree().find(did) }
if (deck?.hasCardsReadyToStudy() == true) {
openReviewerOrStudyOptions(selectionType)
return
}

if (!deck.filtered && isDeckAndSubdeckEmpty(did)) {
val isEmpty = withCol { decks.cardCount(did, includeSubdecks = true) == 0 }
if (!deck?.filtered!! && isEmpty) {
showEmptyDeckSnackbar()
updateUi()
} else {
onDeckCompleted()
}
}

/**
* Return the position of the deck in the deck list. If the deck is a child of a collapsed deck
* (i.e., not visible in the deck list), then the position of the parent deck is returned instead.
*
* An invalid deck ID will return position 0.
*/
private fun findDeckPosition(did: DeckId): Int {
deckListAdapter.currentList.forEachIndexed { index, treeNode ->
if (treeNode.did == did) {
return index
}
}

// If the deck is not in our list, we search again using the immediate parent
// If the deck is not found, return 0
val collapsedDeck = dueTree?.find(did) ?: return 0
val parent = collapsedDeck.parent?.get() ?: return 0
return findDeckPosition(parent.did)
}

/**
* @see DeckPickerViewModel.updateDeckList
*/
Expand All @@ -2215,28 +2203,16 @@ open class DeckPicker :
}
}

/**
* Get the [DeckNode] identified by [did] from [DeckAdapter].
*/
private fun DeckPicker.getNodeByDid(did: DeckId): DeckNode = deckListAdapter.currentList[findDeckPosition(did)].deckNode

fun exportDeck(did: DeckId) {
ExportDialogFragment.newInstance(did).show(supportFragmentManager, "exportOptions")
}

private fun createIcon(
context: Context,
did: DeckId,
) {
private fun createIcon(shortcutData: ShortcutData) {
// This code should not be reachable with lower versions
val shortcut =
ShortcutInfoCompat
.Builder(this, did.toString())
Copy link
Member

@david-allison david-allison Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a unit test in libanki on DeckId.toString being correct.

It's subject to being broken if we move to a value class

.Builder(this, shortcutData.deckId.toString())
.setIntent(
intentToReviewDeckFromShortcuts(context, did),
).setIcon(IconCompat.createWithResource(context, R.mipmap.ic_launcher))
.setShortLabel(Decks.basename(getColUnsafe.decks.name(did)))
.setLongLabel(getColUnsafe.decks.name(did))
intentToReviewDeckFromShortcuts(this, shortcutData.deckId),
).setIcon(IconCompat.createWithResource(this, R.mipmap.ic_launcher))
.setShortLabel(shortcutData.shortLabel)
.setLongLabel(shortcutData.longLabel)
.build()
try {
val success = ShortcutManagerCompat.requestPinShortcut(this, shortcut, null)
Expand All @@ -2254,28 +2230,27 @@ open class DeckPicker :
}
}

/** Disables the shortcut of the deck and the children belonging to it.*/
@NeedsTest("ensure collapsed decks are also deleted")
Copy link
Member

@lukstbit lukstbit Nov 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was deleted but I don't see a test for it.

private fun disableDeckAndChildrenShortcuts(did: DeckId) {
// Get the DeckId and all child DeckIds
val deckTreeDids = dueTree?.find(did)?.map { it.did.toString() } ?: listOf()
private fun disableDeckAndChildrenShortcuts(deckTreeDids: List<String>) {
val errorMessage: CharSequence = getString(R.string.deck_shortcut_doesnt_exist)
ShortcutManagerCompat.disableShortcuts(this, deckTreeDids, errorMessage)
}

fun renameDeckDialog(did: DeckId) {
val currentName = getColUnsafe.decks.name(did)
val createDeckDialog = CreateDeckDialog(this@DeckPicker, R.string.rename_deck, CreateDeckDialog.DeckDialogType.RENAME_DECK, null)
createDeckDialog.deckName = currentName
createDeckDialog.onNewDeckCreated = {
dismissAllDialogFragments()
deckListAdapter.notifyDataSetChanged()
updateDeckList()
if (fragmented) {
loadStudyOptionsFragment()
launchCatchingTask {
val currentName = withCol { decks.name(did) }
val createDeckDialog =
CreateDeckDialog(this@DeckPicker, R.string.rename_deck, CreateDeckDialog.DeckDialogType.RENAME_DECK, null)
createDeckDialog.deckName = currentName
createDeckDialog.onNewDeckCreated = {
dismissAllDialogFragments()
deckListAdapter.notifyDataSetChanged()
updateDeckList()
if (fragmented) {
loadStudyOptionsFragment()
}
}
createDeckDialog.showDialog()
}
createDeckDialog.showDialog()
}

/**
Expand Down Expand Up @@ -2307,11 +2282,7 @@ open class DeckPicker :
fun rebuildFiltered(did: DeckId) {
launchCatchingTask {
withProgress(resources.getString(R.string.rebuild_filtered_deck)) {
withCol {
Timber.d("rebuildFiltered: doInBackground - RebuildCram")
decks.select(did)
sched.rebuildFilteredDeck(decks.selected())
}
viewModel.rebuildFilteredDeck(did).join()
}
updateDeckList()
if (fragmented) loadStudyOptionsFragment()
Expand Down Expand Up @@ -2460,18 +2431,6 @@ open class DeckPicker :
}
}

/**
* Returns if the deck and its subdecks are all empty.
*
* @param did The id of a deck with no pending cards to review
*/
private suspend fun isDeckAndSubdeckEmpty(did: DeckId): Boolean {
val node = getNodeByDid(did)
return withCol {
node.all { decks.isEmpty(it.did) }
}
}

override fun getApkgFileImportResultLauncher(): ActivityResultLauncher<Intent> = apkgFileImportResultLauncher

override fun getCsvFileImportResultLauncher(): ActivityResultLauncher<Intent> = csvImportResultLauncher
Expand Down
Loading