WIP: Migrate benchmarks to UiAutomator 3.0 API #322

keyboardsurfer · 2025-04-02T11:16:57Z

No description provided.

gemini-code-assist

Hello @keyboardsurfer, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request migrates the macrobenchmark tests to use the UiAutomator 3.0 API. This involves updating the UiAutomator dependency to a 2.4.0-SNAPSHOT version and refactoring the tests to use the uiAutomator DSL for interacting with the UI. The primary goal is to modernize the test infrastructure and leverage the latest features and improvements in UiAutomator.

Highlights

UiAutomator Upgrade: The UiAutomator dependency is updated to version 2.4.0-SNAPSHOT in gradle/libs.versions.toml. This brings in the latest API changes and improvements.
DSL Adoption: The tests are refactored to use the uiAutomator DSL, which provides a more concise and expressive way to interact with UI elements. This includes replacing direct UiDevice calls with onView and other DSL constructs.
Clear Data Refactoring: The clearData function in Common.kt is updated to use UiAutomatorTestScope and clears the data for the launcher package instead of the target package.
Test Modernization: Multiple tests across different benchmark types (Baseline Profile Generation, Login, Click Latency, Frame Timing, Startup) are updated to use the new UiAutomator 3.0 API, ensuring consistency and maintainability.

Changelog

Click here to see the changelog

MacrobenchmarkSample/gradle/libs.versions.toml
- Updated uiAutomator version from 2.3.0 to 2.4.0-SNAPSHOT.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/Common.kt
- Modified clearData function to use UiAutomatorTestScope and clear launcher package data.
- Removed MacrobenchmarkScope and UiDevice imports.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/ComposeActivityBaselineProfileGenerator.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By, findOrFail, and waitAndFind imports.
- Removed @Ignore annotation.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/LoginBaselineProfileGenerator.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/RecyclerViewActivityBaselineProfileGenerator.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By import.
- Removed @Ignore annotation.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/StartupProfileGenerator.kt
- Replaced direct startActivityAndWait() call with uiAutomator { startApp() }.
- Added uiAutomator import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/LoginBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Added UiAutomatorTestScope import.
- Removed By import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/clickslatency/ClickLatencyBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Added UiAutomatorTestScope import.
- Removed By and Until imports.
- Removed firstStart variable and setup blocks.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/frames/FrameTimingBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/frames/NestedRecyclerFrameTimingBenchmarks.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By and Until imports.
- Removed waitAndFind import.
- Removed java.util.concurrent.TimeUnit import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/frames/NonExportedActivityBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By and Until imports.
- Removed junit.framework.TestCase.fail import.
- Removed java.util.concurrent.TimeUnit import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/frames/TextInputFrameTimingBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/scroll/ScrollBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By and Until imports.
- Removed junit.framework.TestCase import.
- Removed firstStart variable and setup blocks.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/startup/FullyDrawnStartupBenchmark.kt
- Replaced direct device calls with uiAutomator DSL.
- Removed By and Until imports.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/startup/SampleStartupBenchmark.kt
- Replaced direct startActivityAndWait() call with uiAutomator { startApp() }.
- Added uiAutomator import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/startup/SmallListStartupBenchmark.kt
- Replaced direct startActivityAndWait() call with uiAutomator { startIntent(intent) } in measureStartup and measureComposeStartup.
- Added uiAutomator import.
MacrobenchmarkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/startup/StartupBenchmark.kt
- Replaced direct startActivityAndWait() call with uiAutomator { startApp() }.
- Added uiAutomator import.
- Removed @SdkSuppress annotations.
MacrobenchmarkSample/settings.gradle.kts
- Added maven repository URL for androidx.dev snapshots.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

In realms of code, where tests reside,
UiAutomator's power, a helpful guide.
With DSL's grace,
We set the pace,
For benchmarks swift, with naught to hide.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request migrates the benchmarks to use the UiAutomator 3.0 API. The changes involve updating the UiAutomator dependency and refactoring the benchmark code to use the new API. Overall, the changes look good and improve the maintainability of the benchmark tests.

Summary of Findings

UiAutomator version update: The UiAutomator dependency is updated to version 2.4.0-SNAPSHOT, which includes the new UiAutomator 3.0 API.
Refactoring to use UiAutomator 3.0 API: The benchmark code is refactored to use the new UiAutomator 3.0 API, which provides a more fluent and readable way to interact with UI elements.
Removal of deprecated methods: Deprecated methods like device.findObject and startActivityAndWait are replaced with the new UiAutomator 3.0 API.

Merge Readiness

The pull request is almost ready to be merged. However, there are a few medium severity issues that should be addressed before merging. Once these issues are resolved, the pull request will be ready to be merged. I am unable to directly approve the pull request, and that users should have others review and approve this code before merging.

...rkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/Common.kt

.../src/main/kotlin/com/example/macrobenchmark/benchmark/clickslatency/ClickLatencyBenchmark.kt

keyboardsurfer · 2025-04-02T13:06:28Z

/gemini review

gemini-code-assist

Code Review

