Skip to content

fix(integrations): Add default for ExtraErrorData's depth option #4487

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 2, 2022
Merged

fix(integrations): Add default for ExtraErrorData's depth option #4487

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/integrations/src/extraerrordata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,18 @@ export class ExtraErrorData implements Integration {
*/
public name: string = ExtraErrorData.id;

/** JSDoc */
Copy link
Contributor Author

@rchl rchl Feb 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what purpose does this have but I saw it the debug.ts's code

Copy link
Member

@AbhiPrasad AbhiPrasad Feb 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’s to get around writing doc strings. We can leave it like this.

private readonly _options: ExtraErrorDataOptions;

/**
* @inheritDoc
*/
public constructor(private readonly _options: ExtraErrorDataOptions = { depth: 3 }) {}
public constructor(options?: ExtraErrorDataOptions) {
this._options = {
depth: 3,
...options,
};
}

/**
* @inheritDoc
Expand Down
25 changes: 25 additions & 0 deletions packages/integrations/test/extraerrordata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,31 @@ describe('ExtraErrorData()', () => {
});
});

it('should stringify up to 3 nested levels by default', () => {
const error = new TypeError('foo') as ExtendedError;
error['1'] = {
2: {
3: {
4: 'foo',
},
},
};

const enhancedEvent = extraErrorData.enhanceEventWithErrorData(event, {
originalException: error,
});

expect(enhancedEvent.contexts).toEqual({
TypeError: {
1: {
2: {
3: '[Object]',
},
},
},
});
});

it('should not remove previous data existing in extra field', () => {
event = {
// @ts-ignore Allow contexts on event
Expand Down