feat: Add source map debug ids (#7068)

Author: Luca Forstner

packages/types/src/stackframe.ts

@@ -14,4 +14,5 @@ export interface StackFrame {
   instruction_addr?: string;
   addr_mode?: string;
   vars?: { [key: string]: any };
+  debug_id?: string;
 }

packages/utils/src/stacktrace.ts

@@ -1,7 +1,14 @@
 import type { StackFrame, StackLineParser, StackLineParserFn, StackParser } from '@sentry/types';
 
+import { GLOBAL_OBJ } from './worldwide';
+
 const STACKTRACE_LIMIT = 50;
 
+type DebugIdFilename = string;
+type DebugId = string;
+
+const debugIdParserCache = new Map<StackLineParserFn, Map<DebugIdFilename, DebugId>>();
+
 /**
  * Creates a stack parser with the supplied line parsers
  *
@@ -15,6 +22,28 @@ export function createStackParser(...parsers: StackLineParser[]): StackParser {
   return (stack: string, skipFirst: number = 0): StackFrame[] => {
     const frames: StackFrame[] = [];
 
+    for (const parser of sortedParsers) {
+      let debugIdCache = debugIdParserCache.get(parser);
+      if (!debugIdCache) {
+        debugIdCache = new Map();
+        debugIdParserCache.set(parser, debugIdCache);
+      }
+
+      const debugIdMap = GLOBAL_OBJ._sentryDebugIds;
+
+      if (debugIdMap) {
+        Object.keys(debugIdMap).forEach(debugIdStackTrace => {
+          debugIdStackTrace.split('\n').forEach(line => {
+            const frame = parser(line);
+            if (frame && frame.filename) {
+              // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+              debugIdCache!.set(frame.filename, debugIdMap[debugIdStackTrace]);
+            }
+          });
+        });
+      }
+    }
+
     for (const line of stack.split('\n').slice(skipFirst)) {
       // Ignore lines over 1kb as they are unlikely to be stack frames.
       // Many of the regular expressions use backtracking which results in run time that increases exponentially with
@@ -32,6 +61,14 @@ export function createStackParser(...parsers: StackLineParser[]): StackParser {
         const frame = parser(cleanedLine);
 
         if (frame) {
+          const debugIdCache = debugIdParserCache.get(parser);
+          if (debugIdCache && frame.filename) {
+            const cachedDebugId = debugIdCache.get(frame.filename);
+            if (cachedDebugId) {
+              frame.debug_id = cachedDebugId;
+            }
+          }
+
           frames.push(frame);
           break;
         }

packages/utils/src/worldwide.ts

@@ -29,6 +29,7 @@ export interface InternalGlobal {
     id?: string;
   };
   SENTRY_SDK_SOURCE?: SdkSource;
+  _sentryDebugIds?: Record<string, string>;
   __SENTRY__: {
     globalEventProcessors: any;
     hub: any;

packages/utils/test/stacktrace.test.ts

@@ -1,4 +1,5 @@
-import { stripSentryFramesAndReverse } from '../src/stacktrace';
+import { createStackParser, stripSentryFramesAndReverse } from '../src/stacktrace';
+import { GLOBAL_OBJ } from '../src/worldwide';
 
 describe('Stacktrace', () => {
   describe('stripSentryFramesAndReverse()', () => {
@@ -68,3 +69,41 @@ describe('Stacktrace', () => {
     });
   });
 });
+
+describe('Stack parsers created with createStackParser', () => {
+  afterEach(() => {
+    GLOBAL_OBJ._sentryDebugIds = undefined;
+  });
+
+  it('put debug ids onto individual frames', () => {
+    GLOBAL_OBJ._sentryDebugIds = {
+      'filename1.js\nfilename1.js': 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa',
+      'filename2.js\nfilename2.js': 'bbbbbbbb-bbbb-4bbb-bbbb-bbbbbbbbbb',
+    };
+
+    const fakeErrorStack = 'filename1.js\nfilename2.js\nfilename1.js\nfilename3.js';
+    const stackParser = createStackParser([0, line => ({ filename: line })]);
+
+    const result = stackParser(fakeErrorStack);
+
+    expect(result[0]).toStrictEqual({ filename: 'filename3.js', function: '?' });
+
+    expect(result[1]).toStrictEqual({
+      filename: 'filename1.js',
+      function: '?',
+      debug_id: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa',
+    });
+
+    expect(result[2]).toStrictEqual({
+      filename: 'filename2.js',
+      function: '?',
+      debug_id: 'bbbbbbbb-bbbb-4bbb-bbbb-bbbbbbbbbb',
+    });
+
+    expect(result[3]).toStrictEqual({
+      filename: 'filename1.js',
+      function: '?',
+      debug_id: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa',
+    });
+  });
+});