dd-trace 2.4.2 → 2.5.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.4.2",
+  "version": "2.5.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -61,7 +61,7 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^1.0.0",
+    "@datadog/native-appsec": "^1.0.1",
     "@datadog/native-metrics": "^1.1.0",
     "@datadog/pprof": "^0.3.0",
     "@datadog/sketches-js": "^1.0.4",
@@ -69,6 +69,7 @@
     "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/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-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

@@ -12,9 +12,12 @@ const {
   TEST_FRAMEWORK_VERSION,
   ERROR_MESSAGE,
   TEST_STATUS,
+  TEST_CODE_OWNERS,
   finishAllTraceSpans,
   getTestEnvironmentMetadata,
-  getTestSuitePath
+  getTestSuitePath,
+  getCodeOwnersFileEntries,
+  getCodeOwnersForFilename
 } = 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')
@@ -30,26 +33,35 @@ 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 testSpanMetadata = {
+        [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,
+        ...testEnvironmentMetadata
+      }
+
+      const codeOwners = getCodeOwnersForFilename(testSuite, codeOwnersEntries)
+      if (codeOwners) {
+        testSpanMetadata[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,
-          ...testEnvironmentMetadata
-        }
+        tags: testSpanMetadata
       })
+
       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

@@ -5,9 +5,12 @@ const {
   TEST_STATUS,
   TEST_FRAMEWORK_VERSION,
   TEST_IS_RUM_ACTIVE,
+  TEST_CODE_OWNERS,
   getTestEnvironmentMetadata,
   CI_APP_ORIGIN,
-  getTestParentSpan
+  getTestParentSpan,
+  getCodeOwnersFileEntries,
+  getCodeOwnersForFilename
 } = require('../../dd-trace/src/plugins/util/test')
 
 const { SAMPLING_RULE_DECISION, ORIGIN_KEY } = require('../../dd-trace/src/constants')
