dd-trace 2.12.2 → 2.15.0

package/LICENSE-3rdparty.csv

@@ -4,10 +4,12 @@ require,@datadog/native-metrics,Apache license 2.0,Copyright 2018 Datadog Inc.
 require,@datadog/pprof,Apache license 2.0,Copyright 2019 Google Inc.
 require,@datadog/sketches-js,Apache license 2.0,Copyright 2020 Datadog Inc.
 require,@types/node,MIT,Copyright Authors
+require,cidr-matcher,MIT,Copyright 2015 Marco Pracucci
 require,crypto-randomuuid,MIT,Copyright 2021 Node.js Foundation and contributors
 require,diagnostics_channel,MIT,Copyright 2021 Simon D.
 require,ignore,MIT,Copyright 2013 Kael Zhang and contributors
 require,import-in-the-middle,Apache license 2.0,Copyright 2021 Datadog Inc.
+require,istanbul-lib-coverage,BSD-3-Clause,Copyright 2012-2015 Yahoo! Inc.
 require,koalas,MIT,Copyright 2013-2017 Brian Woodward
 require,limiter,MIT,Copyright 2011 John Hurliman
 require,lodash.kebabcase,MIT,Copyright JS Foundation and other contributors

package/ext/tags.d.ts

@@ -15,7 +15,8 @@ declare const tags: {
   HTTP_ROUTE: 'http.route'
   HTTP_REQUEST_HEADERS: 'http.request.headers'
   HTTP_RESPONSE_HEADERS: 'http.response.headers'
-  HTTP_USERAGENT: 'http.useragent'
+  HTTP_USERAGENT: 'http.useragent',
+  HTTP_CLIENT_IP: 'http.client_ip'
 }
 
 export = tags

package/ext/tags.js

@@ -20,7 +20,8 @@ const tags = {
   HTTP_ROUTE: 'http.route',
   HTTP_REQUEST_HEADERS: 'http.request.headers',
   HTTP_RESPONSE_HEADERS: 'http.response.headers',
-  HTTP_USERAGENT: 'http.useragent'
+  HTTP_USERAGENT: 'http.useragent',
+  HTTP_CLIENT_IP: 'http.client_ip'
 }
 
 // Deprecated

package/index.d.ts

