Add convenience methods to WorkQuery [199919736]

Fixed

Bug

Status Update

No update yet.

Description

fo...@google.com

created issue #1

Sep 14, 2021 07:37PM

https://osscs.corp.google.com/androidx/platform/frameworks/support/+/androidx-main:work/work-runtime/src/main/java/androidx/work/WorkQuery.java

Creating a WorkQuery to represent a simple request is quite verbose. Eg, for a single id:

WorkQuery.Builder.fromIds(ImmutableList.of(id)).build())

It would be more convenient if:

There was a method on WorkQuery static WorkQuery fromIds() which returned a fully-built WorkQuery for simple cases.
These methods used varargs fromIds(UUID ids...) to avoid needing to build a List inline.

WorkManager has convenience methods for querying with single-element parameters, but not multiple-elements, and RemoteWorkManager lacks these entirely.

Comments

se...@google.com <se...@google.com> Nov 4, 2021 01:03PM

Assigned to se...@google.com.

ap...@google.com <ap...@google.com> #2Nov 5, 2021 07:10PM

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

commit ab7a98dd33898f42fe3d5fd1a5454f0bcf0f8639
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Fri Nov 05 16:27:46 2021

Add convenience methods fromIds methods to WorkQuery.

bug:199919736
Test: RawWorkInfoDaoTest
Relnote: """
Helper methods `WorkQuery.fromIds` to create WorkQuery directly from ids
were added.
"""

Change-Id: Ie5bdf99ac193c9aa9179dcf629a46227fe876242

M work/work-runtime/api/restricted_current.txt
M work/work-runtime/src/androidTest/java/androidx/work/RawWorkInfoDaoTest.kt
M work/work-runtime/api/public_plus_experimental_current.txt
M work/work-runtime/src/main/java/androidx/work/WorkQuery.java
M work/work-runtime/api/current.txt

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

ap...@google.com <ap...@google.com> #3Dec 1, 2021 12:46PM

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

commit 898bf37fedbded08de1f4125efb4ea58dc6e4845
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Thu Nov 25 15:44:36 2021

Add convenience methods fromStates, fromTags, fromUniqueWorkNames methods to WorkQuery.

bug:199919736
Test: RawWorkInfoDaoTest
Relnote: """
Helper methods `WorkQuery.fromStates`, `WorkQuery.fromUniqueWorkNames`,
`WorkQuery.fromTags` were added to create WorkQuery directly.
"""

Change-Id: If48f2ae0a5523792a9abe21279084f895abe7c53

M work/work-runtime/api/restricted_current.txt
M work/work-runtime/src/androidTest/java/androidx/work/RawWorkInfoDaoTest.kt
M work/work-runtime/api/public_plus_experimental_current.txt
M work/work-runtime/src/main/java/androidx/work/WorkQuery.java
M work/work-runtime/api/current.txt

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

se...@google.com <se...@google.com> #4Dec 1, 2021 02:17PM

Marked as fixed.

WorkManager has convenience methods for querying with single-element parameters, but not multiple-elements, and RemoteWorkManager lacks these entirely.

I've added factory methods to WorkQuery, but haven't added methods to RemoteWorkManager, but I think it should be fine for now.

fo...@google.com <fo...@google.com> #5Dec 15, 2021 03:25AM

Migrated to the shorter methods today and they look a lot nicer, thanks.

tg...@gmail.com <tg...@gmail.com> #6Feb 3, 2023 02:18PM

This CR should be done since Dec 5, 2021 03:17PM, but the methods are still hidden, because they are listed in restricted_current.txt
Is this an intended behavior?

WorkQuery#Builder has some static from...(List<...> ...) methods taking lists as parameter. Maybe it would be good to move the new convenience methods to WorkQuery#Builder as well - and not forget to remove them from restricted_current.txt this time.

se...@google.com <se...@google.com> #7Feb 3, 2023 02:24PM

Which version of workmanager do you use? They're available since 2.8.0-alpha01

tg...@gmail.com <tg...@gmail.com> #8Feb 3, 2023 02:39PM

I see, its the stable from 2021 (2.7.x)