feat(fastify): add captureBody support (#2681)

Closes: #1906
Closes: #3217
Co-authored-by: Trent Mick <[email protected]>

Author: xxzefgh

.tav.yml

@@ -476,6 +476,7 @@ fastify-v1:
     - node test/instrumentation/modules/fastify/fastify.test.js
     - node test/instrumentation/modules/fastify/async-await.test.js
     - node test/instrumentation/modules/fastify/set-framework.test.js
+    - node test/sanitize-field-names/fastify.test.js
 fastify-v2:
   name: fastify
   versions: '>=2.0.0 <2.4.0 || >2.4.0 <3'
@@ -484,6 +485,7 @@ fastify-v2:
     - node test/instrumentation/modules/fastify/fastify.test.js
     - node test/instrumentation/modules/fastify/async-await.test.js
     - node test/instrumentation/modules/fastify/set-framework.test.js
+    - node test/sanitize-field-names/fastify.test.js
 fastify-v3:
   name: fastify
   versions: '>=3.0.0 <4'
@@ -492,6 +494,7 @@ fastify-v3:
     - node test/instrumentation/modules/fastify/fastify.test.js
     - node test/instrumentation/modules/fastify/async-await.test.js
     - node test/instrumentation/modules/fastify/set-framework.test.js
+    - node test/sanitize-field-names/fastify.test.js
 fastify:
   name: fastify
   versions: '>=4 <4.0.1 || >4.0.1 <4.16.0 || >4.16.2'
@@ -500,6 +503,7 @@ fastify:
     - node test/instrumentation/modules/fastify/fastify.test.js
     - node test/instrumentation/modules/fastify/async-await.test.js
     - node test/instrumentation/modules/fastify/set-framework.test.js
+    - node test/sanitize-field-names/fastify.test.js
 
 finalhandler:
   versions: '*'

CHANGELOG.asciidoc

@@ -40,6 +40,9 @@ Notes:
 [float]
 ===== Features
 
+* Add <<capture-body>> support for Fastify instrumentation.
+  Contributed by @xxzefgh. ({pull}2681[#2681])
+
 * Add support for mysql2@3. Contributed by @firecow. ({pull}3301[#3301])
 
 * Improve error handling with AWS Lambda. When used together with the

lib/instrumentation/modules/fastify.js

@@ -40,6 +40,13 @@ module.exports = function (fastify, agent, { version, enabled }) {
       next()
     })
 
+    agent.logger.debug('adding preHandler hook to fastify')
+    _fastify.addHook('preHandler', (req, reply, next) => {
+      // Save the parsed req body to be picked up by getContextFromRequest().
+      req.raw.body = req.body
+      next()
+    })
+
     agent.logger.debug('adding onError hook to fastify')
     _fastify.addHook('onError', (req, reply, err, next) => {
       agent.captureError(err, { request: req.raw })
@@ -60,6 +67,13 @@ module.exports = function (fastify, agent, { version, enabled }) {
       next()
     })
 
+    agent.logger.debug('adding preHandler hook to fastify')
+    _fastify.addHook('preHandler', (req, reply, next) => {
+      // Save the parsed req body to be picked up by getContextFromRequest().
+      req.raw.body = req.body
+      next()
+    })
+
     agent.logger.debug('adding onError hook to fastify')
     _fastify.addHook('onError', (req, reply, err, next) => {
       agent.captureError(err, { request: req.raw })
@@ -80,6 +94,13 @@ module.exports = function (fastify, agent, { version, enabled }) {
       next()
     })
 
+    agent.logger.debug('adding preHandler hook to fastify')
+    _fastify.addHook('preHandler', (req, reply, next) => {
+      // Save the parsed req body to be picked up by getContextFromRequest().
+      req.raw.body = req.body
+      next()
+    })
+
     agent.logger.warn('Elastic APM cannot automaticaly capture errors on this verison of Fastify. Upgrade to version 2.0.0 or later.')
 
     return _fastify

test/instrumentation/modules/fastify/fastify.test.js

@@ -12,9 +12,12 @@ if (process.env.GITHUB_ACTIONS === 'true' && process.platform === 'win32') {
 }
 
 const agent = require('../../../..').start({
+  serviceName: 'test-fastify',
   captureExceptions: false,
-  metricsInterval: 0,
-  centralConfig: false
+  metricsInterval: '0s',
+  centralConfig: false,
+  apmServerVersion: '8.7.0',
+  captureBody: 'all'
 })
 
 const isFastifyIncompat = require('../../../_is_fastify_incompat')()
@@ -69,6 +72,61 @@ test('transaction name', function (t) {
   })
 })
 
+test('captureBody', function (t) {
+  t.plan(9)
+
+  const postData = JSON.stringify({ foo: 'bar' })
+
+  resetAgent(data => {
+    t.strictEqual(data.transactions.length, 1)
+    var trans = data.transactions[0]
+    t.strictEqual(trans.name, 'POST /postSomeData', 'transaction.name')
+    t.strictEqual(trans.type, 'request', 'transaction.type')
+    t.strictEqual(trans.result, 'HTTP 2xx', 'transaction.result')
+    t.strictEqual(trans.context.request.method, 'POST', 'transaction.context.request.method')
+    t.equal(trans.context.request.body, postData, 'transaction.context.request.body')
+    fastify.close()
+  })
+
+  var fastify = Fastify()
+
+  fastify.post('/postSomeData', (request, reply) => {
+    reply.send('your data has been posted')
+  })
+
+  fastify.listen({ port: 0 }, function (err) {
+    t.error(err)
+
+    // build the URL manually as older versions of fastify doesn't supply it as
+    // an argument to the callback
+    const port = fastify.server.address().port
+    const cReq = http.request(
+      'http://localhost:' + port + '/postSomeData',
+      {
+        method: 'POST',
+        hostname: 'localhost',
+        port,
+        headers: {
+          'Content-Type': 'application/json',
+          'Content-Length': Buffer.byteLength(postData)
+        }
+      },
+      function (res) {
+        t.strictEqual(res.statusCode, 200)
+        res.on('data', function (chunk) {
+          t.strictEqual(chunk.toString(), 'your data has been posted')
+        })
+        res.on('end', function () {
+          agent.flush()
+          t.end()
+        })
+      }
+    )
+    cReq.write(postData)
+    cReq.end()
+  })
+})
+
 function resetAgent (cb) {
   agent._instrumentation.testReset()
   agent._transport = mockClient(1, cb)

test/sanitize-field-names/fastify.test.js

@@ -16,6 +16,7 @@ if (isFastifyIncompat) {
 
 const {
   resetAgent,
+  assertFormsWithFixture,
   assertRequestHeadersWithFixture,
   assertResponseHeadersWithFixture
 } = require('./_shared')
@@ -40,9 +41,7 @@ function runTest (
     const transaction = data.transactions.pop()
     assertRequestHeadersWithFixture(transaction, expected, t)
     assertResponseHeadersWithFixture(transaction, expected, t)
-    // TODO: uncomment once we fix
-    // https://github.com/elastic/apm-agent-nodejs/issues/1906
-    // assertFormsWithFixture(transaction, expected, t)
+    assertFormsWithFixture(transaction, expected, t)
   })
 
   // register request handler