dd-trace 3.2.0 → 3.3.1

package/LICENSE-3rdparty.csv

@@ -3,11 +3,11 @@ require,@datadog/native-appsec,Apache license 2.0,Copyright 2018 Datadog Inc.
 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,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,ipaddr.js,MIT,Copyright 2011-2017 whitequark
 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
@@ -15,6 +15,7 @@ require,lodash.kebabcase,MIT,Copyright JS Foundation and other contributors
 require,lodash.pick,MIT,Copyright JS Foundation and other contributors
 require,lodash.sortby,MIT,Copyright JS Foundation and other contributors
 require,lodash.uniq,MIT,Copyright JS Foundation and other contributors
+require,lru-cache,ISC,Copyright (c) 2010-2022 Isaac Z. Schlueter and Contributors
 require,methods,MIT,Copyright 2013-2014 TJ Holowaychuk
 require,module-details-from-path,MIT,Copyright 2016 Thomas Watson Steen
 require,opentracing,MIT,Copyright 2016 Resonance Labs Inc

package/README.md

@@ -21,6 +21,10 @@ For descriptions of terminology used in APM, take a look at the [official docume
 
 Before contributing to this open source project, read our [CONTRIBUTING.md](https://github.com/DataDog/dd-trace-js/blob/master/CONTRIBUTING.md).
 
+## Security Vulnerabilities
+
+If you have found a security issue, please contact the security team directly at [security@datadoghq.com](mailto:security@datadoghq.com).
+
 ### Requirements
 
 Since this project supports multiple Node versions, using a version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -59,14 +59,14 @@
   },
   "dependencies": {
     "@datadog/native-appsec": "^1.2.1",
-    "@datadog/native-metrics": "^1.4.2",
+    "@datadog/native-metrics": "^1.4.3",
     "@datadog/pprof": "^1.0.2",
     "@datadog/sketches-js": "^2.1.0",
-    "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.1",
+    "import-in-the-middle": "^1.3.4",
+    "ipaddr.js": "^2.0.1",
     "istanbul-lib-coverage": "3.2.0",
     "koalas": "^1.0.2",
     "limiter": "^1.1.4",
@@ -74,6 +74,7 @@
     "lodash.pick": "^4.4.0",
     "lodash.sortby": "^4.7.0",
     "lodash.uniq": "^4.5.0",
+    "lru-cache": "^7.14.0",
     "methods": "^1.1.2",
     "module-details-from-path": "^1.0.3",
     "opentracing": ">=0.12.1",

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

@@ -6,25 +6,27 @@ const {
 } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 
-const cryptoCh = channel('datadog:crypto:hashing:start')
+const cryptoHashCh = channel('datadog:crypto:hashing:start')
+const cryptoCipherCh = channel('datadog:crypto:cipher:start')
+
+const hashMethods = ['createHash', 'createHmac', 'createSign', 'createVerify', 'sign', 'verify']
+const cipherMethods = ['createCipheriv', 'createDecipheriv']
 
 addHook({ name: 'crypto' }, crypto => {
-  shimmer.massWrap(
-    crypto,
-    ['createHash', 'createHmac', 'createSign', 'createVerify', 'sign', 'verify'],
-    wrapMethod
-  )
+  shimmer.massWrap(crypto, hashMethods, wrapCryptoMethod(cryptoHashCh))
+  shimmer.massWrap(crypto, cipherMethods, wrapCryptoMethod(cryptoCipherCh))
   return crypto
 })
 
-function wrapMethod (cryptoMethod) {
-  return function () {
-    if (cryptoCh.hasSubscribers) {
-      if (arguments.length > 0) {
+function wrapCryptoMethod (channel) {
+  function wrapMethod (cryptoMethod) {
+    return function () {
+      if (channel.hasSubscribers && arguments.length > 0) {
         const algorithm = arguments[0]
-        cryptoCh.publish({ algorithm })
+        channel.publish({ algorithm })
       }
+      return cryptoMethod.apply(this, arguments)
     }
-    return cryptoMethod.apply(this, arguments)
   }
+  return wrapMethod
 }

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

@@ -37,15 +37,17 @@ function wrapHandler (func, name) {
     return requestResource.runInAsyncScope(() => {
       startChannel.publish({ name, metadata, type })
 
-      // Finish the span if the call was cancelled.
-      call.once('cancelled', requestResource.bind(() => {
+      const onCancel = requestResource.bind(() => {
         finishChannel.publish({ code: CANCELLED })
-      }))
+      })
+
+      // Finish the span if the call was cancelled.
+      call.once('cancelled', onCancel)
 
       if (isStream) {
-        wrapStream(call, requestResource, parentResource)
+        wrapStream(call, requestResource, onCancel)
       } else {
-        arguments[1] = wrapCallback(callback, requestResource, parentResource)
+        arguments[1] = wrapCallback(callback, call, requestResource, parentResource, onCancel)
       }
 
       shimmer.wrap(call, 'emit', emit => requestResource.bind(emit))
@@ -65,7 +67,7 @@ function wrapRegister (register) {
   }
 }
 
-function wrapStream (call, requestResource) {
+function wrapStream (call, requestResource, onCancel) {
   if (call.call && call.call.sendStatus) {
     call.call.sendStatus = wrapSendStatus(call.call.sendStatus, requestResource)
   }
@@ -77,6 +79,8 @@ function wrapStream (call, requestResource) {
           errorChannel.publish(args[0])
           finishChannel.publish({ code: args[0].code })
 
+          call.removeListener('cancelled', onCancel)
+
           break
 
           // Finish the span of the response only if it was successful.
@@ -90,6 +94,8 @@ function wrapStream (call, requestResource) {
             finishChannel.publish()
           }
 
+          call.removeListener('cancelled', onCancel)
+
           break
       }
 
@@ -98,7 +104,7 @@ function wrapStream (call, requestResource) {
   })
 }
 
-function wrapCallback (callback, requestResource, parentResource) {
+function wrapCallback (callback, call, requestResource, parentResource, onCancel) {
   return function (err, value, trailer, flags) {
     requestResource.runInAsyncScope(() => {
       if (err instanceof Error) {
@@ -107,6 +113,8 @@ function wrapCallback (callback, requestResource, parentResource) {
       } else {
         finishChannel.publish({ code: OK, trailer })
       }
+
+      call.removeListener('cancelled', onCancel)
     })
 
     if (callback) {

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

@@ -7,6 +7,7 @@ module.exports = {
   '@google-cloud/pubsub': () => require('../google-cloud-pubsub'),
   '@grpc/grpc-js': () => require('../grpc'),
   '@hapi/hapi': () => require('../hapi'),
+  '@jest/core': () => require('../jest'),
   '@koa/router': () => require('../koa'),
   '@node-redis/client': () => require('../redis'),
   'amqp10': () => require('../amqp10'),
@@ -31,6 +32,8 @@ module.exports = {
   'http2': () => require('../http2'),
   'https': () => require('../http'),
   'ioredis': () => require('../ioredis'),
+  'jest-circus': () => require('../jest'),
+  'jest-config': () => require('../jest'),
   'jest-environment-node': () => require('../jest'),
   'jest-environment-jsdom': () => require('../jest'),
   'jest-jasmine2': () => require('../jest'),

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

@@ -3,13 +3,20 @@ const istanbul = require('istanbul-lib-coverage')
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 
+const testSessionStartCh = channel('ci:jest:session:start')
+const testSessionFinishCh = channel('ci:jest:session:finish')
+
+const testSessionConfigurationCh = channel('ci:jest:session:configuration')
+
+const testSuiteStartCh = channel('ci:jest:test-suite:start')
+const testSuiteFinishCh = channel('ci:jest:test-suite:finish')
+const testSuiteCodeCoverageCh = channel('ci:jest:test-suite:code-coverage')
+
 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 testCodeCoverageCh = channel('ci:jest:test:code-coverage')
-
 const {
   getTestSuitePath,
   getTestParametersString
@@ -17,7 +24,8 @@ const {
 
 const { getFormattedJestTestParameters, getJestTestName } = require('../../datadog-plugin-jest/src/util')
 
-// This function also resets the coverage counters
+const sessionAsyncResource = new AsyncResource('bound-anonymous-fn')
+
 function extractCoverageInformation (coverage, rootDir) {
   const coverageMap = istanbul.createCoverageMap(coverage)
 
@@ -28,8 +36,6 @@ function extractCoverageInformation (coverage, rootDir) {
       const lineCoverage = fileCoverage.getLineCoverage()
       const isAnyLineExecuted = Object.entries(lineCoverage).some(([, numExecutions]) => !!numExecutions)
 
-      fileCoverage.resetHits()
-
       return isAnyLineExecuted
     })
     .map(filename => filename.replace(`${rootDir}/`, ''))
@@ -63,6 +69,16 @@ function formatJestError (errors) {
   return error
 }
 
+function getTestEnvironmentOptions (config) {
+  if (config.projectConfig && config.projectConfig.testEnvironmentOptions) { // newer versions
+    return config.projectConfig.testEnvironmentOptions
+  }
+  if (config.testEnvironmentOptions) {
+    return config.testEnvironmentOptions
+  }
+  return {}
+}
+
 function getWrappedEnvironment (BaseEnvironment) {
   return class DatadogEnvironment extends BaseEnvironment {
     constructor (config, context) {
@@ -72,6 +88,8 @@ function getWrappedEnvironment (BaseEnvironment) {
       this.testSuite = getTestSuitePath(context.testPath, rootDir)
       this.nameToParams = {}
       this.global._ddtrace = global._ddtrace
+
+      this.testEnvironmentOptions = getTestEnvironmentOptions(config)
     }
 
     async handleTestEvent (event, state) {
@@ -114,10 +132,6 @@ 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'
@@ -163,11 +177,113 @@ addHook({
   versions: ['>=24.8.0']
 }, getTestEnvironment)
 
+function cliWrapper (cli) {
+  const wrapped = shimmer.wrap(cli, 'runCLI', runCLI => async function () {
+    const processArgv = process.argv.slice(2).join(' ')
+    sessionAsyncResource.runInAsyncScope(() => {
+      testSessionStartCh.publish(`jest ${processArgv}`)
+    })
+    return runCLI.apply(this, arguments).then(result => {
+      const { results: { success } } = result
+      sessionAsyncResource.runInAsyncScope(() => {
+        testSessionFinishCh.publish(success ? 'pass' : 'fail')
+      })
+      return result
+    })
+  })
+
+  cli.runCLI = wrapped.runCLI
+
+  return cli
+}
+
 addHook({
-  name: 'jest-jasmine2',
-  versions: ['>=24.8.0'],
-  file: 'build/jasmineAsyncInstall.js'
-}, (jasmineAsyncInstallExport) => {
+  name: '@jest/core',
+  file: 'build/cli/index.js',
+  versions: ['>=24.8.0']
+}, cliWrapper)
+
+function jestAdapterWrapper (jestAdapter) {
+  const adapter = jestAdapter.default ? jestAdapter.default : jestAdapter
+  const newAdapter = shimmer.wrap(adapter, function () {
+    const environment = arguments[2]
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+    return asyncResource.runInAsyncScope(() => {
+      testSuiteStartCh.publish({
+        testSuite: environment.testSuite,
+        testEnvironmentOptions: environment.testEnvironmentOptions
+      })
+      return adapter.apply(this, arguments).then(suiteResults => {
+        const { numFailingTests, skipped, failureMessage: errorMessage } = suiteResults
+        let status = 'pass'
+        if (skipped) {
+          status = 'skipped'
+        } else if (numFailingTests !== 0) {
+          status = 'fail'
+        }
+        testSuiteFinishCh.publish({ status, errorMessage })
+        if (environment.global.__coverage__) {
+          const coverageFiles = extractCoverageInformation(environment.global.__coverage__, environment.rootDir)
+          if (coverageFiles.length) {
+            testSuiteCodeCoverageCh.publish([...coverageFiles, environment.testSuite])
+          }
+        }
+        return suiteResults
+      })
+    })
+  })
+  if (jestAdapter.default) {
+    jestAdapter.default = newAdapter
+  } else {
+    jestAdapter = newAdapter
+  }
+
+  return jestAdapter
+}
+
+addHook({
+  name: 'jest-circus',
+  file: 'build/legacy-code-todo-rewrite/jestAdapter.js',
+  versions: ['>=24.8.0']
+}, jestAdapterWrapper)
+
+function configureTestEnvironment (readConfigsResult) {
+  const { configs } = readConfigsResult
+  sessionAsyncResource.runInAsyncScope(() => {
+    testSessionConfigurationCh.publish(configs.map(config => config.testEnvironmentOptions))
+  })
+}
+
+function jestConfigAsyncWrapper (jestConfig) {
+  shimmer.wrap(jestConfig, 'readConfigs', readConfigs => async function () {
+    const readConfigsResult = await readConfigs.apply(this, arguments)
+    configureTestEnvironment(readConfigsResult)
+    return readConfigsResult
+  })
+  return jestConfig
+}
+
+function jestConfigSyncWrapper (jestConfig) {
+  shimmer.wrap(jestConfig, 'readConfigs', readConfigs => function () {
+    const readConfigsResult = readConfigs.apply(this, arguments)
+    configureTestEnvironment(readConfigsResult)
+    return readConfigsResult
+  })
+  return jestConfig
+}
+
+// from 25.1.0 on, readConfigs becomes async
+addHook({
+  name: 'jest-config',
+  versions: ['>=25.1.0']
+}, jestConfigAsyncWrapper)
+
+addHook({
+  name: 'jest-config',
+  versions: ['24.8.0 - 24.9.0']
+}, jestConfigSyncWrapper)
+
+function jasmineAsyncInstallWraper (jasmineAsyncInstallExport) {
   return function (globalConfig, globalInput) {
     globalInput._ddtrace = global._ddtrace
     shimmer.wrap(globalInput.jasmine.Spec.prototype, 'execute', execute => function (onComplete) {
@@ -194,4 +310,10 @@ addHook({
     })
     return jasmineAsyncInstallExport.default(globalConfig, globalInput)
   }
-})
+}
+
+addHook({
+  name: 'jest-jasmine2',
+  versions: ['>=24.8.0'],
+  file: 'build/jasmineAsyncInstall.js'
+}, jasmineAsyncInstallWraper)

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

@@ -19,7 +19,31 @@ const patched = new WeakSet()
 
 const testToAr = new WeakMap()
 const originalFns = new WeakMap()
-const testSuiteToAr = new WeakMap()
+const testFileToSuiteAr = new Map()
+
+function getSuitesByTestFile (root) {
+  const suitesByTestFile = {}
+  function getSuites (suite) {
+    if (suite.file) {
+      if (suitesByTestFile[suite.file]) {
+        suitesByTestFile[suite.file].push(suite)
+      } else {
+        suitesByTestFile[suite.file] = [suite]
+      }
+    }
+    suite.suites.forEach(suite => {
+      getSuites(suite)
+    })
+  }
+  getSuites(root)
+
+  const numSuitesByTestFile = Object.keys(suitesByTestFile).reduce((acc, testFile) => {
+    acc[testFile] = suitesByTestFile[testFile].length
+    return acc
+  }, {})
+
+  return { suitesByTestFile, numSuitesByTestFile }
+}
 
 function getTestStatus (test) {
   if (test.pending) {
@@ -56,6 +80,8 @@ function mochaHook (Runner) {
       return run.apply(this, arguments)
     }
 
+    const { suitesByTestFile, numSuitesByTestFile } = getSuitesByTestFile(this.suite)
+
     const testRunAsyncResource = new AsyncResource('bound-anonymous-fn')
 
     this.once('end', testRunAsyncResource.bind(function () {
@@ -65,6 +91,7 @@ function mochaHook (Runner) {
       } else if (this.failures !== 0) {
         status = 'fail'
       }
+      testFileToSuiteAr.clear()
       testRunFinishCh.publish(status)
     }))
 
@@ -75,34 +102,45 @@ function mochaHook (Runner) {
     }))
 
     this.on('suite', function (suite) {
-      if (suite.root) {
+      if (suite.root || !suite.tests.length) {
         return
       }
-      const asyncResource = new AsyncResource('bound-anonymous-fn')
-
-      testSuiteToAr.set(suite, asyncResource)
-
-      asyncResource.runInAsyncScope(() => {
-        testSuiteStartCh.publish(suite)
-      })
+      let asyncResource = testFileToSuiteAr.get(suite.file)
+      if (!asyncResource) {
+        asyncResource = new AsyncResource('bound-anonymous-fn')
+        testFileToSuiteAr.set(suite.file, asyncResource)
+        asyncResource.runInAsyncScope(() => {
+          testSuiteStartCh.publish(suite)
+        })
+      }
     })
 
     this.on('suite end', function (suite) {
       if (suite.root) {
         return
       }
+      const suitesInTestFile = suitesByTestFile[suite.file]
+
+      const isLastSuite = --numSuitesByTestFile[suite.file] === 0
+      if (!isLastSuite) {
+        return
+      }
+
       let status = 'pass'
-      if (suite.pending) {
+      if (suitesInTestFile.every(suite => suite.pending)) {
         status = 'skip'
       } else {
-        suite.eachTest(test => {
-          if (test.state === 'failed' || test.timedOut) {
-            status = 'fail'
-          }
+        // has to check every test in the test file
+        suitesInTestFile.forEach(suite => {
+          suite.eachTest(test => {
+            if (test.state === 'failed' || test.timedOut) {
+              status = 'fail'
+            }
+          })
         })
       }
 
-      const asyncResource = testSuiteToAr.get(suite)
+      const asyncResource = testFileToSuiteAr.get(suite.file)
       asyncResource.runInAsyncScope(() => {
         // get suite status
         testSuiteFinishCh.publish(status)
@@ -125,7 +163,7 @@ function mochaHook (Runner) {
       const status = getTestStatus(test)
 
       // if there are afterEach to be run, we don't finish the test yet
-      if (!test.parent._afterEach.length) {
+      if (asyncResource && !test.parent._afterEach.length) {
         asyncResource.runInAsyncScope(() => {
           testFinishCh.publish(status)
         })
@@ -148,34 +186,38 @@ function mochaHook (Runner) {
     })
 
     this.on('fail', (testOrHook, err) => {
+      const testFile = testOrHook.file
       let test = testOrHook
       const isHook = testOrHook.type === 'hook'
       if (isHook && testOrHook.ctx) {
         test = testOrHook.ctx.currentTest
       }
-      let asyncResource
+      let testAsyncResource
       if (test) {
-        asyncResource = getTestAsyncResource(test)
+        testAsyncResource = getTestAsyncResource(test)
       }
-      if (asyncResource) {
-        asyncResource.runInAsyncScope(() => {
+      if (testAsyncResource) {
+        testAsyncResource.runInAsyncScope(() => {
           if (isHook) {
-            err.message = `${testOrHook.title}: ${err.message}`
+            err.message = `${testOrHook.fullTitle()}: ${err.message}`
             errorCh.publish(err)
             // if it's a hook and it has failed, 'test end' will not be called
             testFinishCh.publish('fail')
           } else {
             errorCh.publish(err)
           }
-          // we propagate the error to the suite
-          const testSuiteAsyncResource = testSuiteToAr.get(test.parent)
-          if (testSuiteAsyncResource) {
-            const testSuiteError = new Error(`Test "${test.fullTitle()}" failed with message "${err.message}"`)
-            testSuiteError.stack = err.stack
-            testSuiteAsyncResource.runInAsyncScope(() => {
-              testSuiteErrorCh.publish(testSuiteError)
-            })
-          }
+        })
+      }
+      const testSuiteAsyncResource = testFileToSuiteAr.get(testFile)
+
+      if (testSuiteAsyncResource) {
+        // we propagate the error to the suite
+        const testSuiteError = new Error(
+          `"${testOrHook.parent.fullTitle()}" failed with message "${err.message}"`
+        )
+        testSuiteError.stack = err.stack
+        testSuiteAsyncResource.runInAsyncScope(() => {
+          testSuiteErrorCh.publish(testSuiteError)
         })
       }
     })
@@ -189,7 +231,11 @@ function mochaHook (Runner) {
       } else {
         // if there is no async resource, the test has been skipped through `test.skip``
         const skippedTestAsyncResource = new AsyncResource('bound-anonymous-fn')
-        testToAr.set(test, skippedTestAsyncResource)
+        if (test.fn) {
+          testToAr.set(test.fn, skippedTestAsyncResource)
+        } else {
+          testToAr.set(test, skippedTestAsyncResource)
+        }
         skippedTestAsyncResource.runInAsyncScope(() => {
           skipCh.publish(test)
         })

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

@@ -65,21 +65,25 @@ function wrapFindPageComponents (findPageComponents) {
     const result = findPageComponents.apply(this, arguments)
 
     if (result) {
-      pageLoadChannel.publish({ page: pathname })
+      pageLoadChannel.publish({ page: getPagePath(pathname) })
     }
 
     return result
   }
 }
 
+function getPagePath (page) {
+  return typeof page === 'object' ? page.pathname : page
+}
+
 function getPageFromPath (page, dynamicRoutes = []) {
   for (const dynamicRoute of dynamicRoutes) {
     if (dynamicRoute.page.startsWith('/api') && dynamicRoute.match(page)) {
-      return dynamicRoute.page
+      return getPagePath(dynamicRoute.page)
     }
   }
 
-  return page
+  return getPagePath(page)
 }
 
 function instrument (req, res, handler) {