@@ -267,6 +267,22 @@ export declare interface TracerOptions {
    */
   sampleRate?: number;
 
+  /**
+   * Global rate limit that is applied on the global sample rate and all rules,
+   * and controls the ingestion rate limit between the agent and the backend.
+   * Defaults to deferring the decision to the agent.
+   */
+  rateLimit?: Number,
+
+  /**
+   * Sampling rules to apply to priority samplin. Each rule is a JSON,
+   * consisting of `service` and `name`, which are regexes to match against
+   * a trace's `service` and `name`, and a corresponding `sampleRate`. If not
+   * specified, will defer to global sampling rate for all spans.
+   * @default []
+   */
+  samplingRules?: SamplingRule[]
+
   /**
    * Interval in milliseconds at which the tracer will submit traces to the agent.
    * @default 2000
@@ -298,7 +314,10 @@ export declare interface TracerOptions {
   protocolVersion?: string
 
   /**
-   * Configuration of the ingestion between the agent and the backend.
+   * Deprecated in favor of the global versions of the variables provided under this option
+   *
+   * @deprecated
+   * @hidden
    */
   ingestion?: {
     /**
@@ -307,7 +326,7 @@ export declare interface TracerOptions {
     sampleRate?: number
 
     /**
-     * Controls the ingestion rate limit between the agent and the backend.
+     * Controls the ingestion rate limit between the agent and the backend. Defaults to deferring the decision to the agent.
      */
     rateLimit?: number
   };
@@ -333,32 +352,36 @@ export declare interface TracerOptions {
     exporter?: 'log' | 'agent'
 
     /**
-     * Configuration of the priority sampler. Supports a global config and rules by span name or service name. The first matching rule is applied, and if no rule matches it falls back to the global config or on the rates provided by the agent if there is no global config.
+     * Whether to enable the experimental `getRumData` method.
+     * @default false
      */
-    sampler?: {
+    enableGetRumData?: boolean
+
+    /**
+     * Configuration of the IAST. Can be a boolean as an alias to `iast.enabled`.
+     */
+    iast?: boolean  | {
       /**
-       * Sample rate to apply globally when no other rule is matched. Omit to fallback on the dynamic rates returned by the agent instead.
+       * Whether to enable IAST.
+       * @default false
        */
-      sampleRate?: Number,
-
+      enabled?: boolean,
       /**
-       * Global rate limit that is applied on the global sample rate and all rules.
-       * @default 100
+       * Controls the percentage of requests that iast will analyze
+       * @default 30
        */
-      rateLimit?: Number,
-
+      requestSampling?: number,
       /**
-       * Sampling rules to apply to priority sampling.
-       * @default []
+       * Controls how many request can be analyzing code vulnerabilities at the same time
+       * @default 2
        */
-      rules?: SamplingRule[]
+      maxConcurrentRequests?: number,
+      /**
+       * Controls how many code vulnerabilities can be detected in the same request
+       * @default 2
+       */
+      maxContextOperations?: number
     }
-
-    /**
-     * Whether to enable the experimental `getRumData` method.
-     * @default false
-     */
-    enableGetRumData?: boolean
   };
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.12.2",
+  "version": "2.15.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -61,12 +61,14 @@
     "@datadog/native-appsec": "^1.2.1",
     "@datadog/native-metrics": "^1.4.2",
     "@datadog/pprof": "^1.0.2",
-    "@datadog/sketches-js": "^1.0.5",
+    "@datadog/sketches-js": "^2.1.0",
     "@types/node": ">=12",
+    "cidr-matcher": "^2.1.1",
     "crypto-randomuuid": "^1.0.0",
     "diagnostics_channel": "^1.1.0",
     "ignore": "^5.2.0",
-    "import-in-the-middle": "^1.3.0",
+    "import-in-the-middle": "^1.3.1",
+    "istanbul-lib-coverage": "3.2.0",
     "koalas": "^1.0.2",
     "limiter": "^1.1.4",
     "lodash.kebabcase": "^4.1.1",

package/packages/datadog-core/src/storage/async_resource.js

@@ -6,9 +6,27 @@ const { channel } = require('diagnostics_channel')
 const beforeCh = channel('dd-trace:storage:before')
 const afterCh = channel('dd-trace:storage:after')
 
+let PrivateSymbol = Symbol
+function makePrivateSymbol () {
+  // eslint-disable-next-line no-new-func
+  PrivateSymbol = new Function('name', 'return %CreatePrivateSymbol(name)')
+}
+
+try {
+  makePrivateSymbol()
+} catch (e) {
+  try {
+    const v8 = require('v8')
+    v8.setFlagsFromString('--allow-natives-syntax')
+    makePrivateSymbol()
+    v8.setFlagsFromString('--no-allow-natives-syntax')
+  // eslint-disable-next-line no-empty
+  } catch (e) {}
+}
+
 class AsyncResourceStorage {
   constructor () {
-    this._ddResourceStore = Symbol('ddResourceStore')
+    this._ddResourceStore = PrivateSymbol('ddResourceStore')
     this._enabled = false
     this._hook = createHook(this._createHook())
   }

package/packages/datadog-instrumentations/index.js

@@ -1,54 +1,3 @@
 'use strict'
 
-require('./src/amqplib')
-require('./src/amqp10')
-require('./src/aws-sdk')
-require('./src/bluebird')
-require('./src/bunyan')
-require('./src/cassandra-driver')
-require('./src/connect')
-require('./src/couchbase')
-require('./src/cucumber')
-require('./src/dns')
-require('./src/elasticsearch')
-require('./src/express')
-require('./src/fastify')
-require('./src/find-my-way')
-require('./src/generic-pool')
-require('./src/google-cloud-pubsub')
-require('./src/graphql')
-require('./src/grpc')
-require('./src/hapi')
-require('./src/http')
-require('./src/http2')
-require('./src/ioredis')
-require('./src/jest')
-require('./src/kafkajs')
-require('./src/knex')
-require('./src/koa')
-require('./src/memcached')
-require('./src/microgateway-core')
-require('./src/moleculer')
-require('./src/mongodb-core')
-require('./src/mongoose')
-require('./src/mysql')
-require('./src/mysql2')
-require('./src/mocha')
-require('./src/net')
-require('./src/next')
-require('./src/oracledb')
-require('./src/paperplane')
-require('./src/pino')
-require('./src/pg')
-require('./src/promise')
-require('./src/promise-js')
-require('./src/q')
-require('./src/redis')
-require('./src/restify')
-require('./src/router')
-require('./src/rhea')
-require('./src/sharedb')
-require('./src/tedious')
-require('./src/when')
-require('./src/winston')
-require('./src/limitd-client')
+require('./src/helpers/register')

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

@@ -0,0 +1,30 @@
+'use strict'
+
+const {
+  channel,
+  addHook
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+const cryptoCh = channel('datadog:crypto:hashing:start')
+
+addHook({ name: 'crypto' }, crypto => {
+  shimmer.massWrap(
+    crypto,
+    ['createHash', 'createHmac', 'createSign', 'createVerify', 'sign', 'verify'],
+    wrapMethod
+  )
+  return crypto
+})
+
+function wrapMethod (cryptoMethod) {
+  return function () {
+    if (cryptoCh.hasSubscribers) {
+      if (arguments.length > 0) {
+        const algorithm = arguments[0]
+        cryptoCh.publish({ algorithm })
+      }
+    }
+    return cryptoMethod.apply(this, arguments)
+  }
+}

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

@@ -7,6 +7,7 @@ const runStartCh = channel('ci:cucumber:run:start')
 const runFinishCh = channel('ci:cucumber:run:finish')
 const runStepStartCh = channel('ci:cucumber:run-step:start')
 const errorCh = channel('ci:cucumber:error')
+const sessionFinishCh = channel('ci:cucumber:session:finish')
 
 // TODO: remove in a later major version
 const patched = new WeakSet()
@@ -128,4 +129,18 @@ addHook({
   file: 'lib/runtime/test_case_runner.js'
 }, testCaseHook)
 
+addHook({
+  name: '@cucumber/cucumber',
+  versions: ['>=7.0.0'],
+  file: 'lib/runtime/index.js'
+}, (Runtime) => {
+  shimmer.wrap(Runtime.default.prototype, 'start', start => async function () {
+    const result = await start.apply(this, arguments)
+    sessionFinishCh.publish(undefined)
+    return result
+  })
+
+  return Runtime
+})
+
 module.exports = { pickleHook, testCaseHook }

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

@@ -0,0 +1,11 @@
+'use strict'
+
+const { addHook, channel } = require('./helpers/instrument')
+
+const hookChannel = channel('apm:fs:hook')
+
+// HACK: trigger old style plugin
+addHook({ name: 'fs' }, fs => {
+  hookChannel.publish(fs)
+  return fs
+})

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

@@ -0,0 +1,70 @@
+'use strict'
+
+module.exports = {
+  '@cucumber/cucumber': () => require('../cucumber'),
+  '@elastic/elasticsearch': () => require('../elasticsearch'),
+  '@elastic/transport': () => require('../elasticsearch'),
+  '@google-cloud/pubsub': () => require('../google-cloud-pubsub'),
+  '@grpc/grpc-js': () => require('../grpc'),
+  '@hapi/hapi': () => require('../hapi'),
+  '@koa/router': () => require('../koa'),
+  '@node-redis/client': () => require('../redis'),
+  'amqp10': () => require('../amqp10'),
+  'amqplib': () => require('../amqplib'),
+  'aws-sdk': () => require('../aws-sdk'),
+  'bluebird': () => require('../bluebird'),
+  'bunyan': () => require('../bunyan'),
+  'cassandra-driver': () => require('../cassandra-driver'),
+  'connect': () => require('../connect'),
+  'couchbase': () => require('../couchbase'),
+  'crypto': () => require('../crypto'),
+  'cypress': () => require('../cypress'),
+  'dns': () => require('../dns'),
+  'elasticsearch': () => require('../elasticsearch'),
+  'express': () => require('../express'),
+  'fastify': () => require('../fastify'),
+  'find-my-way': () => require('../find-my-way'),
+  'fs': () => require('../fs'),
+  'graphql': () => require('../graphql'),
+  'grpc': () => require('../grpc'),
+  'hapi': () => require('../hapi'),
+  'http': () => require('../http'),
+  'http2': () => require('../http2'),
+  'https': () => require('../http'),
+  'ioredis': () => require('../ioredis'),
+  'jest-environment-node': () => require('../jest'),
+  'jest-environment-jsdom': () => require('../jest'),
+  'jest-jasmine2': () => require('../jest'),
+  'koa': () => require('../koa'),
+  'koa-router': () => require('../koa'),
+  'kafkajs': () => require('../kafkajs'),
+  'limitd-client': () => require('../limitd-client'),
+  'memcached': () => require('../memcached'),
+  'microgateway-core': () => require('../microgateway-core'),
+  'mocha': () => require('../mocha'),
+  'mocha-each': () => require('../mocha'),
+  'moleculer': () => require('../moleculer'),
+  'mongodb': () => require('../mongodb-core'),
+  'mongodb-core': () => require('../mongodb-core'),
+  'mongoose': () => require('../mongoose'),
+  'mysql': () => require('../mysql'),
+  'mysql2': () => require('../mysql2'),
+  'net': () => require('../net'),
+  'next': () => require('../next'),
+  'oracledb': () => require('../oracledb'),
+  'paperplane': () => require('../paperplane'),
+  'pg': () => require('../pg'),
+  'pino': () => require('../pino'),
+  'pino-pretty': () => require('../pino'),
+  'promise-js': () => require('../promise-js'),
+  'promise': () => require('../promise'),
+  'q': () => require('../q'),
+  'redis': () => require('../redis'),
+  'restify': () => require('../restify'),
+  'rhea': () => require('../rhea'),
+  'router': () => require('../router'),
+  'sharedb': () => require('../sharedb'),
+  'tedious': () => require('../tedious'),
+  'when': () => require('../when'),
+  'winston': () => require('../winston')
+}

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

@@ -1,16 +1,12 @@
 'use strict'
 
 const dc = require('diagnostics_channel')
-const path = require('path')
 const semver = require('semver')
-const Hook = require('./hook')
-const requirePackageJson = require('../../../dd-trace/src/require-package-json')
+const instrumentations = require('./instrumentations')
 const { AsyncResource } = require('async_hooks')
-const log = require('../../../dd-trace/src/log')
 
-const pathSepExpr = new RegExp(`\\${path.sep}`, 'g')
 const channelMap = {}
-exports.channel = function channel (name) {
+exports.channel = function (name) {
   const maybe = channelMap[name]
   if (maybe) return maybe
   const ch = dc.channel(name)
@@ -19,36 +15,11 @@ exports.channel = function channel (name) {
 }
 
 exports.addHook = function addHook ({ name, versions, file }, hook) {
-  const fullFilename = filename(name, file)
-
-  Hook([name], (moduleExports, moduleName, moduleBaseDir) => {
-    moduleName = moduleName.replace(pathSepExpr, '/')
-
-    if (moduleName !== fullFilename || !matchVersion(getVersion(moduleBaseDir), versions)) {
-      return moduleExports
-    }
-
-    try {
-      return hook(moduleExports)
-    } catch (e) {
-      log.error(e)
-      return moduleExports
-    }
-  })
-}
-
-function matchVersion (version, ranges) {
-  return !version || (ranges && ranges.some(range => semver.satisfies(semver.coerce(version), range)))
-}
-
-function getVersion (moduleBaseDir) {
-  if (moduleBaseDir) {
-    return requirePackageJson(moduleBaseDir, module).version
+  if (!instrumentations[name]) {
+    instrumentations[name] = []
   }
-}
 
-function filename (name, file) {
-  return [name, file].filter(val => val).join('/')
+  instrumentations[name].push({ name, versions, file, hook })
 }
 
 // AsyncResource.bind exists and binds `this` properly only from 17.8.0 and up.

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

@@ -0,0 +1,7 @@
+'use strict'
+
+const sym = Symbol.for('_ddtrace_instrumentations')
+
+global[sym] = global[sym] || {}
+
+module.exports = global[sym]

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

@@ -0,0 +1,59 @@
+'use strict'
+
+const { channel } = require('diagnostics_channel')
+const path = require('path')
+const semver = require('semver')
+const Hook = require('./hook')
+const requirePackageJson = require('../../../dd-trace/src/require-package-json')
+const log = require('../../../dd-trace/src/log')
+
+const hooks = require('./hooks')
+const instrumentations = require('./instrumentations')
+const names = Object.keys(hooks)
+const pathSepExpr = new RegExp(`\\${path.sep}`, 'g')
+
+const loadChannel = channel('dd-trace:instrumentation:load')
+
+// TODO: make this more efficient
+
+for (const packageName of names) {
+  Hook([packageName], (moduleExports, moduleName, moduleBaseDir) => {
+    moduleName = moduleName.replace(pathSepExpr, '/')
+
+    hooks[packageName]()
+
+    for (const { name, file, versions, hook } of instrumentations[packageName]) {
+      const fullFilename = filename(name, file)
+
+      if (moduleName === fullFilename) {
+        const version = getVersion(moduleBaseDir)
+
+        if (matchVersion(version, versions)) {
+          try {
+            loadChannel.publish({ name, version, file })
+
+            moduleExports = hook(moduleExports)
+          } catch (e) {
+            log.error(e)
+          }
+        }
+      }
+    }
+
+    return moduleExports
+  })
+}
+
+function matchVersion (version, ranges) {
+  return !version || (ranges && ranges.some(range => semver.satisfies(semver.coerce(version), range)))
+}
+
+function getVersion (moduleBaseDir) {
+  if (moduleBaseDir) {
+    return requirePackageJson(moduleBaseDir, module).version
+  }
+}
+
+function filename (name, file) {
+  return [name, file].filter(val => val).join('/')
+}

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

@@ -29,7 +29,7 @@ function wrapResponseEmit (emit) {
       return emit.apply(this, arguments)
     }
 
-    if (eventName === 'finish') {
+    if (eventName === 'close') {
       finishServerCh.publish({ req: this.req })
     }
 

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

@@ -1,5 +1,5 @@
 'use strict'
-
+const istanbul = require('istanbul-lib-coverage')
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 
@@ -7,7 +7,8 @@ const testStartCh = channel('ci:jest:test:start')
 const testSkippedCh = channel('ci:jest:test:skip')
 const testRunFinishCh = channel('ci:jest:test:finish')
 const testErrCh = channel('ci:jest:test:err')
-const testSuiteFinish = channel('ci:jest:test-suite:finish')
+
+const testCodeCoverageCh = channel('ci:jest:test:code-coverage')
 
 const {
   getTestSuitePath,
@@ -16,6 +17,24 @@ const {
 
 const { getFormattedJestTestParameters, getJestTestName } = require('../../datadog-plugin-jest/src/util')
 
+// This function also resets the coverage counters
+function extractCoverageInformation (coverage, rootDir) {
+  const coverageMap = istanbul.createCoverageMap(coverage)
+
+  return coverageMap
+    .files()
+    .filter(filename => {
+      const fileCoverage = coverageMap.fileCoverageFor(filename)
+      const lineCoverage = fileCoverage.getLineCoverage()
+      const isAnyLineExecuted = Object.entries(lineCoverage).some(([, numExecutions]) => !!numExecutions)
+
+      fileCoverage.resetHits()
+
+      return isAnyLineExecuted
+    })
+    .map(filename => filename.replace(`${rootDir}/`, ''))
+}
+
 const specStatusToTestStatus = {
   'pending': 'skip',
   'disabled': 'skip',
@@ -49,15 +68,11 @@ function getWrappedEnvironment (BaseEnvironment) {
     constructor (config, context) {
       super(config, context)
       const rootDir = config.globalConfig ? config.globalConfig.rootDir : config.rootDir
+      this.rootDir = rootDir
       this.testSuite = getTestSuitePath(context.testPath, rootDir)
       this.nameToParams = {}
       this.global._ddtrace = global._ddtrace
     }
-    async teardown () {
-      super.teardown().finally(() => {
-        testSuiteFinish.publish()
-      })
-    }
 
     async handleTestEvent (event, state) {
       if (super.handleTestEvent) {
@@ -99,6 +114,10 @@ function getWrappedEnvironment (BaseEnvironment) {
       if (event.name === 'test_done') {
         const asyncResource = asyncResources.get(event.test)
         asyncResource.runInAsyncScope(() => {
+          if (this.global.__coverage__) {
+            const coverageFiles = extractCoverageInformation(this.global.__coverage__, this.rootDir)
+            testCodeCoverageCh.publish(coverageFiles)
+          }
           let status = 'pass'
           if (event.test.errors && event.test.errors.length) {
             status = 'fail'
@@ -111,10 +130,13 @@ function getWrappedEnvironment (BaseEnvironment) {
         })
       }
       if (event.name === 'test_skip' || event.name === 'test_todo') {
-        testSkippedCh.publish({
-          name: getJestTestName(event.test),
-          suite: this.testSuite,
-          runner: 'jest-circus'
+        const asyncResource = new AsyncResource('bound-anonymous-fn')
+        asyncResource.runInAsyncScope(() => {
+          testSkippedCh.publish({
+            name: getJestTestName(event.test),
+            suite: this.testSuite,
+            runner: 'jest-circus'
+          })
         })
       }
     }

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

@@ -49,6 +49,19 @@ addHook({ name: 'net' }, net => {
         setupListeners(this, 'tcp', asyncResource)
       }
 
+      const emit = this.emit
+      this.emit = function (eventName) {
+        switch (eventName) {
+          case 'ready':
+          case 'connect':
+            return callbackResource.runInAsyncScope(() => {
+              return emit.apply(this, arguments)
+            })
+          default:
+            return emit.apply(this, arguments)
+        }
+      }
+
       try {
         return connect.apply(this, arguments)
       } catch (err) {

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

@@ -30,6 +30,10 @@ class CucumberPlugin extends Plugin {
     const sourceRoot = process.cwd()
     const codeOwnersEntries = getCodeOwnersFileEntries(sourceRoot)
 
+    this.addSub('ci:cucumber:session:finish', () => {
+      this.tracer._exporter._writer.flush()
+    })
+
     this.addSub('ci:cucumber:run:start', ({ pickleName, pickleUri }) => {
       const store = storage.getStore()
       const childOf = store ? store.span : store