dd-trace 3.3.1 → 3.12.1

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

@@ -1,44 +1,30 @@
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const CiPlugin = require('../../dd-trace/src/plugins/ci_plugin')
 const { storage } = require('../../datadog-core')
 
 const {
-  CI_APP_ORIGIN,
   TEST_STATUS,
   JEST_TEST_RUNNER,
   finishAllTraceSpans,
   getTestEnvironmentMetadata,
   getTestParentSpan,
-  getTestCommonTags,
   getTestSessionCommonTags,
   getTestSuiteCommonTags,
   TEST_PARAMETERS,
   getCodeOwnersFileEntries,
-  getCodeOwnersForFilename,
-  TEST_CODE_OWNERS,
   TEST_SESSION_ID,
   TEST_SUITE_ID,
-  TEST_COMMAND
+  TEST_COMMAND,
+  TEST_ITR_TESTS_SKIPPED,
+  TEST_SESSION_CODE_COVERAGE_ENABLED,
+  TEST_SESSION_ITR_SKIPPING_ENABLED,
+  TEST_CODE_COVERAGE_LINES_TOTAL
 } = require('../../dd-trace/src/plugins/util/test')
+const { COMPONENT } = require('../../dd-trace/src/constants')
 
 // https://github.com/facebook/jest/blob/d6ad15b0f88a05816c2fe034dd6900d28315d570/packages/jest-worker/src/types.ts#L38
 const CHILD_MESSAGE_END = 2
 
