dd-trace 5.81.0 → 5.82.0

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

@@ -1,8 +1,8 @@
 'use strict'
 
 const { errorMonitor } = require('events')
-const { channel, addHook } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
+const { channel, addHook } = require('./helpers/instrument')
 
 const startChannel = channel('apm:fs:operation:start')
 const finishChannel = channel('apm:fs:operation:finish')

package/packages/datadog-instrumentations/src/generic-pool.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const { addHook, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
+const { addHook, AsyncResource } = require('./helpers/instrument')
 
 function createWrapAcquire () {
   return function wrapAcquire (acquire) {

package/packages/datadog-instrumentations/src/google-cloud-pubsub.js

@@ -1,10 +1,10 @@
 'use strict'
 
+const shimmer = require('../../datadog-shimmer')
 const {
   channel,
   addHook
 } = require('./helpers/instrument')
-const shimmer = require('../../datadog-shimmer')
 
 const requestStartCh = channel('apm:google-cloud-pubsub:request:start')
 const requestFinishCh = channel('apm:google-cloud-pubsub:request:finish')
@@ -14,6 +14,21 @@ const receiveStartCh = channel('apm:google-cloud-pubsub:receive:start')
 const receiveFinishCh = channel('apm:google-cloud-pubsub:receive:finish')
 const receiveErrorCh = channel('apm:google-cloud-pubsub:receive:error')
 
+/**
+ * Message-level channels for trace context injection and async context propagation:
+ * - messagePublishCh: Inject trace context when Topic.publish() is called
+ * - messageAckStoreCh: Store async context when message.ack() is called (PULL)
+ * - messageAckRetrieveCh: Retrieve stored context when acknowledge() API is called (PULL)
+ * - messageStoreCh: Propagate context when Subscription emits 'message' event (PULL)
+ */
+const messagePublishCh = channel('apm:google-cloud-pubsub:message:publish')
+const messageAckStoreCh = channel('apm:google-cloud-pubsub:message:ack-store')
+const messageAckRetrieveCh = channel('apm:google-cloud-pubsub:message:ack-retrieve')
+const messageStoreCh = channel('apm:google-cloud-pubsub:message:store')
+
+// WeakMap for passing context between LeaseManager._dispense and LeaseManager.remove
+const messageContexts = new WeakMap()
+
 const publisherMethods = [
   'createTopic',
   'updateTopic',
@@ -65,6 +80,21 @@ function wrapMethod (method) {
     if (!requestStartCh.hasSubscribers) return method.apply(this, arguments)
 
     const ctx = { request, api, projectId: this.auth._cachedProjectId }
+
+    /**
+     * For acknowledge/modifyAckDeadline: retrieve stored context from consumer plugin.
+     * These APIs only have ackIds (no Message objects), so async context is lost.
+     * Plugin sets ctx.storedContext, which client.js uses to link the acknowledge span.
+     */
+    const isAckOperation = api === 'acknowledge' || api === 'modifyAckDeadline'
+    if (isAckOperation && request?.ackIds?.length > 0) {
+      messageAckRetrieveCh.publish({
+        ackIds: request.ackIds,
+        api,
+        ctx
+      })
+    }
+
     return requestStartCh.runStores(ctx, () => {
       const cb = arguments[arguments.length - 1]
 
@@ -74,12 +104,11 @@ function wrapMethod (method) {
             ctx.error = error
             requestErrorCh.publish(ctx)
           }
-
           return requestFinishCh.runStores(ctx, cb, this, ...arguments)
         })
-
         return method.apply(this, arguments)
       }
+
       return method.apply(this, arguments)
         .then(
           response => {
@@ -108,12 +137,16 @@ function massWrap (obj, methods, wrapper) {
 addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
   const Subscription = obj.Subscription
 
+  /**
+   * PULL: Intercept 'message' events and propagate async context via runStores.
+   * This ensures the consumer plugin creates spans in the correct context.
+   */
   shimmer.wrap(Subscription.prototype, 'emit', emit => function (eventName, message) {
     if (eventName !== 'message' || !message) return emit.apply(this, arguments)
 
-    const ctx = {}
+    const ctx = { message }
     try {
-      return emit.apply(this, arguments)
+      return messageStoreCh.runStores(ctx, emit, this, ...arguments)
     } catch (err) {
       ctx.error = err
       receiveErrorCh.publish(ctx)
@@ -124,26 +157,70 @@ addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
   return obj
 })
 
+addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'], file: 'build/src/subscriber.js' }, (obj) => {
+  const Message = obj.Message
+
+  /**
+   * PULL: Capture async context when message.ack() is called.
+   * This is our last chance before context is lost. The acknowledge() API call happens
+   * later (often batched), and we'll retrieve this stored context to link spans.
+   * Flow: message.ack() -> store context -> acknowledge() API -> retrieve context
+   */
+  if (Message?.prototype?.ack) {
+    shimmer.wrap(Message.prototype, 'ack', originalAck => function () {
+      if (this.ackId) {
+        const ctx = {
+          message: this,
+          ackId: this.ackId
+        }
+
+        return messageAckStoreCh.runStores(ctx, originalAck, this, ...arguments)
+      }
+
+      return originalAck.apply(this, arguments)
+    })
+  }
+
+  return obj
+})
+
+/**
+ * PULL: Hook LeaseManager to track message lifecycle (dispense/remove/clear).
+ * _dispense: Message given to handler -> create span
+ * remove: Message removed from lease (ack/nack/timeout) -> finish span
+ * clear: Subscription closed -> finish all remaining spans
+ */
 addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'], file: 'build/src/lease-manager.js' }, (obj) => {
   const LeaseManager = obj.LeaseManager
-  const ctx = {}
+  if (!LeaseManager) {
+    return obj
+  }
 
   shimmer.wrap(LeaseManager.prototype, '_dispense', dispense => function (message) {
-    if (receiveStartCh.hasSubscribers) {
-      ctx.message = message
-      return receiveStartCh.runStores(ctx, dispense, this, ...arguments)
-    }
-    return dispense.apply(this, arguments)
+    const ctx = { message }
+    messageContexts.set(message, ctx)
+
+    return receiveStartCh.runStores(ctx, dispense, this, ...arguments)
   })
 
   shimmer.wrap(LeaseManager.prototype, 'remove', remove => function (message) {
-    return receiveFinishCh.runStores(ctx, remove, this, ...arguments)
+    const ctx = messageContexts.get(message)
+    if (ctx) {
+      messageContexts.delete(message)
+    }
+
+    return receiveFinishCh.runStores(ctx || { message }, remove, this, ...arguments)
   })
 
   shimmer.wrap(LeaseManager.prototype, 'clear', clear => function () {
-    for (const message of this._messages) {
-      ctx.message = message
-      receiveFinishCh.publish(ctx)
+    if (this._messages) {
+      for (const message of this._messages.values()) {
+        const ctx = messageContexts.get(message)
+        if (ctx) {
+          receiveFinishCh.publish(ctx)
+          messageContexts.delete(message)
+        }
+      }
     }
     return clear.apply(this, arguments)
   })
@@ -151,6 +228,51 @@ addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'], file: 'build/src/le
   return obj
 })
 
+/**
+ * Inject trace context into individual messages via Topic.publish()/publishMessage().
+ * Flow: User calls topic.publish() -> inject context (here) -> SDK batches messages ->
+ * publish() API called -> producer plugin creates batch span + metadata
+ */
+addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
+  if (!obj.Topic?.prototype) return obj
+
+  if (typeof obj.Topic.prototype.publishMessage === 'function') {
+    shimmer.wrap(obj.Topic.prototype, 'publishMessage', publishMessage => {
+      return function (data, attributesOrCallback, callback) {
+        if (data && typeof data === 'object') {
+          if (!data.attributes) data.attributes = {}
+          messagePublishCh.publish({
+            attributes: data.attributes,
+            pubsub: this.pubsub,
+            topicName: this.name
+          })
+        }
+        return publishMessage.apply(this, arguments)
+      }
+    })
+  }
+
+  if (typeof obj.Topic.prototype.publish === 'function') {
+    shimmer.wrap(obj.Topic.prototype, 'publish', publish => function (buffer, attributesOrCallback, callback) {
+      if (typeof attributesOrCallback === 'function' || !attributesOrCallback) {
+        arguments[1] = {}
+        arguments[2] = attributesOrCallback
+      }
+
+      messagePublishCh.publish({
+        attributes: arguments[1],
+        pubsub: this.pubsub,
+        topicName: this.name,
+        buffer
+      })
+
+      return publish.apply(this, arguments)
+    })
+  }
+
+  return obj
+})
+
 addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
   const { PublisherClient, SchemaServiceClient, SubscriberClient } = obj.v1
 

package/packages/datadog-instrumentations/src/google-cloud-vertexai.js

@@ -1,9 +1,8 @@
 'use strict'
 
-const { addHook } = require('./helpers/instrument')
-const shimmer = require('../../datadog-shimmer')
-
 const vertexaiTracingChannel = require('dc-polyfill').tracingChannel('apm:vertexai:request')
+const shimmer = require('../../datadog-shimmer')
+const { addHook } = require('./helpers/instrument')
 
 function wrapGenerate (generate) {
   return function (request) {

package/packages/datadog-instrumentations/src/google-genai.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { addHook } = require('./helpers/instrument')
+const { channel, tracingChannel } = require('dc-polyfill')
+
 const shimmer = require('../../datadog-shimmer')
-const tracingChannel = require('dc-polyfill').tracingChannel
-const channel = require('dc-polyfill').channel
+const { addHook } = require('./helpers/instrument')
 
 const genaiTracingChannel = tracingChannel('apm:google:genai:request')
 const onStreamedChunkCh = channel('apm:google:genai:request:chunk')

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

@@ -1,10 +1,10 @@
 'use strict'
 
+const shimmer = require('../../datadog-shimmer')
 const {
   addHook,
   channel
 } = require('./helpers/instrument')
-const shimmer = require('../../datadog-shimmer')
 
 const ddGlobal = globalThis[Symbol.for('dd-trace')] ??= {}
 

package/packages/datadog-instrumentations/src/grpc/client.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const types = require('./types')
 const { addHook, channel } = require('../helpers/instrument')
 const shimmer = require('../../../datadog-shimmer')
+const types = require('./types')
 
 const patched = new WeakSet()
 const instances = new WeakMap()

package/packages/datadog-instrumentations/src/grpc/server.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const types = require('./types')
 const { channel, addHook } = require('../helpers/instrument')
 const shimmer = require('../../../datadog-shimmer')
+const types = require('./types')
 
 const startChannel = channel('apm:grpc:server:request:start')
 const asyncStartChannel = channel('apm:grpc:server:request:asyncStart')

package/packages/datadog-instrumentations/src/helpers/bundler-register.js

@@ -2,6 +2,7 @@
 
 const dc = require('dc-polyfill')
 
+const log = require('../../../dd-trace/src/log')
 const {
   filename,
   loadChannel,
@@ -9,7 +10,6 @@ const {
 } = require('./register.js')
 const hooks = require('./hooks')
 const instrumentations = require('./instrumentations')
-const log = require('../../../dd-trace/src/log')
 
 const CHANNEL = 'dd-trace:bundler:load'
 

package/packages/datadog-instrumentations/src/helpers/hook.js

@@ -1,6 +1,6 @@
 'use strict'
-const iitm = require('../../../dd-trace/src/iitm')
 const path = require('path')
+const iitm = require('../../../dd-trace/src/iitm')
 const ritm = require('../../../dd-trace/src/ritm')
 
 /**

package/packages/datadog-instrumentations/src/helpers/hooks.js

@@ -29,7 +29,8 @@ module.exports = {
   '@node-redis/client': () => require('../redis'),
   '@opensearch-project/opensearch': () => require('../opensearch'),
   '@opentelemetry/sdk-trace-node': () => require('../otel-sdk-trace'),
-  '@prisma/client': () => require('../prisma'),
+  '@prisma/client': { esmFirst: true, fn: () => require('../prisma') },
+  './runtime/library.js': () => require('../prisma'),
   '@redis/client': () => require('../redis'),
   '@smithy/smithy-client': () => require('../aws-sdk'),
   '@vitest/runner': { esmFirst: true, fn: () => require('../vitest') },
@@ -41,6 +42,7 @@ module.exports = {
   'aws-sdk': () => require('../aws-sdk'),
   bluebird: () => require('../bluebird'),
   'body-parser': () => require('../body-parser'),
+  bullmq: () => require('../bullmq'),
   bunyan: () => require('../bunyan'),
   'cassandra-driver': () => require('../cassandra-driver'),
   child_process: () => require('../child_process'),
@@ -83,6 +85,7 @@ module.exports = {
   kafkajs: () => require('../kafkajs'),
   langchain: () => require('../langchain'),
   ldapjs: () => require('../ldapjs'),
+  'light-my-request': () => require('../light-my-request'),
   'limitd-client': () => require('../limitd-client'),
   lodash: () => require('../lodash'),
   mariadb: () => require('../mariadb'),

package/packages/datadog-instrumentations/src/helpers/instrument.js

@@ -1,9 +1,9 @@
 'use strict'
 
+const { AsyncResource } = require('async_hooks')
 const dc = require('dc-polyfill')
 const instrumentations = require('./instrumentations')
 const rewriterInstrumentations = require('./rewriter/instrumentations')
-const { AsyncResource } = require('async_hooks')
 
 const channelMap = {}
 exports.channel = function (name) {

package/packages/datadog-instrumentations/src/helpers/register.js

@@ -1,15 +1,16 @@
 'use strict'
 
-const { channel } = require('dc-polyfill')
 const path = require('path')
+const { channel } = require('dc-polyfill')
 const satisfies = require('../../../../vendor/dist/semifies')
-const Hook = require('./hook')
 const requirePackageJson = require('../../../dd-trace/src/require-package-json')
 const log = require('../../../dd-trace/src/log')
-const checkRequireCache = require('./check-require-cache')
 const telemetry = require('../../../dd-trace/src/guardrails/telemetry')
 const { isInServerlessEnvironment } = require('../../../dd-trace/src/serverless')
 const { getEnvironmentVariables } = require('../../../dd-trace/src/config-helper')
+const checkRequireCache = require('./check-require-cache')
+const Hook = require('./hook')
+const { isRelativeRequire } = require('./shared-utils')
 const rewriter = require('./rewriter')
 
 const envs = getEnvironmentVariables()
@@ -104,6 +105,8 @@ for (const packageName of names) {
       hook[HOOK_SYMBOL] ??= new WeakSet()
       let matchesFile = moduleName === fullFilename
 
+      if (!matchesFile && isRelativeRequire(name)) matchesFile = true
+
       if (fullFilePattern) {
         // Some libraries include a hash in their filenames when installed,
         // so our instrumentation has to include a '.*' to match them for more than a single version.
@@ -219,7 +222,6 @@ function parseHookInstrumentationFileName (packageName) {
     hook = hook.fn
   }
   const hookString = hook.toString()
-
   const regex = /require\('([^']*)'\)/
   const match = hookString.match(regex)
 

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

@@ -34,11 +34,11 @@ Orchestrion-JS that will need to be backported:
 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 transforms = require('./transforms')
 const { generate, parse, traverse } = require('./compiler')
-const log = require('../../../../dd-trace/src/log')
 const instrumentations = require('./instrumentations')
-const { getEnvironmentVariable } = require('../../../../dd-trace/src/config-helper')
 
 const NODE_OPTIONS = getEnvironmentVariable('NODE_OPTIONS')
 

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

@@ -0,0 +1,106 @@
+[
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/cjs/classes/queue.js"
+    },
+    "functionQuery": {
+      "methodName": "add",
+      "className": "Queue",
+      "kind": "Async"
+    },
+    "channelName": "Queue_add"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/cjs/classes/queue.js"
+    },
+    "functionQuery": {
+      "methodName": "addBulk",
+      "className": "Queue",
+      "kind": "Async"
+    },
+    "channelName": "Queue_addBulk"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/cjs/classes/worker.js"
+    },
+    "functionQuery": {
+      "methodName": "callProcessJob",
+      "className": "Worker",
+      "kind": "Async"
+    },
+    "channelName": "Worker_callProcessJob"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/cjs/classes/flow-producer.js"
+    },
+    "functionQuery": {
+      "methodName": "add",
+      "className": "FlowProducer",
+      "kind": "Async"
+    },
+    "channelName": "FlowProducer_add"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/esm/classes/queue.js"
+    },
+    "functionQuery": {
+      "methodName": "add",
+      "className": "Queue",
+      "kind": "Async"
+    },
+    "channelName": "Queue_add"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/esm/classes/queue.js"
+    },
+    "functionQuery": {
+      "methodName": "addBulk",
+      "className": "Queue",
+      "kind": "Async"
+    },
+    "channelName": "Queue_addBulk"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/esm/classes/worker.js"
+    },
+    "functionQuery": {
+      "methodName": "callProcessJob",
+      "className": "Worker",
+      "kind": "Async"
+    },
+    "channelName": "Worker_callProcessJob"
+  },
+  {
+    "module": {
+      "name": "bullmq",
+      "versionRange": ">=5.66.0",
+      "filePath": "dist/esm/classes/flow-producer.js"
+    },
+    "functionQuery": {
+      "methodName": "add",
+      "className": "FlowProducer",
+      "kind": "Async"
+    },
+    "channelName": "FlowProducer_add"
+  }
+]

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

@@ -1,5 +1,6 @@
 'use strict'
 
 module.exports = [
-  ...require('./langchain')
+  ...require('./langchain'),
+  ...require('./bullmq')
 ]

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

@@ -1,7 +1,7 @@
 'use strict'
 
-const { channel } = require('./instrument')
 const shimmer = require('../../../datadog-shimmer')
+const { channel } = require('./instrument')
 
 const routerMountPaths = new WeakMap() // to track mount paths for router instances
 const layerMatchers = new WeakMap() // to store layer matchers

package/packages/datadog-instrumentations/src/helpers/shared-utils.js

@@ -0,0 +1,9 @@
+'use strict'
+
+function isRelativeRequire (moduleName) {
+  return moduleName.startsWith('./') || moduleName.startsWith('../')
+}
+
+module.exports = {
+  isRelativeRequire
+}

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

@@ -9,6 +9,10 @@ const {
 const routeChannel = channel('apm:hono:request:route')
 const handleChannel = channel('apm:hono:request:handle')
 const errorChannel = channel('apm:hono:request:error')
+const nextChannel = channel('apm:hono:middleware:next')
+const enterChannel = channel('apm:hono:middleware:enter')
+const exitChannel = channel('apm:hono:middleware:exit')
+const finishChannel = channel('apm:hono:middleware:finish')
 
 function wrapFetch (fetch) {
   return function (request, env, executionCtx) {
@@ -34,21 +38,62 @@ function wrapCompose (compose) {
 
     const instrumentedMiddlewares = middlewares.map(h => {
       const [[fn, meta], params] = h
-
-      const instrumentedFn = (...args) => {
-        const context = args[0]
-        routeChannel.publish({
-          req: context.env.incoming,
-          route: meta?.path
-        })
-        return fn(...args)
-      }
-      return [[instrumentedFn, meta], params]
+      return [[wrapMiddleware(fn, meta?.path), meta], params]
     })
     return compose.call(this, instrumentedMiddlewares, instrumentedOnError, onNotFound)
   }
 }
 
+function wrapNext (req, route, next) {
+  return shimmer.wrapFunction(
+    next,
+    (next) =>
+      function () {
+        nextChannel.publish({ req, route })
+
+        return next.apply(this, arguments)
+      }
+  )
+}
+
+function wrapMiddleware (middleware, route) {
+  const name = middleware.name
+  return shimmer.wrapFunction(
+    middleware,
+    (middleware) =>
+      function (context, next) {
+        const req = context.env.incoming
+        routeChannel.publish({ req, route })
+        enterChannel.publish({ req, name, route })
+        if (typeof next === 'function') {
+          arguments[1] = wrapNext(req, route, next)
+        }
+        try {
+          const result = middleware.apply(this, arguments)
+          if (result && typeof result.then === 'function') {
+            return result.then(
+              (result) => {
+                finishChannel.publish({ req })
+                return result
+              },
+              (error) => {
+                errorChannel.publish({ req, error })
+                throw error
+              }
+            )
+          }
+          finishChannel.publish({ req })
+          return result
+        } catch (error) {
+          errorChannel.publish({ req, error })
+          throw error
+        } finally {
+          exitChannel.publish({ req, route })
+        }
+      }
+  )
+}
+
 addHook({
   name: 'hono',
   versions: ['>=4'],

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

@@ -1,10 +1,10 @@
 'use strict'
 
+const shimmer = require('../../datadog-shimmer')
 const {
   channel,
   addHook
 } = require('./helpers/instrument')
-const shimmer = require('../../datadog-shimmer')
 
 const startCh = channel('apm:ioredis:command:start')
 const finishCh = channel('apm:ioredis:command:finish')

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

@@ -1,10 +1,10 @@
 'use strict'
 
+const shimmer = require('../../datadog-shimmer')
 const {
   channel,
   addHook
 } = require('./helpers/instrument')
-const shimmer = require('../../datadog-shimmer')
 
 const startCh = channel('apm:iovalkey:command:start')
 const finishCh = channel('apm:iovalkey:command:finish')