node-oom-heapdump 2.1.0-progress.1 → 3.0.1-beta

package/lib/index.js

@@ -1,228 +1,187 @@
-let cp = require("child_process");
-let fs = require("fs");
-let path = require("path");
-
-class NodeOomHeapDumpImpl {
-  constructor(options) {
-    this._opts = options;
-    this._files = [];
-    this._busy = false;
-    this._count = 0;
-    this._limitReached = false;
-
-    if (this._opts.heapdumpOnOOM) {
-      if (options.OOMImplementation === "NATIVE_HOOK") {
-        require('bindings')('node_oom_heapdump_native.node').call(this._getHeapSnapshotPath(this._opts.path), this._opts.addTimestamp);
-      } else if (options.OOMImplementation === "GC_MONITORING") {
-        this._monitorHeap();
-      }
-    }
-  }
-
-  _monitorHeap() {
-    // see https://www.npmjs.com/package/gc-stats	
-    let gcStats = new require('gc-stats')();
-    gcStats.on('stats', (stats) => {
-      // gctype 2 is a Full GC (Mark/Sweep/Compact)	
-      if (stats.gctype === 2 && !this._busy) {
-        let memoryUsagePercentage = Math.round((stats.after.usedHeapSize / stats.after.heapSizeLimit) * 100);
-        if (memoryUsagePercentage > this._opts.threshold) {
-          if (this._count < this._opts.limit) {
-            // this is a full GC and the used heap size is using more than x% of the assigned heap space limit	
-            console.warn('OoM is imminent: Full GC (Mark/Sweep/Compact) complete and still more than %s% (%s%) of the heap is used. Creating heapdump now. GC stats: ', this._opts.threshold, Math.round(memoryUsagePercentage), JSON.stringify(stats));
-
-            this.createHeapSnapshot(this._opts.path, "OoM");
-
-            // block execution of other code for a while (5 second) to enable snapshot to be created	
-            const time = Date.now();
-            let diff = 0;
-            do {
-              diff = Date.now() - time;
-            }
-            while (diff < 5000);
-          } else if (!this._limitReached) {
-            this._limitReached = true;
-            console.warn("OoM heapdump limit reached (%s); no more heapdumps will be created.", this._opts.limit);
-            return;
-          }
-        }
-      }
-    });
-  }
-
-
-  /**
-   * Calls the designated worker and returns a promise
-   * @param {String} workerPath - path of the worker
-   * @param {String[]} workerArgs - arguments to worker
-   * @return {Promise} resolve on success, reject on error
-   */
-  _callWorker(workerPath, workerArgs) {
-    if (this._busy) {
-      return new Promise((resolve, reject) => {
-        reject(new Error("A CPU profile or heapdump is already being created, please retry later."));
-      });
-    }
-
-    var args = [path.resolve(__dirname, workerPath)].concat(workerArgs);
-
-    // use 'require-main-filename' module instead of require.main.filename, see https://github.com/blueconic/node-oom-heapdump/issues/3
-    let mainFilename = require('require-main-filename')();
-
-    // start worker
-    let child = cp.spawn('node', args, {
-      cmd: path.dirname(mainFilename),
-      stdio: 'inherit'
-    });
-
-    return new Promise((resolve, reject) => {
-      this._busy = true;
-      var error = null;
-
-      child.on('error', (err) => {
-        error = err;
-        reject(err);
-      });
-      child.on('exit', (code) => {
-        if (!error) {
-          if (code === 0) {
-            resolve();
-          } else {
-            reject(new Error("Worker exited with statusCode: " + code));
-          }
-        }
-        this._busy = false;
-      });
-    });
-  }
-
-  /**
-   * Returns the path to the created heap snapshot in a promise, or rejects on error
-   * @param {String} snapshotPath - path of the snapshot
-   * @param {String} logPrefix - optional log prefix message when heapdump is created
-   * @return {Promise} the heap snapshot path on success or error on rejection
-   */
-  createHeapSnapshot(snapshotPath, logPrefix) {
-    snapshotPath = this._getHeapSnapshotPath(snapshotPath, logPrefix);
-
-    // start OoMworker to create heapdump
-    return this._callWorker('./heapdumpWorker.js', [this._opts.port, snapshotPath, logPrefix || ""]).then(() => {
-      if (logPrefix === "OoM") {
-        this._count++;
-      }
-      if (!this._files.includes(snapshotPath)) {
-        this._files.push(snapshotPath);
-      }
-      return snapshotPath;
-    });
-  }
-
-  /**
-   * Returns the path to the created CPU profile in a promise, or rejects on error
-   * @param {String} cpuProfilePath - path of the CPU profile
-   * @param {number} duration - the duration of the cpu profile (in ms)
-   * @return {Promise} the CPU profile path on success or error on rejection
-   */
-  createCpuProfile(cpuProfilePath, duration) {
-    if (!cpuProfilePath) {
-      cpuProfilePath = path.resolve(__dirname, "../cpuprofile-" + Date.now());
-    }
-    if (!cpuProfilePath.endsWith(".cpuprofile")) {
-      cpuProfilePath += ".cpuprofile";
-    }
-
-    // start OoMworker to create heapdump
-    return this._callWorker('./cpuProfileWorker.js', [this._opts.port, cpuProfilePath, duration]).then(() => {
-      if (!this._files.includes(cpuProfilePath)) {
-        this._files.push(cpuProfilePath);
-      }
-      return cpuProfilePath;
-    });
-  }
-
-  /**
-   * Delete all created heap snapshots
-   */
-  deleteAllHeapSnapshots() {
-    this._files.forEach((snapshotPath) => {
-      if (snapshotPath.endsWith(".heapsnapshot")) {
-        this.deleteHeapSnapshot(snapshotPath);
-      }
-    });
-  }
-
-  /**
-   * Deletes a particular snapshot from disk
-   * @param {String} snapshotPath - path of the heap snapshot to delete
-   * @return {Promise}
-   */
-  deleteHeapSnapshot(snapshotPath) {
-    return this._deleteFile(snapshotPath);
-  }
-
-  /**
-   * Delete all created CPU profiles
-   */
-  deleteAllCpuProfiles() {
-    this._files.forEach((path) => {
-      if (path.endsWith(".cpuprofile")) {
-        this.deleteCpuProfile(path);
-      }
-    });
-  }
-
-  /**
-   * Deletes a particular CPU profile from disk
-   * @param {String} cpuProfilePath - path of the CPU profile to delete
-   * @return {Promise}
-   */
-  deleteCpuProfile(cpuProfilePath) {
-    return this._deleteFile(cpuProfilePath);
-  }
-
-  /**
-   * Deletes a given CPU profile or heapsnapshot  from disk
-   * @param {String} path - path to the file to delete
-   * @return {Promise}
-   */
-  _deleteFile(path) {
-    return new Promise((resolve, reject) => {
-      if (this._files.includes(path)) {
-        fs.unlink(path, (err) => {
-          if (err) {
-            reject(err);
-          } else {
-            resolve(path);
-          }
-        });
-      } else {
-        reject(new Error("File not found:" + path));
-      }
-    });
-  }
-
-  /**
-   * Returns a proper snapshot path, based on the given parameter
-   * @param {String} snapshotPath 
-   * @param {String} logPrefix
-   * @return {String} path
-   */
-  _getHeapSnapshotPath(snapshotPath, logPrefix) {
-    if (!snapshotPath) {
-      snapshotPath = path.resolve(__dirname, "../heapsnapshot-" + Date.now());
-    }
-    if (logPrefix === "OoM" && this._opts.addTimestamp) {
-      if (snapshotPath.endsWith(".heapsnapshot")) {
-        snapshotPath = snapshotPath.replace(".heapsnapshot", "");
-      }
-      // in case of OoM error, add timestamp if needed	
-      snapshotPath += "-" + Date.now();
-    }
-    if (!snapshotPath.endsWith(".heapsnapshot")) {
-      snapshotPath += ".heapsnapshot";
-    }
-    return snapshotPath;
-  }
-}
-
+let cp = require("child_process");
+let fs = require("fs");
+let path = require("path");
+
+class NodeOomHeapDumpImpl {
+  constructor(options) {
+    this._opts = options;
+    this._files = [];
+    this._busy = false;
+  }
+
+
+  /**
+   * Calls the designated worker and returns a promise
+   * @param {String} workerPath - path of the worker
+   * @param {String[]} workerArgs - arguments to worker
+   * @return {Promise} resolve on success, reject on error
+   */
+  _callWorker(workerPath, workerArgs) {
+    if (this._busy) {
+      return new Promise((resolve, reject) => {
+        reject(new Error("A CPU profile or heapdump is already being created, please retry later."));
+      });
+    }
+
+    var args = [path.resolve(__dirname, workerPath)].concat(workerArgs);
+
+    // use 'require-main-filename' module instead of require.main.filename, see https://github.com/blueconic/node-oom-heapdump/issues/3
+    let mainFilename = require('require-main-filename')();
+
+    // start worker
+    let child = cp.spawn('node', args, {
+      cmd: path.dirname(mainFilename),
+      stdio: 'inherit'
+    });
+
+    return new Promise((resolve, reject) => {
+      this._busy = true;
+      var error = null;
+
+      child.on('error', (err) => {
+        error = err;
+        reject(err);
+      });
+      child.on('exit', (code) => {
+        if (!error) {
+          if (code === 0) {
+            resolve();
+          } else {
+            reject(new Error("Worker exited with statusCode: " + code));
+          }
+        }
+        this._busy = false;
+      });
+    });
+  }
+
+  /**
+   * Returns the path to the created heap snapshot in a promise, or rejects on error
+   * @param {String} snapshotPath - path of the snapshot
+   * @param {String} logPrefix - optional log prefix message when heapdump is created
+   * @return {Promise} the heap snapshot path on success or error on rejection
+   */
+  createHeapSnapshot(snapshotPath, logPrefix) {
+    snapshotPath = this._getHeapSnapshotPath(snapshotPath, logPrefix);
+
+    // start OoMworker to create heapdump
+    return this._callWorker('./heapdumpWorker.js', [this._opts.port, snapshotPath, logPrefix || ""]).then(() => {
+      if (logPrefix === "OoM") {
+        this._count++;
+      }
+      if (!this._files.includes(snapshotPath)) {
+        this._files.push(snapshotPath);
+      }
+      return snapshotPath;
+    });
+  }
+
+  /**
+   * Returns the path to the created CPU profile in a promise, or rejects on error
+   * @param {String} cpuProfilePath - path of the CPU profile
+   * @param {number} duration - the duration of the cpu profile (in ms)
+   * @return {Promise} the CPU profile path on success or error on rejection
+   */
+  createCpuProfile(cpuProfilePath, duration) {
+    if (!cpuProfilePath) {
+      cpuProfilePath = path.resolve(__dirname, "../cpuprofile-" + Date.now());
+    }
+    if (!cpuProfilePath.endsWith(".cpuprofile")) {
+      cpuProfilePath += ".cpuprofile";
+    }
+
+    // start OoMworker to create heapdump
+    return this._callWorker('./cpuProfileWorker.js', [this._opts.port, cpuProfilePath, duration]).then(() => {
+      if (!this._files.includes(cpuProfilePath)) {
+        this._files.push(cpuProfilePath);
+      }
+      return cpuProfilePath;
+    });
+  }
+
+  /**
+   * Delete all created heap snapshots
+   */
+  deleteAllHeapSnapshots() {
+    this._files.forEach((snapshotPath) => {
+      if (snapshotPath.endsWith(".heapsnapshot")) {
+        this.deleteHeapSnapshot(snapshotPath);
+      }
+    });
+  }
+
+  /**
+   * Deletes a particular snapshot from disk
+   * @param {String} snapshotPath - path of the heap snapshot to delete
+   * @return {Promise}
+   */
+  deleteHeapSnapshot(snapshotPath) {
+    return this._deleteFile(snapshotPath);
+  }
+
+  /**
+   * Delete all created CPU profiles
+   */
+  deleteAllCpuProfiles() {
+    this._files.forEach((path) => {
+      if (path.endsWith(".cpuprofile")) {
+        this.deleteCpuProfile(path);
+      }
+    });
+  }
+
+  /**
+   * Deletes a particular CPU profile from disk
+   * @param {String} cpuProfilePath - path of the CPU profile to delete
+   * @return {Promise}
+   */
+  deleteCpuProfile(cpuProfilePath) {
+    return this._deleteFile(cpuProfilePath);
+  }
+
+  /**
+   * Deletes a given CPU profile or heapsnapshot  from disk
+   * @param {String} path - path to the file to delete
+   * @return {Promise}
+   */
+  _deleteFile(path) {
+    return new Promise((resolve, reject) => {
+      if (this._files.includes(path)) {
+        fs.unlink(path, (err) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(path);
+          }
+        });
+      } else {
+        reject(new Error("File not found:" + path));
+      }
+    });
+  }
+
+  /**
+   * Returns a proper snapshot path, based on the given parameter
+   * @param {String} snapshotPath 
+   * @param {String} logPrefix
+   * @return {String} path
+   */
+  _getHeapSnapshotPath(snapshotPath, logPrefix) {
+    if (!snapshotPath) {
+      snapshotPath = path.resolve(__dirname, "../heapsnapshot-" + Date.now());
+    }
+    if (logPrefix === "OoM" && this._opts.addTimestamp) {
+      if (snapshotPath.endsWith(".heapsnapshot")) {
+        snapshotPath = snapshotPath.replace(".heapsnapshot", "");
+      }
+      // in case of OoM error, add timestamp if needed	
+      snapshotPath += "-" + Date.now();
+    }
+    if (!snapshotPath.endsWith(".heapsnapshot")) {
+      snapshotPath += ".heapsnapshot";
+    }
+    return snapshotPath;
+  }
+}
+
 module.exports = NodeOomHeapDumpImpl;

