leak-tracker: Detect memory leaks by identifying not disposed or not GCed objects. #3951

polina-c · 2022-04-01T22:53:46Z

Motivation: go/flutter-devtools-survey-2022

polina-c · 2022-04-01T23:07:27Z

Investigate
- understand WeakMap
- understand Finalizer API (Daco Harkes)
- understand app to DevTools connection
- how to connect DevTools to a test (no way)
- create design (public, private)
- review design
- present to the team - go/memory-leak-detector-high-level-design
Prototype
- prototype the detector
- pilot detector with Gallery
- rump up with Flutter@Google3
- ramp up on memory app
- pilot detector with memory app
- learn to pass GC events to the app
- learn to find retention path
- switch to GC event based approach
- switch to combination of GC event and time based approach
- figure out what to do with WeakReference in the path
- show only root objects
- request GC API changes
Make available for early adopters
- prepare patch for Flutter/Dart (layer.dart, framework.dart - state, element)
  - branch in GitHub for Flutter
  - CL in Google3
- tab 'Leaks' in DevTools
  - shared library
  - summary in console
  - analyze and save
- guidance
- add link to documentation
- review UX with UX specialists: go/notes-ux-review-for-memory-leaks-pane
Pilot with early adopters
- Gallery
- work out leaks in debug mode
- pilot and benchmark money app - go/leaktracker-for-money-app
- DevTools
Critical Improvements/Researches:
- Make the GC signal reliable by adopting gcType: Add information about type of GC to the GC event details. dart-lang/sdk#49319
- add section about performance impact to documentation
Release leak tracker
- Design doc
- MVP
  - Instrument Image and Picture in dart.ui - Instrument Image and Picture for leak tracking. engine#35274
    - Work around Picture.toImage fails for --web-renderer html flutter#110599
    - Pre-work: Test cover 'toImage'. engine#35791
  - Create MemoryAllocations - Create class MemoryAllocations. flutter#110230
  - Instrument flutter classes: Instrument State, Layer, RenderObject and Element. flutter#111328
  - Figure out regression
  - Create package:leak_tracker (in https://github.com/orgs/dart-lang/repositories, with go/dart-lang-repo-creation-process)
    - create launch: https://github.com/dart-lang/leak_tracker
    - create code
      - leak tracking logic
      - integration tests
  - request gcCount: Implement reachability barrier dart-lang/sdk#50080
  - integrated with DevTools
  - port to Google3 - Port leak_tracker to Google3. #4894
  - Update documentation and link from documentation site
Flutter regression - Add test coverage for non-disposed and non-GCed memory leaks. flutter#108322
- Detect and fix some leaks: ValueNotifier is not disposed by tooltip. flutter#117063
- discuss with flutter engineers: go/notes-leak-regression-for-flutter
- discuss regression: go/notes-michael-polina-making-leak-tracker-dev-dependency
- Discuss coverage - go/flutter-leak-tracking-test-coverage
- Regression for animation, foundation and gestures, with not-GCed off: Define testWidgetsWithLeakTracking. flutter#125063
- Create and link guidance to troubleshoot non-disposed memory leaks in the test failure
- Create bugs for 13 non-disposed cases (hoping, that flutter people will find capacity for them)
- address feedback: Improve leak debugging UX. dart-lang/leak_tracker#59
- fix flakiness: Leak Tracking is flaky flutter#126259
- see retaining paths for non-gced objects in tests
  - figure out Result of getRetainingPath should not include WeakReference dart-lang/sdk#49155
  - figure out Service.getInfo() does not work for test environment. dart-lang/sdk#52354
  - figure out flutter test should support flag '--debug' flutter#127331
  - collect retaining path: Collect retaining path. dart-lang/leak_tracker#63
  - figure out Result of getRetainingPath should not be about the getRetainingPath invocation. dart-lang/sdk#52517
  - figure out Watcher fails with class 'FileSystemEvent' can't be extended, for dart, not for flutter. dart-lang/sdk#52570
  - nicely format retaining path: Nicely format retaining path. dart-lang/leak_tracker#68
  - improve formatting: Improve getting retaining path. dart-lang/leak_tracker#69
  - add constructor: Add constructor for retaining path. dart-lang/leak_tracker#72
  - fix inspector:
    - first attempt: Make inspector weakly referencing the inspected objects. flutter#128095
    - second attempt: Redo make inspector weakly referencing the inspected objects. flutter#128471
    - third attempt: Next attempt to make inspector weakly referencing the inspected objects. flutter#128551
    - devtools: Prepare for weak references in inspector. #5880
    - add test that inspector does not hold objects
- investigate Next Gen UI demo crashes mobile browsers flutter#127418 (comment)
- Investigate nonGCed cases for src/material
- Update the guidance on how to debug non-gced
- Turn on tracking for non-GCed (draft)
- Coverage for remaining folders in flutter
  - cupertino
  - material (~ 4000 tests - failures)
  - painting
  - physics
  - rendering
  - scheduler
  - semantics
  - services
  - widgets
- Add leak tracking to testWidgets, disabled by default: Enable testWidgets to track leaks. flutter#124435
- Enable by default leak tracking for testWidgets for Flutter
- Fix failing tests
- Document unit testing with leak tracking
Publish leak tracking for tests
- Update leak_tracker documentation with examples
- Work with pub.get to give points for using leak_tracker
- Create video that describes how to track leaks
Enable by default in debug/profile
- Documentation
  - Explain how to get retaining path
  - Explain how to troubleshoot failing tests
- add DevTools link
- Reference constants that are defined both in DevTools and Flutter (see TODOs for this issue in DevTools)
- Configure telemetry in DevTools
- Set limit for tracked objects
- Create UI in DevTools
- Publish flutter_leak_tracker?
- Ignore inspector, when DevTools is connected
Adopt for:
- Gallery
- money app - go/leaktracker-for-money-app
- Analyzer - go/dart-leak-tracking-for-analyzer
- DevTools
- touch app - go/dart-leak-tracking-for-touch-app
- mulligan (CM)
- profiler
after MVP
- Release mode: Enable leak tracking for release mode. dart-lang/leak_tracker#25

polina-c · 2022-05-14T16:32:46Z

Draft to be submitted to flutter SDK:
flutter: flutter/flutter@master...polina-c:flutter:leak-tracking2

polina-c · 2022-07-07T16:31:51Z

not-GCed leaks:

EditableTextState for Gallery: Flutter framework is leaking in debug mode for gallery app. flutter#107338
Navigation for DevTools: Logging screen is leaking with not-GCed _LoggingScreenState, in profile mode. #4416
Example of detection of passed context to closure: https://github.com/polina-c/spikes/tree/master/not_gced_leak

not-disposed leaks:

polina-c added the memory page label Apr 1, 2022

polina-c added this to the M39 milestone Apr 1, 2022

polina-c self-assigned this Apr 1, 2022

polina-c assigned terrylucas and unassigned terrylucas Apr 6, 2022

flutter deleted a comment from terrylucas Apr 6, 2022

polina-c changed the title ~~Memory leaks: detect disposed, not GC-ed links~~ Detect memory leaks by identifying not disposed or not GCed objects. Apr 7, 2022

kenzieschmoll modified the milestones: M39, M41 May 5, 2022

polina-c mentioned this issue May 13, 2022

Leak tracking (outdated) flutter/flutter#103765

Closed

polina-c mentioned this issue May 15, 2022

Leak tracking flutter/flutter#103834

Closed

polina-c added the P3 highest priority for bugs that don't effect top customers. label May 20, 2022

This was referenced May 20, 2022

No way to see what references leaked instance #3424

Closed

Need a tool to detect memory leaks in a flutter app #1437

Closed

polina-c mentioned this issue Jun 1, 2022

Result of getRetainingPath should not include WeakReference dart-lang/sdk#49155

Closed

kostaleonard mentioned this issue Jun 11, 2022

Add resource leak detection in test suite kostaleonard/populare#7

Open

polina-c mentioned this issue Jun 23, 2022

Create tab 'Leaks' #4211

Merged

polina-c mentioned this issue Jul 13, 2022

proposal: always_dispose_change_notifier dart-lang/linter#3520

Open

5 tasks

darshankawar mentioned this issue Aug 26, 2022

How to detect memory leaks? flutter/flutter#110322

Closed

polina-c mentioned this issue Aug 30, 2022

Report when an object that has a ::dispose method is destructed without dispose being called. flutter/flutter#83274

Open

This was referenced Sep 16, 2022

Instrument State, Layer, RenderObject and Element. flutter/flutter#111328

Merged

Add YourKit like merged paths to the memory page #4492

Open

polina-c mentioned this issue Dec 5, 2022

Port leak_tracker to Google3. #4894

Closed

polina-c mentioned this issue Dec 19, 2022

Dispose OverlayEntry in TooltipState. flutter/flutter#117291

Merged

polina-c changed the title ~~Detect memory leaks by identifying not disposed or not GCed objects.~~ leak-tracker: Detect memory leaks by identifying not disposed or not GCed objects. Apr 3, 2023

polina-c mentioned this issue Apr 8, 2023

Enable testWidgets to track leaks. flutter/flutter#124435

Closed

polina-c mentioned this issue Apr 18, 2023

Define testWidgetsWithLeakTracking. flutter/flutter#125063

Merged

polina-c mentioned this issue May 15, 2023

Memory leak with Stateless Widget flutter/flutter#79605

Open

This was referenced Jun 6, 2023

update readme with more information dart-lang/leak_tracker#78

Closed

Next attempt to make inspector weakly referencing the inspected objects. flutter/flutter#128551

Open

leak-tracker: Detect memory leaks by identifying not disposed or not GCed objects. #3951

leak-tracker: Detect memory leaks by identifying not disposed or not GCed objects. #3951

polina-c commented Apr 1, 2022 •

edited

polina-c commented Apr 1, 2022 •

edited

polina-c commented May 14, 2022 •

edited

polina-c commented Jul 7, 2022 •

edited

leak-tracker: Detect memory leaks by identifying not disposed or not GCed objects. #3951

leak-tracker: Detect memory leaks by identifying not disposed or not GCed objects. #3951

Comments

polina-c commented Apr 1, 2022 • edited

polina-c commented Apr 1, 2022 • edited

polina-c commented May 14, 2022 • edited

polina-c commented Jul 7, 2022 • edited

not-GCed leaks:

not-disposed leaks:

polina-c commented Apr 1, 2022 •

edited

polina-c commented Apr 1, 2022 •

edited

polina-c commented May 14, 2022 •

edited

polina-c commented Jul 7, 2022 •

edited