fixes cupertino page transition leak [prod-leak-fix] #147133

Dimilkalathiya · 2024-04-21T08:35:50Z

Fixes CupertinoPageTransition widget leaks

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.

flutter-dashboard · 2024-04-21T08:35:53Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Dimilkalathiya · 2024-04-21T08:56:32Z

cc: @polina-c

These changes directly reduces route_test.dart leaks from 1540 to 660 and also reduces leaks on other testcases which indirectly using CupertinoPageTransition there are some other transition that has same problem as this, Using curve animation class directly in stateless widgets that does not get disposed

i want know if this is good approach (converting it into stateful widgets and using initState, didUpdateWidget dispose) to fix this issue before i pick other transition widgets so i kind of don't repeat issue on other PRs while i am at it 😅.

Also while looking into curve animation leaks i've noticed few things that might help-out:-

Most of curve animation leak seems to be connected routing related functionality like PopupRoute, Transition widgets and dialog functions like showDateRangePicker which internally using some kinds of route related classes fixing this will indirectly fix most of leaks

polina-c · 2024-04-21T22:05:27Z

packages/flutter/lib/src/cupertino/route.dart

+    _primaryShadowCurve?.dispose();
+  }
+
+  void _init() {


Since we invoke this method not only in the beginning, but also when widget is updated, meay be better name will be something like _setupAnimation?

packages/flutter/lib/src/cupertino/route.dart

polina-c · 2024-04-21T22:08:38Z

cc: @polina-c

These changes directly reduces route_test.dart leaks from 1540 to 660 and also reduces leaks on other testcases which indirectly using CupertinoPageTransition there are some other transition that has same problem as this, Using curve animation class directly in stateless widgets that does not get disposed

i want know if this is good approach (converting it into stateful widgets and using initState, didUpdateWidget dispose) to fix this issue before i pick other transition widgets so i kind of don't repeat issue on other PRs while i am at it 😅.

Also while looking into curve animation leaks i've noticed few things that might help-out:-

Most of curve animation leak seems to be connected routing related functionality like PopupRoute, Transition widgets and dialog functions like showDateRangePicker which internally using some kinds of route related classes fixing this will indirectly fix most of leaks

Thanks. Yes, in general approach looks correct. This does not mean it will be applicable everywhere though :)

polina-c · 2024-04-21T22:34:41Z

1540 to 660 sounds impressive. Thank you!

Dimilkalathiya · 2024-04-22T15:08:09Z

Hii @polina-c Updated PR as per suggestion thanks for the review :)

polina-c · 2024-04-22T17:36:01Z

packages/flutter/lib/src/cupertino/route.dart

+
+  @override
+  void didUpdateWidget(covariant CupertinoPageTransition oldWidget) {
+    super.didUpdateWidget(oldWidget);


Should linearTransition be here as well?

Actually primaryRouteAnimation will also change when linearTransition gets switched so i thought not make things more complicated, but it seems adding it would be good fail-safe, so added in last commit :)

ValentinVignal

I was working on the same fixes in #146999. I believe there are some issues in those changes:

You might dispose some CurvedAnimation twice
You are actually always recreating the CurvedAnimation in each build because of oldWidget.child != widget.child which will always be true. This is why you are not facing the failing tests I am facing in #146999

Those issues are "fixed" in #146999 so maybe I can continue the work there

ValentinVignal · 2024-04-23T04:09:58Z

packages/flutter/lib/src/cupertino/route.dart

+    if (oldWidget.primaryRouteAnimation != widget.primaryRouteAnimation
+    || oldWidget.secondaryRouteAnimation != widget.secondaryRouteAnimation
+    || oldWidget.child != widget.child || oldWidget.linearTransition != widget.linearTransition) {
+    _disposeCurve();
+    _setupAnimation();
+    }
+  }


You don't need to check the child is different here, right? It is not used in the curve

ValentinVignal · 2024-04-23T04:10:34Z

packages/flutter/lib/src/cupertino/route.dart

