Skip to content

[material_ui] Fix LocalHistoryEntry leak when double tapping Drawer scrim - #12552

Merged
auto-submit[bot] merged 14 commits into
flutter:mainfrom
Mairramer:fix-drawer-double-tap
Sep 22, 2026
Merged

auto-submit[bot] merged 14 commits into
flutter:mainfrom
Mairramer:fix-drawer-double-tap

Conversation

@Mairramer

Copy link
Copy Markdown
Contributor

This PR improves the DrawerControllerState lifecycle by making sure the LocalHistoryEntry is properly removed and cleared.

Fixes flutter/flutter#133740

Pre-Review 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-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.

Footnotes

  1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2

@github-actions github-actions Bot added p: material_ui triage-design Should be looked at in design triage labels Aug 22, 2026
@Mairramer Mairramer changed the title Fix LocalHistoryEntry leak when double tapping Drawer scrim [material_ui] Fix LocalHistoryEntry leak when double tapping Drawer scrim Aug 22, 2026
@Mairramer
Mairramer marked this pull request as ready for review September 4, 2026 12:43

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

Copy link
Copy Markdown
Contributor

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 addresses a LocalHistoryEntry leak when double-tapping the drawer scrim by introducing a helper method _removeHistoryEntry to clean up the history entry, updating _handleHistoryEntryRemoved to check if the widget is mounted, and adding a corresponding widget test. The reviewer suggests introducing a _disposed flag to track the disposal state of the widget and checking it in _handleHistoryEntryRemoved to prevent calling close() during disposal, which could trigger setState() exceptions in parent widgets.

Comment thread packages/material_ui/lib/src/drawer.dart
Comment thread packages/material_ui/lib/src/drawer.dart
@Mairramer Mairramer added the CICD Run CI/CD label Sep 6, 2026
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 6, 2026
@Mairramer Mairramer added the CICD Run CI/CD label Sep 6, 2026
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 7, 2026
@Mairramer Mairramer added the CICD Run CI/CD label Sep 7, 2026
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 8, 2026
@Mairramer Mairramer added the CICD Run CI/CD label Sep 9, 2026

@QuncCccccc QuncCccccc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall looks really good! Thanks a lot for your contribution!

Just one question: do we need to call it directly from both _settle() and close(), or is the AnimationStatus.reverse/dismissed cleanup plus the guarded _handleHistoryEntryRemoved() enough? I tried the new regression test locally without those two direct calls and it still passed, so if those calls cover another path, could we add a short comment or test for that case?

@Mairramer

Copy link
Copy Markdown
Contributor Author

Just one question: do we need to call it directly from both _settle() and close(), or is the AnimationStatus.reverse/dismissed cleanup plus the guarded _handleHistoryEntryRemoved() enough? I tried the new regression test locally without those two direct calls and it still passed, so if those calls cover another path, could we add a short comment or test for that case?

While testing this manually, I noticed that without the explicit _removeHistoryEntry() calls in _settle() and close(), the history entry would remain active until the animation fully reached AnimationStatus.dismissed. It also results in some odd behavior when dragging. I’ll add a test covering this case.

@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 11, 2026
@Mairramer Mairramer added the CICD Run CI/CD label Sep 11, 2026

@QuncCccccc QuncCccccc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM with one nit. Thanks for your contribution:)

Comment thread packages/material_ui/test/drawer_test.dart Outdated
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 21, 2026
@Mairramer Mairramer added the CICD Run CI/CD label Sep 21, 2026
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 21, 2026
@Mairramer Mairramer added the CICD Run CI/CD label Sep 21, 2026

@QuncCccccc QuncCccccc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM again. Forgot to approve it last time:)!

@QuncCccccc QuncCccccc added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 22, 2026
@auto-submit
auto-submit Bot merged commit de1f758 into flutter:main Sep 22, 2026
14 checks passed
pull Bot pushed a commit to edisplay/flutter that referenced this pull request Sep 24, 2026
…er#193289)

Roll Packages from c2b58e1a97fb to 431ea69a42e2 (56 revisions)

flutter/packages@c2b58e1...431ea69

