newrelic 7.4.0 → 7.5.0

package/NEWS.md

@@ -1,3 +1,27 @@
+### v7.5.0 (2021-06-01)
+
+* Added default support for config files with a 'cjs' extension (`newrelic.cjs`) in addition to `newrelic.js`.
+
+  Thank you to @Maddemacher for the contribution!
+
+* Added ability to specify a custom config file name with the `NEW_RELIC_CONFIG_FILENAME` environment variable.
+
+  Thank you to @Maddemacher for the contribution!
+
+* Fixed issue when using the 'new_promise_tracking' feature flag where segment mapping may not get cleaned up for promises which never resolve but have all references removed (and thus get cleaned up by GC).
+
+  Adds segment cleanup on 'destroy' when using 'new_promise_tracking' feature flag in addition to the existing 'promiseResolve' hook. Unfortunately, preventing leaks for this edge-case does come with additional overhead due to adding another hook. Memory gains from feature flag usage should still be worth the trade-off and reduced garbage collection may offset perf/CPU impacts or event still result in net gain, depending on the application.
+
+* Bumped `@newrelic/test-utilities` to ^5.1.0.
+
+* Replaced deprecated `util.isArray` with `Array.isArray`.
+
+* Removed unused `listenerCount` method on `Shim`.
+
+* Properly bootstraped husky as a `prepare` script.
+
+* Removed commented-out console log from fastify instrumentation.
+
 ### v7.4.0 (2021-05-11)
 
 * Updated third party notices and manifest for husky and lint-staged.

package/lib/config/index.js

@@ -32,14 +32,6 @@ const DEFAULT_MAX_PAYLOAD_SIZE_IN_BYTES = 1000000
 const DEFAULT_CONFIG_PATH = require.resolve('./default')
 const SPAN_EVENT_LIMIT = 1000
 const BASE_CONFIG_PATH = require.resolve('../../newrelic')
