Merge pull request #11 from zentered/fix/trace-data

fix: add missing request to trace'

Author: PatrickHeneise

index.js

@@ -3,6 +3,7 @@
 const fp = require('fastify-plugin')
 const Sentry = require('@sentry/node')
 const Tracing = require('@sentry/tracing') // eslint-disable-line no-unused-vars
+const extractRequestData = require('./lib/extractRequestData.js')
 
 function sentryConnector(fastify, opts, next) {
   if (!opts || !opts.dsn) {
@@ -22,10 +23,27 @@ function sentryConnector(fastify, opts, next) {
 
   fastify.decorateRequest('sentryTransaction', null)
   fastify.addHook('onRequest', async (request) => {
-    request.sentryTransaction = Sentry.startTransaction({
-      op: 'request',
-      name: `${request.method} ${request.url}`
-    })
+    // If there is a trace header set, we extract the data from it (parentSpanId, traceId, and sampling decision)
+    let traceparentData
+    if (
+      request.headers &&
+      typeof request.headers['sentry-trace'] === 'string'
+    ) {
+      traceparentData = Tracing.extractTraceparentData(
+        request.headers['sentry-trace']
+      )
+    }
+
+    const extractedRequestData = extractRequestData(request)
+
+    request.sentryTransaction = Sentry.startTransaction(
+      {
+        op: 'request',
+        name: `${request.method} ${request.url}`,
+        ...traceparentData
+      },
+      { request: extractedRequestData }
+    )
     return
   })
 

lib/extractRequestData.js

@@ -0,0 +1,48 @@
+'use strict'
+
+const DEFAULT_REQUEST_KEYS = ['headers', 'method', 'query_string', 'url']
+
+/**
+ * Function copied from
+ * https://github.com/getsentry/sentry-javascript/blob/master/packages/node/src/handlers.ts
+ * and mofidied for Fastify
+ *
+ * Data (req.body) isn't available in onRequest hook,
+ * as it is parsed later in the fastify lifecycle
+ * https://www.fastify.io/docs/latest/Hooks/#onrequest
+ */
+function extractRequestData(req, keys) {
+  if (!keys || keys.length <= 0 || typeof keys !== 'object') {
+    keys = DEFAULT_REQUEST_KEYS
+  }
+  const requestData = {}
+  const headers = req.headers || {}
+  const method = req.method
+  const host = req.hostname
+  const protocol = req.protocol
+  const originalUrl = req.url
+  const absoluteUrl = protocol + '://' + host + originalUrl
+  keys.forEach(function (key) {
+    switch (key) {
+      case 'headers':
+        requestData.headers = headers
+        break
+      case 'method':
+        requestData.method = method
+        break
+      case 'url':
+        requestData.url = absoluteUrl
+        break
+      case 'query_string':
+        requestData.query_string = Object.assign({}, req.query)
+        break
+      default:
+        if ({}.hasOwnProperty.call(req, key)) {
+          requestData[key] = req[key]
+        }
+    }
+  })
+  return requestData
+}
+
+module.exports = exports = extractRequestData

test/auth.js renamed to test/auth.test.js

@@ -30,6 +30,7 @@ tap.test('sentryConnector with custom error handler', async (test) => {
 
   const response = await fastify.inject({
     method: 'POST',
+    headers: { 'sentry-trace': 'testing trace' },
     url: '/',
     payload: { error: 503, message: 'Internal Server Error' }
   })

test/basic.js renamed to test/basic.test.js

@@ -0,0 +1,40 @@
+'use strict'
+
+/* eslint-disable node/no-unpublished-require */
+const tap = require('tap')
+const fn = require('../lib/extractRequestData')
+
+tap.test('extractedRequestData should process fastify request', (test) => {
+  test.plan(1)
+  const request = {
+    headers: {
+      host: 'localhost:3000',
+      accept: '/*/'
+    },
+    hostname: 'localhost:3000',
+    protocol: 'http',
+    method: 'GET',
+    url: '/testing'
+  }
+
+  const expected = {
+    headers: { host: 'localhost:3000', accept: '/*/' },
+    method: 'GET',
+    query_string: {},
+    url: 'http://localhost:3000/testing'
+  }
+
+  const actual = fn(request)
+  test.strictSame(actual, expected)
+})
+
+tap.test('extractedRequestData should process other keys', (test) => {
+  test.plan(2)
+  const request = {
+    testing: 'testing'
+  }
+
+  const actual = fn(request, ['testing', 'testing2'])
+  test.equal(actual.testing, 'testing')
+  test.equal(actual.testing2, undefined)
+})