package/package.json

@@ -1,51 +1,40 @@
-{
-  "name": "node-oom-heapdump",
-  "version": "2.1.0-progress.1",
-  "description": "Create a V8 heap snapshot when an \"Out of Memory\" error occurs, or create a heap snapshot or CPU profile on request.",
-  "main": "index.js",
-  "scripts": {
-    "rebuild": "node-pre-gyp install --build-from-source",
-    "install": "node-pre-gyp install --fallback-to-build",
-    "test": "node --max_old_space_size=80 --inspect ./tests/oom_app.js",
-    "dummy": "node -e \"process.exit(0)\""
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/blueconic/node-oom-heapdump.git"
-  },
-  "binary": {
-    "module_name": "node_oom_heapdump_native",
-    "module_path": "./build/Release",
-    "host": "https://github.com/blueconic/node-oom-heapdump/releases/download/{version}"
-  },
-  "engines": {
-    "node": ">=7.0.0"
-  },
-  "keywords": [
-    "nodejs",
-    "memory-leak",
-    "out-of-memory",
-    "heapdump",
-    "memory",
-    "OnFatalError",
-    "OnOOMError"
-  ],
-  "author": "Paul Rütter",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/blueconic/node-oom-heapdump/issues"
-  },
-  "homepage": "https://github.com/blueconic/node-oom-heapdump#readme",
-  "devDependencies": {
-    "eslint-config-google": "^0.13.0"
-  },
-  "dependencies": {
-    "bindings": "^1.5.0",
-    "chrome-remote-interface": "^0.28.0",
-    "gc-stats": "^1.4.0",
-    "nan": "^2.14.0",
-    "node-pre-gyp": "^0.15.0",
-    "require-main-filename": "^2.0.0",
-    "ws": "^7.1.2"
-  }
-}
+{
+  "name": "node-oom-heapdump",
+  "version": "3.0.1-beta",
+  "description": "Create a heap snapshot or CPU profile on request, off-process through the DevTools protocol",
+  "main": "index.js",
+  "scripts": {
+    "dummy": "node -e \"process.exit(0)\"",
+    "api-publish-beta": "npm publish --tag beta"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blueconic/node-oom-heapdump.git"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "keywords": [
+    "nodejs",
+    "memory-leak",
+    "out-of-memory",
+    "heapdump",
+    "memory",
+    "OnFatalError",
+    "OnOOMError"
+  ],
+  "author": "Paul Rütter",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/blueconic/node-oom-heapdump/issues"
+  },
+  "homepage": "https://github.com/blueconic/node-oom-heapdump#readme",
+  "devDependencies": {
+    "eslint-config-google": "^0.14.0"
+  },
+  "dependencies": {
+    "chrome-remote-interface": "^0.31.2",
+    "require-main-filename": "^2.0.0",
+    "ws": "^8.5.0"
+  }
+}

