feat(card-browser): enable new sort order bottom sheet

And remove old implementation

Fixes 17732

Author: david-allison

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserFragment.kt

@@ -17,7 +17,6 @@
 package com.ichi2.anki.browser
 
 import android.content.Context
-import android.content.DialogInterface
 import android.graphics.Color
 import android.os.Bundle
 import android.text.Spannable
@@ -97,14 +96,14 @@ import com.ichi2.anki.browser.search.CardStateBottomSheetFragment
 import com.ichi2.anki.browser.search.FlagsBottomSheetFragment
 import com.ichi2.anki.browser.search.SearchRequest
 import com.ichi2.anki.browser.search.SearchString
+import com.ichi2.anki.browser.search.SortOrderBottomSheetFragment
 import com.ichi2.anki.browser.search.StandardSearchFragment
 import com.ichi2.anki.browser.search.formatChipDescription
 import com.ichi2.anki.browser.search.iconRes
 import com.ichi2.anki.browser.search.savedFilters
 import com.ichi2.anki.common.annotations.NeedsTest
 import com.ichi2.anki.common.utils.annotation.KotlinCleanup
 import com.ichi2.anki.dialogs.BrowserOptionsDialog
-import com.ichi2.anki.dialogs.CardBrowserOrderDialog
 import com.ichi2.anki.dialogs.DeckSelectionDialog
 import com.ichi2.anki.dialogs.DeckSelectionDialog.DeckSelectionListener
 import com.ichi2.anki.dialogs.SimpleMessageDialog
@@ -119,7 +118,6 @@ import com.ichi2.anki.libanki.undoAvailable
 import com.ichi2.anki.libanki.undoLabel
 import com.ichi2.anki.model.CardStateFilter
 import com.ichi2.anki.model.CardsOrNotes.CARDS
-import com.ichi2.anki.model.LegacySortType
 import com.ichi2.anki.model.SelectableDeck
 import com.ichi2.anki.observability.ChangeManager
 import com.ichi2.anki.observability.undoableOp
@@ -1007,11 +1005,11 @@ class CardBrowserFragment :
             searchViewModel.syncState(search)
         }
 
-        fun reverseDirectionChanged(direction: ReverseDirection) {
-            sortChip?.scaleY = if (!direction.orderAsc) 1.0f else -1.0f
+        fun reverseDirectionChanged(reverse: ReverseDirection?) {
+            sortChip?.scaleY = if (reverse == false || reverse == null) 1.0f else -1.0f
         }
 
-        activityViewModel.reverseDirectionFlow.launchCollectionInLifecycleScope(::reverseDirectionChanged)
+        activityViewModel.flowOfReverseDirection.launchCollectionInLifecycleScope(::reverseDirectionChanged)
         activityViewModel.flowOfIsTruncated.launchCollectionInLifecycleScope(::onIsTruncatedChanged)
         activityViewModel.flowOfSelectedRows.launchCollectionInLifecycleScope(::onSelectedRowsChanged)
         activityViewModel.flowOfActiveColumns.launchCollectionInLifecycleScope(::onColumnsChanged)
@@ -1400,15 +1398,12 @@ class CardBrowserFragment :
             }
         }
 
-    fun changeDisplayOrder() {
-        showDialogFragment(
-            // TODO: move this into the ViewModel
-            CardBrowserOrderDialog.newInstance { dialog: DialogInterface, which: Int ->
-                dialog.dismiss()
-                activityViewModel.changeCardOrder(LegacySortType.fromCardBrowserLabelIndex(which))
-            },
-        )
-    }
+    fun changeDisplayOrder() =
+        launchCatchingTask {
+            SortOrderBottomSheetFragment
+                .createInstance(cardsOrNotes = activityViewModel.cardsOrNotes)
+                .show(childFragmentManager)
+        }
 
     fun updateFlagForSelectedRows(flag: Flag) =
         launchCatchingTask {

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserViewModel.kt

@@ -70,15 +70,12 @@ import com.ichi2.anki.model.CardStateFilter
 import com.ichi2.anki.model.CardsOrNotes
 import com.ichi2.anki.model.CardsOrNotes.CARDS
 import com.ichi2.anki.model.CardsOrNotes.NOTES
-import com.ichi2.anki.model.LegacySortType
 import com.ichi2.anki.model.SelectableDeck
 import com.ichi2.anki.model.SortType
 import com.ichi2.anki.observability.ChangeManager
 import com.ichi2.anki.observability.undoableOp
 import com.ichi2.anki.pages.CardInfoDestination
 import com.ichi2.anki.preferences.SharedPreferencesProvider
-import com.ichi2.anki.settings.Prefs
-import com.ichi2.anki.settings.PrefsRepository
 import com.ichi2.anki.utils.ext.currentCardBrowse
 import com.ichi2.anki.utils.ext.getCardOrNull
 import com.ichi2.anki.utils.ext.ignoreAccentsInSearch
@@ -94,7 +91,6 @@ import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.combineTransform
-import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.flattenMerge
 import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.launchIn
@@ -117,6 +113,11 @@ import java.util.Collections
 import kotlin.math.max
 import kotlin.math.min
 
+/**
+ * Whether the current sort is reversed (descending). `true` if reversed.
+ */
+typealias ReverseDirection = Boolean
+
 // TODO: move the tag computation to ViewModel
 
 /**
@@ -129,7 +130,6 @@ import kotlin.math.min
  * @param isFragmented `true` if a NoteEditor side panel is displayed (x-large displays)
  * @param manualInit test-only: defer `initCompleted` until `manualInit()` is called
  */
-@NeedsTest("reverseDirectionFlow/sortTypeFlow are not updated on .launch { }")
 @NeedsTest("columIndex1/2 config is not not updated on init")
 @NeedsTest("13442: selected deck is not changed, as this affects the reviewer")
 @NeedsTest("search is called after launch()")
@@ -143,8 +143,6 @@ class CardBrowserViewModel(
     private val manualInit: Boolean = false,
 ) : ViewModel(),
     SharedPreferencesProvider by preferences {
-    private val prefs: PrefsRepository = Prefs
-
     // TODO: abstract so we can use a `Context` and `pref_display_filenames_in_browser_key`
     val showMediaFilenames = sharedPrefs().getBoolean("card_browser_show_media_filenames", false)
 
@@ -193,11 +191,12 @@ class CardBrowserViewModel(
 
     val flowOfScrollRequest = MutableSharedFlow<RowSelection>()
 
-    private val sortTypeFlow = MutableStateFlow(LegacySortType.NO_SORTING)
-    val order get() = sortTypeFlow.value
-
-    val reverseDirectionFlow = MutableStateFlow(ReverseDirection(orderAsc = false))
-    val orderAsc get() = reverseDirectionFlow.value.orderAsc
+    /**
+     * Whether the current sort is reversed (descending).
+     *
+     * `null` when no sort is applied ([SortType.NoOrdering]).
+     */
+    val flowOfReverseDirection: MutableStateFlow<ReverseDirection?> = MutableStateFlow(null)
 
     /**
      * A map from column backend key to backend column definition
@@ -498,16 +497,6 @@ class CardBrowserViewModel(
                 launchSearchForCards(cardOrNoteIdsToSelect = ids)
             }.launchIn(viewModelScope)
 
-        reverseDirectionFlow
-            .ignoreValuesFromViewModelLaunch()
-            .onEach { newValue -> withCol { newValue.updateConfig(config) } }
-            .launchIn(viewModelScope)
-
-        sortTypeFlow
-            .ignoreValuesFromViewModelLaunch()
-            .onEach { sortType -> withCol { sortType.save(config, prefs) } }
-            .launchIn(viewModelScope)
-
         flowOfCardsOrNotes
             .onEach { cardsOrNotes ->
                 Timber.d("loading columns for %s mode", cardsOrNotes)
@@ -525,10 +514,8 @@ class CardBrowserViewModel(
             val cardsOrNotes = withCol { CardsOrNotes.fromCollection(this@withCol) }
             flowOfCardsOrNotes.update { cardsOrNotes }
 
-            withCol {
-                sortTypeFlow.update { LegacySortType.fromCol(config, cardsOrNotes, prefs) }
-                reverseDirectionFlow.update { ReverseDirection.fromConfig(config) }
-            }
+            flowOfReverseDirection.update { (SortType.build(cardsOrNotes) as? SortType.CollectionOrdering)?.reverse }
+
             Timber.i("initCompleted")
 
             if (!manualInit) {
@@ -869,41 +856,17 @@ class CardBrowserViewModel(
         viewModelScope.launch {
             Timber.i("setting sort type: %s", sortType)
 
-            // Temporarily update legacy flows
-            sortTypeFlow.update { sortType.toLegacy() }
-            sortType.toLegacyReverse()?.let { newValue ->
-                reverseDirectionFlow.update { newValue }
-            }
-
             sortType.save(cardsOrNotes)
 
-            launchSearchForCards()
-        }
-
-    fun changeCardOrder(which: LegacySortType) {
-        val changeType =
-            when {
-                which != order -> ChangeCardOrder.OrderChange(which)
-                // if the same element is selected again, reverse the order
-                which != LegacySortType.NO_SORTING -> ChangeCardOrder.DirectionChange
-                else -> null
-            } ?: return
-
-        Timber.i("updating order: %s", changeType)
-
-        when (changeType) {
-            is ChangeCardOrder.OrderChange -> {
-                sortTypeFlow.update { which }
-                reverseDirectionFlow.update { ReverseDirection(orderAsc = false) }
-                launchSearchForCards()
-            }
-            ChangeCardOrder.DirectionChange -> {
-                reverseDirectionFlow.update { ReverseDirection(orderAsc = !orderAsc) }
-                cards.reverse()
-                viewModelScope.launch { flowOfSearchState.emit(SearchState.Completed) }
+            flowOfReverseDirection.update {
+                when (sortType) {
+                    is SortType.NoOrdering -> null
+                    is SortType.CollectionOrdering -> sortType.reverse
+                }
             }
+
+            launchSearchForCards()
         }
-    }
 
     /**
      * Updates the backend with a new collection of columns
@@ -1116,9 +1079,6 @@ class CardBrowserViewModel(
         return if (searchAdded) SaveSearchResult.SUCCESS else SaveSearchResult.ALREADY_EXISTS
     }
 
-    /** Ignores any values before [initCompleted] is set */
-    private fun <T> Flow<T>.ignoreValuesFromViewModelLaunch(): Flow<T> = this.filter { initCompleted }
-
     /**
      * Sets the filter query (legacy): 'is:suspended'
      */
@@ -1316,7 +1276,7 @@ class CardBrowserViewModel(
                 ) {
                     val searchString = withCol { searchRequestFlow.value.toSearchString().getOrThrow() }
                     flowOfSearchState.emit(SearchState.Searching)
-                    val sortOrder = order.toSortOrder()
+                    val sortOrder = SortType.buildSortOrder()
                     Timber.d("performing search: '%s'; order: %s", searchString, sortOrder)
                     val cards = com.ichi2.anki.searchForRows(searchString, sortOrder, cardsOrNotes)
                     Timber.d("Search returned %d card(s)", cards.size)
@@ -1498,14 +1458,6 @@ class CardBrowserViewModel(
         val count: Int,
     )
 
-    private sealed interface ChangeCardOrder {
-        data class OrderChange(
-            val sortType: LegacySortType,
-        ) : ChangeCardOrder
-
-        data object DirectionChange : ChangeCardOrder
-    }
-
     sealed class ChangeMultiSelectMode : Parcelable {
         val resultedInMultiSelect: Boolean get() =
             when (this) {