This repository has been archived by the owner on Nov 1, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 473
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue #11698: Add an updater to periodically fetch the Contile Top Sites
- Loading branch information
1 parent
134f6a0
commit ab606d4
Showing
12 changed files
with
480 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
...ervice/contile/src/main/java/mozilla/components/service/contile/ContileTopSitesUpdater.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /* 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 mozilla.components.service.contile | ||
|
|
||
| import android.content.Context | ||
| import androidx.annotation.VisibleForTesting | ||
| import androidx.work.Constraints | ||
| import androidx.work.ExistingPeriodicWorkPolicy | ||
| import androidx.work.NetworkType | ||
| import androidx.work.PeriodicWorkRequestBuilder | ||
| import androidx.work.WorkManager | ||
| import mozilla.components.support.base.log.logger.Logger | ||
| import java.util.concurrent.TimeUnit | ||
|
|
||
| /** | ||
| * Provides functionality to schedule updates of Contile top sites. | ||
| * | ||
| * @property context A reference to the application context. | ||
| * @property provider An instance of [ContileTopSitesProvider] which provides access to the Contile | ||
| * services API for fetching top sites. | ||
| * @property frequency Optional [Frequency] that specifies how often the Contile top site updates | ||
| * should happen. | ||
| */ | ||
| class ContileTopSitesUpdater( | ||
| private val context: Context, | ||
| private val provider: ContileTopSitesProvider, | ||
| private val frequency: Frequency = Frequency(1, TimeUnit.DAYS) | ||
| ) { | ||
|
|
||
| private val logger = Logger("ContileTopSitesUpdater") | ||
|
|
||
| /** | ||
| * Starts a work request in the background to periodically update the list of | ||
| * Contile top sites. | ||
| */ | ||
| fun startPeriodicWork() { | ||
| ContileTopSitesUseCases.initialize(provider) | ||
|
|
||
| WorkManager.getInstance(context).enqueueUniquePeriodicWork( | ||
| PERIODIC_WORK_TAG, | ||
| ExistingPeriodicWorkPolicy.KEEP, | ||
| createPeriodicWorkRequest() | ||
| ) | ||
|
|
||
| logger.info("Started periodic work to update Contile top sites") | ||
| } | ||
|
|
||
| /** | ||
| * Stops the work request to periodically update the list of Contile top sites. | ||
| */ | ||
| fun stopPeriodicWork() { | ||
| ContileTopSitesUseCases.destroy() | ||
|
|
||
| WorkManager.getInstance(context).cancelUniqueWork(PERIODIC_WORK_TAG) | ||
|
|
||
| logger.info("Stopped periodic work to update Contile top sites") | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| internal fun createPeriodicWorkRequest() = | ||
| PeriodicWorkRequestBuilder<ContileTopSitesUpdaterWorker>( | ||
| repeatInterval = frequency.repeatInterval, | ||
| repeatIntervalTimeUnit = frequency.repeatIntervalTimeUnit | ||
| ).apply { | ||
| setConstraints(getWorkerConstraints()) | ||
| addTag(PERIODIC_WORK_TAG) | ||
| }.build() | ||
|
|
||
| @VisibleForTesting | ||
| internal fun getWorkerConstraints() = Constraints.Builder() | ||
| .setRequiresStorageNotLow(true) | ||
| .setRequiredNetworkType(NetworkType.CONNECTED) | ||
| .build() | ||
|
|
||
| companion object { | ||
| internal const val PERIODIC_WORK_TAG = "mozilla.components.service.contile.periodicWork" | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Indicates how often Contile top sites should be updated. | ||
| * | ||
| * @property repeatInterval Long indicating how often the update should happen. | ||
| * @property repeatIntervalTimeUnit The time unit of the [repeatInterval]. | ||
| */ | ||
| data class Frequency( | ||
| val repeatInterval: Long, | ||
| val repeatIntervalTimeUnit: TimeUnit | ||
| ) |
Oops, something went wrong.