dd-trace 2.26.1 → 2.27.0

package/packages/datadog-plugin-aws-sdk/src/services/sns.js

@@ -18,30 +18,35 @@ class Sns extends BaseAwsSdkPlugin {
   }
 
   requestInject (span, request) {
-    const operation = request.operation
-    if (operation === 'publish' || operation === 'publishBatch') {
-      if (!request.params) {
-        request.params = {}
-      }
-      let injectPath
-      if (request.params.PublishBatchRequestEntries && request.params.PublishBatchRequestEntries.length > 0) {
-        injectPath = request.params.PublishBatchRequestEntries[0]
-      } else if (request.params.Message) {
-        injectPath = request.params
-      }
-      if (!injectPath.MessageAttributes) {
-        injectPath.MessageAttributes = {}
-      }
-      if (Object.keys(injectPath.MessageAttributes).length >= 10) { // SNS quota
-        log.info('Message attributes full, skipping trace context injection')
-        return
-      }
-      const ddInfo = {}
-      this.tracer.inject(span, 'text_map', ddInfo)
-      injectPath.MessageAttributes._datadog = {
-        DataType: 'Binary',
-        BinaryValue: JSON.stringify(ddInfo) // BINARY types are automatically base64 encoded
-      }
+    const { operation, params } = request
+
+    if (!params) return
+
+    switch (operation) {
+      case 'publish':
+        this._injectMessageAttributes(span, params)
+        break
+      case 'publishBatch':
+        if (params.PublishBatchRequestEntries && params.PublishBatchRequestEntries.length > 0) {
+          this._injectMessageAttributes(span, params.PublishBatchRequestEntries[0])
+        }
+        break
+    }
+  }
+
+  _injectMessageAttributes (span, params) {
+    if (!params.MessageAttributes) {
+      params.MessageAttributes = {}
+    }
+    if (Object.keys(params.MessageAttributes).length >= 10) { // SNS quota
+      log.info('Message attributes full, skipping trace context injection')
+      return
+    }
+    const ddInfo = {}
+    this.tracer.inject(span, 'text_map', ddInfo)
+    params.MessageAttributes._datadog = {
+      DataType: 'Binary',
+      BinaryValue: Buffer.from(JSON.stringify(ddInfo)) // BINARY types are automatically base64 encoded
     }
   }
 }

package/packages/datadog-plugin-aws-sdk/src/services/sqs.js

@@ -78,24 +78,39 @@ class Sqs extends BaseAwsSdkPlugin {
   }
 
   responseExtract (params, operation, response) {
-    if (operation === 'receiveMessage') {
-      if (
-        (!params.MaxNumberOfMessages || params.MaxNumberOfMessages === 1) &&
-        response &&
-        response.Messages &&
-        response.Messages[0] &&
-        response.Messages[0].MessageAttributes &&
-        response.Messages[0].MessageAttributes._datadog &&
-        response.Messages[0].MessageAttributes._datadog.StringValue
-      ) {
-        const textMap = response.Messages[0].MessageAttributes._datadog.StringValue
-        try {
-          return this.tracer.extract('text_map', JSON.parse(textMap))
-        } catch (err) {
-          log.error(err)
-          return undefined
+    if (operation !== 'receiveMessage') return
+    if (params.MaxNumberOfMessages && params.MaxNumberOfMessages !== 1) return
+    if (!response || !response.Messages || !response.Messages[0]) return
+
+    let message = response.Messages[0]
+
+    if (message.Body) {
+      try {
+        const body = JSON.parse(message.Body)
+
+        // SNS to SQS
+        if (body.Type === 'Notification') {
+          message = body
         }
+      } catch (e) {
+        // SQS to SQS
+      }
+    }
+
+    if (!message.MessageAttributes || !message.MessageAttributes._datadog) return
+
+    const datadogAttribute = message.MessageAttributes._datadog
+
+    try {
+      if (datadogAttribute.StringValue) {
+        const textMap = datadogAttribute.StringValue
+        return this.tracer.extract('text_map', JSON.parse(textMap))
+      } else if (datadogAttribute.Type === 'Binary') {
+        const buffer = Buffer.from(datadogAttribute.Value, 'base64')
+        return this.tracer.extract('text_map', JSON.parse(buffer))
       }
+    } catch (e) {
+      log.error(e)
     }
   }
 

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

@@ -7,7 +7,8 @@ const {
   TEST_SKIP_REASON,
   TEST_STATUS,
   finishAllTraceSpans,
-  getTestSuitePath
+  getTestSuitePath,
+  getTestSuiteCommonTags
 } = require('../../dd-trace/src/plugins/util/test')
 const { RESOURCE_NAME } = require('../../../ext/tags')
 const { COMPONENT, ERROR_MESSAGE } = require('../../dd-trace/src/constants')
@@ -20,21 +21,47 @@ class CucumberPlugin extends CiPlugin {
   constructor (...args) {
     super(...args)
 
-    this.addSub('ci:cucumber:session:finish', () => {
+    this.sourceRoot = process.cwd()
+
+    this.addSub('ci:cucumber:session:finish', (status) => {
+      this.testSessionSpan.setTag(TEST_STATUS, status)
+      this.testModuleSpan.setTag(TEST_STATUS, status)
+      this.testModuleSpan.finish()
+      this.testSessionSpan.finish()
+      finishAllTraceSpans(this.testSessionSpan)
       this.tracer._exporter.flush()
     })
 
-    this.addSub('ci:cucumber:run:start', ({ testName, fullTestSuite }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const testSuite = getTestSuitePath(fullTestSuite, process.cwd())
+    this.addSub('ci:cucumber:test-suite:start', (testSuiteFullPath) => {
+      const testSuiteMetadata = getTestSuiteCommonTags(
+        this.command,
+        this.frameworkVersion,
+        getTestSuitePath(testSuiteFullPath, this.sourceRoot)
+      )
+      this.testSuiteSpan = this.tracer.startSpan('cucumber.test_suite', {
+        childOf: this.testModuleSpan,
+        tags: {
+          [COMPONENT]: this.constructor.name,
+          ...this.testEnvironmentMetadata,
+          ...testSuiteMetadata
+        }
+      })
+    })
 
-      const testSpan = this.startTestSpan(testName, testSuite, childOf)
+    this.addSub('ci:cucumber:test-suite:finish', status => {
+      this.testSuiteSpan.setTag(TEST_STATUS, status)
+      this.testSuiteSpan.finish()
+    })
+
+    this.addSub('ci:cucumber:test:start', ({ testName, fullTestSuite }) => {
+      const store = storage.getStore()
+      const testSuite = getTestSuitePath(fullTestSuite, this.sourceRoot)
+      const testSpan = this.startTestSpan(testName, testSuite)
 
       this.enter(testSpan, store)
     })
 
-    this.addSub('ci:cucumber:run-step:start', ({ resource }) => {
+    this.addSub('ci:cucumber:test-step:start', ({ resource }) => {
       const store = storage.getStore()
       const childOf = store ? store.span : store
       const span = this.tracer.startSpan('cucumber.step', {
@@ -48,7 +75,7 @@ class CucumberPlugin extends CiPlugin {
       this.enter(span, store)
     })
 
-    this.addSub('ci:cucumber:run:finish', ({ isStep, status, skipReason, errorMessage }) => {
+    this.addSub('ci:cucumber:test:finish', ({ isStep, status, skipReason, errorMessage }) => {
       const span = storage.getStore().span
       const statusTag = isStep ? 'step.status' : TEST_STATUS
 
@@ -76,8 +103,12 @@ class CucumberPlugin extends CiPlugin {
     })
   }
 
-  startTestSpan (testName, testSuite, childOf) {
-    return super.startTestSpan(testName, testSuite, {}, childOf)
+  startTestSpan (testName, testSuite) {
+    return super.startTestSpan(
+      testName,
+      testSuite,
+      this.testSuiteSpan
+    )
   }
 }
 

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

@@ -7,7 +7,16 @@ const {
   getTestParentSpan,
   getCodeOwnersFileEntries,
   getCodeOwnersForFilename,
-  getTestCommonTags
+  getTestCommonTags,
+  getTestSessionCommonTags,
+  getTestModuleCommonTags,
+  getTestSuiteCommonTags,
+  TEST_SUITE_ID,
+  TEST_MODULE_ID,
+  TEST_SESSION_ID,
+  TEST_COMMAND,
+  TEST_BUNDLE,
+  finishAllTraceSpans
 } = require('../../dd-trace/src/plugins/util/test')
 
 const { ORIGIN_KEY, COMPONENT } = require('../../dd-trace/src/constants')
@@ -30,6 +39,43 @@ function getTestSpanMetadata (tracer, testName, testSuite, cypressConfig) {
   }
 }
 
+function getCypressVersion (details) {
+  if (details && details.cypressVersion) {
+    return details.cypressVersion
+  }
+  if (details && details.config && details.config.version) {
+    return details.config.version
+  }
+  return ''
+}
+
+function getCypressCommand (details) {
+  if (!details) {
+    return 'cypress'
+  }
+  return `cypress ${details.specPattern || ''}`
+}
+
+function getSessionStatus (summary) {
+  if (summary.totalFailed !== undefined && summary.totalFailed > 0) {
+    return 'fail'
+  }
+  if (summary.totalSkipped !== undefined && summary.totalSkipped === summary.totalTests) {
+    return 'skip'
+  }
+  return 'pass'
+}
+
+function getSuiteStatus (suiteStats) {
+  if (suiteStats.failures !== undefined && suiteStats.failures > 0) {
+    return 'fail'
+  }
+  if (suiteStats.tests !== undefined && suiteStats.tests === suiteStats.pending) {
+    return 'skip'
+  }
+  return 'pass'
+}
+
 module.exports = (on, config) => {
   const tracer = require('../../dd-trace')
   const testEnvironmentMetadata = getTestEnvironmentMetadata('cypress')
@@ -37,14 +83,92 @@ module.exports = (on, config) => {
   const codeOwnersEntries = getCodeOwnersFileEntries()
 
   let activeSpan = null
-  on('after:run', () => {
+  let testSessionSpan = null
+  let testModuleSpan = null
+  let testSuiteSpan = null
+  let command = null
+  let frameworkVersion
+
+  on('before:run', (details) => {
+    const childOf = getTestParentSpan(tracer)
+
+    command = getCypressCommand(details)
+    frameworkVersion = getCypressVersion(details)
+
+    const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion)
+    const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion)
+
+    testSessionSpan = tracer.startSpan('cypress.test_session', {
+      childOf,
+      tags: {
+        [COMPONENT]: 'cypress',
+        ...testEnvironmentMetadata,
+        ...testSessionSpanMetadata
+      }
+    })
+    testModuleSpan = tracer.startSpan('cypress.test_module', {
+      childOf: testSessionSpan,
+      tags: {
+        [COMPONENT]: 'cypress',
+        ...testEnvironmentMetadata,
+        ...testModuleSpanMetadata
+      }
+    })
+  })
+
+  on('after:run', (suiteStats) => {
+    const testStatus = getSessionStatus(suiteStats)
+    testModuleSpan.setTag(TEST_STATUS, testStatus)
+    testSessionSpan.setTag(TEST_STATUS, testStatus)
+
+    testModuleSpan.finish()
+    testSessionSpan.finish()
+
+    finishAllTraceSpans(testSessionSpan)
+
     return new Promise(resolve => {
-      tracer._tracer._exporter._writer.flush(() => resolve(null))
+      tracer._tracer._exporter._writer.flush(() => {
+        resolve(null)
+      })
     })
   })
   on('task', {
+    'dd:testSuiteStart': (suite) => {
+      if (testSuiteSpan) {
+        return null
+      }
+      const testSuiteSpanMetadata = getTestSuiteCommonTags(command, frameworkVersion, suite)
+      testSuiteSpan = tracer.startSpan('cypress.test_suite', {
+        childOf: testModuleSpan,
+        tags: {
+          [COMPONENT]: 'cypress',
+          ...testEnvironmentMetadata,
+          ...testSuiteSpanMetadata
+        }
+      })
+      return null
+    },
+    'dd:testSuiteFinish': (suiteStats) => {
+      const status = getSuiteStatus(suiteStats)
+      testSuiteSpan.setTag(TEST_STATUS, status)
+      testSuiteSpan.finish()
+      testSuiteSpan = null
+      return null
+    },
     'dd:beforeEach': (test) => {
       const { testName, testSuite } = test
+      const testSuiteId = testSuiteSpan.context().toSpanId()
+      const testSessionId = testSessionSpan.context().toTraceId()
+      const testModuleId = testModuleSpan.context().toSpanId()
+
+      const testSuiteTags = {
+        [TEST_SUITE_ID]: testSuiteId,
+        [TEST_SESSION_ID]: testSessionId,
+        [TEST_COMMAND]: command,
+        [TEST_MODULE_ID]: testModuleId,
+        [TEST_COMMAND]: command,
+        [TEST_BUNDLE]: command
+      }
 
       const {
         childOf,
@@ -65,7 +189,8 @@ module.exports = (on, config) => {
             [COMPONENT]: 'cypress',
             [ORIGIN_KEY]: CI_APP_ORIGIN,
             ...testSpanMetadata,
-            ...testEnvironmentMetadata
+            ...testEnvironmentMetadata,
+            ...testSuiteTags
           }
         })
       }

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

@@ -8,7 +8,12 @@ beforeEach(() => {
   })
 })
 
+before(() => {
+  cy.task('dd:testSuiteStart', Cypress.mocha.getRootSuite().file)
+})
+
 after(() => {
+  cy.task('dd:testSuiteFinish', Cypress.mocha.getRunner().stats)
   cy.window().then(win => {
     win.dispatchEvent(new Event('beforeunload'))
   })

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

@@ -6,21 +6,12 @@ const {
   JEST_TEST_RUNNER,
   finishAllTraceSpans,
   getTestEnvironmentMetadata,
-  getTestParentSpan,
-  getTestSessionCommonTags,
-  getTestModuleCommonTags,
   getTestSuiteCommonTags,
+  addIntelligentTestRunnerSpanTags,
   TEST_PARAMETERS,
   getCodeOwnersFileEntries,
-  TEST_SESSION_ID,
-  TEST_MODULE_ID,
-  TEST_SUITE_ID,
   TEST_COMMAND,
-  TEST_ITR_TESTS_SKIPPED,
-  TEST_SESSION_CODE_COVERAGE_ENABLED,
-  TEST_SESSION_ITR_SKIPPING_ENABLED,
-  TEST_CODE_COVERAGE_LINES_TOTAL,
-  TEST_BUNDLE
+  TEST_FRAMEWORK_VERSION
 } = require('../../dd-trace/src/plugins/util/test')
 const { COMPONENT } = require('../../dd-trace/src/constants')
 
@@ -52,29 +43,6 @@ class JestPlugin extends CiPlugin {
     this.testEnvironmentMetadata = getTestEnvironmentMetadata('jest', this.config)
     this.codeOwnersEntries = getCodeOwnersFileEntries()
 
-    this.addSub('ci:jest:session:start', ({ command, testFrameworkVersion }) => {
-      const childOf = getTestParentSpan(this.tracer)
-      const testSessionSpanMetadata = getTestSessionCommonTags(command, testFrameworkVersion)
-      const testModuleSpanMetadata = getTestModuleCommonTags(command, testFrameworkVersion)
-
-      this.testSessionSpan = this.tracer.startSpan('jest.test_session', {
-        childOf,
-        tags: {
-          [COMPONENT]: this.constructor.name,
-          ...this.testEnvironmentMetadata,
-          ...testSessionSpanMetadata
-        }
-      })
-      this.testModuleSpan = this.tracer.startSpan('jest.test_module', {
-        childOf: this.testSessionSpan,
-        tags: {
-          [COMPONENT]: this.constructor.name,
-          ...this.testEnvironmentMetadata,
-          ...testModuleSpanMetadata
-        }
-      })
-    })
-
     this.addSub('ci:jest:session:finish', ({
       status,
       isSuitesSkipped,
@@ -83,14 +51,14 @@ class JestPlugin extends CiPlugin {
       testCodeCoverageLinesTotal
     }) => {
       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')
-
-      if (testCodeCoverageLinesTotal !== undefined) {
-        this.testSessionSpan.setTag(TEST_CODE_COVERAGE_LINES_TOTAL, testCodeCoverageLinesTotal)
-      }
       this.testModuleSpan.setTag(TEST_STATUS, status)
+
+      addIntelligentTestRunnerSpanTags(
+        this.testSessionSpan,
+        this.testModuleSpan,
+        { isSuitesSkipped, isSuitesSkippingEnabled, isCodeCoverageEnabled, testCodeCoverageLinesTotal }
+      )
+
       this.testModuleSpan.finish()
       this.testSessionSpan.finish()
       finishAllTraceSpans(this.testSessionSpan)
@@ -108,23 +76,21 @@ class JestPlugin extends CiPlugin {
       })
     })
 
-    this.addSub('ci:jest:test-suite:start', ({ testSuite, testEnvironmentOptions }) => {
+    this.addSub('ci:jest:test-suite:start', ({ testSuite, testEnvironmentOptions, frameworkVersion }) => {
       const {
         _ddTestSessionId: testSessionId,
         _ddTestCommand: testCommand,
         _ddTestModuleId: testModuleId
       } = testEnvironmentOptions
 
-      const store = storage.getStore()
-
       const testSessionSpanContext = this.tracer.extract('text_map', {
         'x-datadog-trace-id': testSessionId,
         'x-datadog-parent-id': testModuleId
       })
 
-      const testSuiteMetadata = getTestSuiteCommonTags(testCommand, this.tracer._version, testSuite)
+      const testSuiteMetadata = getTestSuiteCommonTags(testCommand, frameworkVersion, testSuite)
 
-      const testSuiteSpan = this.tracer.startSpan('jest.test_suite', {
+      this.testSuiteSpan = this.tracer.startSpan('jest.test_suite', {
         childOf: testSessionSpanContext,
         tags: {
           [COMPONENT]: this.constructor.name,
@@ -132,19 +98,17 @@ class JestPlugin extends CiPlugin {
           ...testSuiteMetadata
         }
       })
-      this.enter(testSuiteSpan, store)
     })
 
     this.addSub('ci:jest:test-suite:finish', ({ status, errorMessage }) => {
-      const testSuiteSpan = storage.getStore().span
-      testSuiteSpan.setTag(TEST_STATUS, status)
+      this.testSuiteSpan.setTag(TEST_STATUS, status)
       if (errorMessage) {
-        testSuiteSpan.setTag('error', new Error(errorMessage))
+        this.testSuiteSpan.setTag('error', new Error(errorMessage))
       }
-      testSuiteSpan.finish()
+      this.testSuiteSpan.finish()
       // Suites potentially run in a different process than the session,
       // so calling finishAllTraceSpans on the session span is not enough
-      finishAllTraceSpans(testSuiteSpan)
+      finishAllTraceSpans(this.testSuiteSpan)
     })
 
     /**
@@ -153,8 +117,7 @@ class JestPlugin extends CiPlugin {
      * fetching the ITR config.
      */
     this.addSub('ci:jest:test-suite:code-coverage', (coverageFiles) => {
-      const testSuiteSpan = storage.getStore().span
-      this.tracer._exporter.exportCoverage({ span: testSuiteSpan, coverageFiles })
+      this.tracer._exporter.exportCoverage({ span: this.testSuiteSpan, coverageFiles })
     })
 
     this.addSub('ci:jest:test:start', (test) => {
@@ -173,9 +136,12 @@ class JestPlugin extends CiPlugin {
 
     this.addSub('ci:jest:test:err', (error) => {
       if (error) {
-        const span = storage.getStore().span
-        span.setTag(TEST_STATUS, 'fail')
-        span.setTag('error', error)
+        const store = storage.getStore()
+        if (store && store.span) {
+          const span = store.span
+          span.setTag(TEST_STATUS, 'fail')
+          span.setTag('error', error)
+        }
       }
     })
 
@@ -187,33 +153,15 @@ class JestPlugin extends CiPlugin {
   }
 
   startTestSpan (test) {
-    let childOf
-    const suiteTags = {}
-    const store = storage.getStore()
-    const testSuiteSpan = store ? store.span : undefined
-    if (testSuiteSpan) {
-      const testSuiteId = testSuiteSpan.context().toSpanId()
-      suiteTags[TEST_SUITE_ID] = testSuiteId
-      suiteTags[TEST_SESSION_ID] = testSuiteSpan.context().toTraceId()
-      suiteTags[TEST_MODULE_ID] = testSuiteSpan.context()._parentId.toString(10)
-      suiteTags[TEST_COMMAND] = testSuiteSpan.context()._tags[TEST_COMMAND]
-      suiteTags[TEST_BUNDLE] = testSuiteSpan.context()._tags[TEST_COMMAND]
-      // This is a hack to get good time resolution on test events, while keeping
-      // the test event as the root span of its trace.
-      childOf = getTestParentSpan(this.tracer)
-      childOf._trace.startTime = testSuiteSpan.context()._trace.startTime
-      childOf._trace.ticks = testSuiteSpan.context()._trace.ticks
-    }
-
-    const { suite, name, runner, testParameters } = test
+    const { suite, name, runner, testParameters, frameworkVersion } = test
 
     const extraTags = {
       [JEST_TEST_RUNNER]: runner,
       [TEST_PARAMETERS]: testParameters,
-      ...suiteTags
+      [TEST_FRAMEWORK_VERSION]: frameworkVersion
     }
 
-    return super.startTestSpan(name, suite, extraTags, childOf)
+    return super.startTestSpan(name, suite, this.testSuiteSpan, extraTags)
   }
 }