dd-trace 2.4.2 → 2.6.0

package/LICENSE-3rdparty.csv

@@ -7,6 +7,7 @@ require,@types/node,MIT,Copyright Authors
 require,crypto-randomuuid,MIT,Copyright 2021 Node.js Foundation and contributors
 require,diagnostics_channel,MIT,Copyright 2021 Simon D.
 require,form-data,MIT,Copyright 2012 Felix Geisendörfer and contributors
+require,ignore,MIT,Copyright 2013 Kael Zhang and contributors
 require,import-in-the-middle,Apache license 2.0,Copyright 2021 Datadog Inc.
 require,koalas,MIT,Copyright 2013-2017 Brian Woodward
 require,limiter,MIT,Copyright 2011 John Hurliman

package/ci/init.js

@@ -11,6 +11,12 @@ const options = {
   }
 }
 
+if (process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED && (process.env.DATADOG_API_KEY || process.env.DD_API_KEY)) {
+  options.experimental = {
+    exporter: 'datadog'
+  }
+}
+
 // TODO: remove this in a later major version since we now recommend using
 // `NODE_OPTIONS='-r dd-trace/ci/init'`.
 try {

package/ci/jest/env.js

@@ -1,13 +1,26 @@
 const tracer = require('../../packages/dd-trace')
 const { ORIGIN_KEY } = require('../../packages/dd-trace/src/constants')
 
-tracer.init({
+const options = {
   startupLogs: false,
-  flushInterval: 400000,
   tags: {
     [ORIGIN_KEY]: 'ciapp-test'
   }
-})
+}
+
+if (process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED && (process.env.DATADOG_API_KEY || process.env.DD_API_KEY)) {
+  tracer.init({
+    ...options,
+    experimental: {
+      exporter: 'datadog'
+    }
+  })
+} else {
+  tracer.init({
+    ...options,
+    flushInterval: 400000
+  })
+}
 
 tracer.use('fs', false)
 

package/ext/exporters.d.ts

@@ -1,6 +1,7 @@
 declare const exporters: {
   LOG: 'log',
-  AGENT: 'agent'
+  AGENT: 'agent',
+  DATADOG: 'datadog'
 }
 
 export = exporters

package/ext/exporters.js

@@ -1,5 +1,6 @@
 'use strict'
 module.exports = {
   LOG: 'log',
-  AGENT: 'agent'
+  AGENT: 'agent',
+  DATADOG: 'datadog'
 }

package/index.d.ts

@@ -428,7 +428,23 @@ export declare interface TracerOptions {
      * Controls the maximum amount of traces sampled by AppSec attacks, per second.
      * @default 100
      */
-    rateLimit?: number
+    rateLimit?: number,
+
+    /**
+     * Controls the maximum amount of time in microseconds the WAF is allowed to run synchronously for.
+     * @default 5000
+     */
+    wafTimeout?: number,
+
+    /**
+     * Specifies a regex that will redact sensitive data by its key in attack reports.
+     */
+    obfuscatorKeyRegex?: string,
+
+    /**
+     * Specifies a regex that will redact sensitive data by its value in attack reports.
+     */
+    obfuscatorValueRegex?: string
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.4.2",
+  "version": "2.6.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -61,14 +61,15 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^1.0.0",
-    "@datadog/native-metrics": "^1.1.0",
-    "@datadog/pprof": "^0.3.0",
+    "@datadog/native-appsec": "^1.1.1",
+    "@datadog/native-metrics": "^1.2.0",
+    "@datadog/pprof": "^0.4.0",
     "@datadog/sketches-js": "^1.0.4",
     "@types/node": ">=12",
     "crypto-randomuuid": "^1.0.0",
     "diagnostics_channel": "^1.1.0",
     "form-data": "^3.0.0",
+    "ignore": "^5.2.0",
     "import-in-the-middle": "^1.2.1",
     "koalas": "^1.0.2",
     "limiter": "^1.1.4",

package/packages/datadog-instrumentations/index.js

@@ -12,6 +12,7 @@ require('./src/elasticsearch')
 require('./src/generic-pool')
 require('./src/http')
 require('./src/ioredis')
+require('./src/jest')
 require('./src/memcached')
 require('./src/mongodb-core')
 require('./src/mongoose')

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

@@ -0,0 +1,8 @@
+const { addHook } = require('./helpers/instrument')
+
+// No handler because this is only useful for testing.
+// Cypress plugin does not patch any library.
+addHook({
+  name: 'cypress',
+  versions: ['>=6.7.0']
+})

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

@@ -0,0 +1,170 @@
+'use strict'
+
+const { addHook, channel, AsyncResource } = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+const testStartCh = channel('ci:jest:test:start')
+const testSkippedCh = channel('ci:jest:test:skip')
+const testRunEndCh = channel('ci:jest:test:end')
+const testErrCh = channel('ci:jest:test:err')
+const testSuiteEnd = channel('ci:jest:test-suite:end')
+
+const {
+  getTestSuitePath,
+  getTestParametersString
+} = require('../../dd-trace/src/plugins/util/test')
+
+const { getFormattedJestTestParameters } = require('../../datadog-plugin-jest/src/util')
+
+const specStatusToTestStatus = {
+  'pending': 'skip',
+  'disabled': 'skip',
+  'todo': 'skip',
+  'passed': 'pass',
+  'failed': 'fail'
+}
+
+const asyncResources = new WeakMap()
+const originalTestFns = new WeakMap()
+
+// based on https://github.com/facebook/jest/blob/main/packages/jest-circus/src/formatNodeAssertErrors.ts#L41
+function formatJestError (errors) {
+  let error
+  if (Array.isArray(errors)) {
+    const [originalError, asyncError] = errors
+    if (originalError === null || !originalError.stack) {
+      error = asyncError
+      error.message = originalError
+    } else {
+      error = originalError
+    }
+  } else {
+    error = errors
+  }
+  return error
+}
+
+function getWrappedEnvironment (BaseEnvironment) {
+  return class DatadogEnvironment extends BaseEnvironment {
+    constructor (config, context) {
+      super(config, context)
+      this.testSuite = getTestSuitePath(context.testPath, config.rootDir)
+      this.nameToParams = {}
+      this.global._ddtrace = global._ddtrace
+    }
+    async teardown () {
+      super.teardown().finally(() => {
+        testSuiteEnd.publish()
+      })
+    }
+
+    async handleTestEvent (event, state) {
+      if (super.handleTestEvent) {
+        await super.handleTestEvent(event, state)
+      }
+
+      let context
+      if (this.getVmContext) {
+        context = this.getVmContext()
+      } else {
+        context = this.context
+      }
+
+      const setNameToParams = (name, params) => { this.nameToParams[name] = params }
+
+      if (event.name === 'setup') {
+        shimmer.wrap(this.global.test, 'each', each => function () {
+          const testParameters = getFormattedJestTestParameters(arguments)
+          const eachBind = each.apply(this, arguments)
+          return function () {
+            const [testName] = arguments
+            setNameToParams(testName, testParameters)
+            return eachBind.apply(this, arguments)
+          }
+        })
+      }
+      if (event.name === 'test_start') {
+        const testParameters = getTestParametersString(this.nameToParams, event.test.name)
+
+        // Async resource for this test is created here
+        // It is used later on by the test_done handler
+        const asyncResource = new AsyncResource('bound-anonymous-fn')
+        asyncResources.set(event.test, asyncResource)
+        asyncResource.runInAsyncScope(() => {
+          testStartCh.publish({
+            name: context.expect.getState().currentTestName,
+            suite: this.testSuite,
+            runner: 'jest-circus',
+            testParameters
+          })
+          originalTestFns.set(event.test, event.test.fn)
+          event.test.fn = asyncResource.bind(event.test.fn)
+        })
+      }
+      if (event.name === 'test_done') {
+        const asyncResource = asyncResources.get(event.test)
+        asyncResource.runInAsyncScope(() => {
+          let status = 'pass'
+          if (event.test.errors && event.test.errors.length) {
+            status = 'fail'
+            const formattedError = formatJestError(event.test.errors[0])
+            testErrCh.publish(formattedError)
+          }
+          testRunEndCh.publish(status)
+          // restore in case it is retried
+          event.test.fn = originalTestFns.get(event.test)
+        })
+      }
+      if (event.name === 'test_skip' || event.name === 'test_todo') {
+        testSkippedCh.publish({
+          name: context.expect.getState().currentTestName,
+          suite: this.testSuite,
+          runner: 'jest-circus'
+        })
+      }
+    }
+  }
+}
+
+addHook({
+  name: 'jest-environment-node',
+  versions: ['>=24.8.0']
+}, getWrappedEnvironment)
+
+addHook({
+  name: 'jest-environment-jsdom',
+  versions: ['>=24.8.0']
+}, getWrappedEnvironment)
+
+addHook({
+  name: 'jest-jasmine2',
+  versions: ['>=24.8.0'],
+  file: 'build/jasmineAsyncInstall.js'
+}, (jasmineAsyncInstallExport) => {
+  return function (globalConfig, globalInput) {
+    globalInput._ddtrace = global._ddtrace
+    shimmer.wrap(globalInput.jasmine.Spec.prototype, 'execute', execute => function (onComplete) {
+      const asyncResource = new AsyncResource('bound-anonymous-fn')
+      asyncResource.runInAsyncScope(() => {
+        const testSuite = getTestSuitePath(this.result.testPath, globalConfig.rootDir)
+        testStartCh.publish({
+          name: this.getFullName(),
+          suite: testSuite,
+          runner: 'jest-jasmine2'
+        })
+        const spec = this
+        const callback = asyncResource.bind(function () {
+          if (spec.result.failedExpectations && spec.result.failedExpectations.length) {
+            const formattedError = formatJestError(spec.result.failedExpectations[0].error)
+            testErrCh.publish(formattedError)
+          }
+          testRunEndCh.publish(specStatusToTestStatus[spec.result.status])
+          onComplete.apply(this, arguments)
+        })
+        arguments[0] = callback
+        execute.apply(this, arguments)
+      })
+    })
+    return jasmineAsyncInstallExport.default(globalConfig, globalInput)
+  }
+})

package/packages/datadog-plugin-aws-sdk/src/helpers.js

@@ -19,7 +19,7 @@ function getService (Service) {
 }
 
 const helpers = {
-  finish (span, err) {
+  finish (config, span, response, err) {
     if (err) {
       span.setTag('error', err)
 
@@ -28,6 +28,8 @@ const helpers = {
       }
     }
 
+    config.hooks.request(span, response)
+
     span.finish()
   },
 
@@ -43,14 +45,12 @@ const helpers = {
       : true
   },
 
-  addResponseTags (span, response, serviceName, config) {
+  addResponseTags (span, response, serviceName) {
     if (!span) return
 
     if (response.request) {
       this.addServicesTags(span, response, serviceName)
     }
-
-    config.hooks.request(span, response)
   },
 
   addServicesTags (span, response, serviceName) {

package/packages/datadog-plugin-aws-sdk/src/index.js

@@ -36,7 +36,7 @@ function createWrapRequest (tracer, config) {
         if (!span) return
 
         awsHelpers.addResponseTags(span, response, serviceIdentifier, config, tracer)
-        awsHelpers.finish(span, response.error)
+        awsHelpers.finish(config, span, response, response.error)
       })
 
       analyticsSampler.sample(span, config.measured)

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

@@ -5,20 +5,18 @@ const { storage } = require('../../datadog-core')
 
 const {
   CI_APP_ORIGIN,
-  TEST_TYPE,
-  TEST_NAME,
-  TEST_SUITE,
   TEST_SKIP_REASON,
-  TEST_FRAMEWORK_VERSION,
   ERROR_MESSAGE,
   TEST_STATUS,
+  TEST_CODE_OWNERS,
   finishAllTraceSpans,
   getTestEnvironmentMetadata,
-  getTestSuitePath
+  getTestSuitePath,
+  getCodeOwnersFileEntries,
+  getCodeOwnersForFilename,
+  getTestCommonTags
 } = require('../../dd-trace/src/plugins/util/test')
-const { SPAN_TYPE, RESOURCE_NAME, SAMPLING_PRIORITY } = require('../../../ext/tags')
-const { SAMPLING_RULE_DECISION } = require('../../dd-trace/src/constants')
-const { AUTO_KEEP } = require('../../../ext/priority')
+const { RESOURCE_NAME } = require('../../../ext/tags')
 
 class CucumberPlugin extends Plugin {
   static get name () {
@@ -30,26 +28,28 @@ class CucumberPlugin extends Plugin {
 
     const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber', this.config)
     const sourceRoot = process.cwd()
+    const codeOwnersEntries = getCodeOwnersFileEntries(sourceRoot)
 
     this.addSub('ci:cucumber:run:start', ({ pickleName, pickleUri }) => {
       const store = storage.getStore()
       const childOf = store ? store.span : store
       const testSuite = getTestSuitePath(pickleUri, sourceRoot)
 
+      const commonTags = getTestCommonTags(pickleName, testSuite, this.tracer._version)
+
+      const codeOwners = getCodeOwnersForFilename(testSuite, codeOwnersEntries)
+      if (codeOwners) {
+        commonTags[TEST_CODE_OWNERS] = codeOwners
+      }
+
       const span = this.tracer.startSpan('cucumber.test', {
         childOf,
         tags: {
-          [SPAN_TYPE]: 'test',
-          [RESOURCE_NAME]: pickleName,
-          [TEST_TYPE]: 'test',
-          [TEST_NAME]: pickleName,
-          [TEST_SUITE]: testSuite,
-          [SAMPLING_RULE_DECISION]: 1,
-          [SAMPLING_PRIORITY]: AUTO_KEEP,
-          [TEST_FRAMEWORK_VERSION]: this.tracer._version,
+          ...commonTags,
           ...testEnvironmentMetadata
         }
       })
+
       span.context()._trace.origin = CI_APP_ORIGIN
       this.enter(span, store)
     })

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

@@ -1,6 +1,11 @@
-module.exports = [
-  {
-    name: 'cypress',
-    versions: ['>=6.7.0']
+const Plugin = require('../../dd-trace/src/plugins/plugin')
+
+// Cypress plugin does not patch any library. This is just a placeholder to
+// follow the structure of the plugins
+class CypressPlugin extends Plugin {
+  static get name () {
+    return 'cypress'
   }
-]
+}
+
+module.exports = CypressPlugin

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

@@ -1,18 +1,16 @@
 const {
-  TEST_TYPE,
-  TEST_NAME,
-  TEST_SUITE,
   TEST_STATUS,
-  TEST_FRAMEWORK_VERSION,
   TEST_IS_RUM_ACTIVE,
+  TEST_CODE_OWNERS,
   getTestEnvironmentMetadata,
   CI_APP_ORIGIN,
-  getTestParentSpan
+  getTestParentSpan,
+  getCodeOwnersFileEntries,
+  getCodeOwnersForFilename,
+  getTestCommonTags
 } = require('../../dd-trace/src/plugins/util/test')
 
-const { SAMPLING_RULE_DECISION, ORIGIN_KEY } = require('../../dd-trace/src/constants')
-const { SAMPLING_PRIORITY, SPAN_TYPE, RESOURCE_NAME } = require('../../../ext/tags')
-const { AUTO_KEEP } = require('../../../ext/priority')
+const { ORIGIN_KEY } = require('../../dd-trace/src/constants')
 
 const CYPRESS_STATUS_TO_TEST_STATUS = {
   passed: 'pass',
@@ -24,21 +22,20 @@ const CYPRESS_STATUS_TO_TEST_STATUS = {
 function getTestSpanMetadata (tracer, testName, testSuite, cypressConfig) {
   const childOf = getTestParentSpan(tracer)
 
+  const commonTags = getTestCommonTags(testName, testSuite, cypressConfig.version)
+
   return {
     childOf,
-    resource: `${testSuite}.${testName}`,
-    [TEST_TYPE]: 'test',
-    [TEST_NAME]: testName,
-    [TEST_SUITE]: testSuite,
-    [SAMPLING_RULE_DECISION]: 1,
-    [SAMPLING_PRIORITY]: AUTO_KEEP,
-    [TEST_FRAMEWORK_VERSION]: cypressConfig.version
+    ...commonTags
   }
 }
 
 module.exports = (on, config) => {
   const tracer = require('../../dd-trace')
   const testEnvironmentMetadata = getTestEnvironmentMetadata('cypress')
+
+  const codeOwnersEntries = getCodeOwnersFileEntries()
+
   let activeSpan = null
   on('after:run', () => {
     return new Promise(resolve => {
@@ -55,12 +52,16 @@ module.exports = (on, config) => {
         ...testSpanMetadata
       } = getTestSpanMetadata(tracer, testName, testSuite, config)
 
+      const codeOwners = getCodeOwnersForFilename(testSuite, codeOwnersEntries)
+
+      if (codeOwners) {
+        testSpanMetadata[TEST_CODE_OWNERS] = codeOwners
+      }
+
       if (!activeSpan) {
         activeSpan = tracer.startSpan('cypress.test', {
           childOf,
           tags: {
-            [SPAN_TYPE]: 'test',
-            [RESOURCE_NAME]: resource,
             [ORIGIN_KEY]: CI_APP_ORIGIN,
             ...testSpanMetadata,
             ...testEnvironmentMetadata

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

@@ -60,6 +60,7 @@ function createWrapCreateReadStream (config, tracer) {
       const tags = makeFSFlagTags('ReadStream', path, options, 'r', config, tracer)
       return tracer.trace('fs.operation', { tags, orphanable }, (span, done) => {
         const stream = createReadStream.apply(this, arguments)
+        stream.once('close', done)
         stream.once('end', done)
         stream.once('error', done)
         return stream
@@ -74,6 +75,7 @@ function createWrapCreateWriteStream (config, tracer) {
       const tags = makeFSFlagTags('WriteStream', path, options, 'w', config, tracer)
       return tracer.trace('fs.operation', { tags, orphanable }, (span, done) => {
         const stream = createWriteStream.apply(this, arguments)
+        stream.once('close', done)
         stream.once('finish', done)
         stream.once('error', done)
         return stream

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

@@ -4,9 +4,6 @@ const Plugin = require('../../dd-trace/src/plugins/plugin')
 const { storage } = require('../../datadog-core')
 const web = require('../../dd-trace/src/plugins/util/web')
 const { incomingHttpRequestStart } = require('../../dd-trace/src/appsec/gateway/channels')
-const tags = require('../../../ext/tags')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-const SERVICE_NAME = tags.SERVICE_NAME
 
 class HttpServerPlugin extends Plugin {
   static get name () {
@@ -20,11 +17,6 @@ class HttpServerPlugin extends Plugin {
       const store = storage.getStore()
       const span = web.startSpan(this.tracer, this.config, req, res, 'http.request')
 
-      if (this.config.service) {
-        span.setTag(SERVICE_NAME, this.config.service)
-      }
-
-      analyticsSampler.sample(span, this.config.measured, true)
       this.enter(span, store)
 
       const context = web.getContext(req)

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

@@ -1,4 +1,102 @@
-const jestEnvironment = require('./jest-environment')
-const jestJasmine2 = require('./jest-jasmine2')
+const Plugin = require('../../dd-trace/src/plugins/plugin')
+const { storage } = require('../../datadog-core')
 
-module.exports = [].concat(jestEnvironment, jestJasmine2)
+const {
+  CI_APP_ORIGIN,
+  TEST_STATUS,
+  JEST_TEST_RUNNER,
+  finishAllTraceSpans,
+  getTestEnvironmentMetadata,
+  getTestParentSpan,
+  getTestCommonTags,
+  TEST_PARAMETERS,
+  getCodeOwnersFileEntries,
+  getCodeOwnersForFilename,
+  TEST_CODE_OWNERS
+} = require('../../dd-trace/src/plugins/util/test')
+
+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 {
+  static get name () {
+    return 'jest'
+  }
+
+  constructor (...args) {
+    super(...args)
+
+    this.testEnvironmentMetadata = getTestEnvironmentMetadata('jest', this.config)
+    this.codeOwnersEntries = getCodeOwnersFileEntries()
+
+    this.addSub('ci:jest:test:start', (test) => {
+      const store = storage.getStore()
+      const span = this.startTestSpan(test)
+
+      this.enter(span, store)
+    })
+
+    this.addSub('ci:jest:test:end', (status) => {
+      const span = storage.getStore().span
+      span.setTag(TEST_STATUS, status)
+      span.finish()
+      finishAllTraceSpans(span)
+      this.exit()
+    })
+
+    this.addSub('ci:jest:test-suite:end', () => {
+      this.tracer._exporter._writer.flush()
+    })
+
+    this.addSub('ci:jest:test:err', (error) => {
+      if (error) {
+        const span = storage.getStore().span
+        span.setTag(TEST_STATUS, 'fail')
+        span.setTag('error', error)
+      }
+    })
+
+    this.addSub('ci:jest:test:skip', (test) => {
+      const span = this.startTestSpan(test)
+      span.setTag(TEST_STATUS, 'skip')
+      span.finish()
+    })
+  }
+
+  startTestSpan (test) {
+    const { childOf, ...testSpanMetadata } = getTestSpanMetadata(this.tracer, test)
+
+    const codeOwners = getCodeOwnersForFilename(test.suite, this.codeOwnersEntries)
+
+    if (codeOwners) {
+      testSpanMetadata[TEST_CODE_OWNERS] = codeOwners
+    }
+
+    const testSpan = this.tracer
+      .startSpan('jest.test', {
+        childOf,
+        tags: {
+          ...this.testEnvironmentMetadata,
+          ...testSpanMetadata
+        }
+      })
+
+    testSpan.context()._trace.origin = CI_APP_ORIGIN
+
+    return testSpan
+  }
+}
+
+module.exports = JestPlugin