FR: Update WorkRequest [219446409]

Fixed

Feature Request

Status Update

No update yet.

Description

se...@google.com

created issue #1

Feb 14, 2022 11:17AM

WM should provide an ability to update WorkSpec in non-intrusive way, meaning:

don't cancel work if it is already running.
calculate period delay / initial delay from the original enqueue (not from the update time)

Currently it is impossible to implement outside of WM, because we don't expose enqueue time.

Comments

ap...@google.com <ap...@google.com> #2Mar 25, 2022 06:35PM

Yigit, do you have time to fix it?

reemission of the same liveData is racy

ap...@google.com <ap...@google.com> #3Apr 4, 2022 04:57PM

yea i'll take it.

ap...@google.com <ap...@google.com> #4Apr 4, 2022 04:57PM

Thanks for the detailed analysis. This may not be an issue anymore since we've started using Main.immediate there but I' not sure; I'll try to create a test case.

ap...@google.com <ap...@google.com> #5Apr 5, 2022 06:09PM

just emitting same live data reproduces the issue.

@Test
fun raceTest() {
val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData)
emitSource(subLiveData) //crashes
}
subject.addObserver().apply {
testScope.advanceUntilIdle()
}
}

ap...@google.com <ap...@google.com> #6Apr 7, 2022 09:19PM

With 2.2.0-alpha04 (that use Main.immediate), the issue seems to be still there (I tested it by calling emitSource() twice, like your test case)

ap...@google.com <ap...@google.com> #7Jun 12, 2022 04:02PM

yea sorry immediate does not fix it.
I actually have a WIP fix for it:

https://android-review.googlesource.com/c/platform/frameworks/support/+/1112186

if your case is the one i found (emitting same LiveData multiple times, as shown in #5) you can work around it by adding a dummy transformation.

val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData.map {it })
emitSource(subLiveData.map {it} )
}

ap...@google.com <ap...@google.com> #8Jun 13, 2022 05:42PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit af12e75e6b4110f48e44ca121466943909de8f06
Author: Yigit Boyar <yboyar@google.com>
Date: Tue Sep 03 12:58:11 2019

Fix coroutine livedata race condition

This CL fixes a bug in liveData builder where emitting same
LiveData source twice would make it crash because the second
emission registry could possibly happen before first one is
removed as source.

We fix it by using a suspending dispose function. It does feel
a bit hacky but we cannot make DisposableHandle.dispose async
and we do not want to block there. This does not mean that there
is a problem if developer disposes it manually since our emit
functions take care of making sure it disposes (and there is
no other way to add source to the underlying MediatorLiveData)

Bug: 140249349
Test: BuildLiveDataTest#raceTest_*

Change-Id: I0b464c242a583da4669af195cf2504e2adc4de40

M lifecycle/lifecycle-livedata-ktx/api/2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/current.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_current.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_current.txt
M lifecycle/lifecycle-livedata-ktx/src/main/java/androidx/lifecycle/CoroutineLiveData.kt
M lifecycle/lifecycle-livedata-ktx/src/test/java/androidx/lifecycle/BuildLiveDataTest.kt

https://android-review.googlesource.com/1112186

https://goto.google.com/android-sha1/af12e75e6b4110f48e44ca121466943909de8f06

ap...@google.com <ap...@google.com> #9Jun 14, 2022 10:07PM

Project: platform/frameworks/support
Branch: androidx-main

commit 1430b5a035fb33c4464e24396c547cf1efa9bbb3
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Mon Jun 13 15:03:55 2022

Read WorkSpec in advance in Processor

It is important for updates of periodic workers,
because in case of periodic workers workspec could be
updated during the run of the worker. So Worker should
have all required information at the moment of the start
in order to stay consistent.

bug: 219446409
Test: refactoring
Change-Id: I6a29381b20919cda88461c2960b74dd0b7107a26

M work/work-multiprocess/src/androidTest/java/androidx/work/multiprocess/RemoteListenableWorkerTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkContinuationImplTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/ControlledWorkerWrapperTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/workers/ConstraintTrackingWorkerTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkerWrapperTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/foreground/WorkerWrapperForegroundTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/Processor.java
M work/work-runtime/src/main/java/androidx/work/impl/WorkerWrapper.java
M work/work-multiprocess/src/androidTest/java/androidx/work/multiprocess/RemoteCoroutineWorkerTest.kt

https://android-review.googlesource.com/2123378

ap...@google.com <ap...@google.com> #10Jun 14, 2022 10:07PM

Project: platform/frameworks/support
Branch: androidx-main

commit 66fe06e58187191981ba3f17c8ac8e015a2aae26
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Mon Jun 06 14:37:30 2022

Introduce generation in WorkSpec

This was done in a preparation for updates of
WorkSpecs. It is important for a Worker to know
for which generation it was started:
otherwise it can lead to inconsistent runs,
e.g. old constraints were met and started a new
Worker.

bug: 219446409
Test: ProcessorTests
Change-Id: I2bf26fd7b0d368943a5d119a4183bbaf7a27ae64

M work/work-runtime/src/main/java/androidx/work/impl/utils/StopWorkRunnable.java
M work/work-runtime/src/main/java/androidx/work/impl/background/systemalarm/SystemAlarmDispatcher.java
A work/work-runtime/src/schemas/androidx.work.impl.WorkDatabase/16.json
M work/work-runtime/src/main/java/androidx/work/impl/background/systemjob/SystemJobScheduler.java
M work/work-runtime/src/main/java/androidx/work/impl/WorkDatabase.kt
M work/work-runtime/src/main/java/androidx/work/impl/model/SystemIdInfoDao.kt
M work/work-runtime/src/main/java/androidx/work/impl/WorkerWrapper.java
M work/work-runtime/src/main/java/androidx/work/impl/background/systemalarm/ConstraintsCommandHandler.java
M work/work-testing/src/main/java/androidx/work/testing/TestScheduler.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/utils/ForceStopRunnableTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/background/systemalarm/SystemAlarmDispatcherTest.java
M work/work-gcm/src/main/java/androidx/work/impl/background/gcm/WorkManagerGcmDispatcher.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/background/systemjob/SystemJobServiceTest.java
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkSpec.kt
M work/work-runtime/src/main/java/androidx/work/impl/utils/WorkTimer.java
M work/work-runtime/src/main/java/androidx/work/impl/model/SystemIdInfo.kt
M work/work-gcm/src/androidTest/java/androidx/work/impl/background/gcm/WorkManagerGcmDispatcherTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkSpecDao.kt
M work/work-runtime/src/main/java/androidx/work/impl/Processor.java
M work/work-runtime/src/main/java/androidx/work/impl/background/greedy/GreedyScheduler.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/ProcessorTests.kt
M work/work-runtime/src/main/java/androidx/work/impl/background/systemalarm/DelayMetCommandHandler.java
M work/work-runtime/src/main/java/androidx/work/impl/ExecutionListener.java
M work/work-runtime/src/main/java/androidx/work/impl/background/systemjob/SystemJobService.java
M work/work-runtime/src/main/java/androidx/work/impl/utils/WorkForegroundUpdater.java
M work/work-runtime/src/main/java/androidx/work/impl/StartStopToken.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/foreground/SystemForegroundDispatcherTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/background/systemalarm/CommandHandler.java
M work/work-runtime/src/main/java/androidx/work/impl/background/systemjob/SystemJobInfoConverter.java
M work/work-gcm/src/main/java/androidx/work/impl/background/gcm/GcmTaskConverter.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/background/greedy/GreedySchedulerTest.java
M work/work-runtime/src/main/java/androidx/work/impl/workers/DiagnosticsWorker.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/ProcessorTest.java
M work/work-runtime/src/main/java/androidx/work/impl/WorkManagerImpl.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/ControlledWorkerWrapperTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/foreground/SystemForegroundDispatcher.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/background/systemalarm/AlarmsTest.java
M work/work-runtime/src/main/java/androidx/work/impl/background/systemalarm/Alarms.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/background/systemalarm/WorkTimerTest.java
M work/work-runtime/src/main/java/androidx/work/impl/background/systemalarm/SystemAlarmScheduler.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkManagerImplLargeExecutorTest.java

https://android-review.googlesource.com/2115799

ap...@google.com <ap...@google.com> #11Jun 23, 2022 11:14PM

Project: platform/frameworks/support
Branch: androidx-main

commit e5de8cabaccc7a7ee8aaee8e6cb3e85da3be3212
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Thu Mar 31 16:52:26 2022

