Bug 1830780 - Add support for adding distribution based default search engines list

Author: rocketsroger

android-components/components/browser/state/src/main/java/mozilla/components/browser/state/action/BrowserAction.kt

@@ -1398,8 +1398,9 @@ sealed class SearchAction : BrowserAction() {
 
     /**
      * Sets the [RegionState] (region of the user).
+     * distribution is a [String] that specifies a set of default search engines if available
      */
-    data class SetRegionAction(val regionState: RegionState) : SearchAction()
+    data class SetRegionAction(val regionState: RegionState, val distribution: String? = null) : SearchAction()
 
     /**
      * Sets the list of search engines and default search engine IDs.

android-components/components/feature/search/src/main/java/mozilla/components/feature/search/middleware/SearchMiddleware.kt

@@ -57,7 +57,7 @@ class SearchMiddleware(
         action: BrowserAction,
     ) {
         when (action) {
-            is SearchAction.SetRegionAction -> loadSearchEngines(context.store, action.regionState)
+            is SearchAction.SetRegionAction -> loadSearchEngines(context.store, action.regionState, action.distribution)
             is SearchAction.UpdateCustomSearchEngineAction -> saveCustomSearchEngine(action)
             is SearchAction.RemoveCustomSearchEngineAction -> removeCustomSearchEngine(action)
             is SearchAction.SelectSearchEngineAction -> updateSearchEngineSelection(action)
@@ -82,11 +82,14 @@ class SearchMiddleware(
     private fun loadSearchEngines(
         store: Store<BrowserState, BrowserAction>,
         region: RegionState,
+        distribution: String? = null,
     ) = scope.launch {
         val migrationValues = migration?.getValuesToMigrate()
         performCustomSearchEnginesMigration(migrationValues)
 
-        val regionBundle = async(ioDispatcher) { bundleStorage.load(region, coroutineContext = ioDispatcher) }
+        val regionBundle = async(ioDispatcher) {
+            bundleStorage.load(region, distribution = distribution, coroutineContext = ioDispatcher)
+        }
         val customSearchEngines = async(ioDispatcher) { customStorage.loadSearchEngineList() }
         val hiddenSearchEngineIds = async(ioDispatcher) { metadataStorage.getHiddenSearchEngines() }
         val additionalSearchEngineIds = async(ioDispatcher) { metadataStorage.getAdditionalSearchEngines() }
@@ -240,10 +243,14 @@ class SearchMiddleware(
     interface BundleStorage {
         /**
          * Loads the bundled search engines for the given [locale] and [region].
+         *
+         * If [distribution] is not null then attempt to load the bundled search engine for the
+         * [distribution] in the specified [locale] and [region] if available.
          */
         suspend fun load(
             region: RegionState,
             locale: Locale = Locale.getDefault(),
+            distribution: String? = null,
             coroutineContext: CoroutineContext = Dispatchers.IO,
         ): Bundle
 

android-components/components/feature/search/src/main/java/mozilla/components/feature/search/storage/BundledSearchEnginesStorage.kt

@@ -37,10 +37,11 @@ internal class BundledSearchEnginesStorage(
     override suspend fun load(
         region: RegionState,
         locale: Locale,
+        distribution: String?,
         coroutineContext: CoroutineContext,
     ): SearchMiddleware.BundleStorage.Bundle = withContext(coroutineContext) {
-        val localizedConfiguration = loadAndFilterConfiguration(context, region, locale)
-        val searchEngineIdentifiers = localizedConfiguration.visibleDefaultEngines
+        val localizedConfiguration = loadAndFilterConfiguration(context, region, locale, distribution)
+        val searchEngineIdentifiers = localizedConfiguration.visibleSearchEngines
 
         val searchEngines = loadSearchEnginesFromList(
             context,
@@ -92,7 +93,7 @@ internal class BundledSearchEnginesStorage(
 }
 
 private data class SearchEngineListConfiguration(
-    val visibleDefaultEngines: List<String>,
+    val visibleSearchEngines: List<String>,
     val searchOrder: List<String>,
     val searchDefault: String?,
 )
@@ -101,11 +102,13 @@ private fun loadAndFilterConfiguration(
     context: Context,
     region: RegionState,
     locale: Locale,
+    distribution: String?,
 ): SearchEngineListConfiguration {
     val config = context.assets.readJSONObject("search/list.json")
 
     val configBlocks = pickConfigurationBlocks(locale, config)
-    val jsonSearchEngineIdentifiers = getSearchEngineIdentifiersFromBlock(region, locale, configBlocks)
+    val jsonSearchEngineIdentifiers =
+        getSearchEngineIdentifiersFromBlock(region, locale, distribution, configBlocks)
 
     val searchOrder = getSearchOrderFromBlock(region, configBlocks)
     val searchDefault = getSearchDefaultFromBlock(region, configBlocks)
@@ -144,10 +147,12 @@ private fun pickConfigurationBlocks(
 private fun getSearchEngineIdentifiersFromBlock(
     region: RegionState,
     locale: Locale,
+    distribution: String?,
     configBlocks: Array<JSONObject>,
 ): JSONArray {
-    // Now test if there's an override for the region (if it's set)
-    return getArrayFromBlock(region, "visibleDefaultEngines", configBlocks)
+    // Now test if there's an override for the distribution or region (if it's set)
+    return distribution?.let { getArrayFromBlock(region, distribution, configBlocks) }
+        ?: getArrayFromBlock(region, "visibleDefaultEngines", configBlocks)
         ?: throw IllegalStateException("No visibleDefaultEngines using region $region and locale $locale")
 }
 

android-components/components/feature/search/src/test/java/mozilla/components/feature/search/middleware/SearchMiddlewareTest.kt

@@ -88,6 +88,37 @@ class SearchMiddlewareTest {
         assertNull(store.state.search.regionSearchEngines.find { it.name == "Yandex" })
     }
 
+    @Test
+    fun `WHEN distribution doesn't exist THEN Loads default search engines`() {
+        val searchMiddleware = SearchMiddleware(
+            testContext,
+            ioDispatcher = dispatcher,
+            customStorage = CustomSearchEngineStorage(testContext, dispatcher),
+        )
+
+        val store = BrowserStore(
+            middleware = listOf(searchMiddleware),
+        )
+
+        assertTrue(store.state.search.regionSearchEngines.isEmpty())
+
+        store.dispatch(
+            SearchAction.SetRegionAction(
+                RegionState("US", "US"),
+                "test",
+            ),
+        ).joinBlocking()
+
+        wait(store, dispatcher)
+
+        assertTrue(store.state.search.regionSearchEngines.isNotEmpty())
+        assertTrue(store.state.search.additionalAvailableSearchEngines.isEmpty())
+        assertTrue(store.state.search.additionalSearchEngines.isEmpty())
+
+        assertNotNull(store.state.search.regionSearchEngines.find { it.name == "Google" })
+        assertNull(store.state.search.regionSearchEngines.find { it.name == "Yandex" })
+    }
+
     @Test
     fun `Loads search engines for locale (en-AU)`() {
         Locale.setDefault(Locale("en", "AU"))