Bug 1990978 - Bring back the snackbar with Undo button for when a history item is deleted r=android-reviewers,jonalmeida

This patch essentially reverts this change from back in 143: https://phabricator.services.mozilla.com/D255847

The original patch removed the snackbar that was shown when user deleted one or multiple history items from the list. The complexity here lies in the fact that even though we visually remove the item from the list, under the hood we do not actually remove the item(s) until the snackbar is shown and has gone away. Instead, we add the item(s) to a pending list to be deleted "eventually".

Since the original patch simply removed the snackbar visually but did not actually change the logic under the hood to perform the deletion immediately, once user restarts the app, all of their presumably deleted history would reappear.

Given the severity of this issue I am going to reintroduce the snackbar to resolve this since it's the fastest and safest solution. We can then look into updating the entire logic stack to honor deletions immediately.

Differential Revision: https://phabricator.services.mozilla.com/D266738

Author: Gela

mobile/android/fenix/app/src/androidTest/java/org/mozilla/fenix/ui/HistoryTest.kt

@@ -103,6 +103,7 @@ class HistoryTest : TestSetup() {
             ) {
                 clickDeleteHistoryButton(firstWebPage.url.toString())
             }
+            verifySnackBarText(expectedText = "Deleted")
             verifyEmptyHistoryView()
         }
     }

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/library/history/HistoryFragment.kt

@@ -4,6 +4,7 @@
 
 package org.mozilla.fenix.library.history
 
+import android.R.id.undo
 import android.app.Dialog
 import android.content.DialogInterface
 import android.content.Intent
@@ -58,14 +59,21 @@ import androidx.paging.Pager
 import androidx.paging.PagingConfig
 import androidx.paging.PagingData
 import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Dispatchers.IO
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.mapNotNull
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 import mozilla.components.browser.state.action.AwesomeBarAction
 import mozilla.components.browser.state.action.AwesomeBarAction.EngagementFinished
 import mozilla.components.browser.state.action.EngineAction
+import mozilla.components.browser.state.action.HistoryMetadataAction
 import mozilla.components.browser.state.action.RecentlyClosedAction
 import mozilla.components.browser.state.state.searchEngines
+import mozilla.components.browser.state.store.BrowserStore
+import mozilla.components.browser.storage.sync.PlacesHistoryStorage
 import mozilla.components.compose.base.theme.AcornTheme
 import mozilla.components.compose.base.utils.BackInvokedHandler
 import mozilla.components.compose.browser.awesomebar.AwesomeBar
@@ -85,13 +93,15 @@ import mozilla.components.lib.state.ext.observeAsComposableState
 import mozilla.components.support.base.feature.UserInteractionHandler
 import mozilla.components.support.base.feature.ViewBoundFeatureWrapper
 import mozilla.components.support.ktx.android.view.hideKeyboard
+import mozilla.components.support.ktx.kotlin.toShortUrl
 import mozilla.components.ui.widgets.withCenterAlignedButtons
 import mozilla.telemetry.glean.private.NoExtras
 import org.mozilla.fenix.HomeActivity
 import org.mozilla.fenix.NavHostActivity
 import org.mozilla.fenix.R
 import org.mozilla.fenix.addons.showSnackBar
 import org.mozilla.fenix.browser.browsingmode.BrowsingMode
+import org.mozilla.fenix.components.AppStore
 import org.mozilla.fenix.components.QrScanFenixFeature
 import org.mozilla.fenix.components.StoreProvider
 import org.mozilla.fenix.components.VoiceSearchFeature
@@ -102,6 +112,7 @@ import org.mozilla.fenix.components.search.HISTORY_SEARCH_ENGINE_ID
 import org.mozilla.fenix.components.toolbar.BrowserToolbarEnvironment
 import org.mozilla.fenix.databinding.FragmentHistoryBinding
 import org.mozilla.fenix.ext.components
+import org.mozilla.fenix.ext.getRootView
 import org.mozilla.fenix.ext.nav
 import org.mozilla.fenix.ext.pixelSizeFor
 import org.mozilla.fenix.ext.requireComponents
@@ -128,6 +139,7 @@ import org.mozilla.fenix.search.SearchFragmentStore
 import org.mozilla.fenix.search.createInitialSearchFragmentState
 import org.mozilla.fenix.tabstray.Page
 import org.mozilla.fenix.theme.FirefoxTheme
+import org.mozilla.fenix.utils.allowUndo
 import org.mozilla.fenix.GleanMetrics.History as GleanHistory
 
 private const val MATERIAL_DESIGN_SCRIM = "#52000000"
@@ -242,6 +254,28 @@ class HistoryFragment : LibraryPageFragment<History>(), UserInteractionHandler,
         GleanHistory.opened.record(NoExtras())
     }
 