Initial commit for update work feature

Current implementation only updates `OneTimeWorkRequest`-s

Relnote: "`WorkManager.updateWork` was added to update work
preserving its original enqueue time and chaining.
Currently it supports only OneTimeWorkRequests."

bug: 219446409
Test: WorkUpdateTest

Change-Id: I9a2489e50d217cf70377d348b183ceb2d777506d

A work/work-runtime/src/androidTest/java/androidx/work/WorkUpdateTest.kt
M work/work-runtime/api/public_plus_experimental_current.txt
M work/work-runtime/src/main/java/androidx/work/WorkManager.java
M work/work-runtime/api/current.txt
A work/work-runtime/src/main/java/androidx/work/impl/WorkerUpdater.kt
M work/work-runtime/api/restricted_current.txt
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkTagDao.kt
M work/work-runtime/src/main/java/androidx/work/impl/WorkManagerImpl.java
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkSpecDao.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/constraints/WorkConstraintsTrackerTest.kt
M work/work-runtime/api/restricted_current.ignore
M work/work-runtime/src/main/java/androidx/work/impl/utils/EnqueueRunnable.java
M work/work-runtime/api/current.ignore
A work/work-runtime/src/androidTest/java/androidx/work/impl/testutils/TestConstraints.kt
M work/work-runtime/src/main/java/androidx/work/WorkRequest.kt

https://android-review.googlesource.com/2051581

ap...@google.com <ap...@google.com> #12Jun 28, 2022 12:44PM

Project: platform/frameworks/support
Branch: androidx-main

commit 75331425fcf02b5fb681a796a369a11325a86154
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Mon Jun 27 23:56:01 2022

Use correct WorkSpec in SystemForegroundDispatcher

Database can potentially have newer version of worker,
so we should rely on the spec of running worker instead.

Test: SystemForegroundDispatcherTest
bug: 219446409
Change-Id: I6144f1e604996407d51a92c1fb7e9a6c64577a92

M work/work-runtime/src/androidTest/java/androidx/work/impl/foreground/SystemForegroundDispatcherTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/foreground/SystemForegroundDispatcher.java
M work/work-runtime/src/main/java/androidx/work/impl/Processor.java
M work/work-runtime/src/main/java/androidx/work/impl/WorkerWrapper.java

https://android-review.googlesource.com/2137872

ap...@google.com <ap...@google.com> #13Jun 30, 2022 10:59AM

Project: platform/frameworks/support
Branch: androidx-main

commit bc2bc2a8efff9d46a2a070c4b11067b46a24279b
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Wed Jun 29 12:11:20 2022

Read tags along with WorkSpec in Processor

Otherwise due to the race, tags can be inconsistent
with the rest of properties of worker.

Test: WorkUpdateTest
bug: 219446409
Change-Id: Ieca7c5e1650a5ca16c643ca0b800a7ad2c984951

M work/work-multiprocess/src/androidTest/java/androidx/work/multiprocess/RemoteListenableWorkerTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/WorkUpdateTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkContinuationImplTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/ControlledWorkerWrapperTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/workers/ConstraintTrackingWorkerTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkerWrapperTest.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/foreground/WorkerWrapperForegroundTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/WorkerWrapper.java
M work/work-runtime/src/main/java/androidx/work/impl/Processor.java
M work/work-multiprocess/src/androidTest/java/androidx/work/multiprocess/RemoteCoroutineWorkerTest.kt

https://android-review.googlesource.com/2139532

ap...@google.com <ap...@google.com> #14Jul 7, 2022 04:22PM

Project: platform/frameworks/support
Branch: androidx-main

commit b75f2a988f93a687bd95c87ebdb6ec1d486c4f3c
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Thu Jul 07 16:39:25 2022

Preserve lastEnqueueTime during the update

Test: WorkUpdateTest
bug: 219446409
Change-Id: Ifdc6a4c105ee2c53b2538265f933fd02634e85c5

M work/work-runtime/src/androidTest/java/androidx/work/WorkUpdateTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/WorkerUpdater.kt

https://android-review.googlesource.com/2148159

ap...@google.com <ap...@google.com> #15Jul 12, 2022 10:48AM

Project: platform/frameworks/support
Branch: androidx-main

commit 3258084eefb45350a75e43d86798f2e757ba49a3
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Mon Jul 11 17:26:07 2022

