Skip to content

fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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
Lms24 merged 2 commits into from
Jul 21, 2023
Merged

fix(utils): Truncate aggregate exception values (LinkedErrors) #8593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e90834a
fix(utils): Truncate aggregate exception values (LinkedErrors)
Lms24 Jul 19, 2023
21914c0
cleanup
Lms24 Jul 20, 2023
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
13 changes: 13 additions & 0 deletions ...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);
41 changes: 41 additions & 0 deletions packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
const url = await getLocalTestPath({ testDir: __dirname });

const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

expect(eventData.exception?.values).toHaveLength(2);
expect(eventData.exception?.values?.[0]).toMatchObject({
type: 'Error',
value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
mechanism: {
type: 'chained',
handled: true,
},
stacktrace: {
frames: expect.any(Array),
},
});
expect(eventData.exception?.values?.[1]).toMatchObject({
type: 'Error',
value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
mechanism: {
type: 'generic',
handled: true,
},
stacktrace: {
frames: expect.any(Array),
},
});
});
4 changes: 3 additions & 1 deletion packages/browser/src/integrations/linkederrors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
return event;
}

const options = client.getOptions();
applyAggregateErrorsToEvent(
exceptionFromError,
client.getOptions().stackParser,
options.stackParser,
options.maxValueLength,
self._key,
self._limit,
event,
Expand Down
5 changes: 4 additions & 1 deletion packages/node/src/integrations/linkederrors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
return event;
}

const options = client.getOptions();

