dd-trace 6.10.0 → 6.12.0

package/packages/datadog-plugin-cypress/src/finalization.js

@@ -0,0 +1,76 @@
+'use strict'
+
+const { AsyncLocalStorage } = require('node:async_hooks')
+
+const log = require('../../dd-trace/src/log')
+
+const DD_CYPRESS_USER_HANDLER_CONTEXT = Symbol.for('dd-trace.cypress.user-handler.context')
+const userHandlerContext = globalThis[DD_CYPRESS_USER_HANDLER_CONTEXT] ||= new AsyncLocalStorage()
+const manualPluginOwner = {}
+
+/**
+ * Runs a Cypress user handler while allowing wrapped legacy Datadog helpers to
+ * defer to the managed finalizer.
+ *
+ * @param {() => unknown} handler user handler invocation
+ * @returns {unknown} handler result
+ */
+function runUserHandler (handler) {
+  return userHandlerContext.run(true, handler)
+}
+
+/**
+ * @returns {boolean} whether a managed finalizer owns the current lifecycle event
+ */
+function shouldDeferLegacyFinalization () {
+  return userHandlerContext.getStore() === true
+}
+
+/**
+ * Converts a Cypress rejection reason into error metadata without changing the
+ * value rethrown to Cypress.
+ *
+ * @param {unknown} reason rejection reason
+ * @returns {Error} error used for Test Optimization finalization
+ */
+function normalizeUserHandlerError (reason) {
+  if (reason instanceof Error) return reason
+  if (reason == null) return new Error('Cypress user handler rejected without an error')
+
+  try {
+    return new Error(String(reason))
+  } catch {
+    return new Error('Cypress user handler failed')
+  }
+}
+
+/**
+ * Runs the Datadog finalizer after user handlers while preserving the user
+ * error as the framework-visible failure.
+ *
+ * @param {Promise<void>} userHandlers collected user-handler chain
+ * @param {(userError?: unknown) => unknown} finalizer Datadog finalizer
+ * @returns {Promise<unknown>} finalizer result
+ */
+function finalizeAfterUserHandlers (userHandlers, finalizer) {
+  return userHandlers.then(
+    () => finalizer(),
+    userError => Promise.resolve().then(() => {
+      return finalizer(normalizeUserHandlerError(userError))
+    }).then(
+      () => { throw userError },
+      finalizerError => {
+        log.error('Datadog Cypress finalizer failed after a user handler error', finalizerError)
+        throw userError
+      }
+    )
+  )
+}
+
+module.exports = {
+  finalizeAfterUserHandlers,
+  manualPluginOwner,
+  normalizeUserHandlerError,
+  runUserHandler,
+  shouldDeferLegacyFinalization,
+}

package/packages/datadog-plugin-cypress/src/index.js

@@ -2,6 +2,7 @@
 
 const NoopTracer = require('../../dd-trace/src/noop/tracer')
 const Plugin = require('../../dd-trace/src/plugins/plugin')
