Merge pull request #872 from bugsnag/fix-express-request-body

plugin-express: fetch request body in onError

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## TBD
+
+### Fixed
+- (plugin-express): Ensure `req.body` is always present in metadata by collecting it at the last possible moment [#872](https://github.com/bugsnag/bugsnag-js/pull/872)
 
 ## 7.1.1 (2020-05-26)
 

packages/plugin-express/src/express.js

@@ -25,10 +25,10 @@ module.exports = {
       req.bugsnag = requestClient
 
       // extract request info and pass it to the relevant bugsnag properties
-      const { request, metadata } = getRequestAndMetadataFromReq(req)
-      requestClient.addMetadata('request', metadata)
       requestClient.addOnError((event) => {
+        const { metadata, request } = getRequestAndMetadataFromReq(req)
         event.request = { ...event.request, ...request }
+        requestClient.addMetadata('request', metadata)
       }, true)
 
       // unhandled errors caused by this request

test/node/features/express.feature

@@ -105,3 +105,16 @@ Scenario: a handled error passed to req.bugsnag.notify()
   And the event "request.url" equals "http://express/handled"
   And the event "request.httpMethod" equals "GET"
   And the event "request.clientIp" is not null
+
+Scenario: adding body to request metadata
+  When I POST the data "data=in_request_body" to the URL "http://express/bodytest"
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4" for the "Bugsnag Node" notifier
+  And the event "unhandled" is true
+  And the event "severity" equals "error"
+  And the exception "errorClass" equals "Error"
+  And the exception "message" equals "request body"
+  And the exception "type" equals "nodejs"
+  And the "file" of stack frame 0 equals "scenarios/app.js"
+  And the event "metaData.request.body.data" equals "in_request_body"
+  And the event "request.httpMethod" equals "POST"

test/node/features/fixtures/express/package.json

@@ -1,6 +1,7 @@
 {
   "name": "bugsnag-test",
   "dependencies": {
+    "body-parser": "^1.19.0",
     "express": "^4.16.3"
   }
 }

test/node/features/fixtures/express/scenarios/app.js

@@ -1,13 +1,15 @@
 var Bugsnag = require('@bugsnag/node')
 var bugsnagExpress = require('@bugsnag/plugin-express')
 var express = require('express')
+var bodyParser = require('body-parser')
 
 Bugsnag.start({
   apiKey: process.env.BUGSNAG_API_KEY,
   endpoints: {
     notify: process.env.BUGSNAG_NOTIFY_ENDPOINT,
     sessions: process.env.BUGSNAG_SESSIONS_ENDPOINT
   },
+  autoTrackSessions: false,
   plugins: [bugsnagExpress]
 })
 
@@ -69,6 +71,10 @@ app.get('/handled', function (req, res, next) {
   res.end('OK')
 })
 
+app.post('/bodytest', bodyParser.urlencoded(), function (req, res, next) {
+  throw new Error('request body')
+})
+
 app.use(middleware.errorHandler)
 
 app.listen(80)

test/node/features/steps/server_fixture_request_steps.rb

@@ -0,0 +1,9 @@
+require 'net/http'
+
+# Attempts to POST a string of urlencoded data to a server.
+#
+# @step_input reqbody [String] urlencoded data to send.
+# @step_input url [String] The URL to post data to.
+When("I POST the data {string} to the URL {string}") do |reqbody, url|
+  Net::HTTP.post(URI(url), reqbody)
+end