applyAggregateErrorsToEvent(
exceptionFromError,
client.getOptions().stackParser,
options.stackParser,
options.maxValueLength,
self._key,
self._limit,
event,
Expand Down
37 changes: 28 additions & 9 deletions packages/utils/src/aggregate-errors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
* Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
*/
export function applyAggregateErrorsToEvent(
exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
parser: StackParser,
maxValueLimit: number = 250,
key: string,
limit: number,
event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

// We only create exception grouping if there is an exception in the event.
if (originalException) {
event.exception.values = aggregateExceptionsFromError(
exceptionFromErrorImplementation,
parser,
limit,
hint.originalException as ExtendedError,
key,
event.exception.values,
originalException,
0,
event.exception.values = truncateAggregateExceptions(
aggregateExceptionsFromError(
exceptionFromErrorImplementation,
parser,
limit,
hint.originalException as ExtendedError,
key,
event.exception.values,
originalException,
0,
),
maxValueLimit,
);
}
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
parent_id: parentId,
};
}

/**
* Truncate the message (exception.value) of all exceptions in the event.
* Because this event processor is ran after `applyClientOptions`,
* we need to truncate the message of the added exceptions here.
*/
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
return exceptions.map(exception => {
if (exception.value) {
exception.value = truncate(exception.value, maxValueLength);
}
return exception;
});
}
68 changes: 58 additions & 10 deletions packages/utils/test/aggregate-errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
test('should not do anything if event does not contain an exception', () => {
const event: Event = { exception: undefined };
const eventHint: EventHint = { originalException: new Error() };
applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

// no changes
expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
test('should not do anything if event does not contain exception values', () => {
const event: Event = { exception: { values: undefined } };
const eventHint: EventHint = { originalException: new Error() };
applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

// no changes
expect(event).toStrictEqual({ exception: { values: undefined } });
});

test('should not do anything if event does not contain an event hint', () => {
const event: Event = { exception: { values: [] } };
applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

// no changes
expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
test('should not do anything if the event hint does not contain an original exception', () => {
const event: Event = { exception: { values: [] } };
const eventHint: EventHint = { originalException: undefined };
applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

// no changes
expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
const eventHint: EventHint = { originalException };

applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
expect(event).toStrictEqual({
exception: {
values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
const eventHint: EventHint = { originalException };

applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

// no changes
expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
}

const eventHint: EventHint = { originalException };
applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

// 6 -> one for original exception + 5 linked
expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
const eventHint: EventHint = { originalException: fakeAggregateError };

applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
});

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
const eventHint: EventHint = { originalException: fakeAggregateError1 };

applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
expect(event).toStrictEqual({
exception: {
values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
const eventHint: EventHint = { originalException };

applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
expect(event).toStrictEqual({
exception: {
values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
},
});
});

test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
const originalException: ExtendedError = new Error('Root Error with long message');
originalException.cause = new Error('Nested Error 1 with longer message');
originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
const eventHint: EventHint = { originalException };

const maxValueLength = 15;
applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
expect(event).toStrictEqual({
exception: {
values: [
{
value: 'Nested Error 2 ...',
mechanism: {
exception_id: 2,
handled: true,
parent_id: 1,
source: 'cause',
type: 'chained',
},
},
{
value: 'Nested Error 1 ...',
mechanism: {
exception_id: 1,
handled: true,
parent_id: 0,
is_exception_group: true,
source: 'cause',
type: 'chained',
},
},
{
value: 'Root Error with...',
mechanism: {
exception_id: 0,
handled: true,
is_exception_group: true,
type: 'instrument',
},
},
],
},
});
});
});
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
fix(utils): Truncate aggregate exception values (LinkedErrors) by Lms24 · Pull Request #8593 · getsentry/sentry-javascript · GitHub
Skip to content
fix(utils): Truncate aggregate exception values (LinkedErrors)#8593

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

Lms24
merged 2 commits into

from

Jul 21, 2023
 Merged


fix(utils): Truncate aggregate exception values (LinkedErrors)
#8593
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e90834a

fix(utils): Truncate aggregate exception values (LinkedErrors)


Lms24 Jul 19, 2023
21914c0

cleanup


Lms24 Jul 20, 2023

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


13 changes: 13 additions & 0 deletions
...ges/browser-integration-tests/suites/public-api/captureException/linkedErrrors/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
const wat = new Error(`This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be`);

wat.cause = new Error(`This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,`);

Sentry.captureException(wat);

41 changes: 41 additions & 0 deletions
packages/browser-integration-tests/suites/public-api/captureException/linkedErrrors/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/types';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should capture a linked error with messages', async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.exception?.values).toHaveLength(2);
 expect(eventData.exception?.values?.[0]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long message that should be truncated and hopefully will be,
this is a very long me...`,
 mechanism: {
 type: 'chained',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
 expect(eventData.exception?.values?.[1]).toMatchObject({
 type: 'Error',
 value: `This is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated and will be,
this is a very long message that should be truncated...`,
 mechanism: {
 type: 'generic',
 handled: true,
 },
 stacktrace: {
 frames: expect.any(Array),
 },
 });
});

4 changes: 3 additions & 1 deletion
packages/browser/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,9 +54,11 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();
 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

5 changes: 4 additions & 1 deletion
packages/node/src/integrations/linkederrors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,12 @@ export class LinkedErrors implements Integration {
 return event;
 }

 const options = client.getOptions();

 applyAggregateErrorsToEvent(
 exceptionFromError,
 client.getOptions().stackParser,
 options.stackParser,
 options.maxValueLength,
 self._key,
 self._limit,
 event,
Expand Down

37 changes: 28 additions & 9 deletions
packages/utils/src/aggregate-errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
import type { Event, EventHint, Exception, ExtendedError, StackParser } from '@sentry/types';

import { isInstanceOf } from './is';
import { truncate } from './string';

/**
 * Creates exceptions inside `event.exception.values` for errors that are nested on properties based on the `key` parameter.
 */
export function applyAggregateErrorsToEvent(
 exceptionFromErrorImplementation: (stackParser: StackParser, ex: Error) => Exception,
 parser: StackParser,
 maxValueLimit: number = 250,
 key: string,
 limit: number,
 event: Event,
Expand All@@ -23,15 +25,18 @@ export function applyAggregateErrorsToEvent(

 // We only create exception grouping if there is an exception in the event.
 if (originalException) {
 event.exception.values = aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 event.exception.values = truncateAggregateExceptions(
 aggregateExceptionsFromError(
 exceptionFromErrorImplementation,
 parser,
 limit,
 hint.originalException as ExtendedError,
 key,
 event.exception.values,
 originalException,
 0,
 ),
 maxValueLimit,
 );
 }
}
Expand DownExpand Up@@ -123,3 +128,17 @@ function applyExceptionGroupFieldsForChildException(
 parent_id: parentId,
 };
}

/**
 * Truncate the message (exception.value) of all exceptions in the event.
 * Because this event processor is ran after `applyClientOptions`,
 * we need to truncate the message of the added exceptions here.
 */
function truncateAggregateExceptions(exceptions: Exception[], maxValueLength: number): Exception[] {
 return exceptions.map(exception => {
 if (exception.value) {
 exception.value = truncate(exception.value, maxValueLength);
 }
 return exception;
 });
}

68 changes: 58 additions & 10 deletions
packages/utils/test/aggregate-errors.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain an exception', () => {
 const event: Event = { exception: undefined };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: undefined });
Expand All@@ -20,15 +20,15 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if event does not contain exception values', () => {
 const event: Event = { exception: { values: undefined } };
 const eventHint: EventHint = { originalException: new Error() };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: undefined } });
 });

 test('should not do anything if event does not contain an event hint', () => {
 const event: Event = { exception: { values: [] } };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, undefined);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, undefined);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -37,7 +37,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 test('should not do anything if the event hint does not contain an original exception', () => {
 const event: Event = { exception: { values: [] } };
 const eventHint: EventHint = { originalException: undefined };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [] } });
Expand All@@ -52,7 +52,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -97,7 +97,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);

 // no changes
 expect(event).toStrictEqual({ exception: { values: [exceptionFromError(stackParser, originalException)] } });
Expand All@@ -116,7 +116,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 }

 const eventHint: EventHint = { originalException };
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 5, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 5, event, eventHint);

 // 6 -> one for original exception + 5 linked
 expect(event.exception?.values).toHaveLength(5 + 1);
Expand All@@ -140,7 +140,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event.exception?.values?.[event.exception.values.length - 1].mechanism?.type).toBe('instrument');
 });

Expand All@@ -155,7 +155,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, fakeAggregateError1)] } };
 const eventHint: EventHint = { originalException: fakeAggregateError1 };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, 'cause', 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, 'cause', 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -234,7 +234,7 @@ describe('applyAggregateErrorsToEvent()', () => {
 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 applyAggregateErrorsToEvent(exceptionFromError, stackParser, key, 100, event, eventHint);
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, undefined, key, 100, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
Expand DownExpand Up@@ -272,4 +272,52 @@ describe('applyAggregateErrorsToEvent()', () => {
 },
 });
 });

 test('should truncate the exception values if they exceed the `maxValueLength` option', () => {
 const originalException: ExtendedError = new Error('Root Error with long message');
 originalException.cause = new Error('Nested Error 1 with longer message');
 originalException.cause.cause = new Error('Nested Error 2 with longer message with longer message');

 const event: Event = { exception: { values: [exceptionFromError(stackParser, originalException)] } };
 const eventHint: EventHint = { originalException };

 const maxValueLength = 15;
 applyAggregateErrorsToEvent(exceptionFromError, stackParser, maxValueLength, 'cause', 10, event, eventHint);
 expect(event).toStrictEqual({
 exception: {
 values: [
 {
 value: 'Nested Error 2 ...',
 mechanism: {
 exception_id: 2,
 handled: true,
 parent_id: 1,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Nested Error 1 ...',
 mechanism: {
 exception_id: 1,
 handled: true,
 parent_id: 0,
 is_exception_group: true,
 source: 'cause',
 type: 'chained',
 },
 },
 {
 value: 'Root Error with...',
 mechanism: {
 exception_id: 0,
 handled: true,
 is_exception_group: true,
 type: 'instrument',
 },
 },
 ],
 },
 });
 });
});