Experimental annotation should support / be compatible with @OptIn [151331381]

Fixed

Feature Request

Status Update

No update yet.

Description

du...@google.com

created issue #1

Mar 12, 2020 06:30PM

As of Kotlin 1.3.70 @UseExperimental has been deprecated in favor of @OptIn.

We should update our docs / recommendations for kotlin users accordingly in our Java @Experimental library and add lint compatibility with @OptIn.

Progress for upgrading AndroidX to Kotlin 1.3.70 can be tracked here: https://android-review.googlesource.com/c/platform/frameworks/support/+/1255674

Comments

al...@google.com <al...@google.com> #2Mar 12, 2020 06:41PM

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

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

ni...@google.com <ni...@google.com> #3Mar 12, 2020 07:49PM

I agree with Alan, the @OptIn does not imply the experimental/subject-to-change nature of our APIs tagged with the annotation. +1 to @Alpha

du...@google.com <du...@google.com> #4Mar 13, 2020 09:27AM

To be clear I'm not suggesting that we change the name to @OptIn, just that we make sure we support and are compatible with kotlin's @OptIn.

Also any kotlin samples and documentation we have should point to @OptIn over @UseExperimental.

al...@google.com <al...@google.com> #5Mar 13, 2020 03:00PM

Re #4, understood. My argument in #2 is against my own default reaction to the change.

For docs, I can go ahead and update the API guidelines. Though... our own @UseExperimental annotation works in Kotlin as well. If we're going to diverge from @OptIn for Java, it may be better to consistently use one annotation across both languages.

al...@google.com <al...@google.com> Jul 28, 2020 06:54PM

Accepted by al...@google.com.

al...@google.com <al...@google.com> #6Oct 6, 2020 06:49PM

Merged! That was awful.

ap...@google.com <ap...@google.com> #7Oct 6, 2020 06:52PM

Marked as fixed.

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

commit 89b60486595decdd61d718aee5d4276c2803cb89
Author: Alan Viverette <alanv@google.com>
Date: Mon Oct 05 21:00:39 2020

Update annotation-experimental to support RequiresOptIn

Fixes: 151331381
Test: RequiresOptInDetectorTest
Relnote: "The androidx variant of the Experimental annotation has been
deprecated to provide parity with Kotlin. It has been replaced by the
RequiresOptIn annotation, and the Java-facing linter has been updated to
support both the new Kotlin annotation and the new androidx variant."

Change-Id: I52495721777cf9d2243a825fc491e59c031d2e96

M annotation/annotation-experimental-lint/integration-tests/build.gradle
A annotation/annotation-experimental-lint/integration-tests/lint-baseline.xml
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/DateProvider.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/DateProviderKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/ExperimentalDateTime.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/ExperimentalDateTimeKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/ExperimentalLocation.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/ExperimentalLocationKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/LocationProvider.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/LocationProviderKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/TimeProviderKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/UseJavaExperimentalFromJava.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/UseJavaExperimentalFromKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/UseJavaPackageFromJava.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/UseJavaPackageFromKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/UseKtExperimentalFromJava.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/foo/Bar.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/foo/ExperimentalPackage.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/experimental/foo/package-info.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/DateProvider.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/DateProviderKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/ExperimentalDateTime.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/ExperimentalDateTimeKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/ExperimentalLocation.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/ExperimentalLocationKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/LocationProvider.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/LocationProviderKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/TimeProviderKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/UseJavaExperimentalFromJava.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/UseJavaExperimentalFromKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/UseJavaPackageFromJava.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/UseJavaPackageFromKt.kt
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/UseKtExperimentalFromJava.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/foo/Bar.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/foo/ExperimentalPackage.java
M annotation/annotation-experimental-lint/integration-tests/src/main/java/sample/optin/foo/package-info.java
M annotation/annotation-experimental-lint/src/main/java/androidx/annotation/experimental/lint/ExperimentalDetector.kt
M annotation/annotation-experimental-lint/src/test/kotlin/androidx/annotation/experimental/lint/ExperimentalDetectorTest.kt
A annotation/annotation-experimental-lint/src/test/kotlin/androidx/annotation/experimental/lint/RequiresOptInDetectorTest.kt
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
A annotation/annotation-experimental/src/main/java/androidx/annotation/OptIn.kt
A annotation/annotation-experimental/src/main/java/androidx/annotation/RequiresOptIn.kt
M annotation/annotation-experimental/src/main/java/androidx/annotation/experimental/Experimental.kt
M annotation/annotation-experimental/src/main/java/androidx/annotation/experimental/UseExperimental.kt
M camera/camera-camera2-pipe-integration/src/androidTest/java/androidx/camera/camera2/pipe/integration/InitializationTest.kt
M camera/camera-lifecycle/src/androidTest/java/androidx/camera/lifecycle/ProcessCameraProviderTest.kt
M camera/camera-lifecycle/src/main/java/androidx/camera/lifecycle/ExperimentalCameraProviderConfiguration.java
M camera/camera-lifecycle/src/main/java/androidx/camera/lifecycle/ExperimentalUseCaseGroupLifecycle.java
M camera/camera-lifecycle/src/main/java/androidx/camera/lifecycle/ProcessCameraProvider.java
M paging/samples/src/main/java/androidx/paging/samples/java/RemoteMediatorGuavaItemKeyedSample.java
M paging/samples/src/main/java/androidx/paging/samples/java/RemoteMediatorGuavaPageKeyedSample.java
M paging/samples/src/main/java/androidx/paging/samples/java/RemoteMediatorRxItemKeyedSample.java
M paging/samples/src/main/java/androidx/paging/samples/java/RemoteMediatorRxPageKeyedSample.java

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