+    private fun showDeleteSnackbar(
+        items: Set<History>,
+    ) {
+        val appStore = requireComponents.appStore
+        val browserStore = requireComponents.core.store
+        val historyStorage = requireComponents.core.historyStorage
+
+        CoroutineScope(Dispatchers.Main).allowUndo(
+            view = requireActivity().getRootView()!!,
+            message = getMultiSelectSnackBarMessage(items),
+            undoActionTitle = getString(R.string.snackbar_deleted_undo),
+            onCancel = { undo(appStore = appStore, items = items) },
+            operation = {
+                delete(
+                    browserStore = browserStore,
+                    historyStorage = historyStorage,
+                    items = items,
+                )
+            },
+        )
+    }
+
     private fun onTimeFrameDeleted() {
         runIfFragmentIsAttached {
             historyView.historyAdapter.refresh()
@@ -587,6 +621,23 @@ class HistoryFragment : LibraryPageFragment<History>(), UserInteractionHandler,
         }
     }
 
+    private fun getMultiSelectSnackBarMessage(historyItems: Set<History>): String {
+        return if (historyItems.size > 1) {
+            getString(R.string.history_delete_multiple_items_snackbar)
+        } else {
+            val historyItem = historyItems.first()
+
+            String.format(
+                requireContext().getString(R.string.history_delete_single_item_snackbar),
+                if (historyItem is History.Regular) {
+                    historyItem.url.toShortUrl(requireComponents.publicSuffixList)
+                } else {
+                    historyItem.title
+                },
+            )
+        }
+    }
+
     override fun onBackPressed(): Boolean {
         // The state needs to be updated accordingly if Edit mode is active
         return if (historyStore.state.mode is HistoryFragmentState.Mode.Editing) {
@@ -635,6 +686,7 @@ class HistoryFragment : LibraryPageFragment<History>(), UserInteractionHandler,
         val appStore = requireContext().components.appStore
 
         appStore.dispatch(AppAction.AddPendingDeletionSet(items.toPendingDeletionHistory()))
+        showDeleteSnackbar(items)
     }
 
     private fun share(data: List<ShareData>) {
@@ -659,6 +711,34 @@ class HistoryFragment : LibraryPageFragment<History>(), UserInteractionHandler,
         )
     }
 
+    private suspend fun undo(appStore: AppStore, items: Set<History>) = withContext(IO) {
+        val pendingDeletionItems = items.map { it.toPendingDeletionHistory() }.toSet()
+        appStore.dispatch(AppAction.UndoPendingDeletionSet(pendingDeletionItems))
+    }
+
+    private suspend fun delete(
+        browserStore: BrowserStore,
+        historyStorage: PlacesHistoryStorage,
+        items: Set<History>,
+    ) = withContext(IO) {
+        historyStore.dispatch(HistoryFragmentAction.EnterDeletionMode)
+        for (item in items) {
+            when (item) {
+                is History.Regular -> historyStorage.deleteVisitsFor(item.url)
+                is History.Group -> {
+                    // NB: If we have non-search groups, this logic needs to be updated.
+                    historyProvider.deleteMetadataSearchGroup(item)
+                    browserStore.dispatch(
+                        HistoryMetadataAction.DisbandSearchGroupAction(searchTerm = item.title),
+                    )
+                }
+                // We won't encounter individual metadata entries outside of groups.
+                is History.Metadata -> {}
+            }
+        }
+        historyStore.dispatch(HistoryFragmentAction.ExitDeletionMode)
+    }
+
     private fun onDeleteTimeRange(selectedTimeFrame: RemoveTimeFrame?) {
         historyStore.dispatch(HistoryFragmentAction.DeleteTimeRange(selectedTimeFrame))
         historyStore.dispatch(HistoryFragmentAction.EnterDeletionMode)

mobile/android/fenix/app/src/main/res/values/strings.xml

@@ -1375,9 +1375,9 @@
     <!-- Text for the button to clear all history -->
     <string name="history_delete_all">Delete history</string>
     <!-- Text for the snackbar to confirm that multiple browsing history items has been deleted -->
-    <string name="history_delete_multiple_items_snackbar" tools:ignore="UnusedResources" moz:removedIn="143">History Deleted</string>
+    <string name="history_delete_multiple_items_snackbar">History Deleted</string>
     <!-- Text for the snackbar to confirm that a single browsing history item has been deleted. %1$s is the shortened URL of the deleted history item. -->
-    <string name="history_delete_single_item_snackbar" tools:ignore="UnusedResources" moz:removedIn="143">Deleted %1$s</string>
+    <string name="history_delete_single_item_snackbar">Deleted %1$s</string>
     <!-- Context description text for the button to delete a single history item -->
     <string name="history_delete_item">Delete</string>
     <!-- History multi select title in app bar