+  void _disposeCurve() {
+    _primaryPositionCurve?.dispose();
+    _secondaryPositionCurve?.dispose();
+    _primaryShadowCurve?.dispose();
+  }
+
+  void _setupAnimation() {
+    _primaryPositionAnimation =
+           (widget.linearTransition
+             ? widget.primaryRouteAnimation
+             : _primaryPositionCurve = CurvedAnimation(
+                 parent: widget.primaryRouteAnimation,
                 curve: Curves.fastEaseInToSlowEaseOut,
                 reverseCurve: Curves.fastEaseInToSlowEaseOut.flipped,


Careful, because here you might end up with disposing the curved animation twice. You are not resetting it to null

Dimilkalathiya · 2024-04-23T16:01:11Z

@ValentinVignal Oh, it seems we were working on same issue, thanks for your review :)
while looking into your PR it looks like you're almost already figure out solution.

Dimilkalathiya · 2024-04-23T16:02:30Z

@polina-c Would you like me to continue on this? i can modify it as per @ValentinVignal suggestion, but if he already almost finished, there is no point in continuing.

flutter/flutter@140edb9...77043ba 2024-04-23 [email protected] Roll Flutter Engine from ffd3911b1ff7 to 79f49954cce8 (2 revisions) (flutter/flutter#147235) 2024-04-23 [email protected] Roll Flutter Engine from c7d9deb66bf7 to ffd3911b1ff7 (1 revision) (flutter/flutter#147227) 2024-04-23 [email protected] Roll pub packages (flutter/flutter#147220) 2024-04-23 [email protected] Roll Flutter Engine from 075d834489d0 to c7d9deb66bf7 (2 revisions) (flutter/flutter#147215) 2024-04-23 [email protected] Mention visualDensity impact on ButtonStyle.padding documentation (flutter/flutter#147048) 2024-04-23 [email protected] Roll Flutter Engine from 9c0d24ff1cb6 to 075d834489d0 (1 revision) (flutter/flutter#147214) 2024-04-23 [email protected] Fix memory leaks in `CupertinoTextMagnifier` (flutter/flutter#147208) 2024-04-23 [email protected] Roll Flutter Engine from 004e98839ed7 to 9c0d24ff1cb6 (1 revision) (flutter/flutter#147211) 2024-04-23 [email protected] Roll Flutter Engine from 79f753650c6e to 004e98839ed7 (1 revision) (flutter/flutter#147209) 2024-04-23 [email protected] Roll Flutter Engine from f8e373da5227 to 79f753650c6e (1 revision) (flutter/flutter#147206) 2024-04-23 [email protected] fixes cupertino page transition leak (flutter/flutter#147133) 2024-04-23 [email protected] Fix memory leaks in `PopupMenu` (flutter/flutter#147174) 2024-04-23 [email protected] Roll Flutter Engine from 62c9f17169cf to f8e373da5227 (2 revisions) (flutter/flutter#147205) 2024-04-23 [email protected] Roll Flutter Engine from 33c828fb3ff5 to 62c9f17169cf (4 revisions) (flutter/flutter#147203) 2024-04-23 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.2 to 4.3.3 (flutter/flutter#147192) 2024-04-23 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.25.1 to 3.25.2 (flutter/flutter#147193) 2024-04-23 [email protected] Roll Flutter Engine from a4b71f02a1c7 to 33c828fb3ff5 (9 revisions) (flutter/flutter#147190) 2024-04-22 [email protected] Roll pub packages (flutter/flutter#147094) 2024-04-22 [email protected] Re-land fix for not disposed TabController (flutter/flutter#146745) 2024-04-22 [email protected] Roll Flutter Engine from 75ca2195c936 to a4b71f02a1c7 (1 revision) (flutter/flutter#147175) 2024-04-22 [email protected] Update `examples/api` for android platform (flutter/flutter#147102) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

polina-c · 2024-04-23T18:08:43Z

Sorry, I did not catch duplicate.

@ValentinVignal , thanks for good catches.
@Dimilkalathiya , yes, please, follow up with improvements.

ValentinVignal · 2024-04-24T01:06:09Z

@Dimilkalathiya, @polina-c I'll continue with my PR (#146999) so I guess we are good for CupertinoPageTransition.

You can try to fix the same issues you have in your other PR for CupertinoFullscreenDialogTransition #147168

flutter/flutter@140edb9...77043ba 2024-04-23 [email protected] Roll Flutter Engine from ffd3911b1ff7 to 79f49954cce8 (2 revisions) (flutter/flutter#147235) 2024-04-23 [email protected] Roll Flutter Engine from c7d9deb66bf7 to ffd3911b1ff7 (1 revision) (flutter/flutter#147227) 2024-04-23 [email protected] Roll pub packages (flutter/flutter#147220) 2024-04-23 [email protected] Roll Flutter Engine from 075d834489d0 to c7d9deb66bf7 (2 revisions) (flutter/flutter#147215) 2024-04-23 [email protected] Mention visualDensity impact on ButtonStyle.padding documentation (flutter/flutter#147048) 2024-04-23 [email protected] Roll Flutter Engine from 9c0d24ff1cb6 to 075d834489d0 (1 revision) (flutter/flutter#147214) 2024-04-23 [email protected] Fix memory leaks in `CupertinoTextMagnifier` (flutter/flutter#147208) 2024-04-23 [email protected] Roll Flutter Engine from 004e98839ed7 to 9c0d24ff1cb6 (1 revision) (flutter/flutter#147211) 2024-04-23 [email protected] Roll Flutter Engine from 79f753650c6e to 004e98839ed7 (1 revision) (flutter/flutter#147209) 2024-04-23 [email protected] Roll Flutter Engine from f8e373da5227 to 79f753650c6e (1 revision) (flutter/flutter#147206) 2024-04-23 [email protected] fixes cupertino page transition leak (flutter/flutter#147133) 2024-04-23 [email protected] Fix memory leaks in `PopupMenu` (flutter/flutter#147174) 2024-04-23 [email protected] Roll Flutter Engine from 62c9f17169cf to f8e373da5227 (2 revisions) (flutter/flutter#147205) 2024-04-23 [email protected] Roll Flutter Engine from 33c828fb3ff5 to 62c9f17169cf (4 revisions) (flutter/flutter#147203) 2024-04-23 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.2 to 4.3.3 (flutter/flutter#147192) 2024-04-23 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.25.1 to 3.25.2 (flutter/flutter#147193) 2024-04-23 [email protected] Roll Flutter Engine from a4b71f02a1c7 to 33c828fb3ff5 (9 revisions) (flutter/flutter#147190) 2024-04-22 [email protected] Roll pub packages (flutter/flutter#147094) 2024-04-22 [email protected] Re-land fix for not disposed TabController (flutter/flutter#146745) 2024-04-22 [email protected] Roll Flutter Engine from 75ca2195c936 to a4b71f02a1c7 (1 revision) (flutter/flutter#147175) 2024-04-22 [email protected] Update `examples/api` for android platform (flutter/flutter#147102) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

flutter-dashboard · 2024-08-29T03:51:09Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

fixes cupertino page transition leak

0c7c0b7

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

polina-c added the a: leak tracking Issues and PRs related to memory leaks detected by leak_tracker label Apr 21, 2024

polina-c reviewed Apr 21, 2024

View reviewed changes

packages/flutter/lib/src/cupertino/route.dart Show resolved Hide resolved

add update conditions and rename function to make is readable

e9f4bb0

polina-c reviewed Apr 22, 2024

View reviewed changes

adding linearTransition condition

d327eb2

polina-c approved these changes Apr 22, 2024

View reviewed changes

polina-c merged commit 65fbd52 into flutter:master Apr 23, 2024

ValentinVignal reviewed Apr 23, 2024

View reviewed changes

This was referenced Apr 23, 2024

Fix janks and memory leaks in CupertinoPageTransition and CupertinoFullscreenDialogTransition [prod-leak-fix] #146999

Merged

fixes CupertinoFullscreenDialogTransition leaks [prod-leak-fix] #147168

Merged

engine-flutter-autoroll mentioned this pull request Apr 23, 2024

Roll Flutter from 140edb988312 to 77043bae1a5e (21 revisions) flutter/packages#6599

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 23, 2024

65fbd52 fixes cupertino page transition leak (flutter/flutter#147133)

6bfc034

HansMuller mentioned this pull request Apr 26, 2024

Flutter Framework Team: Notable Commits #121415

Closed

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

65fbd52 fixes cupertino page transition leak (flutter/flutter#147133)

086c8d9

polina-c changed the title ~~fixes cupertino page transition leak~~ fixes cupertino page transition leak [prod-leak-fix] Aug 29, 2024

fixes cupertino page transition leak [prod-leak-fix] #147133

fixes cupertino page transition leak [prod-leak-fix] #147133

Uh oh!

Conversation

Dimilkalathiya commented Apr 21, 2024

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Apr 21, 2024

Uh oh!

Dimilkalathiya commented Apr 21, 2024

Uh oh!

polina-c Apr 21, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

polina-c commented Apr 21, 2024

Uh oh!

polina-c commented Apr 21, 2024

Uh oh!

Dimilkalathiya commented Apr 22, 2024

Uh oh!

polina-c Apr 22, 2024

Choose a reason for hiding this comment

Uh oh!

Dimilkalathiya Apr 22, 2024

Choose a reason for hiding this comment

Uh oh!

ValentinVignal left a comment

Choose a reason for hiding this comment

Uh oh!

ValentinVignal Apr 23, 2024

Choose a reason for hiding this comment

Uh oh!

ValentinVignal Apr 23, 2024

Choose a reason for hiding this comment

Uh oh!

Dimilkalathiya commented Apr 23, 2024

Uh oh!

Dimilkalathiya commented Apr 23, 2024

Uh oh!

polina-c commented Apr 23, 2024

Uh oh!

ValentinVignal commented Apr 24, 2024

Uh oh!

flutter-dashboard bot commented Aug 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants