Skip to content

A general function to generate bundle IDs in Metro serializer; tests for it #5380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2025
Merged

A general function to generate bundle IDs in Metro serializer; tests for it #5380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions packages/core/src/js/tools/sentryMetroSerializer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,7 @@ export const createSentryMetroSerializer = (customSerializer?: MetroSerializer):
// That needs to be done because when Metro 0.83.2 stopped importing `BabelSourceMapSegment`
// from `@babel/generator` and defined it locally, it subtly changed the source map output format.
// https://github.com/facebook/metro/blob/main/packages/metro-source-map/src/source-map.js#L47
const hash = crypto.createHash('md5');
hash.update(bundleCode);
debugId = stringToUUID(hash.digest('hex'));
debugId = calculateDebugId(bundleCode);
// eslint-disable-next-line no-console
console.log('info ' + `Bundle Debug ID (calculated): ${debugId}`);
}
Expand Down Expand Up @@ -125,7 +123,7 @@ export const createSentryMetroSerializer = (customSerializer?: MetroSerializer):
*/
function createSentryBundleCallback(debugIdModule: Module<VirtualJSOutput> & { setSource: (code: string) => void }) {
return (bundle: Bundle) => {
const debugId = calculateDebugId(bundle);
const debugId = calculateDebugId(bundle.pre, bundle.modules);
debugIdModule.setSource(injectDebugId(debugIdModule.getSource().toString(), debugId));
bundle.pre = injectDebugId(bundle.pre, debugId);
return bundle;
Expand Down Expand Up @@ -153,16 +151,15 @@ function createDebugIdModule(debugId: string): Module<VirtualJSOutput> & { setSo
return createVirtualJSModule(DEBUG_ID_MODULE_PATH, createDebugIdSnippet(debugId));
}

function calculateDebugId(bundle: Bundle): string {
function calculateDebugId(bundleCode: string, modules?: Array<[id: number, code: string]>): string {
const hash = crypto.createHash('md5');
hash.update(bundle.pre);
for (const [, code] of bundle.modules) {
hash.update(code);
hash.update(bundleCode);
if (modules) {
for (const [, code] of modules) {
hash.update(code);
}
}
hash.update(bundle.post);

const debugId = stringToUUID(hash.digest('hex'));
return debugId;
return stringToUUID(hash.digest('hex'));
}

function injectDebugId(code: string, debugId: string): string {
Expand Down
124 changes: 124 additions & 0 deletions packages/core/test/tools/sentryMetroSerializer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,130 @@ describe('Sentry Metro Serializer', () => {
expect(debugIdMatch2?.[1]).toBe(debugId);
}
});

describe('calculateDebugId', () => {
// We need to access the private function for testing
const crypto = require('crypto');
const { stringToUUID } = require('../../src/js/tools/utils');

function calculateDebugId(bundleCode: string, modules?: Array<[id: number, code: string]>): string {
const hash = crypto.createHash('md5');
hash.update(bundleCode);
if (modules) {
for (const [, code] of modules) {
hash.update(code);
}
}
return stringToUUID(hash.digest('hex'));
}

test('generates a valid UUID v4 format', () => {
const bundleCode = 'console.log("test");';
const debugId = calculateDebugId(bundleCode);

expect(debugId).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
});

test('generates deterministic debug ID for the same bundle code', () => {
const bundleCode = 'console.log("test");';
const debugId1 = calculateDebugId(bundleCode);
const debugId2 = calculateDebugId(bundleCode);

expect(debugId1).toBe(debugId2);
});

test('generates different debug IDs for different bundle code', () => {
const bundleCode1 = 'console.log("test1");';
const bundleCode2 = 'console.log("test2");';
const debugId1 = calculateDebugId(bundleCode1);
const debugId2 = calculateDebugId(bundleCode2);

expect(debugId1).not.toBe(debugId2);
});

test('handles undefined modules parameter', () => {
const bundleCode = 'console.log("test");';
const debugId = calculateDebugId(bundleCode, undefined);

expect(debugId).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
});

test('handles empty modules array', () => {
const bundleCode = 'console.log("test");';
const debugId1 = calculateDebugId(bundleCode, []);
const debugId2 = calculateDebugId(bundleCode);

// Should generate the same debug ID as without modules
expect(debugId1).toBe(debugId2);
});

test('includes modules in debug ID calculation', () => {
const bundleCode = 'console.log("test");';
const modules: Array<[id: number, code: string]> = [
[1, 'function foo() { return "bar"; }'],
[2, 'function baz() { return "qux"; }'],
];

const debugIdWithModules = calculateDebugId(bundleCode, modules);
const debugIdWithoutModules = calculateDebugId(bundleCode);

expect(debugIdWithModules).not.toBe(debugIdWithoutModules);
});

test('generates different debug IDs when modules differ', () => {
const bundleCode = 'console.log("test");';
const modules1: Array<[id: number, code: string]> = [[1, 'function foo() { return "bar"; }']];
const modules2: Array<[id: number, code: string]> = [[1, 'function foo() { return "baz"; }']];

const debugId1 = calculateDebugId(bundleCode, modules1);
const debugId2 = calculateDebugId(bundleCode, modules2);

expect(debugId1).not.toBe(debugId2);
});

test('generates same debug ID when modules have same content but different IDs', () => {
const bundleCode = 'console.log("test");';
const modules1: Array<[id: number, code: string]> = [[1, 'function foo() { return "bar"; }']];
const modules2: Array<[id: number, code: string]> = [[2, 'function foo() { return "bar"; }']];

const debugId1 = calculateDebugId(bundleCode, modules1);
const debugId2 = calculateDebugId(bundleCode, modules2);

// Module IDs are not used in the hash calculation, only the code
expect(debugId1).toBe(debugId2);
});

test('generates different debug IDs when module order differs', () => {
const bundleCode = 'console.log("test");';
const modules1: Array<[id: number, code: string]> = [
[1, 'function foo() { return "bar"; }'],
[2, 'function baz() { return "qux"; }'],
];
const modules2: Array<[id: number, code: string]> = [
[2, 'function baz() { return "qux"; }'],
[1, 'function foo() { return "bar"; }'],
];

const debugId1 = calculateDebugId(bundleCode, modules1);
const debugId2 = calculateDebugId(bundleCode, modules2);

// Order matters in hash calculation
expect(debugId1).not.toBe(debugId2);
});

test('handles empty bundle code', () => {
const debugId = calculateDebugId('');

expect(debugId).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
});

test('handles large bundle code', () => {
const largeBundleCode = 'console.log("test");'.repeat(10000);
const debugId = calculateDebugId(largeBundleCode);

expect(debugId).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
});
});
});

function mockMinSerializerArgs(options?: {
Expand Down
Loading