Merge pull request #2647 from bugsnag/integration/http-errors

[Integration] HTTP Errors

Author: gingerbenw

.eslintignore

@@ -10,4 +10,5 @@ packages/**/fixtures
 test/browser
 test/node
 test/react-native-cli/features/fixtures
+test/react-native/features/fixtures
 test/cloudflare-workers

CHANGELOG.md

@@ -2,8 +2,11 @@
 
 ## [Unreleased]
 
+This release adds support for notitfying failed network requests using the new `plugin-network-instrumentation` package
+
 ### Added
 
+(plugin-network-instrumentation) Add new plugin to notify failed network requests [#2647](https://github.com/bugsnag/bugsnag-js/pull/2647)
 (plugin-cloudflare-workers): Add initial support for Cloudflare Workers [#2643](https://github.com/bugsnag/bugsnag-js/pull/2643) [#2644](https://github.com/bugsnag/bugsnag-js/pull/2644)
 (plugin-contextualize) Return callback value from contextualize plugin [#2654](https://github.com/bugsnag/bugsnag-js/pull/2654)
 

bin/local-test-util

@@ -121,7 +121,7 @@ async function buildNotifiers (notifier) {
 async function packNotifiers (notifier) {
   const notifiers = notifier
     ? [ notifier ]
-    : [ 'js', 'browser', 'node', 'web-worker', 'plugin-angular', 'plugin-react', 'plugin-vue' ]
+    : [ 'js', 'browser', 'node', 'web-worker', 'plugin-angular', 'plugin-react', 'plugin-vue', 'plugin-network-instrumentation' ]
   for (const n of notifiers) {
     let packageLocation = `packages/${n}/`
     if (n === 'plugin-angular') packageLocation += 'dist/'
@@ -131,7 +131,7 @@ async function packNotifiers (notifier) {
 
 async function installNotifiers (notifier) {
   trace('install notifiers')
-  if (notifier && ![ 'browser', 'plugin-vue', 'plugin-react', 'web-worker' ].includes(notifier)) return
+  if (notifier && ![ 'browser', 'plugin-vue', 'plugin-react', 'web-worker', 'plugin-network-instrumentation' ].includes(notifier)) return
   await ex(`npm`, [
     `install`,
     `--no-package-lock`,
@@ -144,7 +144,8 @@ async function installNotifiers (notifier) {
       `../../../../bugsnag-browser-${require('../packages/browser/package.json').version}.tgz`,
       `../../../../bugsnag-web-worker-${require('../packages/web-worker/package.json').version}.tgz`,
       `../../../../bugsnag-plugin-react-${require('../packages/plugin-react/package.json').version}.tgz`,
-      `../../../../bugsnag-plugin-vue-${require('../packages/plugin-vue/package.json').version}.tgz`
+      `../../../../bugsnag-plugin-vue-${require('../packages/plugin-vue/package.json').version}.tgz`,
+      `../../../../bugsnag-plugin-network-instrumentation-${require('../packages/plugin-network-instrumentation/package.json').version}.tgz`
     ]
   ), {
     cwd: `${__dirname}/../test/browser/features/fixtures`

jest.config.js

@@ -29,7 +29,7 @@ module.exports = {
     project('web workers', ['web-worker'], {
       testEnvironment: '<rootDir>/jest/FixJSDOMEnvironment.js'
     }),
-    project('shared plugins', ['plugin-app-duration', 'plugin-stackframe-path-normaliser']),
+    project('shared plugins', ['plugin-app-duration', 'plugin-stackframe-path-normaliser', 'request-tracker']),
     project('browser', [
       'browser',
       'delivery-x-domain-request',
@@ -50,7 +50,8 @@ module.exports = {
       'plugin-inline-script-content',
       'plugin-simple-throttle',
       'plugin-console-breadcrumbs',
-      'plugin-browser-session'
+      'plugin-browser-session',
+      'plugin-network-instrumentation'
     ], {
       testEnvironment: '<rootDir>/jest/FixJSDOMEnvironment.js'
     }),

package-lock.json

@@ -1,4 +1,4 @@
-import { App, Device, Event, Request, Breadcrumb, User, Session, FeatureFlag } from './types'
+import { App, Device, Event, Request, Response, Breadcrumb, User, Session, FeatureFlag } from './types'
 import { Error } from './types/event'
 
 interface HandledState {
@@ -40,6 +40,7 @@ export default class EventWithInternals extends Event {
     app: App
     device: Device
     request: Request
+    response: Response
     breadcrumbs: Breadcrumb[]
     context: string | undefined
     correlation: { spanId: string, traceId: string } | undefined

packages/core/event.d.ts

@@ -23,6 +23,7 @@ class Event {
     this.app = {}
     this.device = {}
     this.request = {}
+    this.response = {}
 
     this.breadcrumbs = []
     this.threads = []
@@ -120,6 +121,7 @@ class Event {
       app: this.app,
       device: this.device,
       request: this.request,
+      response: this.response,
       breadcrumbs: this.breadcrumbs,
       context: this.context,
       groupingHash: this.groupingHash,

packages/core/event.js

@@ -2,7 +2,8 @@ const jsonStringify = require('@bugsnag/safe-json-stringify')
 const EVENT_REDACTION_PATHS = [
   'events.[].metaData',
   'events.[].breadcrumbs.[].metaData',
-  'events.[].request'
+  'events.[].request',
+  'events.[].response'
 ]
 
 module.exports.event = (event, redactedKeys) => {

packages/core/lib/json-payload.js

@@ -120,6 +120,13 @@ interface Request {
   [key: string]: any
 }
 
+interface Response {
+  statusCode: number
+  headers: { [key: string]: unknown }
+  body?: string
+  bodyLength?: number
+}
+
 export interface User {
   id?: string
   email?: string

packages/core/types/common.d.ts

@@ -3,6 +3,7 @@ import {
   App,
   Device,
   Request,
+  Response,
   Logger,
   User,
   Thread,
@@ -23,6 +24,7 @@ declare class Event {
   public app: App
   public device: Device
   public request: Request
+  public response: Response
 
   public errors: Error[];
   public breadcrumbs: Breadcrumb[]