dd-trace 5.23.0 → 5.24.0

package/LICENSE-3rdparty.csv

@@ -14,7 +14,6 @@ require,import-in-the-middle,Apache license 2.0,Copyright 2021 Datadog Inc.
 require,int64-buffer,MIT,Copyright 2015-2016 Yusuke Kawasaki
 require,istanbul-lib-coverage,BSD-3-Clause,Copyright 2012-2015 Yahoo! Inc.
 require,jest-docblock,MIT,Copyright Meta Platforms, Inc. and affiliates.
-require,jsonpath-plus,MIT,Copyright (c) 2011-2019 Stefan Goessner, Subbu Allamaraju, Mike Brevoort, Robert Krahn, Brett Zamir, Richard Schneider
 require,koalas,MIT,Copyright 2013-2017 Brian Woodward
 require,limiter,MIT,Copyright 2011 John Hurliman
 require,lodash.sortby,MIT,Copyright JS Foundation and other contributors

package/ext/types.d.ts

@@ -1,5 +1,6 @@
 declare const types: {
   HTTP: 'http'
+  SERVERLESS: 'serverless'
   WEB: 'web'
 }
 

package/ext/types.js

@@ -2,5 +2,6 @@
 
 module.exports = {
   HTTP: 'http',
+  SERVERLESS: 'serverless',
   WEB: 'web'
 }

package/index.d.ts

