dd-trace 5.88.0 → 5.89.0

package/ext/tags.js

@@ -30,6 +30,8 @@ const tags = {
 
   // DSM Specific
   PATHWAY_HASH: 'pathway.hash',
+  DSM_TRANSACTION_ID: 'dsm.transaction.id',
+  DSM_TRANSACTION_CHECKPOINT: 'dsm.transaction.checkpoint',
 }
 
 // Deprecated

package/index.d.ts

@@ -1339,6 +1339,15 @@ declare namespace tracer {
      * @returns The DSM context associated with the current pathway.
      */
     setConsumeCheckpoint (type: string, source: string, carrier: any, manualCheckpoint?: boolean): any;
+
+    /**
+     * Records a transaction ID at a named checkpoint without pathway propagation.
+     * Tags the active span (or the provided span) with dsm.transaction.id and dsm.transaction.checkpoint.
+     * @param transactionId The unique transaction identifier (truncated to 255 UTF-8 bytes).
+     * @param checkpointName The logical checkpoint name (stable 1-byte ID per process lifetime).
+     * @param span The span to tag. Defaults to the currently active span.
+     */
+    trackTransaction(transactionId: string, checkpointName: string, span?: Span | null): void;
   }
 
   export interface EventTrackingV2 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.88.0",
+  "version": "5.89.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -16,7 +16,8 @@
     "lint": "node scripts/check_licenses.js && node scripts/check-no-coverage-artifacts.js && eslint . --concurrency=auto --max-warnings 0",
     "lint:fix": "node scripts/check_licenses.js && node scripts/check-no-coverage-artifacts.js && eslint . --concurrency=auto --max-warnings 0 --fix",
     "lint:inspect": "npx @eslint/config-inspector@latest",
-    "lint:codeowners": "node scripts/codeowners.mjs",
+    "lint:codeowners": "codeowners-audit",
+    "lint:codeowners:ci": "codeowners-audit --glob='**/*.spec.js'",
     "release:proposal": "node scripts/release/proposal",
     "services": "node ./scripts/install_plugin_modules && node packages/dd-trace/test/setup/services",
     "test": "echo '\nError: The root \"npm test\" command is intentionally disabled.\n\nInstead, run specific test suites:\n  - npm run test:trace:core\n  - npm run test:appsec\n  - etc.\n\nOr run individual test files:\n  npx mocha path/to/test.spec.js\n\nSee CONTRIBUTING.md (Testing section) for more details.\n' && exit 1",
@@ -60,6 +61,7 @@
     "test:integration": "mocha --timeout 60000 \"integration-tests/*.spec.js\"",
     "test:integration:aiguard": "mocha --timeout 60000 \"integration-tests/aiguard/*.spec.js\"",
     "test:integration:appsec": "mocha --timeout 60000 \"integration-tests/appsec/*.spec.js\"",
+    "test:integration:bun": "mocha --timeout 60000 \"integration-tests/bun/*.spec.js\"",
     "test:integration:cucumber": "mocha --timeout 60000 \"integration-tests/cucumber/*.spec.js\"",
     "test:integration:cypress": "mocha --timeout 60000 \"integration-tests/cypress/*.spec.js\"",
     "test:integration:debugger": "mocha --timeout 60000 \"integration-tests/debugger/*.spec.js\"",
