dd-trace 6.8.0 → 6.10.0

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

@@ -54,4 +54,203 @@ module.exports = [
     channelName: 'LocalRunner_shutdown',
     transform: 'waitForAsyncEnd',
   },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      className: 'JasmineAdapter',
+      methodName: 'init',
+      kind: 'Async',
+    },
+    channelName: 'JasmineAdapter_init',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    astQuery: 'VariableDeclarator[id.name="JasmineAdapter"] > ClassExpression > ClassBody > ' +
+      'MethodDefinition[key.name="init"] ReturnStatement > ' +
+      'CallExpression[callee.object.name="promise"][callee.property.name="then"], ' +
+      'ClassDeclaration[id.name="JasmineAdapter"] > ClassBody > MethodDefinition[key.name="init"] ReturnStatement > ' +
+      'CallExpression[callee.object.name="promise"][callee.property.name="then"]',
+    channelName: 'JasmineAdapter_init',
+    transform: 'waitForAsyncEnd',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      className: 'JasmineAdapter',
+      methodName: 'run',
+      kind: 'Async',
+    },
+    channelName: 'JasmineAdapter_run',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    astQuery: 'VariableDeclarator[id.name="JasmineAdapter"] > ClassExpression > ClassBody > ' +
+      'MethodDefinition[key.name="run"] ReturnStatement > ' +
+      'CallExpression[callee.object.name="promise"][callee.property.name="then"], ' +
+      'ClassDeclaration[id.name="JasmineAdapter"] > ClassBody > MethodDefinition[key.name="run"] ReturnStatement > ' +
+      'CallExpression[callee.object.name="promise"][callee.property.name="then"]',
+    channelName: 'JasmineAdapter_run',
+    transform: 'waitForAsyncEnd',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      className: 'JasmineReporter',
+      methodName: 'specDone',
+      kind: 'Sync',
+    },
+    channelName: 'JasmineReporter_specDone',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      className: 'JasmineReporter',
+      methodName: 'specStarted',
+      kind: 'Sync',
+    },
+    channelName: 'JasmineReporter_specStarted',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      className: 'JasmineReporter',
+      methodName: 'suiteStarted',
+      kind: 'Sync',
+    },
+    channelName: 'JasmineReporter_suiteStarted',
+  },
+  {
+    module: {
+      name: '@wdio/jasmine-framework',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      className: 'JasmineReporter',
+      methodName: 'suiteDone',
+      kind: 'Sync',
+    },
+    channelName: 'JasmineReporter_suiteDone',
+  },
+  {
+    module: {
+      name: '@wdio/utils',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      expressionName: 'testFrameworkFnWrapper',
+      kind: 'Async',
+    },
+    channelName: 'testFrameworkFnWrapper',
+  },
+  {
+    module: {
+      name: '@wdio/utils',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    functionQuery: {
+      functionName: 'executeAsync',
+      kind: 'Async',
+    },
+    channelName: 'executeAsync',
+  },
+  {
+    module: {
+      name: '@wdio/utils',
+      versionRange: '>=9.0.0',
+      filePath: 'build/index.js',
+    },
+    astQuery: 'FunctionDeclaration[id.name="executeAsync"] CatchClause ' +
+      'IfStatement[test.operator=">"][test.left.object.name="retries"]' +
+      '[test.left.property.name="limit"][test.right.object.name="retries"]' +
+      '[test.right.property.name="attempts"]',
+    channelName: 'executeAsync',
+    transform: 'awaitContextCallback',
+    transformOptions: {
+      callbackArgumentNames: ['err'],
+      callbackName: 'retryCallback',
+    },
+  },
+  {
+    module: {
+      name: 'jasmine-core',
+      versionRange: '>=5.0.0 <6.0.0',
+      filePath: 'lib/jasmine-core/jasmine.js',
+    },
+    astQuery: 'AssignmentExpression[left.object.object.name="Spec"]' +
+      '[left.object.property.name="prototype"][left.property.name="execute"] > FunctionExpression',
+    functionQuery: {
+      kind: 'Sync',
+    },
+    channelName: 'Spec_execute',
+  },
+  {
+    module: {
+      name: 'jasmine-core',
+      versionRange: '>=5.0.0 <6.0.0',
+      filePath: 'lib/jasmine-core/jasmine.js',
+    },
+    astQuery: 'AssignmentExpression[left.object.object.name="Spec"]' +
+      '[left.object.property.name="prototype"][left.property.name="status"] > FunctionExpression',
+    functionQuery: {
+      kind: 'Sync',
+    },
+    channelName: 'Spec_attemptDone',
+  },
+  {
+    module: {
+      name: 'jasmine-core',
+      versionRange: '>=5.0.0 <6.0.0',
+      filePath: 'lib/jasmine-core/jasmine.js',
+    },
+    functionQuery: {
+      className: 'Spec',
+      methodName: 'executionFinished',
+      kind: 'Sync',
+    },
+    channelName: 'Spec_attemptDone',
+  },
+  {
+    module: {
+      name: 'jasmine-core',
+      versionRange: '>=5.0.0 <6.0.0',
+      filePath: 'lib/jasmine-core/jasmine.js',
+    },
+    functionQuery: {
+      className: 'TreeRunner',
+      methodName: '_executeSpec',
+      kind: 'Sync',
+    },
+    channelName: 'Spec_execute',
+  },
 ]

