github/flutter
7
0
Fork 0
mirror of https://github.com/flutter/flutter.git synced 2025-06-03 00:51:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
6d6d7914f9
flutter/dev/integration_tests/ui
History
Harri Kirik e4c726ab89
Fix to Linux_pixel_7pro integration_ui_keyboard_resize test flakiness (#162308) 
## `integration_ui_keyboard_resize` flakiness reduction

This PR addresses flakiness in the `integration_ui_keyboard_resize` test
(issue #161300) and slightly improves its performance.

**Issue summary:**

The `integration_ui_keyboard_resize` test occasionally fails because the
device keyboard does not reliably open at the start of the test. This PR
mitigates one cause of this flakiness, though other potential underlying
issues may still exist. See #161300 for a detailed investigation.

**Changes and rationale:**

1.  **Improved keyboard detection logic (flakiness reduction):**
* The core change moves `await driver.tap(defaultTextField);` *inside*
the loop that checks for layout changes. This ensures the test
repeatedly attempts to open the keyboard *while* waiting for the
expected layout shift, significantly improving reliability.
    *   **Local testing results (MacBook Pro M1 + Pixel 8 Pro):**
* **Original implementation:** Consistent failures within the first 15
iterations.
* **This PR:** Ran consistently for at least 300 iterations (out of
2000) before any failure, with some runs exceeding 900 iterations.

2.  **`enableTextEntryEmulation` configuration improvement:**
* The `keyboard_resize.dart` app is *exclusively* used for testing and
requires `enableTextEntryEmulation: false` for proper device keyboard
interaction.
* This PR sets `enableTextEntryEmulation: false` directly within the
app's `enableFlutterDriverExtension` setup. This simplifies the test
setup, avoids cross-thread communication, and prevents the app from
appearing broken when run independently (as manual text input wouldn't
work otherwise).

3.  **UI enhancements for manual testing:**
* Added `SafeArea` and `InputDecoration` to `keyboard_resize.dart`. This
ensures the `TextField` is fully visible and usable during manual
testing (it was previously obscured by the Android status bar). This
improves the developer experience when debugging the app directly.

4.  **Optimized polling for speed:**
* Reduced the polling interval and increased the number of polling
iterations (maintaining the overall timeout). This change resulted in a
~2-second speed improvement per test iteration during local testing.

**Further flakiness improvement discussion and ideas**
See the discussion at https://github.com/flutter/flutter/issues/161300

**Testing and reproduction:**

To reproduce the original flakiness and verify the fix (reproducibility
may vary based on setup; see
https://github.com/flutter/flutter/issues/161300#issuecomment-2618952501):

1. **Disable automatic reboots:** Comment out the `await
checkForRebootRequired();` line in
9e273d5e6e/dev/devicelab/lib/framework/framework.dart (L240-L243)
2. **Disable automatic retries:** Set `static const int retryNumber =
0;` in
9e273d5e6e/dev/devicelab/lib/framework/cocoon.dart (L56-L57)
3. **Install `hyperfine`:** This is a command-line benchmarking tool
(e.g., `brew install hyperfine` on macOS).
4. **Connect a device/emulator:** Connect a physical Android device or
start an emulator.
5. **Run repeated tests:** Use `hyperfine` to run the test multiple
times and capture the output:
    ```bash
hyperfine -r 100 'dart bin/test_runner.dart test -t
integration_ui_keyboard_resize > log.txt'
    ```
2025-03-05 08:36:07 +00:00
..
android Update gradle memory properties in example and test projects (#163798) 2025-02-21 21:08:20 +00:00
assets [framework] work around to load self packages from packages/ (#111350) 2022-09-12 18:30:00 +00:00
integration_test Auto-format Framework (#160545) 2024-12-19 20:06:21 +00:00
ios [flutter_tools] opt iOS/macOS apps out of Metal API validation via migrator, update templates in repo. (#159228) 2024-11-21 01:36:55 +00:00
lib Fix to Linux_pixel_7pro integration_ui_keyboard_resize test flakiness (#162308) 2025-03-05 08:36:07 +00:00
linux Deletes files that should be ignored (#127984) 2023-06-29 19:45:22 +00:00
macos [flutter_tools] opt iOS/macOS apps out of Metal API validation via migrator, update templates in repo. (#159228) 2024-11-21 01:36:55 +00:00
test Auto-format Framework (#160545) 2024-12-19 20:06:21 +00:00
test_driver Fix to Linux_pixel_7pro integration_ui_keyboard_resize test flakiness (#162308) 2025-03-05 08:36:07 +00:00
web [flutter_tools] ensure track-widget-creation can be disabled on Android/macOS (#56203) 2020-05-04 11:22:15 -07:00
windows [Windows] Drop support for Windows 7/8 apps in template (#146668) 2024-04-12 01:07:20 +00:00
pubspec.yaml Roll pub packages (#164316) 2025-02-27 19:38:00 +00:00
README.md

README.md

Flutter UI integration tests

This project contains a collection of non-plugin-dependent UI integration tests. The device code is in the lib/ directory, the driver code is in the test_driver/ directory. They work together. Normally they are run via the devicelab.

keyboard_resize

Verifies that showing and hiding the keyboard resizes the content.

routing

Verifies that flutter drive --route works correctly.