dd-trace 4.0.0 → 4.1.0

package/MIGRATING.md

@@ -4,6 +4,45 @@ 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.
 
+## 3.0 to 4.0
+
+### Node 14 is no longer supported
+
+Node.js 14 has reached EOL in April 2023 and is no longer supported. Generally
+speaking, we highly recommend always keeping Node.js up to date regardless of
+our support policy.
+
+### The `orphanable` option was removed
+
+This option was only useful internally for a single integration that has since
+been removed. It was never useful for manual instrumentation since all that is
+needed to orphan a span on creation is to use
+`tracer.trace('web.request', { childOf: null })`.
+
+### Support for `jest-jasmine2` has been removed
+
+The default test runner for Jest was changed to `jest-circus` around 2 years ago and
+is no longer supported by our Jest integration for CI Visibility. We recommend
+switching to `jest-circus` to anyone still using `jest-jasmine2`.
+
+### Support for older Next.js versions was removed
+
+We now support only Next.js 10.2 and up.
+
+### W3C headers are now prioritized over Datadog headers
+
+As we move towards open standards, we have decided to prioritize W3C Trace
+Context headers over our own vendor-specific headers for context propagation
+across services. For most applications this shouldn't change anything and
+distributed tracing should continue to work seamlessly.
+
+In some rare cases it's possible that some of the services involved in a trace
+are not instrumented by Datadog at all which can cause spans within the trace to
+become disconnected. While the data would still be available in the UI, the
+relationship between spans would no longer be visible. This can be addressed by
+restoring the previous behaviour using
+`DD_TRACE_PROPAGATION_STYLE='datadog,tracecontext'`.
+
 ## 2.0 to 3.0
 
 ### Node 12 is no longer supported

package/README.md

@@ -1,6 +1,7 @@
 # `dd-trace`: Node.js APM Tracer Library
 
