dd-trace 2.0.0-appsec-beta.3 → 2.0.0

package/MIGRATING.md

@@ -0,0 +1,65 @@
+# Migrating
+
+This guide describes the steps to upgrade dd-trace from a major version to the
+next. If you are having any issues related to migrating, please feel free to
+open an issue or contact our [support](https://www.datadoghq.com/support/) team.
+
+## 1.0 to 2.0
+
+### Configuration
+
+The following configuraton options are no longer available programmatically and
+must be configured using these environment variables:
+
+* `enabled` -> `DD_TRACE_ENABLED=true|false`
+* `debug` -> `DD_TRACE_DEBUG=true|false`
+
+If environment variables were already used for these options, no action is
+needed.
+
+The following configuration options were completely removed and will no longer
+have any effect:
+
+* `scope`
+
+Startup logs are now disabled by default and can be enabled if needed with
+`DD_TRACE_STARTUP_LOGS=true`.
+
+### Removed APIs
+
+The original scope manager has been replaced several years ago and has now been
+removed. Any code referencing `tracer.scopeManager()` should be removed or
+replaced with `tracer.scope()` which is documented
+[here](https://datadoghq.dev/dd-trace-js/#scope-manager).
+
+### Nested objects as tags
+
+Support for nested objects as tags as been removed. When adding an object as a
+tag value, only properties that exist on that object directly will be added as
+tags. If nested properties are also needed, these should be added by hand.
+
+For example:
+
+```js
+const obj = {
+  a: 'foo',
+  b: {
+    c: 'bar'
+  }
+}
+
+// 1.0
+span.setTag('test', obj) // add test.a and test.b.c
+
+// 2.0
+span.setTag('test', obj) // add test.a
+span.setTag('test.b', obj.b) // add test.b.c
+```
+
+Arrays are no longer supported and must be converted to string manually.
+
+### Outgoing request filtering
+
+Outgoing request filtering is no longer supported and is now only available for
+incoming requests. This means that the `blocklist` and `allowlist` options on
+the `http` integration no longer have any effect.

package/NOTICE

@@ -0,0 +1,4 @@
+Datadog dd-trace-js
+Copyright 2016-Present Datadog, Inc.
+
+This product includes software developed at Datadog, Inc. (https://www.datadoghq.com/).

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

@@ -268,8 +268,7 @@ export declare interface TracerOptions {
   version?: string;
 
   /**
-   * Percentage of spans to sample as a float between 0 and 1.
-   * @default 1
+   * Controls the ingestion sample rate (between 0 and 1) between the agent and the backend.
    */
   sampleRate?: number;
 
@@ -358,12 +357,6 @@ export declare interface TracerOptions {
      * @default false
      */
     enableGetRumData?: boolean
-
-    /**
-     * Whether to set the error flag when an error occurs in an internal span.
-     * @default false
-     */
-    internalErrors?: boolean
   };
 
   /**
@@ -476,7 +469,6 @@ interface Plugins {
   "amqp10": plugins.amqp10;
   "amqplib": plugins.amqplib;
   "aws-sdk": plugins.aws_sdk;
-  "bluebird": plugins.bluebird;
   "bunyan": plugins.bunyan;
   "cassandra-driver": plugins.cassandra_driver;
   "connect": plugins.connect;
@@ -504,6 +496,7 @@ interface Plugins {
   "memcached": plugins.memcached;
   "microgateway-core": plugins.microgateway_core;
   "mocha": plugins.mocha;
+  "moleculer": plugins.moleculer;
   "mongodb-core": plugins.mongodb_core;
   "mongoose": plugins.mongoose;
   "mysql": plugins.mysql;
@@ -514,16 +507,12 @@ interface Plugins {
   "paperplane": plugins.paperplane;
   "pg": plugins.pg;
   "pino": plugins.pino;
-  "promise-js": plugins.promise_js;
-  "promise": plugins.promise;
-  "q": plugins.q;
   "redis": plugins.redis;
   "restify": plugins.restify;
   "rhea": plugins.rhea;
   "router": plugins.router;
   "sharedb": plugins.sharedb;
   "tedious": plugins.tedious;
-  "when": plugins.when;
   "winston": plugins.winston;
 }
 
@@ -707,6 +696,16 @@ declare namespace plugins {
     metadata?: string[] | ((variables: { [key: string]: any }) => { [key: string]: any });
   }
 
+  /** @hidden */
+  interface Moleculer extends Instrumentation {
+    /**
+     * Whether to include context meta as tags.
+     *
+     * @default false
+     */
+    meta?: boolean;
+  }
+
   /**
    * This plugin automatically instruments the
    * [amqp10](https://github.com/noodlefrenzy/node-amqp10) module.
@@ -750,12 +749,6 @@ declare namespace plugins {
     [key: string]: boolean | Object | undefined;
   }
 
-  /**
-   * This plugin patches the [bluebird](https://github.com/petkaantonov/bluebird)
-   * module to bind the promise callback the the caller context.
-   */
-  interface bluebird extends Integration {}
-
   /**
    * This plugin patches the [bunyan](https://github.com/trentm/node-bunyan)
    * to automatically inject trace identifiers in log records when the
@@ -786,7 +779,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
@@ -972,12 +965,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.
@@ -1006,12 +999,12 @@ declare namespace plugins {
     /**
      * Configuration for HTTP clients.
      */
-    client?: Http2Client,
+    client?: Http2Client | boolean,
 
     /**
      * Configuration for HTTP servers.
      */
-    server?: Http2Server
+    server?: Http2Server | boolean
   }
 
   /**
@@ -1107,6 +1100,24 @@ declare namespace plugins {
    */
   interface mocha extends Integration {}
 
+  /**
+   * This plugin automatically instruments the
+   * [moleculer](https://moleculer.services/) module.
+   */
+   interface moleculer extends Moleculer {
+    /**
+     * Configuration for Moleculer clients. Set to false to disable client
+     * instrumentation.
+     */
+    client?: boolean | Moleculer;
+
+    /**
+     * Configuration for Moleculer servers. Set to false to disable server
+     * instrumentation.
+     */
+    server?: boolean | Moleculer;
+  }
+
   /**
    * This plugin automatically instruments the
    * [mongodb-core](https://github.com/mongodb-js/mongodb-core) module.
@@ -1189,24 +1200,6 @@ declare namespace plugins {
    */
   interface pino extends Integration {}
 
-  /**
-   * This plugin patches the [promise-js](https://github.com/kevincennis/promise)
-   * module to bind the promise callback the the caller context.
-   */
-  interface promise_js extends Integration {}
-
-  /**
-   * This plugin patches the [promise](https://github.com/then/promise)
-   * module to bind the promise callback the the caller context.
-   */
-  interface promise extends Integration {}
-
-  /**
-   * This plugin patches the [q](https://github.com/kriskowal/q)
-   * module to bind the promise callback the the caller context.
-   */
-  interface q extends Integration {}
-
   /**
    * This plugin automatically instruments the
    * [redis](https://github.com/NodeRedis/node_redis) module.
@@ -1289,12 +1282,6 @@ declare namespace plugins {
    */
   interface tedious extends Instrumentation {}
 
-  /**
-   * This plugin patches the [when](https://github.com/cujojs/when)
-   * module to bind the promise callback the the caller context.
-   */
-  interface when extends Integration {}
-
   /**
    * This plugin patches the [winston](https://github.com/winstonjs/winston)
    * to automatically inject trace identifiers in log records when the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.0.0-appsec-beta.3",
+  "version": "2.0.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",
@@ -18,6 +19,8 @@
     "test": "SERVICES=* yarn services && mocha --exit --expose-gc 'packages/dd-trace/test/setup/node.js' 'packages/*/test/**/*.spec.js'",
     "test:trace:core": "mocha --exit --expose-gc --file packages/dd-trace/test/setup/core.js \"packages/dd-trace/test/**/*.spec.js\"",
     "test:trace:core:ci": "nyc --include \"packages/dd-trace/src/**/*.js\" -- npm run test:trace:core --  --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
+    "test:instrumentations": "mocha --file 'packages/dd-trace/test/setup/core.js' 'packages/datadog-instrumentations/test/**/*.spec.js'",
+    "test:instrumentations:ci": "nyc --include 'packages/datadog-instrumentations/src/**/*.js' -- npm run test:instrumentations -- --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
     "test:core": "mocha --file packages/datadog-core/test/setup.js 'packages/datadog-core/test/**/*.spec.js'",
     "test:core:ci": "nyc --include 'packages/datadog-core/src/**/*.js' -- npm run test:core -- --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
     "test:plugins": "mocha --exit --file \"packages/dd-trace/test/setup/core.js\" \"packages/datadog-plugin-@($(echo $PLUGINS))/test/**/*.spec.js\"",
@@ -58,11 +61,11 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^0.6.1",
-    "@datadog/native-metrics": "^1.0.1",
+    "@datadog/native-appsec": "^0.8.0",
+    "@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",
     "diagnostics_channel": "^1.1.0",
     "form-data": "^3.0.0",

package/packages/datadog-instrumentations/index.js

@@ -0,0 +1,10 @@
+'use strict'
+
+require('./src/dns')
+require('./src/memcached')
+require('./src/mysql')
+require('./src/bluebird')
+require('./src/when')
+require('./src/promise')
+require('./src/q')
+require('./src/promise-js')

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

@@ -0,0 +1,26 @@
+'use strict'
+
+const { addHook } = require('./helpers/instrument')
+const { wrapThen } = require('./helpers/promise')
+const shimmer = require('../../datadog-shimmer')
+
+function createGetNewLibraryCopyWrap (originalLib) {
+  return function wrapGetNewLibraryCopy (getNewLibraryCopy) {
+    return function getNewLibraryCopyWithTrace () {
+      const libraryCopy = getNewLibraryCopy.apply(this, arguments)
+      shimmer.wrap(libraryCopy.prototype, '_then', wrapThen)
+      shimmer.wrap(libraryCopy, 'getNewLibraryCopy', createGetNewLibraryCopyWrap(originalLib))
+      return libraryCopy
+    }
+  }
+}
+
+addHook({ name: 'bluebird', versions: ['>=2.0.2'] }, Promise => {
+  shimmer.wrap(Promise.prototype, '_then', wrapThen)
+  return Promise
+})
+
+addHook({ name: 'bluebird', versions: ['^2.11.0', '^3.4.1'] }, Promise => {
+  shimmer.wrap(Promise, 'getNewLibraryCopy', createGetNewLibraryCopyWrap(Promise))
+  return Promise
+})

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

@@ -0,0 +1,94 @@
+'use strict'
+
+const { channel, addHook, AsyncResource } = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+const rrtypes = {
+  resolveAny: 'ANY',
+  resolve4: 'A',
+  resolve6: 'AAAA',
+  resolveCname: 'CNAME',
+  resolveMx: 'MX',
+  resolveNs: 'NS',
+  resolveTxt: 'TXT',
+  resolveSrv: 'SRV',
+  resolvePtr: 'PTR',
+  resolveNaptr: 'NAPTR',
+  resolveSoa: 'SOA'
+}
+
+const rrtypeMap = new WeakMap()
+
+addHook({ name: 'dns' }, dns => {
+  dns.lookup = wrap('apm:dns:lookup', dns.lookup, 2)
+  dns.lookupService = wrap('apm:dns:lookup_service', dns.lookupService, 3)
+  dns.resolve = wrap('apm:dns:resolve', dns.resolve, 2)
+  dns.reverse = wrap('apm:dns:reverse', dns.reverse, 2)
+
+  patchResolveShorthands(dns)
+
+  if (dns.Resolver) {
+    dns.Resolver.prototype.resolve = wrap('apm:dns:resolve', dns.Resolver.prototype.resolve, 2)
+    dns.Resolver.prototype.reverse = wrap('apm:dns:reverse', dns.Resolver.prototype.reverse, 2)
+
+    patchResolveShorthands(dns.Resolver.prototype)
+  }
+
+  return dns
+})
+
+function patchResolveShorthands (prototype) {
+  Object.keys(rrtypes)
+    .filter(method => !!prototype[method])
+    .forEach(method => {
+      rrtypeMap.set(prototype[method], rrtypes[method])
+      prototype[method] = wrap('apm:dns:resolve', prototype[method], 2, rrtypes[method])
+    })
+}
+
+function wrap (prefix, fn, expectedArgs, rrtype) {
+  const startCh = channel(prefix + ':start')
+  const endCh = channel(prefix + ':end')
+  const asyncEndCh = channel(prefix + ':async-end')
+  const errorCh = channel(prefix + ':error')
+
+  const wrapped = function () {
+    const cb = AsyncResource.bind(arguments[arguments.length - 1])
+    if (
+      !startCh.hasSubscribers ||
+      arguments.length < expectedArgs ||
+      typeof cb !== 'function'
+    ) {
+      return fn.apply(this, arguments)
+    }
+
+    const startArgs = Array.from(arguments)
+    startArgs.pop() // gets rid of the callback
+    if (rrtype) {
+      startArgs.push(rrtype)
+    }
+    startCh.publish(startArgs)
+
+    arguments[arguments.length - 1] = function (error, result) {
+      if (error) {
+        errorCh.publish(error)
+      }
+      asyncEndCh.publish(result)
+      cb.apply(this, arguments)
+    }
+
+    try {
+      return fn.apply(this, arguments)
+      // TODO deal with promise versions when we support `dns/promises`
+    } catch (error) {
+      error.stack // trigger getting the stack at the original throwing point
+      errorCh.publish(error)
+
+      throw error
+    } finally {
+      endCh.publish(undefined)
+    }
+  }
+
+  return shimmer.wrap(fn, wrapped)
+}

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

@@ -0,0 +1,120 @@
+'use strict'
+
+const dc = require('diagnostics_channel')
+const path = require('path')
+const semver = require('semver')
+const iitm = require('../../../dd-trace/src/iitm')
+const ritm = require('../../../dd-trace/src/ritm')
+const parse = require('module-details-from-path')
+const requirePackageJson = require('../../../dd-trace/src/require-package-json')
+const { AsyncResource } = require('async_hooks')
+
+const pathSepExpr = new RegExp(`\\${path.sep}`, 'g')
+const channelMap = {}
+exports.channel = function channel (name) {
+  const maybe = channelMap[name]
+  if (maybe) return maybe
+  const ch = dc.channel(name)
+  channelMap[name] = ch
+  return ch
+}
+
+exports.addHook = function addHook ({ name, versions, file }, hook) {
+  file = filename(name, file)
+  const loaderHook = (moduleExports, moduleName, moduleBaseDir) => {
+    moduleName = moduleName.replace(pathSepExpr, '/')
+    const moduleVersion = getVersion(moduleBaseDir)
+    if (moduleName !== file || !matchVersion(moduleVersion, versions)) {
+      return moduleExports
+    }
+    return hook(moduleExports)
+  }
+  ritm([name], loaderHook)
+  cjsPostLoad({ name, versions, file }, hook)
+  iitm([name], loaderHook)
+}
+
+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('/')
+}
+
+// TODO this is basically Loader#_getModules + running the hook. DRY up.
+function cjsPostLoad (instrumentation, hook) {
+  const ids = Object.keys(require.cache)
+
+  let pkg
+
+  for (let i = 0, l = ids.length; i < l; i++) {
+    if (ids[i] === instrumentation.name) {
+      hook(require.cache[ids[i]].exports)
+      continue
+    }
+
+    const id = ids[i].replace(pathSepExpr, '/')
+
+    if (!id.includes(`/node_modules/${instrumentation.name}/`)) continue
+
+    if (instrumentation.file) {
+      if (!id.endsWith(`/node_modules/${filename(instrumentation)}`)) continue
+
+      const basedir = getBasedir(ids[i])
+
+      pkg = requirePackageJson(basedir, module)
+    } else {
+      const basedir = getBasedir(ids[i])
+
+      pkg = requirePackageJson(basedir, module)
+
+      const mainFile = path.posix.normalize(pkg.main || 'index.js')
+      if (!id.endsWith(`/node_modules/${instrumentation.name}/${mainFile}`)) continue
+    }
+
+    if (!matchVersion(pkg.version, instrumentation.versions)) continue
+
+    hook(require.cache[ids[i]].exports)
+  }
+}
+
+function getBasedir (id) {
+  return parse(id).basedir.replace(pathSepExpr, '/')
+}
+
+if (semver.satisfies(process.versions.node, '>=16.0.0')) {
+  exports.AsyncResource = AsyncResource
+} else {
+  exports.AsyncResource = class extends AsyncResource {
+    static bind (fn, type, thisArg) {
+      type = type || fn.name
+      return (new exports.AsyncResource(type || 'bound-anonymous-fn')).bind(fn, thisArg)
+    }
+
+    bind (fn, thisArg = this) {
+      const ret = this.runInAsyncScope.bind(this, fn, thisArg)
+      Object.defineProperties(ret, {
+        'length': {
+          configurable: true,
+          enumerable: false,
+          value: fn.length,
+          writable: false
+        },
+        'asyncResource': {
+          configurable: true,
+          enumerable: true,
+          value: this,
+          writable: true
+        }
+      })
+      return ret
+    }
+  }
+}

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

@@ -0,0 +1,29 @@
+'use strict'
+
+const { AsyncResource } = require('async_hooks')
+
+exports.wrapThen = function wrapThen (origThen) {
+  return function then (onFulfilled, onRejected, onProgress) {
+    const ar = new AsyncResource('bound-anonymous-fn')
+
+    arguments[0] = wrapCallback(ar, onFulfilled)
+    arguments[1] = wrapCallback(ar, onRejected)
+
+    // not standard but sometimes supported
+    if (onProgress) {
+      arguments[2] = wrapCallback(ar, onProgress)
+    }
+
+    return origThen.apply(this, arguments)
+  }
+}
+
+function wrapCallback (ar, callback) {
+  if (typeof callback !== 'function') return callback
+
+  return function () {
+    return ar.runInAsyncScope(() => {
+      return callback.apply(this, arguments)
+    })
+  }
+}

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

@@ -0,0 +1,53 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+addHook({ name: 'memcached', versions: ['>=2.2'] }, Memcached => {
+  const startCh = channel('apm:memcached:command:start')
+  const startWithArgsCh = channel('apm:memcached:command:start:with-args')
+  const asyncEndCh = channel('apm:memcached:command:async-end')
+  const endCh = channel('apm:memcached:command:end')
+  const errorCh = channel('apm:memcached:command:error')
+
+  shimmer.wrap(Memcached.prototype, 'command', command => function (queryCompiler, server) {
+    if (!startCh.hasSubscribers) {
+      return command.apply(this, arguments)
+    }
+
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+
+    const client = this
+
+    const wrappedQueryCompiler = function () {
+      const query = queryCompiler.apply(this, arguments)
+      const callback = asyncResource.bind(query.callback)
+
+      query.callback = AsyncResource.bind(function (err) {
+        if (err) {
+          errorCh.publish(err)
+        }
+        asyncEndCh.publish(undefined)
+
+        return callback.apply(this, arguments)
+      })
+      startWithArgsCh.publish({ client, server, query })
+
+      return query
+    }
+
+    startCh.publish(undefined)
+
+    arguments[0] = wrappedQueryCompiler
+
+    const result = command.apply(this, arguments)
+    endCh.publish(undefined)
+    return result
+  })
+
+  return Memcached
+})