dd-trace 4.12.0 → 4.13.0

package/README.md

@@ -2,8 +2,6 @@
 
 [![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)
 
 <img align="right" src="https://user-images.githubusercontent.com/551402/208212084-1d0c07e2-4135-4c61-b2da-8f2fddbc66ed.png" alt="Bits the dog  JavaScript" width="200px"/>
@@ -28,12 +26,12 @@ Most of the documentation for `dd-trace` is available on these webpages:
 | Release Line                                             | Latest Version                                                                                         | Node.js  | Status          |Initial Release | End of Life |
 | :---:                                                    | :---:                                                                                                  | :---:    | :---:           | :---:          | :---:       |
 | [`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  |
+| [`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` | **End of Life** | 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-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 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.
+We currently maintain two release lines, namely `v3` and `v4`.
+Features and bug fixes that are merged are released to the `v4` line and, if appropriate, also the `v3` line.
 
 For any new projects it is recommended to use the `v4` release line:
 
@@ -42,15 +40,12 @@ $ npm install dd-trace
 $ yarn add dd-trace
 ```
 
-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.
+However, existing projects that already use the `v3` release line, 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` and `latest-node14` tag that can also be used for install:
 
 ```sh
 $ 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "4.12.0",
+  "version": "4.13.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -71,7 +71,7 @@
     "@datadog/native-iast-rewriter": "2.0.1",
     "@datadog/native-iast-taint-tracking": "1.5.0",
     "@datadog/native-metrics": "^2.0.0",
-    "@datadog/pprof": "3.1.0",
+    "@datadog/pprof": "3.2.0",
     "@datadog/sketches-js": "^2.1.0",
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/core": "^1.14.0",

package/packages/datadog-esbuild/index.js

@@ -53,10 +53,25 @@ module.exports.setup = function (build) {
   const externalModules = new Set(build.initialOptions.external || [])
   build.onResolve({ filter: /.*/ }, args => {
     if (externalModules.has(args.path)) {
+      // Internal Node.js packages will still be instrumented via require()
       if (DEBUG) console.log(`EXTERNAL: ${args.path}`)
       return
     }
 
+    // TODO: Should this also check for namespace === 'file'?
+    if (args.path.startsWith('.') && !args.importer.includes('node_modules/')) {
+      // This is local application code, not an instrumented package
+      if (DEBUG) console.log(`LOCAL: ${args.path}`)
+      return
+    }
+
+    // TODO: Should this also check for namespace === 'file'?
+    if (args.path.startsWith('@') && !args.importer.includes('node_modules/')) {
+      // This is the Next.js convention for loading local files
+      if (DEBUG) console.log(`@LOCAL: ${args.path}`)
+      return
+    }
+
     let fullPathToModule
     try {
       fullPathToModule = dotFriendlyResolve(args.path, args.resolveDir)
@@ -65,12 +80,11 @@ module.exports.setup = function (build) {
       return
     }
     const extracted = extractPackageAndModulePath(fullPathToModule)
-    const packageName = args.path
 
     const internal = builtins.has(args.path)
 
     if (args.namespace === 'file' && (
-      modulesOfInterest.has(packageName) || modulesOfInterest.has(`${extracted.pkg}/${extracted.path}`))
+      modulesOfInterest.has(args.path) || modulesOfInterest.has(`${extracted.pkg}/${extracted.path}`))
     ) {
       // The file namespace is used when requiring files from disk in userland
 
@@ -90,7 +104,7 @@ module.exports.setup = function (build) {
 
       const packageJson = require(pathToPackageJson)
 
-      if (DEBUG) console.log(`RESOLVE: ${packageName}@${packageJson.version}`)
+      if (DEBUG) console.log(`RESOLVE: ${args.path}@${packageJson.version}`)
 
       // https://esbuild.github.io/plugins/#on-resolve-arguments
       return {
@@ -101,17 +115,17 @@ module.exports.setup = function (build) {
           pkg: extracted.pkg,
           path: extracted.path,
           full: fullPathToModule,
-          raw: packageName,
+          raw: args.path,
           internal
         }
       }
     } else if (args.namespace === NAMESPACE) {
       // The datadog namespace is used when requiring files that are injected during the onLoad stage
 
-      if (builtins.has(packageName)) return
+      if (builtins.has(args.path)) return
 
       return {
-        path: require.resolve(packageName, { paths: [ args.resolveDir ] }),
+        path: require.resolve(args.path, { paths: [ args.resolveDir ] }),
         namespace: 'file'
       }
     }

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

@@ -12,6 +12,7 @@ const errorChannel = channel('apm:next:request:error')
 const pageLoadChannel = channel('apm:next:page:load')
 
 const requests = new WeakSet()
+const requestToNextjsPagePath = new WeakMap()
 
 function wrapHandleRequest (handleRequest) {
   return function (req, res, pathname, query) {
@@ -132,6 +133,57 @@ function instrument (req, res, handler) {
   })
 }
 
+function wrapSetupServerWorker (setupServerWorker) {
+  return function (requestHandler) {
+    arguments[0] = shimmer.wrap(requestHandler, wrapRequestHandler(requestHandler))
+    return setupServerWorker.apply(this, arguments)
+  }
+}
+
+function wrapInitialize (initialize) {
+  return async function () {
+    const result = await initialize.apply(this, arguments)
+    if (Array.isArray(result)) {
+      const requestHandler = result[0]
+      result[0] = shimmer.wrap(requestHandler, wrapRequestHandler(requestHandler))
+    }
+    return result
+  }
+}
+
+function wrapRequestHandler (requestHandler) {
+  return function (req, res) {
+    return instrument(req, res, async () => {
+      const result = await requestHandler.apply(this, arguments) // apply here first to get page path association
+
+      const page = requestToNextjsPagePath.get(req)
+      if (page && pageLoadChannel.hasSubscribers) pageLoadChannel.publish({ page })
+
+      return result
+    })
+  }
+}
+
+// these two functions make sure we get path groups for routes in standalone,
+// as it doesn't route through `next-server`/`base-server`
+function wrapGetResolveRoutes (getResolveRoutes) {
+  return function () {
+    const result = getResolveRoutes.apply(this, arguments)
+    return shimmer.wrap(result, wrapResolveRoutes(result))
+  }
+}
+
+function wrapResolveRoutes (resolveRoutes) {
+  return async function (req) {
+    const result = await resolveRoutes.apply(this, arguments)
+    if (result && result.matchedOutput) {
+      const path = result.matchedOutput.itemPath
+      requestToNextjsPagePath.set(req, path)
+    }
+    return result
+  }
+}
+
 function finish (ctx, result, err) {
   if (err) {
     ctx.error = err
@@ -147,11 +199,27 @@ function finish (ctx, result, err) {
   return result
 }
 
+addHook({
+  name: 'next',
+  versions: ['>=13.4.13'],
+  file: 'dist/server/lib/router-utils/resolve-routes.js'
+}, resolveRoutesModule => shimmer.wrap(resolveRoutesModule, 'getResolveRoutes', wrapGetResolveRoutes))
+
+addHook({
+  name: 'next',
+  versions: ['13.4.13'],
+  file: 'dist/server/lib/setup-server-worker.js'
+}, setupServerWorker => shimmer.wrap(setupServerWorker, 'initializeServerWorker', wrapSetupServerWorker))
+
+addHook({
+  name: 'next',
+  versions: ['>=13.4.15'],
+  file: 'dist/server/lib/router-server.js'
+}, routerServer => shimmer.wrap(routerServer, 'initialize', wrapInitialize))
+
 addHook({ name: 'next', versions: ['>=13.2'], file: 'dist/server/next-server.js' }, nextServer => {
   const Server = nextServer.default
 
-  shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)
-  shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequestWithMatch)
   shimmer.wrap(Server.prototype, 'renderToResponse', wrapRenderToResponse)
   shimmer.wrap(Server.prototype, 'renderErrorToResponse', wrapRenderErrorToResponse)
   shimmer.wrap(Server.prototype, 'findPageComponents', wrapFindPageComponents)
@@ -159,6 +227,22 @@ addHook({ name: 'next', versions: ['>=13.2'], file: 'dist/server/next-server.js'
   return nextServer
 })
 
+// these functions wrapped in all versions above 13.2 except:
+// 13.4.13 due to tests failing when these functions are wrapped
+// 13.4.14 due to it not being in the NPM registry/officially released
+addHook({
+  name: 'next',
+  versions: ['>=13.2 <13.4.13', '>=13.4.15'],
+  file: 'dist/server/next-server.js'
+}, nextServer => {
+  const Server = nextServer.default
+
+  shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)
+  shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequestWithMatch)
+
+  return nextServer
+})
+
 addHook({ name: 'next', versions: ['>=11.1 <13.2'], file: 'dist/server/next-server.js' }, nextServer => {
   const Server = nextServer.default
 

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

@@ -10,7 +10,7 @@ const startCh = channel('apm:openai:request:start')
 const finishCh = channel('apm:openai:request:finish')
 const errorCh = channel('apm:openai:request:error')
 
-addHook({ name: 'openai', file: 'dist/api.js', versions: ['>=3.0.0'] }, exports => {
+addHook({ name: 'openai', file: 'dist/api.js', versions: ['>=3.0.0 <4'] }, exports => {
   const methodNames = Object.getOwnPropertyNames(exports.OpenAIApi.prototype)
   methodNames.shift() // remove leading 'constructor' method
 

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

@@ -56,9 +56,9 @@ function getVariablesFilter (config) {
 
 function getHooks (config) {
   const noop = () => { }
-  const execute = (config.hooks && config.hooks.execute) || noop
-  const parse = (config.hooks && config.hooks.parse) || noop
-  const validate = (config.hooks && config.hooks.validate) || noop
+  const execute = config.hooks?.execute || noop
+  const parse = config.hooks?.parse || noop
+  const validate = config.hooks?.validate || noop
 
   return { execute, parse, validate }
 }

package/packages/dd-trace/src/exporters/common/request.js

@@ -42,10 +42,19 @@ function urlToOptions (url) {
   return options
 }
 
-function fromUrlString (url) {
-  return typeof urlToHttpOptions === 'function'
-    ? urlToOptions(new URL(url))
-    : urlParse(url)
+function fromUrlString (urlString) {
+  const url = typeof urlToHttpOptions === 'function'
+    ? urlToOptions(new URL(urlString))
+    : urlParse(urlString)
+
+  // Add the 'hostname' back if we're using named pipes
+  if (url.protocol === 'unix:' && url.host === '.') {
+    const udsPath = urlString.replace(/^unix:/, '')
+    url.path = udsPath
+    url.pathname = udsPath
+  }
+
+  return url
 }
 
 function request (data, options, callback) {

package/packages/dd-trace/src/profiling/config.js

@@ -31,6 +31,7 @@ class Config {
       DD_PROFILING_UPLOAD_PERIOD,
       DD_PROFILING_PPROF_PREFIX,
       DD_PROFILING_HEAP_ENABLED,
+      DD_PROFILING_V8_PROFILER_BUG_WORKAROUND,
       DD_PROFILING_WALLTIME_ENABLED,
       DD_PROFILING_EXPERIMENTAL_OOM_MONITORING_ENABLED,
       DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE,
@@ -76,7 +77,8 @@ class Config {
     this.debugSourceMaps = isTrue(coalesce(options.debugSourceMaps, DD_PROFILING_DEBUG_SOURCE_MAPS, false))
     this.endpointCollectionEnabled = endpointCollectionEnabled
     this.pprofPrefix = pprofPrefix
-
+    this.v8ProfilerBugWorkaroundEnabled = isTrue(coalesce(options.v8ProfilerBugWorkaround,
+      DD_PROFILING_V8_PROFILER_BUG_WORKAROUND, true))
     const hostname = coalesce(options.hostname, DD_AGENT_HOST) || 'localhost'
     const port = coalesce(options.port, DD_TRACE_AGENT_PORT) || 8126
     this.url = new URL(coalesce(options.url, DD_TRACE_AGENT_URL, format({

package/packages/dd-trace/src/profiling/profilers/wall.js

@@ -5,6 +5,7 @@ const { storage } = require('../../../../datadog-core')
 const dc = require('../../../../diagnostics_channel')
 const { HTTP_METHOD, HTTP_ROUTE, RESOURCE_NAME, SPAN_TYPE } = require('../../../../../ext/tags')
 const { WEB } = require('../../../../../ext/types')
+const runtimeMetrics = require('../../runtime_metrics')
 
 const beforeCh = dc.channel('dd-trace:storage:before')
 const enterCh = dc.channel('dd-trace:storage:enter')
@@ -83,6 +84,7 @@ class NativeWallProfiler {
     this._flushIntervalMillis = options.flushInterval || 60 * 1e3 // 60 seconds
     this._codeHotspotsEnabled = !!options.codeHotspotsEnabled
     this._endpointCollectionEnabled = !!options.endpointCollectionEnabled
+    this._v8ProfilerBugWorkaroundEnabled = !!options.v8ProfilerBugWorkaroundEnabled
     this._mapper = undefined
     this._pprof = undefined
 
@@ -122,7 +124,8 @@ class NativeWallProfiler {
       durationMillis: this._flushIntervalMillis,
       sourceMapper: this._mapper,
       withContexts: this._codeHotspotsEnabled,
-      lineNumbers: false
+      lineNumbers: false,
+      workaroundV8Bug: this._v8ProfilerBugWorkaroundEnabled
     })
 
     if (this._codeHotspotsEnabled) {
@@ -172,7 +175,18 @@ class NativeWallProfiler {
       this._enter()
       this._lastSampleCount = 0
     }
-    return this._pprof.time.stop(restart, this._codeHotspotsEnabled ? generateLabels : undefined)
+    const profile = this._pprof.time.stop(restart, this._codeHotspotsEnabled ? generateLabels : undefined)
+    if (restart) {
+      const v8BugDetected = this._pprof.time.v8ProfilerStuckEventLoopDetected()
+      if (v8BugDetected === 1) {
+        this._logger?.warn('Wall profiler: possible v8 profiler stuck event loop detected.')
+        runtimeMetrics.increment('runtime.node.profiler.v8_cpu_profiler_maybe_stuck_event_loop', undefined, true)
+      } else if (v8BugDetected === 2) {
+        this._logger?.warn('Wall profiler: v8 profiler stuck event loop detected.')
+        runtimeMetrics.increment('runtime.node.profiler.v8_cpu_profiler_stuck_event_loop', undefined, true)
+      }
+    }
+    return profile
   }
 
   profile () {