leak_detector - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #llm #go #linux #docker #macos #awesome #kubernetes #ios #openai #open-source

leak_detector

(★ 141)

flutter memory leak detector.

File Explorer

Download Latest Version (.zip)

- .gitignore
- build.gradle
- gradle.properties
- gradlew
- gradlew.bat
- settings.gradle
- - .gitignore
  - build.gradle
  - gradle.properties
  - settings.gradle
  - settings_aar.gradle
- - .gitignore
  - Podfile
  - Podfile.lock
- - main.dart
- - .gitignore
  - Podfile
  - Podfile.lock
- - widget_test.dart
- .gitignore
- .metadata
- pubspec.lock
- pubspec.yaml
- README.md
- - .gitkeep
- - LeakDetectorPlugin.h
  - LeakDetectorPlugin.m
  - SwiftLeakDetectorPlugin.swift
- .gitignore
- leak_detector.podspec
- - leak_analyzer.dart
  - leak_data.dart
  - leak_data_store.dart
  - leak_detector.dart
  - leak_detector_task.dart
  - leak_navigator_observer.dart
  - leak_record_handler.dart
  - leak_sqlite_store.dart
  - leak_state_mixin.dart
  - vm_service_utils.dart
- leak_detector.dart
- - LeakDetectorPlugin.swift
- leak_detector.podspec
- leak_detector_test.dart
.gitignore
.metadata
CHANGELOG.md
leak_detector.iml
LICENSE
pubspec.lock
pubspec.yaml
README.md
README_zh-CN.md

# Installation Guide

1. Get the code

git clone https://github.com/liujiakuoyx/leak_detector

Downloads the entire project code from GitHub to your computer.

cd leak_detector

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[中文文档](README_zh-CN.md)

# leak_detector

flutter Memory leak detection tool

## Usage

#### initialize

In order to prevent the underlying library `vm service` from crashing, please call before adding the memory leak detection object:
```dart
LeakDetector().init(maxRetainingPath: 300); //maxRetainingPath default is 300
```
Enabling leak detection will reduce performance, and Full GC may drop frames on the page. 
Initialized by `assert` in the plugin, so you don't need to turn it off when build on `release` mode.

#### Detect

Add `LeakNavigatorObserver` to `navigatorObservers` in `MaterialApp`, it will automatically detect whether there is a memory leak in the page's `Widget` and its corresponding `Element` object. If page's Widget is a `StatefulWidget`, it will also be automatically checked Its corresponding `State`.

```dart
import 'package:leak_detector/leak_detector.dart';

@override
Widget build(BuildContext context) {
  return MaterialApp(
    navigatorObservers: [
      //used the LeakNavigatorObserver
      LeakNavigatorObserver(
        shouldCheck: (route) {
          return route.settings.name != null && route.settings.name != '/';
        },
      ),
    ],
  );
}
```

#### Get leaked information

`LeakDetector().onLeakedStream` can register your listener, and notify the object's reference chain after detecting a memory leak.
`LeakDetector().onEventStream` can monitor internal time notifications, such as `start Gc`, `end Gc`, etc.

A preview page of the reference chain is provided. You only need to add the following code. Note that the `Bulid Context` must be able to obtain the`NavigatorState`:

```dart
import 'package:leak_detector/leak_detector.dart';

//show preview page
LeakDetector().onLeakedStream.listen((LeakedInfo info) {
  //print to console
  info.retainingPath.forEach((node) => print(node));
  //show preview page
  showLeakedInfoPage(navigatorKey.currentContext, info);
});
```

Preview page display:

<img src="https://liujiakuoyx.github.io/images/leak_detector/image2-1.png" width = "280" align=center />

<img src="https://liujiakuoyx.github.io/images/leak_detector/image4.png" width = "280" align=center />

<img src="https://liujiakuoyx.github.io/images/leak_detector/image2-2.png" width = "280" align=center />

It contains the class information of the reference chain node, the referenced attribute information, the source code of the attribute declaration, and the location of the source code (line number: column number).

#### Get memory leak recording

```dart
import 'package:leak_detector/leak_detector.dart';

getLeakedRecording().then((List<LeakedInfo> infoList) {
  showLeakedInfoListPage(navigatorKey.currentContext, infoList);
});
```

<img src="https://liujiakuoyx.github.io/images/leak_detector/image2-3.png" width = "280" align=center />

#### *Cannot connect to `vm_service` on real mobile devices

The VM service allows for an extended feature set via the Dart Development Service (DDS) that forward all core VM service RPCs described in this document to the true VM service.

So when we connect to the computer to run, the `DDS` on the computer will first connect to the `vm_service` on our mobile end, causing our `leak_detector` plugin to fail to connect to the `vm_service` again.

There are two solutions:

- After the `run` is complete, disconnect from the computer, and then it is best to restart the app.

If the completed test package is installed on the mobile phone, the above problem does not exist, so this method is suitable for use by testers.

- Add the `--disable-dds` parameter after `flutter run` to turn off the `DDS`. After testing, this will not cause any impact on debugging

It can be configured as follows in `Android Studio`.
  
After [Pull Request #80900](https://github.com/flutter/flutter/pull/80900) is merged, `--disable-dds` was renamed to `--no-dds`

![image](https://liujiakuoyx.github.io/images/leak_detector/peizhi1.png)

![image](https://liujiakuoyx.github.io/images/leak_detector/peizhi2.png)