Skip to content
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.

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

fix(v8/node): Correctly resolve debug IDs for ANR events with custom appRoot #14823

Merged
merged 1 commit into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 36 additions & 0 deletions dev-packages/node-integration-tests/suites/anr/app-path.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import * as assert from 'assert';
import * as crypto from 'crypto';
import * as path from 'path';
import * as url from 'url';

import * as Sentry from '@sentry/node';

global._sentryDebugIds = { [new Error().stack]: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa' };

const __dirname = path.dirname(url.fileURLToPath(import.meta.url));

setTimeout(() => {
process.exit();
}, 10000);

Sentry.init({
dsn: process.env.SENTRY_DSN,
release: '1.0',
autoSessionTracking: false,
integrations: [Sentry.anrIntegration({ captureStackTrace: true, anrThreshold: 100, appRootPath: __dirname })],
});

Sentry.setUser({ email: '[email protected]' });
Sentry.addBreadcrumb({ message: 'important message!' });

function longWork() {
for (let i = 0; i < 20; i++) {
const salt = crypto.randomBytes(128).toString('base64');
const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512');
assert.ok(hash);
}
}

setTimeout(() => {
longWork();
}, 1000);
28 changes: 24 additions & 4 deletions dev-packages/node-integration-tests/suites/anr/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ const ANR_EVENT = {
mechanism: { type: 'ANR' },
stacktrace: {
frames: expect.arrayContaining([
{
expect.objectContaining({
colno: expect.any(Number),
lineno: expect.any(Number),
filename: expect.any(String),
function: '?',
in_app: true,
},
{
}),
expect.objectContaining({
colno: expect.any(Number),
lineno: expect.any(Number),
filename: expect.any(String),
function: 'longWork',
in_app: true,
},
}),
]),
},
},
Expand Down Expand Up @@ -123,6 +123,26 @@ conditionalTest({ min: 16 })('should report ANR when event loop blocked', () =>
.start(done);
});

test('Custom appRootPath', done => {
const ANR_EVENT_WITH_SPECIFIC_DEBUG_META: Event = {
...ANR_EVENT_WITH_SCOPE,
debug_meta: {
images: [
{
type: 'sourcemap',
debug_id: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa',
code_file: 'app:///app-path.mjs',
},
],
},
};

createRunner(__dirname, 'app-path.mjs')
.withMockSentryServer()
.expect({ event: ANR_EVENT_WITH_SPECIFIC_DEBUG_META })
.start(done);
});

test('multiple events via maxAnrEvents', done => {
createRunner(__dirname, 'basic-multiple.mjs')
.withMockSentryServer()
Expand Down
15 changes: 10 additions & 5 deletions packages/node/src/integrations/anr/worker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,22 +91,27 @@ function applyDebugMeta(event: Event): void {
return;
}

const normalisedDebugImages = options.appRootPath ? {} : mainDebugImages;
if (options.appRootPath) {
for (const [path, debugId] of Object.entries(mainDebugImages)) {
normalisedDebugImages[normalizeUrlToBase(path, options.appRootPath)] = debugId;
}
}

const filenameToDebugId = new Map<string, string>();

for (const exception of event.exception?.values || []) {
for (const frame of exception.stacktrace?.frames || []) {
const filename = frame.abs_path || frame.filename;
if (filename && mainDebugImages[filename]) {
filenameToDebugId.set(filename, mainDebugImages[filename] as string);
if (filename && normalisedDebugImages[filename]) {
filenameToDebugId.set(filename, normalisedDebugImages[filename] as string);
}
}
}

if (filenameToDebugId.size > 0) {
const images: DebugImage[] = [];
for (const [filename, debug_id] of filenameToDebugId.entries()) {
const code_file = options.appRootPath ? normalizeUrlToBase(filename, options.appRootPath) : filename;

for (const [code_file, debug_id] of filenameToDebugId.entries()) {
images.push({
type: 'sourcemap',
code_file,
Expand Down
Loading