Allow overriding unhandled state in callbacks

Author: imjoehaines

packages/core/client.js

@@ -273,14 +273,18 @@ class Client {
     event._user = assign({}, event._user, this._user)
     event.breadcrumbs = this._breadcrumbs.slice()
 
-    if (this._session) {
-      this._session._track(event)
-      event._session = this._session
+    const trackSession = event => {
+      if (this._session) {
+        this._session._track(event)
+        event._session = this._session
+      }
     }
 
     // exit early if events should not be sent on the current releaseStage
     if (this._config.enabledReleaseStages !== null && !includes(this._config.enabledReleaseStages, this._config.releaseStage)) {
       this._logger.warn('Event not sent due to releaseStage/enabledReleaseStages configuration')
+      trackSession(event)
+
       return cb(null, event)
     }
 
@@ -298,6 +302,8 @@ class Client {
 
       if (!shouldSend) {
         this._logger.debug('Event not sent due to onError callback')
+        trackSession(event)
+
         return cb(null, event)
       }
 
@@ -314,6 +320,13 @@ class Client {
         event._handledState.severityReason = { type: 'userCallbackSetSeverity' }
       }
 
+      if (event.unhandled !== event._handledState.unhandled) {
+        event._handledState.severityReason.unhandledOverridden = true
+        event._handledState.unhandled = event.unhandled
+      }
+
+      trackSession(event)
+
       this._delivery.sendEvent({
         apiKey: event.apiKey || this._config.apiKey,
         notifier: this._notifier,

packages/core/session.d.ts

@@ -0,0 +1,24 @@
+import Session from './types/session'
+
+interface MinimalEvent {
+  _handledState: {
+    unhandled: boolean
+  }
+}
+
+interface SessionJson {
+  id: string
+  startedAt: Date
+  events: {
+    handled: number
+    unhandled: number
+  }
+}
+
+export default class SessionWithInternals extends Session {
+  _track(event: MinimalEvent): void
+  toJSON(): SessionJson
+
+  public _handled: number
+  public _unhandled: number
+}

packages/core/test/client.test.ts

@@ -1,6 +1,6 @@
 import Client from '../client'
 import Event from '../event'
-import { Session } from '..'
+import Session from '../session'
 
 describe('@bugsnag/core/client', () => {
   describe('constructor', () => {
@@ -158,6 +158,41 @@ describe('@bugsnag/core/client', () => {
         event.severity = 'info'
       })
     })
+
+    it('supports setting unhandled via callback', done => {
+      const client = new Client({ apiKey: 'API_KEY_YEAH' })
+
+      const session = new Session()
+      // @ts-ignore
+      client._session = session
+
+      client._setDelivery(client => ({
+        sendEvent: (payload) => {
+          expect(payload).toBeTruthy()
+          expect(Array.isArray(payload.events)).toBe(true)
+
+          const event = payload.events[0].toJSON()
+
+          expect(event.unhandled).toBe(true)
+          expect(event.severityReason).toEqual({
+            type: 'handledException',
+            unhandledOverridden: true
+          })
+
+          expect(event.session).toEqual(session)
+          expect((event.session as Session)._handled).toBe(0)
+          expect((event.session as Session)._unhandled).toBe(1)
+
+          done()
+        },
+        sendSession: () => {}
+      }))
+
+      client.notify(new Error('oh em gee'), event => {
+        event.unhandled = true
+      })
+    })
+
     // eslint-disable-next-line jest/expect-expect
     it('supports preventing send by returning false in onError callback', done => {
       const client = new Client({
@@ -177,6 +212,7 @@ describe('@bugsnag/core/client', () => {
       // give the event loop a tick to see if the event gets sent
       process.nextTick(() => done())
     })
+
     // eslint-disable-next-line jest/expect-expect
     it('supports preventing send by returning false in notify callback', done => {
       const client = new Client({ apiKey: 'API_KEY_YEAH' })
@@ -355,11 +391,18 @@ describe('@bugsnag/core/client', () => {
         sendSession: () => {},
         sendEvent: (payload, cb) => cb(null)
       }))
+
+      const session = new Session()
       // @ts-ignore
-      client.notify(new Error('111'), {}, (err, event) => {
+      client._session = session
+
+      client.notify(new Error('111'), () => {}, (err, event) => {
         expect(err).toBe(null)
         expect(event).toBeTruthy()
         expect(event.errors[0].errorMessage).toBe('111')
+
+        expect((event as Event)._session).toBe(session)
+        expect(session.toJSON().events.handled).toBe(1)
         done()
       })
     })
@@ -370,12 +413,19 @@ describe('@bugsnag/core/client', () => {
         sendSession: () => {},
         sendEvent: (payload, cb) => cb(new Error('flerp'))
       }))
+
+      const session = new Session()
       // @ts-ignore
-      client.notify(new Error('111'), {}, (err, event) => {
+      client._session = session
+
+      client.notify(new Error('111'), () => {}, (err, event) => {
         expect(err).toBeTruthy()
         expect(err.message).toBe('flerp')
         expect(event).toBeTruthy()
         expect(event.errors[0].errorMessage).toBe('111')
+
+        expect((event as Event)._session).toBe(session)
+        expect(session.toJSON().events.handled).toBe(1)
         done()
       })
     })
@@ -388,11 +438,17 @@ describe('@bugsnag/core/client', () => {
         sendEvent: () => { done('sendEvent() should not be called') }
       }))
 
+      const session = new Session()
       // @ts-ignore
-      client.notify(new Error('111'), {}, (err, event) => {
+      client._session = session
+
+      client.notify(new Error('111'), () => {}, (err, event) => {
         expect(err).toBe(null)
         expect(event).toBeTruthy()
         expect(event.errors[0].errorMessage).toBe('111')
+
+        expect((event as Event)._session).toBe(session)
+        expect(session.toJSON().events.handled).toBe(1)
         done()
       })
     })
@@ -405,11 +461,17 @@ describe('@bugsnag/core/client', () => {
         sendEvent: () => { done('sendEvent() should not be called') }
       }))
 
+      const session = new Session()
       // @ts-ignore
-      client.notify(new Error('111'), {}, (err, event) => {
+      client._session = session
+
+      client.notify(new Error('111'), () => {}, (err, event) => {
         expect(err).toBe(null)
         expect(event).toBeTruthy()
         expect(event.errors[0].errorMessage).toBe('111')
+
+        expect((event as Event)._session).toBe(session)
+        expect(session.toJSON().events.handled).toBe(1)
         done()
       })
     })