Closes mozilla-mobile#11071: SearchUseCases: Delegate URL loads to SessionUseCases

This allows us to use the optimizations in SessionUseCases for searches too.

Author: pocmo

components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt

@@ -5,14 +5,14 @@
 package mozilla.components.feature.search
 
 import mozilla.components.browser.state.action.ContentAction
-import mozilla.components.browser.state.action.EngineAction
 import mozilla.components.browser.state.action.SearchAction
 import mozilla.components.browser.state.search.SearchEngine
 import mozilla.components.browser.state.selector.findTabOrCustomTab
 import mozilla.components.browser.state.state.SessionState
 import mozilla.components.browser.state.state.selectedOrDefaultSearchEngine
 import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.feature.search.ext.buildSearchUrl
+import mozilla.components.feature.session.SessionUseCases
 import mozilla.components.feature.tabs.TabsUseCases
 import mozilla.components.support.base.log.logger.Logger
 
@@ -21,7 +21,8 @@ import mozilla.components.support.base.log.logger.Logger
  */
 class SearchUseCases(
     store: BrowserStore,
-    tabsUseCases: TabsUseCases
+    tabsUseCases: TabsUseCases,
+    sessionUseCases: SessionUseCases
 ) {
     interface SearchUseCase {
         /**
@@ -36,7 +37,8 @@ class SearchUseCases(
 
     class DefaultSearchUseCase(
         private val store: BrowserStore,
-        private val tabsUseCases: TabsUseCases
+        private val tabsUseCases: TabsUseCases,
+        private val sessionUseCases: SessionUseCases
     ) : SearchUseCase {
         private val logger = Logger("DefaultSearchUseCase")
 
@@ -80,12 +82,7 @@ class SearchUseCases(
                 // If we got a `sessionId` then try to find the tab and load the search URL in it
                 val existingTab = store.state.findTabOrCustomTab(sessionId)
                 if (existingTab != null) {
-                    store.dispatch(
-                        EngineAction.LoadUrlAction(
-                            existingTab.id,
-                            searchUrl
-                        )
-                    )
+                    sessionUseCases.loadUrl(searchUrl, sessionId = existingTab.id)
                     existingTab.id
                 } else {
                     // If the tab with the provided id was not found then create a new tab
@@ -252,7 +249,7 @@ class SearchUseCases(
     }
 
     val defaultSearch: DefaultSearchUseCase by lazy {
-        DefaultSearchUseCase(store, tabsUseCases)
+        DefaultSearchUseCase(store, tabsUseCases, sessionUseCases)
     }
 
     val newTabSearch: NewTabSearchUseCase by lazy {

components/feature/search/src/test/java/mozilla/components/feature/search/SearchUseCasesTest.kt

@@ -7,7 +7,6 @@ package mozilla.components.feature.search
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import mozilla.components.browser.state.action.BrowserAction
 import mozilla.components.browser.state.action.ContentAction
-import mozilla.components.browser.state.action.EngineAction
 import mozilla.components.browser.state.action.TabListAction
 import mozilla.components.browser.state.search.RegionState
 import mozilla.components.browser.state.search.SearchEngine
@@ -19,6 +18,7 @@ import mozilla.components.browser.state.state.createTab
 import mozilla.components.browser.state.state.searchEngines
 import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.feature.search.ext.createSearchEngine
+import mozilla.components.feature.session.SessionUseCases
 import mozilla.components.feature.tabs.TabsUseCases
 import mozilla.components.support.test.ext.joinBlocking
 import mozilla.components.support.test.libstate.ext.waitUntilIdle
@@ -31,6 +31,7 @@ import org.junit.Assert.assertNull
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.mockito.Mockito.doReturn
 import org.mockito.Mockito.verify
 
 @RunWith(AndroidJUnit4::class)
@@ -40,6 +41,8 @@ class SearchUseCasesTest {
     private lateinit var store: BrowserStore
     private lateinit var useCases: SearchUseCases
     private lateinit var tabsUseCases: TabsUseCases
+    private lateinit var sessionUseCases: SessionUseCases
+    private lateinit var loadUrlUseCase: SessionUseCases.DefaultLoadUrlUseCase
 
     private val middleware = CaptureActionsMiddleware<BrowserState, BrowserAction>()
 
@@ -55,6 +58,9 @@ class SearchUseCasesTest {
         )
 
         tabsUseCases = mock()
+        sessionUseCases = mock()
+        loadUrlUseCase = mock()
+        doReturn(loadUrlUseCase).`when`(sessionUseCases).loadUrl
 
         store = BrowserStore(
             initialState = BrowserState(
@@ -67,7 +73,8 @@ class SearchUseCasesTest {
 
         useCases = SearchUseCases(
             store,
-            tabsUseCases
+            tabsUseCases,
+            sessionUseCases
         )
     }
 
@@ -88,8 +95,11 @@ class SearchUseCasesTest {
         useCases.defaultSearch(searchTerms)
         store.waitUntilIdle()
 
-        val loadUrlAction = middleware.findFirstAction(EngineAction.LoadUrlAction::class)
-        assertEquals(searchUrl, loadUrlAction.url)
+        verify(loadUrlUseCase).invoke(searchUrl, sessionId = "mozilla")
+
+        val searchTermsAccessAction = middleware.findFirstAction(ContentAction.UpdateSearchTermsAction::class)
+        assertEquals(searchTerms, searchTermsAccessAction.searchTerms)
+        assertEquals("mozilla", searchTermsAccessAction.sessionId)
     }
 
     @Test
@@ -213,7 +223,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         useCases.selectSearchEngine.invoke(
             store.findSearchEngineById("engine-d")
@@ -275,7 +285,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         assertEquals(6, store.state.search.searchEngines.size)
         assertEquals(3, store.state.search.availableSearchEngines.size)
@@ -328,7 +338,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         assertEquals(6, store.state.search.searchEngines.size)
         assertEquals(3, store.state.search.availableSearchEngines.size)
@@ -381,7 +391,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         assertEquals(6, store.state.search.searchEngines.size)
         assertEquals(3, store.state.search.availableSearchEngines.size)
@@ -439,7 +449,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         assertEquals(6, store.state.search.searchEngines.size)
         assertEquals(3, store.state.search.availableSearchEngines.size)
@@ -492,7 +502,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         assertEquals(6, store.state.search.searchEngines.size)
         assertEquals(3, store.state.search.availableSearchEngines.size)
@@ -545,7 +555,7 @@ class SearchUseCasesTest {
             )
         )
 
-        val useCases = SearchUseCases(store, mock())
+        val useCases = SearchUseCases(store, mock(), mock())
 
         assertEquals(6, store.state.search.searchEngines.size)
         assertEquals(3, store.state.search.availableSearchEngines.size)

samples/browser/src/main/java/org/mozilla/samples/browser/DefaultComponents.kt

@@ -190,7 +190,7 @@ open class DefaultComponents(private val applicationContext: Context) {
     }
 
     val searchUseCases by lazy {
-        SearchUseCases(store, tabsUseCases)
+        SearchUseCases(store, tabsUseCases, sessionUseCases)
     }
 
     val defaultSearchUseCase by lazy {

samples/compose-browser/src/main/java/org/mozilla/samples/compose/browser/Components.kt

@@ -46,7 +46,7 @@ class Components(
 
     val sessionUseCases by lazy { SessionUseCases(store) }
     val tabsUseCases by lazy { TabsUseCases(store) }
-    val searchUseCases by lazy { SearchUseCases(store, tabsUseCases) }
+    val searchUseCases by lazy { SearchUseCases(store, tabsUseCases, sessionUseCases) }
 
     val locationService by lazy { LocationService.default() }
 }