Add AsyncLocalStorage test

Author: timfish

package.json

@@ -23,15 +23,15 @@
     "fix": "yarn fix:eslint && yarn fix:clang",
     "fix:eslint": "eslint . --format stylish --fix",
     "fix:clang": "node scripts/clang-format.mjs --fix",
-    "build": "yarn build:lib && yarn build:bindings:configure && yarn build:bindings",
+    "build": "yarn clean && yarn build:lib && yarn build:bindings:configure && yarn build:bindings",
     "build:lib": "tsc",
     "build:bindings:configure": "node-gyp configure",
     "build:bindings:configure:arm64": "node-gyp configure --arch=arm64 --target_arch=arm64",
     "build:bindings": "node-gyp build && node scripts/copy-target.mjs",
     "build:bindings:arm64": "node-gyp build --arch=arm64 && node scripts/copy-target.mjs",
     "build:dev": "yarn clean && yarn build:bindings:configure && yarn build",
     "build:tarball": "npm pack",
-    "clean": "node-gyp clean && rm -rf lib && rm -rf build",
+    "clean": "node-gyp clean && rm -rf lib && rm -rf build && rm -f *.tgz",
     "test": "yarn test:install && node ./test/prepare.mjs && vitest run --silent=false --disable-console-intercept",
     "test:install": "cross-env ALWAYS_THROW=true yarn install"
   },

src/index.ts

@@ -189,11 +189,7 @@ export function registerThread(threadName: string = String(threadId)): void {
  * @param disableLastSeen If true, disables the last seen tracking for this thread.
  */
 export function threadPoll(disableLastSeen?: boolean): void {
-  if (disableLastSeen) {
-    native.threadPoll(disableLastSeen);
-  } else {
-    native.threadPoll();
-  }
+  native.threadPoll(!!disableLastSeen);
 }
 
 /**

test/async-storage.mjs

@@ -0,0 +1,27 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { Worker } from 'node:worker_threads';
+import { registerThread, registerThreadStateCallback } from '@sentry-internal/node-native-stacktrace';
+import { longWork } from './long-work.js';
+
+registerThread();
+
+const asyncLocalStorage = new AsyncLocalStorage();
+
+function withTraceId(traceId, fn) {
+  return asyncLocalStorage.run(traceId, fn);
+}
+
+registerThreadStateCallback(() => {
+  const traceId = asyncLocalStorage.getStore();
+  return { traceId };
+});
+
+const watchdog = new Worker('./test/watchdog.js');
+
+for (let i = 0; i < 10; i++) {
+  withTraceId(`trace-${i}`, () => {
+    if(i === 5) {
+      longWork();
+    }
+  });
+}

test/e2e.test.mjs

@@ -90,6 +90,38 @@ describe('e2e Tests', { timeout: 20000 }, () => {
     expect(stacks['2'].frames.length).toEqual(1);
   });
 
+  test('async storage state', { timeout: 20000 }, () => {
+    const testFile = join(__dirname, 'async-storage.mjs');
+    const result = spawnSync('node', [testFile]);
+
+    expect(result.status).toEqual(0);
+
+    const stacks = JSON.parse(result.stdout.toString());
+
+    expect(stacks['0'].frames).toEqual(expect.arrayContaining([
+      {
+        function: 'pbkdf2Sync',
+        filename: expect.any(String),
+        lineno: expect.any(Number),
+        colno: expect.any(Number),
+      },
+      {
+        function: 'longWork',
+        filename: expect.stringMatching(/long-work.js$/),
+        lineno: expect.any(Number),
+        colno: expect.any(Number),
+      },
+      {
+        function: '?',
+        filename: expect.stringMatching(/async-storage.mjs$/),
+        lineno: expect.any(Number),
+        colno: expect.any(Number),
+      },
+    ]));
+
+    expect(stacks['0'].state).toEqual({ traceId: 'trace-5' });
+  });
+
   test('can be disabled', { timeout: 20000 }, () => {
     const testFile = join(__dirname, 'stalled-disabled.js');
     const result = spawnSync('node', [testFile]);

test/package.json.template

@@ -1,5 +1,5 @@
 {
-  "name": "node-cpu-profiler-test",
+  "name": "node-native-stacktrace-test",
   "license": "MIT",
   "dependencies": {
     "@sentry-internal/node-native-stacktrace": "{{path}}"

test/prepare.mjs

@@ -1,6 +1,5 @@
-
 import { execSync, spawnSync } from 'node:child_process';
-import {existsSync,readFileSync, rmSync, writeFileSync } from 'node:fs';
+import { existsSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
 import { createRequire } from 'node:module';
 import { dirname, join, relative } from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -16,9 +15,8 @@ function installTarballAsDependency(root) {
   const tarball = join(__dirname, '..', `${normalizedName}-${pkgJson.version}.tgz`);
 
   if (!existsSync(tarball)) {
-    console.error(`Tarball not found: '${tarball}'`);
-    console.error('Run \'yarn build && yarn build:tarball\' first');
-    process.exit(1);
+    console.log('Creating tarball...');
+    execSync('yarn build:tarball', { shell: true, stdio: 'inherit' });
   }
 
   const tarballRelative = relative(root, tarball);