The pull request migrates the benchmarks to use the UiAutomator 3.0 API. This involves updating the UiAutomator dependency and refactoring the benchmark code to use the new UiAutomator API. The changes look good overall, but there are a few areas that could be improved.

Summary of Findings

Redundant startActivityAndWait calls: The startActivityAndWait calls are now redundant since startApp() and startIntent() are used within the uiAutomator block. These calls can be removed to simplify the code.
Inconsistent use of uiAutomator block: The uiAutomator block is not consistently used across all benchmark tests. Some tests still use the old UiDevice methods directly. It would be better to wrap all UiAutomator interactions within the uiAutomator block for consistency.
Clarity of clearData function: The clearData function's documentation should clearly state that it clears data for the launcher package, not the target package.

Merge Readiness

The pull request is almost ready for merging. However, the redundant startActivityAndWait calls and inconsistent use of the uiAutomator block should be addressed before merging. Additionally, the documentation for the clearData function should be clarified. I am unable to approve this pull request, and users should have others review and approve this code before merging.

keyboardsurfer · 2025-04-02T13:12:50Z

/gemini review

Outdated

gemini-code-assist

Code Review

The pull request migrates the benchmarks to use the UiAutomator 3.0 API, which is a good step towards keeping the codebase up-to-date and leveraging the latest features. The changes generally look good, but there are a few areas where improvements can be made to enhance readability and maintainability.

Summary of Findings

Redundant firstStart variable: The firstStart variable is used in several benchmark tests to ensure that the activity is started only once. This variable can be removed by using startupMode = StartupMode.COLD in the measureRepeated block.
Inconsistent use of uiAutomator block: The uiAutomator block is used in some tests but not in others. It would be better to use it consistently across all tests for better readability and maintainability.
Missing waitForIdle() call: In LoginBaselineProfileGenerator.kt, the waitForIdle() call is removed. This call is important to ensure that the UI is fully loaded before proceeding with the next action. It should be added back to ensure the reliability of the benchmark.

Merge Readiness

The pull request is almost ready for merging. However, there are a few issues that need to be addressed before merging. Specifically, the redundant firstStart variable should be removed, the use of uiAutomator block should be consistent, and the waitForIdle() call should be added back to LoginBaselineProfileGenerator.kt. I am unable to approve this pull request, and users should have others review and approve this code before merging. I recommend that the pull request not be merged until those are addressed (at a minimum).

gemini-code-assist · 2025-04-02T13:13:18Z

.../src/main/kotlin/com/example/macrobenchmark/baselineprofile/LoginBaselineProfileGenerator.kt

+                startIntent(Intent("$packageName.LOGIN_ACTIVITY"))
+                onView { viewIdResourceName == "userName" }.text = "user"
+                onView { viewIdResourceName == "password" }.text = "password"
+                onView { viewIdResourceName == "login" }.click()


The waitForIdle() call is removed. This call is important to ensure that the UI is fully loaded before proceeding with the next action. It should be added back to ensure the reliability of the benchmark.

onView { viewIdResourceName == "login" }.click() uiDevice.waitForIdle()

gemini-code-assist · 2025-04-02T13:13:18Z

...rkSample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/Common.kt

