dd-trace 4.17.0 → 4.19.0

package/LICENSE-3rdparty.csv

@@ -8,7 +8,7 @@ require,@datadog/sketches-js,Apache license 2.0,Copyright 2020 Datadog Inc.
 require,@opentelemetry/api,Apache license 2.0,Copyright OpenTelemetry Authors
 require,@opentelemetry/core,Apache license 2.0,Copyright OpenTelemetry Authors
 require,crypto-randomuuid,MIT,Copyright 2021 Node.js Foundation and contributors
-require,diagnostics_channel,MIT,Copyright 2021 Simon D.
+require,dc-polyfill,MIT,Copyright 2023 Datadog Inc.
 require,ignore,MIT,Copyright 2013 Kael Zhang and contributors
 require,import-in-the-middle,Apache license 2.0,Copyright 2021 Datadog Inc.
 require,int64-buffer,MIT,Copyright 2015-2016 Yusuke Kawasaki
@@ -28,6 +28,7 @@ require,msgpack-lite,MIT,Copyright 2015 Yusuke Kawasaki
 require,node-abort-controller,MIT,Copyright (c) 2019 Steve Faulkner
 require,opentracing,MIT,Copyright 2016 Resonance Labs Inc
 require,path-to-regexp,MIT,Copyright 2014 Blake Embrey
+require,pprof-format,MIT,Copyright 2022 Stephen Belanger
 require,protobufjs,BSD-3-Clause,Copyright 2016 Daniel Wirtz
 require,retry,MIT,Copyright 2011 Tim Koschützki Felix Geisendörfer
 require,semver,ISC,Copyright Isaac Z. Schlueter and Contributors
@@ -62,7 +63,6 @@ dev,mocha,MIT,Copyright 2011-2018 JS Foundation and contributors https://js.foun
 dev,multer,MIT,Copyright 2014 Hage Yaapa
 dev,nock,MIT,Copyright 2017 Pedro Teixeira and other contributors
 dev,nyc,ISC,Copyright 2015 Contributors
-dev,pprof-format,MIT,Copyright 2022 Stephen Belanger
 dev,proxyquire,MIT,Copyright 2013 Thorsten Lorenz
 dev,rimraf,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,sinon,BSD-3-Clause,Copyright 2010-2017 Christian Johansen

package/README.md

@@ -202,11 +202,11 @@ To get around this, one can treat all third party modules, or at least third par
 
 For these reasons it's necessary to have custom-built bundler plugins. Such plugins are able to instruct the bundler on how to behave, injecting intermediary code and otherwise intercepting the "translated" `require()` calls. The result is that many more packages are then included in the bundled JavaScript file. Some applications can have 100% of modules bundled, however native modules still need to remain external to the bundle.
 
-### Esbuild Support
+### ESBuild Support
 
-This library provides experimental esbuild support in the form of an esbuild plugin, and currently requires at least Node.js v16.17 or v18.7. To use the plugin, make sure you have `dd-trace@3+` installed, and then require the `dd-trace/esbuild` module when building your bundle.
+This library provides experimental ESBuild support in the form of an ESBuild plugin. Require the `dd-trace/esbuild` module when building your bundle to enable the plugin.
 