@@ -147,7 +147,9 @@ interface Plugins {
   "amqp10": tracer.plugins.amqp10;
   "amqplib": tracer.plugins.amqplib;
   "apollo": tracer.plugins.apollo;
+  "avsc": tracer.plugins.avsc;
   "aws-sdk": tracer.plugins.aws_sdk;
+  "azure-functions": tracer.plugins.azure_functions;
   "bunyan": tracer.plugins.bunyan;
   "cassandra-driver": tracer.plugins.cassandra_driver;
   "child_process": tracer.plugins.child_process;
@@ -190,6 +192,7 @@ interface Plugins {
   "playwright": tracer.plugins.playwright;
   "pg": tracer.plugins.pg;
   "pino": tracer.plugins.pino;
+  "protobufjs": tracer.plugins.protobufjs;
   "redis": tracer.plugins.redis;
   "restify": tracer.plugins.restify;
   "rhea": tracer.plugins.rhea;
@@ -1191,6 +1194,12 @@ declare namespace tracer {
       signature?: boolean;
     }
 
+    /**
+     * This plugin automatically patches the [avsc](https://github.com/mtth/avsc) module
+     * to collect avro message schemas when Datastreams Monitoring is enabled.
+     */
+    interface avsc extends Integration {}
+
     /**
      * This plugin automatically instruments the
      * [aws-sdk](https://github.com/aws/aws-sdk-js) module.
@@ -1229,6 +1238,12 @@ declare namespace tracer {
       [key: string]: boolean | Object | undefined;
     }
 
+    /**
+     * This plugin automatically instruments the
+     * @azure/functions module.
+    */
+    interface azure_functions extends Instrumentation {}
+
     /**
      * This plugin patches the [bunyan](https://github.com/trentm/node-bunyan)
      * to automatically inject trace identifiers in log records when the
@@ -1731,6 +1746,11 @@ declare namespace tracer {
      * on the tracer.
      */
     interface pino extends Integration {}
+    /**
+     * This plugin automatically patches the [protobufjs](https://protobufjs.github.io/protobuf.js/)
+     * to collect protobuf message schemas when Datastreams Monitoring is enabled.
+     */
+    interface protobufjs extends Integration {}
 
     /**
      * This plugin automatically instruments the
@@ -2146,6 +2166,12 @@ declare namespace tracer {
      */
     maxContextOperations?: number,
 
+    /**
+     * Defines the pattern to ignore cookie names in the vulnerability hash calculation
+     * @default ".{32,}"
+     */
+    cookieFilterPattern?: string,
+
     /**
      * Whether to enable vulnerability deduplication
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.23.0",
+  "version": "5.24.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -20,8 +20,8 @@
     "test:appsec:ci": "nyc --no-clean --include \"packages/dd-trace/src/appsec/**/*.js\" --exclude \"packages/dd-trace/test/appsec/**/*.plugin.spec.js\" -- npm run test:appsec",
     "test:appsec:plugins": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/dd-trace/test/appsec/**/*.@($(echo $PLUGINS)).plugin.spec.js\"",
     "test:appsec:plugins:ci": "yarn services && nyc --no-clean --include \"packages/dd-trace/src/appsec/**/*.js\" -- npm run test:appsec:plugins",
-    "test:debugger": "tap packages/dd-trace/test/debugger/**/*.spec.js",
-    "test:debugger:ci": "npm run test:debugger -- --coverage --nyc-arg=--include=\"packages/dd-trace/src/debugger/**/*.js\"",
+    "test:debugger": "mocha -r 'packages/dd-trace/test/setup/mocha.js' 'packages/dd-trace/test/debugger/**/*.spec.js'",
+    "test:debugger:ci": "nyc --no-clean --include 'packages/dd-trace/src/debugger/**/*.js' -- npm run test:debugger",
     "test:trace:core": "tap packages/dd-trace/test/*.spec.js \"packages/dd-trace/test/{ci-visibility,datastreams,encode,exporters,opentelemetry,opentracing,plugins,service-naming,telemetry}/**/*.spec.js\"",
     "test:trace:core:ci": "npm run test:trace:core -- --coverage --nyc-arg=--include=\"packages/dd-trace/src/**/*.js\"",
     "test:instrumentations": "mocha -r 'packages/dd-trace/test/setup/mocha.js' 'packages/datadog-instrumentations/test/**/*.spec.js'",
@@ -77,7 +77,7 @@
   },
   "dependencies": {
     "@datadog/native-appsec": "8.1.1",
-    "@datadog/native-iast-rewriter": "2.4.1",
+    "@datadog/native-iast-rewriter": "2.5.0",
     "@datadog/native-iast-taint-tracking": "3.1.0",
     "@datadog/native-metrics": "^2.0.0",
     "@datadog/pprof": "5.3.0",
@@ -91,7 +91,6 @@
     "int64-buffer": "^0.1.9",
     "istanbul-lib-coverage": "3.2.0",
     "jest-docblock": "^29.7.0",
-    "jsonpath-plus": "^9.0.0",
     "koalas": "^1.0.2",
     "limiter": "1.1.5",
     "lodash.sortby": "^4.7.0",
@@ -114,7 +113,7 @@
     "aws-sdk": "^2.1446.0",
     "axios": "^1.7.4",
     "benchmark": "^2.1.4",
-    "body-parser": "^1.20.2",
+    "body-parser": "^1.20.3",
     "chai": "^4.3.7",
     "chalk": "^5.3.0",
     "checksum": "^1.0.0",
@@ -140,7 +139,7 @@
     "nyc": "^15.1.0",
     "proxyquire": "^1.8.0",
     "rimraf": "^3.0.0",
-    "sinon": "^15.2.0",
+    "sinon": "^16.1.3",
     "sinon-chai": "^3.7.0",
     "tap": "^16.3.7",
     "tiktoken": "^1.0.15"

package/packages/datadog-code-origin/index.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const { getUserLandFrames } = require('../dd-trace/src/plugins/util/stacktrace')
+
+const limit = Number(process.env._DD_CODE_ORIGIN_MAX_USER_FRAMES) || 8
+
+module.exports = {
+  entryTag,
+  exitTag
+}
+
+function entryTag (topOfStackFunc) {
+  return tag('entry', topOfStackFunc)
+}
+
+function exitTag (topOfStackFunc) {
+  return tag('exit', topOfStackFunc)
+}
+
+function tag (type, topOfStackFunc) {
+  const frames = getUserLandFrames(topOfStackFunc, limit)
+  const tags = {
+    '_dd.code_origin.type': type
+  }
+  for (let i = 0; i < frames.length; i++) {
+    const frame = frames[i]
+    tags[`_dd.code_origin.frames.${i}.file`] = frame.file
+    tags[`_dd.code_origin.frames.${i}.line`] = String(frame.line)
+    tags[`_dd.code_origin.frames.${i}.column`] = String(frame.column)
+    if (frame.method) {
+      tags[`_dd.code_origin.frames.${i}.method`] = frame.method
+    }
+    if (frame.type) {
+      tags[`_dd.code_origin.frames.${i}.type`] = frame.type
+    }
+  }
+  return tags
+}

package/packages/datadog-core/index.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const LocalStorage = require('./src/storage')
+const { AsyncLocalStorage } = require('async_hooks')
 
-const storage = new LocalStorage()
+const storage = new AsyncLocalStorage()
 
 module.exports = { storage }

package/packages/datadog-instrumentations/src/avsc.js

@@ -0,0 +1,37 @@
+const shimmer = require('../../datadog-shimmer')
+const { addHook } = require('./helpers/instrument')
+
+const dc = require('dc-polyfill')
+const serializeChannel = dc.channel('apm:avsc:serialize-start')
+const deserializeChannel = dc.channel('apm:avsc:deserialize-end')
+
+function wrapSerialization (Type) {
+  shimmer.wrap(Type.prototype, 'toBuffer', original => function () {
+    if (!serializeChannel.hasSubscribers) {
+      return original.apply(this, arguments)
+    }
+    serializeChannel.publish({ messageClass: this })
+    return original.apply(this, arguments)
+  })
+}
+
+function wrapDeserialization (Type) {
+  shimmer.wrap(Type.prototype, 'fromBuffer', original => function () {
+    if (!deserializeChannel.hasSubscribers) {
+      return original.apply(this, arguments)
+    }
+    const result = original.apply(this, arguments)
+    deserializeChannel.publish({ messageClass: result })
+    return result
+  })
+}
+
+addHook({
+  name: 'avsc',
+  versions: ['>=5.0.0']
+}, avro => {
+  wrapDeserialization(avro.Type)
+  wrapSerialization(avro.Type)
+
+  return avro
+})

package/packages/datadog-instrumentations/src/azure-functions.js

@@ -0,0 +1,48 @@
+'use strict'
+
+const {
+  addHook
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+const dc = require('dc-polyfill')
+
+const azureFunctionsChannel = dc.tracingChannel('datadog:azure-functions:invoke')
+
+addHook({ name: '@azure/functions', versions: ['>=4'] }, azureFunction => {
+  const { app } = azureFunction
+
+  shimmer.wrap(app, 'deleteRequest', wrapHandler)
+  shimmer.wrap(app, 'http', wrapHandler)
+  shimmer.wrap(app, 'get', wrapHandler)
+  shimmer.wrap(app, 'patch', wrapHandler)
+  shimmer.wrap(app, 'post', wrapHandler)
+  shimmer.wrap(app, 'put', wrapHandler)
+
+  return azureFunction
+})
+
+// The http methods are overloaded so we need to check which type of argument was passed in order to wrap the handler
+// The arguments are either an object with a handler property or the handler function itself
+function wrapHandler (method) {
+  return function (name, arg) {
+    if (typeof arg === 'object' && arg.hasOwnProperty('handler')) {
+      const options = arg
+      shimmer.wrap(options, 'handler', handler => traceHandler(handler, name, method.name))
+    } else if (typeof arg === 'function') {
+      const handler = arg
+      arguments[1] = shimmer.wrapFunction(handler, handler => traceHandler(handler, name, method.name))
+    }
+    return method.apply(this, arguments)
+  }
+}
+
+function traceHandler (handler, functionName, methodName) {
+  return function (...args) {
+    const httpRequest = args[0]
+    const invocationContext = args[1]
+    return azureFunctionsChannel.tracePromise(
+      handler,
+      { functionName, httpRequest, invocationContext, methodName },
+      this, ...args)
+  }
+}

package/packages/datadog-instrumentations/src/child_process.js

@@ -61,14 +61,17 @@ function wrapChildProcessSyncMethod (shell = false) {
 
       const childProcessInfo = normalizeArgs(arguments, shell)
 
-      return childProcessChannel.traceSync(
-        childProcessMethod,
-        {
-          command: childProcessInfo.command,
-          shell: childProcessInfo.shell
-        },
-        this,
-        ...arguments)
+      const innerResource = new AsyncResource('bound-anonymous-fn')
+      return innerResource.runInAsyncScope(() => {
+        return childProcessChannel.traceSync(
+          childProcessMethod,
+          {
+            command: childProcessInfo.command,
+            shell: childProcessInfo.shell
+          },
+          this,
+          ...arguments)
+      })
     }
   }
 }
@@ -101,6 +104,12 @@ function wrapChildProcessAsyncMethod (shell = false) {
 
       const childProcessInfo = normalizeArgs(arguments, shell)
 
+      const cb = arguments[arguments.length - 1]
+      if (typeof cb === 'function') {
+        const callbackResource = new AsyncResource('bound-anonymous-fn')
+        arguments[arguments.length - 1] = callbackResource.bind(cb)
+      }
+
       const innerResource = new AsyncResource('bound-anonymous-fn')
       return innerResource.runInAsyncScope(() => {
         childProcessChannel.start.publish({ command: childProcessInfo.command, shell: childProcessInfo.shell })

package/packages/datadog-instrumentations/src/express.js

@@ -3,6 +3,7 @@
 const { createWrapRouterMethod } = require('./router')
 const shimmer = require('../../datadog-shimmer')
 const { addHook, channel } = require('./helpers/instrument')
+const tracingChannel = require('dc-polyfill').tracingChannel
 
 const handleChannel = channel('apm:express:request:handle')
 
@@ -35,6 +36,27 @@ function wrapResponseJson (json) {
   }
 }
 
+const responseRenderChannel = tracingChannel('datadog:express:response:render')
+
+function wrapResponseRender (render) {
+  return function wrappedRender (view, options, callback) {
+    if (!responseRenderChannel.start.hasSubscribers) {
+      return render.apply(this, arguments)
+    }
+
+    return responseRenderChannel.traceSync(
+      render,
+      {
+        req: this.req,
+        view,
+        options
+      },
+      this,
+      ...arguments
+    )
+  }
+}
+
 addHook({ name: 'express', versions: ['>=4'] }, express => {
   shimmer.wrap(express.application, 'handle', wrapHandle)
   shimmer.wrap(express.Router, 'use', wrapRouterMethod)
@@ -42,6 +64,7 @@ addHook({ name: 'express', versions: ['>=4'] }, express => {
 
   shimmer.wrap(express.response, 'json', wrapResponseJson)
   shimmer.wrap(express.response, 'jsonp', wrapResponseJson)
+  shimmer.wrap(express.response, 'render', wrapResponseRender)
 
   return express
 })
@@ -79,11 +102,21 @@ addHook({
 })
 
 const processParamsStartCh = channel('datadog:express:process_params:start')
-const wrapProcessParamsMethod = (requestPositionInArguments) => {
-  return (original) => {
-    return function () {
+function wrapProcessParamsMethod (requestPositionInArguments) {
+  return function wrapProcessParams (original) {
+    return function wrappedProcessParams () {
       if (processParamsStartCh.hasSubscribers) {
-        processParamsStartCh.publish({ req: arguments[requestPositionInArguments] })
+        const req = arguments[requestPositionInArguments]
+        const abortController = new AbortController()
+
+        processParamsStartCh.publish({
+          req,
+          res: req?.res,
+          abortController,
+          params: req?.params
+        })
+
+        if (abortController.signal.aborted) return
       }
 
       return original.apply(this, arguments)

package/packages/datadog-instrumentations/src/fastify.js

@@ -5,6 +5,7 @@ const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 
 const errorChannel = channel('apm:fastify:middleware:error')
 const handleChannel = channel('apm:fastify:request:handle')
+const routeAddedChannel = channel('apm:fastify:route:added')
 
 const parsingResources = new WeakMap()
 
@@ -16,6 +17,7 @@ function wrapFastify (fastify, hasParsingEvents) {
 
     if (!app || typeof app.addHook !== 'function') return app
 
+    app.addHook('onRoute', onRoute)
     app.addHook('onRequest', onRequest)
     app.addHook('preHandler', preHandler)
 
@@ -86,8 +88,9 @@ function onRequest (request, reply, done) {
 
   const req = getReq(request)
   const res = getRes(reply)
+  const routeConfig = getRouteConfig(request)
 
-  handleChannel.publish({ req, res })
+  handleChannel.publish({ req, res, routeConfig })
 
   return done()
 }
@@ -142,6 +145,10 @@ function getRes (reply) {
   return reply && (reply.raw || reply.res || reply)
 }
 
+function getRouteConfig (request) {
+  return request?.routeOptions?.config
+}
+
 function publishError (error, req) {
   if (error) {
     errorChannel.publish({ error, req })
@@ -150,6 +157,10 @@ function publishError (error, req) {
   return error
 }
 
+function onRoute (routeOptions) {
+  routeAddedChannel.publish({ routeOptions, onRoute })
+}
+
 addHook({ name: 'fastify', versions: ['>=3'] }, fastify => {
   const wrapped = shimmer.wrapFunction(fastify, fastify => wrapFastify(fastify, true))
 

package/packages/datadog-instrumentations/src/fs.js

@@ -266,24 +266,44 @@ function createWrapFunction (prefix = '', override = '') {
       const lastIndex = arguments.length - 1
       const cb = typeof arguments[lastIndex] === 'function' && arguments[lastIndex]
       const innerResource = new AsyncResource('bound-anonymous-fn')
-      const message = getMessage(method, getMethodParamsRelationByPrefix(prefix)[operation], arguments, this)
+      const params = getMethodParamsRelationByPrefix(prefix)[operation]
+      const abortController = new AbortController()
+      const message = { ...getMessage(method, params, arguments, this), abortController }
+
+      const finish = innerResource.bind(function (error) {
+        if (error !== null && typeof error === 'object') { // fs.exists receives a boolean
+          errorChannel.publish(error)
+        }
+        finishChannel.publish()
+      })
 
       if (cb) {
         const outerResource = new AsyncResource('bound-anonymous-fn')
 
         arguments[lastIndex] = shimmer.wrapFunction(cb, cb => innerResource.bind(function (e) {
-          if (e !== null && typeof e === 'object') { // fs.exists receives a boolean
-            errorChannel.publish(e)
-          }
-
-          finishChannel.publish()
-
+          finish(e)
           return outerResource.runInAsyncScope(() => cb.apply(this, arguments))
         }))
       }
 
       return innerResource.runInAsyncScope(() => {
         startChannel.publish(message)
+
+        if (abortController.signal.aborted) {
+          const error = abortController.signal.reason || new Error('Aborted')
+
+          if (prefix === 'promises.') {
+            finish(error)
+            return Promise.reject(error)
+          } else if (name.includes('Sync') || !cb) {
+            finish(error)
+            throw error
+          } else if (cb) {
+            arguments[lastIndex](error)
+            return
+          }
+        }
+
         try {
           const result = original.apply(this, arguments)
           if (cb) return result

package/packages/datadog-instrumentations/src/helpers/hooks.js

@@ -5,6 +5,7 @@ module.exports = {
   '@apollo/gateway': () => require('../apollo'),
   'apollo-server-core': () => require('../apollo-server-core'),
   '@aws-sdk/smithy-client': () => require('../aws-sdk'),
+  '@azure/functions': () => require('../azure-functions'),
   '@cucumber/cucumber': () => require('../cucumber'),
   '@playwright/test': () => require('../playwright'),
   '@elastic/elasticsearch': () => require('../elasticsearch'),
@@ -27,6 +28,7 @@ module.exports = {
   aerospike: () => require('../aerospike'),
   amqp10: () => require('../amqp10'),
   amqplib: () => require('../amqplib'),
+  avsc: () => require('../avsc'),
   'aws-sdk': () => require('../aws-sdk'),
   bluebird: () => require('../bluebird'),
   'body-parser': () => require('../body-parser'),
@@ -100,6 +102,7 @@ module.exports = {
   playwright: () => require('../playwright'),
   'promise-js': () => require('../promise-js'),
   promise: () => require('../promise'),
+  protobufjs: () => require('../protobufjs'),
   q: () => require('../q'),
   qs: () => require('../qs'),
   redis: () => require('../redis'),

package/packages/datadog-instrumentations/src/jest.js

@@ -850,7 +850,8 @@ addHook({
 }, jestConfigSyncWrapper)
 
 const LIBRARIES_BYPASSING_JEST_REQUIRE_ENGINE = [
-  'selenium-webdriver'
+  'selenium-webdriver',
+  'winston'
 ]
 
 function shouldBypassJestRequireEngine (moduleName) {

package/packages/datadog-instrumentations/src/mocha/common.js

@@ -1,6 +1,6 @@
 const { addHook, channel } = require('../helpers/instrument')
 const shimmer = require('../../../datadog-shimmer')
-const { getCallSites } = require('../../../dd-trace/src/plugins/util/test')
+const { getCallSites } = require('../../../dd-trace/src/plugins/util/stacktrace')
 const { testToStartLine } = require('./utils')
 
 const parameterizedTestCh = channel('ci:mocha:test:parameterize')