Use ConstraintTrackingWorker in WorkManager.update

Test: WorkUpdateTest
bug: 219446409
Change-Id: Icbb073c77b5f529cb599d11ad74f4f8899eddbb4

M work/work-runtime/src/androidTest/java/androidx/work/WorkUpdateTest.kt
A work/work-runtime/src/main/java/androidx/work/impl/utils/EnqueueUtils.kt
M work/work-runtime/src/main/java/androidx/work/impl/utils/EnqueueRunnable.java
M work/work-runtime/src/main/java/androidx/work/impl/WorkerUpdater.kt

https://android-review.googlesource.com/2149993

ap...@google.com <ap...@google.com> #16Jul 13, 2022 11:19AM

Project: platform/frameworks/support
Branch: androidx-main

commit 4110a2f8612edcd105a72640d43b9c9ae00e727d
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Fri Jul 08 15:52:39 2022

Introduce ExistingPeriodicWorkPolicy.Update

It is very similar to previously existing
ExistingPeriodicWorkPolicy.REPLACE.

Test: WorkManagerImplTest + integration test-app
Relnote: "`ExistingPeriodicWorkPolicy.UPDATE` was
added. This policy allows to update a periodic work
by the name. It is similar existing `REPLACE`, but
is less intrusive: it doesn't cancel a worker if it
is currently running, it preserves enqueue time, so
initial delay and period are calculated from original
enqueue time, rather than update time. `REPLACE` was
deprecated to decrease a confusion between very similarly
named `REPLACE`and `UPDATE`. If you still want to keep
previous semantics of `REPLACE`,
newly added `CANCEL_AND_REENQUEUE` identical to `REPLACE`
can be used."
bug: 219446409

Change-Id: I985edc2cf7ac7c316932185f3fd0a3ca6660f2dc

M work/work-multiprocess/src/main/java/androidx/work/multiprocess/RemoteWorkManagerImpl.java
M work/work-multiprocess/src/main/java/androidx/work/multiprocess/RemoteWorkManagerClient.java
M work/work-runtime/api/public_plus_experimental_current.txt
M work/work-runtime/src/main/aidl/androidx/work/multiprocess/IWorkManagerImpl.aidl
M work/work-runtime/api/current.txt
M work/integration-tests/testapp/src/main/res/layout/activity_main.xml
M work/work-runtime/src/main/java/androidx/work/impl/WorkerUpdater.kt
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkTagDao.kt
M work/work-runtime/api/restricted_current.txt
M work/integration-tests/testapp/src/main/java/androidx/work/integration/testapp/MainActivity.java
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkManagerImplTest.java
M work/work-runtime/src/main/java/androidx/work/impl/WorkManagerImpl.java
M work/work-runtime/src/main/java/androidx/work/ExistingPeriodicWorkPolicy.kt
M work/work-runtime/src/main/java/androidx/work/impl/utils/EnqueueRunnable.java
M work/integration-tests/testapp/src/main/java/androidx/work/integration/testapp/RemoteService.kt
M work/integration-tests/testapp/src/main/res/values/donottranslate-strings.xml

https://android-review.googlesource.com/2149093

ap...@google.com <ap...@google.com> #17Aug 10, 2022 03:54PM

Project: platform/frameworks/support
Branch: androidx-main

commit 8e22db3e7a62008ab0c4c07ac3f682e0c1cc4dbf
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Mon Aug 08 15:39:16 2022

Add WorkerParameters.getGeneration

Relnote: """
`WorkerParameters.getGeneration()` was added that returns
a generation of a worker. A worker has multiple generations, if it was updated via
`WorkManager.updateWork` or `WorkManager.enqueueUniquePeriodicWork` using
`ExistingPeriodicWorkPolicy.UPDATE`.
This worker can possibly be of an older generation rather than latest known,
if an update has happened while this worker is running."""
bug: 219446409

Test: WorkUpdateTest#updateWorkerParameterGeneration
Change-Id: I128a9838067f3a1722a9460f52ef58fb0f98136c

