feat(node): Fix local variables capturing for out-of-app frames

dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-out-of-app-default.js

@@ -0,0 +1,46 @@
+/* eslint-disable no-unused-vars */
+
+const Sentry = require('@sentry/node');
+// const { loggingTransport } = require('@sentry-internal/node-integration-tests'); is throwing error that package not found, so using relative path
+const { loggingTransport } = require('../../../src/index.ts');
+
+// make sure to create the following file with the following content:
+// function out_of_app_function() {
+//   const outOfAppVar = 'out of app value';
+//   throw new Error('out-of-app error');
+// }
+
+// module.exports = { out_of_app_function };
+
+const { out_of_app_function } = require('./node_modules/test-module/out-of-app-function.js');
+
+function in_app_function() {
+  const inAppVar = 'in app value';
+  out_of_app_function();
+}
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+  includeLocalVariables: true,
+  // either set each frame's in_app flag manually or import the `out_of_app_function` from a node_module directory
+  // beforeSend: (event) => {
+  //   event.exception?.values?.[0]?.stacktrace?.frames?.forEach(frame => {
+  //     if (frame.function === 'out_of_app_function') {
+  //       frame.in_app = false;
+  //     }
+  //   });
+  //   return event;
+  // },
+});
+
+setTimeout(async () => {
+  try {
+    in_app_function();
+  } catch (e) {
+    Sentry.captureException(e);
+    await Sentry.flush();
+
+    return null;
+  }
+}, 1000);

dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-out-of-app.js

@@ -0,0 +1,42 @@
+/* eslint-disable no-unused-vars */
+
+const Sentry = require('@sentry/node');
+// const { loggingTransport } = require('@sentry-internal/node-integration-tests'); is throwing error that package not found, so using relative path
+const { loggingTransport } = require('../../../src/index.ts');
+
+const { out_of_app_function } = require('./node_modules/test-module/out-of-app-function.js');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+  includeLocalVariables: true,
+  integrations: [
+    Sentry.localVariablesIntegration({
+      includeOutOfAppFrames: true,
+    }),
+  ],
+  // either set each frame's in_app flag manually or import the `out_of_app_function` from a node_module directory
+  // beforeSend: (event) => {
+  //   event.exception?.values?.[0]?.stacktrace?.frames?.forEach(frame => {
+  //     if (frame.function === 'out_of_app_function') {
+  //       frame.in_app = false;
+  //     }
+  //   });
+  //   return event;
+  // },
+});
+
+function in_app_function() {
+  const inAppVar = 'in app value';
+  out_of_app_function();
+}
+
+setTimeout(async () => {
+  try {
+    in_app_function();
+  } catch (e) {
+    Sentry.captureException(e);
+    await Sentry.flush();
+    return null;
+  }
+}, 1000);

dev-packages/node-integration-tests/suites/public-api/LocalVariables/test.ts

@@ -127,4 +127,44 @@ describe('LocalVariables integration', () => {
       .start()
       .completed();
   });
+
+  test('adds local variables to out of app frames when includeOutOfAppFrames is true', async () => {
+    await createRunner(__dirname, 'local-variables-out-of-app.js')
+      .expect({
+        event: event => {
+          const frames = event.exception?.values?.[0]?.stacktrace?.frames || [];
+
+          const inAppFrame = frames.find(frame => frame.function === 'in_app_function');
+          const outOfAppFrame = frames.find(frame => frame.function === 'out_of_app_function');
+
+          expect(inAppFrame?.vars).toEqual({ inAppVar: 'in app value' });
+          expect(inAppFrame?.in_app).toEqual(true);
+
+          expect(outOfAppFrame?.vars).toEqual({ outOfAppVar: 'out of app value' });
+          expect(outOfAppFrame?.in_app).toEqual(false);
+        },
+      })
+      .start()
+      .completed();
+  });
+
+  test('does not add local variables to out of app frames by default', async () => {
+    await createRunner(__dirname, 'local-variables-out-of-app-default.js')
+      .expect({
+        event: event => {
+          const frames = event.exception?.values?.[0]?.stacktrace?.frames || [];
+
+          const inAppFrame = frames.find(frame => frame.function === 'in_app_function');
+          const outOfAppFrame = frames.find(frame => frame.function === 'out_of_app_function');
+
+          expect(inAppFrame?.vars).toEqual({ inAppVar: 'in app value' });
+          expect(inAppFrame?.in_app).toEqual(true);
+
+          expect(outOfAppFrame?.vars).toBeUndefined();
+          expect(outOfAppFrame?.in_app).toEqual(false);
+        },
+      })
+      .start()
+      .completed();
+  });
 });

packages/node-core/src/integrations/local-variables/common.ts

@@ -99,6 +99,12 @@ export interface LocalVariablesIntegrationOptions {
    * Maximum number of exceptions to capture local variables for per second before rate limiting is triggered.
    */
   maxExceptionsPerSecond?: number;
+  /**
+   * When true, local variables will be captured for all frames, including those that are not in_app.
+   *
+   * Defaults to `false`.
+   */
+  includeOutOfAppFrames?: boolean;
 }
 
 export interface LocalVariablesWorkerArgs extends LocalVariablesIntegrationOptions {

packages/node-core/src/integrations/local-variables/local-variables-async.ts

@@ -39,8 +39,8 @@ export const localVariablesAsyncIntegration = defineIntegration(((
       if (
         // We need to have vars to add
         frameLocalVariables.vars === undefined ||
-        // We're not interested in frames that are not in_app because the vars are not relevant
-        frame.in_app === false ||
+        // Only skip out-of-app frames if includeOutOfAppFrames is not true
+        (frame.in_app === false && integrationOptions.includeOutOfAppFrames !== true) ||
         // The function names need to match
         !functionNamesMatch(frame.function, frameLocalVariables.function)
       ) {