dd-trace 0.36.1 → 0.36.5

package/LICENSE-3rdparty.csv

@@ -1,7 +1,7 @@
 Component,Origin,License,Copyright
+require,@datadog/sketches-js,Apache license 2.0,Copyright 2020 Datadog Inc.
 require,@types/node,MIT,Copyright Authors
 require,form-data,MIT,Copyright 2012 Felix Geisendörfer and contributors
-require,hdr-histogram-js,BSD-2-Clause,Copyright 2016 Alexandre Victoor
 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
@@ -10,18 +10,16 @@ require,lodash.sortby,MIT,Copyright JS Foundation and other contributors
 require,lodash.uniq,MIT,Copyright JS Foundation and other contributors
 require,methods,MIT,Copyright 2013-2014 TJ Holowaychuk
 require,module-details-from-path,MIT,Copyright 2016 Thomas Watson Steen
-require,msgpack-lite,MIT,Copyright 2015 Yusuke Kawasaki
-require,multer,MIT,Copyright 2014 Hage Yaapa
 require,nan,MIT,Copyright 2018 NAN contributors
 require,node-gyp-build,MIT,Copyright 2017 Mathias Buus
 require,opentracing,MIT,Copyright 2016 Resonance Labs Inc
 require,path-to-regexp,MIT,Copyright 2014 Blake Embrey
 require,performance-now,MIT,Copyright 2013 Braveg1rl
 require,protobufjs,BSD-3-Clause,Copyright 2016 Daniel Wirtz
+require,semver,ISC,Copyright Isaac Z. Schlueter and Contributors
 require,shimmer,BSD-2-Clause,Copyright Forrest L Norvell
 require,source-map,BSD-3-Clause,Copyright 2009-2011 Mozilla Foundation and contributors
 require,source-map-resolve,MIT,Copyright 2014-2020 Simon Lydell 2019 Jinxiang
-require,tar,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,autocannon,MIT,Copyright 2016 Matteo Collina
 dev,axios,MIT,Copyright 2014-present Matt Zabriskie
 dev,benchmark,MIT,Copyright 2010-2016 Mathias Bynens Robert Kieffer John-David Dalton
@@ -48,16 +46,17 @@ dev,int64-buffer,MIT,Copyright 2015-2016 Yusuke Kawasaki
 dev,jszip,MIT,Copyright 2015-2016 Stuart Knightley and contributors
 dev,mkdirp,MIT,Copyright 2010 James Halliday
 dev,mocha,MIT,Copyright 2011-2018 JS Foundation and contributors https://js.foundation
+dev,multer,MIT,Copyright 2014 Hage Yaapa
+dev,msgpack-lite,MIT,Copyright 2015 Yusuke Kawasaki
 dev,nock,MIT,Copyright 2017 Pedro Teixeira and other contributors
 dev,nyc,ISC,Copyright 2015 Contributors
 dev,proxyquire,MIT,Copyright 2013 Thorsten Lorenz
-dev,resolve,MIT,Copyright 2012 James Halliday
 dev,retry,MIT,Copyright 2011 Tim Koschützki Felix Geisendörfer
 dev,rimraf,ISC,Copyright Isaac Z. Schlueter and Contributors
-dev,semver,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,sinon,BSD-3-Clause,Copyright 2010-2017 Christian Johansen
 dev,sinon-chai,WTFPL and BSD-2-Clause,Copyright 2004 Sam Hocevar 2012–2017 Domenic Denicola
 dev,tape,MIT,Copyright James Halliday
+dev,tar,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,wait-on,MIT,Copyright 2015 Jeff Barczewski
 file,profile.proto,Apache license 2.0,Copyright 2016 Google Inc.
 file,TDigest.h,Apache license 2.0,Copyright Derrick R. Burns

package/index.d.ts

