WatchFaceType.DIGITAL and other constants within annotation types show as RestrictTo.Scope.LIBRARY [288750666]

Fixed

Bug

Status Update

No update yet.

Description

ia...@gmail.com

created issue #1

Jun 26, 2023 12:04AM

Component used: Wear-Watchface

Version used: 1.2.0-alpha08 or higher

After upgrading to Wear Watchface 1.2.0-alpha08 or higher, I noticed an error in Android Studio on both the WatchFaceType and CanvasType integers that they should only be used within the androidx.wear.watchface library:

Companion.DIGITAL can only be accessed from within the same library
(androidx.wear.watchface:watchface)

It appears this is an unintended side effect of this CL that marked those annotation classes as @RestrictTo(RestrictTo.Scope.LIBRARY).

Would it be possible to separate the constants (which really could just be on a regular Kotlin object, rather than as part of a companion object of a restricted class) from the restricted annotation class (which it doesn't matter what the class name of that annotation actually is)?

It is really annoying to have the red underlines in Android Studio and associated lint failures.

FWIW, I noticed that this does not apply to constants such as WatchFaceStyle.PROTECT_STATUS_BAR, but only to constants within a public annotation class that is restricted.

From this search, it appears this issue affects:

all WatchFaceType constants
all CanvasType constants
all TapType constants
all ComplicationsSlotBoundsType constants

Comments

al...@google.com <al...@google.com> #2Jun 26, 2023 09:14AM

Assigned to al...@google.com.

jsjeon@ do you know why that might be?

al...@google.com <al...@google.com> #3Jun 26, 2023 09:37AM

Accepted by al...@google.com.

Any concrete examples I can take a look at?

One possibility is, as explained at https://kotlinlang.org/docs/annotations.html#annotation-use-site-targets, property use-site target has a higher priority over field, and

but the property itself in Metalava's output is not.

here Metalava's output should be Java field and accessor methods, so I guess @Deprecated could be not properly propagated to field.

ap...@google.com <ap...@google.com> #4Jun 28, 2023 02:07PM

https://android-review.git.corp.google.com/c/platform/frameworks/support/+/2369848/12/wear/compose/compose-material/src/commonMain/kotlin/androidx/wear/compose/material/ScalingLazyListItemInfo.kt

and

https://android-review.git.corp.google.com/c/platform/frameworks/support/+/2369848/12/wear/compose/compose-material/api/current.txt#427

al...@google.com <al...@google.com> #5Jun 28, 2023 03:22PM

Marked as fixed.

Project: platform/tools/metalava
Branch: metalava-main

commit ac6b7a3779511b5be53c4f8dfbdfcdf1508764e6
Author: Jinseong Jeon <jsjeon@google.com>
Date: Thu Mar 02 23:37:39 2023

Propagate deprecation of containing class to property

...in the same way method/field are deprecated

Bug: 271441831
Test: unit test added
Change-Id: I899b80a484866a44be9aa244d00552ebce148335

M src/main/java/com/android/tools/metalava/ApiAnalyzer.kt
M src/test/java/com/android/tools/metalava/ApiFileTest.kt

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

ia...@gmail.com <ia...@gmail.com> #6Jun 28, 2023 04:17PM

Project: platform/prebuilts/androidx/external
Branch: androidx-main

commit b712ab052930d4900a7f060d67bbd3cee2933970
Author: Jinseong Jeon <jsjeon@google.com>
Date: Sun Mar 05 22:51:50 2023

Update Metalava for build ID 9692962

./development/importMaven/importMaven.sh \
--metalava-build-id 9692962 \
--redownload com.android.tools.metalava:metalava:1.0.0-alpha07

Bug: 271441831
Bug: 271662790
Change-Id: Ide5946ed2a6b4248ffe5e822c760ed0b05034afd

M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.jar
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.jar.md5
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.jar.sha1
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.module
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.module.md5
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.module.sha1
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.pom
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.pom.md5
M com/android/tools/metalava/metalava/1.0.0-alpha07/metalava-1.0.0-alpha07.pom.sha1

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

al...@google.com <al...@google.com> #7Jun 30, 2023 01:53PM

Status: Assigned (reopened)

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

commit 5d6108703fa3db420dde7b7ee805ca4172ed44fa
Author: Jinseong Jeon <jsjeon@google.com>
Date: Sun Mar 05 23:03:10 2023

Update current API signature after Metalava update

Relnote: propagation of @Deprecated class to property
Bug: 271441831
Test: ./gradlew updateApi
Change-Id: I882d15d1d0d17f2227262e682d05d9dc7d082e8a

M annotation/annotation-experimental/api/current.txt
M annotation/annotation-experimental/api/public_plus_experimental_current.txt
M annotation/annotation-experimental/api/restricted_current.txt
M compose/ui/ui-test/api/current.txt
M compose/ui/ui-test/api/public_plus_experimental_current.txt
M compose/ui/ui-test/api/restricted_current.txt
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_current.txt
M paging/paging-common/api/current.txt
M paging/paging-common/api/public_plus_experimental_current.txt
M paging/paging-common/api/restricted_current.txt
M paging/paging-runtime/api/current.txt
M paging/paging-runtime/api/public_plus_experimental_current.txt
M paging/paging-runtime/api/restricted_current.txt
M wear/compose/compose-material/api/current.txt
M wear/compose/compose-material/api/public_plus_experimental_current.txt
M wear/compose/compose-material/api/restricted_current.txt
M wear/watchface/watchface-client/api/current.txt
M wear/watchface/watchface-client/api/public_plus_experimental_current.txt
M wear/watchface/watchface-client/api/restricted_current.txt
M wear/watchface/watchface/api/current.txt
M wear/watchface/watchface/api/public_plus_experimental_current.txt
M wear/watchface/watchface/api/restricted_current.txt

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

al...@google.com <al...@google.com> Jun 30, 2023 03:13PM

Accepted by al...@google.com.

al...@google.com <al...@google.com> #8Jul 3, 2023 09:26AM

Marked as fixed.

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.wear.compose:compose-material:1.2.0-alpha07

Message last modified on Jul 3, 2023 09:27AM

ia...@gmail.com <ia...@gmail.com> #9Jul 3, 2023 07:23PM