+fun UiAutomatorTestScope.clearData() {
+    val command = "pm clear $TARGET_PACKAGE"
+    uiDevice.executeShellCommand(command)


The KDoc comment should describe the purpose of the function, not the parameter. Also, it should describe what package the data is being cleared for.

gemini-code-assist · 2025-04-02T13:13:18Z

...Sample/macrobenchmark/src/main/kotlin/com/example/macrobenchmark/benchmark/LoginBenchmark.kt

-        device.findObject(By.res("password")).text = "password"
-        device.findObject(By.res("login")).click()
-        device.waitForIdle()
+    private fun UiAutomatorTestScope.login() {


Consider adding uiDevice.waitForIdle() after the click action to ensure the UI is fully updated before the benchmark finishes.

onView { viewIdResourceName == "login" }.click() uiDevice.waitForIdle()

gemini-code-assist · 2025-04-02T13:13:18Z

.../src/main/kotlin/com/example/macrobenchmark/benchmark/clickslatency/ClickLatencyBenchmark.kt

    fun simpleViewClick() {
-        var firstStart = true
        benchmarkRule.measureRepeated(
-                packageName = TARGET_PACKAGE,
-                metrics = listOf(TraceSectionMetric("ClickTrace")),
-                compilationMode = CompilationMode.Full(),
-                startupMode = null,
-                iterations = DEFAULT_ITERATIONS,
-                setupBlock = {
-                    if (firstStart) {
-                        startActivityAndWait()
-                        firstStart = false
-                    }
-                }
+            packageName = TARGET_PACKAGE,
+            metrics = listOf(TraceSectionMetric("ClickTrace")),
+            compilationMode = CompilationMode.Full(),
+            startupMode = null,
+            iterations = DEFAULT_ITERATIONS,
        ) {


The firstStart variable is redundant here. You can use startupMode = StartupMode.COLD in the measureRepeated block to achieve the same result. This applies to all the other tests in this file as well.

benchmarkRule.measureRepeated( packageName = TARGET_PACKAGE, metrics = listOf(TraceSectionMetric("ClickTrace")), compilationMode = CompilationMode.Full(), startupMode = StartupMode.COLD, iterations = DEFAULT_ITERATIONS, ) {

gemini-code-assist · 2025-04-02T13:13:18Z

.../src/main/kotlin/com/example/macrobenchmark/benchmark/clickslatency/ClickLatencyBenchmark.kt

+            uiAutomator {
+                startApp()
+                val title = "RecyclerView Sample"
+                onView { viewIdResourceName == "launchRecyclerActivity" }.click()
+                onView { text == title && isVisibleToUser }
+                pressBack()
+                onView { text == title && !isVisibleToUser }
+            }


The startApp() function is used in this test, but startIntent() is used in other tests. Consider using startIntent() consistently across all tests for better readability and maintainability.

bentrengrove

It feels like Macrobenchmark should provide the UIAutomator scope, is that planned? It would make this a bit cleaner

MacrobenchmarkSample/gradle/libs.versions.toml

...kotlin/com/example/macrobenchmark/baselineprofile/ComposeActivityBaselineProfileGenerator.kt

...n/com/example/macrobenchmark/baselineprofile/RecyclerViewActivityBaselineProfileGenerator.kt

bentrengrove · 2025-04-02T21:20:18Z

...chmark/src/main/kotlin/com/example/macrobenchmark/baselineprofile/StartupProfileGenerator.kt

@@ -41,7 +42,9 @@ class StartupProfileGenerator {
            stableIterations = 3,
            includeInStartupProfile = true
        ) {
-            startActivityAndWait()
+            uiAutomator {
+                startApp()


startActivityAndWait is a macrobenchmark function, this new one is a UIAutomator function. Are we sure this is correct? startActivityAndWait isn't doing anything else that now wouldn't be done?

keyboardsurfer · 2025-04-03T09:19:29Z

It feels like Macrobenchmark should provide the UIAutomator scope, is that planned? It would make this a bit cleaner

The UiAutomator API is still a SNAPSHOT build. Asking to get this added was on my backlog and I just filed a bug for it.

keyboardsurfer requested a review from a team as a code owner April 2, 2025 11:16

gemini-code-assist bot reviewed Apr 2, 2025

View reviewed changes

gemini-code-assist bot suggested changes Apr 2, 2025

View reviewed changes

keyboardsurfer force-pushed the uiautomator3 branch from 7837b2f to abe3a93 Compare April 2, 2025 11:20

gemini-code-assist bot previously requested changes Apr 2, 2025

View reviewed changes

keyboardsurfer force-pushed the uiautomator3 branch from abe3a93 to 6ab5766 Compare April 2, 2025 13:12

gemini-code-assist bot suggested changes Apr 2, 2025

View reviewed changes

bentrengrove reviewed Apr 2, 2025

View reviewed changes

Migrate benchmarks to UiAutomator 3.0 API

08a4d2e

keyboardsurfer force-pushed the uiautomator3 branch from 6ab5766 to 08a4d2e Compare April 3, 2025 08:55

keyboardsurfer changed the title ~~Migrate benchmarks to UiAutomator 3.0 API~~ WIP: Migrate benchmarks to UiAutomator 3.0 API Apr 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Migrate benchmarks to UiAutomator 3.0 API #322

WIP: Migrate benchmarks to UiAutomator 3.0 API #322

keyboardsurfer commented Apr 2, 2025

gemini-code-assist bot left a comment

gemini-code-assist bot left a comment

keyboardsurfer commented Apr 2, 2025

gemini-code-assist bot left a comment

keyboardsurfer commented Apr 2, 2025

gemini-code-assist bot left a comment

gemini-code-assist bot Apr 2, 2025

gemini-code-assist bot Apr 2, 2025

gemini-code-assist bot Apr 2, 2025

gemini-code-assist bot Apr 2, 2025

gemini-code-assist bot Apr 2, 2025

bentrengrove left a comment

bentrengrove Apr 2, 2025

keyboardsurfer commented Apr 3, 2025

WIP: Migrate benchmarks to UiAutomator 3.0 API #322

Are you sure you want to change the base?

WIP: Migrate benchmarks to UiAutomator 3.0 API #322

Conversation

keyboardsurfer commented Apr 2, 2025

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Changelog

Footnotes

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Summary of Findings

Merge Readiness

keyboardsurfer commented Apr 2, 2025

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Summary of Findings

Merge Readiness

keyboardsurfer commented Apr 2, 2025

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Summary of Findings

Merge Readiness

gemini-code-assist bot Apr 2, 2025

Choose a reason for hiding this comment

gemini-code-assist bot Apr 2, 2025

Choose a reason for hiding this comment

gemini-code-assist bot Apr 2, 2025

Choose a reason for hiding this comment

gemini-code-assist bot Apr 2, 2025

Choose a reason for hiding this comment

gemini-code-assist bot Apr 2, 2025

Choose a reason for hiding this comment

bentrengrove left a comment

Choose a reason for hiding this comment

bentrengrove Apr 2, 2025

Choose a reason for hiding this comment

keyboardsurfer commented Apr 3, 2025