Skip to content

Upgrade macrobenchmark sample to UiAutomator 2.4-alpha05 #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

keyboardsurfer
Copy link
Member

No description provided.

@keyboardsurfer keyboardsurfer requested a review from a team as a code owner July 30, 2025 13:52
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @keyboardsurfer, I'm Gemini Code Assist1! 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!

This pull request primarily focuses on upgrading the UiAutomator dependency to its latest alpha version (2.4.0-alpha05) within the Macrobenchmark sample. This upgrade necessitates a significant refactoring of the existing UI automation code, transitioning to the new, more expressive UiAutomator DSL. The changes aim to modernize the benchmark tests, making them more robust and easier to maintain by leveraging the latest features of the UiAutomator library.

Highlights

  • Dependency Upgrade: I've upgraded the uiAutomator dependency in MacrobenchmarkSample/gradle/libs.versions.toml from version 2.3.0 to 2.4.0-alpha05. This is the core change enabling the subsequent refactorings.
  • Adoption of New UiAutomator DSL: I've refactored numerous benchmark and baseline profile generator files to leverage the new uiAutomator { ... } DSL (Domain Specific Language) and onElement { ... } syntax introduced in UiAutomator 2.4. This significantly streamlines UI interaction code within the tests.
  • Simplified UI Interaction Logic: The adoption of the new UiAutomator API has allowed for the simplification of UI interaction patterns. This includes replacing direct device.findObject(By.res(...)) calls with onElement { ... } and startActivityAndWait() with uiAutomator { startIntent(...) } or uiAutomator { startApp(...) }, making the test code more concise and readable.
  • Removal of Redundant Utilities: I've removed the clearData utility function from Common.kt and the entire Permissions.kt file, as their functionalities are now either directly integrated or superseded by the capabilities of the new UiAutomator 2.4 API, such as the PermissionDialog watcher.
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 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 or fill out our survey 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.

Footnotes

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request upgrades the uiAutomator dependency and refactors the existing tests to use the new, more concise DSL. I've identified several critical issues, primarily incorrect UI selectors that will cause tests to fail. Additionally, there are some high and medium severity issues related to changes in test logic, code consistency, and test performance. Addressing these will ensure the test suite remains robust and reliable after the upgrade.

This commit updates the MacrobenchmarkSample to use UiAutomator 2.4-alpha05, which introduces a breaking change. The `measureBlock` and `setupBlock` in `MacrobenchmarkRule.measureRepeated` no longer have `MacrobenchmarkScope` as a receiver.

The following changes were made to adapt to this:
- Removed `MacrobenchmarkScope` as a receiver from helper functions.
- Updated UI interactions to use new UiAutomator APIs where necessary (e.g., using `textAsString()` for text matching in `TextInputFrameTimingBenchmark` and `StartupBenchmark`).
- Refactored `LoginBenchmark` to separate UI interaction logic (inputting details and clicking login) into distinct functions for clarity and to accommodate the `measureBlock` changes.
- Updated the benchmark library version in `libs.versions.toml`.
The following experimental APIs have been stabilized:
- `ExperimentalComposeUiApi` for `testTag` and `semantics`
- `ExperimentalMetricApi` for `FrameTimingMetric`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants