Simplify by sending raw module data from worker to main-thread

andreiborza · andreiborza · commit 65aefd3cfd4a · 2026-01-09T15:04:23.000+01:00
diff --git a/packages/browser/src/integrations/webWorker.ts b/packages/browser/src/integrations/webWorker.ts
@@ -1,18 +1,8 @@
 import type { Integration, IntegrationFn } from '@sentry/core';
-import {
-  captureEvent,
-  debug,
-  defineIntegration,
-  getClient,
-  getFilenameToMetadataMap,
-  isPlainObject,
-  isPrimitive,
-  mergeMetadataMap,
-} from '@sentry/core';
+import { captureEvent, debug, defineIntegration, getClient, isPlainObject, isPrimitive } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
 import { eventFromUnknownInput } from '../eventbuilder';
 import { WINDOW } from '../helpers';
-import { defaultStackParser } from '../stack-parsers';
 import { _eventFromRejectionWithPrimitive, _getUnhandledRejectionError } from './globalhandlers';
 
 export const INTEGRATION_NAME = 'WebWorker';
@@ -136,8 +126,12 @@ function listenForSentryMessages(worker: Worker): void {
       // Handle module metadata
       if (event.data._sentryModuleMetadata) {
         DEBUG_BUILD && debug.log('Sentry module metadata web worker message received', event.data);
-        // Merge worker metadata into the main thread's metadata cache
-        mergeMetadataMap(event.data._sentryModuleMetadata);
+        // Merge worker's raw metadata into the global object
+        // It will be parsed lazily when needed by getMetadataForUrl
+        WINDOW._sentryModuleMetadata = {
+          ...WINDOW._sentryModuleMetadata,
+          ...event.data._sentryModuleMetadata,
+        };
       }
 
       // Handle unhandled rejections forwarded from worker
@@ -237,13 +231,12 @@ interface RegisterWebWorkerOptions {
  *   - `self`: The worker instance you're calling this function from (self).
  */
 export function registerWebWorker({ self }: RegisterWebWorkerOptions): void {
-  const moduleMetadata = self._sentryModuleMetadata ? getFilenameToMetadataMap(defaultStackParser) : undefined;
-
-  // Send debug IDs and module metadata to parent thread
+  // Send debug IDs and raw module metadata to parent thread
+  // The metadata will be parsed lazily on the main thread when needed
   self.postMessage({
     _sentryMessage: true,
     _sentryDebugIds: self._sentryDebugIds ?? undefined,
-    _sentryModuleMetadata: moduleMetadata,
+    _sentryModuleMetadata: self._sentryModuleMetadata ?? undefined,
   });
 
   // Set up unhandledrejection handler inside the worker
diff --git a/packages/browser/test/integrations/webWorker.test.ts b/packages/browser/test/integrations/webWorker.test.ts
@@ -14,8 +14,6 @@ vi.mock('@sentry/core', async importActual => {
     debug: {
       log: vi.fn(),
     },
-    mergeMetadataMap: vi.fn(),
-    getFilenameToMetadataMap: vi.fn(),
   };
 });
 
@@ -213,10 +211,10 @@ describe('webWorkerIntegration', () => {
       });
 
       it('processes module metadata from worker', () => {
-        const mockMergeMetadataMap = SentryCore.mergeMetadataMap as any;
+        (helpers.WINDOW as any)._sentryModuleMetadata = undefined;
         const moduleMetadata = {
-          'worker-file1.js': { '_sentryBundlerPluginAppKey:my-app': true },
-          'worker-file2.js': { '_sentryBundlerPluginAppKey:my-app': true },
+          'Error\n    at worker-file1.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
+          'Error\n    at worker-file2.js:2:2': { '_sentryBundlerPluginAppKey:my-app': true },
         };
 
         mockEvent.data = {
@@ -228,13 +226,13 @@ describe('webWorkerIntegration', () => {
 
         expect(mockEvent.stopImmediatePropagation).toHaveBeenCalled();
         expect(mockDebugLog).toHaveBeenCalledWith('Sentry module metadata web worker message received', mockEvent.data);
-        expect(mockMergeMetadataMap).toHaveBeenCalledWith(moduleMetadata);
+        expect((helpers.WINDOW as any)._sentryModuleMetadata).toEqual(moduleMetadata);
       });
 
       it('handles message with both debug IDs and module metadata', () => {
-        const mockMergeMetadataMap = SentryCore.mergeMetadataMap as any;
+        (helpers.WINDOW as any)._sentryModuleMetadata = undefined;
         const moduleMetadata = {
-          'worker-file.js': { '_sentryBundlerPluginAppKey:my-app': true },
+          'Error\n    at worker-file.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
         };
 
         mockEvent.data = {
@@ -246,16 +244,16 @@ describe('webWorkerIntegration', () => {
         messageHandler(mockEvent);
 
         expect(mockEvent.stopImmediatePropagation).toHaveBeenCalled();
-        expect(mockMergeMetadataMap).toHaveBeenCalledWith(moduleMetadata);
+        expect((helpers.WINDOW as any)._sentryModuleMetadata).toEqual(moduleMetadata);
         expect((helpers.WINDOW as any)._sentryDebugIds).toEqual({
           'worker-file.js': 'debug-id-1',
         });
       });
 
       it('accepts message with only module metadata', () => {
-        const mockMergeMetadataMap = SentryCore.mergeMetadataMap as any;
+        (helpers.WINDOW as any)._sentryModuleMetadata = undefined;
         const moduleMetadata = {
-          'worker-file.js': { '_sentryBundlerPluginAppKey:my-app': true },
+          'Error\n    at worker-file.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
         };
 
         mockEvent.data = {
@@ -266,7 +264,7 @@ describe('webWorkerIntegration', () => {
         messageHandler(mockEvent);
 
         expect(mockEvent.stopImmediatePropagation).toHaveBeenCalled();
-        expect(mockMergeMetadataMap).toHaveBeenCalledWith(moduleMetadata);
+        expect((helpers.WINDOW as any)._sentryModuleMetadata).toEqual(moduleMetadata);
       });
 
       it('ignores invalid module metadata', () => {
@@ -343,38 +341,28 @@ describe('registerWebWorker', () => {
     });
   });
 
-  it('calls getFilenameToMetadataMap when module metadata is available', () => {
-    const mockGetFilenameToMetadataMap = SentryCore.getFilenameToMetadataMap as any;
-    const extractedMetadata = {
-      'worker-file1.js': { '_sentryBundlerPluginAppKey:my-app': true },
-      'worker-file2.js': { '_sentryBundlerPluginAppKey:my-app': true },
-    };
-
-    mockWorkerSelf._sentryModuleMetadata = {
+  it('includes raw module metadata when available', () => {
+    const rawMetadata = {
       'Error\n    at worker-file1.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
       'Error\n    at worker-file2.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
     };
 
-    mockGetFilenameToMetadataMap.mockReturnValue(extractedMetadata);
+    mockWorkerSelf._sentryModuleMetadata = rawMetadata;
 
     registerWebWorker({ self: mockWorkerSelf as any });
 
-    expect(mockGetFilenameToMetadataMap).toHaveBeenCalledWith(expect.any(Function));
     expect(mockWorkerSelf.postMessage).toHaveBeenCalledWith({
       _sentryMessage: true,
       _sentryDebugIds: undefined,
-      _sentryModuleMetadata: extractedMetadata,
+      _sentryModuleMetadata: rawMetadata,
     });
   });
 
-  it('does not call getFilenameToMetadataMap when module metadata is not available', () => {
-    const mockGetFilenameToMetadataMap = SentryCore.getFilenameToMetadataMap as any;
-
+  it('sends undefined module metadata when not available', () => {
     mockWorkerSelf._sentryModuleMetadata = undefined;
 
     registerWebWorker({ self: mockWorkerSelf as any });
 
-    expect(mockGetFilenameToMetadataMap).not.toHaveBeenCalled();
     expect(mockWorkerSelf.postMessage).toHaveBeenCalledWith({
       _sentryMessage: true,
       _sentryDebugIds: undefined,
@@ -383,19 +371,14 @@ describe('registerWebWorker', () => {
   });
 
   it('includes both debug IDs and module metadata when both available', () => {
-    const mockGetFilenameToMetadataMap = SentryCore.getFilenameToMetadataMap as any;
-    const extractedMetadata = {
-      'worker-file.js': { '_sentryBundlerPluginAppKey:my-app': true },
+    const rawMetadata = {
+      'Error\n    at worker-file.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
     };
 
     mockWorkerSelf._sentryDebugIds = {
       'worker-file.js': 'debug-id-1',
     };
-    mockWorkerSelf._sentryModuleMetadata = {
-      'Error\n    at worker-file.js:1:1': { '_sentryBundlerPluginAppKey:my-app': true },
-    };
-
-    mockGetFilenameToMetadataMap.mockReturnValue(extractedMetadata);
+    mockWorkerSelf._sentryModuleMetadata = rawMetadata;
 
     registerWebWorker({ self: mockWorkerSelf as any });
 
@@ -404,7 +387,7 @@ describe('registerWebWorker', () => {
       _sentryDebugIds: {
         'worker-file.js': 'debug-id-1',
       },
-      _sentryModuleMetadata: extractedMetadata,
+      _sentryModuleMetadata: rawMetadata,
     });
   });
 });
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -322,7 +322,7 @@ export { vercelWaitUntil } from './utils/vercelWaitUntil';
 export { flushIfServerless } from './utils/flushIfServerless';
 export { SDK_VERSION } from './utils/version';
 export { getDebugImagesForResources, getFilenameToDebugIdMap } from './utils/debug-ids';
-export { getFilenameToMetadataMap, mergeMetadataMap } from './metadata';
+export { getFilenameToMetadataMap } from './metadata';
 export { escapeStringForRegex } from './vendor/escapeStringForRegex';
 
 export type { Attachment } from './types-hoist/attachment';
diff --git a/packages/core/src/metadata.ts b/packages/core/src/metadata.ts
@@ -67,21 +67,6 @@ function ensureMetadataStacksAreParsed(parser: StackParser): void {
   }
 }
 
-/**
- * Merges a filename-to-metadata map into the internal metadata cache.
- * This is used to integrate metadata from web workers into the main thread.
- *
- * @param metadataMap - A map of filename to metadata object
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function mergeMetadataMap(metadataMap: Record<string, any>): void {
-  for (const filename of Object.keys(metadataMap)) {
-    if (!filenameMetadataMap.has(filename)) {
-      filenameMetadataMap.set(filename, metadataMap[filename]);
-    }
-  }
-}
-
 /**
  * Retrieve metadata for a specific JavaScript file URL.
  *
diff --git a/packages/core/test/lib/metadata.test.ts b/packages/core/test/lib/metadata.test.ts
@@ -3,7 +3,6 @@ import {
   addMetadataToStackFrames,
   getFilenameToMetadataMap,
   getMetadataForUrl,
-  mergeMetadataMap,
   stripMetadataFromStackFrames,
 } from '../../src/metadata';
 import type { Event } from '../../src/types-hoist/event';
@@ -175,75 +174,3 @@ describe('getFilenameToMetadataMap', () => {
     expect(result['/path/to/same-file.js']).toBeDefined();
   });
 });
-
-describe('mergeMetadataMap', () => {
-  beforeEach(() => {
-    delete GLOBAL_OBJ._sentryModuleMetadata;
-  });
-
-  it('merges metadata from a map into internal cache', () => {
-    const workerMetadata = {
-      'worker-file1.js': { '_sentryBundlerPluginAppKey:my-app': true },
-      'worker-file2.js': { '_sentryBundlerPluginAppKey:my-app': true },
-    };
-
-    mergeMetadataMap(workerMetadata);
-
-    const metadata1 = getMetadataForUrl(parser, 'worker-file1.js');
-    const metadata2 = getMetadataForUrl(parser, 'worker-file2.js');
-
-    expect(metadata1).toEqual({ '_sentryBundlerPluginAppKey:my-app': true });
-    expect(metadata2).toEqual({ '_sentryBundlerPluginAppKey:my-app': true });
-  });
-
-  it('does not overwrite existing metadata', () => {
-    const stack = `Error
-    at Object.<anonymous> (/existing-file.js:10:15)`;
-
-    GLOBAL_OBJ._sentryModuleMetadata = {
-      [stack]: { '_sentryBundlerPluginAppKey:main-app': true, existing: true },
-    };
-
-    const existingMetadata = getMetadataForUrl(parser, '/existing-file.js');
-    expect(existingMetadata).toEqual({ '_sentryBundlerPluginAppKey:main-app': true, existing: true });
-
-    const workerMetadata = {
-      '/existing-file.js': { '_sentryBundlerPluginAppKey:worker-app': true, worker: true },
-    };
-
-    mergeMetadataMap(workerMetadata);
-
-    const metadataAfterMerge = getMetadataForUrl(parser, '/existing-file.js');
-    expect(metadataAfterMerge).toEqual({ '_sentryBundlerPluginAppKey:main-app': true, existing: true });
-  });
-
-  it('handles empty metadata map', () => {
-    mergeMetadataMap({});
-
-    const metadata = getMetadataForUrl(parser, 'nonexistent-file.js');
-    expect(metadata).toBeUndefined();
-  });
-
-  it('adds new files without affecting existing ones', () => {
-    const stack = `Error
-    at Object.<anonymous> (/main-file.js:10:15)`;
-
-    GLOBAL_OBJ._sentryModuleMetadata = {
-      [stack]: { '_sentryBundlerPluginAppKey:main-app': true },
-    };
-
-    getMetadataForUrl(parser, '/main-file.js');
-
-    const workerMetadata = {
-      '/worker-file.js': { '_sentryBundlerPluginAppKey:worker-app': true },
-    };
-
-    mergeMetadataMap(workerMetadata);
-
-    const mainMetadata = getMetadataForUrl(parser, '/main-file.js');
-    const workerMetadataResult = getMetadataForUrl(parser, '/worker-file.js');
-
-    expect(mainMetadata).toEqual({ '_sentryBundlerPluginAppKey:main-app': true });
-    expect(workerMetadataResult).toEqual({ '_sentryBundlerPluginAppKey:worker-app': true });
-  });
-});
