fix PopupMenuButton unmounted exception when updating position #166412

sstasi95 · 2025-04-02T11:35:29Z

This PR fixes an exception thrown when trying to update an unmounted PopupMenuButton's position, which can happen when a layout change is triggered during PopupMenuButton's pop animation (see issue's attached video).
A workaround is to set popUpAnimationStyle: AnimationStyle.noAnimation.
This PR fixes it by returning the last known position if the button is unmounted.

Exception thrown: FlutterError (This widget has been unmounted, so the State no longer has a context (and should be considered defunct). Consider canceling any active work during "dispose" or using the "mounted" getter to determine if the State is still active.)

Code that causes the exception: final PopupMenuThemeData popupMenuTheme = PopupMenuTheme.of(context);

Fixes #163477

Tested both on stable (3.29.2) and master (a0b1b32)

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.

navaronbracke · 2025-04-03T08:13:05Z

packages/flutter/test/material/popup_menu_test.dart

+    await tester.tap(find.byKey(buttonKey));
+    await tester.pumpAndSettle();
+
+    // TODO(sstasi95): here we should trigger a layout change to test the fix


You can try pumping an unrelated widget with the tester (I.e. a SizedBox), after the button is tapped, to trigger the unmounting of the popup menu.

I've tried but it's not enough, we should also update the layout after the popup menu is unmounted but when is still visible (during the pop animation), as you can see in this screen recording. This way the _positionBuilder method will be called on an unmounted popup menu.

packages/flutter/test/material/popup_menu_test.dart

Piinks · 2025-06-04T22:56:57Z

Hey @sstasi95 it looks like this never entered our review queue since this is a draft. Would you like to move forward with this change?

sstasi95 · 2025-06-05T09:45:07Z

Hi @Piinks, sure. I left it as a draft because I wasn't able to write a test for it, I'll mark it ready for review now

dkwingsmt · 2025-06-24T05:01:26Z

Sorry for the late review and for drafting the PR! I've managed to rewrite your test in the following way, which breaks before your fix and passes after your fix.

  // Regression test for https://github.com/flutter/flutter/issues/163477
  testWidgets("PopupMenu's overlay can be rebuilt even when the button is unmounted", (
    WidgetTester tester,
  ) async {
    final GlobalKey buttonKey = GlobalKey();

    late StateSetter setState;
    bool showButton = true;

    Widget widget({required Size viewSize}) {
      return Center(
        child: SizedBox(
          width: viewSize.width,
          height: viewSize.height,
          child: MaterialApp(
            home: Material(
              child: StatefulBuilder(builder: (BuildContext context, StateSetter innerSetState) {
                setState = innerSetState;
                return showButton
                        ? PopupMenuButton<int>(
                          key: buttonKey,
                          popUpAnimationStyle: const AnimationStyle(
                            reverseDuration: Duration(milliseconds: 400),
                          ),
                          itemBuilder: (BuildContext context) {
                            return <PopupMenuEntry<int>>[
                              PopupMenuItem<int>(
                                value: 1,
                                child: const Text('ACTION'),
                                onTap: () {},
                              ),
                            ];
                          },
                        )
                        : Container();
                }),
              ),
            ),
          ),
      );
    }

    // Pump a button
    await tester.pumpWidget(widget(viewSize: const Size(500, 500)));

    // Tap the button to show the menu
    await tester.tap(find.byKey(buttonKey));
    await tester.pumpAndSettle();
    expect(find.text('ACTION'), findsOne);
    expect(find.byKey(buttonKey), findsOne);

    // Hide the button. The menu still shows since it's placed on a separate route.
    setState(() {
      showButton = false;
    });
    await tester.pump();
    expect(find.text('ACTION'), findsOne);
    expect(find.byKey(buttonKey), findsNothing);

    // Resize the view, causing the menu to rebuild. Before the fix, this
    // rebuild would lead to a crash, because it relies on context of the button,
    // which has been unmounted.
    await tester.pumpWidget(widget(viewSize: const Size(300, 300)));

    expect(tester.takeException(), isNull);
  });

packages/flutter/lib/src/material/popup_menu.dart

dkwingsmt

Everything else looks good to me! Thank you for the investigation.

Co-authored-by: Navaron Bracke <[email protected]>

chunhtai

LGTM

chunhtai · 2025-06-26T18:19:25Z

packages/flutter/lib/src/material/popup_menu.dart

+    }
+
    final PopupMenuThemeData popupMenuTheme = PopupMenuTheme.of(context);
    final RenderBox button = context.findRenderObject()! as RenderBox;


Since this is already implemented this way, so not blocking the merge. but if the goal is to pin the popup to this button with a delta offset, we should use compositedtrasnformfollower and target/leaderlayer. Things will just be simpler with no mounted/unmounted problem

@chunhtai Are you talking about #169814 ?

yes, that is right. although looking at the comment it mentioned some bug about using compsitedfollower, which is new to me.

…ion (flutter/flutter#166412)

…er#166412)  This PR fixes an exception thrown when trying to update an unmounted PopupMenuButton's position, which can happen when a layout change is triggered during PopupMenuButton's pop animation (see issue's attached video). A workaround is to set `popUpAnimationStyle: AnimationStyle.noAnimation`. This PR fixes it by returning the last known position if the button is unmounted. Exception thrown:` FlutterError (This widget has been unmounted, so the State no longer has a context (and should be considered defunct). Consider canceling any active work during "dispose" or using the "mounted" getter to determine if the State is still active.)` Code that causes the exception: `final PopupMenuThemeData popupMenuTheme = PopupMenuTheme.of(context);` Fixes flutter#163477 Tested both on stable (3.29.2) and master (a0b1b32) ## Pre-launch Checklist - [X] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [X] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [X] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [X] I signed the [CLA]. - [X] I listed at least one issue that this PR fixes in the description above. - [X] I updated/added relevant documentation (doc comments with `///`). - [X] I added new tests to check the change I am making, or this PR is [test-exempt]. - [X] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [X] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [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 --------- Co-authored-by: Navaron Bracke <[email protected]> Co-authored-by: Tong Mu <[email protected]>

…ion (flutter/flutter#166412)

…er#166412)  This PR fixes an exception thrown when trying to update an unmounted PopupMenuButton's position, which can happen when a layout change is triggered during PopupMenuButton's pop animation (see issue's attached video). A workaround is to set `popUpAnimationStyle: AnimationStyle.noAnimation`. This PR fixes it by returning the last known position if the button is unmounted. Exception thrown:` FlutterError (This widget has been unmounted, so the State no longer has a context (and should be considered defunct). Consider canceling any active work during "dispose" or using the "mounted" getter to determine if the State is still active.)` Code that causes the exception: `final PopupMenuThemeData popupMenuTheme = PopupMenuTheme.of(context);` Fixes flutter#163477 Tested both on stable (3.29.2) and master (a0b1b32) ## Pre-launch Checklist - [X] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [X] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [X] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [X] I signed the [CLA]. - [X] I listed at least one issue that this PR fixes in the description above. - [X] I updated/added relevant documentation (doc comments with `///`). - [X] I added new tests to check the change I am making, or this PR is [test-exempt]. - [X] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [X] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [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 --------- Co-authored-by: Navaron Bracke <[email protected]> Co-authored-by: Tong Mu <[email protected]>

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Apr 2, 2025

navaronbracke reviewed Apr 3, 2025

View reviewed changes

sstasi95 marked this pull request as ready for review June 5, 2025 09:45

dkwingsmt self-requested a review June 11, 2025 18:24

dkwingsmt reviewed Jun 24, 2025

View reviewed changes

packages/flutter/lib/src/material/popup_menu.dart Show resolved Hide resolved

dkwingsmt reviewed Jun 24, 2025

View reviewed changes

sstasi95 and others added 2 commits June 24, 2025 10:59

check if PopupMenuButton is mounted before updating position

6525222

test: check that no exception is thrown

3ce8dd3

Co-authored-by: Navaron Bracke <[email protected]>

sstasi95 force-pushed the master branch from 5996c9a to 3ce8dd3 Compare June 24, 2025 08:59

fix test and add comment

2adb12d

dkwingsmt self-requested a review June 25, 2025 18:32

dkwingsmt mentioned this pull request Jun 26, 2025

PopupMenuRoute crashes sometimes on drawFrame #163477

Closed

Format

d18f14b

chunhtai approved these changes Jun 26, 2025

View reviewed changes

Merge branch 'master' into master

9c472b8

dkwingsmt approved these changes Jun 26, 2025

View reviewed changes

dkwingsmt added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 26, 2025

auto-submit bot added this pull request to the merge queue Jun 26, 2025

Merged via the queue into flutter:master with commit 777bfea Jun 26, 2025
71 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 26, 2025

engine-flutter-autoroll mentioned this pull request Jun 27, 2025

Roll Flutter from 2773c0c8e15e to d3a2cf8fcd42 (40 revisions) flutter/packages#9510

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jun 27, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

349c559

…ion (flutter/flutter#166412)

engine-flutter-autoroll mentioned this pull request Jun 27, 2025

Roll Flutter from 2773c0c8e15e to fa71d1b3e448 (41 revisions) flutter/packages#9512

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jun 27, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

dcedefe

…ion (flutter/flutter#166412)

engine-flutter-autoroll mentioned this pull request Jun 27, 2025

Roll Flutter from 2773c0c8e15e to af61a6f97daf (42 revisions) flutter/packages#9513

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 2, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

8d02d74

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 2, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

c83aa38

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 2, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

81ee5aa

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 2, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

04f1f08

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 2, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

0f7d2e5

…ion (flutter/flutter#166412)

dkwingsmt mentioned this pull request Jul 2, 2025

PopupMenuButton broken in Flutter 3.32.5 #171422

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 3, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

d0066e8

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 3, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

b42e199

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 3, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

42bdb1e

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 3, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

d9dc697

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 3, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

9c67380

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 4, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

39547d3

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 4, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

a7206f2

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 4, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

e91be50

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 5, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

9f2e6e0

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 5, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

1dbc61e

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 6, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

53bf6af

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 6, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

83673cc

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 6, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

de43120

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 7, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

55037f7

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 7, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

fbe0a30

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 7, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

1e2c6e6

…ion (flutter/flutter#166412)

Piinks mentioned this pull request Jul 19, 2025

Flutter Notable Commits - 2025 #161460

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

3fdf88d

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

a421447

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

580b6a8

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

8f590d4

…ion (flutter/flutter#166412)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

777bfea28 fix PopupMenuButton unmounted exception when updating posit…

c71b3fa

…ion (flutter/flutter#166412)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix PopupMenuButton unmounted exception when updating position #166412

fix PopupMenuButton unmounted exception when updating position #166412

Uh oh!

sstasi95 commented Apr 2, 2025 •

edited

Loading

Uh oh!

navaronbracke Apr 3, 2025

Uh oh!

sstasi95 Apr 3, 2025

Uh oh!

Uh oh!

Piinks commented Jun 4, 2025

Uh oh!

sstasi95 commented Jun 5, 2025

Uh oh!

dkwingsmt commented Jun 24, 2025

Uh oh!

Uh oh!

dkwingsmt left a comment

Uh oh!

chunhtai left a comment

Uh oh!

chunhtai Jun 26, 2025

Uh oh!

dkwingsmt Jun 26, 2025

Uh oh!

chunhtai Jun 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

fix PopupMenuButton unmounted exception when updating position #166412

fix PopupMenuButton unmounted exception when updating position #166412

Uh oh!

Conversation

sstasi95 commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

navaronbracke Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

sstasi95 Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Piinks commented Jun 4, 2025

Uh oh!

sstasi95 commented Jun 5, 2025

Uh oh!

dkwingsmt commented Jun 24, 2025

Uh oh!

Uh oh!

dkwingsmt left a comment

Choose a reason for hiding this comment

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

chunhtai Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

dkwingsmt Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sstasi95 commented Apr 2, 2025 •

edited

Loading