-Here's an example of how one might use `dd-trace` with esbuild:
+Here's an example of how one might use `dd-trace` with ESBuild:
 
 ```javascript
 const ddPlugin = require('dd-trace/esbuild')

package/ext/kinds.d.ts

@@ -3,6 +3,7 @@ declare const kinds: {
   CLIENT: 'client'
   PRODUCER: 'producer'
   CONSUMER: 'consumer'
+  INTERNAL: 'internal'
 }
 
 export = kinds

package/ext/kinds.js

@@ -4,5 +4,6 @@ module.exports = {
   SERVER: 'server',
   CLIENT: 'client',
   PRODUCER: 'producer',
-  CONSUMER: 'consumer'
+  CONSUMER: 'consumer',
+  INTERNAL: 'internal'
 }

package/ext/tags.d.ts

@@ -17,7 +17,8 @@ declare const tags: {
   HTTP_REQUEST_HEADERS: 'http.request.headers'
   HTTP_RESPONSE_HEADERS: 'http.response.headers'
   HTTP_USERAGENT: 'http.useragent',
-  HTTP_CLIENT_IP: 'http.client_ip'
+  HTTP_CLIENT_IP: 'http.client_ip',
+  PATHWAY_HASH: 'pathway.hash'
 }
 
 export = tags

package/ext/tags.js

@@ -22,7 +22,12 @@ const tags = {
   HTTP_REQUEST_HEADERS: 'http.request.headers',
   HTTP_RESPONSE_HEADERS: 'http.response.headers',
   HTTP_USERAGENT: 'http.useragent',
-  HTTP_CLIENT_IP: 'http.client_ip'
+  HTTP_CLIENT_IP: 'http.client_ip',
+
+  // Messaging
+
+  // DSM Specific
+  PATHWAY_HASH: 'pathway.hash'
 }
 
 // Deprecated

package/index.d.ts

@@ -453,7 +453,15 @@ export declare interface TracerOptions {
        * Whether to enable vulnerability redaction
        * @default true
        */
-      redactionEnabled?: boolean
+      redactionEnabled?: boolean,
+      /**
+       * Specifies a regex that will redact sensitive source names in vulnerability reports.
+       */
+      redactionNamePattern?: string,
+      /**
+       * Specifies a regex that will redact sensitive source values in vulnerability reports.
+       */
+      redactionValuePattern?: string
     }
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "4.17.0",
+  "version": "4.19.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -19,7 +19,7 @@
     "test:appsec:ci": "nyc --no-clean --include \"packages/dd-trace/src/appsec/**/*.js\" --exclude \"packages/dd-trace/test/appsec/**/*.plugin.spec.js\" -- npm run test:appsec",
     "test:appsec:plugins": "mocha --colors --exit -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/dd-trace/test/appsec/**/*.@($(echo $PLUGINS)).plugin.spec.js\"",
     "test:appsec:plugins:ci": "yarn services && nyc --no-clean --include \"packages/dd-trace/src/appsec/**/*.js\" -- npm run test:appsec:plugins",
-    "test:trace:core": "tap packages/dd-trace/test/*.spec.js \"packages/dd-trace/test/{ci-visibility,encode,exporters,opentelemetry,opentracing,plugins,service-naming,telemetry}/**/*.spec.js\"",
+    "test:trace:core": "tap packages/dd-trace/test/*.spec.js \"packages/dd-trace/test/{ci-visibility,datastreams,encode,exporters,opentelemetry,opentracing,plugins,service-naming,telemetry}/**/*.spec.js\"",
     "test:trace:core:ci": "npm run test:trace:core -- --coverage --nyc-arg=--include=\"packages/dd-trace/src/**/*.js\"",
     "test:instrumentations": "mocha --colors -r 'packages/dd-trace/test/setup/mocha.js' 'packages/datadog-instrumentations/test/**/*.spec.js'",
     "test:instrumentations:ci": "nyc --no-clean --include 'packages/datadog-instrumentations/src/**/*.js' -- npm run test:instrumentations",
@@ -68,16 +68,16 @@
     "node": ">=16"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^4.0.0",
-    "@datadog/native-iast-rewriter": "2.1.3",
-    "@datadog/native-iast-taint-tracking": "1.6.1",
+    "@datadog/native-appsec": "4.0.0",
+    "@datadog/native-iast-rewriter": "2.2.1",
+    "@datadog/native-iast-taint-tracking": "1.6.4",
     "@datadog/native-metrics": "^2.0.0",
-    "@datadog/pprof": "4.0.0",
+    "@datadog/pprof": "4.0.1",
     "@datadog/sketches-js": "^2.1.0",
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/core": "^1.14.0",
     "crypto-randomuuid": "^1.0.0",
-    "diagnostics_channel": "^1.1.0",
+    "dc-polyfill": "^0.1.2",
     "ignore": "^5.2.4",
     "import-in-the-middle": "^1.4.2",
     "int64-buffer": "^0.1.9",
@@ -97,6 +97,7 @@
     "node-abort-controller": "^3.1.1",
     "opentracing": ">=0.12.1",
     "path-to-regexp": "^0.1.2",
+    "pprof-format": "^2.0.7", 
     "protobufjs": "^7.2.4",
     "retry": "^0.13.1",
     "semver": "^7.5.4"
@@ -133,7 +134,6 @@
     "multer": "^1.4.5-lts.1",
     "nock": "^11.3.3",
     "nyc": "^15.1.0",
-    "pprof-format": "^2.0.7",
     "proxyquire": "^1.8.0",
     "rimraf": "^3.0.0",
     "sinon": "^15.2.0",

package/packages/datadog-core/src/storage/async_resource.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { createHook, executionAsyncResource } = require('async_hooks')
-const { channel } = require('../../../diagnostics_channel')
+const { channel } = require('dc-polyfill')
 
 const beforeCh = channel('dd-trace:storage:before')
 const afterCh = channel('dd-trace:storage:after')

package/packages/datadog-esbuild/index.js

@@ -5,8 +5,6 @@
 const instrumentations = require('../datadog-instrumentations/src/helpers/instrumentations.js')
 const hooks = require('../datadog-instrumentations/src/helpers/hooks.js')
 
-warnIfUnsupported()
-
 for (const hook of Object.values(hooks)) {
   hook()
 }
@@ -144,7 +142,7 @@ module.exports.setup = function (build) {
         ${fileCode}
       })(...arguments);
       {
-        const dc = require('diagnostics_channel');
+        const dc = require('dc-polyfill');
         const ch = dc.channel('${CHANNEL}');
         const mod = module.exports
         const payload = {
@@ -167,23 +165,6 @@ module.exports.setup = function (build) {
   })
 }
 
-// Currently esbuild support requires Node.js >=v16.17 or >=v18.7
-// Better yet it would support Node >=v14.17 or >=v16
-// Of course, the most ideal would be to support all versions of Node that dd-trace supports.
-// Version constraints based on Node's diagnostics_channel support
-function warnIfUnsupported () {
-  const [major, minor] = process.versions.node.split('.').map(Number)
-  if (
-    major < 16 ||
-    (major === 16 && minor < 17) ||
-    (major === 18 && minor < 7)) {
-    console.error('WARNING: Esbuild support isn\'t available for older versions of Node.js.')
-    console.error(`Expected: Node.js >=v16.17 or >=v18.7. Actual: Node.js = ${process.version}.`)
-    console.error('This application may build properly with this version of Node.js, but unless a')
-    console.error('more recent version is used at runtime, third party packages won\'t be instrumented.')
-  }
-}
-
 // @see https://github.com/nodejs/node/issues/47000
 function dotFriendlyResolve (path, directory) {
   if (path === '.') {

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

@@ -296,6 +296,11 @@ addHook({
       const filteredPickles = getFilteredPickles(this, skippableSuites)
       const { picklesToRun } = filteredPickles
       isSuitesSkipped = picklesToRun.length !== this.pickleIds.length
+
+      log.debug(
+        () => `${picklesToRun.length} out of ${this.pickleIds.length} suites are going to run.`
+      )
+
       this.pickleIds = picklesToRun
 
       skippedSuites = Array.from(filteredPickles.skippedSuites)

package/packages/datadog-instrumentations/src/helpers/bundler-register.js

@@ -1,7 +1,6 @@
 'use strict'
 
-// eslint-disable-next-line n/no-restricted-require
-const dc = require('diagnostics_channel')
+const dc = require('dc-polyfill')
 
 const {
   filename,

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const dc = require('../../../diagnostics_channel')
+const dc = require('dc-polyfill')
 const semver = require('semver')
 const instrumentations = require('./instrumentations')
 const { AsyncResource } = require('async_hooks')

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const { channel } = require('../../../diagnostics_channel')
+const { channel } = require('dc-polyfill')
 const path = require('path')
 const semver = require('semver')
 const Hook = require('./hook')

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

@@ -208,6 +208,11 @@ addHook({
     const rootDir = test && test.context && test.context.config && test.context.config.rootDir
 
     const jestSuitesToRun = getJestSuitesToRun(skippableSuites, shardedTests, rootDir || process.cwd())
+
+    log.debug(
+      () => `${jestSuitesToRun.suitesToRun.length} out of ${shardedTests.length} suites are going to run.`
+    )
+
     hasUnskippableSuites = jestSuitesToRun.hasUnskippableSuites
     hasForcedToRunSuites = jestSuitesToRun.hasForcedToRunSuites
 
@@ -272,7 +277,16 @@ function cliWrapper (cli, jestVersion) {
 
     const result = await runCLI.apply(this, arguments)
 
-    const { results: { success, coverageMap } } = result
+    const {
+      results: {
+        success,
+        coverageMap,
+        numFailedTestSuites,
+        numFailedTests,
+        numTotalTests,
+        numTotalTestSuites
+      }
+    } = result
 
     let testCodeCoverageLinesTotal
     try {
@@ -281,17 +295,30 @@ function cliWrapper (cli, jestVersion) {
     } catch (e) {
       // ignore errors
     }
+    let status, error
+
+    if (success) {
+      if (numTotalTests === 0 && numTotalTestSuites === 0) {
+        status = 'skip'
+      } else {
+        status = 'pass'
+      }
+    } else {
+      status = 'fail'
+      error = new Error(`Failed test suites: ${numFailedTestSuites}. Failed tests: ${numFailedTests}`)
+    }
 
     sessionAsyncResource.runInAsyncScope(() => {
       testSessionFinishCh.publish({
-        status: success ? 'pass' : 'fail',
+        status,
         isSuitesSkipped,
         isSuitesSkippingEnabled,
         isCodeCoverageEnabled,
         testCodeCoverageLinesTotal,
         numSkippedSuites,
         hasUnskippableSuites,
-        hasForcedToRunSuites
+        hasForcedToRunSuites,
+        error
       })
     })
 
@@ -363,23 +390,23 @@ function jestAdapterWrapper (jestAdapter, jestVersion) {
           status = 'fail'
         }
 
-        const coverageFiles = getCoveredFilenamesFromCoverage(environment.global.__coverage__)
-          .map(filename => getTestSuitePath(filename, environment.rootDir))
-
         /**
          * Child processes do not each request ITR configuration, so the jest's parent process
          * needs to pass them the configuration. This is done via _ddTestCodeCoverageEnabled, which
          * controls whether coverage is reported.
-         */
-        if (coverageFiles &&
-          environment.testEnvironmentOptions &&
-          environment.testEnvironmentOptions._ddTestCodeCoverageEnabled) {
+        */
+        if (environment.testEnvironmentOptions?._ddTestCodeCoverageEnabled) {
+          const coverageFiles = getCoveredFilenamesFromCoverage(environment.global.__coverage__)
+            .map(filename => getTestSuitePath(filename, environment.rootDir))
           asyncResource.runInAsyncScope(() => {
             testSuiteCodeCoverageCh.publish([...coverageFiles, environment.testSuite])
           })
         }
         testSuiteFinishCh.publish({ status, errorMessage })
         return suiteResults
+      }).catch(error => {
+        testSuiteFinishCh.publish({ status: 'fail', error })
+        throw error
       })
     })
   })
@@ -508,6 +535,8 @@ addHook({
 
     const jestSuitesToRun = getJestSuitesToRun(skippableSuites, tests, rootDir)
 
+    log.debug(() => `${jestSuitesToRun.suitesToRun.length} out of ${tests.length} suites are going to run.`)
+
     hasUnskippableSuites = jestSuitesToRun.hasUnskippableSuites
     hasForcedToRunSuites = jestSuitesToRun.hasForcedToRunSuites
 

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const { addHook, channel } = require('./helpers/instrument')
+const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const { wrapThen } = require('./helpers/promise')
 const shimmer = require('../../datadog-shimmer')
 
@@ -39,34 +39,41 @@ addHook({
       return raw.apply(this, arguments)
     }
 
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+
     function finish () {
       finishRawQueryCh.publish()
     }
 
-    startRawQueryCh.publish({ sql, dialect: this.dialect })
+    return asyncResource.runInAsyncScope(() => {
+      startRawQueryCh.publish({ sql, dialect: this.dialect })
 
-    const rawResult = raw.apply(this, arguments)
+      const rawResult = raw.apply(this, arguments)
+      shimmer.wrap(rawResult, 'then', originalThen => function () {
+        return asyncResource.runInAsyncScope(() => {
+          arguments[0] = wrapCallbackWithFinish(arguments[0], finish)
+          if (arguments[1]) arguments[1] = wrapCallbackWithFinish(arguments[1], finish)
 
-    shimmer.wrap(rawResult, 'then', originalThen => function () {
-      arguments[0] = wrapCallbackWithFinish(arguments[0], finish)
-      arguments[1] = wrapCallbackWithFinish(arguments[1], finish)
+          const originalThenResult = originalThen.apply(this, arguments)
 
-      const originalThenResult = originalThen.apply(this, arguments)
+          shimmer.wrap(originalThenResult, 'catch', originalCatch => function () {
+            arguments[0] = wrapCallbackWithFinish(arguments[0], finish)
+            return originalCatch.apply(this, arguments)
+          })
 
-      shimmer.wrap(originalThenResult, 'catch', originalCatch => function () {
-        arguments[0] = wrapCallbackWithFinish(arguments[0], finish)
-        return originalCatch.apply(this, arguments)
+          return originalThenResult
+        })
       })
 
-      return originalThenResult
-    })
+      shimmer.wrap(rawResult, 'asCallback', originalAsCallback => function () {
+        return asyncResource.runInAsyncScope(() => {
+          arguments[0] = wrapCallbackWithFinish(arguments[0], finish)
+          return originalAsCallback.apply(this, arguments)
+        })
+      })
 
-    shimmer.wrap(rawResult, 'asCallback', originalAsCallback => function () {
-      arguments[0] = wrapCallbackWithFinish(arguments[0], finish)
-      return originalAsCallback.apply(this, arguments)
+      return rawResult
     })
-
-    return rawResult
   })
   return Knex
 })

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

@@ -133,11 +133,20 @@ function mochaHook (Runner) {
 
     this.once('end', testRunAsyncResource.bind(function () {
       let status = 'pass'
+      let error
       if (this.stats) {
         status = this.stats.failures === 0 ? 'pass' : 'fail'
+        if (this.stats.tests === 0) {
+          status = 'skip'
+        }
       } else if (this.failures !== 0) {
         status = 'fail'
       }
+
+      if (status === 'fail') {
+        error = new Error(`Failed tests: ${this.failures}.`)
+      }
+
       testFileToSuiteAr.clear()
 
       let testCodeCoverageLinesTotal
@@ -157,7 +166,8 @@ function mochaHook (Runner) {
         testCodeCoverageLinesTotal,
         numSkippedSuites: skippedSuites.length,
         hasForcedToRunSuites: isForcedToRun,
-        hasUnskippableSuites: !!unskippableSuites.length
+        hasUnskippableSuites: !!unskippableSuites.length,
+        error
       })
     }))
 
@@ -396,6 +406,11 @@ addHook({
       const { suitesToRun } = filteredSuites
 
       isSuitesSkipped = suitesToRun.length !== runner.suite.suites.length
+
+      log.debug(
+        () => `${suitesToRun.length} out of ${runner.suite.suites.length} suites are going to run.`
+      )
+
       runner.suite.suites = suitesToRun
 
       skippedSuites = Array.from(filteredSuites.skippedSuites)

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

@@ -1,7 +1,5 @@
 'use strict'
 
-// TODO: either instrument all or none of the render functions
-
 const { channel, addHook } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 const { DD_MAJOR } = require('../../../version')
@@ -14,6 +12,9 @@ const bodyParsedChannel = channel('apm:next:body-parsed')
 const queryParsedChannel = channel('apm:next:query-parsed')
 
 const requests = new WeakSet()
+const nodeNextRequestsToNextRequests = new WeakMap()
+
+const MIDDLEWARE_HEADER = 'x-middleware-invoke'
 
 function wrapHandleRequest (handleRequest) {
   return function (req, res, pathname, query) {
@@ -56,18 +57,6 @@ function wrapHandleApiRequestWithMatch (handleApiRequest) {
   }
 }
 
-function wrapRenderToResponse (renderToResponse) {
-  return function (ctx) {
-    return instrument(ctx.req, ctx.res, () => renderToResponse.apply(this, arguments))
-  }
-}
-
-function wrapRenderErrorToResponse (renderErrorToResponse) {
-  return function (ctx) {
-    return instrument(ctx.req, ctx.res, () => renderErrorToResponse.apply(this, arguments))
-  }
-}
-
 function wrapRenderToHTML (renderToHTML) {
   return function (req, res, pathname, query, parsedUrl) {
     return instrument(req, res, () => renderToHTML.apply(this, arguments))
@@ -80,6 +69,18 @@ function wrapRenderErrorToHTML (renderErrorToHTML) {
   }
 }
 
+function wrapRenderToResponse (renderToResponse) {
+  return function (ctx) {
+    return instrument(ctx.req, ctx.res, () => renderToResponse.apply(this, arguments))
+  }
+}
+
+function wrapRenderErrorToResponse (renderErrorToResponse) {
+  return function (ctx) {
+    return instrument(ctx.req, ctx.res, () => renderErrorToResponse.apply(this, arguments))
+  }
+}
+
 function wrapFindPageComponents (findPageComponents) {
   return function (pathname, query) {
     const result = findPageComponents.apply(this, arguments)
@@ -114,7 +115,9 @@ function instrument (req, res, handler) {
   req = req.originalRequest || req
   res = res.originalResponse || res
 
-  if (requests.has(req)) return handler()
+  // TODO support middleware properly in the future?
+  const isMiddleware = req.headers[MIDDLEWARE_HEADER]
+  if (isMiddleware || requests.has(req)) return handler()
 
   requests.add(req)
 
@@ -154,6 +157,11 @@ function finish (ctx, result, err) {
     errorChannel.publish(ctx)
   }
 
+  const maybeNextRequest = nodeNextRequestsToNextRequests.get(ctx.req)
+  if (maybeNextRequest) {
+    ctx.nextRequest = maybeNextRequest
+  }
+
   finishChannel.publish(ctx)
 
   if (err) {
@@ -163,6 +171,24 @@ function finish (ctx, result, err) {
   return result
 }
 
+// also wrapped in dist/server/future/route-handlers/app-route-route-handler.js
+// in versions below 13.3.0 that support middleware,
+// however, it is not provided as a class function or exported property
+addHook({
+  name: 'next',
+  versions: ['>=13.3.0'],
+  file: 'dist/server/web/spec-extension/adapters/next-request.js'
+}, NextRequestAdapter => {
+  shimmer.wrap(NextRequestAdapter.NextRequestAdapter, 'fromNodeNextRequest', fromNodeNextRequest => {
+    return function (nodeNextRequest) {
+      const nextRequest = fromNodeNextRequest.apply(this, arguments)
+      nodeNextRequestsToNextRequests.set(nodeNextRequest.originalRequest, nextRequest)
+      return nextRequest
+    }
+  })
+  return NextRequestAdapter
+})
+
 addHook({
   name: 'next',
   versions: ['>=11.1'],
@@ -175,27 +201,32 @@ addHook({
   file: 'dist/next-server/server/serve-static.js'
 }, serveStatic => shimmer.wrap(serveStatic, 'serveStatic', wrapServeStatic))
 
-addHook({ name: 'next', versions: ['>=13.2'], file: 'dist/server/next-server.js' }, nextServer => {
+addHook({ name: 'next', versions: ['>=11.1'], file: 'dist/server/next-server.js' }, nextServer => {
   const Server = nextServer.default
 
   shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)
-  shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequestWithMatch)
+
+  // Wrapping these makes sure any public API render methods called in a custom server
+  // are traced properly
+  // (instead of wrapping the top-level API methods, just wrapping these covers them all)
   shimmer.wrap(Server.prototype, 'renderToResponse', wrapRenderToResponse)
   shimmer.wrap(Server.prototype, 'renderErrorToResponse', wrapRenderErrorToResponse)
+
   shimmer.wrap(Server.prototype, 'findPageComponents', wrapFindPageComponents)
 
   return nextServer
 })
 
-addHook({ name: 'next', versions: ['>=11.1 <13.2'], file: 'dist/server/next-server.js' }, nextServer => {
+// `handleApiRequest` changes parameters/implementation at 13.2.0
+addHook({ name: 'next', versions: ['>=13.2'], file: 'dist/server/next-server.js' }, nextServer => {
   const Server = nextServer.default
+  shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequestWithMatch)
+  return nextServer
+})
 
-  shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)
+addHook({ name: 'next', versions: ['>=11.1 <13.2'], file: 'dist/server/next-server.js' }, nextServer => {
+  const Server = nextServer.default
   shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequest)
-  shimmer.wrap(Server.prototype, 'renderToResponse', wrapRenderToResponse)
-  shimmer.wrap(Server.prototype, 'renderErrorToResponse', wrapRenderErrorToResponse)
-  shimmer.wrap(Server.prototype, 'findPageComponents', wrapFindPageComponents)
-
   return nextServer
 })
 
@@ -208,8 +239,12 @@ addHook({
 
   shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)
   shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequest)
+
+  // Likewise with newer versions, these correlate to public API render methods for custom servers
+  // all public ones use these methods somewhere in their code path
   shimmer.wrap(Server.prototype, 'renderToHTML', wrapRenderToHTML)
   shimmer.wrap(Server.prototype, 'renderErrorToHTML', wrapRenderErrorToHTML)
+
   shimmer.wrap(Server.prototype, 'findPageComponents', wrapFindPageComponents)
 
   return nextServer