DataDog · wconti27 · Nov 19, 2025 · Nov 20, 2025 · Nov 21, 2025 · Nov 21, 2025
@@ -135,3 +135,10 @@ packages/datadog-plugin-azure-functions/test/integration-test/fixtures/node_modu
 __azurite_db_queue__.json
 __azurite_db_queue_extent__.json
 __queuestorage__/AzuriteConfig
+
+
+# ignore apm-instrumentation-toolkit analysis results dirs
+.analysis/
+
+# ignore claude settings
+.claude/
@@ -48,6 +48,7 @@ export default [
       '**/versions', // This is effectively a node_modules tree.
       '**/acmeair-nodejs', // We don't own this.
       '**/vendor', // Generally, we didn't author this code.
+      '**/.analysis', // Ignore apm-instrumentation-toolkit analysis results
       'integration-tests/code-origin/typescript.js', // Generated
       'integration-tests/debugger/target-app/source-map-support/bundle.js', // Generated
       'integration-tests/debugger/target-app/source-map-support/hello/world.js', // Generated

@@ -22,6 +22,11 @@ const { DEBUG } = process.env
 // This is set by the setShouldKill function
 let shouldKill
 
+// Symbol constants for dynamic value matching in assertObjectContains
+const ANY_STRING = Symbol.for('test.ANY_STRING')
+const ANY_NUMBER = Symbol.for('test.ANY_NUMBER')
+const ANY_VALUE = Symbol.for('test.ANY_VALUE')
+
 /**
  * @param {string} filename
  * @param {string} cwd
@@ -57,7 +62,7 @@ async function runAndCheckOutput (filename, cwd, expectedOut, expectedSource) {
 
   if (expectedSource) {
     assert.match(out, new RegExp(`instrumentation source: ${expectedSource}`),
-    `Expected the process to output "${expectedSource}", but logs only contain: "${out}"`)
+      `Expected the process to output "${expectedSource}", but logs only contain: "${out}"`)
   }
   return pid
 }
@@ -80,9 +85,9 @@ async function runAndCheckWithTelemetry (filename, expectedOut, expectedTelemetr
   const msgs = await cleanup()
   if (expectedTelemetryPoints.length === 0) {
     // assert no telemetry sent
-    assert.strictEqual(msgs.length, 0, `Expected no telemetry, but got:\n${
-      msgs.map(msg => JSON.stringify(msg[1].points)).join('\n')
-    }`)
+    assert.strictEqual(
+      msgs.length, 0, `Expected no telemetry, but got:\n${msgs.map(msg => JSON.stringify(msg[1].points)).join('\n')
+      }`)
   } else {
     assertTelemetryPoints(pid, msgs, expectedTelemetryPoints)
   }
@@ -633,9 +638,8 @@ function setShouldKill (value) {
   })
 }
 
-// @ts-expect-error assert.partialDeepStrictEqual does not exist on older Node.js versions
-// eslint-disable-next-line n/no-unsupported-features/node-builtins
-const assertObjectContains = assert.partialDeepStrictEqual || function assertObjectContains (actual, expected) {
+// we use our own assertObjectContains, to account for any types
+const assertObjectContains = function assertObjectContains (actual, expected) {
   if (Array.isArray(expected)) {
     assert.ok(Array.isArray(actual), `Expected array but got ${typeof actual}`)
     let startIndex = 0
@@ -662,7 +666,13 @@ const assertObjectContains = assert.partialDeepStrictEqual || function assertObj
   }
 
   for (const [key, val] of Object.entries(expected)) {
-    if (val !== null && typeof val === 'object') {
+    if (val === ANY_STRING) {
+      assert.strictEqual(typeof actual[key], 'string', `Expected ${key} to be a string but got ${typeof actual[key]}`)
+    } else if (val === ANY_NUMBER) {
+      assert.strictEqual(typeof actual[key], 'number', `Expected ${key} to be a number but got ${typeof actual[key]}`)
+    } else if (val === ANY_VALUE) {
+      assert.ok(actual[key] !== undefined, `Expected ${key} to be present but it was undefined`)
+    } else if (val !== null && typeof val === 'object') {
       assert.ok(Object.hasOwn(actual, key))
       assert.notStrictEqual(actual[key], null)
       assert.strictEqual(typeof actual[key], 'object')

@@ -5,11 +5,17 @@ const StoragePlugin = require('./storage')
 class CachePlugin extends StoragePlugin {
   static operation = 'command'
 
-  startSpan (options, ctx) {
+  startSpan (name, options, ctx) {
+    if (typeof name === 'object' && name !== null && ctx === undefined) {
+      ctx = options
+      options = name
+      name = this.operationName()
+    }
+
     if (!options.kind) {
       options.kind = this.constructor.kind
     }
-    return super.startSpan(this.operationName(), options, ctx)
+    return super.startSpan(name, options, ctx)
   }
 }
 

@@ -7,14 +7,20 @@ class ConsumerPlugin extends InboundPlugin {
   static kind = 'consumer'
   static type = 'messaging'
 
-  startSpan (options, enterOrCtx) {
+  startSpan (name, options, enterOrCtx) {
+    if (typeof name === 'object' && name !== null && enterOrCtx === undefined) {
+      enterOrCtx = options
+      options = name
+      name = this.operationName()
+    }
+
     if (!options.service) {
       options.service = this.config.service || this.serviceName()
     }
     if (!options.kind) {
       options.kind = this.constructor.kind
     }
-    return super.startSpan(this.operationName(), options, enterOrCtx)
+    return super.startSpan(name, options, enterOrCtx)
   }
 }
 

@@ -7,7 +7,13 @@ class ProducerPlugin extends OutboundPlugin {
   static kind = 'producer'
   static type = 'messaging'
 
-  startSpan (options, enterOrCtx) {
+  startSpan (name, options, enterOrCtx) {
+    if (typeof name === 'object' && name !== null && enterOrCtx === undefined) {
+      enterOrCtx = options
+      options = name
+      name = this.operationName()
+    }
+
     const spanDefaults = {
       kind: this.constructor.kind
     }
@@ -19,7 +25,7 @@ class ProducerPlugin extends OutboundPlugin {
         if (!options[key]) options[key] = spanDefaults[key]
       }
     )
-    return super.startSpan(this.operationName(), options, enterOrCtx)
+    return super.startSpan(name, options, enterOrCtx)
   }
 }
 

@@ -66,31 +66,35 @@ class TracingPlugin extends Plugin {
     this.addError(ctxOrError)
   }
 
-  addTraceSubs () {
+  registerOperation (channelName) {
+    this.addTraceSubs(channelName)
+  }
+
+  addTraceSubs (channelName) {
     const events = ['start', 'end', 'asyncStart', 'asyncEnd', 'error', 'finish']
 
     for (const event of events) {
       const bindName = `bind${event.charAt(0).toUpperCase()}${event.slice(1)}`
 
       if (this[event]) {
         this.addTraceSub(event, message => {
-          this[event](message)
-        })
+          this[event](message, channelName)
+        }, channelName)
       }
 
       if (this[bindName]) {
-        this.addTraceBind(event, message => this[bindName](message))
+        this.addTraceBind(event, message => this[bindName](message, channelName), channelName)
       }
     }
   }
 
-  addTraceSub (eventName, handler) {
-    const prefix = this.constructor.prefix || `apm:${this.component}:${this.operation}`
+  addTraceSub (eventName, handler, channelName) {
+    const prefix = channelName || this.constructor.prefix || `apm:${this.component}:${this.operation}`
     this.addSub(`${prefix}:${eventName}`, handler)
   }
 
-  addTraceBind (eventName, transform) {
-    const prefix = this.constructor.prefix || `apm:${this.component}:${this.operation}`
+  addTraceBind (eventName, transform, channelName) {
+    const prefix = channelName || this.constructor.prefix || `apm:${this.component}:${this.operation}`
     this.addBind(`${prefix}:${eventName}`, transform)
   }
 

@@ -0,0 +1,62 @@
+'use strict'
+
+const { describe, it, beforeEach, afterEach, before, after } = require('mocha')
+const { expect } = require('chai')
+const agent = require('../../../plugins/agent')
+const { withVersions } = require('../../mocha')
+
+function createIntegrationTestSuite (pluginName, packageName, testSetup, options, testCallback) {
+  describe('Plugin', () => {
+    describe(pluginName, () => {
+      withVersions(pluginName, packageName, version => {
+        createVersionedTests(pluginName, packageName, testSetup, options, version, testCallback)
+      })
+    })
+  })
+}
+
+function createVersionedTests (pluginName, packageName, testSetup, options = {}, version, testCallback) {
+  let tracer = null
+  let mod = null
+
+  describe('without configuration', () => {
+    before(async () => {
+      const plugins = [pluginName, ...(options.additionalPlugins || [])]
+      const pluginConfigs = [options.pluginConfig || {}, ...(options.additionalPlugins || []).map(() => ({}))]
+      await agent.load(plugins, pluginConfigs)
+    })
+
+    after(async () => {
+      await agent.close({ ritmReset: false })
+    })
+
+    before(async () => {
+      tracer = require('../../../../../dd-trace').init()
+      mod = require(`../../../../../../versions/${packageName}@${version}`)
+      mod = options.subModule ? mod.get(options.subModule) : mod.get()
+      await testSetup.setup(mod)
+    })
+
+    after(async () => {
+      if (testSetup?.teardown) {
+        await testSetup.teardown()
+      }
+    })
+
+    if (testCallback) {
+      testCallback({
+        testSetup,
+        agent,
+        tracer,
+        expect,
+        describe,
+        it,
+        beforeEach,
+        afterEach,
+        mod
+      })
+    }
+  })
+}
+
+module.exports = { createIntegrationTestSuite }