For mozilla-mobile#22078 Selecting search group in Jump back in switc…

…hes active tab

app/src/main/java/org/mozilla/fenix/home/recenttabs/controller/RecentTabController.kt

@@ -68,9 +68,12 @@ class DefaultRecentTabsController(
     }
 
     override fun handleRecentSearchGroupClicked(tabId: String) {
-        selectTabUseCase.invoke(tabId)
         metrics.track(Event.JumpBackInGroupTapped)
-        navController.navigate(HomeFragmentDirections.actionGlobalTabsTrayFragment())
+        navController.navigate(
+            HomeFragmentDirections.actionGlobalTabsTrayFragment(
+                focusGroupTabId = tabId
+            )
+        )
     }
 
     @VisibleForTesting(otherwise = PRIVATE)

app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayFragment.kt

@@ -123,7 +123,8 @@ class TabsTrayFragment : AppCompatDialogFragment() {
         tabsTrayStore = StoreProvider.get(this) {
             TabsTrayStore(
                 initialState = TabsTrayState(
-                    mode = initialMode
+                    mode = initialMode,
+                    focusGroupTabId = args.selectedSearchGroupTabId
                 )
             )
         }

app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayStore.kt

@@ -18,11 +18,13 @@ import mozilla.components.lib.state.Store
  * currently selected tabs.
  * @property syncing Whether the Synced Tabs feature should fetch the latest tabs from paired
  * devices.
+ * @property focusGroupTabId The search group tab id to focus. Defaults to null.
  */
 data class TabsTrayState(
     val selectedPage: Page = Page.NormalTabs,
     val mode: Mode = Mode.Normal,
-    val syncing: Boolean = false
+    val syncing: Boolean = false,
+    val focusGroupTabId: String? = null
 ) : State {
 
     /**
@@ -119,6 +121,11 @@ sealed class TabsTrayAction : Action {
      * no sync action was able to be performed.
      */
     object SyncCompleted : TabsTrayAction()
+
+    /**
+     * Removes the [TabsTrayState.focusGroupTabId] of the [TabsTrayState].
+     */
+    object ConsumeSelectedSearchGroupTabIdAction : TabsTrayAction()
 }
 
 /**
@@ -149,6 +156,8 @@ internal object TabsTrayReducer {
                 state.copy(syncing = true)
             is TabsTrayAction.SyncCompleted ->
                 state.copy(syncing = false)
+            is TabsTrayAction.ConsumeSelectedSearchGroupTabIdAction ->
+                state.copy(focusGroupTabId = null)
         }
     }
 }

app/src/main/java/org/mozilla/fenix/tabstray/viewholders/NormalBrowserPageViewHolder.kt

@@ -17,6 +17,7 @@ import org.mozilla.fenix.components.appstate.AppAction
 import org.mozilla.fenix.components.AppStore
 import org.mozilla.fenix.ext.settings
 import org.mozilla.fenix.selection.SelectionHolder
+import org.mozilla.fenix.tabstray.TabsTrayAction
 import org.mozilla.fenix.tabstray.TabsTrayInteractor
 import org.mozilla.fenix.tabstray.TabsTrayStore
 import org.mozilla.fenix.tabstray.browser.containsTabId
@@ -84,6 +85,10 @@ class NormalBrowserPageViewHolder(
         val searchTermTabGroupsAreEnabled = containerView.context.settings().searchTermTabGroupsAreEnabled
 
         val selectedTab = browserStore.state.selectedNormalTab ?: return
+        // It's safe to read the state directly (i.e. won't cause bugs because of the store actions
+        // processed on a separate thread) instead of observing it because this value is only set during
+        // the initialState of the TabsTrayStore being created.
+        val selectedSearchGroupTabId = tabsTrayStore.state.focusGroupTabId
 
         // Update tabs into the inactive adapter.
         if (inactiveTabsAreEnabled && selectedTab.isNormalTabInactive(maxActiveTime)) {
@@ -106,7 +111,13 @@ class NormalBrowserPageViewHolder(
         }
 
         // Updates tabs into the search term group adapter.
-        if (searchTermTabGroupsAreEnabled && selectedTab.isNormalTabActiveWithSearchTerm(maxActiveTime)) {
+        if (searchTermTabGroupsAreEnabled && (
+            !selectedSearchGroupTabId.isNullOrEmpty() ||
+                selectedTab.isNormalTabActiveWithSearchTerm(maxActiveTime)
+            )
+        ) {
+            val tabId = selectedSearchGroupTabId ?: selectedTab.id
+
             tabGroupAdapter.observeFirstInsert {
                 // With a grouping, we need to use the list of the adapter that is already grouped
                 // together for the UI, so we know the final index of the grouping to scroll to.
@@ -117,35 +128,40 @@ class NormalBrowserPageViewHolder(
                 // [DiffUtil.calculateDiff] directly to submit a changed list which evades the `ListAdapter` from being
                 // notified of updates, so it therefore returns an empty list.
                 tabGroupAdapter.currentList.forEachIndexed { groupIndex, group ->
-                    if (group.containsTabId(selectedTab.id)) {
+                    if (group.containsTabId(tabId)) {
 
                         // Index is based on tabs above (inactive) with our calculated index.
                         val indexToScrollTo = inactiveTabAdapter.itemCount + groupIndex
                         layoutManager.scrollToPosition(indexToScrollTo)
 
+                        if (selectedSearchGroupTabId != null) {
+                            tabsTrayStore.dispatch(TabsTrayAction.ConsumeSelectedSearchGroupTabIdAction)
+                        }
                         return@observeFirstInsert
                     }
                 }
             }
         }
 
-        // Updates tabs into the normal browser tabs adapter.
-        browserAdapter.observeFirstInsert {
-            val activeTabsList = browserStore.state.getNormalTrayTabs(
-                searchTermTabGroupsAreEnabled,
-                inactiveTabsAreEnabled
-            )
-            activeTabsList.forEachIndexed { tabIndex, trayTab ->
-                if (trayTab.id == selectedTab.id) {
-
-                    // Index is based on tabs above (inactive + groups + header) with our calculated index.
-                    val indexToScrollTo = inactiveTabAdapter.itemCount +
-                        tabGroupAdapter.itemCount +
-                        headerAdapter.itemCount + tabIndex
+        if (selectedSearchGroupTabId.isNullOrEmpty()) {
+            // Updates tabs into the normal browser tabs adapter.
+            browserAdapter.observeFirstInsert {
+                val activeTabsList = browserStore.state.getNormalTrayTabs(
+                    searchTermTabGroupsAreEnabled,
+                    inactiveTabsAreEnabled
+                )
+                activeTabsList.forEachIndexed { tabIndex, trayTab ->
+                    if (trayTab.id == selectedTab.id) {
+
+                        // Index is based on tabs above (inactive + groups + header) with our calculated index.
+                        val indexToScrollTo = inactiveTabAdapter.itemCount +
+                            tabGroupAdapter.itemCount +
+                            headerAdapter.itemCount + tabIndex
 
-                    layoutManager.scrollToPosition(indexToScrollTo)
+                        layoutManager.scrollToPosition(indexToScrollTo)
 
-                    return@observeFirstInsert
+                        return@observeFirstInsert
+                    }
                 }
             }
         }

app/src/main/res/navigation/nav_graph.xml

@@ -150,6 +150,11 @@
             android:name="enterMultiselect"
             android:defaultValue="false"
             app:argType="boolean" />
+        <argument
+            android:name="focusGroupTabId"
+            app:nullable="true"
+            android:defaultValue="@null"
+            app:argType="string" />
     </dialog>
 
     <fragment

app/src/test/java/org/mozilla/fenix/tabstray/TabsTrayStoreReducerTest.kt

@@ -0,0 +1,23 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package org.mozilla.fenix.tabstray
+
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+class TabsTrayStoreReducerTest {
+    @Test
+    fun `GIVEN selectedSearchGroupTabId WHEN ConsumeSelectedSearchGroupTabIdAction THEN selectedSearchGroupTabId must be consumed`() {
+        val initialState = TabsTrayState(focusGroupTabId = "id")
+        val expectedState = initialState.copy(focusGroupTabId = null)
+
+        val resultState = TabsTrayReducer.reduce(
+            initialState,
+            TabsTrayAction.ConsumeSelectedSearchGroupTabIdAction
+        )
+
+        assertEquals(expectedState, resultState)
+    }
+}