Skip to content

Commit

Permalink
Update to WorkManager 1.0.0-alpha12
Browse files Browse the repository at this point in the history 
Use the new Result class in place of Payload.
  • Loading branch information
@ianhanniballake
ianhanniballake committed Dec 6, 2018
1 parent 7bcdc92 commit ab70bf8
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 50 deletions.
22 changes: 10 additions & 12 deletions android-client-common/src/main/java/com/google/android/apps/muzei/sync/ArtworkLoadWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import androidx.work.ExistingWorkPolicy
import androidx.work.NetworkType
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.PeriodicWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.WorkerParameters
import com.google.android.apps.muzei.api.internal.ProtocolConstants
Expand Down Expand Up @@ -98,24 +99,21 @@ class ArtworkLoadWorker(

override val coroutineContext = syncSingleThreadContext

override suspend fun doWork(): Payload {
override suspend fun doWork(): Result {
// Throttle artwork loads
delay(ARTWORK_LOAD_THROTTLE)
return Payload(loadArtwork())
}

private suspend fun loadArtwork(): Result {
// Now actually load the artwork
val database = MuzeiDatabase.getInstance(applicationContext)
val (authority) = database.providerDao()
.getCurrentProvider() ?: return Result.FAILURE
.getCurrentProvider() ?: return Result.failure()
if (BuildConfig.DEBUG) {
Log.d(TAG, "Artwork Load for $authority")
}
val contentUri = ProviderContract.getContentUri(authority)
try {
ContentProviderClientCompat.getClient(applicationContext, contentUri)?.use { client ->
val result = client.call(METHOD_GET_LOAD_INFO)
?: return Result.FAILURE
?: return Result.failure()
val maxLoadedArtworkId = result.getLong(KEY_MAX_LOADED_ARTWORK_ID, 0L)
val recentArtworkIds = RecentArtworkIdsConverter.fromString(
result.getString(KEY_RECENT_ARTWORK_IDS, ""))
Expand Down Expand Up @@ -144,7 +142,7 @@ class ArtworkLoadWorker(
}
client.call(METHOD_REQUEST_LOAD)
}
return Result.SUCCESS
return Result.success()
}
}
if (BuildConfig.DEBUG) {
Expand All @@ -155,7 +153,7 @@ class ArtworkLoadWorker(
// Is there any artwork at all?
if (allArtwork.count == 0) {
Log.w(TAG, "Unable to find any artwork for $authority")
return Result.FAILURE
return Result.failure()
}
// Okay so there's at least some artwork.
// Is it just the one artwork we're already showing?
Expand All @@ -167,7 +165,7 @@ class ArtworkLoadWorker(
if (BuildConfig.DEBUG) {
Log.i(TAG, "Provider $authority only has one artwork")
}
return Result.FAILURE
return Result.failure()
}
}
// At this point, we know there must be some artwork that isn't the current
Expand Down Expand Up @@ -202,7 +200,7 @@ class ArtworkLoadWorker(
Log.d(TAG, "Loaded $imageUri into id $artworkId")
}
client.call(METHOD_MARK_ARTWORK_LOADED, imageUri.toString())
return Result.SUCCESS
return Result.success()
}
}
}
Expand All @@ -215,7 +213,7 @@ class ArtworkLoadWorker(
} catch (e: Exception) {
Log.i(TAG, "Provider $authority crashed while retrieving artwork: ${e.message}")
}
return Result.RETRY
return Result.retry()
}

