feat(node) Capture SystemError context and remove paths from message

Author: timfish

dev-packages/node-core-integration-tests/suites/system-error/basic-pii.mjs

@@ -0,0 +1,11 @@
+import * as Sentry from '@sentry/node-core';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+import { readFileSync } from 'fs';
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+  sendDefaultPii: true,
+});
+
+readFileSync('non-existent-file.txt');

dev-packages/node-core-integration-tests/suites/system-error/basic.mjs

@@ -0,0 +1,10 @@
+import * as Sentry from '@sentry/node-core';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+import { readFileSync } from 'fs';
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+});
+
+readFileSync('non-existent-file.txt');

dev-packages/node-core-integration-tests/suites/system-error/test.ts

@@ -0,0 +1,59 @@
+import { afterAll, describe, test } from 'vitest';
+import { cleanupChildProcesses, createRunner } from '../../utils/runner';
+
+afterAll(() => {
+  cleanupChildProcesses();
+});
+
+describe('SystemError integration', () => {
+  test('sendDefaultPii: false', async () => {
+    await createRunner(__dirname, 'basic.mjs')
+      .expect({
+        event: {
+          contexts: {
+            node_system_error: {
+              errno: -2,
+              code: 'ENOENT',
+              syscall: 'open',
+            },
+          },
+          exception: {
+            values: [
+              {
+                type: 'Error',
+                value: 'ENOENT: no such file or directory, open ',
+              }
+            ]
+          },
+        },
+      })
+      .start()
+      .completed();
+  });
+
+  test('sendDefaultPii: true', async () => {
+    await createRunner(__dirname, 'basic-pii.mjs')
+      .expect({
+        event: {
+          contexts: {
+            node_system_error: {
+              errno: -2,
+              code: 'ENOENT',
+              syscall: 'open',
+              path: 'non-existent-file.txt'
+            },
+          },
+          exception: {
+            values: [
+              {
+                type: 'Error',
+                value: 'ENOENT: no such file or directory, open ',
+              }
+            ]
+          },
+        },
+      })
+      .start()
+      .completed();
+  });
+});

packages/node-core/src/index.ts

@@ -21,6 +21,7 @@ export { onUnhandledRejectionIntegration } from './integrations/onunhandledrejec
 export { anrIntegration, disableAnrDetectionForCallback } from './integrations/anr';
 
 export { spotlightIntegration } from './integrations/spotlight';
+export { systemErrorIntegration } from './integrations/systemError';
 export { childProcessIntegration } from './integrations/childProcess';
 export { createSentryWinstonTransport } from './integrations/winston';
 

packages/node-core/src/integrations/systemError.ts

@@ -0,0 +1,69 @@
+import { defineIntegration } from '@sentry/core';
+import { getSystemErrorMap } from 'util';
+
+const INTEGRATION_NAME = 'NodeSystemError';
+
+type SystemErrorContext = {
+  dest?: string; // If present, the file path destination when reporting a file system error
+  errno: number; // The system-provided error number
+  path?: string; // If present, the file path when reporting a file system error
+};
+
+type SystemError = Error & SystemErrorContext;
+
+function isSystemError(error: unknown): error is SystemError {
+  if (!(error instanceof Error)) {
+    return false;
+  }
+
+  if (!('errno' in error) || typeof error.errno !== 'number') {
+    return false;
+  }
+
+  // Appears this is the recommended way to check for Node.js SystemError
+  // https://github.com/nodejs/node/issues/46869
+  return getSystemErrorMap().has(error.errno);
+}
+
+/**
+ * Captures context for Node.js SystemError errors.
+ */
+export const systemErrorIntegration = defineIntegration(() => {
+  return {
+    name: INTEGRATION_NAME,
+    processEvent: (event, hint, client) => {
+      if (!isSystemError(hint.originalException)) {
+        return event;
+      }
+
+      const error = hint.originalException;
+
+      const errorContext: SystemErrorContext = {
+        ...error,
+      };
+
+      if (!client.getOptions().sendDefaultPii) {
+        delete errorContext.path;
+        delete errorContext.dest;
+      }
+
+      event.contexts = {
+        ...event.contexts,
+        node_system_error: errorContext,
+      };
+
+      for (const exception of event.exception?.values || []) {
+        if (exception.value) {
+          if (error.path && exception.value.includes(error.path)) {
+            exception.value = exception.value.replace(`'${error.path}'`, '');
+          }
+          if (error.dest && exception.value.includes(error.dest)) {
+            exception.value = exception.value.replace(`'${error.dest}'`, '');
+          }
+        }
+      }
+
+      return event;
+    },
+  };
+});

packages/node-core/src/sdk/index.ts

@@ -32,6 +32,7 @@ import { onUncaughtExceptionIntegration } from '../integrations/onuncaughtexcept
 import { onUnhandledRejectionIntegration } from '../integrations/onunhandledrejection';
 import { processSessionIntegration } from '../integrations/processSession';
 import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from '../integrations/spotlight';
+import { systemErrorIntegration } from '../integrations/systemError';
 import { makeNodeTransport } from '../transports';
 import type { NodeClientOptions, NodeOptions } from '../types';
 import { isCjs } from '../utils/commonjs';
@@ -52,6 +53,7 @@ export function getDefaultIntegrations(): Integration[] {
     functionToStringIntegration(),
     linkedErrorsIntegration(),
     requestDataIntegration(),
+    systemErrorIntegration(),
     // Native Wrappers
     consoleIntegration(),
     httpIntegration(),