Bugfix FXIOS-14615 [Trending Searches] only save recent searches in normal mode (backport #31620) (#31637)

* Bugfix FXIOS-14615 [Trending Searches] only save recent searches in normal mode (#31620)

(cherry picked from commit 6ac9979)

* fix: add back setupEditingAppState for backport

---------

Co-authored-by: Cyndi Chin <cgc95@cornell.edu>

Author: mergify[bot]

firefox-ios/Client/Frontend/Browser/Toolbars/Redux/ToolbarMiddleware.swift

@@ -168,8 +168,17 @@ final class ToolbarMiddleware: FeatureFlaggable {
             store.dispatch(action)
 
         case ToolbarActionType.didSubmitSearchTerm:
-            // After a user submits a search term, we want to record it in our history storage via recent search provider
-            guard let url = action.url, let searchTerm = action.searchTerm else { return }
+            // After a user submits a search term, we want to record it in our history storage via recent search provider.
+            // We only want to record when in normal mode since recent searches is not available for private mode.
+            guard let toolbarState = state.screenState(
+                ToolbarState.self,
+                for: .toolbar,
+                window: action.windowUUID
+            ) else {
+                return
+            }
+
+            guard let url = action.url, let searchTerm = action.searchTerm, !toolbarState.isPrivateMode else { return }
             recentSearchProvider.addRecentSearch(searchTerm, url: url.absoluteString)
 
         case ToolbarActionType.navigationMiddleButtonDidChange:

firefox-ios/firefox-ios-tests/Tests/ClientTests/Toolbar/ToolbarMiddlewareTests.swift

@@ -835,6 +835,51 @@ final class ToolbarMiddlewareTests: XCTestCase, StoreTestUtility {
         XCTAssertEqual(mockRecentSearchProvider.addRecentSearchCalledCount, 0)
     }
 
+    func test_didSubmitSearchTerm_forPrivateMode_withProperPayload_addsRecentSearchToHistoryStorage() {
+        mockStore = MockStoreForMiddleware(state: setupPrivateModeAppState())
+        StoreTestUtilityHelper.setupStore(with: mockStore)
+
+        let subject = createSubject(manager: toolbarManager)
+        let action = ToolbarAction(
+            url: URL(string: "https://example.com")!,
+            searchTerm: "cookies",
+            windowUUID: windowUUID,
+            actionType: ToolbarActionType.didSubmitSearchTerm
+        )
+
+        subject.toolbarProvider(mockStore.state, action)
+        XCTAssertEqual(mockRecentSearchProvider.addRecentSearchCalledCount, 0)
+    }
+
+    func test_didSubmitSearchTerm_forPrivateMode_withoutURL_doesNotAddRecentSearchToHistoryStorage() {
+        mockStore = MockStoreForMiddleware(state: setupPrivateModeAppState())
+        StoreTestUtilityHelper.setupStore(with: mockStore)
+
+        let subject = createSubject(manager: toolbarManager)
+        let action = ToolbarAction(
+            searchTerm: "cookies",
+            windowUUID: windowUUID,
+            actionType: ToolbarActionType.didSubmitSearchTerm
+        )
+
+        subject.toolbarProvider(mockStore.state, action)
+        XCTAssertEqual(mockRecentSearchProvider.addRecentSearchCalledCount, 0)
+    }
+
+    func test_didSubmitSearchTerm_forPrivateMode_withoutSearchTerm_doesNotAddRecentSearchToHistoryStorage() {
+        mockStore = MockStoreForMiddleware(state: setupPrivateModeAppState())
+        StoreTestUtilityHelper.setupStore(with: mockStore)
+
+        let subject = createSubject(manager: toolbarManager)
+        let action = ToolbarAction(
+            windowUUID: windowUUID,
+            actionType: ToolbarActionType.didSubmitSearchTerm
+        )
+
+        subject.toolbarProvider(mockStore.state, action)
+        XCTAssertEqual(mockRecentSearchProvider.addRecentSearchCalledCount, 0)
+    }
+
     // MARK: - Helpers
     private func createSubject(manager: ToolbarManager) -> ToolbarMiddleware {
         return ToolbarMiddleware(
@@ -900,6 +945,24 @@ final class ToolbarMiddlewareTests: XCTestCase, StoreTestUtility {
         }
     }
 
+    func setupPrivateModeAppState() -> AppState {
+        var toolbarState = ToolbarState(windowUUID: windowUUID)
+        toolbarState.isPrivateMode = true
+
+        return AppState(
+            activeScreens: ActiveScreensState(
+                screens: [
+                    .browserViewController(
+                        BrowserViewControllerState(
+                            windowUUID: windowUUID
+                        )
+                    ),
+                    .toolbar(toolbarState)
+                ]
+            )
+        )
+    }
+
     func setupEditingAppState() -> AppState {
         var addressBarState = AddressBarState(windowUUID: windowUUID)
         addressBarState.isEditing = true