Defer the OverlayEntry listenable disposal until its widget is unmounted #102794
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flutter-dashboard
bot
added
the
framework
LongCatIsLooong
force-pushed
the
defer-OverlayEntry-dispose
branch
from
639ff35 to
60560bb
Compare
goderbauer
reviewed
Apr 29, 2022
|
|
||
| /// Whether the `_OverlayState`s built using this [OverlayEntry] is currently | ||
| /// mounted. | ||
| final ValueNotifier<bool> _overlayStateMounted = ValueNotifier<bool>(false); |
Member
There was a problem hiding this comment.
With this change, we don't need to extend ChangeNotifier anymore, right? There's nothing from it that this class uses, AFIKT. We could just implement the Listenable interface.
Contributor
Author
There was a problem hiding this comment.
Yeah only the docs but I think I overrode the docs for dispose anyways.
| } | ||
|
|
||
| void _didUnmount() { | ||
| if (_disposedByOwner && !mounted) { |
Member
There was a problem hiding this comment.
from the method name (_didUnmount) it should follow that mounted must always be false here? Should that !mounted just be in an assert?
|
|
||
| void _didUnmount() { | ||
| if (_disposedByOwner && !mounted) { | ||
| super.dispose(); |
Member
There was a problem hiding this comment.
No functionality of the superclass appears to be used in this implementation, so there is really no reason to call its dispose method... Technically, you should dispose the _overlayStateMounted, though.
Member
There was a problem hiding this comment.
(see also the other comment about removing the super class altogether)
| assert(_overlay == null, 'An OverlayEntry must first be removed from the Overlay before dispose is called.'); | ||
| _disposedByOwner = true; | ||
| if (!mounted) { | ||
| super.dispose(); |
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 29, 2022
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/plugins
that referenced
this pull request
Apr 29, 2022
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 29, 2022
egramond
pushed a commit
to egramond/flutter
that referenced
this pull request
May 5, 2022
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 25, 2025
## Description This PR adds an assert message to help users understand the error occuring when `OverlayEntry.remove` is called twice. It also adds a comment about calling dispose after removal as this is mandatory since github.com//issues/102794. ## Related Issue Fixes ["Failed assertion: line 207 pos 12: '_overlay != null': is not true" when trying to remove a non null overlayEntry](#145466) Related external issue: LanarsInc/top-snackbar-flutter#80 ## Tests - Adds 1 test.
mboetger
pushed a commit
to mboetger/flutter
that referenced
this pull request
Dec 2, 2025
…er#178163) ## Description This PR adds an assert message to help users understand the error occuring when `OverlayEntry.remove` is called twice. It also adds a comment about calling dispose after removal as this is mandatory since github.com/flutter/issues/102794. ## Related Issue Fixes ["Failed assertion: line 207 pos 12: '_overlay != null': is not true" when trying to remove a non null overlayEntry](flutter#145466) Related external issue: LanarsInc/top-snackbar-flutter#80 ## Tests - Adds 1 test.
reidbaker
pushed a commit
to AbdeMohlbi/flutter
that referenced
this pull request
Dec 10, 2025
…er#178163) ## Description This PR adds an assert message to help users understand the error occuring when `OverlayEntry.remove` is called twice. It also adds a comment about calling dispose after removal as this is mandatory since github.com/flutter/issues/102794. ## Related Issue Fixes ["Failed assertion: line 207 pos 12: '_overlay != null': is not true" when trying to remove a non null overlayEntry](flutter#145466) Related external issue: LanarsInc/top-snackbar-flutter#80 ## Tests - Adds 1 test.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There're customers using
OverlayEntry.addListener(and leaking listeners unfortunately).Alternatively we can let
_OverlayEntryWidgetStateown the value notifier (so it doesn't leak since it will always be disposed by the state object). Old listeners won't be notified when the entry is reused to build new widgets but our internal customer and route entry are only interested in the mounted state of the current widget.Fixes #102718
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.