-[![npm v3](https://img.shields.io/npm/v/dd-trace/latest?color=blue&label=dd-trace%40v3&logo=npm)](https://www.npmjs.com/package/dd-trace)
+[![npm v4](https://img.shields.io/npm/v/dd-trace/latest?color=blue&label=dd-trace%40v4&logo=npm)](https://www.npmjs.com/package/dd-trace)
+[![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=blue&label=dd-trace%40v3&logo=npm)](https://www.npmjs.com/package/dd-trace/v/latest-node12)
 [![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=blue&label=dd-trace%40v2&logo=npm)](https://www.npmjs.com/package/dd-trace/v/latest-node12)
 [![npm dev](https://img.shields.io/npm/v/dd-trace/dev?color=orange&label=dd-trace%40dev&logo=npm)](https://www.npmjs.com/package/dd-trace/v/dev)
 [![codecov](https://codecov.io/gh/DataDog/dd-trace-js/branch/master/graph/badge.svg)](https://codecov.io/gh/DataDog/dd-trace-js)
@@ -28,27 +29,28 @@ Most of the documentation for `dd-trace` is available on these webpages:
 | :---:                                                    | :---:                                                                                                  | :---:    | :---:           | :---:          | :---:       |
 | [`v1`](https://github.com/DataDog/dd-trace-js/tree/v1.x) | ![npm v1](https://img.shields.io/npm/v/dd-trace/legacy-v1?color=white&label=%20&style=flat-square)     | `>= v12` | **End of Life** | 2021-07-13     | 2022-02-25  |
 | [`v2`](https://github.com/DataDog/dd-trace-js/tree/v2.x) | ![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=white&label=%20&style=flat-square) | `>= v12` | **Maintenance** | 2022-01-28     | 2023-08-15  |
-| [`v3`](https://github.com/DataDog/dd-trace-js/tree/v3.x) | ![npm v3](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square)        | `>= v14` | **Current**     | 2022-08-15     | Unknown     |
+| [`v3`](https://github.com/DataDog/dd-trace-js/tree/v3.x) | ![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=white&label=%20&style=flat-square) | `>= v14` | **Maintenance** | 2022-08-15     | 2024-05-15  |
+| [`v4`](https://github.com/DataDog/dd-trace-js/tree/v4.x) | ![npm v4](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square)        | `>= v16` | **Current**     | 2023-05-12     | Unknown     |
 
-We currently maintain two release lines, namely `v2` and `v3`.
-Features and bug fixes that are merged are released to the `v3` line and, if appropriate, also the `v2` line.
+We currently maintain three release lines, namely `v2`, `v3` and `v4`.
+Features and bug fixes that are merged are released to the `v4` line and, if appropriate, also the `v2` and `v3` line.
 
-For any new projects it is recommended to use the `v3` release line:
+For any new projects it is recommended to use the `v4` release line:
 
 ```sh
 $ npm install dd-trace
 $ yarn add dd-trace
 ```
 
-However, existing projects that already use the `v2` release line, or projects that need to support Node.js v12, may use the `v2` release line.
+However, existing projects that already use the `v2` or `v3` release lines, or projects that need to support EOL versions of Node.js, may continue to use these release lines.
 This is done by specifying the version when installing the package.
-Note that we also publish to npm using a `latest-node12` tag that can also be used for install:
+Note that we also publish to npm using a `latest-node12` and `latest-node14` tag that can also be used for install:
 
 ```sh
-$ npm install dd-trace@2
-$ yarn add dd-trace@2
-$ npm install dd-trace@latest-node12
-$ yarn add dd-trace@latest-node12
+$ npm install dd-trace@3
+$ yarn add dd-trace@3
+$ npm install dd-trace@latest-node14
+$ yarn add dd-trace@latest-node14
 ```
 
 Any backwards-breaking functionality that is introduced into the library will result in an increase of the major version of the library and therefore a new release line.
@@ -153,6 +155,11 @@ $ yarn lint
 
 ### Experimental ESM Support
 
+> **Warning**
+> 
+> ESM support has been temporarily disabled starting from Node 20 as significant
+> changes are in progress.
+
 ESM support is currently in the experimental stages, while CJS has been supported
 since inception. This means that code loaded using `require()` should work fine
 but code loaded using `import` might not always work.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -66,7 +66,7 @@
     "node": ">=16"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^3.1.0",
+    "@datadog/native-appsec": "^3.2.0",
     "@datadog/native-iast-rewriter": "2.0.1",
     "@datadog/native-iast-taint-tracking": "^1.4.1",
     "@datadog/native-metrics": "^2.0.0",

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

@@ -3,6 +3,7 @@ const { createCoverageMap } = require('istanbul-lib-coverage')
 
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
+const log = require('../../dd-trace/src/log')
 
 const testStartCh = channel('ci:cucumber:test:start')
 const testFinishCh = channel('ci:cucumber:test:finish') // used for test steps too
@@ -175,6 +176,12 @@ function wrapRun (pl, isLatestVersion) {
 }
 
 function pickleHook (PickleRunner) {
+  if (process.env.CUCUMBER_WORKER_ID) {
+    // Parallel mode is not supported
+    log.warn('Unable to initialize CI Visibility because Cucumber is running in parallel mode.')
+    return PickleRunner
+  }
+
   const pl = PickleRunner.default
 
   wrapRun(pl, false)
@@ -183,6 +190,12 @@ function pickleHook (PickleRunner) {
 }
 
 function testCaseHook (TestCaseRunner) {
+  if (process.env.CUCUMBER_WORKER_ID) {
+    // Parallel mode is not supported
+    log.warn('Unable to initialize CI Visibility because Cucumber is running in parallel mode.')
+    return TestCaseRunner
+  }
+
   const pl = TestCaseRunner.default
 
   wrapRun(pl, true)

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

@@ -80,6 +80,7 @@ module.exports = {
   'rhea': () => require('../rhea'),
   'router': () => require('../router'),
   'sharedb': () => require('../sharedb'),
+  'sequelize': () => require('../sequelize'),
   'tedious': () => require('../tedious'),
   'when': () => require('../when'),
   'winston': () => require('../winston')

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

@@ -101,6 +101,7 @@ function patch (http, methodName) {
   }
 
   function normalizeArgs (inputURL, inputOptions, cb) {
+    const originalUrl = inputURL
     inputURL = normalizeOptions(inputURL)
 
     const [callback, inputOptionsNormalized] = normalizeCallback(inputOptions, cb, inputURL)
@@ -108,7 +109,7 @@ function patch (http, methodName) {
     normalizeHeaders(options)
     const uri = url.format(options)
 
-    return { uri, options, callback }
+    return { uri, options, callback, originalUrl }
   }
 
   function combineOptions (inputURL, inputOptions) {

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

@@ -11,6 +11,7 @@ const startServerCh = channel('apm:http:server:request:start')
 const exitServerCh = channel('apm:http:server:request:exit')
 const errorServerCh = channel('apm:http:server:request:error')
 const finishServerCh = channel('apm:http:server:request:finish')
+const finishSetHeaderCh = channel('datadog:http:server:response:set-header:finish')
 
 const requestFinishedSet = new WeakSet()
 
@@ -58,6 +59,9 @@ function wrapEmit (emit) {
           // TODO: should this always return true ?
           return this.listenerCount(eventName) > 0
         }
+        if (finishSetHeaderCh.hasSubscribers) {
+          wrapSetHeader(res)
+        }
         return emit.apply(this, arguments)
       } catch (err) {
         errorServerCh.publish(err)
@@ -70,3 +74,13 @@ function wrapEmit (emit) {
     return emit.apply(this, arguments)
   }
 }
+
+function wrapSetHeader (res) {
+  shimmer.wrap(res, 'setHeader', setHeader => {
+    return function (name, value) {
+      const setHeaderResult = setHeader.apply(this, arguments)
+      finishSetHeaderCh.publish({ name, value, res })
+      return setHeaderResult
+    }
+  })
+}

package/packages/datadog-instrumentations/src/http2/client.js

@@ -3,6 +3,7 @@
 const shimmer = require('../../../datadog-shimmer')
 const { addHook, channel, AsyncResource } = require('../helpers/instrument')
 
+const connectChannel = channel('apm:http2:client:connect:start')
 const startChannel = channel('apm:http2:client:request:start')
 const finishChannel = channel('apm:http2:client:request:finish')
 const errorChannel = channel('apm:http2:client:request:error')
@@ -52,6 +53,9 @@ function createWrapRequest (authority, options) {
 
 function wrapConnect (connect) {
   return function (authority, options) {
+    if (connectChannel.hasSubscribers) {
+      connectChannel.publish({ authority })
+    }
     const session = connect.apply(this, arguments)
 
     shimmer.wrap(session, 'request', createWrapRequest(authority, options))

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

@@ -1,10 +1,8 @@
 'use strict'
-const semver = require('semver')
 
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 const log = require('../../dd-trace/src/log')
-const { version: ddTraceVersion } = require('../../../package.json')
 const {
   getCoveredFilenamesFromCoverage,
   JEST_WORKER_TRACE_PAYLOAD_CODE,
@@ -18,6 +16,7 @@ const {
   getJestTestName,
   getJestSuitesToRun
 } = require('../../datadog-plugin-jest/src/util')
+const { DD_MAJOR } = require('../../../version')
 
 const testSessionStartCh = channel('ci:jest:session:start')
 const testSessionFinishCh = channel('ci:jest:session:finish')
@@ -481,7 +480,7 @@ function jasmineAsyncInstallWraper (jasmineAsyncInstallExport, jestVersion) {
   }
 }
 
-if (semver.lt(ddTraceVersion, '4.0.0')) {
+if (DD_MAJOR < 4) {
   addHook({
     name: 'jest-jasmine2',
     versions: ['>=24.8.0'],

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

@@ -4,7 +4,7 @@
 
 const { channel, addHook, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
-const { MAJOR } = require('../../../version')
+const { DD_MAJOR } = require('../../../version')
 
 const startChannel = channel('apm:next:request:start')
 const finishChannel = channel('apm:next:request:finish')
@@ -171,7 +171,7 @@ addHook({ name: 'next', versions: ['>=11.1 <13.2'], file: 'dist/server/next-serv
 
 addHook({
   name: 'next',
-  versions: MAJOR >= 4 ? ['>=10.2 <11.1'] : ['>=9.5 <11.1'],
+  versions: DD_MAJOR >= 4 ? ['>=10.2 <11.1'] : ['>=9.5 <11.1'],
   file: 'dist/next-server/server/next-server.js'
 }, nextServer => {
   const Server = nextServer.default

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

@@ -248,7 +248,7 @@ function runnerHook (runnerExport, playwrightVersion) {
 addHook({
   name: '@playwright/test',
   file: 'lib/runner.js',
-  versions: ['>=1.18.0 <1.30.0']
+  versions: ['>=1.18.0 <=1.30.0']
 }, runnerHook)
 
 addHook({

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

@@ -0,0 +1,51 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+
+const shimmer = require('../../datadog-shimmer')
+
+addHook({ name: 'sequelize', versions: ['>=4'] }, Sequelize => {
+  const startCh = channel('datadog:sequelize:query:start')
+  const finishCh = channel('datadog:sequelize:query:finish')
+
+  shimmer.wrap(Sequelize.prototype, 'query', query => {
+    return function (sql) {
+      if (!startCh.hasSubscribers) {
+        return query.apply(this, arguments)
+      }
+
+      const asyncResource = new AsyncResource('bound-anonymous-fn')
+
+      let dialect
+      if (this.options && this.options.dialect) {
+        dialect = this.options.dialect
+      } else if (this.dialect && this.dialect.name) {
+        dialect = this.dialect.name
+      }
+
+      function onFinish () {
+        asyncResource.bind(function () {
+          finishCh.publish()
+        }, this).apply(this)
+      }
+
+      return asyncResource.bind(function () {
+        startCh.publish({
+          sql,
+          dialect
+        })
+
+        const promise = query.apply(this, arguments)
+        promise.then(onFinish, onFinish)
+
+        return promise
+      }, this).apply(this, arguments)
+    }
+  })
+
+  return Sequelize
+})

package/packages/datadog-plugin-amqp10/src/consumer.js

@@ -11,11 +11,9 @@ class Amqp10ConsumerPlugin extends ConsumerPlugin {
     const source = getShortName(link)
     const address = getAddress(link)
 
-    this.startSpan('amqp.receive', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    this.startSpan({
       resource: ['receive', source].filter(v => v).join(' '),
       type: 'worker',
-      kind: 'consumer',
       meta: {
         'amqp.link.source.address': source,
         'amqp.link.role': 'receiver',

package/packages/datadog-plugin-amqp10/src/producer.js

@@ -13,10 +13,8 @@ class Amqp10ProducerPlugin extends ProducerPlugin {
     const address = getAddress(link)
     const target = getShortName(link)
 
-    this.startSpan('amqp.send', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    this.startSpan({
       resource: ['send', target].filter(v => v).join(' '),
-      kind: 'producer',
       meta: {
         'amqp.link.target.address': target,
         'amqp.link.role': 'sender',

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

@@ -7,6 +7,7 @@ const { getResourceName } = require('./util')
 
 class AmqplibClientPlugin extends ClientPlugin {
   static get id () { return 'amqplib' }
+  static get type () { return 'messaging' }
   static get operation () { return 'command' }
 
   start ({ channel = {}, method, fields }) {
@@ -14,10 +15,10 @@ class AmqplibClientPlugin extends ClientPlugin {
     if (method === 'basic.publish') return
 
     const stream = (channel.connection && channel.connection.stream) || {}
-    const span = this.startSpan('amqp.command', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    const span = this.startSpan(this.operationName(), {
+      service: this.config.service || this.serviceName(),
       resource: getResourceName(method, fields),
-      kind: 'client',
+      kind: this.constructor.kind,
       meta: {
         'out.host': stream._host,
         [CLIENT_PORT_KEY]: stream.remotePort,

package/packages/datadog-plugin-amqplib/src/consumer.js

@@ -13,11 +13,9 @@ class AmqplibConsumerPlugin extends ConsumerPlugin {
 
     const childOf = extract(this.tracer, message)
 
-    this.startSpan('amqp.command', {
+    this.startSpan({
       childOf,
-      service: this.config.service || `${this.tracer._service}-amqp`,
       resource: getResourceName(method, fields),
-      kind: 'consumer',
       type: 'worker',
       meta: {
         'amqp.queue': fields.queue,

package/packages/datadog-plugin-amqplib/src/producer.js

@@ -13,10 +13,8 @@ class AmqplibProducerPlugin extends ProducerPlugin {
     if (method !== 'basic.publish') return
 
     const stream = (channel.connection && channel.connection.stream) || {}
-    const span = this.startSpan('amqp.command', {
-      service: this.config.service || `${this.tracer._service}-amqp`,
+    const span = this.startSpan({
       resource: getResourceName(method, fields),
-      kind: 'producer',
       meta: {
         'out.host': stream._host,
         [CLIENT_PORT_KEY]: stream.remotePort,

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

@@ -73,8 +73,8 @@ class CucumberPlugin extends CiPlugin {
         .map(filename => getTestSuitePath(filename, this.sourceRoot))
 
       const formattedCoverage = {
-        traceId: this.testSuiteSpan.context()._traceId,
-        spanId: this.testSuiteSpan.context()._spanId,
+        sessionId: this.testSuiteSpan.context()._traceId,
+        suiteId: this.testSuiteSpan.context()._spanId,
         files: relativeCoverageFiles
       }