@@ -886,6 +886,16 @@ declare namespace plugins {
      */
     depth?: number;
 
+    /**
+     * Whether to include the source of the operation within the query as a tag
+     * on every span. This may contain sensitive information and sould only be
+     * enabled if sensitive data is always sent as variables and not in the
+     * query text.
+     *
+     * @default false
+     */
+    source?: boolean;
+
     /**
      * An array of variable names to record. Can also be a callback that returns
      * the key/value pairs to record. For example, using

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "0.36.1",
+  "version": "0.36.5",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -17,7 +17,7 @@
     "bench:e2e": "SERVICES=mongo yarn services && cd benchmark/e2e && node benchmark-run.js --duration=30",
     "type:doc": "cd docs && yarn && yarn build",
     "type:test": "cd docs && yarn && yarn test",
-    "lint": "node scripts/check_licenses.js && eslint .",
+    "lint": "node scripts/check_licenses.js && eslint . && yarn audit --groups dependencies",
     "services": "node ./scripts/install_plugin_modules && node packages/dd-trace/test/setup/services",
     "tdd": "node scripts/tdd.js",
     "test": "SERVICES=* yarn services && mocha --exit --expose-gc 'packages/dd-trace/test/setup/node.js' 'packages/*/test/**/*.spec.js'",
@@ -55,9 +55,9 @@
     "node": ">=8"
   },
   "dependencies": {
+    "@datadog/sketches-js": "^1.0.4",
     "@types/node": "^10.12.18",
     "form-data": "^3.0.0",
-    "hdr-histogram-js": "^2.0.1",
     "koalas": "^1.0.2",
     "limiter": "^1.1.4",
     "lodash.kebabcase": "^4.1.1",
@@ -66,14 +66,12 @@
     "lodash.uniq": "^4.5.0",
     "methods": "^1.1.2",
     "module-details-from-path": "^1.0.3",
-    "multer": "^1.4.2",
     "nan": "^2.12.1",
     "node-gyp-build": "^3.8.0",
     "opentracing": ">=0.12.1",
     "path-to-regexp": "^0.1.2",
     "performance-now": "^2.1.0",
     "protobufjs": "^6.9.0",
-    "resolve": "^1.20.0",
     "semver": "^5.5.0",
     "shimmer": "1.2.1",
     "source-map": "^0.7.3",
@@ -106,6 +104,7 @@
     "mocha": "^5.2.0",
     "mocha-junit-reporter": "^2.0.0",
     "mocha-multi-reporters": "^1.5.1",
+    "multer": "^1.4.2",
     "msgpack-lite": "^0.1.26",
     "nock": "^11.3.3",
     "nyc": "^14.1.1",

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

@@ -89,11 +89,9 @@ function getHooks (config) {
 
 // TODO: test splitByAwsService when the test suite is fixed
 function getServiceName (serviceIdentifier, tracer, config) {
-  const service = config.service || tracer._service
-
-  return config.splitByAwsService
-    ? `${service}-aws-${serviceIdentifier}`
-    : service
+  return config.service
+    ? config.service
+    : `${tracer._service}-aws-${serviceIdentifier}`
 }
 
 // <2.1.35 has breaking changes for instrumentation

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

@@ -1,5 +1,4 @@
 const { relative } = require('path')
-const resolve = require('resolve')
 
 const { SAMPLING_RULE_DECISION } = require('../../dd-trace/src/constants')
 
@@ -132,7 +131,7 @@ module.exports = [
       const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber')
       const sourceRoot = process.cwd()
       const getTestSuiteName = (pickleUri) => {
-        return relative(sourceRoot, resolve.sync(pickleUri, { basedir: __dirname }))
+        return relative(sourceRoot, pickleUri)
       }
       const pl = TestCaseRunner.default
       this.wrap(

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

@@ -9,6 +9,8 @@ function createWrapRequest (tracer, config) {
     return function requestWithTrace (params, options, cb) {
       if (!params) return request.apply(this, arguments)
 
+      const lastIndex = arguments.length - 1
+      const body = getBody(params.body || params.bulkBody)
       const childOf = tracer.scope().active()
       const span = tracer.startSpan('elasticsearch.query', {
         childOf,
@@ -20,48 +22,39 @@ function createWrapRequest (tracer, config) {
           'span.type': 'elasticsearch',
           'elasticsearch.url': params.path,
           'elasticsearch.method': params.method,
+          'elasticsearch.body': body,
           'elasticsearch.params': JSON.stringify(params.querystring || params.query)
         }
       })
 
-      if (params.body || params.bulkBody) {
-        span.setTag('elasticsearch.body', JSON.stringify(params.body || params.bulkBody))
-      }
-
       analyticsSampler.sample(span, config.analytics)
 
-      cb = request.length === 2 || typeof options === 'function'
-        ? tracer.scope().bind(options, childOf)
-        : tracer.scope().bind(cb, childOf)
-
-      return tracer.scope().activate(span, () => {
-        if (typeof cb === 'function') {
-          if (request.length === 2) {
-            return request.call(this, params, wrapCallback(tracer, span, params, config, cb))
-          } else {
-            return request.call(this, params, options, wrapCallback(tracer, span, params, config, cb))
-          }
-        } else {
-          const promise = request.apply(this, arguments)
+      cb = arguments[lastIndex]
 
-          if (promise && typeof promise.then === 'function') {
-            promise.then(() => finish(span, params, config), e => finish(span, params, config, e))
-          } else {
-            finish(span, params, config)
-          }
+      if (typeof cb === 'function') {
+        arguments[lastIndex] = wrapCallback(tracer, span, params, config, cb)
 
-          return promise
+        return tracer.scope().activate(span, () => request.apply(this, arguments))
+      } else {
+        const promise = request.apply(this, arguments)
+
+        if (promise && typeof promise.then === 'function') {
+          promise.then(() => finish(span, params, config), e => finish(span, params, config, e))
+        } else {
+          finish(span, params, config)
         }
-      })
+
+        return promise
+      }
     }
   }
 }
 
 function wrapCallback (tracer, span, params, config, done) {
-  return function (err) {
+  return tracer.scope().bind(function (err) {
     finish(span, params, config, err)
     done.apply(null, arguments)
-  }
+  })
 }
 
 function finish (span, params, config, err) {
@@ -82,6 +75,10 @@ function quantizePath (path) {
   return path && path.replace(/[0-9]+/g, '?')
 }
 
+function getBody (body) {
+  return body && JSON.stringify(body)
+}
+
 function normalizeConfig (config) {
   const hooks = getHooks(config)
 

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

@@ -17,6 +17,7 @@ function createWrapFastify (tracer, config) {
       if (typeof app.addHook === 'function') {
         app.addHook('onRequest', createOnRequest(tracer, config))
         app.addHook('preHandler', preHandler)
+        app.addHook = createWrapAddHook(tracer, config)(app.addHook)
       }
 
       methods.forEach(method => {
@@ -30,6 +31,51 @@ function createWrapFastify (tracer, config) {
   }
 }
 
+function createWrapAddHook (tracer, config) {
+  return function wrapAddHook (addHook) {
+    return function addHookWithTrace (name, fn) {
+      fn = arguments[arguments.length - 1]
+
+      if (typeof fn !== 'function') return addHook.apply(this, arguments)
+
+      arguments[arguments.length - 1] = safeWrap(fn, function (request, reply, done) {
+        const req = getReq(request)
+
+        if (!req) return fn.apply(this, arguments)
+
+        done = arguments[arguments.length - 1]
+
+        try {
+          if (typeof done === 'function') {
+            arguments[arguments.length - 1] = function (err) {
+              web.addError(req, err)
+              return done.apply(this, arguments)
+            }
+
+            return fn.apply(this, arguments)
+          } else {
+            const promise = fn.apply(this, arguments)
+
+            if (promise && typeof promise.catch === 'function') {
+              return promise.catch(err => {
+                web.addError(req, err)
+                throw err
+              })
+            }
+
+            return promise
+          }
+        } catch (e) {
+          web.addError(req, e)
+          throw e
+        }
+      })
+
+      return addHook.apply(this, arguments)
+    }
+  }
+}
+
 function createOnRequest (tracer, config) {
   return function onRequest (request, reply, next) {
     if (typeof next !== 'function') return
@@ -101,6 +147,13 @@ function wrapHandler (handler) {
   }
 }
 
+// TODO: move this to a common util
+function safeWrap (fn, wrapper) {
+  Object.defineProperty(wrapper, 'length', Object.getOwnPropertyDescriptor(fn, 'length'))
+
+  return wrapper
+}
+
 function getReq (request) {
   return request && (request.raw || request.req || request)
 }

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

@@ -60,7 +60,7 @@ function createWrapParse (tracer, config) {
           document._datadog_source = source.body || source
         }
 
-        addDocumentTags(span, document)
+        addDocumentTags(span, document, config)
 
         return document
       } catch (e) {
@@ -82,7 +82,7 @@ function createWrapValidate (tracer, config) {
 
       // skip for schema stitching nested validation
       if (document && document.loc) {
-        addDocumentTags(span, document)
+        addDocumentTags(span, document, config)
       }
 
       try {
@@ -228,7 +228,7 @@ function startExecutionSpan (tracer, config, operation, args) {
   const span = startSpan(tracer, config, 'execute')
 
   addExecutionTags(span, config, operation, args.document, args.operationName)
-  addDocumentTags(span, args.document)
+  addDocumentTags(span, args.document, config)
   addVariableTags(tracer, config, span, args.variableValues)
 
   analyticsSampler.sample(span, config.analytics)
@@ -255,10 +255,10 @@ function addExecutionTags (span, config, operation, document, operationName) {
   span.addTags(tags)
 }
 
-function addDocumentTags (span, document) {
+function addDocumentTags (span, document, config) {
   const tags = {}
 
-  if (document && document._datadog_source) {
+  if (config.source && document && document._datadog_source) {
     tags['graphql.source'] = document._datadog_source
   }
 
@@ -304,7 +304,7 @@ function startResolveSpan (tracer, config, childOf, path, info, contextValue) {
   })
 
   if (fieldNode) {
-    if (document && fieldNode.loc) {
+    if (config.source && document && fieldNode.loc) {
       span.setTag('graphql.source', document.substring(fieldNode.loc.start, fieldNode.loc.end))
     }
 

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

@@ -84,14 +84,6 @@ function patch (http, methodName, tracer, config) {
 
             scope.bind(res)
 
-            span.setTag(HTTP_STATUS_CODE, res.statusCode)
-
-            addResponseHeaders(res, span, config)
-
-            if (!config.validateStatus(res.statusCode)) {
-              span.setTag('error', 1)
-            }
-
             res.on('end', () => finish(req, res, span, config))
 
             break
@@ -99,7 +91,7 @@ function patch (http, methodName, tracer, config) {
           case 'error':
             addError(span, arg)
           case 'abort': // eslint-disable-line no-fallthrough
-          case 'close': // eslint-disable-line no-fallthrough
+          case 'timeout': // eslint-disable-line no-fallthrough
             finish(req, null, span, config)
         }
 
@@ -113,6 +105,18 @@ function patch (http, methodName, tracer, config) {
   }
 
   function finish (req, res, span, config) {
+    if (res) {
+      span.setTag(HTTP_STATUS_CODE, res.statusCode)
+
+      if (!config.validateStatus(res.statusCode)) {
+        span.setTag('error', 1)
+      }
+
+      addResponseHeaders(res, span, config)
+    } else {
+      span.setTag('error', 1)
+    }
+
     addRequestHeaders(req, span, config)
 
     config.hooks.request(span, req, res)

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

@@ -19,6 +19,13 @@ const {
 } = require('../../dd-trace/src/plugins/util/test')
 const { getFormattedJestTestParameters } = require('./util')
 
+function getVmContext (environment) {
+  if (typeof environment.getVmContext === 'function') {
+    return environment.getVmContext()
+  }
+  return null
+}
+
 function wrapEnvironment (BaseEnvironment) {
   return class DatadogJestEnvironment extends BaseEnvironment {
     constructor (config, context) {
@@ -54,11 +61,15 @@ const isTimeout = (event) => {
 function createHandleTestEvent (tracer, testEnvironmentMetadata, instrumenter) {
   return async function handleTestEventWithTrace (event) {
     if (event.name === 'test_retry') {
-      const context = this.getVmContext()
-      const { currentTestName } = context.expect.getState()
+      let testName = event.test && event.test.name
+      const context = getVmContext(this)
+      if (context) {
+        const { currentTestName } = context.expect.getState()
+        testName = currentTestName
+      }
       // If it's a retry, we restore the original test function so that it is not wrapped again
-      if (this.originalTestFnByTestName[currentTestName]) {
-        event.test.fn = this.originalTestFnByTestName[currentTestName]
+      if (this.originalTestFnByTestName[testName]) {
+        event.test.fn = this.originalTestFnByTestName[testName]
       }
       return
     }
@@ -66,7 +77,7 @@ function createHandleTestEvent (tracer, testEnvironmentMetadata, instrumenter) {
       if (!isTimeout(event)) {
         return
       }
-      const context = this.getVmContext()
+      const context = getVmContext(this)
       if (context) {
         const { currentTestName } = context.expect.getState()
         const testSpan = this.testSpansByTestName[`${currentTestName}_${event.test.invocations}`]
@@ -99,17 +110,25 @@ function createHandleTestEvent (tracer, testEnvironmentMetadata, instrumenter) {
       event.name !== 'hook_failure') {
       return
     }
+    // for hook_failure events the test entry might not be defined, because the hook
+    // is not necessarily associated to a test:
+    if (!event.test) {
+      return
+    }
+
     const childOf = tracer.extract('text_map', {
       'x-datadog-trace-id': id().toString(10),
       'x-datadog-parent-id': '0000000000000000',
       'x-datadog-sampled': 1
     })
     let testName = event.test.name
-    const context = this.getVmContext()
+    const context = getVmContext(this)
+
     if (context) {
       const { currentTestName } = context.expect.getState()
       testName = currentTestName
     }
+
     const commonSpanTags = {
       [TEST_TYPE]: 'test',
       [TEST_NAME]: testName,
@@ -188,7 +207,7 @@ function createHandleTestEvent (tracer, testEnvironmentMetadata, instrumenter) {
           result = await specFunction()
           // it may have been set already if the test timed out
           let suppressedErrors = []
-          const context = environment.getVmContext()
+          const context = getVmContext(environment)
           if (context) {
             suppressedErrors = context.expect.getState().suppressedErrors
           }

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

@@ -79,8 +79,13 @@ function createWrapRunTest (tracer, testEnvironmentMetadata, sourceRoot) {
               activeSpan.setTag(TEST_STATUS, 'fail')
             }
           } catch (error) {
-            activeSpan.setTag(TEST_STATUS, 'fail')
-            activeSpan.setTag('error', error)
+            // this.skip has been called
+            if (error.constructor.name === 'Pending' && !this.forbidPending) {
+              activeSpan.setTag(TEST_STATUS, 'skip')
+            } else {
+              activeSpan.setTag(TEST_STATUS, 'fail')
+              activeSpan.setTag('error', error)
+            }
             throw error
           } finally {
             finishAllTraceSpans(activeSpan)

package/packages/datadog-plugin-mongodb-core/src/unified.js

@@ -2,6 +2,22 @@
 
 const { instrument } = require('./util')
 
+function createWrapConnectionCommand (tracer, config, name) {
+  return function wrapCommand (command) {
+    return function commandWithTrace (ns, ops) {
+      const hostParts = typeof this.address === 'string' ? this.address.split(':') : ''
+      const options = hostParts.length === 2
+        ? { host: hostParts[0], port: hostParts[1] }
+        : {} // no port means the address is a random UUID so no host either
+      const topology = { s: { options } }
+
+      ns = `${ns.db}.${ns.collection}`
+
+      return instrument(command, this, arguments, topology, ns, ops, tracer, config, { name })
+    }
+  }
+}
+
 function createWrapCommand (tracer, config, name) {
   return function wrapCommand (command) {
     return function commandWithTrace (server, ns, ops) {
@@ -30,6 +46,24 @@ function unpatch (wp) {
   this.unwrap(wp, 'killCursors')
 }
 
+function patchConnection ({ Connection }, tracer, config) {
+  const proto = Connection.prototype
+
+  this.wrap(proto, 'command', createWrapConnectionCommand(tracer, config))
+  this.wrap(proto, 'query', createWrapConnectionCommand(tracer, config))
+  this.wrap(proto, 'getMore', createWrapConnectionCommand(tracer, config, 'getMore'))
+  this.wrap(proto, 'killCursors', createWrapConnectionCommand(tracer, config, 'killCursors'))
+}
+
+function unpatchConnection ({ Connection }) {
+  const proto = Connection.prototype
+
+  this.unwrap(proto, 'command')
+  this.unwrap(proto, 'query')
+  this.unwrap(proto, 'getMore')
+  this.unwrap(proto, 'killCursors')
+}
+
 function patchClass (WireProtocol, tracer, config) {
   this.wrap(WireProtocol.prototype, 'command', createWrapCommand(tracer, config))
 }
@@ -41,7 +75,14 @@ function unpatchClass (WireProtocol) {
 module.exports = [
   {
     name: 'mongodb',
-    versions: ['>=3.3'],
+    versions: ['>=4'],
+    file: 'lib/cmap/connection.js',
+    patch: patchConnection,
+    unpatch: unpatchConnection
+  },
+  {
+    name: 'mongodb',
+    versions: ['>=3.3 <4'],
     file: 'lib/core/wireprotocol/index.js',
     patch,
     unpatch