R8 removes enum class values, despite usage from generated code [339085669]

WAI

Bug

Status Update

No update yet.

Description

cc...@google.com

created issue #1

May 6, 2024 10:04PM

In tweaking proguard rules in androidx microbenchmarks, I noticed that some of our generated moshi code references to a values array are failing to resolve, and crashing at runtime:

> ./gradlew benchmark:benchmark-benchmark:installRelease && adb shell am instrument -w -r -e debug false -e newRunListenerMode true -e class 'androidx.benchmark.benchmark.TrivialJavaBenchmark' -e androidx.benchmark.output.enable true -e listener androidx.benchmark.junit4.InstrumentationResultsRunListener androidx.benchmark.benchmark.test/androidx.benchmark.junit4.AndroidBenchmarkRunner

Time: 9.563
There were 2 failures:
1) increment(androidx.benchmark.benchmark.TrivialJavaBenchmark)
java.lang.ExceptionInInitializerError
	at androidx.benchmark.junit4.BenchmarkRule$applyInternal$$inlined$Statement$1.evaluate(SourceFile:123)
	at androidx.test.rule.GrantPermissionRule$RequestPermissionStatement.evaluate(Unknown Source:11)
	at org.junit.rules.RunRules.evaluate(Unknown Source:2)
...
	at androidx.test.runner.AndroidJUnitRunner.onStart(SourceFile:134)
	at android.app.Instrumentation$InstrumentationThread.run(Instrumentation.java:2402)
Caused by: java.lang.RuntimeException: java.lang.NoSuchMethodException: androidx.benchmark.json.BenchmarkData$TestResult$ProfilerOutput$Type.values []
	at java.lang.Enum.enumValues(Enum.java:315)
...
	at androidx.benchmark.ResultWriter.<clinit>(SourceFile:20)
	... 31 more
Caused by: java.lang.NoSuchMethodException: androidx.benchmark.json.BenchmarkData$TestResult$ProfilerOutput$Type.values []
	at java.lang.Class.getMethod(Class.java:2937)
	at java.lang.Class.getDeclaredMethod(Class.java:2914)
	at java.lang.Enum.enumValues(Enum.java:312)
	... 64 more

# also repros with
#    ./gradlew benchmark:benchmark-benchmark:cC -P android.testInstrumentationRunnerArguments.class=androidx.benchmark.benchmark.TrivialJavaBenchmark
# but above makes crash stack clearer

Repro AndroidX CL, which just enables R8 in a trivial sample benchmark, and tweaks proguard rules to get it (almost) running: https://android-review.git.corp.google.com/c/platform/frameworks/support/+/3073538

Comments

cc...@google.com <cc...@google.com> #2May 6, 2024 10:22PM

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

ap...@google.com <ap...@google.com> #3May 6, 2024 10:53PM

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

commit 94a0e983d92bcc434b0fc1d697f5cd231805bc5c
Author: Chris Craik <ccraik@google.com>
Date: Mon May 06 15:12:42 2024

More improvements for benchmark proguard rules

Bug: 329126308
Bug: 339085669
Relnote: "Additional workaround rules added to microbench proguard
rules, including support for listener rules and other observed
warnings / errors."

Test: ./gradlew benchmark:benchmark-benchmark:installRelease && adb shell am instrument -w -r -e debug false -e newRunListenerMode true -e class 'androidx.benchmark.benchmark.TrivialJavaBenchmark' -e androidx.benchmark.output.enable true -e listener androidx.benchmark.junit4.InstrumentationResultsRunListener androidx.benchmark.benchmark.test/androidx.benchmark.junit4.AndroidBenchmarkRunner # after enabling R8 in the project

Change-Id: I14d8fe36a73ce04076da29eb792679651e895601

M benchmark/benchmark-junit4/proguard-rules.pro

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

ch...@google.com <ch...@google.com> #4May 7, 2024 07:34AM

Reassigned to ch...@google.com.

It looks like the benchmark may be missing the below standard rule for enums. Can you check if adding this rule solves the issue? IIRC this rule is part of the default proguard-android-optimize.txt, but maybe you are not using that?

-keepclassmembers,allowoptimization enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

cc...@google.com <cc...@google.com> #5May 7, 2024 10:44PM

Confirm that adding proguard-android-optimize.txt or those rules directly works around the issue.

I was missing it since I generally try to avoid proguard-android-optimize.txt since it is too inclusive in some cases.

Why are standard rules for enums necessary?

ze...@google.com <ze...@google.com> #6May 8, 2024 04:44AM

The Java standard library has implemented various parts of the enum by use of reflection within the runtime, so maintaining that behavior has required these rules in both Proguard and R8.

cc...@google.com <cc...@google.com> #7May 9, 2024 04:58PM

Is it possible for R8 to figure out which enum classes are potentially fed to such stl methods? If so, and the stl behavior is consistent (and stl using values to implement class.enumConstants seems reasonable), it would be nice to avoid this necessary configuration (even if studio gives it to you by default in the very stale proguard-android-optimize list).

Either that, or could make enum value/valueOf minification opt-in.

ze...@google.com <ze...@google.com> #8May 13, 2024 06:12AM

Unfortunately, we have not been able to come up with a safe/sound analysis that can determine when the rules are not needed. Conversely, we have no way of safely keeping the enums that is less conservative than the rules. There are clients that do not have these rules as they manually ensure that they have no usages of enums that would break. Thus we can't make the rules part of the compiler and we can't safely determine when they are needed. We are not happy with that situation, but we currently have no better alternatives.

cc...@google.com <cc...@google.com> #9May 13, 2024 11:40PM

Fair enough, feel free to close as WAI. Understand that the cost to migrate the default is non-zero, with minimal benefit.

ch...@google.com <ch...@google.com> May 14, 2024 07:31AM

Status: Won't Fix (Intended Behavior)

pr...@google.com <pr...@google.com> #10May 14, 2024 05:22PM

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

androidx.benchmark:benchmark-junit4:1.3.0-alpha05