@@ -132,14 +134,14 @@
   ],
   "dependencies": {
     "dc-polyfill": "^0.1.10",
-    "import-in-the-middle": "^2.0.6"
+    "import-in-the-middle": "^3.0.0"
   },
   "optionalDependencies": {
     "@datadog/libdatadog": "0.8.1",
     "@datadog/native-appsec": "11.0.1",
     "@datadog/native-iast-taint-tracking": "4.1.0",
     "@datadog/native-metrics": "3.1.1",
-    "@datadog/openfeature-node-server": "^0.3.3",
+    "@datadog/openfeature-node-server": "^1.1.0",
     "@datadog/pprof": "5.13.4",
     "@datadog/wasm-js-rewriter": "5.0.1",
     "@opentelemetry/api": ">=1.0.0 <1.10.0",
@@ -147,13 +149,14 @@
     "oxc-parser": "^0.115.0"
   },
   "devDependencies": {
+    "@actions/core": "^3.0.0",
+    "@actions/github": "^9.0.0",
     "@babel/helpers": "^7.28.6",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.39.2",
     "@msgpack/msgpack": "^3.1.3",
     "@openfeature/core": "^1.8.1",
     "@openfeature/server-sdk": "~1.20.0",
-    "@snyk/github-codeowners": "^1.1.0",
     "@stylistic/eslint-plugin": "^5.7.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.106",
@@ -161,15 +164,16 @@
     "axios": "^1.13.4",
     "benchmark": "^2.1.4",
     "body-parser": "^2.2.2",
-    "bun": "1.3.8",
+    "bun": "1.3.10",
+    "codeowners-audit": "^2.0.0",
     "eslint": "^9.39.2",
-    "eslint-plugin-cypress": "^5.2.1",
+    "eslint-plugin-cypress": "^6.1.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsdoc": "^62.5.0",
     "eslint-plugin-mocha": "^11.2.0",
     "eslint-plugin-n": "^17.23.2",
     "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-unicorn": "^62.0.0",
+    "eslint-plugin-unicorn": "^63.0.0",
     "express": "^5.1.0",
     "glob": "^10.4.5",
     "globals": "^17.2.0",

package/packages/datadog-instrumentations/src/helpers/rewriter/index.js

@@ -1,95 +1,45 @@
 'use strict'
 
-/*
-This rewriter is basically a JavaScript version of Orchestrion-JS. The goal is
-not to replace Orchestrion-JS, but rather to make it easier and faster to write
-new integrations in the short-term, especially as many changes to the rewriter
-will be needed as all the patterns we need have not been identified yet. This
-will avoid the back and forth of having to make Rust changes to an external
-library for every integration change or addition that requires something new.
-
-In the meantime, we'll work concurrently on a change to Orchestrion-JS that
-adds an "arbitrary transform" or "plugin" system that can be used from
-JavaScript, in order to enable quick iteration while still using Orchestrion-JS.
-Once that's done we'll use that, so that we can remove this JS approach and
-return to using Orchestrion-JS.
-
-The long term goal is to backport any additional features we add to the JS
-rewriter (or using the plugin system in Orchestrion-JS once we're using that)
-to Orchestrion-JS  once we're confident that the implementation is fairly
-complete and has all features we need.
-
-Here is a list of the additions and changes in this rewriter compared to
-Orchestrion-JS that will need to be backported:
-
-(NOTE: Please keep this list up-to-date whenever new features are added)
-
-- Supports an `astQuery` field to filter AST nodes with an esquery query. This
-  is mostly meant to be used when experimenting or if what needs to be queried
-  is not a function. We'll see over time if something like this is needed to be
-  backported or if it can be replaced by simpler queries.
-- Supports replacing methods of child class instances in the base constructor.
-- Supports tracing iterator (sync/async) returning functions (sync/async).
-*/
-
 const { readFileSync } = require('fs')
 const { join } = require('path')
-const semifies = require('../../../../../vendor/dist/semifies')
 const log = require('../../../../dd-trace/src/log')
-const { getEnvironmentVariable } = require('../../../../dd-trace/src/config/helper')
-const { transform } = require('./transformer')
-const { generate, parse, traverse } = require('./compiler')
 const instrumentations = require('./instrumentations')
+const { create } = require('./orchestrion')
 
-const NODE_OPTIONS = getEnvironmentVariable('NODE_OPTIONS')
-
-/** @type {Record<string, Set<string>>} map of module base name to supported function query versions */
-const supported = {}
+/** @type {Record<string, string>} map of module base name to version */
+const moduleVersions = {}
 const disabled = new Set()
-
-// TODO: Source maps without `--enable-source-maps`.
-const enableSourceMaps = NODE_OPTIONS?.includes('--enable-source-maps') ||
-  process.execArgv?.some(arg => arg.includes('--enable-source-maps'))
-
-let SourceMapGenerator
+const matcher = create(instrumentations, 'dc-polyfill')
 
 function rewrite (content, filename, format) {
   if (!content) return content
+  if (!filename.includes('node_modules')) return content
 
-  const sourceType = format === 'module' ? 'module' : 'script'
-
-  try {
-    let ast
-
-    filename = filename.replace('file://', '')
-
-    for (const inst of instrumentations) {
-      const { astQuery, functionQuery = {}, module: { name, versionRange, filePath } } = inst
+  filename = filename.replace('file://', '')
 
-      if (disabled.has(name)) continue
-      if (!filename.endsWith(`${name}/${filePath}`)) continue
-      if (!satisfies(filename, filePath, versionRange)) continue
+  const moduleType = format === 'module' ? 'esm' : 'cjs'
+  const [modulePath] = filename.split('/node_modules/').reverse()
+  const moduleParts = modulePath.split('/')
+  const splitIndex = moduleParts[0].startsWith('@') ? 2 : 1
+  const moduleName = moduleParts.slice(0, splitIndex).join('/')
+  const filePath = moduleParts.slice(splitIndex).join('/')
+  const version = getVersion(filename, filePath)
 
-      ast ??= parse(content.toString(), { range: true, sourceType })
+  if (disabled.has(moduleName)) return content
 
-      const query = astQuery || fromFunctionQuery(functionQuery)
-      const state = { ...inst, sourceType, functionQuery }
+  const transformer = matcher.getTransformer(moduleName, version, filePath)
 
-      traverse(ast, query, (...args) => transform(state, ...args))
-    }
+  if (!transformer) return content
 
-    if (ast) {
-      if (!enableSourceMaps) return generate(ast)
+  try {
+    // TODO: pass existing sourcemap as input for remapping
+    const { code, map } = transformer.transform(content, moduleType)
 
-      // TODO: Can we use the same version of `source-map` that DI uses?
-      SourceMapGenerator ??= require('../../../../../vendor/dist/@datadog/source-map').SourceMapGenerator
+    if (!map) return code
 
-      const sourceMap = new SourceMapGenerator({ file: filename })
-      const code = generate(ast, { sourceMap })
-      const map = Buffer.from(sourceMap.toString()).toString('base64')
+    const inlineMap = Buffer.from(map).toString('base64')
 
-      return code + '\n' + `//# sourceMappingURL=data:application/json;base64,${map}`
-    }
+    return code + '\n' + `//# sourceMappingURL=data:application/json;base64,${inlineMap}`
   } catch (e) {
     log.error(e)
   }
@@ -101,55 +51,20 @@ function disable (instrumentation) {
   disabled.add(instrumentation)
 }
 
-function satisfies (filename, filePath, versions) {
+function getVersion (filename, filePath) {
   const [basename] = filename.split(filePath)
 
-  supported[basename] ??= new Set()
-
-  if (!supported[basename].has(versions)) {
+  if (!moduleVersions[basename]) {
     try {
       const pkg = JSON.parse(readFileSync(
         join(basename, 'package.json'), 'utf8'
       ))
 
-      if (semifies(pkg.version, versions)) {
-        supported[basename].add(versions)
-      }
+      moduleVersions[basename] = pkg.version
     } catch {}
   }
 
-  return supported[basename].has(versions)
-}
-
-// TODO: Support index
-function fromFunctionQuery (functionQuery) {
-  const { methodName, functionName, expressionName, className } = functionQuery
-  const queries = []
-
-  if (className) {
-    queries.push(
-      `[id.name="${className}"]`,
-      `[id.name="${className}"] > ClassExpression`,
-      `[id.name="${className}"] > ClassBody > [key.name="${methodName}"] > [async]`,
-      `[id.name="${className}"] > ClassExpression > ClassBody > [key.name="${methodName}"] > [async]`
-    )
-  } else if (methodName) {
-    queries.push(
-      `ClassBody > [key.name="${methodName}"] > [async]`,
-      `Property[key.name="${methodName}"] > [async]`
-    )
-  }
-
-  if (functionName) {
-    queries.push(`FunctionDeclaration[id.name="${functionName}"][async]`)
-  } else if (expressionName) {
-    queries.push(
-      `FunctionExpression[id.name="${expressionName}"][async]`,
-      `ArrowFunctionExpression[id.name="${expressionName}"][async]`
-    )
-  }
-
-  return queries.join(', ')
+  return moduleVersions[basename]
 }
 
 module.exports = { rewrite, disable }

package/packages/datadog-instrumentations/src/helpers/rewriter/{compiler.js → orchestrion/compiler.js}

@@ -1,6 +1,6 @@
 'use strict'
 
-const log = require('../../../../dd-trace/src/log')
+const log = require('../../../../../dd-trace/src/log')
 
 // eslint-disable-next-line camelcase, no-undef
 const runtimeRequire = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require
@@ -25,7 +25,7 @@ const compiler = {
       log.error(e)
 
       // Fallback for when OXC is not available.
-      const meriyah = require('../../../../../vendor/dist/meriyah')
+      const meriyah = require('../../../../../../vendor/dist/meriyah')
 
       compiler.parse = (sourceText, { range, sourceType } = {}) => {
         return meriyah.parse(sourceText.toString(), {
@@ -40,7 +40,7 @@ const compiler = {
   },
 
   generate: (...args) => {
-    const astring = require('../../../../../vendor/dist/astring')
+    const astring = require('../../../../../../vendor/dist/astring')
 
     compiler.generate = astring.generate
 
@@ -48,7 +48,7 @@ const compiler = {
   },
 
   traverse: (ast, query, visitor) => {
-    const esquery = require('../../../../../vendor/dist/esquery').default
+    const esquery = require('../../../../../../vendor/dist/esquery').default
 
     compiler.traverse = (ast, query, visitor) => {
       return esquery.traverse(ast, esquery.parse(query), visitor)
@@ -58,7 +58,7 @@ const compiler = {
   },
 
   query: (ast, query) => {
-    const esquery = require('../../../../../vendor/dist/esquery').default
+    const esquery = require('../../../../../../vendor/dist/esquery').default
 
     compiler.query = esquery.query
 

package/packages/datadog-instrumentations/src/helpers/rewriter/orchestrion/index.js

@@ -0,0 +1,43 @@
+'use strict'
+
+/*
+This folder is basically a JavaScript version of Orchestrion-JS. The goal is
+not to replace Orchestrion-JS, but rather to make it easier and faster to write
+new integrations in the short-term, especially as many changes to the rewriter
+will be needed as all the patterns we need have not been identified yet. This
+will avoid the back and forth of having to make Rust changes to an external
+library for every integration change or addition that requires something new.
+
+In the meantime, we'll work concurrently on a change to Orchestrion-JS that
+adds an "arbitrary transform" or "plugin" system that can be used from
+JavaScript, in order to enable quick iteration while still using Orchestrion-JS.
+Once that's done we'll use that, so that we can remove this JS approach and
+return to using Orchestrion-JS.
+
+The long term goal is to backport any additional features we add to the JS
+rewriter (or using the plugin system in Orchestrion-JS once we're using that)
+to Orchestrion-JS  once we're confident that the implementation is fairly
+complete and has all features we need.
+
+Here is a list of the additions and changes in this rewriter compared to
+Orchestrion-JS that will need to be backported:
+
+(NOTE: Please keep this list up-to-date whenever new features are added)
+
+- Supports an `astQuery` field to filter AST nodes with an esquery query. This
+  is mostly meant to be used when experimenting or if what needs to be queried
+  is not a function. We'll see over time if something like this is needed to be
+  backported or if it can be replaced by simpler queries.
+- Supports replacing methods of child class instances in the base constructor.
+- Supports tracing iterator (sync/async) returning functions (sync/async).
+*/
+
+/* eslint-disable camelcase */
+
+const { InstrumentationMatcher } = require('./matcher')
+
+function create (configs, dc_module) {
+  return new InstrumentationMatcher(configs, dc_module)
+}
+
+module.exports = { create }

package/packages/datadog-instrumentations/src/helpers/rewriter/orchestrion/matcher.js

@@ -0,0 +1,49 @@
+'use strict'
+
+/* eslint-disable camelcase */
+
+const semifies = require('../../../../../../vendor/dist/semifies')
+const { Transformer } = require('./transformer')
+
+// TODO: addTransform
+
+class InstrumentationMatcher {
+  #configs = []
+  #dc_module = null
+  #transformers = {}
+
+  constructor (configs, dc_module) {
+    this.#configs = configs
+    this.#dc_module = dc_module || 'diagnostics_channel'
+  }
+
+  free () {
+    this.#transformers = {}
+  }
+
+  getTransformer (module_name, version, file_path) {
+    const id = `${module_name}/${file_path}@${version}`
+
+    if (this.#transformers[id]) return this.#transformers[id]
+
+    const configs = this.#configs.filter(({ module: { name, filePath, versionRange } }) =>
+      name === module_name &&
+      filePath === file_path &&
+      semifies(version, versionRange)
+    )
+
+    if (configs.length === 0) return
+
+    this.#transformers[id] = new Transformer(
+      module_name,
+      version,
+      file_path,
+      configs,
+      this.#dc_module
+    )
+
+    return this.#transformers[id]
+  }
+}
+
+module.exports = { InstrumentationMatcher }

package/packages/datadog-instrumentations/src/helpers/rewriter/orchestrion/transformer.js

@@ -0,0 +1,121 @@
+'use strict'
+
+/* eslint-disable camelcase */
+
+const { generate, parse, traverse } = require('./compiler')
+const transforms = require('./transforms')
+
+let SourceMapConsumer
+let SourceMapGenerator
+
+class Transformer {
+  #module_name = null
+  #file_path = null
+  #configs = []
+  #dc_module = null
+
+  // TODO: module_name false for user module
+  constructor (module_name, _version, file_path, configs, dc_module) {
+    this.#module_name = module_name
+    this.#file_path = file_path
+    this.#configs = configs
+    this.#dc_module = dc_module
+  }
+
+  free () {
+    // Freeing is not needed for a JavaScript implementation.
+  }
+
+  transform (code, module_type, sourcemap) {
+    if (!code) return { code }
+
+    const sourceType = module_type === 'esm' ? 'module' : 'script'
+
+    let ast
+
+    for (const config of this.#configs) {
+      const { astQuery, functionQuery = {} } = config
+
+      ast ??= parse(code.toString(), { range: true, sourceType })
+
+      const query = astQuery || this.#fromFunctionQuery(functionQuery)
+      const state = { ...config, dcModule: this.#dc_module, sourceType, functionQuery }
+
+      state.operator = this.#getOperator(state)
+
+      traverse(ast, query, (...args) => this.#visit(state, ...args))
+    }
+
+    if (ast) {
+      SourceMapConsumer ??= require('../../../../../../vendor/dist/@datadog/source-map').SourceMapConsumer
+      SourceMapGenerator ??= require('../../../../../../vendor/dist/@datadog/source-map').SourceMapGenerator
+
+      const file = `${this.#module_name}/${this.#file_path}`
+      const sourceMapInput = sourcemap ? new SourceMapConsumer(sourcemap) : { file }
+      const sourceMap = new SourceMapGenerator(sourceMapInput)
+      const code = generate(ast, { sourceMap })
+      const map = sourceMap.toString()
+
+      return { code, map }
+    }
+
+    return { code }
+  }
+
+  #visit (state, ...args) {
+    const transform = transforms[state.operator]
+    const { index } = state.functionQuery
+
+    if (index !== undefined) {
+      state.functionIndex = ++state.functionIndex || 0
+
+      if (index !== state.functionIndex) return
+    }
+
+    transform(state, ...args)
+  }
+
+  #getOperator ({ functionQuery: { kind } }) {
+    switch (kind) {
+      case 'Async': return 'tracePromise'
+      case 'AsyncIterator': return 'traceAsyncIterator'
+      case 'Callback': return 'traceCallback'
+      case 'Iterator': return 'traceIterator'
+      case 'Sync': return 'traceSync'
+    }
+  }
+
+  #fromFunctionQuery (functionQuery) {
+    const { functionName, expressionName, className } = functionQuery
+    const method = functionQuery.methodName || functionQuery.privateMethodName
+    const type = functionQuery.privateMethodName ? 'PrivateIdentifier' : 'Identifier'
+    const queries = []
+
+    if (className) {
+      queries.push(
+        `[id.name="${className}"]`,
+        `[id.name="${className}"] > ClassExpression`,
+        `[id.name="${className}"] > ClassBody > [key.name="${method}"][key.type=${type}] > [async]`,
+        `[id.name="${className}"] > ClassExpression > ClassBody > [key.name="${method}"][key.type=${type}] > [async]`
+      )
+    } else if (method) {
+      queries.push(
+        `ClassBody > [key.name="${method}"][key.type=${type}] > [async]`,
+        `Property[key.name="${method}"][key.type=${type}] > [async]`
+      )
+    }
+
+    if (functionName) {
+      queries.push(`FunctionDeclaration[id.name="${functionName}"][async]`)
+    } else if (expressionName) {
+      queries.push(
+        `FunctionExpression[id.name="${expressionName}"][async]`,
+        `ArrowFunctionExpression[id.name="${expressionName}"][async]`
+      )
+    }
+
+    return queries.join(', ')
+  }
+}
+
+module.exports = { Transformer }

package/packages/datadog-instrumentations/src/helpers/rewriter/{transforms.js → orchestrion/transforms.js}

@@ -8,13 +8,13 @@ const tracingChannelPredicate = (node) => (
 )
 
 const transforms = module.exports = {
-  tracingChannelImport ({ sourceType }, node) {
+  tracingChannelImport ({ dcModule, sourceType }, node) {
     if (node.body.some(tracingChannelPredicate)) return
 
     const index = node.body.findIndex(child => child.directive === 'use strict')
     const code = sourceType === 'module'
-      ? 'import { tracingChannel as tr_ch_apm_tracingChannel } from "diagnostics_channel"'
-      : 'const {tracingChannel: tr_ch_apm_tracingChannel} = require("diagnostics_channel")'
+      ? `import { tracingChannel as tr_ch_apm_tracingChannel } from "${dcModule}"`
+      : `const {tracingChannel: tr_ch_apm_tracingChannel} = require("${dcModule}")`
 
     node.body.splice(index + 1, 0, parse(code, { sourceType }).body[0])
   },
@@ -196,11 +196,11 @@ function wrapSuper (_state, node) {
 }
 
 function wrapCallback (state, node) {
-  const { channelName, functionQuery: { index = -1 } } = state
+  const { channelName, functionQuery: { callbackIndex = -1 } } = state
   const channelVariable = 'tr_ch_apm$' + channelName.replaceAll(':', '_')
   const wrapper = parse(`
     function wrapper () {
-      const __apm$cb = Array.prototype.at.call(arguments, ${index});
+      const __apm$cb = Array.prototype.at.call(arguments, ${callbackIndex});
       const __apm$ctx = {
         arguments,
         self: this,
@@ -235,7 +235,7 @@ function wrapCallback (state, node) {
       if (typeof __apm$cb !== 'function') {
         return __apm$traced();
       }
-      Array.prototype.splice.call(arguments, ${index}, 1, __apm$wrappedCb);
+      Array.prototype.splice.call(arguments, ${callbackIndex}, 1, __apm$wrappedCb);
 
       return ${channelVariable}.start.runStores(__apm$ctx, () => {
         try {