Skip to content

Fix an issue that clearing the image cache may cause resource leaks #104527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
fluttergithubbot merged 1 commit into from
May 24, 2022
Merged

Fix an issue that clearing the image cache may cause resource leaks #104527

fluttergithubbot merged 1 commit into from
May 24, 2022

Conversation

@yeatse
Copy link
Contributor

@yeatse yeatse commented May 24, 2022 •
edited
Loading

When we call clear() to ImageCache, it will clear the _pendingImages list. According to

flutter/packages/flutter/lib/src/painting/image_cache.dart

Lines 430 to 433 in 7ca4984

final _PendingImage? pendingImage = untrackedPendingImage ?? _pendingImages.remove(key);
if (pendingImage != null) {
pendingImage.removeListener();
}

cleared _PendingImage objects will never call removeListener(), so their memory will never be freed.

This PR tries to fix this issue.

closes #104522

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.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@flutter-dashboard flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label May 24, 2022
@goderbauer goderbauer requested a review from dnfield May 24, 2022 21:18
dnfield
dnfield approved these changes May 24, 2022
View reviewed changes
Copy link
Contributor

@dnfield dnfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Thanks for the detailed explanation and the test.

@dnfield
Copy link
Contributor

dnfield commented May 24, 2022

@goderbauer can you provide a secondary review?

goderbauer
goderbauer approved these changes May 24, 2022
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fluttergithubbot fluttergithubbot merged commit b5adbee into flutter:master May 24, 2022
@yeatse yeatse deleted the prevent-leaks-in-pending-image branch May 25, 2022 00:02
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 25, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request May 25, 2022
@engine-flutter-autoroll
b5adbee Fix an issue that clearing the image cache may cause resource…
a91447d 
… leaks (flutter/flutter#104527)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 25, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 25, 2022
@engine-flutter-autoroll
b5adbee Fix an issue that clearing the image cache may cause resource…
1e5e2ec 
… leaks (flutter/flutter#104527)
yzhtracy pushed a commit to BuildAndRelease/flutter that referenced this pull request Jun 15, 2022
@yeatse @yzhtracy
Fix an issue that clearing the image cache may cause resource leaks (f…
4cece1f 
…lutter#104527)
yzhtracy pushed a commit to BuildAndRelease/flutter that referenced this pull request Jun 16, 2022
@yeatse @yzhtracy
Fix an issue that clearing the image cache may cause resource leaks (f…
af8ec45 
…lutter#104527)
yzhtracy pushed a commit to BuildAndRelease/flutter that referenced this pull request Jun 17, 2022
@yeatse @yzhtracy
Fix an issue that clearing the image cache may cause resource leaks (f…
5d66fe8 
…lutter#104527)
yzhtracy pushed a commit to BuildAndRelease/flutter that referenced this pull request Jun 28, 2022
@yeatse @yzhtracy
Fix an issue that clearing the image cache may cause resource leaks (f…
183df46 
…lutter#104527)
camsim99 pushed a commit to camsim99/flutter that referenced this pull request Aug 10, 2022
@yeatse @camsim99
Fix an issue that clearing the image cache may cause resource leaks (f…
c14f119 
…lutter#104527)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2022
@engine-flutter-autoroll
b5adbee Fix an issue that clearing the image cache may cause resource…
85fc992 
… leaks (flutter/flutter#104527)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 30, 2022
@engine-flutter-autoroll
b5adbee Fix an issue that clearing the image cache may cause resource…
869fb90 
… leaks (flutter/flutter#104527)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@goderbauer goderbauer goderbauer approved these changes

+1 more reviewer

@dnfield dnfield dnfield approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

If app is loading images and we put it to background, the memory is never released.

4 participants

@yeatse @dnfield @goderbauer @fluttergithubbot