Skip to content

ref(node): Fix async stack parsing #4721

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 3 commits into from
Mar 18, 2022
Merged

ref(node): Fix async stack parsing #4721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
79464f7
Fix stack parsing
timfish Mar 15, 2022
bb9de54
Minor improvement
timfish Mar 15, 2022
b2c0971
Replace record/object type with new Error
timfish Mar 15, 2022
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
12 changes: 9 additions & 3 deletions packages/node/src/stack-parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ function getModule(filename: string | undefined): string | undefined {
}

const FILENAME_MATCH = /^\s*[-]{4,}$/;
const FULL_MATCH = /at (?:(.+?)\s+\()?(?:(.+?):(\d+)(?::(\d+))?|([^)]+))\)?/;
const FULL_MATCH = /at (?:async )?(?:(.+?)\s+\()?(?:(.+?):(\d+)(?::(\d+))?|([^)]+))\)?/;

// eslint-disable-next-line complexity
const node: StackLineParserFn = (line: string) => {
if (line.match(FILENAME_MATCH)) {
return {
Expand Down Expand Up @@ -87,7 +88,12 @@ const node: StackLineParserFn = (line: string) => {
functionName = undefined;
}

const filename = lineMatch[2];
if (functionName === undefined) {
methodName = methodName || '<anonymous>';
functionName = typeName ? `${typeName}.${methodName}` : methodName;
}

const filename = lineMatch[2]?.startsWith('file://') ? lineMatch[2].substr(7) : lineMatch[2];
const isNative = lineMatch[5] === 'native';
const isInternal =
isNative || (filename && !filename.startsWith('/') && !filename.startsWith('.') && filename.indexOf(':\\') !== 1);
Expand All @@ -100,7 +106,7 @@ const node: StackLineParserFn = (line: string) => {
return {
filename,
module: getModule(filename),
function: functionName || `${typeName}.${methodName || '<anonymous>'}`,
function: functionName,
lineno: parseInt(lineMatch[3], 10) || undefined,
colno: parseInt(lineMatch[4], 10) || undefined,
in_app,
Expand Down
120 changes: 102 additions & 18 deletions packages/node/test/stacktrace.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ describe('Stack parsing', () => {
});

test('parses object in fn name', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'Error: Foo\n' +
' at [object Object].global.every [as _onTimeout] (/Users/hoitz/develop/test.coffee:36:3)\n' +
' at Timer.listOnTimeout [as ontimeout] (timers.js:110:15)\n';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
Expand Down Expand Up @@ -89,15 +89,15 @@ describe('Stack parsing', () => {
});

test('parses corrupt stack', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'AssertionError: true == false\n' +
' fuck' +
' at Test.run (/Users/felix/code/node-fast-or-slow/lib/test.js:45:10)\n' +
'oh no' +
' at TestCase.run (/Users/felix/code/node-fast-or-slow/lib/test_case.js:61:8)\n';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
Expand All @@ -120,13 +120,13 @@ describe('Stack parsing', () => {
});

test('parses with missing column numbers', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'AssertionError: true == false\n' +
' at Test.fn (/Users/felix/code/node-fast-or-slow/test/fast/example/test-example.js:6)\n' +
' at Test.run (/Users/felix/code/node-fast-or-slow/lib/test.js:45)';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
Expand All @@ -147,7 +147,7 @@ describe('Stack parsing', () => {
});

test('parses with native methods', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'AssertionError: true == false\n' +
' at Test.fn (/Users/felix/code/node-fast-or-slow/test/fast/example/test-example.js:6:10)\n' +
Expand All @@ -157,7 +157,7 @@ describe('Stack parsing', () => {
' at Array.0 (native)\n' +
' at EventEmitter._tickCallback (node.js:126:26)';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
Expand Down Expand Up @@ -209,16 +209,16 @@ describe('Stack parsing', () => {
});

test('parses with file only', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack = 'AssertionError: true == false\n' + ' at /Users/felix/code/node-fast-or-slow/lib/test_case.js:80:10';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
filename: '/Users/felix/code/node-fast-or-slow/lib/test_case.js',
module: 'test_case',
function: 'undefined.<anonymous>',
function: '<anonymous>',
lineno: 80,
colno: 10,
in_app: true,
Expand All @@ -227,18 +227,18 @@ describe('Stack parsing', () => {
});

test('parses with multi line message', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'AssertionError: true == false\nAnd some more shit\n' +
' at /Users/felix/code/node-fast-or-slow/lib/test_case.js:80:10';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
filename: '/Users/felix/code/node-fast-or-slow/lib/test_case.js',
module: 'test_case',
function: 'undefined.<anonymous>',
function: '<anonymous>',
lineno: 80,
colno: 10,
in_app: true,
Expand All @@ -247,12 +247,12 @@ describe('Stack parsing', () => {
});

test('parses with anonymous fn call', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'AssertionError: expected [] to be arguments\n' +
' at Assertion.prop.(anonymous function) (/Users/den/Projects/should.js/lib/should.js:60:14)\n';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
Expand All @@ -267,13 +267,13 @@ describe('Stack parsing', () => {
});

test('parses with braces in paths', () => {
const err: { [key: string]: any } = {};
const err = new Error();
err.stack =
'AssertionError: true == false\n' +
' at Test.run (/Users/felix (something)/code/node-fast-or-slow/lib/test.js:45:10)\n' +
' at TestCase.run (/Users/felix (something)/code/node-fast-or-slow/lib/test_case.js:61:8)\n';

const frames = parseStackFrames(err as Error);
const frames = parseStackFrames(err);

expect(frames).toEqual([
{
Expand All @@ -294,4 +294,88 @@ describe('Stack parsing', () => {
},
]);
});

test('parses with async frames', () => {
// https://github.com/getsentry/sentry-javascript/issues/4692#issuecomment-1063835795
const err = new Error();
err.stack =
'Error: Client request error\n' +
' at Object.httpRequestError (file:///code/node_modules/@waroncancer/gaia/lib/error/error-factory.js:17:73)\n' +
' at Object.run (file:///code/node_modules/@waroncancer/gaia/lib/http-client/http-client.js:81:36)\n' +
' at processTicksAndRejections (node:internal/process/task_queues:96:5)\n' +
' at async Object.send (file:///code/lib/post-created/send-post-created-notification-module.js:17:27)\n' +
' at async each (file:///code/lib/process-post-events-module.js:14:21)\n' +
' at async Runner.processEachMessage (/code/node_modules/kafkajs/src/consumer/runner.js:151:9)\n' +
' at async onBatch (/code/node_modules/kafkajs/src/consumer/runner.js:326:9)\n' +
' at async /code/node_modules/kafkajs/src/consumer/runner.js:376:15\n';

const frames = parseStackFrames(err);

expect(frames).toEqual([
{
filename: '/code/node_modules/kafkajs/src/consumer/runner.js',
module: 'kafkajs.src.consumer:runner',
function: '<anonymous>',
lineno: 376,
colno: 15,
in_app: false,
},
{
filename: '/code/node_modules/kafkajs/src/consumer/runner.js',
module: 'kafkajs.src.consumer:runner',
function: 'onBatch',
lineno: 326,
colno: 9,
in_app: false,
},
{
filename: '/code/node_modules/kafkajs/src/consumer/runner.js',
module: 'kafkajs.src.consumer:runner',
function: 'Runner.processEachMessage',
lineno: 151,
colno: 9,
in_app: false,
},
{
filename: '/code/lib/process-post-events-module.js',
module: 'process-post-events-module',
function: 'each',
lineno: 14,
colno: 21,
in_app: true,
},
{
filename: '/code/lib/post-created/send-post-created-notification-module.js',
module: 'send-post-created-notification-module',
function: 'Object.send',
lineno: 17,
colno: 27,
in_app: true,
},
{
filename: 'node:internal/process/task_queues',
module: 'task_queues',
function: 'processTicksAndRejections',
lineno: 96,
colno: 5,
in_app: false,
},
{
filename: '/code/node_modules/@waroncancer/gaia/lib/http-client/http-client.js',
module: '@waroncancer.gaia.lib.http-client:http-client',
function: 'Object.run',
lineno: 81,
colno: 36,
in_app: false,
},
{
filename: '/code/node_modules/@waroncancer/gaia/lib/error/error-factory.js',
module: '@waroncancer.gaia.lib.error:error-factory',
function: 'Object.httpRequestError',
lineno: 17,
colno: 73,
in_app: false,
},
]);
});
});