M work/work-runtime/src/androidTest/java/androidx/work/WorkUpdateTest.kt
M work/work-multiprocess/src/main/java/androidx/work/multiprocess/parcelable/ParcelableWorkerParameters.java
M work/work-rxjava2/src/test/java/androidx/work/RxWorkerTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/workers/ConstraintTrackingWorkerTest.java
M work/work-rxjava3/src/test/java/androidx/work/rxjava3/RxForegroundInfoTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkerWrapperTest.java
M work/work-rxjava3/src/test/java/androidx/work/rxjava3/RxWorkerTest.kt
M work/work-rxjava3/src/test/java/androidx/work/rxjava3/SetCompletableProgressTest.kt
M work/work-runtime/api/public_plus_experimental_current.txt
M work/work-runtime/src/main/java/androidx/work/impl/WorkerWrapper.java
M work/work-runtime-ktx/src/androidTest/java/androidx/work/CoroutineWorkerTest.kt
M work/work-testing/src/main/java/androidx/work/testing/TestListenableWorkerBuilder.java
M work/work-runtime/api/current.txt
M work/work-runtime/src/main/java/androidx/work/impl/WorkerUpdater.kt
M work/work-rxjava2/src/test/java/androidx/work/RxForegroundInfoTest.kt
M work/work-runtime/api/restricted_current.txt
M work/work-multiprocess/src/androidTest/java/androidx/work/multiprocess/RemoteListenableWorkerTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/DefaultWorkerFactoryTest.java
M work/work-runtime/src/androidTest/java/androidx/work/DelegatingWorkerFactoryTest.kt
M work/work-rxjava2/src/test/java/androidx/work/SetCompletableProgressTest.kt
M work/work-runtime/src/androidTest/java/androidx/work/WorkForegroundRunnableTest.kt
M work/work-runtime/src/main/java/androidx/work/WorkerParameters.java

https://android-review.googlesource.com/2177783

dr...@gmail.com <dr...@gmail.com> #18Aug 12, 2022 05:17PM

I like the ability introduced in 2.8.0-alpha03 to update an existing work request, particularly a periodic work request.

I see that there is a new ExistingPeriodicWorkPolicy.UPDATE type as well as a new WorkManager.updateWork() method.

Can I ask: what is the difference between setting up a new work request and calling enqueueUniquePeriodicWork() (with the same name as the existing work request, and also passing ExistingPeriodicWorkPolicy.UPDATE as the work policy), versus calling updateWork() and passing the existing work request itself?

ap...@google.com <ap...@google.com> #19Aug 15, 2022 03:08PM

Project: platform/frameworks/support
Branch: androidx-main

commit cb25671d1f6f60aa0baf13e39a66496b28540915
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Thu Aug 11 15:21:26 2022

Add generation to WorkerInfo

Relnote: """
`WorkerInfo.getGeneration()` was added that returns
a generation of a worker. A worker has multiple generations, if it was updated via
`WorkManager.updateWork` or `WorkManager.enqueueUniquePeriodicWork` using
`ExistingPeriodicWorkPolicy.UPDATE`.
If the worker is currently running, it can possibly be of an older generation rather than
returned by this methof if an update has happened during an execution of this worker."""
bug: 219446409
Test: WorkUpdateTest

Change-Id: I665c5d480700dd682d1268ee88be124783fca70f

M work/work-multiprocess/src/main/java/androidx/work/multiprocess/parcelable/ParcelableWorkInfo.java
M work/work-runtime/api/restricted_current.txt
M work/work-runtime/src/androidTest/java/androidx/work/impl/WorkManagerImplTest.java
M work/work-runtime/src/androidTest/java/androidx/work/WorkUpdateTest.kt
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkSpec.kt
M work/work-runtime/src/main/java/androidx/work/impl/model/WorkSpecDao.kt
M work/work-multiprocess/src/androidTest/java/androidx/work/multiprocess/ParcelableWorkInfoTest.kt
M work/work-runtime/api/public_plus_experimental_current.txt
M work/work-runtime/src/main/java/androidx/work/WorkInfo.java
M work/work-runtime/api/current.txt

https://android-review.googlesource.com/2183459

se...@google.com <se...@google.com> Aug 15, 2022 03:09PM

Marked as fixed.

na...@google.com <na...@google.com> #20Sep 12, 2022 05:52PM

This bug was linked in a change in the following release(s):

androidx.work:work-multiprocess:2.8.0-alpha04
androidx.work:work-rxjava2:2.8.0-alpha04
androidx.work:work-rxjava3:2.8.0-alpha04

IssueTracker