dd-trace 5.74.0 → 5.76.0

package/LICENSE-3rdparty.csv

@@ -14,6 +14,7 @@ require,@opentelemetry/resources,Apache license 2.0,Copyright OpenTelemetry Auth
 require,@isaacs/ttlcache,ISC,Copyright (c) 2022-2023 - Isaac Z. Schlueter and Contributors
 require,crypto-randomuuid,MIT,Copyright 2021 Node.js Foundation and contributors
 require,dc-polyfill,MIT,Copyright 2023 Datadog Inc.
+require,escape-string-regexp,MIT,Copyright Sindre Sorhus
 require,ignore,MIT,Copyright 2013 Kael Zhang and contributors
 require,import-in-the-middle,Apache license 2.0,Copyright 2021 Datadog Inc.
 require,istanbul-lib-coverage,BSD-3-Clause,Copyright 2012-2015 Yahoo! Inc.

package/ci/init.js

@@ -29,6 +29,7 @@ function detectTestWorkerType () {
   if (getEnvironmentVariable('MOCHA_WORKER_ID')) return 'mocha'
   if (getEnvironmentVariable('DD_PLAYWRIGHT_WORKER')) return 'playwright'
   if (getEnvironmentVariable('TINYPOOL_WORKER_ID')) return 'vitest'
+  if (getEnvironmentVariable('DD_VITEST_WORKER')) return 'vitest'
   return null
 }
 

package/index.d.ts

