feat: can be used in worker threads (#39)

.clang-format

@@ -0,0 +1,4 @@
+# http://clang.llvm.org/docs/ClangFormatStyleOptions.html
+BasedOnStyle: Google
+DerivePointerAlignment: false
+MaxEmptyLinesToKeep: 1

.github/workflows/nodejs.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [ 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ]
+        node-version: [ 4, 6, 8, 10, 12, 14, 16, 18 ]
     steps:
     - name: Checkout Git Source
       uses: actions/checkout@master
@@ -32,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [ 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ]
+        node-version: [ 8, 10, 12, 14, 16, 18 ]
     steps:
     - name: Checkout Git Source
       uses: actions/checkout@master

README.md

@@ -14,9 +14,11 @@ v8-profiler-next provides [node](https://github.com/nodejs/node) bindings for the
 ## I. Quick Start
 
 * **Compatibility**
-  * **node version:** v4.x ~ v17.x
+  * **node version:** v4.x ~ v18.x
   * **platform:** mac, linux, windows
 
+This module can also be used in `worker_threads`.
+
 ### take cpu profile
 
 ```js
@@ -47,6 +49,42 @@ setTimeout(() => {
 }, 5 * 60 * 1000);
 ```
 
+Get `.cpuprofile` in `worker_threads`:
+
+```js
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const v8Profiler = require('./');
+const workerThreads = require('worker_threads');
+
+v8Profiler.setGenerateType(1);
+
+if (workerThreads.isMainThread) {
+  const w = new workerThreads.Worker(__filename, {
+    env: process.env,
+  });
+  v8Profiler.startProfiling('main', true);
+  w.once('exit', code => {
+    // create cpu profile in main thread
+    const profile = v8Profiler.stopProfiling('main');
+    const mainProfile = path.join(__dirname, 'main.cpuprofile');
+    fs.existsSync(mainProfile) && fs.unlinkSync(mainProfile);
+    fs.writeFileSync(mainProfile, JSON.stringify(profile));
+  });
+} else {
+  v8Profiler.startProfiling('worker_threads', true);
+  // create cpu profile in worker_threads
+  const start = Date.now();
+  while (Date.now() - start < 2000) { }
+  const profile = v8Profiler.stopProfiling('worker_threads');
+  const workerProfile = path.join(__dirname, 'worker_threads.cpuprofile');
+  fs.existsSync(workerProfile) && fs.unlinkSync(workerProfile);
+  fs.writeFileSync(workerProfile, JSON.stringify(profile));
+}
+```
+
 ### take heapsnapshot
 
 ```js
@@ -68,6 +106,42 @@ transform.pipe(process.stdout);
 transform.on('finish', snapshot.delete.bind(snapshot));
 ```
 
+Get `.heapsnapshot` in `worker_threads`:
+
+```js
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const v8Profiler = require('./');
+const workerThreads = require('worker_threads');
+
+function createSnapshot(filename) {
+  const snapshot = v8Profiler.takeSnapshot();
+  const file = path.join(__dirname, filename);
+  const transform = snapshot.export();
+  transform.pipe(fs.createWriteStream(file));
+  transform.on('finish', snapshot.delete.bind(snapshot));
+}
+
+if (workerThreads.isMainThread) {
+  const w = new workerThreads.Worker(__filename, {
+    env: process.env,
+  });
+
+  // create heapsnapshot in main thread
+  createSnapshot('main.heapsnapshot');
+
+} else {
+  const start = Date.now();
+  const array = [];
+  while (Date.now() - start < 2000) { array.push(new Array(1e3).fill('*')); }
+
+  // create heapsnapshot in worker_threads
+  createSnapshot('worker_threads.heapsnapshot');
+}
+```
+
 ### take allocation profile
 
 **Attention:** If node version < v12.x, please use sampling heap profiling alone without cpu profiling or taking snapshot.
@@ -91,6 +165,41 @@ setTimeout(() => {
 }, 60 * 1000);
 ```
 
+Get `.heapprofile` in `worker_threads`:
+
+```js
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const v8Profiler = require('./');
+const workerThreads = require('worker_threads');
+
+if (workerThreads.isMainThread) {
+  const w = new workerThreads.Worker(__filename, {
+    env: process.env,
+  });
+  v8Profiler.startSamplingHeapProfiling();
+  w.once('exit', code => {
+    // create heap profile in main thread
+    const profile = v8Profiler.stopSamplingHeapProfiling();
+    const mainProfile = path.join(__dirname, 'main.heapprofile');
+    fs.existsSync(mainProfile) && fs.unlinkSync(mainProfile);
+    fs.writeFileSync(mainProfile, JSON.stringify(profile));
+  });
+} else {
+  v8Profiler.startSamplingHeapProfiling();
+  // create heap profile in worker_threads
+  const start = Date.now();
+  const array = [];
+  while (Date.now() - start < 2000) { array.push(new Array(1e3).fill('*')); }
+  const profile = v8Profiler.stopSamplingHeapProfiling();
+  const workerProfile = path.join(__dirname, 'worker_threads.heapprofile');
+  fs.existsSync(workerProfile) && fs.unlinkSync(workerProfile);
+  fs.writeFileSync(workerProfile, JSON.stringify(profile));
+}
+```
+
 ## II. License
 
 [MIT License](LICENSE)

appveyor.yml

@@ -7,19 +7,13 @@ environment:
   matrix:
     # node.js
     - nodejs_version: "4"
-    - nodejs_version: "5"
     - nodejs_version: "6"
-    - nodejs_version: "7"
     - nodejs_version: "8"
-    - nodejs_version: "9"
     - nodejs_version: "10"
-    - nodejs_version: "11"
     - nodejs_version: "12"
-    - nodejs_version: "13"
     - nodejs_version: "14"
-    - nodejs_version: "15"
     - nodejs_version: "16"
-    - nodejs_version: "17"
+    - nodejs_version: "18"
 
 # Install scripts. (runs after repo cloning)
 install:

binding.gyp

@@ -4,18 +4,20 @@
       'target_name': 'profiler',
       'win_delay_load_hook': 'false',
       'sources': [
+        'src/cpu_profiler/cpu_profiler.cc',
+        'src/cpu_profiler/cpu_profile.cc',
+        'src/cpu_profiler/cpu_profile_node.cc',
+        'src/heap_profiler/sampling_heap_profiler.cc',
+        'src/heapsnapshot/heap_profiler.cc',
+        'src/heapsnapshot/heap_snapshot.cc',
+        'src/heapsnapshot/heap_output_stream.cc',
+        'src/heapsnapshot/heap_graph_node.cc',
+        'src/heapsnapshot/heap_graph_edge.cc',
         'src/profiler.cc',
-        'src/cpu_profiler.cc',
-        'src/cpu_profile.cc',
-        'src/cpu_profile_node.cc',
-        'src/heap_profiler.cc',
-        'src/heap_snapshot.cc',
-        'src/heap_output_stream.cc',
-        'src/heap_graph_node.cc',
-        'src/heap_graph_edge.cc',
-        'src/sampling_heap_profile.cc'
+        'src/environment_data.cc'
       ],
       'include_dirs' : [
+        "src",
         "<!(node -e \"require('nan')\")"
       ],
       'conditions':[

lib/worker_threads.js

@@ -0,0 +1,20 @@
+'use strict';
+
+let canIUseWorkerThreads = false;
+let isMainThread = true;
+let threadId = 0;
+
+try {
+  const workerThreads = require('worker_threads');
+  isMainThread = workerThreads.isMainThread;
+  threadId = workerThreads.threadId;
+  canIUseWorkerThreads = true;
+} catch (err) {
+  err;
+}
+
+module.exports = {
+  isMainThread,
+  threadId,
+  canIUseWorkerThreads,
+};

package.json

@@ -4,8 +4,12 @@
   "description": "node bindings for the v8 profiler",
   "main": "dispatch.js",
   "scripts": {
-    "test": "mocha test/*.test.js --timeout 10000",
-    "build": "node-gyp rebuild"
+    "test-old": "mocha test/*.test.js --exclude test/worker.test.js --timeout 10000",
+    "test-new": "mocha test/*.test.js --timeout 10000",
+    "test": "node scripts/test.js",
+    "test-single": "mocha --timeout 10000",
+    "build": "node-gyp rebuild",
+    "format": "clang-format -i --glob=\"src/**/*[.h|.cc]\""
   },
   "repository": {
     "type": "git",
@@ -23,6 +27,7 @@
   "homepage": "https://github.com/hyj1991/v8-profiler-next#readme",
   "files": [
     "src",
+    "lib",
     "binding.gyp",
     "dispatch.js",
     "index.d.ts",
@@ -34,6 +39,7 @@
   },
   "devDependencies": {
     "chai": "^4.2.0",
+    "clang-format": "^1.8.0",
     "mocha": "^5.2.0"
   }
 }

scripts/test.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const cp = require('child_process');
+const path = require('path');
+const nodeVersion = process.versions.node;
+
+function exec(cmd) {
+  cp.execSync(cmd, {
+    cwd: path.join(__dirname, '../'),
+    stdio: 'inherit', env: process.env
+  });
+}
+
+const tags = nodeVersion.split('.');
+if (tags[0] < 8) {
+  exec('npm run test-old');
+} else {
+  exec('npm run test-new');
+}