fix(local-variables): Improve test for local variables in out of app frames

Move the creation/cleanup of the out-of-app frame module file into
the test setup/teardown.

Author: isaacs

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

@@ -3,34 +3,21 @@
 const Sentry = require('@sentry/node');
 const { loggingTransport } = require('@sentry-internal/node-integration-tests');
 
-// 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');
-// }
+const externalFunctionFile = require.resolve(
+  './node_modules/out-of-app-function.js'
+);
 
-// module.exports = { out_of_app_function };
-
-const { out_of_app_function } = require('./node_modules/test-module/out-of-app-function.js');
+const { out_of_app_function } = require(externalFunctionFile);
 
 function in_app_function() {
   const inAppVar = 'in app value';
-  out_of_app_function();
+  out_of_app_function(`${inAppVar} modified value`);
 }
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/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 () => {
@@ -39,7 +26,5 @@ setTimeout(async () => {
   } catch (e) {
     Sentry.captureException(e);
     await Sentry.flush();
-
-    return null;
   }
-}, 1000);
+}, 500);

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

@@ -3,7 +3,11 @@
 const Sentry = require('@sentry/node');
 const { loggingTransport } = require('@sentry-internal/node-integration-tests');
 
-const { out_of_app_function } = require('./node_modules/test-module/out-of-app-function.js');
+const externalFunctionFile = require.resolve(
+  './node_modules/out-of-app-function.js'
+);
+
+const { out_of_app_function } = require(externalFunctionFile);
 
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
@@ -14,20 +18,11 @@ Sentry.init({
       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();
+  out_of_app_function(`${inAppVar} modified value`);
 }
 
 setTimeout(async () => {
@@ -36,6 +31,5 @@ setTimeout(async () => {
   } catch (e) {
     Sentry.captureException(e);
     await Sentry.flush();
-    return null;
   }
-}, 1000);
+}, 500);

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

@@ -1,5 +1,6 @@
+import { mkdirSync, rmdirSync, unlinkSync, writeFileSync } from 'fs';
 import * as path from 'path';
-import { afterAll, describe, expect, test } from 'vitest';
+import { afterAll, beforeAll, describe, expect, test } from 'vitest';
 import { conditionalTest } from '../../../utils';
 import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
 
@@ -39,8 +40,32 @@ const EXPECTED_LOCAL_VARIABLES_EVENT = {
 };
 
 describe('LocalVariables integration', () => {
+  const nodeModules = `${__dirname}/node_modules`;
+  const externalModule = `${nodeModules}//out-of-app-function.js`;
+  function cleanupExternalModuleFile() {
+    try {
+      unlinkSync(externalModule);
+      // eslint-disable-next-line no-empty
+    } catch {}
+    try {
+      rmdirSync(nodeModules);
+      // eslint-disable-next-line no-empty
+    } catch {}
+  }
+
+  beforeAll(() => {
+    cleanupExternalModuleFile();
+    mkdirSync(nodeModules);
+    writeFileSync(externalModule, `
+function out_of_app_function(passedArg) {
+  const outOfAppVar = "out of app value " + passedArg.substring(13);
+  throw new Error("out-of-app error");
+}
+module.exports = { out_of_app_function };`);
+  });
   afterAll(() => {
     cleanupChildProcesses();
+    cleanupExternalModuleFile();
   });
 
   test('Should not include local variables by default', async () => {
@@ -140,7 +165,10 @@ describe('LocalVariables integration', () => {
           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?.vars).toEqual({
+            outOfAppVar: 'out of app value modified value',
+            passedArg: 'in app value modified value',
+          });
           expect(outOfAppFrame?.in_app).toEqual(false);
         },
       })