Warning NLeak is currently under development and is not ready for production use.
NLeak is an automatical memory detection and diagnosis tool for NodeJS. It is built on top of BLeak [1], a memory leak detection tool for JavaScript applications. NLeak is designed to be a lightweight and extensible tool that can be easily integrated into existing CI/CD pipelines. NLeak is currently under development and is not ready for production use.
Memory leaks are a common cause of system memory exhaustion, which can result in slow performance or system crashes. Identifying and fixing memory leaks in JavaScript can be particularly challenging, as the language is dynamically typed and leaks may differ from those in other languages such as C, C++, and Java. There are currently no automated tools that can effectively detect memory leaks in JavaScript applications executed in the NodeJS runtime environment. The team is working on extending BLeak to NodeJS in order to create a memory detection tool that can automate the process of locating, diagnosing, and ranking JavaScript memory leaks in Node.js applications.
You can simply install NLeak globally and run it on your NodeJS application.
npm install -g nleak
Then, you will need the config file to tell NLeak how to run your application. The config file should be named config.js and should be in the root directory of your application. Please refer to the example folder for an example config file and guest NodeJS application with memory leak.
Once you have the files prepared, you can run NLeak on your application by simply running the following command:
// go to ./example folder
nleak run --config ./config.js --guest-app-entry ./app.js --out ./
As a result, you will get a nleak_result.json file in the current directory. This file contains the memory leak detection result. You can also use the NLeak viewer to visualize the result.
The above figure demonstrates the execution process of NLeak. The guest application is executed as a child process in inspection mode, and heap snapshots are captured using the Chrome debugger protocol. In the leak diagnosis phase, guest application rewrites are applied to obtain the reference stack trace for potential memory leak objects. This rewrite enables traceability of object references in the guest application's execution and is seamlessly integrated into the system through a customized module import and compile scheme.
From the client's perspective, they only need to provide a configuration file and their guest application to execute NLeak. The memory leak detection results will be stored in a result file. NLeak also includes a viewer for better interpretation of the results on a web frontend.
NLeak utilizes the core algorithm from BLeak [1] to identify memory leaks. This algorithm takes a series of JavaScript runtime heap snapshots during idempotent operations in the guest application. Memory leaks are identified as heap objects that gain more outgoing references across the heap snapshots. Once leak-related objects are gathered, NLeak re-executes the guest application to collect the related JavaScript stack trace. A visual representation of this process can be seen in following sequence diagram.
sequenceDiagram
autonumber
actor User
participant NLeak Core
participant NLeak Guest
User->>NLeak Core: Provides config.js and guest application
Note over NLeak Core, NLeak Guest: Detection Phase
NLeak Core->>NLeak Guest: Spawn child NodeJS process and run guest app
loop For each iteration
NLeak Core->>NLeak Guest: Trigger run actions defined in config
NLeak Guest-->NLeak Guest: Run action and wait for completion
NLeak Guest->>NLeak Core: Take heap snapshot and send back
end
NLeak Core-->NLeak Core: Comparing mutliple heap snapshots and run detection algorithms
Note over User: Leak detection intermediate result
NLeak Core->>User: nleak_result that contains potential leaks with score ranking
Note over NLeak Core, NLeak Guest: Diagnosis Phase
NLeak Core-->NLeak Core: Rewrite guest JS source, code instrumentation for LeakPath objects
NLeak Core->>NLeak Guest: Restart child process to prevent caching
loop For extra 2 iterations
NLeak Core->>NLeak Guest: Trigger run actions defined in config
NLeak Guest->>NLeak Core: Collect stack traces on LeakPath
end
NLeak Core-->NLeak Core: Mapping stack trace to original code with source map
Note over User: Full leak detection and diagnosis result
NLeak Core->>User: Stack traces and leak location highlighted with source map
NLeak viewer is a tool built in reactjs that allows you to visualize the heap snapshot growth of your application. To use it, simply go to https://nleak-viewer.vercel.app/ and upload your nleak_result.json file.
Once you've uploaded the file, NLeak viewer will generate a chart showing the growth of your heap snapshots over time. You'll also see a summary of the last heap snapshot's size, as well as the leak location with source map.
By using NLeak with the viewer, you can easily identify potential memory leaks in your application and take steps to fix them.
npm inpm run dev
The dev script will start nodemon to monitor all TypeScript changes and compile
them into JavaScript and put to build folder.
For local testing, currently we support driver tests. Simply run npm run test:driver.
Docker is used as CI building environment and testing.
$ docker build . -t nleak_build --platform=linux/amd64
$ docker run -v <path on host>:/home/NLeak --platform=linux/amd64 -it nleak_build:latest[1] J. Vilk and E. D. Berger, “BLeak: automatically debugging memory leaks in web applications,” in Proceedings of the 39th ACM SIGPLAN Conference on Programming Language Design and Implementation, 2018.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent