Add the createDependency parameter to ModalRoute.of #145389

LinXunFeng · 2024-03-19T10:25:39Z

Added createDependency parameter to ModalRoute.of, which allows developer to freely choose to use dependOnInheritedWidgetOfExactType or getElementForInheritedWidgetOfExactType to obtain ModalRoute.

Releated issue:

Page that use ModalRoute.of will trigger the build method when pushing or popping another page. #145387
call ModalRoute.of(context) causes route created twice in flutter 3.19 #145136

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.

wanjm · 2024-03-20T00:39:01Z

packages/flutter/lib/src/widgets/routes.dart

  /// while it is visible (specifically, if [isCurrent] or [canPop] change value).
  @optionalTypeArgs
-  static ModalRoute<T>? of<T extends Object?>(BuildContext context) {
-    final _ModalScopeStatus? widget = context.dependOnInheritedWidgetOfExactType<_ModalScopeStatus>();


I found this line of code didn't change in 3.19. but why the action is changed.

The main reason is that these codes were added in the PR #134554

flutter/packages/flutter/lib/src/widgets/routes.dart

Lines 1711 to 1721 in ba39319

@override

void didChangeNext(Route<dynamic>? nextRoute) {

super.didChangeNext(nextRoute);

changedInternalState();

}

@override

void didPopNext(Route<dynamic> nextRoute) {

super.didPopNext(nextRoute);

changedInternalState();

}

in my scenario ,when calling showDialog will also come across such problem as I said in #145136 (comment) , so this case also need to be dealt;

It also applies showDialog

goderbauer · 2024-03-21T18:26:55Z

packages/flutter/lib/src/widgets/routes.dart


+  /// Obtains the element corresponding to the nearest widget of
+  /// [_ModalScopeStatus] within the given [context].
+  @visibleForTesting


https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#avoid-using-visiblefortesting

Added @protected

It's a static method. @protected doesn't make sense here.

goderbauer · 2024-03-21T18:28:46Z

packages/flutter/lib/src/widgets/routes.dart

-    final _ModalScopeStatus? widget = context.dependOnInheritedWidgetOfExactType<_ModalScopeStatus>();
+  static ModalRoute<T>? of<T extends Object?>(
+    BuildContext context, {
+    bool createDependency = true,


What problem is it solving to not create the dependency? In my experience, this kind of API often ends up being a footgun where people forget to switch this to true when their code evolves and they do actually need to rebuild when ModalRoute changes.

In many cases, people obtain route arguments through ModalRoute.of(context)?.settings.arguments. In this scenario, there is no need to create dependency.

Now after upgrading to 3.19, I found that I obtained the route arguments in Page2 and then pushed to Page3. During the process of Page3 being pushed and popped, the build method of Page2 will be called again because of ModalRoute.of. In this process, it is meaningless for Page2 to re-obtain routing arguments.

2024-03-22.10.08.36.mov

In many cases, people obtain route arguments through ModalRoute.of(context)?.settings.arguments. In this scenario, there is no need to create dependency.

The settings associated with a route (and with that the arguments) can change, though (see [1]). Not creating a dependency will lead to bugs because widgets that previously read the args will not rebuild with the new args. So, this API will likely be a foot gun. Instead, we could consider an API that only rebuilds when the arguments change. Something like ModalRoute.argumentsOf(context).

[1]

flutter/packages/flutter/lib/src/widgets/navigator.dart

Line 191 in ac5be2d

void _updateSettings(RouteSettings newSettings) {

Good suggestion, but sorry I don’t have time to complete it, thanks for reviewing.

LinXunFeng · 2024-04-03T01:30:27Z

@goderbauer Hello, will you continue to review it?

If you do not accept the changes in this PR, could you please indicate how to solve unnecessary rebuild caused by use ModalRoute.of(context)?.settings.arguments? This is very important to us, thank you!

goderbauer · 2024-04-03T16:23:04Z

Yes, I have this on my list of PRs to review and will get back to it shortly. Sorry for the delay.

ref: flutter/flutter#145389

ioma8 · 2024-04-11T08:09:45Z

@goderbauer How does it look? This issue is kinda blocking our update of flutter.

ioma8 · 2024-04-11T08:10:06Z

@goderbauer Hello, will you continue to review it?

If you do not accept the changes in this PR, could you please indicate how to solve unnecessary rebuild caused by use ModalRoute.of(context)?.settings.arguments? This is very important to us, thank you!

Have you found any other solution yet?

LinXunFeng · 2024-04-11T08:16:31Z

Have you found any other solution yet?

@ioma8 We temporarily solve this issue by modifying the flutter source code.

# Enter your local flutter directory
cd /Users/lxf/fvm/versions/3.19.3

# Download patch
curl -O https://raw.githubusercontent.com/LinXunFeng/flutter_assets/main/patch/01_rollbak_3_19_routes_change/0001-Roll-back-changes-to-routes.dart.patch

# Apply patch
git apply 0001-Roll-back-changes-to-routes.dart.patch

Related article: Flutter - 升级3.19之后页面多次rebuild？🤨

kandevis · 2024-04-11T08:50:49Z

This issue is blocking us to upgrade to Flutter 3.19.x
The widget tree rebuild issue make performance terrible. @goderbauer Can you continue to review it or put another solution to this issue.

CoderBuck · 2024-04-15T08:01:40Z

My temporary solution: replace all instances of ModalRoute.of(context) with MyModalRoute.of(context).

/// replace ModalRoute.of(context)
class MyModalRoute {

  static ModalRoute<dynamic>? of(BuildContext context) {
    ModalRoute<dynamic>? route;
    context.visitAncestorElements((element) {
      if(element.widget.runtimeType.toString() == '_ModalScopeStatus') {
        dynamic widget = element.widget;
        route = widget.route as ModalRoute;
        return false;
      }
      return true;
    });
    return route;
  }
}

ghost · 2024-04-16T09:30:06Z

Close when no one care about this issue =)). LOL

cjcj125125 · 2024-04-19T01:58:34Z

真的没人在乎么，我很在乎呀，我这个该死的强迫症

harismairaj · 2024-04-23T10:11:08Z

My temporary solution: replace all instances of ModalRoute.of(context) with MyModalRoute.of(context).

/// replace ModalRoute.of(context)
class MyModalRoute {

  static ModalRoute<dynamic>? of(BuildContext context) {
    ModalRoute<dynamic>? route;
    context.visitAncestorElements((element) {
      if(element.widget.runtimeType.toString() == '_ModalScopeStatus') {
        dynamic widget = element.widget;
        route = widget.route as ModalRoute;
        return false;
      }
      return true;
    });
    return route;
  }
}

It is working for me. Thanks @CoderBuck for the solution.

According to previous discussion at #145389 (comment), this change makes `_ModalScopeStatus` an `InheritedModel` rather than an `InheritedWidget`, and provides the following methods. - `isCurrentOf` - `canPopOf` - `settingsOf` For example, `ModalRoute.of(context)!.settings` could become `ModalRoute.settingsOf(context)` as a performance optimization.

According to previous discussion at flutter#145389 (comment), this change makes `_ModalScopeStatus` an `InheritedModel` rather than an `InheritedWidget`, and provides the following methods. - `isCurrentOf` - `canPopOf` - `settingsOf` For example, `ModalRoute.of(context)!.settings` could become `ModalRoute.settingsOf(context)` as a performance optimization.

Plinzen · 2024-06-17T13:45:16Z

/// replace ModalRoute.of(context)
class MyModalRoute {

  static ModalRoute<dynamic>? of(BuildContext context) {
    ModalRoute<dynamic>? route;
    context.visitAncestorElements((element) {
      if(element.widget.runtimeType.toString() == '_ModalScopeStatus') {
        dynamic widget = element.widget;
        route = widget.route as ModalRoute;
        return false;
      }
      return true;
    });
    return route;
  }
}

Is there also a solution when the code is obfuscated? Since the _ModalScopeStatus class is renamed by obfuscation this check doesn't work on an obfuscated release build.

Add the listen parameter to ModalRoute.of

e7d24ec

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: routes Navigator, Router, and related APIs. labels Mar 19, 2024

EduardoDadalt mentioned this pull request Mar 19, 2024

ModalRoute.of(context) + DropdownButton = Rebuild in every interaction with DropdownButton #143709

Closed

wanjm reviewed Mar 20, 2024

View reviewed changes

Rename listen to createDependency

59311a4

LinXunFeng changed the title ~~Add the listen parameter to ModalRoute.of~~ Add the createDependency parameter to ModalRoute.of Mar 20, 2024

LinXunFeng requested a review from goderbauer March 21, 2024 01:05

goderbauer reviewed Mar 21, 2024

View reviewed changes

Add @Protected

ef332a8

darshankawar mentioned this pull request Apr 8, 2024

[Navigator 2.0] All pages rebuild on push/pop on Flutter 3.19.x #146132

Closed

j-fbriere added a commit to j-fbriere/squawker that referenced this pull request Apr 8, 2024

fix unnecessary rebuilds when using ModalRoute.of() with flutter 3.19.x.

ac41a05

ref: flutter/flutter#145389

LinXunFeng closed this Apr 16, 2024

harismairaj mentioned this pull request Apr 23, 2024

Build a widget again & again if use ModalRoute.of(context) and open or close a Dialog or Dropdown on Web. #147167

Closed

LinXunFeng mentioned this pull request May 24, 2024

_ModalScopeStatus as InheritedModel #149022

Merged

9 tasks

LinXunFeng deleted the modal_route_of_add_listen_param branch February 12, 2025 01:58

	@override
	void didChangeNext(Route<dynamic>? nextRoute) {
	super.didChangeNext(nextRoute);
	changedInternalState();
	}

	@override
	void didPopNext(Route<dynamic> nextRoute) {
	super.didPopNext(nextRoute);
	changedInternalState();
	}

Add the createDependency parameter to ModalRoute.of #145389

Add the createDependency parameter to ModalRoute.of #145389

Uh oh!

Conversation

LinXunFeng commented Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LinXunFeng Mar 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LinXunFeng Mar 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LinXunFeng Mar 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LinXunFeng commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

goderbauer commented Apr 3, 2024

Uh oh!

ioma8 commented Apr 11, 2024

Uh oh!

ioma8 commented Apr 11, 2024

Uh oh!

LinXunFeng commented Apr 11, 2024

Uh oh!

kandevis commented Apr 11, 2024

Uh oh!

CoderBuck commented Apr 15, 2024

Uh oh!

ghost commented Apr 16, 2024

Uh oh!

cjcj125125 commented Apr 19, 2024

Uh oh!

harismairaj commented Apr 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Plinzen commented Jun 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

LinXunFeng commented Mar 19, 2024 •

edited

Loading

LinXunFeng Mar 20, 2024 •

edited

Loading

LinXunFeng Mar 22, 2024 •

edited

Loading

LinXunFeng Mar 22, 2024 •

edited

Loading

LinXunFeng commented Apr 3, 2024 •

edited

Loading

harismairaj commented Apr 23, 2024 •

edited

Loading

Plinzen commented Jun 17, 2024 •

edited

Loading