-const DEFAULT_FILENAME = 'newrelic.js'
-const CONFIG_FILE_LOCATIONS = [
-  process.env.NEW_RELIC_HOME,
-  process.cwd(),
-  process.env.HOME,
-  path.join(__dirname, '../../../..') // above node_modules
-]
-
 const HAS_ARBITRARY_KEYS = new Set([
   'ignore_messages',
   'expected_messages',
@@ -54,9 +46,22 @@ const exists = fs.existsSync || path.existsSync
 let logger = null // Lazy-loaded in `initialize`.
 let _configInstance = null
 
+const getConfigFileNames = () => [
+  process.env.NEW_RELIC_CONFIG_FILENAME,
+  'newrelic.js',
+  'newrelic.cjs'
+].filter(Boolean)
+
+const getConfigFileLocations = () => [
+  process.env.NEW_RELIC_HOME,
+  process.cwd(),
+  process.env.HOME,
+  path.join(__dirname, '../../../..') // above node_modules
+].filter(Boolean)
+
 // the REPL has no main module
 if (process.mainModule && process.mainModule.filename) {
-  CONFIG_FILE_LOCATIONS.splice(2, 0, path.dirname(process.mainModule.filename))
+  getConfigFileLocations().splice(2, 0, path.dirname(process.mainModule.filename))
 }
 
 function isTruthular(setting) {
@@ -89,19 +94,15 @@ function fromObjectList(setting) {
 }
 
 function _findConfigFile() {
-  var candidate
-  var filepath
-
-
-  for (var i = 0; i < CONFIG_FILE_LOCATIONS.length; i++) {
-    candidate = CONFIG_FILE_LOCATIONS[i]
-    if (!candidate) continue
+  const configFileCandidates = getConfigFileLocations().reduce((files, configPath) => {
+    const configFiles = getConfigFileNames().map(filename => 
+      path.join(path.resolve(configPath), filename)
+    )
 
-    filepath = path.join(path.resolve(candidate), DEFAULT_FILENAME)
-    if (!exists(filepath)) continue
+    return files.concat(configFiles)
+  }, [])
 
-    return fs.realpathSync(filepath)
-  }
+  return configFileCandidates.find(exists)
 }
 
 function Config(config) {

package/lib/instrumentation/core/async_hooks.js

@@ -191,6 +191,10 @@ function getPromiseResolveStyleHooks(segmentMap, agent, shim) {
       if (hookSegment === null) {
         shim.setActiveSegment(hookSegment)
       }
+    },
+    destroy: function destroyHandler(id) {
+      // Clean up any unresolved promises that have been destroyed.
+      segmentMap.delete(id)
     }
   }
 

package/lib/instrumentation/core/http-outbound.js

@@ -10,7 +10,6 @@ var urltils = require('../../util/urltils')
 var hashes = require('../../util/hashes')
 var logger = require('../../logger').child({component: 'outbound'})
 var shimmer = require('../../shimmer')
-var util = require('util')
 var url = require('url')
 var copy = require('../../util/copy')
 
@@ -110,7 +109,7 @@ module.exports = function instrumentOutbound(agent, opts, makeRequest) {
       logger.trace('CAT disabled, not adding headers!')
     }
 
-    if (util.isArray(opts.headers)) {
+    if (Array.isArray(opts.headers)) {
       opts.headers = opts.headers.slice()
       Array.prototype.push.apply(
         opts.headers,
@@ -203,7 +202,7 @@ function handleResponse(segment, hostname, req, res) {
   // Add response attributes for spans
   segment.addSpanAttribute('http.statusCode', res.statusCode)
   segment.addSpanAttribute('http.statusText', res.statusMessage)
-  
+
   // If CAT is enabled, grab those headers!
   const agent = segment.transaction.agent
   if (

package/lib/instrumentation/core/http.js

@@ -11,7 +11,6 @@ const recordWeb = require('../../metrics/recorders/http')
 const hashes = require('../../util/hashes')
 const cat = require('../../util/cat')
 const instrumentOutbound = require('./http-outbound')
-const util = require('util')
 const url = require('url')
 const urltils = require('../../util/urltils')
 const properties = require('../../util/properties')
@@ -606,7 +605,7 @@ function parseSyntheticsHeader(header, encKey, trustedIds) {
     return
   }
 
-  if (!util.isArray(synthData)) {
+  if (!Array.isArray(synthData)) {
     logger.trace(
       'Synthetics data is not an array: %s (%s)',
       synthData,

package/lib/instrumentation/fastify.js

@@ -54,7 +54,7 @@ const setupMiddlewareHandlers = (shim, fastify) => {
       )
       // replace original function with our function
       args[0] = newMiddlewareFunction
-      // console.log(middlewareFunction.__NR_original)
+
       return fn.apply(this, args)
     }
   })

package/lib/shim/shim.js

@@ -7,7 +7,6 @@
 
 const arity = require('../util/arity')
 const constants = require('./constants')
-const events = require('events')
 const hasOwnProperty = require('../util/properties').hasOwn
 const logger = require('../logger').child({component: 'Shim'})
 const path = require('path')
@@ -127,7 +126,6 @@ Shim.prototype.isNull = isNull
 Shim.prototype.toArray = toArray
 Shim.prototype.argsToArray = argsToArray
 Shim.prototype.normalizeIndex = normalizeIndex
-Shim.prototype.listenerCount = listenerCount
 Shim.prototype.once = once
 
 Shim.prototype.setInternalProperty = setInternalProperty
@@ -1695,23 +1693,6 @@ function normalizeIndex(arrayLength, idx) {
   return (idx < 0 || idx >= arrayLength) ? null : idx
 }
 
-/**
- * Retrieves the number of listeners for the given event.
- *
- * @memberof Shim.prototype
- *
- * @param {object} emitter  - The emitter to count the listeners on.
- * @param {string} event    - The event to count.
- *
- * @return {number} The number of listeners on the given event for this emitter.
- */
-function listenerCount(emitter, evnt) {
-  if (events.EventEmitter.listenerCount) {
-    return events.EventEmitter.listenerCount(emitter, evnt)
-  }
-  return emitter.listeners(evnt).length
-}
-
 /**
  * Wraps a function such that it will only be executed once.
  *

package/lib/util/cat.js

@@ -5,9 +5,8 @@
 
 'use strict'
 
-var util = require('util')
-var hashes = require('./hashes')
-var logger = require('../logger').child({component: 'cat'})
+const hashes = require('./hashes')
+const logger = require('../logger').child({component: 'cat'})
 
 module.exports.handleCatHeaders = handleCatHeaders
 module.exports.parsedHeadersToTrans = parsedHeadersToTrans
@@ -43,7 +42,7 @@ function parsedHeadersToTrans(parsedCatId, externalTrans, transaction) {
     transaction.incomingCatId = parsedCatId
   }
 
-  if (util.isArray(externalTrans)) {
+  if (Array.isArray(externalTrans)) {
     transaction.referringTransactionGuid = externalTrans[0]
     if (typeof externalTrans[2] === 'string') {
       transaction.tripId = externalTrans[2]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -137,7 +137,8 @@
     "update-cross-agent-tests": "./bin/update-cats.sh",
     "versioned-tests": "./bin/run-versioned-tests.sh",
     "update-changelog-version": "node ./bin/update-changelog-version",
-    "versioned": "npm run prepare-test && time ./bin/run-versioned-tests.sh"
+    "versioned": "npm run prepare-test && time ./bin/run-versioned-tests.sh",
+    "prepare": "husky install"
   },
   "bin": {
     "newrelic-naming-rules": "./bin/test-naming-rules.js"
@@ -161,7 +162,7 @@
   },
   "devDependencies": {
     "@newrelic/proxy": "^2.0.0",
-    "@newrelic/test-utilities": "^5.0.0",
+    "@newrelic/test-utilities": "^5.1.0",
     "@octokit/rest": "^18.0.15",
     "JSV": "~4.0.2",
     "architect": "*",