Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit ffb6afa

Browse files
fix: Ensure breadcrumbs behave correctly
Now that leaveBreadcrumb() doesn't have the check of enabledBreadcrumbTypes, the notifier needs to check if "error" breadcrumbs are desired before adding them. Additionally this commit forces Node not to leave any breadcrumbs at all, until they are switched on.
1 parent 7a62ec4 commit ffb6afa

File tree

3 files changed

+25
-6
lines changed

3 files changed

+25
-6
lines changed

‎packages/core/client.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -301,12 +301,14 @@ class Client {
301301
return cb(null, event)
302302
}
303303

304-
// only leave a crumb for the error if actually got sent
305-
Client.prototype.leaveBreadcrumb.call(this, event.errors[0].errorClass, {
306-
errorClass: event.errors[0].errorClass,
307-
errorMessage: event.errors[0].errorMessage,
308-
severity: event.severity
309-
}, 'error')
304+
if (includes(this._config.enabledBreadcrumbTypes, 'error')) {
305+
// only leave a crumb for the error if actually got sent
306+
Client.prototype.leaveBreadcrumb.call(this, event.errors[0].errorClass, {
307+
errorClass: event.errors[0].errorClass,
308+
errorMessage: event.errors[0].errorMessage,
309+
severity: event.severity
310+
}, 'error')
311+
}
310312

311313
if (originalSeverity !== event.severity) {
312314
event._handledState.severityReason = { type: 'userCallbackSetSeverity' }

‎packages/core/test/client.test.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,21 @@ describe('@bugsnag/core/client', () => {
487487
expect(client._breadcrumbs.length).toBe(1)
488488
expect(client._breadcrumbs[0].type).toBe('manual')
489489
})
490+
491+
it('only leaves an error breadcrumb if enabledBreadcrumbTypes contains "error"', (done) => {
492+
const client = new Client({
493+
apiKey: 'API_KEY_YEAH',
494+
enabledBreadcrumbTypes: []
495+
})
496+
client._setDelivery(client => ({
497+
sendSession: () => {},
498+
sendEvent: (payload, cb) => cb(null)
499+
}))
500+
client.notify(new Error('oh no'), () => {}, () => {
501+
expect(client._breadcrumbs.length).toBe(0)
502+
done()
503+
})
504+
})
490505
})
491506

492507
describe('startSession()', () => {

‎packages/node/src/notifier.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ const Bugsnag = {
5454
bugsnag._logger.warn('Breadcrumbs are not supported in Node.js yet')
5555
}
5656

57+
bugsnag._config.enabledBreadcrumbTypes = []
58+
5759
return bugsnag
5860
},
5961
start: (opts) => {

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /