Issue mozilla-mobile#11605: Add option to include provided top sites …

…in TopSitesConfig
gabrielluong · Jan 25, 2022 · cd0f1ce · cd0f1ce
1 parent c581640
commit cd0f1ce
Show file tree

Hide file tree

Showing 6 changed files with 271 additions and 14 deletions.
diff --git a/...re/top-sites/src/main/java/mozilla/components/feature/top/sites/DefaultTopSitesStorage.kt b/...re/top-sites/src/main/java/mozilla/components/feature/top/sites/DefaultTopSitesStorage.kt
@@ -86,6 +86,7 @@ class DefaultTopSitesStorage(
     @Suppress("TooGenericExceptionCaught")
     override suspend fun getTopSites(
         totalSites: Int,
+        fetchProvidedTopSites: Boolean,
         frecencyConfig: FrecencyThresholdOption?
     ): List<TopSite> {
         val topSites = ArrayList<TopSite>()
@@ -94,9 +95,9 @@ class DefaultTopSitesStorage(
 
         topSites.addAll(pinnedSites)
 
-        topSitesProvider?.let { provider ->
+        if (fetchProvidedTopSites && topSitesProvider != null) {
             try {
-                val providerTopSites = provider.getTopSites()
+                val providerTopSites = topSitesProvider.getTopSites()
                 topSites.addAll(providerTopSites.take(numSitesRequired))
                 numSitesRequired -= providerTopSites.size
             } catch (e: Exception) {

diff --git a/...ts/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/TopSitesConfig.kt b/...ts/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/TopSitesConfig.kt
@@ -11,11 +11,13 @@ import mozilla.components.concept.storage.FrecencyThresholdOption
  * whether or not to include top frecent sites in the top sites feature.
  *
  * @property totalSites A total number of sites that will be displayed.
+ * @property fetchProvidedTopSites Whether or not to fetch top sites from the [TopSitesProvider].
  * @property frecencyConfig If [frecencyConfig] is specified, only visited sites with a frecency
  * score above the given threshold will be returned. Otherwise, frecent top site results are
  * not included.
  */
 data class TopSitesConfig(
     val totalSites: Int,
+    val fetchProvidedTopSites: Boolean,
     val frecencyConfig: FrecencyThresholdOption?
 )
diff --git a/...s/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/TopSitesStorage.kt b/...s/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/TopSitesStorage.kt
@@ -4,6 +4,7 @@
 
 package mozilla.components.feature.top.sites
 
+import mozilla.components.browser.storage.sync.PlacesHistoryStorage
 import mozilla.components.concept.storage.FrecencyThresholdOption
 import mozilla.components.support.base.observer.Observable
 
@@ -42,12 +43,14 @@ interface TopSitesStorage : Observable<TopSitesStorage.Observer> {
      * If `frecencyConfig` is specified, fill in any missing top sites with frecent top site results.
      *
      * @param totalSites A total number of sites that will be retrieve if possible.
+     * @param fetchProvidedTopSites Whether or not to fetch top sites from the [TopSitesProvider].
      * @param frecencyConfig If [frecencyConfig] is specified, only visited sites with a frecency
      * score above the given threshold will be returned. Otherwise, frecent top site results are
      * not included.
      */
     suspend fun getTopSites(
         totalSites: Int,
+        fetchProvidedTopSites: Boolean,
         frecencyConfig: FrecencyThresholdOption?
     ): List<TopSite>
 

diff --git a/.../src/main/java/mozilla/components/feature/top/sites/presenter/DefaultTopSitesPresenter.kt b/.../src/main/java/mozilla/components/feature/top/sites/presenter/DefaultTopSitesPresenter.kt
@@ -46,6 +46,7 @@ internal class DefaultTopSitesPresenter(
         scope.launch {
             val topSites = storage.getTopSites(
                 innerConfig.totalSites,
+                innerConfig.fetchProvidedTopSites,
                 innerConfig.frecencyConfig
             )