@@ -39,6 +42,9 @@ function getTestSpanMetadata (tracer, testName, testSuite, cypressConfig) {
 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,6 +61,12 @@ 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,

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

@@ -5,6 +5,7 @@ const { storage } = require('../../datadog-core')
 
 const {
   CI_APP_ORIGIN,
+  TEST_CODE_OWNERS,
   TEST_TYPE,
   TEST_NAME,
   TEST_SUITE,
@@ -15,7 +16,9 @@ const {
   getTestEnvironmentMetadata,
   getTestSuitePath,
   getTestParentSpan,
-  getTestParametersString
+  getTestParametersString,
+  getCodeOwnersFileEntries,
+  getCodeOwnersForFilename
 } = 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')
@@ -54,6 +57,7 @@ class MochaPlugin extends Plugin {
     this._testNameToParams = {}
     this.testEnvironmentMetadata = getTestEnvironmentMetadata('mocha', this.config)
     this.sourceRoot = process.cwd()
+    this.codeOwnersEntries = getCodeOwnersFileEntries(this.sourceRoot)
 
     this.addSub('ci:mocha:test:start', (test) => {
       const store = storage.getStore()
@@ -139,6 +143,11 @@ class MochaPlugin extends Plugin {
     if (testParametersString) {
       testSpanMetadata[TEST_PARAMETERS] = testParametersString
     }
+    const codeOwners = getCodeOwnersForFilename(testSpanMetadata[TEST_SUITE], this.codeOwnersEntries)
+
+    if (codeOwners) {
+      testSpanMetadata[TEST_CODE_OWNERS] = codeOwners
+    }
 
     const testSpan = this.tracer
       .startSpan('mocha.test', {

package/packages/dd-trace/lib/version.js

@@ -1 +1 @@
-module.exports = '2.4.2'
+module.exports = '2.5.0'

package/packages/dd-trace/src/appsec/callbacks/ddwaf.js

@@ -70,7 +70,7 @@ class WAFCallback {
       }
     }
 
-    if (!wafContext) {
+    if (!wafContext || wafContext.disposed) {
       wafContext = this.ddwaf.createContext()
     }
 
@@ -87,6 +87,8 @@ class WAFCallback {
     } catch (err) {
       log.error('Error while running the AppSec WAF')
       log.error(err)
+    } finally {
+      wafContext.dispose()
     }
   }
 

package/packages/dd-trace/src/appsec/recommended.json

@@ -1,7 +1,7 @@
 {
   "version": "2.2",
   "metadata": {
-    "rules_version": "1.3.0"
+    "rules_version": "1.3.1"
   },
   "rules": [
     {
@@ -3040,7 +3040,9 @@
           "operator": "match_regex"
         }
       ],
-      "transformers": []
+      "transformers": [
+        "keys_only"
+      ]
     },
     {
       "id": "crs-942-360",
@@ -4097,15 +4099,23 @@
           "parameters": {
             "inputs": [
               {
-                "address": "server.request.headers.no_cookies"
+                "address": "server.request.query"
+              },
+              {
+                "address": "server.request.body"
+              },
+              {
+                "address": "server.request.path_params"
               }
             ],
-            "regex": "\\$(eq|ne|lte?|gte?|n?in)\\b"
+            "regex": "^\\$(eq|ne|(l|g)te?|n?in|not|(n|x|)or|and|regex|where|expr|exists)$"
           },
           "operator": "match_regex"
         }
       ],
-      "transformers": []
+      "transformers": [
+        "keys_only"
+      ]
     },
     {
       "id": "sqr-000-008",

package/packages/dd-trace/src/ci-visibility/exporters/agentless/index.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const URL = require('url').URL
+const Writer = require('./writer')
+const Scheduler = require('../../../exporters/scheduler')
+
+class AgentlessCiVisibilityExporter {
+  constructor (config) {
+    const { flushInterval, tags, site, url } = config
+    this._url = url || new URL(`https://citestcycle-intake.${site}`)
+    this._writer = new Writer({ url: this._url, tags })
+
+    if (flushInterval > 0) {
+      this._scheduler = new Scheduler(() => this._writer.flush(), flushInterval)
+    }
+    this._scheduler && this._scheduler.start()
+  }
+
+  export (trace) {
+    this._writer.append(trace)
+
+    if (!this._scheduler) {
+      this._writer.flush()
+    }
+  }
+
+  flush () {
+    this._writer.flush()
+  }
+}
+
+module.exports = AgentlessCiVisibilityExporter

package/packages/dd-trace/src/ci-visibility/exporters/agentless/writer.js

@@ -0,0 +1,51 @@
+'use strict'
+const request = require('../../../exporters/common/request')
+const log = require('../../../log')
+
+const { AgentlessCiVisibilityEncoder } = require('../../../encode/agentless-ci-visibility')
+const BaseWriter = require('../../../exporters/common/writer')
+
+class Writer extends BaseWriter {
+  constructor ({ url, tags }) {
+    super(...arguments)
+    const { 'runtime-id': runtimeId, env, service } = tags
+    this._url = url
+    this._encoder = new AgentlessCiVisibilityEncoder({ runtimeId, env, service })
+  }
+
+  _sendPayload (data, _, done) {
+    makeRequest(data, this._url, (err, res) => {
+      if (err) {
+        log.error(err)
+        done()
+        return
+      }
+      log.debug(`Response from the intake: ${res}`)
+      done()
+    })
+  }
+}
+
+function makeRequest (data, url, cb) {
+  const options = {
+    path: '/api/v2/citestcycle',
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/msgpack',
+      'dd-api-key': process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+    },
+    timeout: 15000
+  }
+
+  options.protocol = url.protocol
+  options.hostname = url.hostname
+  options.port = url.port
+
+  log.debug(() => `Request to the intake: ${JSON.stringify(options)}`)
+
+  request(data, options, false, (err, res) => {
+    cb(err, res)
+  })
+}
+
+module.exports = Writer

package/packages/dd-trace/src/config.js

@@ -66,6 +66,7 @@ class Config {
       process.env.DD_TRACE_URL,
       null
     )
+    const DD_CIVISIBILITY_AGENTLESS_URL = process.env.DD_CIVISIBILITY_AGENTLESS_URL
     const DD_SERVICE = options.service ||
       process.env.DD_SERVICE ||
       process.env.DD_SERVICE_NAME ||
@@ -90,6 +91,10 @@ class Config {
       process.env.DD_TRACE_STARTUP_LOGS,
       false
     )
+    const DD_TRACE_TELEMETRY_ENABLED = coalesce(
+      process.env.DD_TRACE_TELEMETRY_ENABLED,
+      true
+    )
     const DD_TRACE_DEBUG = coalesce(
       process.env.DD_TRACE_DEBUG,
       false
@@ -171,7 +176,8 @@ class Config {
     this.debug = isTrue(DD_TRACE_DEBUG)
     this.logInjection = isTrue(DD_LOGS_INJECTION)
     this.env = DD_ENV
-    this.url = getAgentUrl(DD_TRACE_AGENT_URL, options)
+    this.url = DD_CIVISIBILITY_AGENTLESS_URL ? new URL(DD_CIVISIBILITY_AGENTLESS_URL)
+      : getAgentUrl(DD_TRACE_AGENT_URL, options)
     this.site = coalesce(options.site, process.env.DD_SITE, 'datadoghq.com')
     this.hostname = DD_AGENT_HOST || (this.url && this.url.hostname)
     this.port = String(DD_TRACE_AGENT_PORT || (this.url && this.url.port))
@@ -212,6 +218,7 @@ class Config {
     }
     this.lookup = options.lookup
     this.startupLogs = isTrue(DD_TRACE_STARTUP_LOGS)
+    this.telemetryEnabled = isTrue(DD_TRACE_TELEMETRY_ENABLED)
     this.protocolVersion = DD_TRACE_AGENT_PROTOCOL_VERSION
     this.appsec = {
       enabled: isTrue(DD_APPSEC_ENABLED),

package/packages/dd-trace/src/encode/0.4.js

@@ -196,7 +196,6 @@ class AgentEncoder {
 
     for (const key of keys) {
       if (typeof value[key] !== 'string' && typeof value[key] !== 'number') return
-
       length++
 
       this._encodeString(bytes, key)