-function getTestSpanMetadata (tracer, test) {
-  const childOf = getTestParentSpan(tracer)
-
-  const { suite, name, runner, testParameters } = test
-
-  const commonTags = getTestCommonTags(name, suite, tracer._version)
-
-  return {
-    childOf,
-    ...commonTags,
-    [JEST_TEST_RUNNER]: runner,
-    [TEST_PARAMETERS]: testParameters
-  }
-}
-
-class JestPlugin extends Plugin {
+class JestPlugin extends CiPlugin {
   static get name () {
     return 'jest'
   }
@@ -49,7 +35,7 @@ class JestPlugin extends Plugin {
     // Used to handle the end of a jest worker to be able to flush
     const handler = ([message]) => {
       if (message === CHILD_MESSAGE_END) {
-        this.tracer._exporter._writer.flush(() => {
+        this.tracer._exporter.flush(() => {
           // eslint-disable-next-line
           // https://github.com/facebook/jest/blob/24ed3b5ecb419c023ee6fdbc838f07cc028fc007/packages/jest-worker/src/workers/processChild.ts#L118-L133
           // Only after the flush is done we clean up open handles
@@ -64,9 +50,6 @@ class JestPlugin extends Plugin {
     this.codeOwnersEntries = getCodeOwnersFileEntries()
 
     this.addSub('ci:jest:session:start', (command) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
       const store = storage.getStore()
       const childOf = getTestParentSpan(this.tracer)
       const testSessionSpanMetadata = getTestSessionCommonTags(command, this.tracer._version)
@@ -74,6 +57,7 @@ class JestPlugin extends Plugin {
       const testSessionSpan = this.tracer.startSpan('jest.test_session', {
         childOf,
         tags: {
+          [COMPONENT]: this.constructor.name,
           ...this.testEnvironmentMetadata,
           ...testSessionSpanMetadata
         }
@@ -81,24 +65,32 @@ class JestPlugin extends Plugin {
       this.enter(testSessionSpan, store)
     })
 
-    this.addSub('ci:jest:session:finish', (status) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
+    this.addSub('ci:jest:session:finish', ({
+      status,
+      isSuitesSkipped,
+      isSuitesSkippingEnabled,
+      isCodeCoverageEnabled,
+      testCodeCoverageLinesTotal
+    }) => {
       const testSessionSpan = storage.getStore().span
+
       testSessionSpan.setTag(TEST_STATUS, status)
+      testSessionSpan.setTag(TEST_ITR_TESTS_SKIPPED, isSuitesSkipped ? 'true' : 'false')
+      testSessionSpan.setTag(TEST_SESSION_ITR_SKIPPING_ENABLED, isSuitesSkippingEnabled ? 'true' : 'false')
+      testSessionSpan.setTag(TEST_SESSION_CODE_COVERAGE_ENABLED, isCodeCoverageEnabled ? 'true' : 'false')
+
+      if (testCodeCoverageLinesTotal !== undefined) {
+        testSessionSpan.setTag(TEST_CODE_COVERAGE_LINES_TOTAL, testCodeCoverageLinesTotal)
+      }
       testSessionSpan.finish()
       finishAllTraceSpans(testSessionSpan)
-      this.tracer._exporter._writer.flush()
+      this.tracer._exporter.flush()
     })
 
     // Test suites can be run in a different process from jest's main one.
     // This subscriber changes the configuration objects from jest to inject the trace id
     // of the test session to the processes that run the test suites.
     this.addSub('ci:jest:session:configuration', configs => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
       const testSessionSpan = storage.getStore().span
       configs.forEach(config => {
         config._ddTestSessionId = testSessionSpan.context()._traceId.toString(10)
@@ -107,10 +99,6 @@ class JestPlugin extends Plugin {
     })
 
     this.addSub('ci:jest:test-suite:start', ({ testSuite, testEnvironmentOptions }) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
-
       const { _ddTestSessionId: testSessionId, _ddTestCommand: testCommand } = testEnvironmentOptions
 
       const store = storage.getStore()
@@ -125,6 +113,7 @@ class JestPlugin extends Plugin {
       const testSuiteSpan = this.tracer.startSpan('jest.test_suite', {
         childOf: testSessionSpanContext,
         tags: {
+          [COMPONENT]: this.constructor.name,
           ...this.testEnvironmentMetadata,
           ...testSuiteMetadata
         }
@@ -133,21 +122,23 @@ class JestPlugin extends Plugin {
     })
 
     this.addSub('ci:jest:test-suite:finish', ({ status, errorMessage }) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
       const testSuiteSpan = storage.getStore().span
       testSuiteSpan.setTag(TEST_STATUS, status)
       if (errorMessage) {
         testSuiteSpan.setTag('error', new Error(errorMessage))
       }
       testSuiteSpan.finish()
+      // Suites potentially run in a different process than the session,
+      // so calling finishAllTraceSpans on the session span is not enough
+      finishAllTraceSpans(testSuiteSpan)
     })
 
+    /**
+     * This can't use `this.itrConfig` like `ci:mocha:test-suite:code-coverage`
+     * because this subscription happens in a different process from the one
+     * fetching the ITR config.
+     */
     this.addSub('ci:jest:test-suite:code-coverage', (coverageFiles) => {
-      if (!this.config.isAgentlessEnabled || !this.config.isIntelligentTestRunnerEnabled) {
-        return
-      }
       const testSuiteSpan = storage.getStore().span
       this.tracer._exporter.exportCoverage({ span: testSuiteSpan, coverageFiles })
     })
@@ -192,30 +183,15 @@ class JestPlugin extends Plugin {
       suiteTags[TEST_COMMAND] = testSuiteSpan.context()._tags[TEST_COMMAND]
     }
 
-    const {
-      childOf,
-      ...testSpanMetadata
-    } = getTestSpanMetadata(this.tracer, test)
-
-    const codeOwners = getCodeOwnersForFilename(test.suite, this.codeOwnersEntries)
+    const { suite, name, runner, testParameters } = test
 
-    if (codeOwners) {
-      testSpanMetadata[TEST_CODE_OWNERS] = codeOwners
+    const extraTags = {
+      [JEST_TEST_RUNNER]: runner,
+      [TEST_PARAMETERS]: testParameters,
+      ...suiteTags
     }
 
-    const testSpan = this.tracer
-      .startSpan('jest.test', {
-        childOf,
-        tags: {
-          ...this.testEnvironmentMetadata,
-          ...testSpanMetadata,
-          ...suiteTags
-        }
-      })
-
-    testSpan.context()._trace.origin = CI_APP_ORIGIN
-
-    return testSpan
+    return super.startTestSpan(name, suite, extraTags)
   }
 }
 

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

@@ -0,0 +1,42 @@
+'use strict'
+
+const ConsumerPlugin = require('../../dd-trace/src/plugins/consumer')
+
+class KafkajsConsumerPlugin extends ConsumerPlugin {
+  static get name () { return 'kafkajs' }
+  static get operation () { return 'consume' }
+
+  start ({ topic, partition, message }) {
+    const childOf = extract(this.tracer, message.headers)
+
+    this.startSpan('kafka.consume', {
+      childOf,
+      service: this.config.service || `${this.tracer._service}-kafka`,
+      resource: topic,
+      kind: 'consumer',
+      type: 'worker',
+      meta: {
+        'component': 'kafkajs',
+        'kafka.topic': topic,
+        'kafka.message.offset': message.offset
+      },
+      metrics: {
+        'kafka.partition': partition
+      }
+    })
+  }
+}
+
+function extract (tracer, bufferMap) {
+  if (!bufferMap) return null
+
+  const textMap = {}
+
+  for (const key of Object.keys(bufferMap)) {
+    textMap[key] = bufferMap[key].toString()
+  }
+
+  return tracer.extract('text_map', textMap)
+}
+
+module.exports = KafkajsConsumerPlugin

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

@@ -1,93 +1,17 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-
-class KafkajsPlugin extends Plugin {
-  static get name () {
-    return 'kafkajs'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:kafkajs:produce:start`, ({ topic, messages }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('kafka.produce', {
-        childOf,
-        tags: {
-          'service.name': this.config.service || `${this.tracer._service}-kafka`,
-          'span.kind': 'producer',
-          'component': 'kafkajs'
-        }
-      })
-
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-
-      span.addTags({
-        'resource.name': topic,
-        'kafka.topic': topic,
-        'kafka.batch_size': messages.length
-      })
-      for (const message of messages) {
-        if (typeof message === 'object') {
-          this.tracer.inject(span, 'text_map', message.headers)
-        }
-      }
-    })
-
-    this.addSub(`apm:kafkajs:consume:start`, ({ topic, partition, message }) => {
-      const store = storage.getStore()
-      const childOf = extract(this.tracer, message.headers)
-      const span = this.tracer.startSpan('kafka.consume', {
-        childOf,
-        tags: {
-          'service.name': this.config.service || `${this.tracer._service}-kafka`,
-          'span.kind': 'consumer',
-          'span.type': 'worker',
-          'component': 'kafkajs',
-          'resource.name': topic,
-          'kafka.topic': topic,
-          'kafka.partition': partition,
-          'kafka.message.offset': message.offset
-        }
-      })
-
-      analyticsSampler.sample(span, this.config.measured, true)
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:kafkajs:consume:error`, errorHandler)
-
-    this.addSub(`apm:kafkajs:consume:finish`, finishHandler)
-
-    this.addSub(`apm:kafkajs:produce:error`, errorHandler)
-
-    this.addSub(`apm:kafkajs:produce:finish`, finishHandler)
+const ProducerPlugin = require('./producer')
+const ConsumerPlugin = require('./consumer')
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
+
+class KafkajsPlugin extends CompositePlugin {
+  static get name () { return 'kafkajs' }
+  static get plugins () {
+    return {
+      producer: ProducerPlugin,
+      consumer: ConsumerPlugin
+    }
   }
 }
 
-function finishHandler () {
-  storage.getStore().span.finish()
-}
-
-function errorHandler (error) {
-  storage.getStore().span.setTag('error', error)
-}
-
-function extract (tracer, bufferMap) {
-  if (!bufferMap) return null
-
-  const textMap = {}
-
-  for (const key of Object.keys(bufferMap)) {
-    textMap[key] = bufferMap[key].toString()
-  }
-
-  return tracer.extract('text_map', textMap)
-}
-
 module.exports = KafkajsPlugin

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

@@ -0,0 +1,31 @@
+'use strict'
+
+const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
+
+class KafkajsProducerPlugin extends ProducerPlugin {
+  static get name () { return 'kafkajs' }
+  static get operation () { return 'produce' }
+
+  start ({ topic, messages }) {
+    const span = this.startSpan('kafka.produce', {
+      service: this.config.service || `${this.tracer._service}-kafka`,
+      resource: topic,
+      kind: 'producer',
+      meta: {
+        'component': 'kafkajs',
+        'kafka.topic': topic
+      },
+      metrics: {
+        'kafka.batch_size': messages.length
+      }
+    })
+
+    for (const message of messages) {
+      if (typeof message === 'object') {
+        this.tracer.inject(span, 'text_map', message.headers)
+      }
+    }
+  }
+}
+
+module.exports = KafkajsProducerPlugin

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

@@ -0,0 +1,10 @@
+'use strict'
+
+const MySQLPlugin = require('../../datadog-plugin-mysql/src')
+
+class MariadbPlugin extends MySQLPlugin {
+  static get name () { return 'mariadb' }
+  static get system () { return 'mariadb' }
+}
+
+module.exports = MariadbPlugin

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

@@ -1,59 +1,24 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-
-class MemcachedPlugin extends Plugin {
-  static get name () {
-    return 'memcached'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub('apm:memcached:command:start', () => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('memcached.command', {
-        childOf,
-        tags: {
-          'span.kind': 'client',
-          'span.type': 'memcached',
-          'service.name': this.config.service || `${this.tracer._service}-memcached`
-        }
-      })
-
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-    })
-
-    this.addSub('apm:memcached:command:start:with-args', ({ client, server, query }) => {
-      const span = storage.getStore().span
-      span.addTags({
-        'resource.name': query.type,
-        'memcached.command': query.command
-      })
-
-      const address = getAddress(client, server, query)
-
-      if (address) {
-        span.addTags({
-          'out.host': address[0],
-          'out.port': address[1]
-        })
+const CachePlugin = require('../../dd-trace/src/plugins/cache')
+
+class MemcachedPlugin extends CachePlugin {
+  static get name () { return 'memcached' }
+
+  start ({ client, server, query }) {
+    const address = getAddress(client, server, query)
+
+    this.startSpan('memcached.command', {
+      service: this.config.service,
+      resource: query.type,
+      type: 'memcached',
+      kind: 'client',
+      meta: {
+        'memcached.command': query.command,
+        'out.host': address[0],
+        'out.port': address[1]
       }
     })
-
-    this.addSub('apm:memcached:command:error', err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
-
-    this.addSub('apm:memcached:command:finish', () => {
-      const span = storage.getStore().span
-      span.finish()
-    })
   }
 }
 

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

@@ -1,45 +1,27 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const CiPlugin = require('../../dd-trace/src/plugins/ci_plugin')
 const { storage } = require('../../datadog-core')
 
 const {
-  CI_APP_ORIGIN,
-  TEST_CODE_OWNERS,
-  TEST_SUITE,
   TEST_STATUS,
   TEST_PARAMETERS,
   finishAllTraceSpans,
-  getTestEnvironmentMetadata,
   getTestSuitePath,
   getTestParentSpan,
   getTestParametersString,
-  getCodeOwnersFileEntries,
-  getCodeOwnersForFilename,
-  getTestCommonTags,
   getTestSessionCommonTags,
   getTestSuiteCommonTags,
   TEST_SUITE_ID,
   TEST_SESSION_ID,
-  TEST_COMMAND
+  TEST_COMMAND,
+  TEST_ITR_TESTS_SKIPPED,
+  TEST_SESSION_CODE_COVERAGE_ENABLED,
+  TEST_SESSION_ITR_SKIPPING_ENABLED
 } = require('../../dd-trace/src/plugins/util/test')
+const { COMPONENT } = require('../../dd-trace/src/constants')
 
-function getTestSpanMetadata (tracer, test, sourceRoot) {
-  const childOf = getTestParentSpan(tracer)
-
-  const { file: testSuiteAbsolutePath } = test
-  const fullTestName = test.fullTitle()
-  const testSuite = getTestSuitePath(testSuiteAbsolutePath, sourceRoot)
-
-  const commonTags = getTestCommonTags(fullTestName, testSuite, tracer._version)
-
-  return {
-    childOf,
-    ...commonTags
-  }
-}
-
-class MochaPlugin extends Plugin {
+class MochaPlugin extends CiPlugin {
   static get name () {
     return 'mocha'
   }
@@ -49,14 +31,24 @@ class MochaPlugin extends Plugin {
 
     this._testSuites = new Map()
     this._testNameToParams = {}
-    this.testEnvironmentMetadata = getTestEnvironmentMetadata('mocha', this.config)
     this.sourceRoot = process.cwd()
-    this.codeOwnersEntries = getCodeOwnersFileEntries(this.sourceRoot)
 
-    this.addSub('ci:mocha:run:start', (command) => {
-      if (!this.config.isAgentlessEnabled) {
+    this.addSub('ci:mocha:test-suite:code-coverage', ({ coverageFiles, suiteFile }) => {
+      if (!this.itrConfig || !this.itrConfig.isCodeCoverageEnabled) {
         return
       }
+      const testSuiteSpan = this._testSuites.get(suiteFile)
+
+      const relativeCoverageFiles = [...coverageFiles, suiteFile]
+        .map(filename => getTestSuitePath(filename, this.sourceRoot))
+
+      this.tracer._exporter.exportCoverage({
+        span: testSuiteSpan,
+        coverageFiles: relativeCoverageFiles
+      })
+    })
+
+    this.addSub('ci:mocha:session:start', (command) => {
       const childOf = getTestParentSpan(this.tracer)
       const testSessionSpanMetadata = getTestSessionCommonTags(command, this.tracer._version)
 
@@ -64,6 +56,7 @@ class MochaPlugin extends Plugin {
       this.testSessionSpan = this.tracer.startSpan('mocha.test_session', {
         childOf,
         tags: {
+          [COMPONENT]: this.constructor.name,
           ...this.testEnvironmentMetadata,
           ...testSessionSpanMetadata
         }
@@ -71,9 +64,6 @@ class MochaPlugin extends Plugin {
     })
 
     this.addSub('ci:mocha:test-suite:start', (suite) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
       const store = storage.getStore()
       const testSuiteMetadata = getTestSuiteCommonTags(
         this.command,
@@ -83,6 +73,7 @@ class MochaPlugin extends Plugin {
       const testSuiteSpan = this.tracer.startSpan('mocha.test_suite', {
         childOf: this.testSessionSpan,
         tags: {
+          [COMPONENT]: this.constructor.name,
           ...this.testEnvironmentMetadata,
           ...testSuiteMetadata
         }
@@ -92,9 +83,6 @@ class MochaPlugin extends Plugin {
     })
 
     this.addSub('ci:mocha:test-suite:finish', (status) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
       const span = storage.getStore().span
       // the test status of the suite may have been set in ci:mocha:test-suite:error already
       if (!span.context()._tags[TEST_STATUS]) {
@@ -104,9 +92,6 @@ class MochaPlugin extends Plugin {
     })
 
     this.addSub('ci:mocha:test-suite:error', (err) => {
-      if (!this.config.isAgentlessEnabled) {
-        return
-      }
       const span = storage.getStore().span
       span.setTag('error', err)
       span.setTag(TEST_STATUS, 'fail')
@@ -154,20 +139,25 @@ class MochaPlugin extends Plugin {
       this._testNameToParams[name] = params
     })
 
-    this.addSub('ci:mocha:run:finish', (status) => {
+    this.addSub('ci:mocha:session:finish', ({ status, isSuitesSkipped }) => {
       if (this.testSessionSpan) {
+        const { isSuitesSkippingEnabled, isCodeCoverageEnabled } = this.itrConfig || {}
         this.testSessionSpan.setTag(TEST_STATUS, status)
+        this.testSessionSpan.setTag(TEST_ITR_TESTS_SKIPPED, isSuitesSkipped ? 'true' : 'false')
+        this.testSessionSpan.setTag(TEST_SESSION_ITR_SKIPPING_ENABLED, isSuitesSkippingEnabled ? 'true' : 'false')
+        this.testSessionSpan.setTag(TEST_SESSION_CODE_COVERAGE_ENABLED, isCodeCoverageEnabled ? 'true' : 'false')
+
         this.testSessionSpan.finish()
         finishAllTraceSpans(this.testSessionSpan)
       }
-      this.tracer._exporter._writer.flush()
+      this.itrConfig = null
+      this.tracer._exporter.flush()
     })
   }
 
   startTestSpan (test) {
     const testSuiteTags = {}
     const testSuiteSpan = this._testSuites.get(test.parent.file)
-
     if (testSuiteSpan) {
       const testSuiteId = testSuiteSpan.context()._spanId.toString(10)
       testSuiteTags[TEST_SUITE_ID] = testSuiteId
@@ -179,30 +169,20 @@ class MochaPlugin extends Plugin {
       testSuiteTags[TEST_COMMAND] = this.command
     }
 
-    const { childOf, ...testSpanMetadata } = getTestSpanMetadata(this.tracer, test, this.sourceRoot)
+    const { file: testSuiteAbsolutePath } = test
+    const fullTestName = test.fullTitle()
+    const testSuite = getTestSuitePath(testSuiteAbsolutePath, this.sourceRoot)
 
-    const testParametersString = getTestParametersString(this._testNameToParams, test.title)
-    if (testParametersString) {
-      testSpanMetadata[TEST_PARAMETERS] = testParametersString
+    const extraTags = {
+      ...testSuiteTags
     }
-    const codeOwners = getCodeOwnersForFilename(testSpanMetadata[TEST_SUITE], this.codeOwnersEntries)
 
-    if (codeOwners) {
-      testSpanMetadata[TEST_CODE_OWNERS] = codeOwners
+    const testParametersString = getTestParametersString(this._testNameToParams, test.title)
+    if (testParametersString) {
+      extraTags[TEST_PARAMETERS] = testParametersString
     }
 
-    const testSpan = this.tracer
-      .startSpan('mocha.test', {
-        childOf,
-        tags: {
-          ...this.testEnvironmentMetadata,
-          ...testSpanMetadata,
-          ...testSuiteTags
-        }
-      })
-    testSpan.context()._trace.origin = CI_APP_ORIGIN
-
-    return testSpan
+    return super.startTestSpan(fullTestName, testSuite, extraTags)
   }
 }