dd-trace 5.72.0 → 5.73.0

package/LICENSE-3rdparty.csv

@@ -64,6 +64,8 @@ dev,globals,MIT,Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://si
 dev,graphql,MIT,Copyright 2015 Facebook Inc.
 dev,jszip,MIT,Copyright 2015-2016 Stuart Knightley and contributors
 dev,mocha,MIT,Copyright 2011-2018 JS Foundation and contributors https://js.foundation
+dev,mocha-multi-reporters,MIT,Copyright 2015-2019 Yousaf Nabi and Stanley Ng
+dev,mocha-junit-reporter,MIT, Copyright 2015 Michael Allen
 dev,multer,MIT,Copyright 2014 Hage Yaapa
 dev,nock,MIT,Copyright 2017 Pedro Teixeira and other contributors
 dev,nyc,ISC,Copyright 2015 Contributors

package/index.d.ts

@@ -2938,6 +2938,15 @@ declare namespace tracer {
        */
       submitEvaluation (spanContext: llmobs.ExportedLLMObsSpan, options: llmobs.EvaluationOptions): void
 
+
+      /**
+       * Annotates all spans, including auto-instrumented spans, with the provided tags created in the context of the callback function.
+       * @param options The annotation context options.
+       * @param fn The callback over which to apply the annotation context options.
+       * @returns The result of the function.
+       */
+      annotationContext<T> (options: llmobs.AnnotationContextOptions, fn: () => T): T
+
       /**
        * Flushes any remaining spans and evaluation metrics to LLM Observability.
        */
@@ -3099,6 +3108,18 @@ declare namespace tracer {
       tags?: { [key: string]: any }
     }
 
+    interface AnnotationContextOptions {
+      /**
+       * Dictionary of JSON serializable key-value tag pairs to set or update on the LLMObs span regarding the span's context.
+       */
+      tags?: { [key: string]: any },
+
+      /**
+       * Set to override the span name for any spans annotated within the returned context.
+       */
+      name?: string,
+    }
+
     /**
      * An object containing the span ID and trace ID of interest
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.72.0",
+  "version": "5.73.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -44,7 +44,7 @@
     "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/@($(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-plugin-@($(echo $PLUGINS))/test/**/*.spec.js\"",
+    "test:plugins": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/datadog-plugin-@($(echo $PLUGINS))/test/**/@($(echo ${SPEC:-'*'})).spec.js\"",
     "test:plugins:ci": "yarn services && nyc --no-clean --include \"packages/datadog-plugin-@($(echo $PLUGINS))/src/**/*.js\" -- npm run test:plugins",
     "test:plugins:ci:flaky": "yarn services && nyc --no-clean --include \"packages/datadog-plugin-@($(echo $PLUGINS))/src/**/*.js\" -- npm run test:plugins -- --bail --retries 2",
     "test:plugins:upstream": "node ./packages/dd-trace/test/plugins/suite.js",
@@ -120,10 +120,10 @@
   ],
   "dependencies": {
     "@datadog/libdatadog": "0.7.0",
-    "@datadog/native-appsec": "10.2.1",
+    "@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.10",
+    "@datadog/openfeature-node-server": "0.1.0-preview.12",
     "@datadog/pprof": "5.11.1",
     "@datadog/sketches-js": "2.1.1",
     "@datadog/wasm-js-rewriter": "4.0.1",
@@ -158,7 +158,7 @@
   },
   "peerDependencies": {
     "@openfeature/core": "^1.9.0",
-    "@openfeature/server-sdk": "~1.18.0"
+    "@openfeature/server-sdk": "~1.19.0"
   },
   "peerDependenciesMeta": {
     "@openfeature/core": {
@@ -174,7 +174,7 @@
     "@eslint/js": "^9.29.0",
     "@msgpack/msgpack": "^3.1.2",
     "@openfeature/core": "^1.8.1",
-    "@openfeature/server-sdk": "~1.18.0",
+    "@openfeature/server-sdk": "~1.19.0",
     "@stylistic/eslint-plugin": "^5.0.0",
     "@types/chai": "^4.3.16",
     "@types/mocha": "^10.0.10",
@@ -198,6 +198,8 @@
     "graphql": "*",
     "jszip": "^3.10.1",
     "mocha": "^11.6.0",
+    "mocha-junit-reporter": "^2.2.1",
+    "mocha-multi-reporters": "^1.5.1",
     "multer": "^2.0.2",
     "nock": "^13.5.6",
     "nyc": "^15.1.0",

package/packages/datadog-esbuild/index.js

@@ -115,6 +115,14 @@ module.exports.setup = function (build) {
       ${isSourceMapEnabled ? `globalThis.__DD_ESBUILD_BASEPATH = '${require('../dd-trace/src/util').ddBasePath}';` : ''}
 ${build.initialOptions.banner.js}`
   }
+
+  try {
+    require.resolve('@openfeature/core')
+  } catch (error) {
+    build.initialOptions.external ??= []
+    build.initialOptions.external.push('@openfeature/core')
+  }
+
   if (isESMBuild(build)) {
     if (!build.initialOptions.banner.js.includes('import { createRequire as $dd_createRequire } from \'module\'')) {
       build.initialOptions.banner.js = `import { createRequire as $dd_createRequire } from 'module';

package/packages/datadog-instrumentations/src/azure-service-bus.js

@@ -1,38 +1,65 @@
 'use strict'
 
 const {
-  channel,
   addHook
 } = require('./helpers/instrument')
 
 const shimmer = require('../../datadog-shimmer')
+const dc = require('dc-polyfill')
 
-const producerStartCh = channel('apm:azure-service-bus:send:start')
-const producerErrorCh = channel('apm:azure-service-bus:send:error')
-const producerFinishCh = channel('apm:azure-service-bus:send:finish')
+const producerCh = dc.tracingChannel('apm:azure-service-bus:send')
 
 addHook({ name: '@azure/service-bus', versions: ['>=7.9.2'], patchDefault: false }, (obj) => {
   const ServiceBusClient = obj.ServiceBusClient
-  shimmer.wrap(ServiceBusClient.prototype, 'createSender', createSender => function (queueOrTopicName) {
-    const sender = createSender.apply(this, arguments)
-    shimmer.wrap(sender._sender, 'send', send => function (msg) {
-      const ctx = { sender, msg }
-      return producerStartCh.runStores(ctx, () => {
-        return send.apply(this, arguments)
-          .then(
-            response => {
-              producerFinishCh.publish(ctx)
-            },
-            error => {
-              ctx.error = error
-              producerErrorCh.publish(ctx)
-              producerFinishCh.publish(ctx)
-              throw error
-            }
+  let didItShim = false
+  shimmer.wrap(ServiceBusClient.prototype, 'createSender',
+    createSender => function (queueOrTopicName) {
+      const sender = createSender.apply(this, arguments)
+      if (didItShim) return sender
+      const senderPrototype = sender.constructor.prototype
+      const senderSenderPrototype = sender._sender.constructor.prototype
+      shimmer.wrap(senderPrototype, 'scheduleMessages', scheduleMessages =>
+        function (msg, scheduledEnqueueTimeUtc) {
+          const functionName = scheduleMessages.name
+          const config = this._context.config
+          const entityPath = this._entityPath
+          return producerCh.tracePromise(
+            scheduleMessages,
+            { config, entityPath, functionName, msg, scheduledEnqueueTimeUtc },
+            this, ...arguments
           )
+        })
+
+      shimmer.wrap(senderPrototype, 'createMessageBatch', createMessageBatch => async function () {
+        const batch = await createMessageBatch.apply(this, arguments)
+        shimmer.wrap(batch.constructor.prototype, 'tryAddMessage', tryAddMessage => function (msg) {
+          const functionName = tryAddMessage.name
+          const config = this._context.config
+          return producerCh.tracePromise(
+            tryAddMessage, { config, functionName, batch, msg }, this, ...arguments)
+        })
+        return batch
+      })
+
+      shimmer.wrap(senderSenderPrototype, 'send', send => function (msg) {
+        const functionName = send.name
+        const config = this._context.config
+        const entityPath = this.entityPath
+        return producerCh.tracePromise(
+          send, { config, entityPath, functionName, msg }, this, ...arguments
+        )
+      })
+
+      shimmer.wrap(senderSenderPrototype, 'sendBatch', sendBatch => function (msg) {
+        const functionName = sendBatch.name
+        const config = this._context.config
+        const entityPath = this.entityPath
+        return producerCh.tracePromise(
+          sendBatch, { config, entityPath, functionName, msg }, this, ...arguments
+        )
       })
+      didItShim = true
+      return sender
     })
-    return sender
-  })
   return obj
 })

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

@@ -25,6 +25,8 @@ 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/jest.js

@@ -29,6 +29,7 @@ const testSessionConfigurationCh = channel('ci:jest:session:configuration')
 
 const testSuiteStartCh = channel('ci:jest:test-suite:start')
 const testSuiteFinishCh = channel('ci:jest:test-suite:finish')
+const testSuiteErrorCh = channel('ci:jest:test-suite:error')
 
 const workerReportTraceCh = channel('ci:jest:worker-report:trace')
 const workerReportCoverageCh = channel('ci:jest:worker-report:coverage')
@@ -397,7 +398,8 @@ function getWrappedEnvironment (BaseEnvironment, jestVersion) {
           isJestRetry,
           isDisabled,
           isQuarantined,
-          isModified
+          isModified,
+          testSuiteAbsolutePath: this.testSuiteAbsolutePath
         }
         testContexts.set(event.test, ctx)
 
@@ -809,11 +811,15 @@ function getCliWrapper (isNewJestVersion) {
 
         try {
           const { err, testManagementTests: receivedTestManagementTests } = await testManagementTestsPromise
-          if (!err) {
+          if (err) {
+            isTestManagementTestsEnabled = false
+            testManagementTests = {}
+          } else {
             testManagementTests = receivedTestManagementTests
           }
         } catch (err) {
           log.error('Jest test management tests error', err)
+          isTestManagementTestsEnabled = false
         }
       }
 
@@ -1092,7 +1098,8 @@ function jestAdapterWrapper (jestAdapter, jestVersion) {
       testEnvironmentOptions: environment.testEnvironmentOptions,
       testSourceFile: environment.testSourceFile,
       displayName: environment.displayName,
-      frameworkVersion: jestVersion
+      frameworkVersion: jestVersion,
+      testSuiteAbsolutePath: environment.testSuiteAbsolutePath
     })
     return adapter.apply(this, arguments).then(suiteResults => {
       const { numFailingTests, skipped, failureMessage: errorMessage } = suiteResults
@@ -1116,12 +1123,17 @@ function jestAdapterWrapper (jestAdapter, jestVersion) {
         const coverageFiles = getFilesWithPath(getCoveredFilenamesFromCoverage(environment.global.__coverage__))
         const mockedFiles = getFilesWithPath(testSuiteMockedFiles.get(environment.testSuiteAbsolutePath) || [])
 
-        testSuiteCodeCoverageCh.publish({ coverageFiles, testSuite: environment.testSourceFile, mockedFiles })
+        testSuiteCodeCoverageCh.publish({
+          coverageFiles,
+          testSuite: environment.testSourceFile,
+          mockedFiles,
+          testSuiteAbsolutePath: environment.testSuiteAbsolutePath
+        })
       }
-      testSuiteFinishCh.publish({ status, errorMessage })
+      testSuiteFinishCh.publish({ status, errorMessage, testSuiteAbsolutePath: environment.testSuiteAbsolutePath })
       return suiteResults
     }).catch(error => {
-      testSuiteFinishCh.publish({ status: 'fail', error })
+      testSuiteFinishCh.publish({ status: 'fail', error, testSuiteAbsolutePath: environment.testSuiteAbsolutePath })
       throw error
     })
   })
@@ -1301,16 +1313,49 @@ addHook({
   })
 
   shimmer.wrap(Runtime.prototype, 'requireModuleOrMock', requireModuleOrMock => function (from, moduleName) {
-    // TODO: do this for every library that we instrument
-    if (LIBRARIES_BYPASSING_JEST_REQUIRE_ENGINE.has(moduleName)) {
-      // To bypass jest's own require engine
-      return this._requireCoreModule(moduleName)
+    // `requireModuleOrMock` may log errors to the console. If we don't remove ourselves
+    // from the stack trace, the user might see a useless stack trace rather than the error
+    // that `jest` tries to show.
+    const originalPrepareStackTrace = Error.prepareStackTrace
+    Error.prepareStackTrace = function (error, structuredStackTrace) {
+      const filteredStackTrace = structuredStackTrace
+        .filter(callSite => !callSite.getFileName()?.includes('datadog-instrumentations/src/jest.js'))
+
+      return originalPrepareStackTrace(error, filteredStackTrace)
     }
-    // This means that `@fast-check/jest` is used in the test file.
-    if (moduleName === '@fast-check/jest') {
-      testSuiteAbsolutePathsWithFastCheck.add(this._testPath)
+    try {
+      // TODO: do this for every library that we instrument
+      if (LIBRARIES_BYPASSING_JEST_REQUIRE_ENGINE.has(moduleName)) {
+        // To bypass jest's own require engine
+        return this._requireCoreModule(moduleName)
+      }
+      // This means that `@fast-check/jest` is used in the test file.
+      if (moduleName === '@fast-check/jest') {
+        testSuiteAbsolutePathsWithFastCheck.add(this._testPath)
+      }
+      const returnedValue = requireModuleOrMock.apply(this, arguments)
+      if (process.exitCode === 1) {
+        if (this.loggedReferenceErrors.size > 0) {
+          const errorMessage = [...this.loggedReferenceErrors][0]
+          testSuiteErrorCh.publish({
+            errorMessage,
+            testSuiteAbsolutePath: this._testPath
+          })
+        } else {
+          testSuiteErrorCh.publish({
+            errorMessage: 'An error occurred while importing a module',
+            testSuiteAbsolutePath: this._testPath
+          })
+        }
+      }
+      return returnedValue
+    } catch (error) {
+      testSuiteErrorCh.publish({ error, testSuiteAbsolutePath: this._testPath })
+      throw error
+    } finally {
+      // Restore original prepareStackTrace
+      Error.prepareStackTrace = originalPrepareStackTrace
     }
-    return requireModuleOrMock.apply(this, arguments)
   })
 
   return runtimePackage

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

@@ -163,14 +163,13 @@ function runnableWrapper (RunnablePackage, libraryConfig) {
       const ctx = getTestContext(test)
 
       if (ctx) {
-        const originalFn = this.fn
         // we bind the test fn to the correct context
-        const newFn = function () {
+        const newFn = shimmer.wrapFunction(this.fn, originalFn => function () {
           return testFnCh.runStores(ctx, () => originalFn.apply(this, arguments))
-        }
+        })
 
         // we store the original function, not to lose it
-        originalFns.set(newFn, originalFn)
+        originalFns.set(newFn, this.fn)
         this.fn = newFn
 
         wrappedFunctions.add(this.fn)

package/packages/datadog-plugin-amqplib/src/consumer.js

@@ -10,7 +10,7 @@ class AmqplibConsumerPlugin extends ConsumerPlugin {
   static operation = 'consume'
 
   bindStart (ctx) {
-    const { method, fields, message, queue } = ctx
+    const { method, fields = {}, message, queue } = ctx
 
     if (method !== 'basic.deliver' && method !== 'basic.get') return
 

package/packages/datadog-plugin-azure-functions/src/index.js

@@ -24,10 +24,10 @@ class AzureFunctionsPlugin extends TracingPlugin {
   static prefix = 'tracing:datadog:azure:functions:invoke'
 
   bindStart (ctx) {
-    const childOf = extractTraceContext(this._tracer, ctx)
     const meta = getMetaForTrigger(ctx)
     const triggerType = triggerMap[ctx.methodName]
     const isMessagingService = (triggerType === 'ServiceBus' || triggerType === 'EventHubs')
+    const childOf = isMessagingService ? null : extractTraceContext(this._tracer, ctx)
     const span = this.startSpan(this.operationName(), {
       childOf,
       service: this.serviceName(),
@@ -36,7 +36,7 @@ class AzureFunctionsPlugin extends TracingPlugin {
     }, ctx)
 
     if (isMessagingService) {
-      setSpanLinks(this.tracer, span, ctx)
+      setSpanLinks(triggerType, this.tracer, span, ctx)
     }
 
     ctx.span = span
@@ -116,29 +116,39 @@ function extractTraceContext (tracer, ctx) {
   switch (String(triggerMap[ctx.methodName])) {
     case 'Http':
       return tracer.extract('http_headers', Object.fromEntries(ctx.httpRequest.headers))
-    case 'ServiceBus':
-      return tracer.extract('text_map', ctx.invocationContext.triggerMetadata.applicationProperties)
     default:
       null
   }
 }
 
-function setSpanLinks (tracer, span, ctx) {
+// message & messages & batch with cardinality of 1 == applicationProperties
+// messages with cardinality of many == applicationPropertiesArray
+function setSpanLinks (triggerType, tracer, span, ctx) {
   const cardinality = ctx.invocationContext.options.trigger.cardinality
   const triggerMetadata = ctx.invocationContext.triggerMetadata
-  if (cardinality === 'many' && triggerMetadata.propertiesArray.length > 0) {
-    triggerMetadata.propertiesArray.forEach(event => {
-      // Check for possible empty event when span links are disabled
-      if (Object.keys(event).length > 0) {
-        span.addLink(tracer.extract('text_map', event))
-      }
-    })
-  } else if (cardinality === 'one') {
-    const spanContext = tracer.extract('text_map', triggerMetadata.properties)
+  const isServiceBus = triggerType === 'ServiceBus'
+
+  const properties = isServiceBus
+    ? triggerMetadata.applicationProperties
+    : triggerMetadata.properties
+
+  const propertiesArray = isServiceBus
+    ? triggerMetadata.applicationPropertiesArray
+    : triggerMetadata.propertiesArray
+
+  const addLinkFromProperties = (props) => {
+    if (!props || Object.keys(props).length === 0) return
+    const spanContext = tracer.extract('text_map', props)
     if (spanContext) {
       span.addLink(spanContext)
     }
   }
+
+  if (cardinality === 'many' && propertiesArray?.length > 0) {
+    propertiesArray.forEach(addLinkFromProperties)
+  } else if (cardinality === 'one') {
+    addLinkFromProperties(properties)
+  }
 }
 
 module.exports = AzureFunctionsPlugin

package/packages/datadog-plugin-azure-service-bus/src/index.js

@@ -4,7 +4,7 @@ const ProducerPlugin = require('./producer')
 const CompositePlugin = require('../../dd-trace/src/plugins/composite')
 
 class AzureServiceBusPlugin extends CompositePlugin {
-  static id = 'azure-service-bus'
+  static get id () { return 'azure-service-bus' }
   static get plugins () {
     return {
       producer: ProducerPlugin

package/packages/datadog-plugin-azure-service-bus/src/producer.js

@@ -1,36 +1,84 @@
 'use strict'
 
+const { getEnvironmentVariable } = require('../../dd-trace/src/config-helper')
 const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
 
 class AzureServiceBusProducerPlugin extends ProducerPlugin {
-  static id = 'azure-service-bus'
-  static operation = 'send'
+  static get id () { return 'azure-service-bus' }
+  static get operation () { return 'send' }
+  static get prefix () { return 'tracing:apm:azure-service-bus:send' }
 
   bindStart (ctx) {
-    const { sender, msg } = ctx
-    const qualifiedSenderNamespace = sender._sender.audience.replace('sb://', '')
+    // we do not want to make these spans when batch linking is disabled.
+    if (!batchLinksAreEnabled() && ctx.functionName === 'tryAddMessage') {
+      return ctx.currentStore
+    }
+
+    const qualifiedSenderNamespace = ctx.config.host
     const span = this.startSpan({
-      resource: sender.entityPath,
+      resource: ctx.entityPath,
       type: 'messaging',
       meta: {
         component: 'azure-service-bus',
-        'messaging.destination.name': sender.entityPath,
+        'messaging.destination.name': ctx.entityPath,
         'messaging.operation': 'send',
         'messaging.system': 'servicebus',
         'network.destination.name': qualifiedSenderNamespace,
       }
     }, ctx)
 
-    // This is the correct key for injecting trace context into Azure Service Bus messages
-    // It may not be present in the message properties, so we ensure it exists
-    if (!msg.applicationProperties) {
-      msg.applicationProperties = {}
-    }
+    if (ctx.functionName === 'tryAddMessage') {
+      span._spanContext._name = 'azure.servicebus.create'
+      span.setTag('messaging.operation', 'create')
 
-    this.tracer.inject(span, 'text_map', msg.applicationProperties)
+      if (ctx.msg.messageID !== undefined) {
+        span.setTag('message.id', ctx.msg)
+      }
 
+      if (batchLinksAreEnabled()) {
+        ctx.batch._spanContexts.push(span.context())
+        injectTraceContext(this.tracer, span, ctx.msg)
+      }
+    }
+
+    if (ctx.functionName === 'send' || ctx.functionName === 'sendBatch' || ctx.functionName === 'scheduleMessages') {
+      const messages = ctx.msg
+      const isBatch = messages.constructor?.name === 'ServiceBusMessageBatchImpl'
+      if (isBatch) {
+        span.setTag('messaging.batch.message_count', messages.count)
+        if (batchLinksAreEnabled()) {
+          messages._spanContexts.forEach(spanContext => {
+            span.addLink(spanContext)
+          })
+        }
+      } else if (Array.isArray(messages)) {
+        span.setTag('messaging.batch.message_count', messages.length)
+        messages.forEach(event => {
+          injectTraceContext(this.tracer, span, event)
+        })
+      } else {
+        injectTraceContext(this.tracer, span, messages)
+      }
+    }
     return ctx.currentStore
   }
+
+  asyncEnd (ctx) {
+    super.finish()
+  }
+}
+
+function injectTraceContext (tracer, span, msg) {
+  if (!msg.applicationProperties) {
+    msg.applicationProperties = {}
+  }
+
+  tracer.inject(span, 'text_map', msg.applicationProperties)
+}
+
+function batchLinksAreEnabled () {
+  const sb = getEnvironmentVariable('DD_TRACE_AZURE_SERVICEBUS_BATCH_LINKS_ENABLED')
+  return sb !== 'false'
 }
 
 module.exports = AzureServiceBusProducerPlugin