dd-trace 1.5.0 → 1.7.0

package/ci/cypress/plugin.js

@@ -0,0 +1,3 @@
+require('../init')
+
+module.exports = require('../../packages/datadog-plugin-cypress/src/plugin')

package/ci/cypress/support.js

@@ -0,0 +1 @@
+require('../../packages/datadog-plugin-cypress/src/support')

package/ci/init.js

@@ -0,0 +1,13 @@
+const tracer = require('../packages/dd-trace')
+const { ORIGIN_KEY } = require('../packages/dd-trace/src/constants')
+
+tracer.init({
+  startupLogs: false,
+  tags: {
+    [ORIGIN_KEY]: 'ciapp-test'
+  }
+})
+
+tracer.use('fs', false)
+
+module.exports = tracer

package/ci/jest/env.js

@@ -0,0 +1,14 @@
+const tracer = require('../../packages/dd-trace')
+const { ORIGIN_KEY } = require('../../packages/dd-trace/src/constants')
+
+tracer.init({
+  startupLogs: false,
+  flushInterval: 400000,
+  tags: {
+    [ORIGIN_KEY]: 'ciapp-test'
+  }
+})
+
+tracer.use('fs', false)
+
+module.exports = tracer

package/index.d.ts

@@ -792,7 +792,7 @@ declare namespace plugins {
    * This plugin automatically instruments the
    * [cucumber](https://www.npmjs.com/package/@cucumber/cucumber) module.
    */
-  interface cucumber extends Instrumentation {}
+  interface cucumber extends Integration {}
 
   /**
    * This plugin automatically instruments the
@@ -978,12 +978,12 @@ declare namespace plugins {
     /**
      * Configuration for HTTP clients.
      */
-    client?: HttpClient,
+    client?: HttpClient | boolean,
 
     /**
      * Configuration for HTTP servers.
      */
-    server?: HttpServer
+    server?: HttpServer | boolean
 
     /**
      * Hooks to run before spans are finished.
@@ -1012,12 +1012,12 @@ declare namespace plugins {
     /**
      * Configuration for HTTP clients.
      */
-    client?: Http2Client,
+    client?: Http2Client | boolean,
 
     /**
      * Configuration for HTTP servers.
      */
-    server?: Http2Server
+    server?: Http2Server | boolean
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -10,6 +10,7 @@
     "bench": "node benchmark",
     "bench:profiler": "node benchmark/profiler",
     "bench:e2e": "SERVICES=mongo yarn services && cd benchmark/e2e && node benchmark-run.js --duration=30",
+    "bench:e2e:ci-visibility": "node benchmark/e2e-ci/benchmark-run.js",
     "type:doc": "cd docs && yarn && yarn build",
     "type:test": "cd docs && yarn && yarn test",
     "lint": "node scripts/check_licenses.js && eslint . && yarn audit --groups dependencies",
@@ -56,13 +57,13 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@datadog/native-metrics": "^1.0.0",
-    "@datadog/pprof": "^0.1.3",
+    "@datadog/native-metrics": "^1.1.0",
+    "@datadog/pprof": "^0.3.0",
     "@datadog/sketches-js": "^1.0.4",
-    "@types/node": "^10.12.18",
+    "@types/node": ">=12",
     "crypto-randomuuid": "^1.0.0",
     "form-data": "^3.0.0",
-    "import-in-the-middle": "^1.1.1",
+    "import-in-the-middle": "^1.1.2",
     "koalas": "^1.0.2",
     "limiter": "^1.1.4",
     "lodash.kebabcase": "^4.1.1",

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

@@ -5,6 +5,7 @@ const {
   TEST_NAME,
   TEST_SUITE,
   TEST_STATUS,
+  TEST_FRAMEWORK_VERSION,
   TEST_SKIP_REASON,
   CI_APP_ORIGIN,
   ERROR_MESSAGE,
@@ -52,6 +53,7 @@ function createWrapRun (tracer, testEnvironmentMetadata, sourceRoot, setStatus)
         [TEST_NAME]: testName,
         [TEST_SUITE]: testSuite,
         [SAMPLING_RULE_DECISION]: 1,
+        [TEST_FRAMEWORK_VERSION]: tracer._version,
         ...testEnvironmentMetadata
       }
 
@@ -101,8 +103,8 @@ module.exports = [
     name: '@cucumber/cucumber',
     versions: ['7.0.0 - 7.2.1'],
     file: 'lib/runtime/pickle_runner.js',
-    patch (PickleRunner, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber')
+    patch (PickleRunner, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber', config)
       const sourceRoot = process.cwd()
       const pl = PickleRunner.default
       this.wrap(
@@ -125,8 +127,8 @@ module.exports = [
     name: '@cucumber/cucumber',
     versions: ['>=7.3.0'],
     file: 'lib/runtime/test_case_runner.js',
-    patch (TestCaseRunner, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber')
+    patch (TestCaseRunner, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber', config)
       const sourceRoot = process.cwd()
       const pl = TestCaseRunner.default
       this.wrap(

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

@@ -3,6 +3,8 @@ const {
   TEST_NAME,
   TEST_SUITE,
   TEST_STATUS,
+  TEST_FRAMEWORK_VERSION,
+  TEST_IS_RUM_ACTIVE,
   getTestEnvironmentMetadata,
   CI_APP_ORIGIN,
   getTestParentSpan
@@ -19,7 +21,7 @@ const CYPRESS_STATUS_TO_TEST_STATUS = {
   skipped: 'skip'
 }
 
-function getTestSpanMetadata (tracer, testName, testSuite) {
+function getTestSpanMetadata (tracer, testName, testSuite, cypressConfig) {
   const childOf = getTestParentSpan(tracer)
 
   return {
@@ -29,7 +31,8 @@ function getTestSpanMetadata (tracer, testName, testSuite) {
     [TEST_NAME]: testName,
     [TEST_SUITE]: testSuite,
     [SAMPLING_RULE_DECISION]: 1,
-    [SAMPLING_PRIORITY]: AUTO_KEEP
+    [SAMPLING_PRIORITY]: AUTO_KEEP,
+    [TEST_FRAMEWORK_VERSION]: cypressConfig.version
   }
 }
 
@@ -50,7 +53,7 @@ module.exports = (on, config) => {
         childOf,
         resource,
         ...testSpanMetadata
-      } = getTestSpanMetadata(tracer, testName, testSuite)
+      } = getTestSpanMetadata(tracer, testName, testSuite, config)
 
       if (!activeSpan) {
         activeSpan = tracer.startSpan('cypress.test', {
@@ -64,19 +67,28 @@ module.exports = (on, config) => {
           }
         })
       }
-      return null
+      return activeSpan ? activeSpan._spanContext._traceId.toString(10) : null
     },
     'dd:afterEach': (test) => {
-      const { state, error } = test
+      const { state, error, isRUMActive } = test
       if (activeSpan) {
         activeSpan.setTag(TEST_STATUS, CYPRESS_STATUS_TO_TEST_STATUS[state])
         if (error) {
           activeSpan.setTag('error', error)
         }
+        if (isRUMActive) {
+          activeSpan.setTag(TEST_IS_RUM_ACTIVE, true)
+        }
         activeSpan.finish()
       }
       activeSpan = null
       return null
+    },
+    'dd:addTags': (tags) => {
+      if (activeSpan) {
+        activeSpan.addTags(tags)
+      }
+      return null
     }
   })
 }

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

@@ -3,15 +3,30 @@ beforeEach(() => {
   cy.task('dd:beforeEach', {
     testName: Cypress.mocha.getRunner().suite.ctx.currentTest.fullTitle(),
     testSuite: Cypress.mocha.getRootSuite().file
+  }).then(traceId => {
+    Cypress.env('traceId', traceId)
   })
 })
 
+after(() => {
+  cy.window().then(win => {
+    win.dispatchEvent(new Event('beforeunload'))
+  })
+})
+
+
 afterEach(() => {
-  const currentTest = Cypress.mocha.getRunner().suite.ctx.currentTest
-  cy.task('dd:afterEach', {
-    testName: currentTest.fullTitle(),
-    testSuite: Cypress.mocha.getRootSuite().file,
-    state: currentTest.state,
-    error: currentTest.err
+  cy.window().then(win => {
+    const currentTest = Cypress.mocha.getRunner().suite.ctx.currentTest
+    const testInfo = {
+      testName: currentTest.fullTitle(),
+      testSuite: Cypress.mocha.getRootSuite().file,
+      state: currentTest.state,
+      error: currentTest.err,
+    }
+    if (win.DD_RUM) {
+      testInfo.isRUMActive = true
+    }
+    cy.task('dd:afterEach', testInfo)
   })
 })

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

@@ -9,20 +9,17 @@ let tools
 function createWrapExecute (tracer, config, defaultFieldResolver) {
   return function wrapExecute (execute) {
     return function executeWithTrace () {
-      const args = normalizeArgs(arguments)
+      const args = normalizeArgs(arguments, tracer, config, defaultFieldResolver)
       const schema = args.schema
       const document = args.document
       const source = document && document._datadog_source
-      const fieldResolver = args.fieldResolver || defaultFieldResolver
-      const contextValue = args.contextValue = args.contextValue || {}
+      const contextValue = args.contextValue
       const operation = getOperation(document, args.operationName)
 
       if (contextValue._datadog_graphql) {
         return execute.apply(this, arguments)
       }
 
-      args.fieldResolver = wrapResolve(fieldResolver, tracer, config)
-
       if (schema) {
         wrapFields(schema._queryType, tracer, config)
         wrapFields(schema._mutationType, tracer, config)
@@ -32,7 +29,7 @@ function createWrapExecute (tracer, config, defaultFieldResolver) {
 
       contextValue._datadog_graphql = { source, span, fields: {} }
 
-      return call(execute, span, this, [args], (err, res) => {
+      return call(execute, span, this, arguments, (err, res) => {
         finishResolvers(contextValue, config)
 
         setError(span, err || (res && res.errors && res.errors[0]))
@@ -212,10 +209,19 @@ function getField (contextValue, path) {
   return contextValue._datadog_graphql.fields[path.join('.')]
 }
 
-function normalizeArgs (args) {
-  if (args.length === 1) {
-    return args[0]
-  }
+function normalizeArgs (args, tracer, config, defaultFieldResolver) {
+  if (args.length !== 1) return normalizePositional(args, tracer, config, defaultFieldResolver)
+
+  args[0].contextValue = args[0].contextValue || {}
+  args[0].fieldResolver = wrapResolve(args[0].fieldResolver || defaultFieldResolver, tracer, config)
+
+  return args[0]
+}
+
+function normalizePositional (args, tracer, config, defaultFieldResolver) {
+  args[3] = args[3] || {} // contextValue
+  args[6] = wrapResolve(args[6] || defaultFieldResolver, tracer, config) // fieldResolver
+  args.length = Math.max(args.length, 7)
 
   return {
     schema: args[0],

package/packages/datadog-plugin-grpc/src/client.js

@@ -48,7 +48,7 @@ function createWrapMakeClientConstructor (tracer, config) {
 function wrapPackageDefinition (tracer, config, def) {
   for (const name in def) {
     if (def[name].format) continue
-    if (def[name].service) {
+    if (def[name].service && def[name].prototype) {
       wrapClientConstructor(tracer, config, def[name], def[name].service)
     } else {
       wrapPackageDefinition(tracer, config, def[name])

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

@@ -5,6 +5,8 @@ const {
   TEST_NAME,
   TEST_SUITE,
   TEST_STATUS,
+  TEST_FRAMEWORK_VERSION,
+  JEST_TEST_RUNNER,
   ERROR_MESSAGE,
   ERROR_TYPE,
   TEST_PARAMETERS,
@@ -138,7 +140,9 @@ function createHandleTestEvent (tracer, testEnvironmentMetadata, instrumenter) {
     const spanTags = {
       ...commonSpanTags,
       [TEST_NAME]: testName,
-      [TEST_SUITE]: this.testSuite
+      [TEST_SUITE]: this.testSuite,
+      [TEST_FRAMEWORK_VERSION]: tracer._version,
+      [JEST_TEST_RUNNER]: 'jest-circus'
     }
 
     const testParametersString = getTestParametersString(nameToParams, event.test.name)
@@ -234,8 +238,8 @@ module.exports = [
   {
     name: 'jest-environment-node',
     versions: ['>=24.8.0'],
-    patch: function (NodeEnvironment, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest')
+    patch: function (NodeEnvironment, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest', config)
 
       this.wrap(NodeEnvironment.prototype, 'teardown', createWrapTeardown(tracer, this))
 
@@ -253,8 +257,8 @@ module.exports = [
   {
     name: 'jest-environment-jsdom',
     versions: ['>=24.8.0'],
-    patch: function (JsdomEnvironment, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest')
+    patch: function (JsdomEnvironment, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest', config)
 
       this.wrap(JsdomEnvironment.prototype, 'teardown', createWrapTeardown(tracer, this))
 

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

@@ -5,6 +5,8 @@ const {
   TEST_NAME,
   TEST_SUITE,
   TEST_STATUS,
+  TEST_FRAMEWORK_VERSION,
+  JEST_TEST_RUNNER,
   CI_APP_ORIGIN,
   getTestEnvironmentMetadata,
   finishAllTraceSpans,
@@ -29,7 +31,12 @@ function createWrapIt (tracer, globalConfig, globalInput, testEnvironmentMetadat
         {
           type: 'test',
           childOf,
-          tags: { ...commonSpanTags, [TEST_SUITE]: testSuite }
+          tags: {
+            ...commonSpanTags,
+            [TEST_SUITE]: testSuite,
+            [TEST_FRAMEWORK_VERSION]: tracer._version,
+            [JEST_TEST_RUNNER]: 'jest-jasmine2'
+          }
         },
         async (done) => {
           const testSpan = tracer.scope().active()
@@ -124,7 +131,9 @@ function createWrapItSkip (tracer, globalConfig, globalInput, testEnvironmentMet
             [RESOURCE_NAME]: resource,
             [TEST_NAME]: testName,
             [TEST_SUITE]: testSuite,
-            [TEST_STATUS]: 'skip'
+            [TEST_STATUS]: 'skip',
+            [TEST_FRAMEWORK_VERSION]: tracer._version,
+            [JEST_TEST_RUNNER]: 'jest-jasmine2'
           }
         }
       )
@@ -160,8 +169,8 @@ module.exports = [
     name: 'jest-jasmine2',
     versions: ['>=24.8.0'],
     file: 'build/jasmineAsyncInstall.js',
-    patch: function (jasmineAsyncInstallExport, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest')
+    patch: function (jasmineAsyncInstallExport, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest', config)
       return this.wrapExport(
         jasmineAsyncInstallExport.default,
         createWrapJasmineAsyncInstall(tracer, this, testEnvironmentMetadata)(jasmineAsyncInstallExport.default)

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

@@ -9,6 +9,7 @@ const {
   TEST_SUITE,
   TEST_STATUS,
   TEST_PARAMETERS,
+  TEST_FRAMEWORK_VERSION,
   CI_APP_ORIGIN,
   getTestEnvironmentMetadata,
   getTestParametersString,
@@ -31,13 +32,20 @@ function getTestSpanMetadata (tracer, test, sourceRoot) {
     [TEST_NAME]: fullTestName,
     [TEST_SUITE]: testSuite,
     [SAMPLING_RULE_DECISION]: 1,
-    [SAMPLING_PRIORITY]: AUTO_KEEP
+    [SAMPLING_PRIORITY]: AUTO_KEEP,
+    [TEST_FRAMEWORK_VERSION]: tracer._version
   }
 }
 
 function createWrapRunTest (tracer, testEnvironmentMetadata, sourceRoot) {
   return function wrapRunTest (runTest) {
     return async function runTestWithTrace () {
+      // `runTest` is rerun when retries are configured through `this.retries` and the test fails.
+      // This clause prevents rewrapping `this.test.fn` when it has already been wrapped.
+      if (this.test._currentRetry !== undefined && this.test._currentRetry !== 0) {
+        return runTest.apply(this, arguments)
+      }
+
       let specFunction = this.test.fn
       if (specFunction.length) {
         specFunction = promisify(specFunction)
@@ -114,6 +122,7 @@ function getAllTestsInSuite (root) {
 function createWrapRunTests (tracer, testEnvironmentMetadata, sourceRoot) {
   return function wrapRunTests (runTests) {
     return function runTestsWithTrace () {
+      this.once('end', () => tracer._exporter._writer.flush())
       runTests.apply(this, arguments)
       const suite = arguments[0]
       const tests = getAllTestsInSuite(suite)
@@ -231,8 +240,8 @@ module.exports = [
     name: 'mocha',
     versions: ['>=5.2.0'],
     file: 'lib/runner.js',
-    patch (Runner, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('mocha')
+    patch (Runner, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('mocha', config)
       const sourceRoot = process.cwd()
       this.wrap(Runner.prototype, 'runTests', createWrapRunTests(tracer, testEnvironmentMetadata, sourceRoot))
       this.wrap(Runner.prototype, 'runTest', createWrapRunTest(tracer, testEnvironmentMetadata, sourceRoot))

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

@@ -1,7 +1,25 @@
 'use strict'
 
+// TODO: always use uppercase for command names
+
 const tx = require('../../dd-trace/src/plugins/util/redis')
 
+function createWrapAddCommand (tracer, config) {
+  return function wrapAddCommand (addCommand) {
+    return function addCommandWithTrace (command) {
+      const name = command[0]
+      const args = command.slice(1)
+
+      if (!config.filter(name)) return addCommand.apply(this, arguments)
+
+      const scope = tracer.scope()
+      const span = startSpan(tracer, config, this, name, args)
+
+      return tx.wrap(span, scope.bind(addCommand, span).apply(this, arguments))
+    }
+  }
+}
+
 function createWrapInternalSendCommand (tracer, config) {
   return function wrapInternalSendCommand (internalSendCommand) {
     return function internalSendCommandWithTrace (options) {
@@ -49,9 +67,21 @@ function startSpan (tracer, config, client, command, args) {
 }
 
 module.exports = [
+  {
+    name: '@node-redis/client',
+    versions: ['>=1'],
+    file: 'dist/lib/client/commands-queue.js',
+    patch (redis, tracer, config) {
+      config = tx.normalizeConfig(config)
+      this.wrap(redis.default.prototype, 'addCommand', createWrapAddCommand(tracer, config))
+    },
+    unpatch (redis) {
+      this.unwrap(redis.default.prototype, 'addCommand')
+    }
+  },
   {
     name: 'redis',
-    versions: ['>=2.6'],
+    versions: ['>=2.6 <4'],
     patch (redis, tracer, config) {
       config = tx.normalizeConfig(config)
       this.wrap(redis.RedisClient.prototype, 'internal_send_command', createWrapInternalSendCommand(tracer, config))

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

@@ -1 +1 @@
-module.exports = '1.5.0'
+module.exports = '1.7.0'

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

@@ -10,5 +10,10 @@ module.exports = {
   SAMPLING_RULE_DECISION: '_dd.rule_psr',
   SAMPLING_LIMIT_DECISION: '_dd.limit_psr',
   SAMPLING_AGENT_DECISION: '_dd.agent_psr',
-  DATADOG_LAMBDA_EXTENSION_PATH: '/opt/extensions/datadog-agent'
+  SAMPLING_MECHANISM_DEFAULT: 0,
+  SAMPLING_MECHANISM_AGENT: 1,
+  SAMPLING_MECHANISM_RULE: 3,
+  SAMPLING_MECHANISM_MANUAL: 4,
+  DATADOG_LAMBDA_EXTENSION_PATH: '/opt/extensions/datadog-agent',
+  UPSTREAM_SERVICES_KEY: '_dd.p.upstream_services'
 }