Fix leaks in flutter_test tests#180879
Conversation
github-actions
bot
added
a: tests
![gemini-code-assist[bot]](proxy.php?url=https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request addresses memory leaks in flutter_test tests by ensuring proper disposal of resources. A new method, resetLayers, is introduced in TestWidgetsFlutterBinding to reliably dispose of render view layers, which is a key part of the fix. The rest of the changes involve diligently using addTearDown in numerous test files to dispose of objects like controllers, painters, and focus nodes, preventing them from leaking between tests. The changes are thorough and correctly apply resource management best practices in a testing context.
| Future<void> resetLayers() async { | ||
| await setSurfaceSize(null); | ||
| for (final RenderView renderView in renderViews) { | ||
| // Trigger a layer replacement by changing the device pixel ratio. |
There was a problem hiding this comment.
I tried to understand the code here. why do we assign twice in line 1862 and 1865?
There was a problem hiding this comment.
See the comment above:
This method forces a layer replacement by temporarily toggling the device pixel ratio, which triggers a clean disposal of the old layer tree.
I'd consider copying that "which triggers..." bit down to the implementation to make this more obvious :)
There was a problem hiding this comment.
I've rewritten the doc of this method and the inline comments. Can you check if it's clearer now?
| /// | ||
| /// * [setSurfaceSize], which often necessitates calling this method during | ||
| /// tear down. | ||
| Future<void> resetLayers() async { |
There was a problem hiding this comment.
maybe this should be called resetViewConfiguration?
There was a problem hiding this comment.
I get why you would think so. But the goal of this method is really to replace the root layers with new, unused ones, so that the current used ones can be disposed. Resetting view configuration is a side effect that has to be done anyway. Calling it resetViewConfiguration might lead to improper usage. I prefer the current name over resetViewConfiguration.
|
@dkwingsmt Will this PR cause Line 5912 in 3feca0c |
|
@jmagman Yes, removing the I haven't had time to address the comments, but plan to do it asap. |
| testWidgets( | ||
| 'passing a view to pumpWidget with wrapWithView: true throws', | ||
| experimentalLeakTesting: LeakTesting.settings | ||
| .withIgnoredAll(), // leaking by design because of exception |
There was a problem hiding this comment.
Just double-checking - we can't use something like a catch to dispose? Ideally we don't leak even with exceptions.
However, I'm OK ignoring here since this seems like an uncommon scenario.
There was a problem hiding this comment.
I actually tried to trace the state for this test (before I knew that exception is leaking by design), and from what I understand, the interruption caused by the exception leaves the system at an inconsistent state and breaks expectations of how to cleanup.
For example, class A and B keep reference counting of each other for resource management. If an exception occurs at the middle of A.dispose, B might not be notified and still keeps A's resources. And there would be no way to make B clean up in a public way later, because B's cleanup will call A's, who has recorded itself as disposed and, for example, throw assertions.
In the end, exceptions are not expected for an app, and memory cleanup after exceptions shouldn't be that important.
|
Thanks for the review!
The |
dkwingsmt
added
the
autosubmit
flutter-dashboard
bot
removed
the
autosubmit
Roll Flutter from 48c2475 to bfc9041eb118 (173 revisions) flutter/flutter@48c2475...bfc9041 2026-01-23 [email protected] No longer exiting the application when the RegularWindow is destroyed + resolving the window created promise after runWidget (flutter/flutter#181339) 2026-01-23 [email protected] Remove unnecessary Material import from dialog_test.dart (flutter/flutter#181249) 2026-01-23 [email protected] Roll Skia from 8e516fe6828f to db10db8bd55f (1 revision) (flutter/flutter#181379) 2026-01-23 [email protected] Reset TextFormField to initial value after state change (flutter/flutter#181199) 2026-01-23 [email protected] Roll Dart SDK from 980b2b41d36e to e82d7ad1855e (1 revision) (flutter/flutter#181375) 2026-01-23 [email protected] Roll Skia from 3e86f377d300 to 8e516fe6828f (4 revisions) (flutter/flutter#181370) 2026-01-23 [email protected] Remove unnecessary Material import from sliver_visibility_test (flutter/flutter#181248) 2026-01-23 [email protected] Add bottom navigation bar item semantics label (flutter/flutter#180577) 2026-01-23 [email protected] Make topGap not required for CupertinoSheetTransition (flutter/flutter#181269) 2026-01-23 [email protected] Roll Fuchsia Linux SDK from b4cLyhuxciUC-4zCJ... to n7NohL9DPpEuPjNt9... (flutter/flutter#181365) 2026-01-23 [email protected] Roll Dart SDK from 806f04638561 to 980b2b41d36e (1 revision) (flutter/flutter#181364) 2026-01-23 [email protected] Reland hybrid views test (flutter/flutter#181336) 2026-01-23 [email protected] Revert DropdownMenu non-nullable breaking change (flutter/flutter#181074) 2026-01-23 [email protected] Fix leaks in `flutter_test` tests (flutter/flutter#180879) 2026-01-23 [email protected] Re-enable fragment_shader_tests.dart 'Shader Compiler appropriately pads vec3 uniform arrays' test on Vulkan (flutter/flutter#181292) 2026-01-23 [email protected] [ Tool ] Fix `update-packages` failing due to mismatched dependencies between flutter_tools and the framework (flutter/flutter#181335) 2026-01-23 [email protected] [Impeller] Make dynamically created shader metadata for runtime effects consistent with metadata for built-in shaders (flutter/flutter#181201) 2026-01-23 [email protected] Broaden the applicability of `Color` fix_data rules from flutter/painting.dart (flutter/flutter#181093) 2026-01-23 [email protected] Fixes macOS App.framework not being codesigned or find framework (flutter/flutter#181348) 2026-01-22 [email protected] Roll Fuchsia GN SDK from NAEC5tfgSl8g94nwp... to JLBh4Z9PKsjIJcqDU... (flutter/flutter#181139) 2026-01-22 [email protected] Roll Dart SDK from ab4640ea82e9 to 806f04638561 (2 revisions) (flutter/flutter#181347) 2026-01-22 [email protected] Add ExpansibleController.toggle method. (flutter/flutter#181320) 2026-01-22 [email protected] Fixes Typo in codebase (flutter/flutter#181256) 2026-01-22 [email protected] Roll Skia from 4766615bcc96 to 3e86f377d300 (3 revisions) (flutter/flutter#181346) 2026-01-22 [email protected] Make sure that a Hero doesn't crash in 0x0 environment (flutter/flutter#180954) 2026-01-22 [email protected] Reland "Fix capitalization of the path to FlutterWindowControllerTest.mm in the macOS platform build script" (flutter/flutter#181200) 2026-01-22 [email protected] Roll Skia from 6e9746be8c4a to 4766615bcc96 (3 revisions) (flutter/flutter#181331) 2026-01-22 [email protected] Fix remove material import textfield (flutter/flutter#181254) 2026-01-22 [email protected] Add FlutterFramework as an Xcode SwiftPM local package override (flutter/flutter#179512) 2026-01-22 [email protected] Roll Dart SDK from 7bd4c68b625c to ab4640ea82e9 (1 revision) (flutter/flutter#181324) 2026-01-22 [email protected] Roll Packages from d80c60e to 9010299 (9 revisions) (flutter/flutter#181323) 2026-01-22 [email protected] Roll Dart SDK from 2d53a77adc5d to 7bd4c68b625c (2 revisions) (flutter/flutter#181316) 2026-01-22 [email protected] Roll Skia from 3f6949bc5780 to 6e9746be8c4a (2 revisions) (flutter/flutter#181311) 2026-01-22 [email protected] Roll Skia from ef6efc358b4a to 3f6949bc5780 (2 revisions) (flutter/flutter#181307) 2026-01-22 [email protected] Roll Dart SDK from 5d7c8faf2e41 to 2d53a77adc5d (1 revision) (flutter/flutter#181305) 2026-01-22 [email protected] [Material] update hourFormat to use Dart 3 switch expression (flutter/flutter#181041) 2026-01-22 [email protected] Use null-aware elements in cupertino/nav_bar.dart (flutter/flutter#181237) 2026-01-22 [email protected] Roll Fuchsia Linux SDK from b2KIEXVAlEqImQ9VO... to b4cLyhuxciUC-4zCJ... (flutter/flutter#181297) 2026-01-22 [email protected] Roll pub packages (flutter/flutter#181295) 2026-01-22 [email protected] Enables fragment shader test for impeller (fixes mat2 on vulkan) (flutter/flutter#181013) 2026-01-21 [email protected] Roll Dart SDK from 366200db1aa1 to 5d7c8faf2e41 (4 revisions) (flutter/flutter#181290) 2026-01-21 [email protected] Roll Skia from b5ec89e31f59 to ef6efc358b4a (19 revisions) (flutter/flutter#181289) 2026-01-21 [email protected] fix description for semantics finders (flutter/flutter#181214) 2026-01-21 [email protected] Make sure that an Icon doesn't crash in 0x0 environment (flutter/flutter#181021) 2026-01-21 [email protected] Make sure that a GridPaper doesn't crash in 0x0 environment (flutter/flutter#180906) 2026-01-21 [email protected] Bring Linux coverage out of bringup (flutter/flutter#181280) ...
Following flutter#176992, this PR fixes all leaks in `flutter_test` tests. A new method is added to reliably dispose the root layer of render views. Feel free to let me know if you have suggestions for the name! ## Pre-launch Checklist - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [ ] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [ ] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
5 participants
Following #176992, this PR fixes all leaks in
flutter_testtests.A new method is added to reliably dispose the root layer of render views. Feel free to let me know if you have suggestions for the name!
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.