package/.github/workflows/publish-native-assets-to-github-releases.yml

@@ -1,37 +0,0 @@
-# This workflow will prebuild native binaries for supported NodeJS versions, and add them to the Github release that triggered the workflow
-
-name: Add native binaries to release
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  augment-release:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        node-version: [7.x, 8.x, 9.x, 10.x, 11.x, 12.x]
-        os: [ubuntu-latest, macos-latest, windows-latest]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: patch node gyp on windows to support Visual Studio 2019
-        if: matrix.os == 'windows-latest'
-        shell: powershell
-        run: |
-          npm install --global node-gyp@5.1.1
-          npm prefix -g | % {npm config set node_gyp "$_\node_modules\node-gyp\bin\node-gyp.js"}
-      - name: build using node-pre-gyp
-        run: |
-          npm install --build-from-source
-          ./node_modules/.bin/node-pre-gyp package
-      - name: Upload native binaries for Node ${{ matrix.node-version }} for ${{ matrix.os }}
-        uses: csexton/release-asset-action@v2
-        with:
-          pattern: "build/stage/*.tar.gz"
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          release-url: ${{ github.event.release.upload_url }}

package/binding.gyp

@@ -1,10 +0,0 @@
-{
-	"targets" : [{
-		"target_name" : "node_oom_heapdump_native",
-		"sources" : [ "lib/node_oom_heapdump_native.cc" ],
-		"include_dirs": [
-			'<!(node -e "require(\'nan\')")'
-		],
-		"win_delay_load_hook" : "false"
-	}]
-}