dd-trace 3.21.0 → 3.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "3.21.0",
+  "version": "3.22.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -66,7 +66,7 @@
     "node": ">=14"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^3.1.0",
+    "@datadog/native-appsec": "^3.2.0",
     "@datadog/native-iast-rewriter": "2.0.1",
     "@datadog/native-iast-taint-tracking": "^1.4.1",
     "@datadog/native-metrics": "^2.0.0",

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

@@ -3,6 +3,7 @@ const { createCoverageMap } = require('istanbul-lib-coverage')
 
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
+const log = require('../../dd-trace/src/log')
 
 const testStartCh = channel('ci:cucumber:test:start')
 const testFinishCh = channel('ci:cucumber:test:finish') // used for test steps too
@@ -175,6 +176,12 @@ function wrapRun (pl, isLatestVersion) {
 }
 
 function pickleHook (PickleRunner) {
+  if (process.env.CUCUMBER_WORKER_ID) {
+    // Parallel mode is not supported
+    log.warn('Unable to initialize CI Visibility because Cucumber is running in parallel mode.')
+    return PickleRunner
+  }
+
   const pl = PickleRunner.default
 
   wrapRun(pl, false)
@@ -183,6 +190,12 @@ function pickleHook (PickleRunner) {
 }
 
 function testCaseHook (TestCaseRunner) {
+  if (process.env.CUCUMBER_WORKER_ID) {
+    // Parallel mode is not supported
+    log.warn('Unable to initialize CI Visibility because Cucumber is running in parallel mode.')
+    return TestCaseRunner
+  }
+
   const pl = TestCaseRunner.default
 
   wrapRun(pl, true)

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

@@ -80,6 +80,7 @@ module.exports = {
   'rhea': () => require('../rhea'),
   'router': () => require('../router'),
   'sharedb': () => require('../sharedb'),
+  'sequelize': () => require('../sequelize'),
   'tedious': () => require('../tedious'),
   'when': () => require('../when'),
   'winston': () => require('../winston')

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

@@ -101,6 +101,7 @@ function patch (http, methodName) {
   }
 
   function normalizeArgs (inputURL, inputOptions, cb) {
+    const originalUrl = inputURL
     inputURL = normalizeOptions(inputURL)
 
     const [callback, inputOptionsNormalized] = normalizeCallback(inputOptions, cb, inputURL)
@@ -108,7 +109,7 @@ function patch (http, methodName) {
     normalizeHeaders(options)
     const uri = url.format(options)
 
-    return { uri, options, callback }
+    return { uri, options, callback, originalUrl }
   }
 
   function combineOptions (inputURL, inputOptions) {

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

@@ -11,6 +11,7 @@ const startServerCh = channel('apm:http:server:request:start')
 const exitServerCh = channel('apm:http:server:request:exit')
 const errorServerCh = channel('apm:http:server:request:error')
 const finishServerCh = channel('apm:http:server:request:finish')
+const finishSetHeaderCh = channel('datadog:http:server:response:set-header:finish')
 
 const requestFinishedSet = new WeakSet()
 
@@ -58,6 +59,9 @@ function wrapEmit (emit) {
           // TODO: should this always return true ?
           return this.listenerCount(eventName) > 0
         }
+        if (finishSetHeaderCh.hasSubscribers) {
+          wrapSetHeader(res)
+        }
         return emit.apply(this, arguments)
       } catch (err) {
         errorServerCh.publish(err)
@@ -70,3 +74,13 @@ function wrapEmit (emit) {
     return emit.apply(this, arguments)
   }
 }
+
+function wrapSetHeader (res) {
+  shimmer.wrap(res, 'setHeader', setHeader => {
+    return function (name, value) {
+      const setHeaderResult = setHeader.apply(this, arguments)
+      finishSetHeaderCh.publish({ name, value, res })
+      return setHeaderResult
+    }
+  })
+}

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

@@ -3,6 +3,7 @@
 const shimmer = require('../../../datadog-shimmer')
 const { addHook, channel, AsyncResource } = require('../helpers/instrument')
 
+const connectChannel = channel('apm:http2:client:connect:start')
 const startChannel = channel('apm:http2:client:request:start')
 const finishChannel = channel('apm:http2:client:request:finish')
 const errorChannel = channel('apm:http2:client:request:error')
@@ -52,6 +53,9 @@ function createWrapRequest (authority, options) {
 
 function wrapConnect (connect) {
   return function (authority, options) {
+    if (connectChannel.hasSubscribers) {
+      connectChannel.publish({ authority })
+    }
     const session = connect.apply(this, arguments)
 
     shimmer.wrap(session, 'request', createWrapRequest(authority, options))

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

@@ -248,7 +248,7 @@ function runnerHook (runnerExport, playwrightVersion) {
 addHook({
   name: '@playwright/test',
   file: 'lib/runner.js',
-  versions: ['>=1.18.0 <1.30.0']
+  versions: ['>=1.18.0 <=1.30.0']
 }, runnerHook)
 
 addHook({

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

@@ -0,0 +1,51 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+
+const shimmer = require('../../datadog-shimmer')
+
+addHook({ name: 'sequelize', versions: ['>=4'] }, Sequelize => {
+  const startCh = channel('datadog:sequelize:query:start')
+  const finishCh = channel('datadog:sequelize:query:finish')
+
+  shimmer.wrap(Sequelize.prototype, 'query', query => {
+    return function (sql) {
+      if (!startCh.hasSubscribers) {
+        return query.apply(this, arguments)
+      }
+
+      const asyncResource = new AsyncResource('bound-anonymous-fn')
+
+      let dialect
+      if (this.options && this.options.dialect) {
+        dialect = this.options.dialect
+      } else if (this.dialect && this.dialect.name) {
+        dialect = this.dialect.name
+      }
+
+      function onFinish () {
+        asyncResource.bind(function () {
+          finishCh.publish()
+        }, this).apply(this)
+      }
+
+      return asyncResource.bind(function () {
+        startCh.publish({
+          sql,
+          dialect
+        })
+
+        const promise = query.apply(this, arguments)
+        promise.then(onFinish, onFinish)
+
+        return promise
+      }, this).apply(this, arguments)
+    }
+  })
+
+  return Sequelize
+})

package/packages/datadog-plugin-amqp10/src/consumer.js

@@ -11,11 +11,9 @@ class Amqp10ConsumerPlugin extends ConsumerPlugin {
     const source = getShortName(link)
     const address = getAddress(link)
 
-    this.startSpan('amqp.receive', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    this.startSpan({
       resource: ['receive', source].filter(v => v).join(' '),
       type: 'worker',
-      kind: 'consumer',
       meta: {
         'amqp.link.source.address': source,
         'amqp.link.role': 'receiver',

package/packages/datadog-plugin-amqp10/src/producer.js

@@ -13,10 +13,8 @@ class Amqp10ProducerPlugin extends ProducerPlugin {
     const address = getAddress(link)
     const target = getShortName(link)
 
-    this.startSpan('amqp.send', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    this.startSpan({
       resource: ['send', target].filter(v => v).join(' '),
-      kind: 'producer',
       meta: {
         'amqp.link.target.address': target,
         'amqp.link.role': 'sender',

package/packages/datadog-plugin-amqplib/src/client.js

@@ -7,6 +7,7 @@ const { getResourceName } = require('./util')
 
 class AmqplibClientPlugin extends ClientPlugin {
   static get id () { return 'amqplib' }
+  static get type () { return 'messaging' }
   static get operation () { return 'command' }
 
   start ({ channel = {}, method, fields }) {
@@ -14,10 +15,10 @@ class AmqplibClientPlugin extends ClientPlugin {
     if (method === 'basic.publish') return
 
     const stream = (channel.connection && channel.connection.stream) || {}
-    const span = this.startSpan('amqp.command', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    const span = this.startSpan(this.operationName(), {
+      service: this.config.service || this.serviceName(),
       resource: getResourceName(method, fields),
-      kind: 'client',
+      kind: this.constructor.kind,
       meta: {
         'out.host': stream._host,
         [CLIENT_PORT_KEY]: stream.remotePort,

package/packages/datadog-plugin-amqplib/src/consumer.js

@@ -13,11 +13,9 @@ class AmqplibConsumerPlugin extends ConsumerPlugin {
 
     const childOf = extract(this.tracer, message)
 
-    this.startSpan('amqp.command', {
+    this.startSpan({
       childOf,
-      service: this.config.service || `${this.tracer._service}-amqp`,
       resource: getResourceName(method, fields),
-      kind: 'consumer',
       type: 'worker',
       meta: {
         'amqp.queue': fields.queue,

package/packages/datadog-plugin-amqplib/src/producer.js

@@ -13,10 +13,8 @@ class AmqplibProducerPlugin extends ProducerPlugin {
     if (method !== 'basic.publish') return
 
     const stream = (channel.connection && channel.connection.stream) || {}
-    const span = this.startSpan('amqp.command', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    const span = this.startSpan({
       resource: getResourceName(method, fields),
-      kind: 'producer',
       meta: {
         'out.host': stream._host,
         [CLIENT_PORT_KEY]: stream.remotePort,

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

@@ -73,8 +73,8 @@ class CucumberPlugin extends CiPlugin {
         .map(filename => getTestSuitePath(filename, this.sourceRoot))
 
       const formattedCoverage = {
-        traceId: this.testSuiteSpan.context()._traceId,
-        spanId: this.testSuiteSpan.context()._spanId,
+        sessionId: this.testSuiteSpan.context()._traceId,
+        suiteId: this.testSuiteSpan.context()._spanId,
         files: relativeCoverageFiles
       }
 

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

@@ -17,13 +17,16 @@ const {
   TEST_COMMAND,
   TEST_MODULE,
   TEST_SOURCE_START,
-  finishAllTraceSpans
+  finishAllTraceSpans,
+  getCoveredFilenamesFromCoverage,
+  getTestSuitePath,
+  addIntelligentTestRunnerSpanTags
 } = require('../../dd-trace/src/plugins/util/test')
+const { ORIGIN_KEY, COMPONENT } = require('../../dd-trace/src/constants')
+const log = require('../../dd-trace/src/log')
 
 const TEST_FRAMEWORK_NAME = 'cypress'
 
-const { ORIGIN_KEY, COMPONENT } = require('../../dd-trace/src/constants')
-
 const CYPRESS_STATUS_TO_TEST_STATUS = {
   passed: 'pass',
   failed: 'fail',
@@ -52,6 +55,13 @@ function getCypressVersion (details) {
   return ''
 }
 
+function getRootDir (details) {
+  if (details && details.config) {
+    return details.config.projectRoot || details.config.repoRoot || process.cwd()
+  }
+  return process.cwd()
+}
+
 function getCypressCommand (details) {
   if (!details) {
     return TEST_FRAMEWORK_NAME
@@ -79,10 +89,62 @@ function getSuiteStatus (suiteStats) {
   return 'pass'
 }
 
+function getItrConfig (tracer, testConfiguration) {
+  return new Promise(resolve => {
+    if (!tracer._tracer._exporter || !tracer._tracer._exporter.getItrConfiguration) {
+      return resolve({ err: new Error('CI Visibility was not initialized correctly') })
+    }
+
+    tracer._tracer._exporter.getItrConfiguration(testConfiguration, (err, itrConfig) => {
+      resolve({ err, itrConfig })
+    })
+  })
+}
+
+function getSkippableTests (isSuitesSkippingEnabled, tracer, testConfiguration) {
+  if (!isSuitesSkippingEnabled) {
+    return Promise.resolve({ skippableTests: [] })
+  }
+  return new Promise(resolve => {
+    if (!tracer._tracer._exporter || !tracer._tracer._exporter.getItrConfiguration) {
+      return resolve({ err: new Error('CI Visibility was not initialized correctly') })
+    }
+    tracer._tracer._exporter.getSkippableSuites(testConfiguration, (err, skippableTests) => {
+      resolve({
+        err,
+        skippableTests
+      })
+    })
+  })
+}
+
 module.exports = (on, config) => {
   const tracer = require('../../dd-trace')
   const testEnvironmentMetadata = getTestEnvironmentMetadata(TEST_FRAMEWORK_NAME)
 
+  const {
+    'git.repository_url': repositoryUrl,
+    'git.commit.sha': sha,
+    'os.version': osVersion,
+    'os.platform': osPlatform,
+    'os.architecture': osArchitecture,
+    'runtime.name': runtimeName,
+    'runtime.version': runtimeVersion,
+    'git.branch': branch
+  } = testEnvironmentMetadata
+
+  const testConfiguration = {
+    repositoryUrl,
+    sha,
+    osVersion,
+    osPlatform,
+    osArchitecture,
+    runtimeName,
+    runtimeVersion,
+    branch,
+    testLevel: 'test'
+  }
+
   const codeOwnersEntries = getCodeOwnersFileEntries()
 
   let activeSpan = null
@@ -91,31 +153,54 @@ module.exports = (on, config) => {
   let testSuiteSpan = null
   let command = null
   let frameworkVersion
+  let rootDir
+  let isSuitesSkippingEnabled = false
+  let isCodeCoverageEnabled = false
+  let testsToSkip = []
 
   on('before:run', (details) => {
-    const childOf = getTestParentSpan(tracer)
+    return getItrConfig(tracer, testConfiguration).then(({ err, itrConfig }) => {
+      if (err) {
+        log.error(err)
+      } else {
+        isSuitesSkippingEnabled = itrConfig.isSuitesSkippingEnabled
+        isCodeCoverageEnabled = itrConfig.isCodeCoverageEnabled
+      }
 
-    command = getCypressCommand(details)
-    frameworkVersion = getCypressVersion(details)
+      getSkippableTests(isSuitesSkippingEnabled, tracer, testConfiguration).then(({ err, skippableTests }) => {
+        if (err) {
+          log.error(err)
+        } else {
+          testsToSkip = skippableTests || []
+        }
 
-    const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion, TEST_FRAMEWORK_NAME)
-    const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion, TEST_FRAMEWORK_NAME)
+        const childOf = getTestParentSpan(tracer)
+        rootDir = getRootDir(details)
 
-    testSessionSpan = tracer.startSpan(`${TEST_FRAMEWORK_NAME}.test_session`, {
-      childOf,
-      tags: {
-        [COMPONENT]: TEST_FRAMEWORK_NAME,
-        ...testEnvironmentMetadata,
-        ...testSessionSpanMetadata
-      }
-    })
-    testModuleSpan = tracer.startSpan(`${TEST_FRAMEWORK_NAME}.test_module`, {
-      childOf: testSessionSpan,
-      tags: {
-        [COMPONENT]: TEST_FRAMEWORK_NAME,
-        ...testEnvironmentMetadata,
-        ...testModuleSpanMetadata
-      }
+        command = getCypressCommand(details)
+        frameworkVersion = getCypressVersion(details)
+
+        const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion, TEST_FRAMEWORK_NAME)
+        const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion, TEST_FRAMEWORK_NAME)
+
+        testSessionSpan = tracer.startSpan(`${TEST_FRAMEWORK_NAME}.test_session`, {
+          childOf,
+          tags: {
+            [COMPONENT]: TEST_FRAMEWORK_NAME,
+            ...testEnvironmentMetadata,
+            ...testSessionSpanMetadata
+          }
+        })
+        testModuleSpan = tracer.startSpan(`${TEST_FRAMEWORK_NAME}.test_module`, {
+          childOf: testSessionSpan,
+          tags: {
+            [COMPONENT]: TEST_FRAMEWORK_NAME,
+            ...testEnvironmentMetadata,
+            ...testModuleSpanMetadata
+          }
+        })
+        return details
+      })
     })
   })
 
@@ -125,6 +210,16 @@ module.exports = (on, config) => {
       testModuleSpan.setTag(TEST_STATUS, testStatus)
       testSessionSpan.setTag(TEST_STATUS, testStatus)
 
+      addIntelligentTestRunnerSpanTags(
+        testSessionSpan,
+        testModuleSpan,
+        {
+          isSuitesSkipped: !!testsToSkip.length,
+          isSuitesSkippingEnabled,
+          isCodeCoverageEnabled
+        }
+      )
+
       testModuleSpan.finish()
       testSessionSpan.finish()
 
@@ -132,9 +227,15 @@ module.exports = (on, config) => {
     }
 
     return new Promise(resolve => {
-      tracer._tracer._exporter._writer.flush(() => {
-        resolve(null)
-      })
+      if (tracer._tracer._exporter.flush) {
+        tracer._tracer._exporter.flush(() => {
+          resolve(null)
+        })
+      } else {
+        tracer._tracer._exporter._writer.flush(() => {
+          resolve(null)
+        })
+      }
     })
   })
   on('task', {
@@ -153,9 +254,9 @@ module.exports = (on, config) => {
       })
       return null
     },
-    'dd:testSuiteFinish': (suiteStats) => {
+    'dd:testSuiteFinish': (stats) => {
       if (testSuiteSpan) {
-        const status = getSuiteStatus(suiteStats)
+        const status = getSuiteStatus(stats)
         testSuiteSpan.setTag(TEST_STATUS, status)
         testSuiteSpan.finish()
         testSuiteSpan = null
@@ -164,6 +265,12 @@ module.exports = (on, config) => {
     },
     'dd:beforeEach': (test) => {
       const { testName, testSuite } = test
+      // skip test
+      if (testsToSkip.find(test => {
+        return testName === test.name && testSuite === test.suite
+      })) {
+        return { shouldSkip: true }
+      }
 
       const testSuiteTags = {
         [TEST_COMMAND]: command,
@@ -202,11 +309,24 @@ module.exports = (on, config) => {
           }
         })
       }
-      return activeSpan ? activeSpan.context().toTraceId() : null
+      return activeSpan ? { traceId: activeSpan.context().toTraceId() } : {}
     },
-    'dd:afterEach': (test) => {
+    'dd:afterEach': ({ test, coverage }) => {
       const { state, error, isRUMActive, testSourceLine } = test
       if (activeSpan) {
+        if (coverage && tracer._tracer._exporter.exportCoverage && isCodeCoverageEnabled) {
+          const coverageFiles = getCoveredFilenamesFromCoverage(coverage)
+          const relativeCoverageFiles = coverageFiles.map(file => getTestSuitePath(file, rootDir))
+          const { _traceId, _spanId } = testSuiteSpan.context()
+          const formattedCoverage = {
+            sessionId: _traceId,
+            suiteId: _spanId,
+            testId: activeSpan.context()._spanId,
+            files: relativeCoverageFiles
+          }
+          tracer._tracer._exporter.exportCoverage(formattedCoverage)
+        }
+
         activeSpan.setTag(TEST_STATUS, CYPRESS_STATUS_TO_TEST_STATUS[state])
         if (error) {
           activeSpan.setTag('error', error)

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

@@ -1,10 +1,13 @@
 /* eslint-disable */
-beforeEach(() => {
+beforeEach(function () {
   cy.task('dd:beforeEach', {
     testName: Cypress.mocha.getRunner().suite.ctx.currentTest.fullTitle(),
     testSuite: Cypress.mocha.getRootSuite().file
-  }).then(traceId => {
+  }).then(({ traceId, shouldSkip }) => {
     Cypress.env('traceId', traceId)
+    if (shouldSkip) {
+      this.skip()
+    }
   })
 })
 
@@ -36,6 +39,6 @@ afterEach(() => {
     if (win.DD_RUM) {
       testInfo.isRUMActive = true
     }
-    cy.task('dd:afterEach', testInfo)
+    cy.task('dd:afterEach', { test: testInfo, coverage: win.__coverage__ })
   })
 })

package/packages/datadog-plugin-google-cloud-pubsub/src/client.js

@@ -4,15 +4,16 @@ const ClientPlugin = require('../../dd-trace/src/plugins/client')
 
 class GoogleCloudPubsubClientPlugin extends ClientPlugin {
   static get id () { return 'google-cloud-pubsub' }
+  static get type () { return 'messaging' }
   static get operation () { return 'request' }
 
   start ({ request, api, projectId }) {
     if (api === 'publish') return
 
-    this.startSpan('pubsub.request', {
-      service: this.config.service || `${this.tracer._service}-pubsub`,
+    this.startSpan(this.operationName(), {
+      service: this.config.service || this.serviceName(),
       resource: [api, request.name].filter(x => x).join(' '),
-      kind: 'client',
+      kind: this.constructor.kind,
       meta: {
         'pubsub.method': api,
         'gcloud.project_id': projectId

package/packages/datadog-plugin-google-cloud-pubsub/src/consumer.js

@@ -11,11 +11,9 @@ class GoogleCloudPubsubConsumerPlugin extends ConsumerPlugin {
     const topic = subscription.metadata && subscription.metadata.topic
     const childOf = this.tracer.extract('text_map', message.attributes) || null
 
-    this.startSpan('pubsub.receive', {
+    this.startSpan({
       childOf,
-      service: this.config.service,
       resource: topic,
-      kind: 'consumer',
       type: 'worker',
       meta: {
         'gcloud.project_id': subscription.pubsub.projectId,

package/packages/datadog-plugin-google-cloud-pubsub/src/producer.js

@@ -11,10 +11,8 @@ class GoogleCloudPubsubProducerPlugin extends ProducerPlugin {
 
     const messages = request.messages || []
     const topic = request.topic
-    const span = this.startSpan('pubsub.request', { // TODO: rename
-      service: this.config.service || `${this.tracer._service}-pubsub`,
+    const span = this.startSpan({ // TODO: rename
       resource: `${api} ${topic}`,
-      kind: 'producer',
       meta: {
         'gcloud.project_id': projectId,
         'pubsub.method': api, // TODO: remove