Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fix errorInfo metadata in Vue 3.4+ #2062

Merged
merged 1 commit into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@

## TBD

### Changed

- (react-native) Update bugsnag-cocoa from v6.27.3 to [v6.28.0](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CHANGELOG.md#6280-2023-12-13)

### Fixed

- (plugin-vue) Fix errorInfo metadata in Vue 3.4+ [#2062](https://github.com/bugsnag/bugsnag-js/pull/2062)

## v7.22.2 (2023-11-21)

### Changed
Expand Down
7 changes: 6 additions & 1 deletion packages/plugin-vue/src/vue.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@ module.exports = (app, client) => {
const handledState = { severity: 'error', unhandled: true, severityReason: { type: 'unhandledException' } }
const event = client.Event.create(err, true, handledState, 'vue error handler', 1)

// In Vue 3.4+, the info param is a link to the Vue error docs in prod, so we need to extract the error code from it
// https://github.com/vuejs/core/pull/9165/commits/c261beab2c0a26e401f2c3d5eae2e4c41de6fe4d
const code = typeof info === 'string' && info.indexOf('-') > 0 ? info.split('-')[1] : info
const errorInfo = ErrorTypeStrings[code] || info

event.addMetadata('vue', {
errorInfo: ErrorTypeStrings[info] || info,
errorInfo,
component: vm ? formatComponentName(vm, true) : undefined,
props: (vm && vm.$options) ? vm.$options.propsData : undefined
})
Expand Down
28 changes: 27 additions & 1 deletion packages/plugin-vue/test/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,32 @@ describe('bugsnag vue', () => {
errorHandler(new Error('oops'), { $parent: null, $options: {} }, 1)
})

it('handles URL info paramater', done => {
const mockVueApp: Vue3App = {
use: (plugin) => {
plugin.install(mockVueApp)
},
config: { errorHandler: undefined }
}
const client = new Client({ apiKey: 'API_KEYYY', plugins: [new BugsnagVuePlugin()] })
// eslint-disable-next-line
mockVueApp.use(client.getPlugin('vue')!)
client._setDelivery(client => ({
sendEvent: (payload) => {
expect(payload.events[0].errors[0].errorClass).toBe('Error')
expect(payload.events[0].errors[0].errorMessage).toBe('oops')
expect(payload.events[0]._metadata.vue).toBeDefined()
expect(payload.events[0]._metadata.vue.component).toBe('MyComponent')
expect(payload.events[0]._metadata.vue.errorInfo).toBe('render function')
done()
},
sendSession: () => {}
}))
expect(typeof mockVueApp.config.errorHandler).toBe('function')
const errorHandler = mockVueApp.config.errorHandler as unknown as Vue3ErrorHandler
errorHandler(new Error('oops'), { $options: { name: 'MyComponent' } }, 'https://vuejs.org/errors/#runtime-1')
})

it('tolerates unmappable info paramater', done => {
const mockVueApp: Vue3App = {
use: (plugin) => {
Expand All @@ -106,7 +132,7 @@ describe('bugsnag vue', () => {
errorHandler(new Error('oops'), { $options: { name: 'MyComponent' } }, 'abcz')
})

it('tolerates tolerates anonymous components', done => {
it('tolerates anonymous components', done => {
const mockVueApp: Vue3App = {
use: (plugin) => {
plugin.install(mockVueApp)
Expand Down
Loading