feat(node): Rework ANR to use worker script via an integration

.gitignore

@@ -50,6 +50,9 @@ tmp.js
 .eslintcache
 **/eslintcache/*
 
+# node worker scripts
+packages/node/src/integrations/anr/worker-script.*
+
 # deno
 packages/deno/build-types
 packages/deno/build-test

packages/core/src/index.ts

@@ -5,7 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
 export type { RequestDataIntegrationOptions } from './integrations/requestdata';
 
 export * from './tracing';
-export { createEventEnvelope } from './envelope';
+export { createEventEnvelope, createSessionEnvelope } from './envelope';
 export {
   addBreadcrumb,
   captureCheckIn,

packages/node-integration-tests/suites/anr/basic-session.js

@@ -2,30 +2,25 @@ const crypto = require('crypto');
 
 const Sentry = require('@sentry/node');
 
-const { transport } = require('./test-transport.js');
-
-// close both processes after 5 seconds
 setTimeout(() => {
   process.exit();
-}, 5000);
+}, 10000);
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   release: '1.0',
   debug: true,
-  transport,
+  integrations: [new Sentry.Integrations.Anr({ captureStackTrace: true, anrThreshold: 200 })],
 });
 
-Sentry.enableAnrDetection({ captureStackTrace: true, anrThreshold: 200 }).then(() => {
-  function longWork() {
-    for (let i = 0; i < 100; i++) {
-      const salt = crypto.randomBytes(128).toString('base64');
-      // eslint-disable-next-line no-unused-vars
-      const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
-    }
+function longWork() {
+  for (let i = 0; i < 100; i++) {
+    const salt = crypto.randomBytes(128).toString('base64');
+    // eslint-disable-next-line no-unused-vars
+    const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
   }
+}
 
-  setTimeout(() => {
-    longWork();
-  }, 1000);
-});
+setTimeout(() => {
+  longWork();
+}, 1000);

packages/node-integration-tests/suites/anr/basic.js

@@ -2,31 +2,26 @@ const crypto = require('crypto');
 
 const Sentry = require('@sentry/node');
 
-const { transport } = require('./test-transport.js');
-
-// close both processes after 5 seconds
 setTimeout(() => {
   process.exit();
-}, 5000);
+}, 10000);
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   release: '1.0',
   debug: true,
   autoSessionTracking: false,
-  transport,
+  integrations: [new Sentry.Integrations.Anr({ captureStackTrace: true, anrThreshold: 200 })],
 });
 
-Sentry.enableAnrDetection({ captureStackTrace: true, anrThreshold: 200 }).then(() => {
-  function longWork() {
-    for (let i = 0; i < 100; i++) {
-      const salt = crypto.randomBytes(128).toString('base64');
-      // eslint-disable-next-line no-unused-vars
-      const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
-    }
+function longWork() {
+  for (let i = 0; i < 100; i++) {
+    const salt = crypto.randomBytes(128).toString('base64');
+    // eslint-disable-next-line no-unused-vars
+    const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
   }
+}
 
-  setTimeout(() => {
-    longWork();
-  }, 1000);
-});
+setTimeout(() => {
+  longWork();
+}, 1000);

packages/node-integration-tests/suites/anr/basic.mjs

@@ -2,23 +2,18 @@ import * as crypto from 'crypto';
 
 import * as Sentry from '@sentry/node';
 
-const { transport } = await import('./test-transport.js');
-
-// close both processes after 5 seconds
 setTimeout(() => {
   process.exit();
-}, 5000);
+}, 10000);
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   release: '1.0',
   debug: true,
   autoSessionTracking: false,
-  transport,
+  integrations: [new Sentry.Integrations.Anr({ captureStackTrace: true, anrThreshold: 200 })],
 });
 
-await Sentry.enableAnrDetection({ captureStackTrace: true, anrThreshold: 200 });
-
 function longWork() {
   for (let i = 0; i < 100; i++) {
     const salt = crypto.randomBytes(128).toString('base64');

packages/node-integration-tests/suites/anr/forked.js

@@ -2,31 +2,26 @@ const crypto = require('crypto');
 
 const Sentry = require('@sentry/node');
 
-const { transport } = require('./test-transport.js');
-
-// close both processes after 5 seconds
 setTimeout(() => {
   process.exit();
-}, 5000);
+}, 10000);
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   release: '1.0',
   debug: true,
   autoSessionTracking: false,
-  transport,
+  integrations: [new Sentry.Integrations.Anr({ captureStackTrace: true, anrThreshold: 200 })],
 });
 
-Sentry.enableAnrDetection({ captureStackTrace: true, anrThreshold: 200 }).then(() => {
-  function longWork() {
-    for (let i = 0; i < 100; i++) {
-      const salt = crypto.randomBytes(128).toString('base64');
-      // eslint-disable-next-line no-unused-vars
-      const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
-    }
+function longWork() {
+  for (let i = 0; i < 100; i++) {
+    const salt = crypto.randomBytes(128).toString('base64');
+    // eslint-disable-next-line no-unused-vars
+    const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
   }
+}
 
-  setTimeout(() => {
-    longWork();
-  }, 1000);
-});
+setTimeout(() => {
+  longWork();
+}, 1000);

packages/node-integration-tests/suites/anr/test.ts

@@ -26,10 +26,12 @@ function parseJsonLines<T extends unknown[]>(input: string, expected: number): T
 
 describe('should report ANR when event loop blocked', () => {
   test('CJS', done => {
-    // The stack trace is different when node < 12
-    const testFramesDetails = NODE_VERSION >= 12;
+    if (NODE_VERSION < 16) {
+      done();
+      return;
+    }
 
-    expect.assertions(testFramesDetails ? 7 : 5);
+    expect.assertions(9);
 
     const testScriptPath = path.resolve(__dirname, 'basic.js');
 
@@ -41,17 +43,18 @@ describe('should report ANR when event loop blocked', () => {
       expect(event.exception?.values?.[0].value).toEqual('Application Not Responding for at least 200 ms');
       expect(event.exception?.values?.[0].stacktrace?.frames?.length).toBeGreaterThan(4);
 
-      if (testFramesDetails) {
-        expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
-        expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
-      }
+      expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
+      expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
+
+      expect(event.contexts?.trace?.trace_id).toBeDefined();
+      expect(event.contexts?.trace?.span_id).toBeDefined();
 
       done();
     });
   });
 
   test('ESM', done => {
-    if (NODE_VERSION < 14) {
+    if (NODE_VERSION < 16) {
       done();
       return;
     }
@@ -66,7 +69,7 @@ describe('should report ANR when event loop blocked', () => {
       expect(event.exception?.values?.[0].mechanism).toEqual({ type: 'ANR' });
       expect(event.exception?.values?.[0].type).toEqual('ApplicationNotResponding');
       expect(event.exception?.values?.[0].value).toEqual('Application Not Responding for at least 200 ms');
-      expect(event.exception?.values?.[0].stacktrace?.frames?.length).toBeGreaterThan(4);
+      expect(event.exception?.values?.[0].stacktrace?.frames?.length).toBeGreaterThanOrEqual(4);
       expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
       expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
 
@@ -75,10 +78,12 @@ describe('should report ANR when event loop blocked', () => {
   });
 
   test('With session', done => {
-    // The stack trace is different when node < 12
-    const testFramesDetails = NODE_VERSION >= 12;
+    if (NODE_VERSION < 16) {
+      done();
+      return;
+    }
 
-    expect.assertions(testFramesDetails ? 9 : 7);
+    expect.assertions(9);
 
     const testScriptPath = path.resolve(__dirname, 'basic-session.js');
 
@@ -90,10 +95,8 @@ describe('should report ANR when event loop blocked', () => {
       expect(event.exception?.values?.[0].value).toEqual('Application Not Responding for at least 200 ms');
       expect(event.exception?.values?.[0].stacktrace?.frames?.length).toBeGreaterThan(4);
 
-      if (testFramesDetails) {
-        expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
-        expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
-      }
+      expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
+      expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
 
       expect(session.status).toEqual('abnormal');
       expect(session.abnormal_mechanism).toEqual('anr_foreground');
@@ -103,10 +106,12 @@ describe('should report ANR when event loop blocked', () => {
   });
 
   test('from forked process', done => {
-    // The stack trace is different when node < 12
-    const testFramesDetails = NODE_VERSION >= 12;
+    if (NODE_VERSION < 16) {
+      done();
+      return;
+    }
 
-    expect.assertions(testFramesDetails ? 7 : 5);
+    expect.assertions(7);
 
     const testScriptPath = path.resolve(__dirname, 'forker.js');
 
@@ -118,10 +123,8 @@ describe('should report ANR when event loop blocked', () => {
       expect(event.exception?.values?.[0].value).toEqual('Application Not Responding for at least 200 ms');
       expect(event.exception?.values?.[0].stacktrace?.frames?.length).toBeGreaterThan(4);
 
-      if (testFramesDetails) {
-        expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
-        expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
-      }
+      expect(event.exception?.values?.[0].stacktrace?.frames?.[2].function).toEqual('?');
+      expect(event.exception?.values?.[0].stacktrace?.frames?.[3].function).toEqual('longWork');
 
       done();
     });

packages/node/.eslintrc.js

@@ -2,6 +2,7 @@ module.exports = {
   env: {
     node: true,
   },
+  ignorePatterns: ['src/integrations/anr/worker-script.ts'],
   extends: ['../../.eslintrc.js'],
   rules: {
     '@sentry-internal/sdk/no-optional-chaining': 'off',

packages/node/package.json

@@ -41,20 +41,22 @@
   "scripts": {
     "build": "run-p build:transpile build:types",
     "build:dev": "yarn build",
-    "build:transpile": "rollup -c rollup.npm.config.js",
-    "build:types": "run-s build:types:core build:types:downlevel",
+    "build:transpile": "yarn build:anr-worker && rollup -c rollup.npm.config.js",
+    "build:types": "run-s build:anr-worker build:types:core build:types:downlevel",
     "build:types:core": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
     "build:watch": "run-p build:transpile:watch build:types:watch",
     "build:dev:watch": "yarn build:watch",
     "build:transpile:watch": "rollup -c rollup.npm.config.js --watch",
     "build:types:watch": "tsc -p tsconfig.types.json --watch",
     "build:tarball": "ts-node ../../scripts/prepack.ts && npm pack ./build",
+    "build:anr-worker": "rollup -c rollup.anr-worker.config.js",
+    "build:anr-worker-stub": "echo 'export const base64WorkerScript=\"\";' > src/integrations/anr/worker-script.ts",
     "circularDepCheck": "madge --circular src/index.ts",
     "clean": "rimraf build coverage sentry-node-*.tgz",
     "fix": "eslint . --format stylish --fix",
     "lint": "eslint . --format stylish",
-    "test": "run-s test:jest test:express test:webpack test:release-health",
+    "test": "run-s build:anr-worker-stub test:jest test:express test:webpack test:release-health",
     "test:express": "node test/manual/express-scope-separation/start.js",
     "test:jest": "jest",
     "test:release-health": "node test/manual/release-health/runner.js",

packages/node/rollup.anr-worker.config.js

@@ -0,0 +1,23 @@
+import { makeBaseBundleConfig } from '../../rollup/index.js';
+
+export default makeBaseBundleConfig({
+  bundleType: 'node-worker',
+  entrypoints: ['src/integrations/anr/worker.ts'],
+  jsVersion: 'es6',
+  licenseTitle: '@sentry/node',
+  outputFileBase: () => 'worker-script.ts',
+  packageSpecificConfig: {
+    output: {
+      dir: './src/integrations/anr',
+      sourcemap: false,
+    },
+    plugins: [
+      {
+        name: 'output-base64-worker-script',
+        renderChunk(code) {
+          return `export const base64WorkerScript = '${Buffer.from(code).toString('base64')}';`;
+        },
+      },
+    ],
+  },
+});