API Review: Metalava doesn’t deprecate property properly [271441831]

Fixed

Bug

Status Update

No update yet.

Description

du...@google.com

created issue on behalf of an...@google.com #1

Mar 2, 2023 06:02PM

The getters and setters are marked @Deprecated properly, but the property itself in Metalava’s output is not.

If you have any clarifying questions or feedback, please reassign this issue back to android-api-council@google.com for a response.

Android API Council has been reviewing newly added APIs, and these questions/requests came up during a review of APIs associated with a Buganizer issue for which you are the assignee. To learn more about the API review process, including best practices for making API changes, visit http://go/android-api-bugs.

Comments

au...@google.com <au...@google.com> #2Mar 2, 2023 07:58PM

jsjeon@ do you know why that might be?

js...@google.com <js...@google.com> #3Mar 2, 2023 08:07PM

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.

au...@google.com <au...@google.com> #4Mar 2, 2023 10:45PM

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

js...@google.com <js...@google.com> Mar 3, 2023 07:35AM

Accepted by js...@google.com.

ap...@google.com <ap...@google.com> #5Mar 3, 2023 07:25PM

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

au...@google.com <au...@google.com> Mar 3, 2023 09:19PM

Marked as fixed.

ap...@google.com <ap...@google.com> #6Mar 6, 2023 06:16PM

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

ap...@google.com <ap...@google.com> #7Mar 6, 2023 06:16PM

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

pr...@google.com <pr...@google.com> #8Mar 22, 2023 08:24PM

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

pr...@google.com <pr...@google.com> #9Apr 19, 2023 06:12PM