@@ -181,6 +181,7 @@ interface Tracer extends opentracing.Tracer {
 /** @hidden */
 interface Plugins {
   "aerospike": tracer.plugins.aerospike;
+  "ai": tracer.plugins.ai;
   "amqp10": tracer.plugins.amqp10;
   "amqplib": tracer.plugins.amqplib;
   "anthropic": tracer.plugins.anthropic;
@@ -1642,6 +1643,12 @@ declare namespace tracer {
      */
     interface aerospike extends Instrumentation {}
 
+    /**
+     * This plugin automatically instruments the
+     * [Vercel AI SDK](https://ai-sdk.dev/docs/introduction) module.
+     */
+    interface ai extends Instrumentation {}
+
     /**
      * This plugin automatically instruments the
      * [amqp10](https://github.com/noodlefrenzy/node-amqp10) module.
@@ -1698,12 +1705,6 @@ declare namespace tracer {
      * [aws-sdk](https://github.com/aws/aws-sdk-js) module.
      */
     interface aws_sdk extends Instrumentation {
-      /**
-       * Whether to add a suffix to the service name so that each AWS service has its own service name.
-       * @default true
-       */
-      splitByAwsService?: boolean;
-
       /**
        * Whether to inject all messages during batch AWS SQS, Kinesis, and SNS send operations. Normal
        * behavior is to inject the first message in batch send operations.
@@ -2821,7 +2822,10 @@ declare namespace tracer {
     redactionValuePattern?: string,
 
     /**
-     * Allows to enable security controls.
+     * Allows to enable security controls. This option is not supported when
+     * using ESM.
+     * @deprecated Please use the DD_IAST_SECURITY_CONTROLS_CONFIGURATION
+     * environment variable instead.
      */
     securityControlsConfiguration?: string,
 

package/loader-hook.mjs

@@ -1 +1,52 @@
-export * from 'import-in-the-middle/hook.mjs'
+import regexpEscape from 'escape-string-regexp'
+import * as iitm from 'import-in-the-middle/hook.mjs'
+import hooks from './packages/datadog-instrumentations/src/helpers/hooks.js'
+import configHelper from './packages/dd-trace/src/config-helper.js'
+
+// For some reason `getEnvironmentVariable` is not otherwise available to ESM.
+const env = configHelper.getEnvironmentVariable
+
+function initialize (data = {}) {
+  data.include ??= []
+  data.exclude ??= []
+
+  addInstrumentations(data)
+  addSecurityControls(data)
+  addExclusions(data)
+
+  return iitm.initialize(data)
+}
+
+function addInstrumentations (data) {
+  const instrumentations = Object.keys(hooks)
+
+  for (const moduleName of instrumentations) {
+    data.include.push(new RegExp(`node_modules/${moduleName}/(?!node_modules).+`), moduleName)
+  }
+}
+
+function addSecurityControls (data) {
+  const securityControls = (env('DD_IAST_SECURITY_CONTROLS_CONFIGURATION') || '')
+    .split(';')
+    .map(sc => sc.trim().split(':')[2])
+    .filter(Boolean)
+    .map(sc => sc.trim())
+
+  for (const subpath of securityControls) {
+    data.include.push(new RegExp(regexpEscape(subpath)))
+  }
+}
+
+function addExclusions (data) {
+  data.exclude.push(
+    /middle/,
+    /langsmith/,
+    /openai\/_shims/,
+    /openai\/resources\/chat\/completions\/messages/,
+    /openai\/agents-core\/dist\/shims/,
+    /@anthropic-ai\/sdk\/_shims/
+  )
+}
+
+export { initialize }
+export { load, getFormat, resolve, getSource } from 'import-in-the-middle/hook.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.74.0",
+  "version": "5.76.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -125,8 +125,8 @@
     "@datadog/native-appsec": "10.3.0",
     "@datadog/native-iast-taint-tracking": "4.0.0",
     "@datadog/native-metrics": "3.1.1",
-    "@datadog/openfeature-node-server": "0.1.0-preview.12",
-    "@datadog/pprof": "5.11.1",
+    "@datadog/openfeature-node-server": "0.1.0-preview.13",
+    "@datadog/pprof": "5.12.0",
     "@datadog/sketches-js": "2.1.1",
     "@datadog/wasm-js-rewriter": "4.0.1",
     "@isaacs/ttlcache": "^1.4.1",
@@ -136,6 +136,7 @@
     "@opentelemetry/resources": ">=1.0.0 <1.10.0",
     "crypto-randomuuid": "^1.0.0",
     "dc-polyfill": "^0.1.10",
+    "escape-string-regexp": "^5.0.0",
     "ignore": "^7.0.5",
     "import-in-the-middle": "^1.14.2",
     "istanbul-lib-coverage": "^3.2.2",
@@ -158,25 +159,13 @@
     "tlhunter-sorted-set": "^0.1.0",
     "ttl-set": "^1.0.0"
   },
-  "peerDependencies": {
-    "@openfeature/core": "^1.9.0",
-    "@openfeature/server-sdk": "~1.20.0"
-  },
-  "peerDependenciesMeta": {
-    "@openfeature/core": {
-      "optional": true
-    },
-    "@openfeature/server-sdk": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "@babel/helpers": "^7.27.6",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.29.0",
     "@msgpack/msgpack": "^3.1.2",
-    "@openfeature/core": "^1.8.1",
-    "@openfeature/server-sdk": "~1.20.0",
+    "@openfeature/core": "^1.9.0",
+    "@openfeature/server-sdk": "^1.20.0",
     "@stylistic/eslint-plugin": "^5.0.0",
     "@types/chai": "^4.3.16",
     "@types/mocha": "^10.0.10",
@@ -214,7 +203,7 @@
     "tap": "^16.3.10",
     "tiktoken": "^1.0.21",
     "typescript": "^5.9.2",
-    "workerpool": "^9.2.0",
+    "workerpool": "^10.0.0",
     "yaml": "^2.8.0",
     "yarn-deduplicate": "^6.0.2"
   }

package/packages/datadog-esbuild/index.js

@@ -114,6 +114,7 @@ ${build.initialOptions.banner.js}`
   }
 
   try {
+    // eslint-disable-next-line n/no-unpublished-require
     require.resolve('@openfeature/core')
   } catch (error) {
     build.initialOptions.external ??= []

package/packages/datadog-instrumentations/src/cookie-parser.js

@@ -25,8 +25,6 @@ addHook({
   name: 'cookie-parser',
   versions: ['>=1.0.0']
 }, cookieParser => {
-  // This prevents the non default export from entering the wrapping process
-  if (cookieParser.default) return cookieParser
   return shimmer.wrapFunction(cookieParser, cookieParser => function () {
     const cookieMiddleware = cookieParser.apply(this, arguments)
 

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

@@ -259,7 +259,7 @@ function wrapRun (pl, isLatestVersion, version) {
     testStartCh.runStores(ctx, () => {})
     const promises = {}
     try {
-      this.eventBroadcaster.on('envelope', shimmer.wrapFunction(null, () => async (testCase) => {
+      this.eventBroadcaster.on('envelope', async (testCase) => {
         // Only supported from >=8.0.0
         if (testCase?.testCaseFinished) {
           const { testCaseFinished: { willBeRetried } } = testCase
@@ -289,7 +289,7 @@ function wrapRun (pl, isLatestVersion, version) {
             testStartCh.runStores(newCtx, () => {})
           }
         }
-      }))
+      })
       let promise
 
       testFnCh.runStores(ctx, () => {

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

@@ -37,6 +37,5 @@ addHook({
   name: 'express-session',
   versions: ['>=1.5.0']
 }, session => {
-  if (session.default) return session
   return shimmer.wrapFunction(session, wrapSession)
 })

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

@@ -82,12 +82,7 @@ function createWrapQueryCallback (options) {
 
       const cb = arguments[arguments.length - 1]
       const ctx = { sql, conf: options }
-
-      if (typeof cb !== 'function') {
-        arguments.length += 1
-      }
-
-      arguments[arguments.length - 1] = shimmer.wrapFunction(cb, cb => function (err) {
+      const wrapper = (cb) => function (err) {
         if (err) {
           ctx.error = err
           errorCh.publish(ctx)
@@ -96,7 +91,14 @@ function createWrapQueryCallback (options) {
         return typeof cb === 'function'
           ? finishCh.runStores(ctx, cb, this, ...arguments)
           : finishCh.publish(ctx)
-      })
+      }
+
+      if (typeof cb === 'function') {
+        arguments[arguments.length - 1] = shimmer.wrapFunction(cb, wrapper)
+      } else {
+        arguments.length += 1
+        arguments[arguments.length - 1] = wrapper()
+      }
 
       return startCh.runStores(ctx, query, this, ...arguments)
     }

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

@@ -22,6 +22,14 @@ const V4_PACKAGE_SHIMS = [
     methods: ['create'],
     streamedResponse: true
   },
+  {
+    file: 'resources/responses/responses',
+    targetClass: 'Responses',
+    baseResource: 'responses',
+    methods: ['create'],
+    streamedResponse: true,
+    versions: ['>=4.87.0']
+  },
   {
     file: 'resources/embeddings',
     targetClass: 'Embeddings',

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

@@ -15,6 +15,7 @@ const { DD_MAJOR } = require('../../../version')
 
 const testStartCh = channel('ci:playwright:test:start')
 const testFinishCh = channel('ci:playwright:test:finish')
+const testSkipCh = channel('ci:playwright:test:skip')
 
 const testSessionStartCh = channel('ci:playwright:session:start')
 const testSessionFinishCh = channel('ci:playwright:session:finish')
@@ -37,6 +38,8 @@ const testSuiteToTestStatuses = new Map()
 const testSuiteToErrors = new Map()
 const testsToTestStatuses = new Map()
 
+const RUM_FLUSH_WAIT_TIME = 1000
+
 let applyRepeatEachIndex = null
 
 let startedSuites = []
@@ -65,6 +68,8 @@ let modifiedFiles = {}
 const quarantinedOrDisabledTestsAttemptToFix = []
 let quarantinedButNotAttemptToFixFqns = new Set()
 let rootDir = ''
+let sessionProjects = []
+
 const MINIMUM_SUPPORTED_VERSION_RANGE_EFD = '>=1.38.0' // TODO: remove this once we drop support for v5
 
 function isValidKnownTests (receivedKnownTests) {
@@ -285,7 +290,12 @@ function getTestFullname (test) {
   return names.join(' ')
 }
 
-function testBeginHandler (test, browserName, isMainProcess) {
+function shouldFinishTestSuite (testSuiteAbsolutePath) {
+  const remainingTests = remainingTestsByFile[testSuiteAbsolutePath]
+  return !remainingTests.length || remainingTests.every(test => test.expectedStatus === 'skipped')
+}
+
+function testBeginHandler (test, browserName, shouldCreateTestSpan) {
   const {
     _requireFile: testSuiteAbsolutePath,
     location: {
@@ -297,6 +307,10 @@ function testBeginHandler (test, browserName, isMainProcess) {
   if (_type === 'beforeAll' || _type === 'afterAll') {
     return
   }
+  // this means that a skipped test is being handled
+  if (!remainingTestsByFile[testSuiteAbsolutePath].length) {
+    return
+  }
 
   const isNewTestSuite = !startedSuites.includes(testSuiteAbsolutePath)
 
@@ -313,7 +327,7 @@ function testBeginHandler (test, browserName, isMainProcess) {
   }
 
   // this handles tests that do not go through the worker process (because they're skipped)
-  if (isMainProcess) {
+  if (shouldCreateTestSpan) {
     const testName = getTestFullname(test)
     const testCtx = {
       testName,
@@ -328,8 +342,20 @@ function testBeginHandler (test, browserName, isMainProcess) {
   }
 }
 
-function testEndHandler (test, annotations, testStatus, error, isTimeout, isMainProcess) {
-  const { _requireFile: testSuiteAbsolutePath, results, _type } = test
+function testEndHandler ({
+  test,
+  annotations,
+  testStatus,
+  error,
+  isTimeout,
+  shouldCreateTestSpan,
+  projects
+}) {
+  const {
+    _requireFile: testSuiteAbsolutePath,
+    results,
+    _type,
+  } = test
 
   let annotationTags
   if (annotations.length) {
@@ -368,31 +394,34 @@ function testEndHandler (test, annotations, testStatus, error, isTimeout, isMain
   }
 
   // this handles tests that do not go through the worker process (because they're skipped)
-  if (isMainProcess) {
+  if (shouldCreateTestSpan) {
     const testResult = results.at(-1)
     const testCtx = testToCtx.get(test)
     const isAtrRetry = testResult?.retry > 0 &&
       isFlakyTestRetriesEnabled &&
       !test._ddIsAttemptToFix &&
       !test._ddIsEfdRetry
-    testFinishCh.publish({
-      testStatus,
-      steps: testResult?.steps || [],
-      isRetry: testResult?.retry > 0,
-      error,
-      extraTags: annotationTags,
-      isNew: test._ddIsNew,
-      isAttemptToFix: test._ddIsAttemptToFix,
-      isAttemptToFixRetry: test._ddIsAttemptToFixRetry,
-      isQuarantined: test._ddIsQuarantined,
-      isEfdRetry: test._ddIsEfdRetry,
-      hasFailedAllRetries: test._ddHasFailedAllRetries,
-      hasPassedAttemptToFixRetries: test._ddHasPassedAttemptToFixRetries,
-      hasFailedAttemptToFixRetries: test._ddHasFailedAttemptToFixRetries,
-      isAtrRetry,
-      isModified: test._ddIsModified,
-      ...testCtx.currentStore
-    })
+    // if there is no testCtx, the skipped test will be created later
+    if (testCtx) {
+      testFinishCh.publish({
+        testStatus,
+        steps: testResult?.steps || [],
+        isRetry: testResult?.retry > 0,
+        error,
+        extraTags: annotationTags,
+        isNew: test._ddIsNew,
+        isAttemptToFix: test._ddIsAttemptToFix,
+        isAttemptToFixRetry: test._ddIsAttemptToFixRetry,
+        isQuarantined: test._ddIsQuarantined,
+        isEfdRetry: test._ddIsEfdRetry,
+        hasFailedAllRetries: test._ddHasFailedAllRetries,
+        hasPassedAttemptToFixRetries: test._ddHasPassedAttemptToFixRetries,
+        hasFailedAttemptToFixRetries: test._ddHasFailedAttemptToFixRetries,
+        isAtrRetry,
+        isModified: test._ddIsModified,
+        ...testCtx.currentStore
+      })
+    }
   }
 
   if (testSuiteToTestStatuses.has(testSuiteAbsolutePath)) {
@@ -410,8 +439,25 @@ function testEndHandler (test, annotations, testStatus, error, isTimeout, isMain
       .filter(currentTest => currentTest !== test)
   }
 
-  // Last test, we finish the suite
-  if (!remainingTestsByFile[testSuiteAbsolutePath].length) {
+  if (shouldFinishTestSuite(testSuiteAbsolutePath)) {
+    const skippedTests = remainingTestsByFile[testSuiteAbsolutePath]
+      .filter(test => test.expectedStatus === 'skipped')
+
+    for (const test of skippedTests) {
+      const browserName = getBrowserNameFromProjects(projects, test)
+      testSkipCh.publish({
+        testName: getTestFullname(test),
+        testSuiteAbsolutePath,
+        testSourceLine: test.location.line,
+        browserName,
+        isNew: test._ddIsNew,
+        isDisabled: test._ddIsDisabled,
+        isModified: test._ddIsModified,
+        isQuarantined: test._ddIsQuarantined
+      })
+    }
+    remainingTestsByFile[testSuiteAbsolutePath] = []
+
     const testStatuses = testSuiteToTestStatuses.get(testSuiteAbsolutePath)
     let testSuiteStatus = 'pass'
     if (testStatuses.includes('fail')) {
@@ -450,10 +496,14 @@ function dispatcherHook (dispatcherExport) {
   shimmer.wrap(dispatcherExport.Dispatcher.prototype, '_createWorker', createWorker => function () {
     const dispatcher = this
     const worker = createWorker.apply(this, arguments)
+    const projects = getProjectsFromDispatcher(dispatcher)
+    sessionProjects = projects
+
+    // for older versions of playwright, `shouldCreateTestSpan` should always be true,
+    // since the `_runTest` function wrapper is not available for older versions
     worker.process.on('message', ({ method, params }) => {
       if (method === 'testBegin') {
         const { test } = dispatcher._testById.get(params.testId)
-        const projects = getProjectsFromDispatcher(dispatcher)
         const browser = getBrowserNameFromProjects(projects, test)
         testBeginHandler(test, browser, true)
       } else if (method === 'testEnd') {
@@ -464,12 +514,15 @@ function dispatcherHook (dispatcherExport) {
 
         const isTimeout = testResult.status === 'timedOut'
         testEndHandler(
-          test,
-          params.annotations,
-          STATUS_TO_TEST_STATUS[testResult.status],
-          testResult.error,
-          isTimeout,
-          true
+          {
+            test,
+            annotations: params.annotations,
+            testStatus: STATUS_TO_TEST_STATUS[testResult.status],
+            error: testResult.error,
+            isTimeout,
+            shouldCreateTestSpan: true,
+            projects
+          }
         )
       }
     })
@@ -484,18 +537,31 @@ function dispatcherHookNew (dispatcherExport, runWrapper) {
   shimmer.wrap(dispatcherExport.Dispatcher.prototype, '_createWorker', createWorker => function () {
     const dispatcher = this
     const worker = createWorker.apply(this, arguments)
+    const projects = getProjectsFromDispatcher(dispatcher)
+    sessionProjects = projects
 
     worker.on('testBegin', ({ testId }) => {
       const test = getTestByTestId(dispatcher, testId)
-      const projects = getProjectsFromDispatcher(dispatcher)
       const browser = getBrowserNameFromProjects(projects, test)
-      testBeginHandler(test, browser, false)
+      const shouldCreateTestSpan = test.expectedStatus === 'skipped'
+      testBeginHandler(test, browser, shouldCreateTestSpan)
     })
     worker.on('testEnd', ({ testId, status, errors, annotations }) => {
       const test = getTestByTestId(dispatcher, testId)
 
       const isTimeout = status === 'timedOut'
-      testEndHandler(test, annotations, STATUS_TO_TEST_STATUS[status], errors && errors[0], isTimeout, false)
+      const shouldCreateTestSpan = test.expectedStatus === 'skipped'
+      testEndHandler(
+        {
+          test,
+          annotations,
+          testStatus: STATUS_TO_TEST_STATUS[status],
+          error: errors && errors[0],
+          isTimeout,
+          shouldCreateTestSpan,
+          projects
+        }
+      )
       const testResult = test.results.at(-1)
       const isAtrRetry = testResult?.retry > 0 &&
         isFlakyTestRetriesEnabled &&
@@ -625,6 +691,9 @@ function runAllTestsWrapper (runAllTests, playwrightVersion) {
 
     let runAllTestsReturn = await runAllTests.apply(this, arguments)
 
+    // Tests that have only skipped tests may reach this point
+    // Skipped tests may or may not go through `testBegin` or `testEnd`
+    // depending on the playwright configuration
     Object.values(remainingTestsByFile).forEach(tests => {
       // `tests` should normally be empty, but if it isn't,
       // there were tests that did not go through `testBegin` or `testEnd`,
@@ -632,7 +701,15 @@ function runAllTestsWrapper (runAllTests, playwrightVersion) {
       tests.forEach(test => {
         const browser = getBrowserNameFromProjects(projects, test)
         testBeginHandler(test, browser, true)
-        testEndHandler(test, [], 'skip', null, false, true)
+        testEndHandler({
+          test,
+          annotations: [],
+          testStatus: 'skip',
+          error: null,
+          isTimeout: false,
+          shouldCreateTestSpan: true,
+          projects
+        })
       })
     })
 
@@ -1007,6 +1084,9 @@ addHook({
   const stepInfoByStepId = {}
 
   shimmer.wrap(workerPackage.WorkerMain.prototype, '_runTest', _runTest => async function (test) {
+    if (test.expectedStatus === 'skipped') {
+      return _runTest.apply(this, arguments)
+    }
     steps = []
 
     const {
@@ -1060,6 +1140,8 @@ addHook({
                 })
 
                 if (isRumActive) {
+                  // Give some time RUM to flush data, similar to what we do in selenium
+                  await new Promise(resolve => setTimeout(resolve, RUM_FLUSH_WAIT_TIME))
                   const url = page.url()
                   if (url) {
                     const domain = new URL(url).hostname
@@ -1067,9 +1149,10 @@ addHook({
                       name: 'datadog-ci-visibility-test-execution-id',
                       value: '',
                       domain,
-                      expires: 0,
                       path: '/'
                     }])
+                  } else {
+                    log.error('RUM is active but page.url() is not available')
                   }
                 }
               }
@@ -1176,3 +1259,46 @@ addHook({
 
   return workerPackage
 })
+
+function generateSummaryWrapper (generateSummary) {
+  return function () {
+    for (const test of this.suite.allTests()) {
+      // https://github.com/microsoft/playwright/blob/bf92ffecff6f30a292b53430dbaee0207e0c61ad/packages/playwright/src/reporters/base.ts#L279
+      const didNotRun = test.outcome() === 'skipped' &&
+        (!test.results.length || test.expectedStatus !== 'skipped')
+      if (didNotRun) {
+        const {
+          _requireFile: testSuiteAbsolutePath,
+          location: { line: testSourceLine },
+        } = test
+        const browserName = getBrowserNameFromProjects(sessionProjects, test)
+
+        testSkipCh.publish({
+          testName: getTestFullname(test),
+          testSuiteAbsolutePath,
+          testSourceLine,
+          browserName,
+        })
+      }
+    }
+    return generateSummary.apply(this, arguments)
+  }
+}
+
+// If a playwright project B has a dependency on project A,
+// and project A fails, the tests in project B will not run.
+// This hook is used to report tests that did not run as skipped.
+// Note: this is different from tests skipped via test.skip() or test.fixme()
+addHook({
+  name: 'playwright',
+  file: 'lib/reporters/base.js',
+  versions: ['>=1.38.0']
+}, (reportersPackage) => {
+  // v1.50.0 changed the name of the base reporter from BaseReporter to TerminalReporter
+  if (reportersPackage.TerminalReporter) {
+    shimmer.wrap(reportersPackage.TerminalReporter.prototype, 'generateSummary', generateSummaryWrapper)
+  } else if (reportersPackage.BaseReporter) {
+    shimmer.wrap(reportersPackage.BaseReporter.prototype, 'generateSummary', generateSummaryWrapper)
+  }
+  return reportersPackage
+})