Merge pull request #2639 from bugsnag/PLAT-12567/http-errors-plugin

Create http errors plugin

Author: gingerbenw

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-http-errors' ]
   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-http-errors' ].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-http-errors-${require('../packages/plugin-http-errors/package.json').version}.tgz`
     ]
   ), {
     cwd: `${__dirname}/../test/browser/features/fixtures`

jest.config.js

@@ -50,7 +50,8 @@ module.exports = {
       'plugin-inline-script-content',
       'plugin-simple-throttle',
       'plugin-console-breadcrumbs',
-      'plugin-browser-session'
+      'plugin-browser-session',
+      'plugin-http-errors'
     ], {
       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[]

packages/core/types/event.d.ts

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Bugsnag
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/plugin-http-errors/LICENSE.txt

@@ -0,0 +1,45 @@
+# @bugsnag/plugin-http-errors
+
+A [@bugsnag/js](https://github.com/bugsnag/bugsnag-js) plugin for HTTP error handling.
+
+## Installation
+
+```sh
+npm install --save @bugsnag/plugin-http-errors
+# or
+yarn add @bugsnag/plugin-http-errors
+```
+
+## Usage
+
+```js
+import Bugsnag from '@bugsnag/js'
+import createHttpErrorPlugin from '@bugsnag/plugin-http-errors'
+
+const plugin = createHttpErrorPlugin({
+  httpErrorCodes: [401, { min: 404, max: 499 }], // handle individual error codes or ranges of error codes 
+  maxRequestSize: 5_000, // don't capture requests over 5kb
+  onHttpError: ({ request, response }) => {
+    // Only handle 5xx errors
+    if (response.statusCode < 500 || response.statusCode > 599) return false
+
+    // Exclude specific domains
+    if (request.url.indexOf('redacted.domain.com') === 0) return false
+
+    // Update properties on the reported request and response
+    request.url = '[REDACTED]'
+    response.statusCode = 418
+
+    return true // return value will determine whether the error is reported
+  }
+})
+
+Bugsnag.start({
+  apiKey: 'YOUR_API_KEY',
+  plugins: [plugin]
+})
+```
+
+## License
+
+This package is free software released under the MIT License. See [LICENSE.txt](./LICENSE.txt) for details.