newrelic 11.2.0 → 11.3.0

package/NEWS.md

@@ -1,47 +1,78 @@
-### v11.2.0 (2023-10-11)
-
-#### Features
-
-* Added instrumentation for ElasticSearch ([#1785](https://github.com/newrelic/node-newrelic/pull/1785)) ([a748b84](https://github.com/newrelic/node-newrelic/commit/a748b84c6a706ed0cea2e07c9fae8807a82dbc95))
-
-#### Bug Fixes
-
-* Updated agent to create a stub api when running in a worker thread to avoid Next.js early return errors ([#1800](https://github.com/newrelic/node-newrelic/pull/1800)) ([636e8f0](https://github.com/newrelic/node-newrelic/commit/636e8f068a2ec2f989e28f6646f844b951ee636d))
-* Updated shimmer to allow registering instrumentation for different versions of the same module ([#1799](https://github.com/newrelic/node-newrelic/pull/1799)) ([30f0b16](https://github.com/newrelic/node-newrelic/commit/30f0b16e13e9621c86481c5d5409a799dbbb8d57))
-
-#### Miscellaneous Chores
-
-* **deps:** Updated @newrelic/security-agent to v0.3.0 ([#1786](https://github.com/newrelic/node-newrelic/pull/1786)) ([9ca78ae](https://github.com/newrelic/node-newrelic/commit/9ca78aede72ddecd3eb8271d349ad35cc4ce05f9))
-* Separated running versioned tests between local and external ([#1792](https://github.com/newrelic/node-newrelic/pull/1792)) ([6ffe2f6](https://github.com/newrelic/node-newrelic/commit/6ffe2f6e16c769c3fb8de767e9336992b1cca797))
-* **dev-deps** Updated get-func-name to fix CVE ([#1790](https://github.com/newrelic/node-newrelic/pull/1790)) ([f378c77](https://github.com/newrelic/node-newrelic/commit/f378c77eb09fcd3453850a1d177faea41422f637))
-
-#### Tests
-
-* Updated elasticsearch container to ignore highwatermark to function on a constrained environment ([#1803](https://github.com/newrelic/node-newrelic/pull/1803)) ([8380e9d](https://github.com/newrelic/node-newrelic/commit/8380e9d527f3ffc61d1f3e32199e81ed25837185))
-* Updated invalid json pino test as this was fixed in 8.15.1 of the pino library. ([#1782](https://github.com/newrelic/node-newrelic/pull/1782)) ([3e65fdc](https://github.com/newrelic/node-newrelic/commit/3e65fdcc68999e09d9ef3c341ff7c1159b65ab37))
-
-#### Continuous Integration
-
-* Added steps to zip up container logs on versioned test failure ([#1804](https://github.com/newrelic/node-newrelic/pull/1804)) ([0a54729](https://github.com/newrelic/node-newrelic/commit/0a54729f1d8187bb50508659716ec55349e9ee31))
-
-### 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.3.0 (2023-10-23)
+
+#### Features
+
+* Updated agent initialization to allow running in worker threads when config.worker_threads.enabled is true ([#1817](https://github.com/newrelic/node-newrelic/pull/1817)) ([a39f0ef](https://github.com/newrelic/node-newrelic/commit/a39f0ef5ac670d03ab407b24e5aeccd8d5e8c680))
+
+#### Bug fixes
+
+* Updated Elasticsearch instrumentation to register on v7.13.0+ only ([#1816](https://github.com/newrelic/node-newrelic/pull/1816)) ([6437671](https://github.com/newrelic/node-newrelic/commit/6437671b921cd6bd73ed31180b0d62f62cc229a2))
+
+#### Miscellaneous chores
+
+* **dev-deps:** Bumped @babel/traverse ([#1818](https://github.com/newrelic/node-newrelic/pull/1818)) ([d3c8d04](https://github.com/newrelic/node-newrelic/commit/d3c8d04b74b7a84846609b744e3b4922136dbdd6))
+* Updated release note headers to follow standard sentence caps ([#1806](https://github.com/newrelic/node-newrelic/pull/1806)) ([91d3600](https://github.com/newrelic/node-newrelic/commit/91d36009e0496af823cfbc3a4bdb2b32a97ba8c5))
+
+#### Tests
+
+* Updated the grpc versioned tests utils to dynamically bind ports to avoid conflicts between cjs and esm tests ([#1820](https://github.com/newrelic/node-newrelic/pull/1820)) ([95ac917](https://github.com/newrelic/node-newrelic/commit/95ac917da92575e178d8026bdc0badb08ba6fb83))
+
+#### Continuous integration
+
+* Disabled fail-fast on testing jobs to make sure all versions are run before getting canceled because of a flappy test ([#1819](https://github.com/newrelic/node-newrelic/pull/1819)) ([0928ee3](https://github.com/newrelic/node-newrelic/commit/0928ee3db82533e2386ad2bf4b87074b4f15f33b))
+* Updated CI workflow to use larger runners on versioned tests but only when running against the main branch ([#1812](https://github.com/newrelic/node-newrelic/pull/1812)) ([01eaa14](https://github.com/newrelic/node-newrelic/commit/01eaa14c76a32966f6af8475e6ba6d4e00b03513))
+* Updated post release script to update the nodejs_agent_version only on staging and us prod, eu will get it via replication now ([#1811](https://github.com/newrelic/node-newrelic/pull/1811)) ([317a00a](https://github.com/newrelic/node-newrelic/commit/317a00a9c160b52b053cb1f9f55292551c4c3428))
+
+### v11.2.1 (2023-10-12)
+
+#### Bug fixes
+
+* Updated initialization to return the api on start up to the security agent properly ([#1807](https://github.com/newrelic/node-newrelic/pull/1807)) ([99e5792](https://github.com/newrelic/node-newrelic/commit/99e5792024263a61751b73976ed707ed51815388))
+
+### v11.2.0 (2023-10-11)
+
+#### Features
+
+* Added instrumentation for ElasticSearch ([#1785](https://github.com/newrelic/node-newrelic/pull/1785)) ([a748b84](https://github.com/newrelic/node-newrelic/commit/a748b84c6a706ed0cea2e07c9fae8807a82dbc95))
+
+#### Bug Fixes
+
+* Updated agent to create a stub api when running in a worker thread to avoid Next.js early return errors ([#1800](https://github.com/newrelic/node-newrelic/pull/1800)) ([636e8f0](https://github.com/newrelic/node-newrelic/commit/636e8f068a2ec2f989e28f6646f844b951ee636d))
+* Updated shimmer to allow registering instrumentation for different versions of the same module ([#1799](https://github.com/newrelic/node-newrelic/pull/1799)) ([30f0b16](https://github.com/newrelic/node-newrelic/commit/30f0b16e13e9621c86481c5d5409a799dbbb8d57))
+
+#### Miscellaneous Chores
+
+* **deps:** Updated @newrelic/security-agent to v0.3.0 ([#1786](https://github.com/newrelic/node-newrelic/pull/1786)) ([9ca78ae](https://github.com/newrelic/node-newrelic/commit/9ca78aede72ddecd3eb8271d349ad35cc4ce05f9))
+* Separated running versioned tests between local and external ([#1792](https://github.com/newrelic/node-newrelic/pull/1792)) ([6ffe2f6](https://github.com/newrelic/node-newrelic/commit/6ffe2f6e16c769c3fb8de767e9336992b1cca797))
+* **dev-deps** Updated get-func-name to fix CVE ([#1790](https://github.com/newrelic/node-newrelic/pull/1790)) ([f378c77](https://github.com/newrelic/node-newrelic/commit/f378c77eb09fcd3453850a1d177faea41422f637))
+
+#### Tests
+
+* Updated elasticsearch container to ignore highwatermark to function on a constrained environment ([#1803](https://github.com/newrelic/node-newrelic/pull/1803)) ([8380e9d](https://github.com/newrelic/node-newrelic/commit/8380e9d527f3ffc61d1f3e32199e81ed25837185))
+* Updated invalid json pino test as this was fixed in 8.15.1 of the pino library. ([#1782](https://github.com/newrelic/node-newrelic/pull/1782)) ([3e65fdc](https://github.com/newrelic/node-newrelic/commit/3e65fdcc68999e09d9ef3c341ff7c1159b65ab37))
+
+#### Continuous Integration
+
+* Added steps to zip up container logs on versioned test failure ([#1804](https://github.com/newrelic/node-newrelic/pull/1804)) ([0a54729](https://github.com/newrelic/node-newrelic/commit/0a54729f1d8187bb50508659716ec55349e9ee31))
+
+### 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
@@ -53,6 +84,7 @@
 * Updated agent to use require-in-the-middle to register CommonJS instrumentation. You can no longer use an onResolved hook to register custom instrumentation.
 * Updated the default context manager to be AsyncLocalContextManager.
 * Renamed `shim.handleCATHeaders` to `shim.handleMqTracingHeaders`.
+* Updated agent to only run in the main thread. This is because running in a worker thread does not completely function out of the box. This will reduce the overhead for customers that are naively trying to load this into worker threads.
 
 #### Features
 

package/index.js

@@ -20,28 +20,23 @@ const NAMES = require('./lib/metrics/names')
 const isESMSupported = psemver.satisfies('>=16.2.0')
 
 const pkgJSON = require('./package.json')
-if (isMainThread) {
-  logger.info(
-    'Using New Relic for Node.js. Agent version: %s; Node version: %s.',
-    pkgJSON.version,
-    process.version
+logger.info(
+  'Using New Relic for Node.js. Agent version: %s; Node version: %s.',
+  pkgJSON.version,
+  process.version
+)
+
+if (require.cache.__NR_cache) {
+  logger.warn(
+    'Attempting to load a second copy of newrelic from %s, using cache instead',
+    __dirname
   )
-
-  if (require.cache.__NR_cache) {
-    logger.warn(
-      'Attempting to load a second copy of newrelic from %s, using cache instead',
-      __dirname
-    )
-    if (require.cache.__NR_cache.agent) {
-      require.cache.__NR_cache.agent.recordSupportability('Agent/DoubleLoad')
-    }
-    module.exports = require.cache.__NR_cache
-  } else {
-    initialize()
+  if (require.cache.__NR_cache.agent) {
+    require.cache.__NR_cache.agent.recordSupportability('Agent/DoubleLoad')
   }
+  module.exports = require.cache.__NR_cache
 } else {
-  logger.warn('Using New Relic for Node.js in worker_threads is not supported. Not starting!')
-  initApi({ apiPath: './stub_api' })
+  initialize()
 }
 
 function initApi({ agent, apiPath }) {
@@ -49,6 +44,7 @@ function initApi({ agent, apiPath }) {
 
   const api = new API(agent)
   require.cache.__NR_cache = module.exports = api
+  return api
 }
 
 function initialize() {
@@ -96,7 +92,16 @@ function initialize() {
       logger.info('No configuration detected. Not starting.')
     } else if (!config.agent_enabled) {
       logger.info('Module disabled in configuration. Not starting.')
+    } else if (!config.worker_threads.enabled && !isMainThread) {
+      logger.warn(
+        'New Relic for Node.js in worker_threads is not officially supported. Not starting! To bypass this, set `config.worker_threads.enabled` to true in configuration.'
+      )
     } else {
+      if (!isMainThread && config.worker_threads.enabled) {
+        logger.warn(
+          'Attempting to load agent in worker thread. This is not officially supported. Use at your own risk.'
+        )
+      }
       agent = createAgent(config)
       addStartupSupportabilities(agent)
     }

package/lib/config/default.js

@@ -1320,11 +1320,31 @@ defaultConfig.definition = () => ({
     }
   },
 
+  /**
+   * When enabled, it will use `process.env.DYNO`
+   * to set the hostname of the running application
+   */
   heroku: {
     use_dyno_names: {
       default: true,
       formatter: boolean
     }
+  },
+
+  /**
+   * When enabled, it will allow loading of the agent
+   * in worker threads.
+   *
+   * In 11.0.0 we added code to prevent loading in worker threads
+   * to cut down on unnecessary overhead of the agent.  We have found
+   * in testing that traces and spans were useless unless work was
+   * completely self contained in the worker thread.
+   */
+  worker_threads: {
+    enabled: {
+      formatter: boolean,
+      default: false
+    }
   }
 })
 

package/lib/config/merge-server-config.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+const { isSimpleObject } = require('../util/objects')
+
 class MergeServerConfig {
   // eslint-disable-next-line max-params
   updateNestedIfChanged(config, remote, local, remoteKey, localKey, logger) {
@@ -21,7 +23,7 @@ class MergeServerConfig {
     // value is an array, a simple object, or anything else
     if (Array.isArray(value) && Array.isArray(local[localKey])) {
       this.updateArray(value, local, localKey)
-    } else if (this.isSimpleObject(value) && this.isSimpleObject(local[localKey])) {
+    } else if (isSimpleObject(value) && isSimpleObject(local[localKey])) {
       this.updateObject(value, local, localKey)
     } else {
       local[localKey] = value
@@ -54,10 +56,6 @@ class MergeServerConfig {
       }
     })
   }
-
-  isSimpleObject(thing) {
-    return 'object' === typeof thing && thing !== null
-  }
 }
 
 module.exports = MergeServerConfig

package/lib/instrumentation/@elastic/elasticsearch.js

@@ -4,7 +4,9 @@
  */
 
 'use strict'
+const semver = require('semver')
 const logger = require('../../logger').child({ component: 'ElasticSearch' })
+const { isNotEmpty } = require('../../util/objects')
 
 /**
  * Instruments the `@elastic/elasticsearch` module. This function is
@@ -17,6 +19,15 @@ const logger = require('../../logger').child({ component: 'ElasticSearch' })
  * @returns {void}
  */
 module.exports = function initialize(_agent, elastic, _moduleName, shim) {
+  const pkgVersion = shim.require('./package.json').version
+  if (semver.lt(pkgVersion, '7.13.0')) {
+    shim &&
+      shim.logger.debug(
+        `ElasticSearch support is for versions 7.13.0 and above. Not instrumenting ${pkgVersion}.`
+      )
+    return
+  }
+
   shim.setDatastore(shim.ELASTICSEARCH)
   shim.setParser(queryParser)
 
@@ -46,18 +57,17 @@ module.exports = function initialize(_agent, elastic, _moduleName, shim) {
  */
 function queryParser(params) {
   params = JSON.parse(params)
-
   const { collection, operation } = parsePath(params.path, params.method)
 
   // the substance of the query may be in querystring or in body.
   let queryParam = {}
-  if (typeof params.querystring === 'object' && Object.keys(params.querystring).length > 0) {
+  if (isNotEmpty(params.querystring)) {
     queryParam = params.querystring
   }
   // let body or bulkBody override querystring, as some requests have both
-  if (typeof params.body === 'object' && Object.keys(params.body).length > 0) {
+  if (isNotEmpty(params.body)) {
     queryParam = params.body
-  } else if (typeof params.bulkBody === 'object' && Object.keys(params.bulkBody).length > 0) {
+  } else if (isNotEmpty(params.bulkBody)) {
     queryParam = params.bulkBody
   }
 

package/lib/util/objects.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+exports = module.exports = { isSimpleObject, isNotEmpty }
+
+/**
+ * Convenience function to test if a value is a non-null object
+ *
+ * @param {object} thing Value to be tested
+ * @returns {boolean} whether or not the value is an object and not null
+ */
+function isSimpleObject(thing) {
+  return 'object' === typeof thing && thing !== null
+}
+
+/**
+ * Convenience function to test if an object is not empty
+ *
+ * @param {object} thing Value to be tested
+ * @returns {boolean} true if the value is an object, not null, and has keys
+ */
+function isNotEmpty(thing) {
+  return isSimpleObject(thing) && Object.keys(thing).length > 0
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.2.0",
+  "version": "11.3.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [