Do not rebuild when TickerMode changes #93166

goderbauer · 2021-11-05T22:57:54Z

Prior to this change, all widgets using the TickerProviderStateMixin would rebuild unnecessarily when the TickerMode changed. That's because the provider mixin created a dependency on TickerMode. The rebuild is unnecessary, because a changing ticker mode doesn't have any visual effects. All it needs to do is disable/enable the vended Tickers. When the Tickers start ticking again, their listeners may cause rebuilds independently e.g. to advance an animation.

Also fixes an issue where in certain cases EditableTextState would instantiate AnimationControllers in dispose only to dispose them.

dnfield · 2021-11-05T23:18:18Z

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

@@ -1808,12 +1807,12 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
    _internalScrollController?.dispose();
    _currentAutofillScope?.unregister(autofillId);
    widget.controller.removeListener(_didChangeTextEditingValue);
-    _floatingCursorResetController.dispose();
+    _floatingCursorResetController?.dispose();


How do we get a dispose without an init state?

also nit: null the variable after disposing it?

How do we get a dispose without an init state?

These weren't initialized in initState. Instead, the variable was marked as late, which initializes them on first access. If the floating cursor is never shown throughout the lifetime of this object (which is possible), then the first access was in dispose here.

nulling out: Done.

Can we add a test to make sure we don't regress this? Specifically a test that verifies we don't do whatever work these controllers would drive if we just immediately dispose the widget?

Hm, I don't see a good way to test this. The test would have to verify that dispose doesn't instantiate any AnimationControllers.

Ahh agreed, I misunderstood what's going on here. Filed dart-lang/linter#3058 which could help with this.

dnfield · 2021-11-06T04:02:20Z

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

+  /// [TickerMode] ancestor, it is up to the [Widget] to obtain a new
+  /// [ValueNotifier] from the new ancestor [TickerMode] by calling this method
+  /// again. [StatefulWidget]s can, for example, do this in [State.activate].


Express this more prescriptively: if the widget is moved, it must unsubscribe from the old notifier and subscribe to any new one that might be available, the correct place to do this is state.deactivate/activate.

Re-wrote this section to incorporate that information.

dnfield

Seems fine overall

dnfield · 2021-11-06T04:02:58Z

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

+  ///
+  /// While the [ValueNotifier] is stable for the lifetime of the surrounding
+  /// [TickerMode], calling this method does not establish a dependency between
+  /// the `context` and the [TickerMode]. When the [Widget] owning the `context`


Explain the difference between establishing a dependency or not and why you'd want to avoid it (unnecessarily rebuilding to stop an animation controller, building anyway once the animation controller is started)

Re-wrote this section to incorporate that information.

goderbauer

PTAL

goderbauer · 2021-11-08T18:39:59Z

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

@@ -1808,12 +1807,12 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
    _internalScrollController?.dispose();
    _currentAutofillScope?.unregister(autofillId);
    widget.controller.removeListener(_didChangeTextEditingValue);
-    _floatingCursorResetController.dispose();
+    _floatingCursorResetController?.dispose();


nulling out: Done.

goderbauer · 2021-11-08T18:44:01Z

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

+  /// [TickerMode] ancestor, it is up to the [Widget] to obtain a new
+  /// [ValueNotifier] from the new ancestor [TickerMode] by calling this method
+  /// again. [StatefulWidget]s can, for example, do this in [State.activate].


Re-wrote this section to incorporate that information.

goderbauer · 2021-11-08T19:02:41Z

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

+  ///
+  /// While the [ValueNotifier] is stable for the lifetime of the surrounding
+  /// [TickerMode], calling this method does not establish a dependency between
+  /// the `context` and the [TickerMode]. When the [Widget] owning the `context`


Re-wrote this section to incorporate that information.

dnfield · 2021-11-08T19:10:28Z

Also, it seems like we should have a test that routes do not rebuild when their ticker mode changes to muted and they are covered.

skia-gold · 2021-11-08T19:10:34Z

Gold has detected about 18 new digest(s) on patchset 2.
View them at https://flutter-gold.skia.org/cl/github/93166

goderbauer · 2021-11-08T21:10:35Z

Also, it seems like we should have a test that routes do not rebuild when their ticker mode changes to muted and they are covered.

That's what the test "Ticking widgets in old route do not rebuild when new route is pushed" in this PR is covering.

dnfield

LGTM

fluttergithubbot · 2021-11-08T21:47:35Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Linux web_canvaskit_tests_5 has failed. Please fix the issues identified (or deflake) before re-applying this label.

goderbauer · 2021-11-09T18:02:45Z

Curiously, the test that's failing on the Linux web_canvaskit_tests_5 shard...

05:03 +616 ~16 -1: test/cupertino/context_menu_action_test.dart: turns grey when pressed and held [E]                                                                                                  
  Test failed. See exception logs above.
  The test description was: turns grey when pressed and held

... is supposed to be skipped:

flutter/dev/bots/test.dart

Line 135 in 2a17ce4

'test/cupertino/context_menu_action_test.dart',

goderbauer · 2021-11-09T18:13:06Z

Looks like the test has since been excluded from running: #93268

Rebasing and trying again...

zanderso · 2021-11-16T16:11:22Z

There were some nice improvements to flutter gallery frame build times on this change: https://flutter-flutter-perf.skia.org/e/?begin=1635352385&end=1637009732&keys=X868dfa49d7994e8de2106df6966dcc25&requestType=0&xbaroffset=26521

flutter-dashboard bot added a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels. labels Nov 5, 2021

google-cla bot added the cla: yes label Nov 5, 2021

goderbauer requested a review from dnfield November 5, 2021 22:58

dnfield reviewed Nov 5, 2021

View reviewed changes

dnfield reviewed Nov 6, 2021

View reviewed changes

goderbauer force-pushed the tickerMode branch from 17fe1ab to 5c6e19b Compare November 8, 2021 19:02

goderbauer commented Nov 8, 2021

View reviewed changes

dnfield mentioned this pull request Nov 8, 2021

proposal: no_lazy_instantiation_of_disposables dart-lang/linter#3058

Open

dnfield approved these changes Nov 8, 2021

View reviewed changes

goderbauer added the waiting for tree to go green label Nov 8, 2021

fluttergithubbot removed the waiting for tree to go green label Nov 8, 2021

goderbauer added 2 commits November 9, 2021 10:03

Do not rebuild when TickerMode changes

46dd5f3

dan review

52a72e9

goderbauer force-pushed the tickerMode branch from 5c6e19b to 52a72e9 Compare November 9, 2021 18:04

goderbauer added the waiting for tree to go green label Nov 9, 2021

fluttergithubbot merged commit fe8e882 into flutter:master Nov 9, 2021

goderbauer deleted the tickerMode branch November 16, 2021 16:53

WizzXu pushed a commit to WizzXu/flutter that referenced this pull request Nov 19, 2021

Do not rebuild when TickerMode changes (flutter#93166)

d3f318d

This was referenced Jun 11, 2024

A ticker created by useSingleTickerProvider is not muted properly rrousselGit/flutter_hooks#431

Closed

Update useSingleTickerProvider based on SingleTickerProviderStateMixin rrousselGit/flutter_hooks#432

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not rebuild when TickerMode changes #93166

Do not rebuild when TickerMode changes #93166

goderbauer commented Nov 5, 2021 •

edited

Loading

dnfield Nov 5, 2021

dnfield Nov 5, 2021

goderbauer Nov 8, 2021

goderbauer Nov 8, 2021

dnfield Nov 8, 2021

goderbauer Nov 8, 2021

dnfield Nov 8, 2021

dnfield Nov 6, 2021

goderbauer Nov 8, 2021

dnfield left a comment

dnfield Nov 6, 2021

goderbauer Nov 8, 2021

goderbauer left a comment

goderbauer Nov 8, 2021

goderbauer Nov 8, 2021

goderbauer Nov 8, 2021

dnfield commented Nov 8, 2021

skia-gold commented Nov 8, 2021

goderbauer commented Nov 8, 2021 •

edited

Loading

dnfield left a comment

fluttergithubbot commented Nov 8, 2021

goderbauer commented Nov 9, 2021

goderbauer commented Nov 9, 2021

zanderso commented Nov 16, 2021

Do not rebuild when TickerMode changes #93166

Do not rebuild when TickerMode changes #93166

Conversation

goderbauer commented Nov 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnfield left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goderbauer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnfield commented Nov 8, 2021

skia-gold commented Nov 8, 2021

goderbauer commented Nov 8, 2021 • edited Loading

dnfield left a comment

Choose a reason for hiding this comment

fluttergithubbot commented Nov 8, 2021

goderbauer commented Nov 9, 2021

goderbauer commented Nov 9, 2021

zanderso commented Nov 16, 2021

goderbauer commented Nov 5, 2021 •

edited

Loading

goderbauer commented Nov 8, 2021 •

edited

Loading