newrelic 11.0.0 → 11.1.0

package/NEWS.md

@@ -1,3 +1,21 @@
+### v11.1.0 (2023-09-07)
+
+#### Features
+
+* Added instrumentation for fetch. ([#1776](https://github.com/newrelic/node-newrelic/pull/1776)) ([980b4dc](https://github.com/newrelic/node-newrelic/commit/980b4dc31d085cafc45961a157f76cb73768741a))
+* Removed undici feature flag. This will now instrument undici by default. ([#1772](https://github.com/newrelic/node-newrelic/pull/1772)) ([683b254](https://github.com/newrelic/node-newrelic/commit/683b254c1c4686527a37e628f80eed9fcc03cb37))
+* Updated undici instrumentation to create segment on request create instead of after connection and opening socket to more accurately record time it takes to make an undici request. ([#1770](https://github.com/newrelic/node-newrelic/pull/1770)) ([3f494f8](https://github.com/newrelic/node-newrelic/commit/3f494f8ad8dd1350fbe034e9c4a582a40228bc45))
+
+#### Performance Improvements
+
+* **Trace:** optimise getTotalTimeDurationInMillis function to push to an array instead of concat arrays. ([#1774](https://github.com/newrelic/node-newrelic/pull/1774)) ([6ecde97](https://github.com/newrelic/node-newrelic/commit/6ecde97a5efeef4d816b2e82ba762f2130914658))
+    * Thanks @infinity-naveen for your contribution 🎉 
+
+#### Miscellaneous Chores
+
+* Updated Next.js plugin versioned tests to use main now that require-in-the-middle fixes have been merged. ([#1768](https://github.com/newrelic/node-newrelic/pull/1768)) ([6a72d1f](https://github.com/newrelic/node-newrelic/commit/6a72d1fb452ea2655c35d7cd008fa78935821ab8))
+* Upgraded `@newrelic/test-utilities` and removed unused shimmer.patchModule and shimmer.unpatchModule ([#1769](https://github.com/newrelic/node-newrelic/pull/1769)) ([96620ef](https://github.com/newrelic/node-newrelic/commit/96620efa725f0f548b683825cb3cefff270fb252))
+
 ### v11.0.0 (2023-08-28)
 
 #### ⚠ BREAKING CHANGES

package/THIRD_PARTY_NOTICES.md

@@ -1892,7 +1892,7 @@ This product includes source derived from [@newrelic/newrelic-oss-cli](https://g
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v8.0.0](https://github.com/newrelic/node-test-utilities/tree/v8.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v8.0.0/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v8.1.0](https://github.com/newrelic/node-test-utilities/tree/v8.1.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v8.1.0/LICENSE):
 
 ```
                                  Apache License
@@ -2218,7 +2218,7 @@ THE SOFTWARE.
 
 ### c8
 
-This product includes source derived from [c8](https://github.com/bcoe/c8) ([v7.14.0](https://github.com/bcoe/c8/tree/v7.14.0)), distributed under the [ISC License](https://github.com/bcoe/c8/blob/v7.14.0/LICENSE.txt):
+This product includes source derived from [c8](https://github.com/bcoe/c8) ([v8.0.1](https://github.com/bcoe/c8/tree/v8.0.1)), distributed under the [ISC License](https://github.com/bcoe/c8/blob/v8.0.1/LICENSE.txt):
 
 ```
 Copyright (c) 2017, Contributors

package/lib/feature_flags.js

@@ -10,7 +10,6 @@ exports.prerelease = {
   express5: false,
   promise_segments: false,
   reverse_naming_rules: false,
-  undici_instrumentation: false,
   undici_async_tracking: true,
   unresolved_promise_cleanup: true,
   legacy_context_manager: false
@@ -33,7 +32,8 @@ exports.released = [
   'fastify_instrumentation',
   'await_support',
   'certificate_bundle',
-  'async_local_context'
+  'async_local_context',
+  'undici_instrumentation'
 ]
 
 // flags that are no longer used for unreleased features

package/lib/instrumentation/undici.js

@@ -12,48 +12,38 @@ const NAMES = require('../metrics/names')
 const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
 const symbols = require('../symbols')
 const { executionAsyncResource } = require('async_hooks')
-const tls = require('tls')
-const net = require('net')
-
-let diagnosticsChannel = null
-try {
-  diagnosticsChannel = require('diagnostics_channel')
-} catch (e) {
-  // quick check to see if module exists
-  // module was not added until v15.x
-}
+const diagnosticsChannel = require('diagnostics_channel')
 
-module.exports = function addUndiciChannels(agent, _undici, _modName, shim) {
-  if (!diagnosticsChannel || !agent.config.feature_flag.undici_instrumentation) {
-    logger.warn(
-      'diagnostics_channel or feature_flag.undici_instrumentation = false. Skipping undici instrumentation.'
-    )
-    return
-  }
-
-  registerHookPoints(shim)
-}
+const channels = [
+  { channel: diagnosticsChannel.channel('undici:request:create'), hook: requestCreateHook },
+  { channel: diagnosticsChannel.channel('undici:request:headers'), hook: requestHeadersHook },
+  { channel: diagnosticsChannel.channel('undici:request:trailers'), hook: endAndRestoreSegment },
+  { channel: diagnosticsChannel.channel('undici:request:error'), hook: endAndRestoreSegment }
+]
 
 /**
  * Subscribes to all relevant undici hook points
  * See: https://github.com/nodejs/undici/blob/main/docs/api/DiagnosticsChannel.md
  *
- * @param {Shim} shim instance of shim
+ * @param agent
+ * @param _undici
+ * @param _modName
+ * @param shim
  */
-function registerHookPoints(shim) {
-  diagnosticsChannel.channel('undici:request:create').subscribe(requestCreateHook.bind(null, shim))
-  diagnosticsChannel
-    .channel('undici:client:sendHeaders')
-    .subscribe(responseHeadersHook.bind(null, shim))
-  diagnosticsChannel
-    .channel('undici:request:headers')
-    .subscribe(requestHeadersHook.bind(null, shim))
-  diagnosticsChannel
-    .channel('undici:request:trailers')
-    .subscribe(endAndRestoreSegment.bind(null, shim))
-  diagnosticsChannel
-    .channel('undici:request:error')
-    .subscribe(endAndRestoreSegment.bind(null, shim))
+module.exports = function addUndiciChannels(agent, _undici, _modName, shim) {
+  channels.forEach(({ channel, hook }) => {
+    if (!channel.hasSubscribers) {
+      channel.subscribe(hook.bind(null, shim))
+    }
+  })
+}
+
+module.exports.unsubscribe = function unsubscribe() {
+  channels.forEach(({ channel, hook }) => {
+    if (channel.hasSubscribers) {
+      channel.unsubscribe(hook)
+    }
+  })
 }
 
 /**
@@ -90,29 +80,14 @@ function getParentSegment(shim) {
 }
 
 /**
- * This event occurs after the Undici Request is created
- * We will check current segment for opaque and also attach
- * relevant headers to outgoing http request
+ * Injects relevant DT headers for the external request
  *
- * @param {Shim} shim instance of shim
- * @param {object} params object from undici hook
+ * @param {object} params object to fn
+ * @param {Shim} params.transaction current transaction
  * @param {object} params.request undici request object
+ * @param {object} params.config agent config
  */
-function requestCreateHook(shim, { request }) {
-  const { config } = shim.agent
-  const parent = getParentSegment(shim)
-  request[symbols.parentSegment] = parent
-  if (!parent || (parent && parent.opaque)) {
-    logger.trace(
-      'Not capturing data for outbound request (%s) because parent segment opaque (%s)',
-      request.path,
-      parent && parent.name
-    )
-
-    return
-  }
-
-  const transaction = parent.transaction
+function addDTHeaders({ transaction, config, request }) {
   const outboundHeaders = Object.create(null)
   if (config.encoding_key && transaction.syntheticsHeader) {
     outboundHeaders[NEWRELIC_SYNTHETICS_HEADER] = transaction.syntheticsHeader
@@ -133,37 +108,19 @@ function requestCreateHook(shim, { request }) {
 }
 
 /**
- * This event occurs right before the data is written to the socket.
- * Undici has some abstracted headers that are only created at this time, one
- * is the `host` header which we need to name the Undici segment. So in this
- * handler we create, start and set the segment active, name it, and
- * attach the url/procedure/request.parameters
+ * Creates the external segment with url, procedure and request.parameters attributes
  *
- * @param {Shim} shim instance of shim
- * @param {object} params object from undici hook
+ * @param {object} params object to fn
+ * @param {Shim} params.shim instance of shim
  * @param {object} params.request undici request object
- * @param {tls.TLSSocket | net.Socket} params.socket active socket connection
+ * @param {object} params.parentSegment current active, about to be parent of external segment
  */
-function responseHeadersHook(shim, { request, socket }) {
-  const parentSegment = request[symbols.parentSegment]
-  if (!parentSegment || (parentSegment && parentSegment.opaque)) {
-    return
-  }
-
-  const port = socket.remotePort
-  const isHttps = socket.servername
-  let urlString
-  if (isHttps) {
-    urlString = `https://${socket.servername}`
-    urlString += port === 443 ? request.path : `:${port}${request.path}`
-  } else {
-    urlString = `http://${socket._host}`
-    urlString += port === 80 ? request.path : `:${port}${request.path}`
-  }
-
-  const url = new URL(urlString)
-
+function createExternalSegment({ shim, request, parentSegment }) {
+  const url = new URL(request.origin + request.path)
   const name = NAMES.EXTERNAL.PREFIX + url.host + url.pathname
+  // Metrics for `External/<host>` will have a suffix of undici
+  // We will have to see if this matters for people only using fetch
+  // It's undici under the hood so ¯\_(ツ)_/¯
   const segment = shim.createSegment(name, recordExternal(url.host, 'undici'), parentSegment)
   if (segment) {
     segment.start()
@@ -178,6 +135,38 @@ function responseHeadersHook(shim, { request, socket }) {
   }
 }
 
+/**
+ * This event occurs after the Undici Request is created.
+ * We will check current segment for opaque before creating the
+ * external segment with the standard url/procedure/request.parameters
+ * attributes.  We will also attach relevant DT headers to outgoing http request.
+ *
+ * @param {Shim} shim instance of shim
+ * @param {object} params object from undici hook
+ * @param {object} params.request undici request object
+ */
+function requestCreateHook(shim, { request }) {
+  const { config } = shim.agent
+  const parentSegment = getParentSegment(shim)
+  request[symbols.parentSegment] = parentSegment
+  if (!parentSegment || (parentSegment && parentSegment.opaque)) {
+    logger.trace(
+      'Not capturing data for outbound request (%s) because parent segment opaque (%s)',
+      request.path,
+      parentSegment && parentSegment.name
+    )
+
+    return
+  }
+
+  try {
+    addDTHeaders({ transaction: parentSegment.transaction, config, request })
+    createExternalSegment({ shim, request, parentSegment })
+  } catch (err) {
+    logger.warn(err, 'Unable to create external segment')
+  }
+}
+
 /**
  * This event occurs after the response headers have been received.
  * We will add the relevant http response attributes to active segment.

package/lib/instrumentations.js

@@ -36,7 +36,6 @@ module.exports = function instrumentations() {
     '@redis/client': { type: MODULE_TYPE.DATASTORE },
     'restify': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'superagent': { module: '@newrelic/superagent' },
-    'undici': { type: MODULE_TYPE.TRANSACTION },
     '@hapi/vision': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'when': { module: './instrumentation/when' },
     'winston': { type: MODULE_TYPE.GENERIC },

package/lib/shimmer.js

@@ -18,6 +18,7 @@ let pkgsToHook = []
 
 const NAMES = require('./metrics/names')
 const symbols = require('./symbols')
+const { unsubscribe } = require('./instrumentation/undici')
 
 const MODULE_TYPE = shims.constants.MODULE_TYPE
 
@@ -328,6 +329,12 @@ const shimmer = (module.exports = {
     const globalsFilepath = path.join(__dirname, 'instrumentation', 'core', 'globals.js')
     _firstPartyInstrumentation(agent, globalsFilepath, globalShim, global, 'globals')
 
+    // Since this just registers subscriptions to diagnostics_channel events from undici
+    // We register this as core and it'll work for both fetch and undici
+    const undiciPath = path.join(__dirname, 'instrumentation', 'undici.js')
+    const undiciShim = shims.createShimFromType(MODULE_TYPE.TRANSACTION, agent, 'undici', 'undici')
+    _firstPartyInstrumentation(agent, undiciPath, undiciShim)
+
     // Instrument each of the core modules.
     for (const [mojule, core] of Object.entries(CORE_INSTRUMENTATION)) {
       const filePath = path.join(__dirname, 'instrumentation', 'core', core.file)
@@ -344,14 +351,6 @@ const shimmer = (module.exports = {
       _firstPartyInstrumentation(agent, filePath, shim, uninstrumented, mojule)
     }
   },
-  // TODO: remove the following methods once test-utilities have been updated and released
-  // with the new registerHooks and removeHooks methods
-  patchModule(agent) {
-    shimmer.registerHooks(agent)
-  },
-  unpatchModule() {
-    shimmer.removeHooks()
-  },
   registerHooks(agent) {
     this._ritm = new Hook(pkgsToHook, function onHook(exports, name, basedir) {
       return _postLoad(agent, exports, name, basedir)
@@ -372,6 +371,7 @@ const shimmer = (module.exports = {
     }
 
     pkgsToHook = []
+    unsubscribe()
   },
 
   bootstrapInstrumentation: function bootstrapInstrumentation(agent) {

package/lib/symbols.js

@@ -18,6 +18,7 @@ module.exports = {
   offTheRecord: Symbol('offTheRecord'),
   original: Symbol('original'),
   wrapped: Symbol('shimWrapped'),
+  parentSegment: Symbol('parentSegment'),
   prismaConnection: Symbol('prismaConnection'),
   prismaModelCall: Symbol('modelCall'),
   segment: Symbol('segment'),

package/lib/transaction/trace/index.js

@@ -218,13 +218,13 @@ Trace.prototype.getTotalTimeDurationInMillis = function getTotalTimeDurationInMi
   if (this.root.children.length === 0) {
     return 0
   }
-  let segments = this.root.getChildren()
+  const segments = this.root.getChildren()
   let totalTimeInMillis = 0
 
   while (segments.length !== 0) {
     const segment = segments.pop()
     totalTimeInMillis += segment.getExclusiveDurationInMillis()
-    segments = segments.concat(segment.getChildren())
+    segment.getChildren().forEach((childSegment) => segments.push(childSegment))
   }
 
   if (!this.transaction.isActive()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.0.0",
+  "version": "11.1.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -202,12 +202,12 @@
   "devDependencies": {
     "@newrelic/eslint-config": "^0.3.0",
     "@newrelic/newrelic-oss-cli": "^0.1.2",
-    "@newrelic/test-utilities": "^8.0.0",
+    "@newrelic/test-utilities": "^8.1.0",
     "@octokit/rest": "^18.0.15",
     "@slack/bolt": "^3.7.0",
     "ajv": "^6.12.6",
     "async": "^3.2.4",
-    "c8": "^7.14.0",
+    "c8": "^8.0.1",
     "chai": "^4.1.2",
     "clean-jsdoc-theme": "^4.2.4",
     "commander": "^7.0.0",