feat(node): Capture exceptions from worker threads

Author: timfish

dev-packages/node-integration-tests/suites/child-process/child.js

@@ -0,0 +1,3 @@
+setTimeout(() => {
+  throw new Error('Test error');
+}, 1000);

dev-packages/node-integration-tests/suites/child-process/child.mjs

@@ -0,0 +1,3 @@
+setTimeout(() => {
+  throw new Error('Test error');
+}, 1000);

dev-packages/node-integration-tests/suites/child-process/fork.js

@@ -0,0 +1,19 @@
+const Sentry =  require('@sentry/node');
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const path = require('path');
+const { fork } = require('child_process');
+
+Sentry.init({
+  debug: true,
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  integrations: [Sentry.childProcessIntegration()],
+  transport: loggingTransport,
+});
+
+// eslint-disable-next-line no-unused-vars
+const _child = fork(path.join(__dirname, 'child.mjs'));
+
+setTimeout(() => {
+  throw new Error('Exiting main process');
+}, 3000);

dev-packages/node-integration-tests/suites/child-process/fork.mjs

@@ -0,0 +1,20 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+import * as path from 'path';
+import { fork } from 'child_process';
+
+const __dirname = new URL('.', import.meta.url).pathname;
+
+Sentry.init({
+  debug: true,
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  integrations: [Sentry.childProcessIntegration()],
+  transport: loggingTransport,
+});
+
+const _child = fork(path.join(__dirname, 'child.mjs'));
+
+setTimeout(() => {
+  throw new Error('Exiting main process');
+}, 3000);

dev-packages/node-integration-tests/suites/child-process/test.ts

@@ -0,0 +1,58 @@
+import type { Event } from '@sentry/core';
+import { conditionalTest } from '../../utils';
+import { cleanupChildProcesses, createRunner } from '../../utils/runner';
+
+const WORKER_EVENT: Event = {
+  exception: {
+    values: [
+      {
+        type: 'Error',
+        value: 'Test error',
+      },
+    ],
+  },
+};
+
+const CHILD_EVENT: Event = {
+  exception: {
+    values: [
+      {
+        type: 'Error',
+        value: 'Exiting main process',
+      },
+    ],
+  },
+  breadcrumbs: [
+    {
+      category: 'child_process',
+      message: "Child process exited with code '1'",
+      level: 'info',
+    },
+  ],
+};
+
+describe('should capture child process events', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  describe('worker', () => {
+    test('ESM', done => {
+      createRunner(__dirname, 'worker.mjs').expect({ event: WORKER_EVENT }).start(done);
+    });
+
+    test('CJS', done => {
+      createRunner(__dirname, 'worker.js').expect({ event: WORKER_EVENT }).start(done);
+    });
+  });
+
+  conditionalTest({ min: 20 })('fork', () => {
+    test('ESM', done => {
+      createRunner(__dirname, 'fork.mjs').expect({ event: CHILD_EVENT }).start(done);
+    });
+
+    test('CJS', done => {
+      createRunner(__dirname, 'fork.js').expect({ event: CHILD_EVENT }).start(done);
+    });
+  });
+});

dev-packages/node-integration-tests/suites/child-process/worker.js

@@ -0,0 +1,19 @@
+const Sentry =  require('@sentry/node');
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const path = require('path');
+const { Worker } = require('worker_threads');
+
+Sentry.init({
+  debug: true,
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  integrations: [Sentry.childProcessIntegration()],
+  transport: loggingTransport,
+});
+
+// eslint-disable-next-line no-unused-vars
+const _worker = new Worker(path.join(__dirname, 'child.js'));
+
+setTimeout(() => {
+  process.exit();
+}, 3000);

dev-packages/node-integration-tests/suites/child-process/worker.mjs

@@ -0,0 +1,20 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+import * as path from 'path';
+import { Worker } from 'worker_threads';
+
+const __dirname = new URL('.', import.meta.url).pathname;
+
+Sentry.init({
+  debug: true,
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  integrations: [Sentry.childProcessIntegration()],
+  transport: loggingTransport,
+});
+
+const _worker = new Worker(path.join(__dirname, 'child.mjs'));
+
+setTimeout(() => {
+  process.exit();
+}, 3000);

packages/node/src/integrations/childProcess.ts

@@ -1,7 +1,7 @@
 import type { ChildProcess } from 'node:child_process';
 import * as diagnosticsChannel from 'node:diagnostics_channel';
 import type { Worker } from 'node:worker_threads';
-import { addBreadcrumb, defineIntegration } from '@sentry/core';
+import { addBreadcrumb, captureException, defineIntegration } from '@sentry/core';
 
 interface Options {
   /**
@@ -10,6 +10,13 @@ interface Options {
    * @default false
    */
   includeChildProcessArgs?: boolean;
+
+  /**
+   * Whether to capture errors from worker threads.
+   *
+   * @default true
+   */
+  captureWorkerErrors?: boolean;
 }
 
 const INTEGRATION_NAME = 'ChildProcess';
@@ -20,7 +27,7 @@ const INTEGRATION_NAME = 'ChildProcess';
 export const childProcessIntegration = defineIntegration((options: Options = {}) => {
   return {
     name: INTEGRATION_NAME,
-    setup(_client) {
+    setup() {
       diagnosticsChannel.channel('child_process').subscribe((event: unknown) => {
         if (event && typeof event === 'object' && 'process' in event) {
           captureChildProcessEvents(event.process as ChildProcess, options);
@@ -29,7 +36,7 @@ export const childProcessIntegration = defineIntegration((options: Options = {})
 
       diagnosticsChannel.channel('worker_threads').subscribe((event: unknown) => {
         if (event && typeof event === 'object' && 'worker' in event) {
-          captureWorkerThreadEvents(event.worker as Worker);
+          captureWorkerThreadEvents(event.worker as Worker, options);
         }
       });
     },
@@ -62,7 +69,7 @@ function captureChildProcessEvents(child: ChildProcess, options: Options): void
           addBreadcrumb({
             category: 'child_process',
             message: `Child process exited with code '${code}'`,
-            level: 'warning',
+            level: code === 0 ? 'warning' : 'info',
             data,
           });
         }
@@ -82,19 +89,25 @@ function captureChildProcessEvents(child: ChildProcess, options: Options): void
     });
 }
 
-function captureWorkerThreadEvents(worker: Worker): void {
+function captureWorkerThreadEvents(worker: Worker, options: Options): void {
   let threadId: number | undefined;
 
   worker
     .on('online', () => {
       threadId = worker.threadId;
     })
     .on('error', error => {
-      addBreadcrumb({
-        category: 'worker_thread',
-        message: `Worker thread errored with '${error.message}'`,
-        level: 'error',
-        data: { threadId },
-      });
+      if (options.captureWorkerErrors !== false) {
+        captureException(error, {
+          mechanism: { type: 'instrument', handled: false, data: { threadId: String(threadId) } },
+        });
+      } else {
+        addBreadcrumb({
+          category: 'worker_thread',
+          message: `Worker thread errored with '${error.message}'`,
+          level: 'error',
+          data: { threadId },
+        });
+      }
     });
 }