Reduce test flakiness by increasing timeouts, consolidating wait logic

[temcguir]

This PR addresses test flakiness, particularly observed on API 28 emulators, by increasing standard timeout durations and refactoring tests to use consolidated helper functions. Additionally, the project's style guide has been updated to codify these testing best practices.

Changes

• Increased Timeouts (UiTestUtil.kt):

  • APP_START_TIMEOUT_MILLIS: Increased from 10s to 20s.
  • VIDEO_CAPTURE_TIMEOUT_MILLIS & SAVE_MEDIA_TIMEOUT_MILLIS: Increased from 5s to 15s.
  • DEFAULT_TIMEOUT_MILLIS: Increased from 1s to 5s.

• New Helper Functions (ComposeTestRuleExt.kt):

  • Added extension functions to standardize waiting logic and reduce boilerplate:
    • waitForNodeWithTag(tag, timeout)
    • waitForNodeWithTagToDisappear(tag, timeout)
    • waitForNodeWithText(textResId, timeout)
    • waitForCaptureModeToggleState(state, timeout)

• Test Refactoring:

  • Updated VideoRecordingDeviceTest.kt and other tests to replace manual waitUntil blocks with the new waitForNodeWithTag helpers.
  • Consolidated timeout usage to ensure consistent behavior across the test suite.

• Documentation (.gemini/styleguide.md):

  • Added a "Test Stability & Timeouts" section to the Code Review Directives.
  • Mandates explicit timeouts when using waitUntil.
  • Encourages extracting repeated wait conditions into helper functions to allow centralized timeout tuning.

[gemini-code-assist]

Summary of Changes

Hello @temcguir, 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!

This pull request significantly enhances the stability and reliability of the test suite by addressing common causes of test flakiness. It achieves this by extending timeout durations for critical operations and introducing a set of standardized helper functions to manage asynchronous UI interactions more effectively. These changes aim to provide a more consistent testing experience and reduce intermittent failures, particularly on resource-constrained environments.

Highlights

• Increased Test Timeouts: Several key timeout durations for UI tests have been significantly increased to reduce flakiness, particularly on slower emulators like API 28. This includes APP_START_TIMEOUT_MILLIS (10s to 20s), VIDEO_CAPTURE_TIMEOUT_MILLIS (5s to 15s), SAVE_MEDIA_TIMEOUT_MILLIS (5s to 15s), and DEFAULT_TIMEOUT_MILLIS (1s to 5s).
• Consolidated Wait Logic: New helper extension functions have been introduced in ComposeTestRuleExt.kt to standardize common waiting patterns in tests. These include waitForNodeWithTag, waitForNodeWithTagToDisappear, waitForNodeWithText, and waitForCaptureModeToggleState, reducing boilerplate and improving readability.
• Test Refactoring: Numerous existing UI tests across various files (e.g., CachedImageCaptureDeviceTest.kt, VideoRecordingDeviceTest.kt, PermissionsTest.kt) have been refactored to utilize the newly created helper functions, replacing direct waitUntil calls with more concise and robust waiting mechanisms.
• Updated Style Guide: The project's style guide (.gemini/styleguide.md) has been updated with a new section on 'Test Stability & Timeouts'. This section codifies best practices, mandating explicit timeouts for waitUntil blocks and encouraging the extraction of repeated wait conditions into helper functions for better maintainability and centralized timeout tuning.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Ignored Files

• Ignored by pattern: .gemini/** (1)
  • .gemini/styleguide.md

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

[gemini-code-assist]

Code Review

This pull request is a great step towards improving test stability and code quality. Increasing the timeout values is a practical solution for flaky tests in CI environments. The introduction of new helper functions in ComposeTestRuleExt.kt to abstract waiting logic is an excellent refactoring that significantly improves the readability and maintainability of the test suite. The changes have been applied consistently across numerous test files. I have one suggestion to further improve code reuse by extracting a small piece of duplicated logic into a helper function, in line with the project's style guide.