feat(core): Further optimize debug ID parsing

Author: timfish

packages/core/src/utils/prepareEvent.ts

@@ -180,7 +180,7 @@ export function applyDebugIds(event: Event, stackParser: StackParser): void {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       exception.stacktrace!.frames!.forEach(frame => {
         if (frame.filename) {
-          frame.debug_id = filenameDebugIdMap[frame.filename];
+          frame.debug_id = filenameDebugIdMap.get(frame.filename);
         }
       });
     });

packages/node/src/integrations/anr/index.ts

@@ -1,4 +1,3 @@
-import * as diagnosticsChannel from 'node:diagnostics_channel';
 import { Worker } from 'node:worker_threads';
 import { defineIntegration, getCurrentScope, getGlobalScope, getIsolationScope, mergeScopeData } from '@sentry/core';
 import type { Contexts, Event, EventHint, Integration, IntegrationFn, ScopeData } from '@sentry/types';
@@ -101,13 +100,6 @@ type AnrReturn = (options?: Partial<AnrIntegrationOptions>) => Integration & Anr
 
 export const anrIntegration = defineIntegration(_anrIntegration) as AnrReturn;
 
-function onModuleLoad(callback: () => void): void {
-  // eslint-disable-next-line deprecation/deprecation
-  diagnosticsChannel.channel('module.require.end').subscribe(() => callback());
-  // eslint-disable-next-line deprecation/deprecation
-  diagnosticsChannel.channel('module.import.asyncEnd').subscribe(() => callback());
-}
-
 /**
  * Starts the ANR worker thread
  *
@@ -161,12 +153,6 @@ async function _startWorker(
     }
   }
 
-  let debugImages: Record<string, string> = getFilenameToDebugIdMap(initOptions.stackParser);
-
-  onModuleLoad(() => {
-    debugImages = getFilenameToDebugIdMap(initOptions.stackParser);
-  });
-
   const worker = new Worker(new URL(`data:application/javascript;base64,${base64WorkerScript}`), {
     workerData: options,
     // We don't want any Node args to be passed to the worker
@@ -185,7 +171,7 @@ async function _startWorker(
       // serialized without making it a SerializedSession
       const session = currentSession ? { ...currentSession, toJSON: undefined } : undefined;
       // message the worker to tell it the main event loop is still running
-      worker.postMessage({ session, debugImages });
+      worker.postMessage({ session, debugImages: getFilenameToDebugIdMap(initOptions.stackParser) });
     } catch (_) {
       //
     }

packages/utils/src/debug-ids.ts

@@ -1,49 +1,83 @@
-import type { DebugImage, StackFrame, StackParser } from '@sentry/types';
+import type { DebugImage, StackParser } from '@sentry/types';
 import { GLOBAL_OBJ } from './worldwide';
 
-const debugIdStackParserCache = new WeakMap<StackParser, Map<string, StackFrame[]>>();
+type StackString = string;
+
+interface CachedResult {
+  filename: string;
+  debugId: string;
+}
+
+let debugIdStackParserCache: WeakMap<StackParser, Map<StackString, CachedResult>> | undefined;
+
+function getCacheForStackParser(stackParser: StackParser): Map<StackString, CachedResult> {
+  if (!debugIdStackParserCache) {
+    debugIdStackParserCache = new WeakMap();
+  }
+
+  let result = debugIdStackParserCache.get(stackParser);
+
+  if (!result) {
+    result = new Map();
+    debugIdStackParserCache.set(stackParser, result);
+  }
+
+  return result;
+}
+
+let lastDebugIdKeyCount = 0;
+let cachedFilenameToDebugId: Map<string, string> | undefined;
 
 /**
  * Returns a map of filenames to debug identifiers.
  */
-export function getFilenameToDebugIdMap(stackParser: StackParser): Record<string, string> {
+export function getFilenameToDebugIdMap(stackParser: StackParser): Map<string, string> {
   const debugIdMap = GLOBAL_OBJ._sentryDebugIds;
   if (!debugIdMap) {
-    return {};
+    return new Map();
   }
 
-  let debugIdStackFramesCache: Map<string, StackFrame[]>;
-  const cachedDebugIdStackFrameCache = debugIdStackParserCache.get(stackParser);
-  if (cachedDebugIdStackFrameCache) {
-    debugIdStackFramesCache = cachedDebugIdStackFrameCache;
-  } else {
-    debugIdStackFramesCache = new Map<string, StackFrame[]>();
-    debugIdStackParserCache.set(stackParser, debugIdStackFramesCache);
+  const debugIdKeys = Object.keys(debugIdMap);
+
+  // If the count of registered globals hasn't changed since the last call, we
+  // can just return the cached result.
+  if (debugIdKeys.length === lastDebugIdKeyCount && cachedFilenameToDebugId) {
+    return cachedFilenameToDebugId;
   }
 
+  const debugIdStackFramesCache = getCacheForStackParser(stackParser);
+
   // Build a map of filename -> debug_id.
-  return Object.keys(debugIdMap).reduce<Record<string, string>>((acc, debugIdStackTrace) => {
-    let parsedStack: StackFrame[];
-
-    const cachedParsedStack = debugIdStackFramesCache.get(debugIdStackTrace);
-    if (cachedParsedStack) {
-      parsedStack = cachedParsedStack;
-    } else {
-      parsedStack = stackParser(debugIdStackTrace);
-      debugIdStackFramesCache.set(debugIdStackTrace, parsedStack);
-    }
+  const output = debugIdKeys.reduce<Map<string, string>>((acc, debugIdStackTrace) => {
+    let result = debugIdStackFramesCache.get(debugIdStackTrace);
+
+    if (!result) {
+      const parsedStack = stackParser(debugIdStackTrace);
 
-    for (let i = parsedStack.length - 1; i >= 0; i--) {
-      const stackFrame = parsedStack[i];
-      const file = stackFrame && stackFrame.filename;
+      for (let i = parsedStack.length - 1; i >= 0; i--) {
+        const stackFrame = parsedStack[i];
+        const filename = stackFrame && stackFrame.filename;
+        const debugId = debugIdMap[debugIdStackTrace];
 
-      if (stackFrame && file) {
-        acc[file] = debugIdMap[debugIdStackTrace] as string;
-        break;
+        if (filename && debugId) {
+          result = { filename, debugId };
+          debugIdStackFramesCache.set(debugIdStackTrace, result);
+          break;
+        }
       }
     }
+
+    if (result) {
+      acc.set(result.filename, result.debugId);
+    }
+
     return acc;
-  }, {});
+  }, new Map());
+
+  lastDebugIdKeyCount = Object.keys(debugIdMap).length;
+  cachedFilenameToDebugId = output;
+
+  return output;
 }
 
 /**
@@ -57,11 +91,12 @@ export function getDebugImagesForResources(
 
   const images: DebugImage[] = [];
   for (const path of resource_paths) {
-    if (path && filenameDebugIdMap[path]) {
+    const debug_id = filenameDebugIdMap.get(path);
+    if (path && debug_id) {
       images.push({
         type: 'sourcemap',
         code_file: path,
-        debug_id: filenameDebugIdMap[path] as string,
+        debug_id,
       });
     }
   }