fix: Disable ANR and Local Variables if debugger is enabled via CLI a…

…rgs (#14643)
getsentry · Dec 12, 2024 · 0aa7d95 · 0aa7d95
1 parent d9d3b06
commit 0aa7d95
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 5 deletions.
diff --git a/dev-packages/node-integration-tests/suites/anr/test.ts b/dev-packages/node-integration-tests/suites/anr/test.ts
@@ -52,6 +52,35 @@ const ANR_EVENT = {
   },
 };
 
+const ANR_EVENT_WITHOUT_STACKTRACE = {
+  // Ensure we have context
+  contexts: {
+    device: {
+      arch: expect.any(String),
+    },
+    app: {
+      app_start_time: expect.any(String),
+    },
+    os: {
+      name: expect.any(String),
+    },
+    culture: {
+      timezone: expect.any(String),
+    },
+  },
+  // and an exception that is our ANR
+  exception: {
+    values: [
+      {
+        type: 'ApplicationNotResponding',
+        value: 'Application Not Responding for at least 100 ms',
+        mechanism: { type: 'ANR' },
+        stacktrace: {},
+      },
+    ],
+  },
+};
+
 const ANR_EVENT_WITH_SCOPE = {
   ...ANR_EVENT,
   user: {
@@ -98,11 +127,11 @@ conditionalTest({ min: 16 })('should report ANR when event loop blocked', () =>
     createRunner(__dirname, 'indefinite.mjs').withMockSentryServer().expect({ event: ANR_EVENT }).start(done);
   });
 
-  test('With --inspect', done => {
+  test("With --inspect the debugger isn't used", done => {
     createRunner(__dirname, 'basic.mjs')
       .withMockSentryServer()
       .withFlags('--inspect')
-      .expect({ event: ANR_EVENT_WITH_SCOPE })
+      .expect({ event: ANR_EVENT_WITHOUT_STACKTRACE })
       .start(done);
   });
 

diff --git a/packages/node/src/integrations/anr/index.ts b/packages/node/src/integrations/anr/index.ts
@@ -14,6 +14,7 @@ import {
 } from '@sentry/core';
 import { NODE_VERSION } from '../../nodeVersion';
 import type { NodeClient } from '../../sdk/client';
+import { isDebuggerEnabled } from '../../utils/debug';
 import type { AnrIntegrationOptions, WorkerStartData } from './common';
 
 const { isPromise } = types;
@@ -98,9 +99,14 @@ const _anrIntegration = ((options: Partial<AnrIntegrationOptions> = {}) => {
         });
       }
     },
-    setup(initClient: NodeClient) {
+    async setup(initClient: NodeClient) {
       client = initClient;
 
+      if (options.captureStackTrace && (await isDebuggerEnabled())) {
+        logger.warn('ANR captureStackTrace has been disabled because the debugger was already enabled');
+        options.captureStackTrace = false;
+      }
+
       // setImmediate is used to ensure that all other integrations have had their setup called first.
       // This allows us to call into all integrations to fetch the full context
       setImmediate(() => this.startWorker());

diff --git a/packages/node/src/integrations/local-variables/local-variables-async.ts b/packages/node/src/integrations/local-variables/local-variables-async.ts
@@ -2,6 +2,7 @@ import { Worker } from 'node:worker_threads';
 import type { Event, EventHint, Exception, IntegrationFn } from '@sentry/core';
 import { defineIntegration, logger } from '@sentry/core';
 import type { NodeClient } from '../../sdk/client';
+import { isDebuggerEnabled } from '../../utils/debug';
 import type { FrameVariables, LocalVariablesIntegrationOptions, LocalVariablesWorkerArgs } from './common';
 import { LOCAL_VARIABLES_KEY, functionNamesMatch } from './common';
 
@@ -101,13 +102,18 @@ export const localVariablesAsyncIntegration = defineIntegration(((
 
   return {
     name: 'LocalVariablesAsync',
-    setup(client: NodeClient) {
+    async setup(client: NodeClient) {
       const clientOptions = client.getOptions();
 
       if (!clientOptions.includeLocalVariables) {
         return;
       }
 
+      if (await isDebuggerEnabled()) {
+        logger.warn('Local variables capture has been disabled because the debugger was already enabled');
+        return;
+      }
+
       const options: LocalVariablesWorkerArgs = {
         ...integrationOptions,
         debug: logger.isEnabled(),

diff --git a/packages/node/src/integrations/local-variables/local-variables-sync.ts b/packages/node/src/integrations/local-variables/local-variables-sync.ts
@@ -3,6 +3,7 @@ import type { Event, Exception, IntegrationFn, StackFrame, StackParser } from '@
 import { LRUMap, defineIntegration, getClient, logger } from '@sentry/core';
 import { NODE_MAJOR } from '../../nodeVersion';
 import type { NodeClient } from '../../sdk/client';
+import { isDebuggerEnabled } from '../../utils/debug';
 import type {
   FrameVariables,
   LocalVariablesIntegrationOptions,
@@ -289,7 +290,7 @@ const _localVariablesSyncIntegration = ((
 
   return {
     name: INTEGRATION_NAME,
-    setupOnce() {
+    async setupOnce() {
       const client = getClient<NodeClient>();
       const clientOptions = client?.getOptions();
 
@@ -306,6 +307,11 @@ const _localVariablesSyncIntegration = ((
         return;
       }
 
+      if (await isDebuggerEnabled()) {
+        logger.warn('Local variables capture has been disabled because the debugger was already enabled');
+        return;
+      }
+
       AsyncSession.create(sessionOverride).then(
         session => {
           function handlePaused(

diff --git a/packages/node/src/utils/debug.ts b/packages/node/src/utils/debug.ts
@@ -0,0 +1,18 @@
+let cachedDebuggerEnabled: boolean | undefined;
+
+/**
+ * Was the debugger enabled when this function was first called?
+ */
+export async function isDebuggerEnabled(): Promise<boolean> {
+  if (cachedDebuggerEnabled === undefined) {
+    try {
+      // Node can be built without inspector support
+      const inspector = await import('node:inspector');
+      cachedDebuggerEnabled = !!inspector.url();
+    } catch (_) {
+      cachedDebuggerEnabled = false;
+    }
+  }
+
+  return cachedDebuggerEnabled;
+}