Clarify failures on devices misconfigured for tracing/compilation [282191686]

Fixed

Bug

Status Update

No update yet.

Description

cc...@google.com

created issue #1

May 12, 2023 05:48PM

Since fixes are slow to roll out, we should have benchmark clearly tell people they're using unsupported emulators if they run into the following bugs:

b/272339637 b/244619933

For the tracing issue, if perfetto capture start fails, do something like:

if (!File("/sys/kernel/debug/tracing/trace_marker").exists() && !File("/sys/kernel/tracing/trace_marker").exists()) {
    val deviceType = DeviceInfo.isEmulator ? "emulator" : "device"
    throw IllegalStateException("This $deviceType system image is misconfigured, and doesn't support tracing. Try a different $deviceType (or updating, if possible).")
}

And add something similar for the compilation failure.

Comments

cc...@google.com <cc...@google.com> #2May 12, 2023 05:50PM

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

ma...@google.com <ma...@google.com> Jun 6, 2023 07:19PM

Accepted by ma...@google.com.

cc...@google.com <cc...@google.com> #3Jun 6, 2023 08:13PM

Thought about this a bit more, and suggest the following parts for tracing:

check for file presence in process init (e.g. DeviceInfo initializer) without throwing
In macro, add a runtime check with a clear error about unsupported/noncomplient device build
In PerfettoHelper.startCollecting(), check(!DeviceInfo.supportsTracing) {...}
In micro, we're ok with tracing failing, so suggest changing enableTracing = !Arguments.dryRunMode here to enableTracing = !Arguments.dryRunMode && DeviceInfo.supportsTracing

This way, macrobench and PerfettoTrace.capture will error clearly, without it affecting baseline profile capture or microbench.

ma...@google.com <ma...@google.com> Jun 13, 2023 05:44PM

Assigned to ma...@google.com.

cc...@google.com <cc...@google.com> Jun 13, 2023 05:45PM

Reassigned to cc...@google.com.

ap...@google.com <ap...@google.com> #4Jul 15, 2023 12:00AM

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

commit 24d0d7a6f7e7100d0e3d05131de1cd872a7e840f
Author: Chris Craik <ccraik@google.com>
Date: Fri Jul 14 13:52:36 2023

Add warning and test for device with misconfigured tracing

Bug: 282191686
Test: DeviceInfoTest # on user build
Test: TrivialStartupBenchmark
Test: TrivialKotlinBenchmark
Relnote: "Report error in macrobench when OS is misconfigured for
tracing, as was recently fixed in API 26/28 ARM64 emulators."

Change-Id: I0a328b08a0ef4b356d3d7b593dbb89e47d00815e

A benchmark/benchmark-common/src/androidTest/java/androidx/benchmark/DeviceInfoTest.kt
M benchmark/benchmark-common/src/androidTest/java/androidx/benchmark/PerfettoHelperTest.kt
M benchmark/benchmark-common/src/main/java/androidx/benchmark/DeviceInfo.kt
M benchmark/benchmark-common/src/main/java/androidx/benchmark/perfetto/PerfettoHelper.kt
M benchmark/benchmark-common/src/main/java/androidx/benchmark/perfetto/PerfettoTrace.kt
M benchmark/benchmark-junit4/src/main/java/androidx/benchmark/junit4/BenchmarkRule.kt
M benchmark/benchmark-macro/src/androidTest/java/androidx/benchmark/macro/perfetto/PerfettoCaptureSweepTest.kt
M benchmark/benchmark-macro/src/androidTest/java/androidx/benchmark/macro/perfetto/PerfettoCaptureTest.kt
M benchmark/benchmark-macro/src/main/java/androidx/benchmark/macro/Macrobenchmark.kt

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

ap...@google.com <ap...@google.com> #5Jul 17, 2023 05:45PM

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

commit 2189e12ba790617267b4ee81923553ffcc71e90d
Author: Chris Craik <ccraik@google.com>
Date: Fri Jul 14 16:21:41 2023

Add error suggesting emulator update if compile reset fails

Bug: 282191686
Test: CompilationModeTest
Relnote: "Added detail to compilation reset failure to suggest
updating emulator, as some emulators have recently fixed this issue."

Change-Id: I8c81570e0b2e03b9f6453e13f0706b10f59f0455

M benchmark/benchmark-macro/src/main/java/androidx/benchmark/macro/CompilationMode.kt
M benchmark/integration-tests/macrobenchmark/src/main/java/androidx/benchmark/integration/macrobenchmark/CompilationModeTest.kt

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

cc...@google.com <cc...@google.com> Jul 17, 2023 08:07PM

Marked as fixed.

na...@google.com <na...@google.com> #6Jul 26, 2023 06:38PM

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

androidx.benchmark:benchmark-common:1.2.0-beta02
androidx.benchmark:benchmark-junit4:1.2.0-beta02
androidx.benchmark:benchmark-macro:1.2.0-beta02