package/packages/datadog-instrumentations/src/helpers/rewriter/loader.mjs

@@ -1,4 +1,8 @@
-import { rewrite } from './index.js'
+import * as Module from 'module'
+
+const require = Module.createRequire(import.meta.url)
+const { getRewriteTarget } = require('./targets.js')
+let rewriter
 
 async function load (url, context, nextLoad) {
   const result = await nextLoad(url, context)
@@ -12,6 +16,11 @@ function loadSync (url, context, nextLoad) {
   return rewriteResult(result, url, context)
 }
 
+/**
+ * @param {{ format?: string, source?: unknown }} result
+ * @param {string} url
+ * @param {{ format?: string }} context
+ */
 function rewriteResult (result, url, context) {
   const format = result.format || context.format
 
@@ -19,7 +28,16 @@ function rewriteResult (result, url, context) {
   // double-instruments CommonJS entrypoints loaded through sync hooks.
   if (format === 'commonjs') return result
 
-  result.source = rewrite(result.source, url, format)
+  if (result.source) {
+    const target = getRewriteTarget(url)
+    if (target) {
+      if (!rewriter) {
+        rewriter = require('./index.js')
+      }
+
+      result.source = rewriter.rewrite(result.source, url, format, target)
+    }
+  }
 
   return result
 }

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

@@ -0,0 +1,32 @@
+'use strict'
+
+// Generated by scripts/generate-rewriter-targets.js from ./instrumentations. Do not edit by hand.
+const targets = require('./targets.json')
+
+const NODE_MODULES = '/node_modules/'
+
+/**
+ * @typedef {object} RewriteTarget
+ * @property {string} moduleName
+ * @property {string} filePath
+ */
+
+/**
+ * @param {string} filename
+ * @returns {RewriteTarget|undefined}
+ */
+function getRewriteTarget (filename) {
+  const nodeModulesIndex = filename.lastIndexOf(NODE_MODULES)
+  if (nodeModulesIndex === -1) return
+
+  const modulePath = filename.slice(nodeModulesIndex + NODE_MODULES.length)
+  const moduleName = targets[modulePath]
+  if (typeof moduleName !== 'string') return
+
+  return {
+    moduleName,
+    filePath: modulePath.slice(moduleName.length + 1),
+  }
+}
+
+module.exports = { getRewriteTarget }

package/packages/datadog-instrumentations/src/helpers/rewriter/targets.json

@@ -0,0 +1,62 @@
+{
+  "@anthropic-ai/claude-agent-sdk/sdk.mjs": "@anthropic-ai/claude-agent-sdk",
+  "@aws/durable-execution-sdk-js/dist-cjs/index.js": "@aws/durable-execution-sdk-js",
+  "@aws/durable-execution-sdk-js/dist/index.mjs": "@aws/durable-execution-sdk-js",
+  "@azure/cosmos/dist/browser/plugins/Plugin.js": "@azure/cosmos",
+  "@azure/cosmos/dist/commonjs/plugins/Plugin.js": "@azure/cosmos",
+  "@azure/cosmos/dist/esm/plugins/Plugin.js": "@azure/cosmos",
+  "@azure/cosmos/dist/react-native/plugins/Plugin.js": "@azure/cosmos",
+  "@graphql-tools/executor/cjs/execution/execute.js": "@graphql-tools/executor",
+  "@graphql-tools/executor/cjs/execution/normalizedExecutor.js": "@graphql-tools/executor",
+  "@graphql-tools/executor/esm/execution/execute.js": "@graphql-tools/executor",
+  "@graphql-tools/executor/esm/execution/normalizedExecutor.js": "@graphql-tools/executor",
+  "@langchain/core/dist/embeddings.cjs": "@langchain/core",
+  "@langchain/core/dist/embeddings.js": "@langchain/core",
+  "@langchain/core/dist/language_models/chat_models.cjs": "@langchain/core",
+  "@langchain/core/dist/language_models/chat_models.js": "@langchain/core",
+  "@langchain/core/dist/language_models/llms.cjs": "@langchain/core",
+  "@langchain/core/dist/language_models/llms.js": "@langchain/core",
+  "@langchain/core/dist/runnables/base.cjs": "@langchain/core",
+  "@langchain/core/dist/runnables/base.js": "@langchain/core",
+  "@langchain/core/dist/tools/index.cjs": "@langchain/core",
+  "@langchain/core/dist/tools/index.js": "@langchain/core",
+  "@langchain/core/dist/vectorstores.cjs": "@langchain/core",
+  "@langchain/core/dist/vectorstores.js": "@langchain/core",
+  "@langchain/langgraph/dist/pregel/index.cjs": "@langchain/langgraph",
+  "@langchain/langgraph/dist/pregel/index.js": "@langchain/langgraph",
+  "@modelcontextprotocol/sdk/dist/cjs/client/index.js": "@modelcontextprotocol/sdk",
+  "@modelcontextprotocol/sdk/dist/cjs/server/mcp.js": "@modelcontextprotocol/sdk",
+  "@modelcontextprotocol/sdk/dist/esm/client/index.js": "@modelcontextprotocol/sdk",
+  "@modelcontextprotocol/sdk/dist/esm/server/mcp.js": "@modelcontextprotocol/sdk",
+  "@openai/agents-openai/dist/openaiChatCompletionsModel.js": "@openai/agents-openai",
+  "@openai/agents-openai/dist/openaiChatCompletionsModel.mjs": "@openai/agents-openai",
+  "@wdio/cli/build/index.js": "@wdio/cli",
+  "@wdio/jasmine-framework/build/index.js": "@wdio/jasmine-framework",
+  "@wdio/local-runner/build/index.js": "@wdio/local-runner",
+  "@wdio/utils/build/index.js": "@wdio/utils",
+  "ai/dist/index.js": "ai",
+  "ai/dist/index.mjs": "ai",
+  "bullmq/dist/cjs/classes/flow-producer.js": "bullmq",
+  "bullmq/dist/cjs/classes/queue.js": "bullmq",
+  "bullmq/dist/cjs/classes/worker.js": "bullmq",
+  "bullmq/dist/esm/classes/flow-producer.js": "bullmq",
+  "bullmq/dist/esm/classes/queue.js": "bullmq",
+  "bullmq/dist/esm/classes/worker.js": "bullmq",
+  "graphql/execution/execute.js": "graphql",
+  "graphql/execution/execute.mjs": "graphql",
+  "graphql/language/parser.js": "graphql",
+  "graphql/language/parser.mjs": "graphql",
+  "graphql/language/printer.js": "graphql",
+  "graphql/language/printer.mjs": "graphql",
+  "graphql/language/visitor.js": "graphql",
+  "graphql/language/visitor.mjs": "graphql",
+  "graphql/utilities/index.js": "graphql",
+  "graphql/utilities/index.mjs": "graphql",
+  "graphql/validation/validate.js": "graphql",
+  "graphql/validation/validate.mjs": "graphql",
+  "jasmine-core/lib/jasmine-core/jasmine.js": "jasmine-core",
+  "mercurius/index.js": "mercurius",
+  "playwright-core/lib/coreBundle.js": "playwright-core",
+  "playwright/lib/index.js": "playwright",
+  "playwright/lib/runner/index.js": "playwright"
+}

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

@@ -14,7 +14,89 @@ const clone = require('../../../../../vendor/dist/rfdc')({ proto: false, circles
 
 const { parse, query } = require('./compiler')
 
-module.exports = { waitForAsyncEnd }
+const functionTypes = new Set(['ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression'])
+const identifierPattern = /^[$A-Z_a-z][$\w]*$/
+
+module.exports = { awaitContextCallback, waitForAsyncEnd }
+
+/**
+ * Awaits an optional context callback before continuing through a matched conditional branch.
+ *
+ * The branch condition is checked again after the callback settles so the
+ * original body does not run against state that changed while awaiting.
+ *
+ * @param {{
+ *   transformOptions?: {
+ *     callbackArgumentNames?: string[],
+ *     callbackName?: string
+ *   }
+ * }} state
+ * @param {import('estree').IfStatement} node
+ * @param {import('estree').Node} _parent
+ * @param {import('estree').Node[]} ancestry
+ * @returns {void}
+ */
+function awaitContextCallback (state, node, _parent, ancestry) {
+  assert(node.type === 'IfStatement' && node.consequent?.type === 'BlockStatement',
+    'awaitContextCallback: expected an if statement with a block body')
+
+  const { callbackArgumentNames = [], callbackName } = state.transformOptions ?? {}
+
+  assert(identifierPattern.test(callbackName), 'awaitContextCallback: callbackName must be an identifier')
+  assert(callbackArgumentNames.every(name => identifierPattern.test(name)),
+    'awaitContextCallback: callbackArgumentNames must be identifiers')
+
+  let enclosingFunction
+  let hasTraceWrapper = false
+  for (const ancestor of ancestry) {
+    if (!functionTypes.has(ancestor.type)) continue
+
+    enclosingFunction ??= ancestor
+    if (ancestor.body?.type !== 'BlockStatement') continue
+
+    let hasContextBinding = false
+    let hasTracedBinding = false
+    for (const statement of ancestor.body.body) {
+      if (statement.type !== 'VariableDeclaration') continue
+
+      for (const declaration of statement.declarations) {
+        hasContextBinding ||= declaration.id?.name === '__apm$ctx'
+        hasTracedBinding ||= declaration.id?.name === '__apm$traced'
+      }
+    }
+    hasTraceWrapper ||= hasContextBinding && hasTracedBinding
+  }
+
+  assert(enclosingFunction?.async, 'awaitContextCallback: expected an enclosing async function')
+  assert(hasTraceWrapper, 'awaitContextCallback: expected an enclosing trace wrapper')
+
+  const callbackVariable = `__apm$${callbackName}`
+  if (query(node, `[id.name="${callbackVariable}"]`).length > 0) {
+    return
+  }
+
+  const originalStatements = node.consequent.body
+  const callbackStatements = parse(`
+    async function wrapper () {
+      const ${callbackVariable} = __apm$ctx.${callbackName};
+      if (typeof ${callbackVariable} === 'function') {
+        try {
+          await ${callbackVariable}(${callbackArgumentNames.join(', ')});
+        } catch {}
+        if (true) {}
+      } else {
+      }
+    }
+  `).body[0].body.body
+
+  const callbackBranch = callbackStatements[1]
+  const recheckedBranch = callbackBranch.consequent.body[1]
+  recheckedBranch.test = clone(node.test)
+  recheckedBranch.consequent.body.push(...clone(originalStatements))
+  recheckedBranch.alternate = clone(node.alternate)
+  callbackBranch.alternate.body.push(...originalStatements)
+  node.consequent.body = callbackStatements
+}
 
 /**
  * Injects settlement-specific asyncEnd waits into a generated `tracePromise`

package/packages/datadog-instrumentations/src/helpers/router-helper.js

@@ -7,10 +7,25 @@ const routerMountPaths = new WeakMap() // to track mount paths for router instan
 const layerMeta = new WeakMap() // per-layer middleware dispatch metadata (resolved name + route matchers)
 const appMountedRouters = new WeakSet() // to track routers mounted via app.use()
 
+/**
+ * @typedef {object} LayerMeta
+ * @property {string} [name]
+ * @property {string} [captureRoute]
+ * @property {boolean} [needMultiMatch]
+ * @property {Array<{ path?: string, regex?: RegExp }> & {
+ *   hasStarPath?: boolean,
+ *   hasSlashPath?: boolean
+ * }} [matchers]
+ */
+
 const METHODS = [...require('http').METHODS.map(v => v.toLowerCase()), 'all']
 
 const routeAddedChannel = channel('apm:express:route:added')
 
+/**
+ * @typedef {{ stack?: Array<{ route?: unknown, handle?: ExpressRouter }> }} ExpressRouter
+ */
+
 /**
  * Joins two URL path segments into a single path
  *
@@ -57,12 +72,14 @@ function collectRoutesFromRouter (router, prefix) {
       const fullPaths = getRouteFullPaths(route, prefix)
 
       for (const fullPath of fullPaths) {
-        for (const [method, enabled] of Object.entries(route.methods || {})) {
-          if (!enabled) continue
-          routeAddedChannel.publish({
-            method: normalizeMethodName(method),
-            path: fullPath,
-          })
+        if (route.methods) {
+          for (const [method, enabled] of Object.entries(route.methods)) {
+            if (!enabled) continue
+            routeAddedChannel.publish({
+              method: normalizeMethodName(method),
+              path: fullPath,
+            })
+          }
         }
       }
     } else if (layer.handle?.stack?.length) {
@@ -121,10 +138,19 @@ function getRouterMountPaths (router) {
   return [...paths]
 }
 
+/**
+ * @param {object} layer
+ * @param {LayerMeta} meta
+ * @returns {void}
+ */
 function setLayerMeta (layer, meta) {
   layerMeta.set(layer, meta)
 }
 
+/**
+ * @param {object} layer
+ * @returns {LayerMeta | undefined}
+ */
 function getLayerMeta (layer) {
   return layerMeta.get(layer)
 }
@@ -157,6 +183,8 @@ function isAppMounted (router) {
  * Express accepts strings, regex, arrays (possibly nested), or
  * no mount path at all; this helper returns the flattened set of paths along
  * with the index where actual middleware arguments start.
+ *
+ * @param {unknown} path First `use()` argument, which may be a mount path or already a middleware.
  */
 function extractMountPaths (path) {
   const hasMount = typeof path === 'string' || path instanceof RegExp || Array.isArray(path)
@@ -174,6 +202,9 @@ function extractMountPaths (path) {
 
 /**
  * Detect cycle router graphs.
+ *
+ * @param {ExpressRouter | undefined} router
+ * @param {Set<ExpressRouter>} [stack]
  */
 function hasRouterCycle (router, stack = new Set()) {
   if (!router?.stack?.length) return false

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

@@ -14,7 +14,7 @@ const TRANSFORM_OPTIONS = {
 
 function getCoverageBackfillFiles (skippableSuitesCoverage, rootDir, getTestSuitePath) {
   const files = []
-  for (const filename of Object.keys(skippableSuitesCoverage || {})) {
+  for (const filename of Object.keys(skippableSuitesCoverage)) {
     const relativeFilename = path.isAbsolute(filename)
       ? getTestSuitePath(filename, rootDir)
       : filename