private suspend fun checkForValidArtwork(
Expand Down
15 changes: 6 additions & 9 deletions ...d-client-common/src/main/java/com/google/android/apps/muzei/sync/ProviderChangedWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import androidx.work.Constraints
import androidx.work.CoroutineWorker
import androidx.work.ExistingWorkPolicy
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.WorkerParameters
import androidx.work.workDataOf
Expand Down Expand Up @@ -170,7 +171,7 @@ class ProviderChangedWorker(

override val coroutineContext = syncSingleThreadContext

override suspend fun doWork(): Payload {
override suspend fun doWork(): Result {
val tag = inputData.getString(TAG) ?: ""
// First schedule the observer to pick up any changes fired
// by the work done in handleProviderChange
Expand All @@ -181,21 +182,17 @@ class ProviderChangedWorker(
}
}
// Now actually handle the provider change
return Payload(handleProviderChange(tag))
}

private suspend fun handleProviderChange(tag: String): Result {
val database = MuzeiDatabase.getInstance(applicationContext)
val provider = database.providerDao()
.getCurrentProvider() ?: return Result.FAILURE
.getCurrentProvider() ?: return Result.failure()
if (BuildConfig.DEBUG) {
Log.d(TAG, "Provider Change ($tag) for ${provider.authority}")
}
val contentUri = ProviderContract.getContentUri(provider.authority)
try {
ContentProviderClientCompat.getClient(applicationContext, contentUri)?.use { client ->
val result = client.call(METHOD_GET_LOAD_INFO)
?: return Result.RETRY
?: return Result.retry()
val lastLoadedTime = result.getLong(KEY_LAST_LOADED_TIME, 0L)
client.query(contentUri)?.use { allArtwork ->
val providerManager = ProviderManager.getInstance(applicationContext)
Expand Down Expand Up @@ -245,13 +242,13 @@ class ProviderChangedWorker(
// and haven't just called enqueueNext / enqueuePeriodic
client.call(ProtocolConstants.METHOD_REQUEST_LOAD)
}
return Result.SUCCESS
return Result.success()
}
}
} catch (e: Exception) {
Log.i(TAG, "Provider ${provider.authority} crashed while retrieving artwork: ${e.message}")
}
return Result.RETRY
return Result.retry()
}

private suspend fun isCurrentArtworkValid(
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ buildscript {
roomVersion = "2.0.0"
pagingVersion = "2.0.0"
navigationVersion = "1.0.0-alpha07"
workManagerVersion = "1.0.0-alpha11"
workManagerVersion = "1.0.0-alpha12"
playServicesWearableVersion = "16.0.1"
firebaseCoreVersion = "16.0.4"
firebasePerfVersion = "16.2.0"
Expand Down
7 changes: 4 additions & 3 deletions example-unsplash/src/main/java/com/example/muzei/unsplash/UnsplashExampleWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import androidx.core.net.toUri
import androidx.work.Constraints
import androidx.work.NetworkType
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.Worker
import androidx.work.WorkerParameters
Expand Down Expand Up @@ -53,12 +54,12 @@ class UnsplashExampleWorker(
UnsplashService.popularPhotos()
} catch (e: IOException) {
Log.w(TAG, "Error reading Unsplash response", e)
return Result.RETRY
return Result.retry()
}

if (photos.isEmpty()) {
Log.w(TAG, "No photos returned from API.")
return Result.FAILURE
return Result.failure()
}

val providerClient = ProviderContract.getProviderClient(
Expand All @@ -75,6 +76,6 @@ class UnsplashExampleWorker(
metadata = photo.user.links.webUri.toString()
}
})
return Result.SUCCESS
return Result.success()
}
}
13 changes: 6 additions & 7 deletions ...featured-art/src/main/java/com/google/android/apps/muzei/featuredart/FeaturedArtWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import androidx.work.CoroutineWorker
import androidx.work.ExistingWorkPolicy
import androidx.work.NetworkType
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.WorkerParameters
import com.google.android.apps.muzei.api.provider.Artwork
Expand Down Expand Up @@ -109,13 +110,11 @@ class FeaturedArtWorker(

override val coroutineContext = SINGLE_THREAD_CONTEXT

override suspend fun doWork(): Payload = Payload(loadFeaturedArt())

private fun loadFeaturedArt(): Result {
override suspend fun doWork(): Result {
val jsonObject: JSONObject?
try {
jsonObject = fetchJsonObject(QUERY_URL)
val imageUri = jsonObject.optString(KEY_IMAGE_URI) ?: return Result.SUCCESS
val imageUri = jsonObject.optString(KEY_IMAGE_URI) ?: return Result.success()
val artwork = Artwork().apply {
persistentUri = imageUri.toUri()
token = jsonObject.optString(KEY_TOKEN).takeUnless { it.isEmpty() } ?: imageUri
Expand All @@ -132,10 +131,10 @@ class FeaturedArtWorker(
.addArtwork(artwork)
} catch (e: JSONException) {
Log.e(TAG, "Error reading JSON", e)
return Result.RETRY
return Result.retry()
} catch (e: IOException) {
Log.e(TAG, "Error reading JSON", e)
return Result.RETRY
return Result.retry()
}

val nextTime: Date? = jsonObject.optString("nextTime")?.takeUnless {
Expand Down Expand Up @@ -170,7 +169,7 @@ class FeaturedArtWorker(
sp.edit {
putLong(PREF_NEXT_UPDATE_MILLIS, nextUpdateMillis)
}
return Result.SUCCESS
return Result.success()
}

@Throws(IOException::class, JSONException::class)
Expand Down
17 changes: 9 additions & 8 deletions source-gallery/src/main/java/com/google/android/apps/muzei/gallery/GalleryScanWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import androidx.core.content.ContextCompat
import androidx.exifinterface.media.ExifInterface
import androidx.work.ExistingWorkPolicy
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.Worker
import androidx.work.WorkerParameters
Expand Down Expand Up @@ -99,9 +100,9 @@ class GalleryScanWorker(
return if (chosenPhoto != null) {
scanChosenPhoto(providerClient, chosenPhoto)
deleteMediaUris(providerClient)
Result.SUCCESS
Result.success()
} else {
Result.FAILURE
Result.failure()
}
}
val chosenPhotos = GalleryDatabase.getInstance(applicationContext)
Expand All @@ -113,7 +114,7 @@ class GalleryScanWorker(
scanChosenPhoto(providerClient, chosenPhoto)
}
deleteMediaUris(providerClient)
return Result.SUCCESS
return Result.success()
}
return addMediaUri(providerClient)
}
Expand Down Expand Up @@ -230,7 +231,7 @@ class GalleryScanWorker(
if (ContextCompat.checkSelfPermission(applicationContext,
android.Manifest.permission.READ_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED) {
Log.w(TAG, "Missing read external storage permission.")
return Result.FAILURE
return Result.failure()
}
applicationContext.contentResolver.query(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
Expand All @@ -240,7 +241,7 @@ class GalleryScanWorker(
val count = data.count
if (count == 0) {
Log.d(TAG, "No photos in the gallery.")
return Result.FAILURE
return Result.failure()
}
val lastToken = providerClient.lastAddedArtwork?.token

Expand All @@ -259,17 +260,17 @@ class GalleryScanWorker(
providerClient.addArtwork(createArtwork(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
imageUri))
return Result.SUCCESS
return Result.success()
}
}
}
if (BuildConfig.DEBUG) {
Log.i(TAG, "Unable to find any other valid photos in the gallery")
}
return Result.FAILURE
return Result.failure()
} ?: run {
Log.w(TAG, "Empty cursor.")
return Result.FAILURE
return Result.failure()
}
}

Expand Down
3 changes: 2 additions & 1 deletion ...le/src/main/java/com/google/android/apps/muzei/complications/ArtworkComplicationWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import androidx.annotation.RequiresApi
import androidx.work.Constraints
import androidx.work.ExistingWorkPolicy
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.Worker
import androidx.work.WorkerParameters
Expand Down Expand Up @@ -78,6 +79,6 @@ class ArtworkComplicationWorker(
}
// Reschedule the job to listen for the next change
scheduleComplicationUpdate()
return Result.SUCCESS
return Result.success()
}
}
17 changes: 8 additions & 9 deletions wearable/src/main/java/com/google/android/apps/muzei/datalayer/DataLayerLoadWorker.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import android.content.pm.PackageManager
import android.net.Uri
import android.util.Log
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.Result
import androidx.work.WorkManager
import androidx.work.Worker
import androidx.work.WorkerParameters
Expand Down Expand Up @@ -57,9 +58,7 @@ class DataLayerLoadWorker(
}
}

override fun doWork(): Result = loadFromDataLayer()

private fun loadFromDataLayer(): Result {
override fun doWork(): Result {
if (BuildConfig.DEBUG) {
Log.d(TAG, "Loading artwork from the DataLayer")
}
Expand All @@ -71,7 +70,7 @@ class DataLayerLoadWorker(
if (BuildConfig.DEBUG) {
Log.i(TAG, "Error getting artwork DataItem")
}
return Result.FAILURE
return Result.failure()
}
val dataMap = dataItemBuffer.map {
DataMapItem.fromDataItem(it).dataMap
Expand All @@ -81,7 +80,7 @@ class DataLayerLoadWorker(
if (BuildConfig.DEBUG) {
Log.w(TAG, "No artwork datamap found.")
}
return Result.FAILURE
return Result.failure()
}
val result = Tasks.await<DataClient.GetFdForAssetResponse>(
dataClient.getFdForAsset(dataMap.getAsset("image")))
Expand All @@ -93,7 +92,7 @@ class DataLayerLoadWorker(
}
} catch (e: IOException) {
Log.e(TAG, "Unable to save asset to local storage", e)
return Result.FAILURE
return Result.failure()
} finally {
result.release()
}
Expand All @@ -112,13 +111,13 @@ class DataLayerLoadWorker(
Log.d(TAG, "Successfully wrote artwork to $artworkUri")
}
}
return Result.SUCCESS
return Result.success()
} catch (e: ExecutionException) {
Log.w(TAG, "Error getting artwork from Wear Data Layer", e)
return Result.FAILURE
return Result.failure()
} catch (e: InterruptedException) {
Log.w(TAG, "Error getting artwork from Wear Data Layer", e)
return Result.FAILURE
return Result.failure()
}
}
}

0 comments on commit ab70bf8

Please sign in to comment.