dd-trace 5.30.0 → 5.32.0

package/LICENSE-3rdparty.csv

@@ -30,6 +30,7 @@ require,rfdc,MIT,Copyright 2019 David Mark Clements
 require,semver,ISC,Copyright Isaac Z. Schlueter and Contributors
 require,shell-quote,mit,Copyright (c) 2013 James Halliday
 require,source-map,BSD-3-Clause,Copyright (c) 2009-2011, Mozilla Foundation and contributors
+require,ttl-set,MIT,Copyright (c) 2024 Thomas Watson
 dev,@apollo/server,MIT,Copyright (c) 2016-2020 Apollo Graph, Inc. (Formerly Meteor Development Group, Inc.)
 dev,@types/node,MIT,Copyright Authors
 dev,@eslint/eslintrc,MIT,Copyright OpenJS Foundation and other contributors, <www.openjsf.org>

package/README.md

@@ -23,13 +23,15 @@ Most of the documentation for `dd-trace` is available on these webpages:
 
 ## Version Release Lines and Maintenance
 
-| Release Line                                             | Latest Version                                                                                         | Node.js  | Status          |Initial Release | End of Life |
-| :---:                                                    | :---:                                                                                                  | :---:    | :---:           | :---:          | :---:       |
-| [`v1`](https://github.com/DataDog/dd-trace-js/tree/v1.x) | ![npm v1](https://img.shields.io/npm/v/dd-trace/legacy-v1?color=white&label=%20&style=flat-square)     | `>= v12` | **End of Life** | 2021-07-13     | 2022-02-25  |
-| [`v2`](https://github.com/DataDog/dd-trace-js/tree/v2.x) | ![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=white&label=%20&style=flat-square) | `>= v12` | **End of Life** | 2022-01-28     | 2023-08-15  |
-| [`v3`](https://github.com/DataDog/dd-trace-js/tree/v3.x) | ![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=white&label=%20&style=flat-square) | `>= v14` | **End of Life** | 2022-08-15     | 2024-05-15  |
-| [`v4`](https://github.com/DataDog/dd-trace-js/tree/v4.x) | ![npm v4](https://img.shields.io/npm/v/dd-trace/latest-node16?color=white&label=%20&style=flat-square)        | `>= v16` | **Maintenance**     | 2023-05-12     | 2025-01-11     |
-| [`v5`](https://github.com/DataDog/dd-trace-js/tree/v5.x) | ![npm v5](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square)        | `>= v18` | **Current**     | 2024-01-11     | Unknown     |
+| Release Line                                             | Latest Version                                                                                         | Node.js  | [SSI](https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/single-step-apm/?tab=linuxhostorvm) | [K8s Injection](https://docs.datadoghq.com/tracing/trace_collection/library_injection_local/?tab=kubernetes) |Status          |Initial Release | End of Life |
+| :---:                                                    | :---:                                                                                                  | :---:    | :---:  | :---:  | :---:           | :---:          | :---:       |
+| [`v1`](https://github.com/DataDog/dd-trace-js/tree/v1.x) | ![npm v1](https://img.shields.io/npm/v/dd-trace/legacy-v1?color=white&label=%20&style=flat-square)     | `>= v12` | NO | NO | **End of Life** | 2021-07-13     | 2022-02-25  |
+| [`v2`](https://github.com/DataDog/dd-trace-js/tree/v2.x) | ![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=white&label=%20&style=flat-square) | `>= v12` | NO | NO | **End of Life** | 2022-01-28     | 2023-08-15  |
+| [`v3`](https://github.com/DataDog/dd-trace-js/tree/v3.x) | ![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=white&label=%20&style=flat-square) | `>= v14` | NO | YES | **End of Life** | 2022-08-15     | 2024-05-15  |
+| [`v4`](https://github.com/DataDog/dd-trace-js/tree/v4.x) | ![npm v4](https://img.shields.io/npm/v/dd-trace/latest-node16?color=white&label=%20&style=flat-square) | `>= v16` | YES | YES | **Maintenance**     | 2023-05-12     | 2025-01-11     |
+| [`v5`](https://github.com/DataDog/dd-trace-js/tree/v5.x) | ![npm v5](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square)        | `>= v18` | YES | YES | **Current**     | 2024-01-11     | Unknown     |
+
+* SSI = Single-Step Install
 
 We currently maintain two release lines, namely `v5`, and `v4`.
 Features and bug fixes that are merged are released to the `v5` line and, if appropriate, also `v4`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.30.0",
+  "version": "5.32.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -33,7 +33,7 @@
     "test:lambda:ci": "nyc --no-clean --include \"packages/dd-trace/src/lambda/**/*.js\" -- npm run test:lambda",
     "test:llmobs:sdk": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" --exclude \"packages/dd-trace/test/llmobs/plugins/**/*.spec.js\" \"packages/dd-trace/test/llmobs/**/*.spec.js\" ",
     "test:llmobs:sdk:ci": "nyc --no-clean --include \"packages/dd-trace/src/llmobs/**/*.js\" -- npm run test:llmobs:sdk",
-    "test:llmobs:plugins": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/dd-trace/test/llmobs/plugins/**/*.spec.js\"",
+    "test:llmobs:plugins": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/dd-trace/test/llmobs/plugins/@($(echo $PLUGINS))/*.spec.js\"",
     "test:llmobs:plugins:ci": "yarn services && nyc --no-clean --include \"packages/dd-trace/src/llmobs/**/*.js\" -- npm run test:llmobs:plugins",
     "test:plugins": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/datadog-instrumentations/test/@($(echo $PLUGINS)).spec.js\" \"packages/datadog-plugin-@($(echo $PLUGINS))/test/**/*.spec.js\"",
     "test:plugins:ci": "yarn services && nyc --no-clean --include \"packages/datadog-instrumentations/src/@($(echo $PLUGINS)).js\" --include \"packages/datadog-instrumentations/src/@($(echo $PLUGINS))/**/*.js\" --include \"packages/datadog-plugin-@($(echo $PLUGINS))/src/**/*.js\" -- npm run test:plugins",
@@ -81,8 +81,8 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@datadog/libdatadog": "^0.3.0",
-    "@datadog/native-appsec": "8.3.0",
+    "@datadog/libdatadog": "^0.4.0",
+    "@datadog/native-appsec": "8.4.0",
     "@datadog/native-iast-rewriter": "2.6.1",
     "@datadog/native-iast-taint-tracking": "3.2.0",
     "@datadog/native-metrics": "^3.1.0",
@@ -111,7 +111,8 @@
     "semver": "^7.5.4",
     "shell-quote": "^1.8.1",
     "source-map": "^0.7.4",
-    "tlhunter-sorted-set": "^0.1.0"
+    "tlhunter-sorted-set": "^0.1.0",
+    "ttl-set": "^1.0.0"
   },
   "devDependencies": {
     "@apollo/server": "^4.11.0",
@@ -145,7 +146,7 @@
     "jszip": "^3.5.0",
     "knex": "^2.4.2",
     "mkdirp": "^3.0.1",
-    "mocha": "^9",
+    "mocha": "^10",
     "msgpack-lite": "^0.1.26",
     "multer": "^1.4.5-lts.1",
     "nock": "^11.3.3",

package/packages/datadog-core/src/storage.js

@@ -21,8 +21,16 @@ class DatadogStorage {
     this._storage.exit(callback, ...args)
   }
 
-  getStore () {
-    const handle = this._storage.getStore()
+  // TODO: Refactor the Scope class to use a span-only store and remove this.
+  getHandle () {
+    return this._storage.getStore()
+  }
+
+  getStore (handle) {
+    if (!handle) {
+      handle = this._storage.getStore()
+    }
+
     return stores.get(handle)
   }
 
@@ -50,6 +58,7 @@ const storage = function (namespace) {
 storage.disable = legacyStorage.disable.bind(legacyStorage)
 storage.enterWith = legacyStorage.enterWith.bind(legacyStorage)
 storage.exit = legacyStorage.exit.bind(legacyStorage)
+storage.getHandle = legacyStorage.getHandle.bind(legacyStorage)
 storage.getStore = legacyStorage.getStore.bind(legacyStorage)
 storage.run = legacyStorage.run.bind(legacyStorage)
 

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

@@ -40,7 +40,7 @@ function wrapProcess (process) {
 addHook({
   name: 'aerospike',
   file: 'lib/commands/command.js',
-  versions: ['4', '5']
+  versions: ['4', '5', '6']
 },
 commandFactory => {
   return shimmer.wrapFunction(commandFactory, f => wrapCreateCommand(f))

package/packages/datadog-instrumentations/src/aws-sdk.js

@@ -167,7 +167,8 @@ function getChannelSuffix (name) {
     'sns',
     'sqs',
     'states',
-    'stepfunctions'
+    'stepfunctions',
+    'bedrock runtime'
   ].includes(name)
     ? name
     : 'default'

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

@@ -238,8 +238,9 @@ function wrapRun (pl, isLatestVersion) {
     asyncResource.runInAsyncScope(() => {
       testStartCh.publish(testStartPayload)
     })
+    const promises = {}
     try {
-      this.eventBroadcaster.on('envelope', shimmer.wrapFunction(null, () => (testCase) => {
+      this.eventBroadcaster.on('envelope', shimmer.wrapFunction(null, () => async (testCase) => {
         // Only supported from >=8.0.0
         if (testCase?.testCaseFinished) {
           const { testCaseFinished: { willBeRetried } } = testCase
@@ -253,17 +254,22 @@ function wrapRun (pl, isLatestVersion) {
             }
 
             const failedAttemptAsyncResource = numAttemptToAsyncResource.get(numAttempt)
-            const isRetry = numAttempt++ > 0
+            const isFirstAttempt = numAttempt++ === 0
+
+            if (promises.hitBreakpointPromise) {
+              await promises.hitBreakpointPromise
+            }
+
             failedAttemptAsyncResource.runInAsyncScope(() => {
               // the current span will be finished and a new one will be created
-              testRetryCh.publish({ isRetry, error })
+              testRetryCh.publish({ isFirstAttempt, error })
             })
 
             const newAsyncResource = new AsyncResource('bound-anonymous-fn')
             numAttemptToAsyncResource.set(numAttempt, newAsyncResource)
 
             newAsyncResource.runInAsyncScope(() => {
-              testStartCh.publish(testStartPayload) // a new span will be created
+              testStartCh.publish({ ...testStartPayload, promises }) // a new span will be created
             })
           }
         }
@@ -273,7 +279,7 @@ function wrapRun (pl, isLatestVersion) {
       asyncResource.runInAsyncScope(() => {
         promise = run.apply(this, arguments)
       })
-      promise.finally(() => {
+      promise.finally(async () => {
         const result = this.getWorstStepResult()
         const { status, skipReason } = isLatestVersion
           ? getStatusFromResultLatest(result)
@@ -296,6 +302,9 @@ function wrapRun (pl, isLatestVersion) {
 
         const error = getErrorFromCucumberResult(result)
 
+        if (promises.hitBreakpointPromise) {
+          await promises.hitBreakpointPromise
+        }
         attemptAsyncResource.runInAsyncScope(() => {
           testFinishCh.publish({ status, skipReason, error, isNew, isEfdRetry, isFlakyRetry: numAttempt > 0 })
         })

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

@@ -88,6 +88,7 @@ module.exports = {
   mysql2: () => require('../mysql2'),
   net: () => require('../net'),
   next: () => require('../next'),
+  'node-serialize': () => require('../node-serialize'),
   'node:child_process': () => require('../child_process'),
   'node:crypto': () => require('../crypto'),
   'node:dns': () => require('../dns'),
@@ -96,6 +97,7 @@ module.exports = {
   'node:https': () => require('../http'),
   'node:net': () => require('../net'),
   'node:url': () => require('../url'),
+  'node:vm': () => require('../vm'),
   nyc: () => require('../nyc'),
   oracledb: () => require('../oracledb'),
   openai: () => require('../openai'),
@@ -122,6 +124,7 @@ module.exports = {
   undici: () => require('../undici'),
   url: () => require('../url'),
   vitest: { esmFirst: true, fn: () => require('../vitest') },
+  vm: () => require('../vm'),
   when: () => require('../when'),
   winston: () => require('../winston'),
   workerpool: () => require('../mocha')

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

@@ -12,7 +12,8 @@ const {
   getTestParametersString,
   addEfdStringToTestName,
   removeEfdStringFromTestName,
-  getIsFaultyEarlyFlakeDetection
+  getIsFaultyEarlyFlakeDetection,
+  JEST_WORKER_LOGS_PAYLOAD_CODE
 } = require('../../dd-trace/src/plugins/util/test')
 const {
   getFormattedJestTestParameters,
@@ -30,12 +31,13 @@ const testSuiteFinishCh = channel('ci:jest:test-suite:finish')
 
 const workerReportTraceCh = channel('ci:jest:worker-report:trace')
 const workerReportCoverageCh = channel('ci:jest:worker-report:coverage')
+const workerReportLogsCh = channel('ci:jest:worker-report:logs')
 
 const testSuiteCodeCoverageCh = channel('ci:jest:test-suite:code-coverage')
 
 const testStartCh = channel('ci:jest:test:start')
 const testSkippedCh = channel('ci:jest:test:skip')
-const testRunFinishCh = channel('ci:jest:test:finish')
+const testFinishCh = channel('ci:jest:test:finish')
 const testErrCh = channel('ci:jest:test:err')
 
 const skippableSuitesCh = channel('ci:jest:test-suite:skippable')
@@ -75,6 +77,8 @@ const originalTestFns = new WeakMap()
 const retriedTestsToNumAttempts = new Map()
 const newTestsTestStatuses = new Map()
 
+const BREAKPOINT_HIT_GRACE_PERIOD_MS = 200
+
 // based on https://github.com/facebook/jest/blob/main/packages/jest-circus/src/formatNodeAssertErrors.ts#L41
 function formatJestError (errors) {
   let error
@@ -274,46 +278,70 @@ function getWrappedEnvironment (BaseEnvironment, jestVersion) {
         }
       }
       if (event.name === 'test_done') {
-        const probe = {}
+        let status = 'pass'
+        if (event.test.errors && event.test.errors.length) {
+          status = 'fail'
+        }
+        // restore in case it is retried
+        event.test.fn = originalTestFns.get(event.test)
+
+        // We'll store the test statuses of the retries
+        if (this.isEarlyFlakeDetectionEnabled) {
+          const testName = getJestTestName(event.test)
+          const originalTestName = removeEfdStringFromTestName(testName)
+          const isNewTest = retriedTestsToNumAttempts.has(originalTestName)
+          if (isNewTest) {
+            if (newTestsTestStatuses.has(originalTestName)) {
+              newTestsTestStatuses.get(originalTestName).push(status)
+            } else {
+              newTestsTestStatuses.set(originalTestName, [status])
+            }
+          }
+        }
+
+        const promises = {}
+        const numRetries = this.global[RETRY_TIMES]
+        const numTestExecutions = event.test?.invocations
+        const willBeRetried = numRetries > 0 && numTestExecutions - 1 < numRetries
+        const mightHitBreakpoint = this.isDiEnabled && numTestExecutions >= 2
+
         const asyncResource = asyncResources.get(event.test)
-        asyncResource.runInAsyncScope(() => {
-          let status = 'pass'
-          if (event.test.errors && event.test.errors.length) {
-            status = 'fail'
-            const numRetries = this.global[RETRY_TIMES]
-            const numTestExecutions = event.test?.invocations
-            const willBeRetried = numRetries > 0 && numTestExecutions - 1 < numRetries
-
-            const error = formatJestError(event.test.errors[0])
+
+        if (status === 'fail') {
+          asyncResource.runInAsyncScope(() => {
             testErrCh.publish({
-              error,
-              willBeRetried,
-              probe,
-              isDiEnabled: this.isDiEnabled
+              error: formatJestError(event.test.errors[0]),
+              shouldSetProbe: this.isDiEnabled && willBeRetried && numTestExecutions === 1,
+              promises
             })
-          }
-          testRunFinishCh.publish({
+          })
+        }
+
+        // After finishing it might take a bit for the snapshot to be handled.
+        // This means that tests retried with DI are BREAKPOINT_HIT_GRACE_PERIOD_MS slower at least.
+        if (status === 'fail' && mightHitBreakpoint) {
+          await new Promise(resolve => {
+            setTimeout(() => {
+              resolve()
+            }, BREAKPOINT_HIT_GRACE_PERIOD_MS)
+          })
+        }
+
+        asyncResource.runInAsyncScope(() => {
+          testFinishCh.publish({
             status,
-            testStartLine: getTestLineStart(event.test.asyncError, this.testSuite)
+            testStartLine: getTestLineStart(event.test.asyncError, this.testSuite),
+            promises,
+            shouldRemoveProbe: this.isDiEnabled && !willBeRetried
           })
-          // restore in case it is retried
-          event.test.fn = originalTestFns.get(event.test)
-          // We'll store the test statuses of the retries
-          if (this.isEarlyFlakeDetectionEnabled) {
-            const testName = getJestTestName(event.test)
-            const originalTestName = removeEfdStringFromTestName(testName)
-            const isNewTest = retriedTestsToNumAttempts.has(originalTestName)
-            if (isNewTest) {
-              if (newTestsTestStatuses.has(originalTestName)) {
-                newTestsTestStatuses.get(originalTestName).push(status)
-              } else {
-                newTestsTestStatuses.set(originalTestName, [status])
-              }
-            }
-          }
         })
-        if (probe.setProbePromise) {
-          await probe.setProbePromise
+
+        if (promises.isProbeReady) {
+          await promises.isProbeReady
+        }
+
+        if (promises.isProbeRemoved) {
+          await promises.isProbeRemoved
         }
       }
       if (event.name === 'test_skip' || event.name === 'test_todo') {
@@ -953,6 +981,12 @@ addHook({
       })
       return
     }
+    if (code === JEST_WORKER_LOGS_PAYLOAD_CODE) { // datadog logs payload
+      sessionAsyncResource.runInAsyncScope(() => {
+        workerReportLogsCh.publish(data)
+      })
+      return
+    }
     return _onMessage.apply(this, arguments)
   })
   return childProcessWorker

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

@@ -19,6 +19,7 @@ const skipCh = channel('ci:mocha:test:skip')
 // suite channels
 const testSuiteErrorCh = channel('ci:mocha:test-suite:error')
 
+const BREAKPOINT_HIT_GRACE_PERIOD_MS = 200
 const testToAr = new WeakMap()
 const originalFns = new WeakMap()
 const testToStartLine = new WeakMap()
@@ -73,7 +74,7 @@ function isMochaRetry (test) {
   return test._currentRetry !== undefined && test._currentRetry !== 0
 }
 
-function isLastRetry (test) {
+function getIsLastRetry (test) {
   return test._currentRetry === test._retries
 }
 
@@ -203,14 +204,28 @@ function getOnTestHandler (isMain) {
 }
 
 function getOnTestEndHandler () {
-  return function (test) {
+  return async function (test) {
     const asyncResource = getTestAsyncResource(test)
     const status = getTestStatus(test)
 
+    // After finishing it might take a bit for the snapshot to be handled.
+    // This means that tests retried with DI are BREAKPOINT_HIT_GRACE_PERIOD_MS slower at least.
+    if (test._ddShouldWaitForHitProbe || test._retriedTest?._ddShouldWaitForHitProbe) {
+      await new Promise((resolve) => {
+        setTimeout(() => {
+          resolve()
+        }, BREAKPOINT_HIT_GRACE_PERIOD_MS)
+      })
+    }
+
     // if there are afterEach to be run, we don't finish the test yet
     if (asyncResource && !test.parent._afterEach.length) {
       asyncResource.runInAsyncScope(() => {
-        testFinishCh.publish({ status, hasBeenRetried: isMochaRetry(test) })
+        testFinishCh.publish({
+          status,
+          hasBeenRetried: isMochaRetry(test),
+          isLastRetry: getIsLastRetry(test)
+        })
       })
     }
   }
@@ -220,16 +235,17 @@ function getOnHookEndHandler () {
   return function (hook) {
     const test = hook.ctx.currentTest
     if (test && hook.parent._afterEach.includes(hook)) { // only if it's an afterEach
-      const isLastAfterEach = hook.parent._afterEach.indexOf(hook) === hook.parent._afterEach.length - 1
-      if (test._retries > 0 && !isLastRetry(test)) {
+      const isLastRetry = getIsLastRetry(test)
+      if (test._retries > 0 && !isLastRetry) {
         return
       }
+      const isLastAfterEach = hook.parent._afterEach.indexOf(hook) === hook.parent._afterEach.length - 1
       if (isLastAfterEach) {
         const status = getTestStatus(test)
         const asyncResource = getTestAsyncResource(test)
         if (asyncResource) {
           asyncResource.runInAsyncScope(() => {
-            testFinishCh.publish({ status, hasBeenRetried: isMochaRetry(test) })
+            testFinishCh.publish({ status, hasBeenRetried: isMochaRetry(test), isLastRetry })
           })
         }
       }
@@ -286,7 +302,7 @@ function getOnTestRetryHandler () {
       const isFirstAttempt = test._currentRetry === 0
       const willBeRetried = test._currentRetry < test._retries
       asyncResource.runInAsyncScope(() => {
-        testRetryCh.publish({ isFirstAttempt, err, willBeRetried })
+        testRetryCh.publish({ isFirstAttempt, err, willBeRetried, test })
       })
     }
     const key = getTestToArKey(test)

package/packages/datadog-instrumentations/src/node-serialize.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const shimmer = require('../../datadog-shimmer')
+const { channel, addHook } = require('./helpers/instrument')
+
+const nodeUnserializeCh = channel('datadog:node-serialize:unserialize:start')
+
+function wrapUnserialize (serialize) {
+  return function wrappedUnserialize (obj) {
+    if (nodeUnserializeCh.hasSubscribers) {
+      nodeUnserializeCh.publish({ obj })
+    }
+
+    return serialize.apply(this, arguments)
+  }
+}
+
+addHook({ name: 'node-serialize', versions: ['0.0.4'] }, serialize => {
+  shimmer.wrap(serialize, 'unserialize', wrapUnserialize)
+
+  return serialize
+})

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

@@ -338,6 +338,8 @@ for (const shim of V4_PACKAGE_SHIMS) {
               })
           })
 
+          ch.end.publish(ctx)
+
           return apiProm
         })
       })