+const { finalizeAfterUserHandlers, runUserHandler } = require('./finalization')
 
 /**
  * Cypress plugin handles setup-node-events from the instrumentation layer
@@ -30,11 +31,12 @@ class CypressPlugin extends Plugin {
       const registerAfterRunWithCleanup = (afterRunHandler) => {
         on('after:run', (results) => {
           const chain = userAfterRunHandlers.reduce(
-            (p, h) => p.then(() => h(results)),
+            (p, h) => p.then(() => runUserHandler(() => h(results))),
             Promise.resolve()
           )
           if (afterRunHandler) {
-            return chain.then(() => afterRunHandler(results)).finally(cleanupWrapper)
+            return finalizeAfterUserHandlers(chain, userError => afterRunHandler(results, userError))
+              .finally(cleanupWrapper)
           }
           return chain.finally(cleanupWrapper)
         })
@@ -82,7 +84,7 @@ class CypressPlugin extends Plugin {
         // (the chained registration replaces the one plugin.js set, so it must include it).
         if (userAfterSpecHandlers.length > 0) {
           on('after:spec', (spec, results) => userAfterSpecHandlers.reduce(
-            (chain, handler) => chain.then(() => handler(spec, results)),
+            (chain, handler) => chain.then(() => runUserHandler(() => handler(spec, results))),
             Promise.resolve()
           ))
         }
@@ -97,13 +99,17 @@ class CypressPlugin extends Plugin {
 
       on('after:spec', (spec, results) => {
         const chain = userAfterSpecHandlers.reduce(
-          (p, h) => p.then(() => h(spec, results)),
+          (p, h) => p.then(() => runUserHandler(() => h(spec, results))),
           Promise.resolve()
         )
-        return chain.then(() => cypressPlugin.afterSpec(spec, results))
+        return finalizeAfterUserHandlers(chain, userError => cypressPlugin.afterSpec(spec, results, userError))
+          .catch((error) => {
+            cleanupWrapper()
+            throw error
+          })
       })
 
-      registerAfterRunWithCleanup((results) => cypressPlugin.afterRun(results))
+      registerAfterRunWithCleanup((results, userError) => cypressPlugin.afterRun(results, userError))
 
       on('task', cypressPlugin.getTasks())
 

package/packages/datadog-plugin-cypress/src/plugin.js

@@ -4,6 +4,12 @@ const NoopTracer = require('../../dd-trace/src/noop/tracer')
 const satisfies = require('../../../vendor/dist/semifies')
 const { DD_MAJOR } = require('../../../version')
 const cypressPlugin = require('./cypress-plugin')
+const { manualPluginOwner } = require('./finalization')
+
+const DD_CYPRESS_AFTER_SPEC_HANDLER = Symbol.for('dd-trace.cypress.after-spec.handler')
+const DD_CYPRESS_AFTER_RUN_HANDLER = Symbol.for('dd-trace.cypress.after-run.handler')
+const DD_CYPRESS_TASK_HANDLER = Symbol.for('dd-trace.cypress.task.handler')
+const DD_CYPRESS_NOOP_TASK_HANDLER = Symbol.for('dd-trace.cypress.noop-task.handler')
 
 const noopTask = {
   'dd:testSuiteStart': () => {
@@ -18,6 +24,7 @@ const noopTask = {
   'dd:addTags': () => {
     return null
   },
+  [DD_CYPRESS_NOOP_TASK_HANDLER]: true,
 }
 
 module.exports = function CypressPlugin (on, config) {
@@ -41,9 +48,15 @@ module.exports = function CypressPlugin (on, config) {
 
   on('before:run', cypressPlugin.beforeRun.bind(cypressPlugin))
   on('after:screenshot', cypressPlugin.getAfterScreenshotHandler())
-  on('after:spec', cypressPlugin.afterSpec.bind(cypressPlugin))
-  on('after:run', cypressPlugin.afterRun.bind(cypressPlugin))
-  on('task', cypressPlugin.getTasks())
+  const afterSpecHandler = cypressPlugin.afterSpec.bind(cypressPlugin)
+  afterSpecHandler[DD_CYPRESS_AFTER_SPEC_HANDLER] = true
+  on('after:spec', afterSpecHandler)
+  const afterRunHandler = cypressPlugin.afterRun.bind(cypressPlugin)
+  afterRunHandler[DD_CYPRESS_AFTER_RUN_HANDLER] = true
+  on('after:run', afterRunHandler)
+  const taskHandler = cypressPlugin.getTasks()
+  taskHandler[DD_CYPRESS_TASK_HANDLER] = manualPluginOwner
+  on('task', taskHandler)
 
   return cypressPlugin.init(tracer, config)
 }

package/packages/datadog-plugin-dd-trace-api/src/index.js

@@ -78,6 +78,10 @@ module.exports = class DdTraceApiPlugin extends Plugin {
     }
 
     // handleEvent('configure')
+    // No handoff for `openfeature` yet: an application that calls into the tracer
+    // exclusively through the `dd-trace-api` shim (instead of `require('dd-trace')`) cannot
+    // reach `tracer.openfeature` through that shim. This does not affect SSI itself --
+    // auto-injection and vendored-provider resolution work regardless of this gap.
     handleEvent('startSpan')
     handleEvent('wrap')
     handleEvent('trace')

package/packages/datadog-plugin-electron/src/index.js

@@ -1,11 +1,13 @@
 'use strict'
 
+const { DD_MAJOR } = require('../../../version')
 const CompositePlugin = require('../../dd-trace/src/plugins/composite')
 const ElectronIpcPlugin = require('./ipc')
 const ElectronNetPlugin = require('./net')
 
 class ElectronPlugin extends CompositePlugin {
   static id = 'electron'
+  static optIn = DD_MAJOR >= 7
   static get plugins () {
     return {
       net: ElectronNetPlugin,

package/packages/datadog-plugin-fs/src/index.js

@@ -5,7 +5,7 @@ const TracingPlugin = require('../../dd-trace/src/plugins/tracing')
 class FsPlugin extends TracingPlugin {
   static id = 'fs'
   static operation = 'operation'
-  static experimental = true
+  static optIn = true
 
   bindStart (ctx) {
     if (!this.activeSpan) return { noop: true }

package/packages/datadog-plugin-jest/src/index.js

@@ -113,6 +113,7 @@ class JestPlugin extends CiPlugin {
       hasUnskippableSuites,
       hasForcedToRunSuites,
       error,
+      isTestSessionFinalizationError,
       isEarlyFlakeDetectionEnabled,
       isEarlyFlakeDetectionFaulty,
       isTestManagementTestsEnabled,
@@ -123,6 +124,9 @@ class JestPlugin extends CiPlugin {
         this.testModuleSpan.setTag(TEST_STATUS, status)
 
         if (error) {
+          if (isTestSessionFinalizationError) {
+            this.tracer._exporter.setDeferredTestSuiteError?.(error)
+          }
           this.testSessionSpan.setTag('error', error)
           this.testModuleSpan.setTag('error', error)
         }
@@ -159,6 +163,7 @@ class JestPlugin extends CiPlugin {
           this.testSessionSpan.setTag(TEST_MANAGEMENT_ENABLED, 'true')
         }
 
+        this.tracer._exporter.exportDeferredTestSuiteSpans?.()
         this.testModuleSpan.finish()
         this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'module')
         this.testSessionSpan.finish()
@@ -329,6 +334,7 @@ class JestPlugin extends CiPlugin {
       this.pendingTestSuiteFinishes.add(pendingFinish)
 
       const finish = () => {
+        this.tracer._exporter.deferTestSuiteSpan?.(testSuiteSpan)
         testSuiteSpan.finish()
         this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'suite')
         // Suites potentially run in a different process than the session,

package/packages/datadog-plugin-mocha/src/index.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { performance } = require('node:perf_hooks')
+const dateNow = Date.now
 const { fileURLToPath } = require('node:url')
 
 const { channel } = require('dc-polyfill')
@@ -173,6 +174,15 @@ class MochaPlugin extends CiPlugin {
 
     this._testTitleToParams = {}
     this.sourceRoot = process.cwd()
+    this._pendingTestSuiteSpans = []
+    this._timeOrigin = dateNow()
+    this._perfOrigin = performance.now()
+
+    this.addSub('ci:mocha:session:start', () => {
+      this._pendingTestSuiteSpans = []
+      this._timeOrigin = dateNow()
+      this._perfOrigin = performance.now()
+    })
 
     this.addSub('ci:mocha:worker:configuration', ({
       libraryConfig,
@@ -472,7 +482,19 @@ class MochaPlugin extends CiPlugin {
         if (!testSuiteSpan.context().getTag(TEST_STATUS)) {
           testSuiteSpan.setTag(TEST_STATUS, status)
         }
-        testSuiteSpan.finish()
+        const exporter = this.tracer._exporter
+        if (exporter.deferTestSuiteSpan) {
+          exporter.deferTestSuiteSpan(testSuiteSpan)
+          testSuiteSpan.finish()
+        } else if (exporter.exportDeferredTestSuiteSpans) {
+          const finishTime = this._now()
+          this._pendingTestSuiteSpans.push({
+            span: testSuiteSpan,
+            finishTime,
+          })
+        } else {
+          testSuiteSpan.finish()
+        }
         this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'suite')
       }
     })
@@ -522,6 +544,7 @@ class MochaPlugin extends CiPlugin {
     })
 
     this.addSub('ci:mocha:worker:finish', ({ onDone } = {}) => {
+      this._finishPendingTestSuiteSpans()
       this.tracer._exporter.flush(onDone)
     })
 
@@ -715,6 +738,7 @@ class MochaPlugin extends CiPlugin {
       isEarlyFlakeDetectionFaulty,
       isTestManagementEnabled,
       isParallel,
+      isFrameworkError,
       onDone,
     }) => {
       this._exportPendingWorkerTraces()
@@ -730,8 +754,17 @@ class MochaPlugin extends CiPlugin {
         if (error) {
           this.testSessionSpan.setTag('error', error)
           this.testModuleSpan.setTag('error', error)
+          if (isFrameworkError) {
+            this.tracer._exporter.setDeferredTestSuiteError?.(error)
+            for (const testSuiteSpan of this._testSuiteSpansByTestSuite.values()) {
+              testSuiteSpan.setTag(TEST_STATUS, 'fail')
+              testSuiteSpan.setTag('error', error)
+            }
+          }
         }
 
+        this._finishPendingTestSuiteSpans()
+
         if (isParallel) {
           this.testSessionSpan.setTag(MOCHA_IS_PARALLEL, 'true')
         }
@@ -769,6 +802,7 @@ class MochaPlugin extends CiPlugin {
           this.testSessionSpan.setTag(TEST_EARLY_FLAKE_ABORT_REASON, 'faulty')
         }
 
+        this.tracer._exporter.exportDeferredTestSuiteSpans?.()
         this.testModuleSpan.finish()
         this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'module')
         this.testSessionSpan.finish()
@@ -790,6 +824,27 @@ class MochaPlugin extends CiPlugin {
     })
   }
 
+  /**
+   * Returns the current time in the coordinate system used by spans.
+   *
+   * @returns {number}
+   */
+  _now () {
+    return this._timeOrigin + performance.now() - this._perfOrigin
+  }
+
+  /**
+   * Finishes suites retained for a later framework finalization event.
+   *
+   * @returns {void}
+   */
+  _finishPendingTestSuiteSpans () {
+    for (const { span, finishTime } of this._pendingTestSuiteSpans) {
+      span.finish(finishTime)
+    }
+    this._pendingTestSuiteSpans = []
+  }
+
   /**
    * Starts a Jasmine test span around WebdriverIO's test-function wrapper.
    *

package/packages/datadog-plugin-nats/src/index.js

@@ -8,7 +8,7 @@ class NatsPlugin extends CompositePlugin {
   static id = 'nats'
   // Disabled by default — users must opt in via DD_TRACE_NATS_ENABLED=true
   // or `tracer.use('nats')`. Matches the feature parity dashboard policy.
-  static experimental = true
+  static optIn = true
   static get plugins () {
     return {
       producer: ProducerPlugin,

package/packages/datadog-plugin-openai/src/tracing.js

@@ -102,23 +102,23 @@ class OpenAiTracingPlugin extends TracingPlugin {
       },
     }, false)
 
-    const openaiStore = Object.create(null)
-
     const tags = {} // The remaining tags are added one at a time
 
     if (payload.stream) {
       tags['openai.request.stream'] = payload.stream
     }
 
+    let openaiStore
+
     switch (normalizedMethodName) {
       case 'createImage':
       case 'createImageEdit':
       case 'createImageVariation':
-        commonCreateImageRequestExtraction(tags, payload, openaiStore)
+        openaiStore = commonCreateImageRequestExtraction(tags, payload)
         break
 
       case 'createChatCompletion':
-        createChatCompletionRequestExtraction(tags, payload, openaiStore)
+        openaiStore = createChatCompletionRequestExtraction(tags, payload)
         break
 
       case 'createFile':
@@ -128,7 +128,7 @@ class OpenAiTracingPlugin extends TracingPlugin {
 
       case 'createTranscription':
       case 'createTranslation':
-        commonCreateAudioRequestExtraction(tags, payload, openaiStore)
+        openaiStore = commonCreateAudioRequestExtraction(tags, payload)
         break
 
       case 'retrieveModel':
@@ -136,11 +136,11 @@ class OpenAiTracingPlugin extends TracingPlugin {
         break
 
       case 'createEdit':
-        createEditRequestExtraction(tags, payload, openaiStore)
+        openaiStore = createEditRequestExtraction(tags, payload)
         break
 
       case 'createResponse':
-        createResponseRequestExtraction(tags, payload, openaiStore)
+        openaiStore = createResponseRequestExtraction(tags, payload)
         break
     }
 
@@ -177,8 +177,6 @@ class OpenAiTracingPlugin extends TracingPlugin {
 
     body = coerceResponseBody(body, normalizedMethodName)
 
-    const openaiStore = store.openai
-
     if (!error && (path?.startsWith('https://') || path?.startsWith('http://'))) {
       // basic checking for if the path was set as a full URL
       // not using a full regex as it will likely be "https://api.openai.com/..."
@@ -204,7 +202,7 @@ class OpenAiTracingPlugin extends TracingPlugin {
           'openai.response.created_at': body.created_at,
         }
 
-    responseDataExtractionByMethod(normalizedMethodName, tags, body, openaiStore)
+    const openaiStore = responseDataExtractionByMethod(normalizedMethodName, tags, body, store.openai)
     span.addTags(tags)
 
     span.finish()
@@ -298,7 +296,6 @@ class OpenAiTracingPlugin extends TracingPlugin {
 
   sendLog (methodName, span, tags, openaiStore, error) {
     if (!openaiStore) return
-    if (!Object.keys(openaiStore).length) return
     if (!this.sampler.isSampled(span)) return
 
     const log = {
@@ -395,45 +392,54 @@ function normalizeMethodName (methodName) {
   }
 }
 
-function createEditRequestExtraction (tags, payload, openaiStore) {
-  const instruction = payload.instruction
-  openaiStore.instruction = instruction
+function createEditRequestExtraction (tags, payload) {
+  const openaiStore = Object.create(null)
+  openaiStore.instruction = payload.instruction
+  return openaiStore
 }
 
-function createResponseRequestExtraction (tags, payload, openaiStore) {
+function createResponseRequestExtraction (tags, payload) {
   // Extract model information
   if (payload.model) {
     tags['openai.request.model'] = payload.model
   }
 
   // Store the full payload for response extraction
+  const openaiStore = Object.create(null)
   openaiStore.responseData = payload
+  return openaiStore
 }
 
 function retrieveModelRequestExtraction (tags, payload) {
   tags['openai.request.id'] = payload.id
 }
 
-function createChatCompletionRequestExtraction (tags, payload, openaiStore) {
+function createChatCompletionRequestExtraction (tags, payload) {
   const messages = payload.messages
   if (!defensiveArrayLength(messages)) return
 
-  openaiStore.messages = payload.messages
+  const openaiStore = Object.create(null)
+  openaiStore.messages = messages
+  return openaiStore
 }
 
-function commonCreateImageRequestExtraction (tags, payload, openaiStore) {
+function commonCreateImageRequestExtraction (tags, payload) {
+  let openaiStore
+
   // createImageEdit, createImageVariation
   const img = payload.file || payload.image
   if (img !== null && typeof img === 'object' && img.path) {
-    const file = path.basename(img.path)
-    openaiStore.file = file
+    openaiStore = Object.create(null)
+    openaiStore.file = path.basename(img.path)
   }
 
   // createImageEdit
   if (payload.mask !== null && typeof payload.mask === 'object' && payload.mask.path) {
-    const mask = path.basename(payload.mask.path)
-    openaiStore.mask = mask
+    openaiStore ??= Object.create(null)
+    openaiStore.mask = path.basename(payload.mask.path)
   }
+
+  return openaiStore
 }
 
 function responseDataExtractionByMethod (methodName, tags, body, openaiStore) {
@@ -441,12 +447,10 @@ function responseDataExtractionByMethod (methodName, tags, body, openaiStore) {
     case 'createCompletion':
     case 'createChatCompletion':
     case 'createEdit':
-      commonCreateResponseExtraction(tags, body, openaiStore, methodName)
-      break
+      return commonCreateResponseExtraction(tags, body, openaiStore, methodName)
 
     case 'createResponse':
-      createResponseResponseExtraction(tags, body, openaiStore)
-      break
+      return createResponseResponseExtraction(tags, body, openaiStore)
 
     case 'listFiles':
     case 'listFineTunes':
@@ -475,6 +479,8 @@ function responseDataExtractionByMethod (methodName, tags, body, openaiStore) {
       retrieveModelResponseExtraction(tags, body)
       break
   }
+
+  return openaiStore
 }
 
 function retrieveModelResponseExtraction (tags, body) {
@@ -513,10 +519,11 @@ function deleteFileResponseExtraction (tags, body) {
   tags['openai.response.id'] = body.id
 }
 
-function commonCreateAudioRequestExtraction (tags, body, openaiStore) {
+function commonCreateAudioRequestExtraction (tags, body) {
   if (body.file !== null && typeof body.file === 'object' && body.file.path) {
-    const filename = path.basename(body.file.path)
-    openaiStore.file = filename
+    const openaiStore = Object.create(null)
+    openaiStore.file = path.basename(body.file.path)
+    return openaiStore
   }
 }
 
@@ -546,9 +553,11 @@ function commonListCountResponseExtraction (tags, body) {
 
 // createCompletion, createChatCompletion, createEdit
 function commonCreateResponseExtraction (tags, body, openaiStore, methodName) {
-  if (!body.choices) return
+  if (!body.choices) return openaiStore
 
+  openaiStore ??= Object.create(null)
   openaiStore.choices = body.choices
+  return openaiStore
 }
 
 function createResponseResponseExtraction (tags, body, openaiStore) {
@@ -568,7 +577,9 @@ function createResponseResponseExtraction (tags, body, openaiStore) {
   }
 
   // Store the full response for potential future use
+  openaiStore ??= Object.create(null)
   openaiStore.response = body
+  return openaiStore
 }
 
 // The server almost always responds with JSON

package/packages/datadog-plugin-openai-agents/src/integration.js

@@ -498,6 +498,7 @@ class OpenAIAgentsIntegration {
 
     this.#tagger.tagTextIO(ddSpan, inputValue, outputValue)
 
+    // eslint-disable-next-line no-restricted-syntax -- agents-core builds metadata before the plugin receives it
     if (info.metadata && Object.keys(info.metadata).length > 0) {
       this.#tagger.tagMetadata(ddSpan, info.metadata)
     }