2026-09-24 [email protected] [cross_file]
Updates cross_file to a package separated federated plugin
(flutter/packages#11010)
2026-09-23 [email protected] [material_ui]
Remove static access of `copyWith` from `dart fix` golden tests for
`ThemeData/TextTheme` (flutter/packages#12994)
2026-09-23 [email protected] [camera_avfoundation] Replace
deprecated high-resolution capture APIs (flutter/packages#12372)
2026-09-23 [email protected] [pigeon] update nullish checks to use
new isNullish method (flutter/packages#12985)
2026-09-23 [email protected] [ci] Assign batch release PR approver
as reviewer on sync-back PR (flutter/packages#12976)
2026-09-23 [email protected] [image_picker] Fix scaling 10-bit images
(flutter/packages#12557)
2026-09-23 [email protected] [material_ui] Improve
Autocomplete, DrawerHeader, and Tooltip accessibility
(flutter/packages#12918)
2026-09-23 [email protected] [google_fonts] Decouple GoogleFontsLite
for full tree-shaking and add full feature parity
(flutter/packages#12830)
2026-09-23 [email protected] [file_selector]
Ignore flakey `file_selector_android` tests (flutter/packages#12992)
2026-09-23 [email protected] [CI] Remove
bringup from `Mac_arm64 build_all_packages` targets
(flutter/packages#12978)
2026-09-22 [email protected] [material_ui]
Unskip 5 passing web tests in bottom_app_bar_test and text_field_test
(flutter/packages#12983)
2026-09-22 [email protected]
[cupertino_ui] Unskip 5 passing web tests in
adaptive_text_selection_toolbar_test and text_field_test
(flutter/packages#12984)
2026-09-22 [email protected] [go_router] Fix ShellRoute chrome dropped
from semantics tree by ModalBarrier (flutter/packages#12353)
2026-09-22 [email protected] [material_ui]
Add contrastLevel for M3 ColorScheme (flutter/packages#12743)
2026-09-22 [email protected] [go_router] Preserve nested pushes
during config updates (flutter/packages#12611)
2026-09-22 [email protected] [material_ui]
Migrate M3 Chip template to use new gen_defaults
(flutter/packages#12847)
2026-09-22 [email protected] [material_ui] Fix
LocalHistoryEntry leak when double tapping Drawer scrim
(flutter/packages#12552)
2026-09-22 [email protected] Update suggested reviewers
(flutter/packages#12974)
2026-09-22 [email protected] Sync release-material_ui-1.4.0 to
main (flutter/packages#12966)
2026-09-22 [email protected] Sync release-cupertino_ui-1.1.1 to
main (flutter/packages#12965)
2026-09-21 [email protected] [ci] Update repo
for 3.47 stable release (flutter/packages#12959)
2026-09-21 [email protected] Manual roll Flutter from
27fec0e to 4fcd90b (1 revision) (flutter/packages#12904)
2026-09-21 [email protected] Revert "[go_router_builder] Migrate to
material_ui" (flutter/packages#12962)
2026-09-21 [email protected]
[material_ui] Update `material_ui` tests to prevent them from failing
when framework `TextStyle` changes (flutter/packages#12728)
2026-09-21 [email protected] [go_router_builder] Migrate to
material_ui (flutter/packages#12913)
2026-09-21 [email protected] [material_ui,
cupertino_ui] Bump Flutter version from to 3.47 (flutter/packages#12944)
2026-09-21 [email protected] [cupertino_ui] Work around dart2wasm
optional parameter inference bug in example checkbox tests
(flutter/packages#12961)
2026-09-21 [email protected] [cupertino_ui] Work around dart2wasm
optional parameter inference bug in checkbox_test.dart
(flutter/packages#12956)
2026-09-21 [email protected] [google_sign_in] PR 3/4 Migrate
ViewProvider and GID SDK wrappers from Objective-C to Swift
(flutter/packages#12657)
2026-09-21 [email protected] [google_sign_in] PR 2/4 Migrate
the plugin class from Objective-C to Swift. (flutter/packages#12655)
2026-09-20 [email protected]
[cross_file_darwin] iOS/macOS implementation of `cross_file`
(flutter/packages#12910)
2026-09-20 [email protected]
[cross_file_web] Web implementation of `cross_file`
(flutter/packages#12908)
2026-09-20 [email protected] [material_ui]
Migrate M3 `InputChip` template to use new gen_defaults
(flutter/packages#12850)
2026-09-20 [email protected] [material_ui]
Migrate M3 Checkbox defaults to new gen_defaults
(flutter/packages#12816)
2026-09-20 [email protected] [material_ui]
Migrate M3 `FilterChip` template to use new gen_defaults
(flutter/packages#12849)
2026-09-19 [email protected] [material_ui] Announce PopupMenuButton with a
child as a button (flutter/packages#12585)
2026-09-19 [email protected] Roll Flutter (stable) from
9584c67 to 6a19cca (7 revisions) (flutter/packages#12950)
2026-09-18 [email protected] [material_ui]
Reduce the `material_ui` non-wasm web test suite
(flutter/packages#12763)
2026-09-18 [email protected] Replace
`Mac_x64` builders with `Mac_arm64` ones (flutter/packages#12941)
2026-09-18 [email protected]
[in_app_purchase_storekit] Use `_$SKPaymentDiscountWrapperToJson`
(flutter/packages#12721)
2026-09-18 [email protected] [In_app _purchase] README
excerpt examples and changelog (flutter/packages#12739)
2026-09-18 [email protected] [material_ui] Add alternative
input method for `RangeSlider` in `NavigationMode.directional`
(flutter/packages#12630)
2026-09-18 [email protected]
[cross_file_android] Android implementation of `cross_file`
(flutter/packages#12909)
2026-09-18 [email protected]
[camera_platform_interface] Adds videoOutputPath support to
startVideoRecording (flutter/packages#12667)
2026-09-17 [email protected] [cupertino_ui] Migrate a
snippet in `CupertinoCheckbox`'s API doc to `{@example}` and add unit
tests (flutter/packages#12180)
2026-09-17 [email protected] [material_ui]
Default gen_defaults color helper prefix (flutter/packages#12848)
...
vashworth pushed a commit to vashworth/packages that referenced this pull request Sep 24, 2026
…crim (flutter#12552)

This PR improves the DrawerControllerState lifecycle by making sure the LocalHistoryEntry is properly removed and cleared.

Fixes flutter/flutter#133740

## Pre-Review Checklist

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

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App CICD Run CI/CD p: material_ui triage-design Should be looked at in design triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tapping outside of drawer twice to dismiss it breaks swipe to go back

3 participants