nleak

An automatical memory detection and diagnosis tool for NodeJS.

Background

• core folder contains all src code for nleak-core
  • NodeJS driver
  • Heap analysis
  • Leak detection & debugging algorithms
  • Reporter
  • ...
• guest folder contains all src code for running guest app in child NodeJS process
  • Code rewriting logic
  • Instrumental agent
  • Testing guest app
  • ...

System Overview

Local Development

• npm i
• npm 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 Related Build & CI

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

NLeak result preview