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

This PR reworks Node ANR detection to use a worker thread. Workers are
usually started via a path to a source file but this can cause issues
when bundlers are used. Instead, the worker code is bundled and included
in the source as a base64 string which can be used to launch a worker
via a data URL. The base64 code comes in at around 45KB.

Positives 👍
- No extra processes
- Only 10-15MB memory overhead (vs at least 50MB for a child process)
- Uses inspector API so we can remove the websockets implementation
- Doesn't require special cases/setup for Electron main process
- No longer runs the app entry point again as the child process code
   - Closes some outstanding Electron ANR issues
- ANR becomes just an integration since we don't need to intercept app
execution in the child
   - Less confusing setup and less chance of running the app twice

Negatives 👎
- Minimum supported Node version for ANR detection becomes v16 because
Node 14 does not support data URLs for workers 😢

## Usage

```ts
import * as Sentry from '@sentry/node';

Sentry.init({
  dsn: 'https://[email protected]/1337',
  integrations: [new Sentry.Integrations.Anr({ captureStackTrace: true, anrThreshold: 200 })],
});
```

.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-experimental/src/sdk/init.ts

@@ -4,7 +4,6 @@ import {
   defaultIntegrations as defaultNodeIntegrations,
   defaultStackParser,
   getSentryRelease,
-  isAnrChildProcess,
   makeNodeTransport,
 } from '@sentry/node';
 import type { Integration } from '@sentry/types';
@@ -113,15 +112,14 @@ function getClientOptions(options: NodeExperimentalOptions): NodeExperimentalCli
 
   const release = getRelease(options.release);
 
-  // If there is no release, or we are in an ANR child process, we disable autoSessionTracking by default
   const autoSessionTracking =
-    typeof release !== 'string' || isAnrChildProcess()
+    typeof release !== 'string'
       ? false
       : options.autoSessionTracking === undefined
         ? true
         : options.autoSessionTracking;
-  // We enforce tracesSampleRate = 0 in ANR child processes
-  const tracesSampleRate = isAnrChildProcess() ? 0 : getTracesSampleRate(options.tracesSampleRate);
+
+  const tracesSampleRate = getTracesSampleRate(options.tracesSampleRate);
 
   const baseOptions = dropUndefinedKeys({
     transport: makeNodeTransport,

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

@@ -1,31 +1,28 @@
 const crypto = require('crypto');
+const assert = require('assert');
 
 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://[email protected]/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');
+    assert.ok(hash);
   }
+}
 
-  setTimeout(() => {
-    longWork();
-  }, 1000);
-});
+setTimeout(() => {
+  longWork();
+}, 1000);

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

@@ -1,32 +1,29 @@
 const crypto = require('crypto');
+const assert = require('assert');
 
 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://[email protected]/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');
+    assert.ok(hash);
   }
+}
 
-  setTimeout(() => {
-    longWork();
-  }, 1000);
-});
+setTimeout(() => {
+  longWork();
+}, 1000);

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

@@ -1,29 +1,26 @@
+import * as assert from 'assert';
 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://[email protected]/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');
     // eslint-disable-next-line no-unused-vars
     const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
+    assert.ok(hash);
   }
 }
 

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

@@ -1,32 +1,29 @@
 const crypto = require('crypto');
+const assert = require('assert');
 
 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://[email protected]/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');
+    assert.ok(hash);
   }
+}
 
-  setTimeout(() => {
-    longWork();
-  }, 1000);
-});
+setTimeout(() => {
+  longWork();
+}, 1000);

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

@@ -0,0 +1,31 @@
+const crypto = require('crypto');
+const assert = require('assert');
+
+const Sentry = require('@sentry/node');
+
+setTimeout(() => {
+  process.exit();
+}, 10000);
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  debug: true,
+  autoSessionTracking: false,
+});
+
+// eslint-disable-next-line deprecation/deprecation
+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');
+      assert.ok(hash);
+    }
+  }
+
+  setTimeout(() => {
+    longWork();
+  }, 1000);
+});