newrelic 9.6.0 → 9.7.0

package/NEWS.md

@@ -1,3 +1,7 @@
+### v9.7.0 (2022-11-14)
+
+* Added new configuration option, `grpc.ignore_status_codes`, which can be used to select nonzero gRPC status codes to ignore and not report as errors.
+
 ### v9.6.0 (2022-11-09)
 
 * Dropped support for `vision`, and instead only instrument `@hapi/vision`.

package/api.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 21] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const util = require('util')
 const logger = require('./lib/logger').child({ component: 'api' })
 const recordWeb = require('./lib/metrics/recorders/http')

package/bin/test-naming-rules.js

@@ -64,7 +64,7 @@ function run(opts) {
   let appliedRules = []
 
   // responsible for handling default rules provided by the server
-  const defaultNormalizer = loadDefaultNormalizer(config, runtimeRules)
+  const defaultNormalizer = loadDefaultNormalizer(config)
 
   // rules defined by user in local configuration file
   const userNormalizer = loadUserNormalizer(config, runtimeRules)

package/esm-loader.mjs

@@ -197,11 +197,9 @@ async function wrapEsmSource(url, specifier) {
     const _wrappedModule = wrapModule(_originalModule, '${specifier}', '${trimmedUrl}')
     ${props
       .map((propName) => {
-        const propertyExportSource = `
+        return `
     let _${propName} = _wrappedModule.${propName}
     export { _${propName} as ${propName} }`
-
-        return propertyExportSource
       })
       .join('\n')}
   `

package/lib/adaptive-sampler.js

@@ -79,8 +79,7 @@ class AdaptiveSampler {
    * the number of objects sampled in this window.
    *
    * @param {number} roll - The number to compare against the threshold
-   *
-   * @return {bool} True if the object should be sampled.
+   * @returns {bool} True if the object should be sampled.
    */
   shouldSample(roll) {
     ++this._seen

package/lib/agent.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 23] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const AdaptiveSampler = require('./adaptive-sampler')
 const CollectorAPI = require('./collector/api')
 const ServerlessCollector = require('./collector/serverless')

package/lib/aggregators/event-aggregator.js

@@ -76,7 +76,7 @@ class EventAggregator extends Aggregator {
   /**
    * Fetches all the span events aggregated.
    *
-   * @return {array.<Event>} An array of span events from the aggregator.
+   * @returns {Array.<Event>} An array of span events from the aggregator.
    */
   getEvents() {
     return this._items.toArray()
@@ -85,7 +85,7 @@ class EventAggregator extends Aggregator {
   /**
    * Resets the contents of the aggregator and all counters.
    *
-   * @return {PriorityQueue} The old collection of aggregated events.
+   * @returns {PriorityQueue} The old collection of aggregated events.
    */
   clearEvents() {
     // ???: might be more efficient to clear here and come up with an efficient way to

package/lib/attributes.js

@@ -22,7 +22,6 @@ class Attributes {
    * @param {string} scope
    *  The scope of the attributes this will collect. Must be `transaction` or
    *  `segment`.
-   *
    * @param {number} [limit=Infinity]
    *  The maximum number of attributes to retrieve for each destination.
    */
@@ -61,7 +60,7 @@ class Attributes {
    * attributes allowed, no more than that number will be included in the result.
    *
    * @param {AttributeFilter.DESTINATIONS} dest
-   * @return {object}
+   * @returns {object}
    */
   get(dest) {
     const attrs = Object.create(null)
@@ -168,8 +167,7 @@ class Attributes {
  * Creates a filter function for the given scope.
  *
  * @param {string} scope - The scope of the filter to make.
- *
- * @return {function} A function that performs attribute filtering for the given
+ * @returns {Function} A function that performs attribute filtering for the given
  *  scope.
  */
 function makeFilter(scope) {

package/lib/collector/api.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 16] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const CollectorResponse = require('./response')
 const facts = require('./facts')
 const logger = require('../logger').child({ component: 'collector_api' })
@@ -89,6 +91,10 @@ function CollectorAPI(agent) {
   }
 }
 
+CollectorAPI.prototype._throwCallbackError = function _throwCallbackError() {
+  throw new TypeError('callback is required')
+}
+
 /**
  * Updates all methods except preconnect w/ new host/port pairs sent down from server
  * during preconnect (via redirect_host). Preconnect does not update.
@@ -107,7 +113,7 @@ CollectorAPI.prototype._updateEndpoints = function _updateEndpoints(endpoint) {
 
 CollectorAPI.prototype.connect = function connect(callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
 
   logger.trace('Starting collector.')
@@ -376,7 +382,7 @@ CollectorAPI.prototype.reportSettings = function reportSettings(callback) {
  */
 CollectorAPI.prototype.error_data = function errorData(errors, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!errors) {
     return callback(new TypeError('must pass errors to send'))
@@ -387,7 +393,7 @@ CollectorAPI.prototype.error_data = function errorData(errors, callback) {
 
 CollectorAPI.prototype.error_event_data = function errorEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass errors to send'))
@@ -403,7 +409,7 @@ CollectorAPI.prototype.analytic_event_data = transactionEvents
  */
 function transactionEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass events to send'))
@@ -414,7 +420,7 @@ function transactionEvents(events, callback) {
 
 CollectorAPI.prototype.custom_event_data = function customEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass events to send'))
@@ -441,7 +447,7 @@ CollectorAPI.prototype.custom_event_data = function customEvents(events, callbac
  */
 CollectorAPI.prototype.metric_data = function metricData(metrics, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!metrics) {
     return callback(new TypeError('must pass metrics to send'))
@@ -464,7 +470,7 @@ CollectorAPI.prototype.metric_data = function metricData(metrics, callback) {
  */
 CollectorAPI.prototype.sql_trace_data = function queryData(queries, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!queries) {
     return callback(new TypeError('must pass queries to send'))
@@ -474,7 +480,7 @@ CollectorAPI.prototype.sql_trace_data = function queryData(queries, callback) {
 
 CollectorAPI.prototype.span_event_data = function spanEvents(events, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!events) {
     return callback(new TypeError('must pass spans to send'))
@@ -503,7 +509,7 @@ CollectorAPI.prototype.transaction_sample_data = transactionSampleData
  */
 function transactionSampleData(traces, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!traces) {
     return callback(new TypeError('must pass traces to send'))
@@ -527,7 +533,7 @@ function transactionSampleData(traces, callback) {
  */
 CollectorAPI.prototype.log_event_data = function logEventData(logRecords, callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
   if (!logRecords) {
     return callback(new TypeError('must pass logRecords to send'))
@@ -545,7 +551,7 @@ CollectorAPI.prototype.log_event_data = function logEventData(logRecords, callba
  */
 CollectorAPI.prototype.shutdown = function shutdown(callback) {
   if (!callback) {
-    throw new TypeError('callback is required')
+    this._throwCallbackError()
   }
 
   logger.info('Shutting down collector.')
@@ -620,6 +626,7 @@ CollectorAPI.prototype._sendData = function _sendData(method, data, callback) {
 
     // TODO: log the payload if exists?
 
+    /*
     if (response.agentRun === AGENT_RUN_BEHAVIOR.SHUTDOWN) {
       // TODO: for now, shut handled in _handleResponseCode for consistency
       // either find way to safely change while side-by-side or move
@@ -635,7 +642,8 @@ CollectorAPI.prototype._sendData = function _sendData(method, data, callback) {
       // })
 
       callback(null, { retainData: response.retainData })
-    } else if (response.agentRun === AGENT_RUN_BEHAVIOR.RESTART) {
+      */
+    if (response.agentRun === AGENT_RUN_BEHAVIOR.RESTART) {
       // TODO: almost seems better to leg aggregator finish (cb) then restart?
 
       // TODO: ensure harvesting stopped for all other endpoints. same for shutdown.

package/lib/collector/facts.js

@@ -142,13 +142,11 @@ function getAllIPAddresses() {
  * @param appNames
  */
 function getIdentifierOverride(appNames) {
-  const identifier = [
+  return [
     'nodejs',
     // NOTE: The concat is necessary to prevent sort from happening in-place.
     appNames.concat([]).sort().join(',')
   ].join(':')
-
-  return identifier
 }
 
 /**

package/lib/collector/parse-response.js

@@ -22,7 +22,9 @@ const logger = require('../logger').child({ component: 'new_relic_response' })
  *                                error, the value returned by the server
  *                                (if any), and the raw JSON of the
  *                                server's response.
- *
+ * @param name
+ * @param response
+ * @param callback
  * @returns Function Another callback that is meant to be invoked with
  *                   any errors from reading the response stream, as
  *                   well as a string containing the full response.

package/lib/collector/remote-method.js

@@ -250,12 +250,13 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
 
   // If trace level is not explicitly enabled check to see if the audit log is
   // enabled.
-  if (logConfig != null && logConfig.level !== 'trace' && auditLog.enabled) {
-    // If the filter property is empty, then always log the event otherwise
-    // check to see if the filter includes this method.
-    if (auditLog.endpoints.length === 0 || auditLog.endpoints.indexOf(this.name) > -1) {
-      level = 'info'
-    }
+  if (
+    logConfig != null &&
+    logConfig.level !== 'trace' &&
+    auditLog.enabled &&
+    (auditLog.endpoints.length === 0 || auditLog.endpoints.indexOf(this.name) > -1)
+  ) {
+    level = 'info'
   }
 
   const logBody = Buffer.isBuffer(options.body) ? 'Buffer ' + options.body.length : options.body
@@ -349,12 +350,10 @@ RemoteMethod.prototype._path = function _path() {
     query[RUN_ID_NAME] = this._config.run_id
   }
 
-  const formatted = url.format({
+  return url.format({
     pathname: RAW_METHOD_PATH,
     query: query
   })
-
-  return formatted
 }
 
 /**

package/lib/config/attribute-filter.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 16] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const NO_MATCH = -Infinity
 const EXACT_MATCH = Infinity
 const DESTINATIONS = {
@@ -52,7 +54,6 @@ exports.DESTINATIONS = DESTINATIONS
  *
  * @class
  * @private
- *
  * @param {Config} config - The configuration object for the agent.
  */
 function AttributeFilter(config) {
@@ -87,8 +88,7 @@ function AttributeFilter(config) {
  *
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype.filterTransaction = filterTransaction
 function filterTransaction(destinations, key) {
@@ -100,8 +100,7 @@ function filterTransaction(destinations, key) {
  *
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype.filterSegment = function filterSegment(destinations, key) {
   return this._filter(SEGMENT_SCOPE_DETAILS, destinations, key)
@@ -112,8 +111,7 @@ AttributeFilter.prototype.filterSegment = function filterSegment(destinations, k
  *
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype.filterAll = function filterSegment(destinations, key) {
   return this._filter(DESTINATION_DETAILS, destinations, key)
@@ -122,11 +120,10 @@ AttributeFilter.prototype.filterAll = function filterSegment(destinations, key)
 /**
  * Tests a given key against the global and destination filters.
  *
- * @param {array}         scope         - The destination details for filtering.
+ * @param {Array}         scope         - The destination details for filtering.
  * @param {DESTINATIONS}  destinations  - The locations the attribute wants to be put.
  * @param {string}        key           - The name of the attribute to test.
- *
- * @return {DESTINATIONS} The destinations the attribute should be put.
+ * @returns {DESTINATIONS} The destinations the attribute should be put.
  */
 AttributeFilter.prototype._filter = function _filter(scope, destinations, key) {
   // This method could be easily memoized since for a given destination and key
@@ -212,9 +209,12 @@ AttributeFilter.prototype.update = function update() {
 /**
  * Applies the global and destination rules to this key.
  *
+ * @param globalInclude
+ * @param globalExclude
+ * @param destConfig
+ * @param key
  * @private
- *
- * @return {bool|number} True if this key is explicitly included, false if it is
+ * @returns {bool|number} True if this key is explicitly included, false if it is
  *  explicitly excluded, or `NO_MATCH` if no rule applies.
  */
 function _doTest(globalInclude, globalExclude, destConfig, key) {
@@ -289,10 +289,8 @@ function _matchRules(rules, key) {
  * Converts the raw rules into a set of regular expressions to test against.
  *
  * @private
- *
- * @param {array.<string>} rules - The set of rules to compose.
- *
- * @return {object} An object with `exact` and `wildcard` properties which are
+ * @param {Array.<string>} rules - The set of rules to compose.
+ * @returns {object} An object with `exact` and `wildcard` properties which are
  * `RegExp` instances for testing keys.
  */
 function _importRules(rules) {

package/lib/config/default.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 17] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252*/
+
 const defaultConfig = module.exports
 const { array, int, float, boolean, object, objectList, allowList } = require('./formatters')
 
@@ -936,6 +938,21 @@ defaultConfig.definition = () => ({
     record_errors: {
       formatter: boolean,
       default: true
+    },
+    /**
+     * List of gRPC error status codes the error tracer should disregard.
+     * Ignoring a status code means that the transaction is not renamed to
+     * match the code, and the request is not treated as an error by the error
+     * collector.
+     *
+     * NOTE: This configuration value has no effect on errors recorded using
+     * `noticeError()`.
+     *
+     * Defaults to no codes ignored.
+     */
+    ignore_status_codes: {
+      formatter: array,
+      default: []
     }
   },
   /**

package/lib/config/harvest-config-validator.js

@@ -12,17 +12,15 @@ function isValidHarvestConfig(harvestConfig) {
 
   const harvestLimits = harvestConfig.harvest_limits
 
-  const isValid =
+  return (
     isValidHarvestValue(harvestConfig.report_period_ms) &&
     harvestLimits != null &&
     Object.keys(harvestLimits).length > 0
-
-  return isValid
+  )
 }
 
 function isValidHarvestValue(value) {
-  const isValid = value != null && value >= 0
-  return !!isValid
+  return !!(value != null && value >= 0)
 }
 
 module.exports = {

package/lib/config/index.js

@@ -5,6 +5,9 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 29] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+/* eslint sonarjs/max-switch-cases: ["error", 36] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const AttributeFilter = require('./attribute-filter')
 const CollectorResponse = require('../collector/response')
 const copy = require('../util/copy')
@@ -37,6 +40,7 @@ const HAS_ARBITRARY_KEYS = new Set(['ignore_messages', 'expected_messages', 'lab
 const LASP_MAP = require('./lasp').LASP_MAP
 const HSM = require('./hsm')
 const REMOVE_BEFORE_SEND = new Set(['attributeFilter'])
+const SSL_WARNING = 'SSL config key can no longer be disabled, not updating.'
 
 const exists = fs.existsSync
 let logger = null // Lazy-loaded in `initialize`.
@@ -305,7 +309,7 @@ Config.prototype._fromServer = function _fromServer(params, key) {
 
     case 'ssl':
       if (!isTruthular(params.ssl)) {
-        logger.warn('SSL config key can no longer be disabled, not updating.')
+        logger.warn(SSL_WARNING)
       }
       break
 
@@ -963,7 +967,7 @@ Config.prototype._fromPassed = function _fromPassed(external, internal, arbitrar
     }
 
     if (key === 'ssl' && !isTruthular(external.ssl)) {
-      logger.warn('SSL config key can no longer be disabled, not updating.')
+      logger.warn(SSL_WARNING)
       return
     }
 
@@ -1033,8 +1037,7 @@ Config.prototype._featureFlagsFromEnv = function _featureFlagsFromEnv() {
 function deriveEnvVar(key, paths) {
   let path = paths.join('_')
   path = path ? `${path}_` : path
-  const envKey = `NEW_RELIC_${path.toUpperCase()}${key.toUpperCase()}`
-  return envKey
+  return `NEW_RELIC_${path.toUpperCase()}${key.toUpperCase()}`
 }
 
 /**

package/lib/environment.js

@@ -10,6 +10,7 @@ const { fsPromises } = require('./util/unwrapped-core')
 const os = require('os')
 const logger = require('./logger').child({ component: 'environment' })
 const stringify = require('json-stringify-safe')
+const DISPATCHER_VERSION = 'Dispatcher Version'
 
 // As of 1.7.0 you can no longer dynamically link v8
 // https://github.com/nodejs/io.js/commit/d726a177ed
@@ -418,7 +419,7 @@ function refreshSyncOnly() {
   // gather persisted settings
   const framework = getSetting('Framework')
   const dispatcher = getSetting('Dispatcher')
-  const dispatcherVersion = getSetting('Dispatcher Version')
+  const dispatcherVersion = getSetting(DISPATCHER_VERSION)
 
   // clearing and rebuilding a global variable
   settings = Object.create(null)
@@ -437,7 +438,7 @@ function refreshSyncOnly() {
 
   if (dispatcherVersion.length) {
     dispatcher.forEach(function addDispatchers(d) {
-      addSetting('Dispatcher Version', d)
+      addSetting(DISPATCHER_VERSION, d)
     })
   }
 
@@ -503,12 +504,12 @@ module.exports = {
     }
 
     userSetDispatcher = !!userSet
-    clearSetting('Dispatcher Version')
+    clearSetting(DISPATCHER_VERSION)
     clearSetting('Dispatcher')
 
     // TODO: Decide if this should only happen once for internals as well.
     if (version) {
-      addSetting('Dispatcher Version', version)
+      addSetting(DISPATCHER_VERSION, version)
     }
 
     addSetting('Dispatcher', dispatcher)
@@ -520,7 +521,7 @@ module.exports = {
     // This method is only used for tests.
     userSetDispatcher = false
     clearSetting('Dispatcher')
-    clearSetting('Dispatcher Version')
+    clearSetting(DISPATCHER_VERSION)
   },
   listPackages,
   getJSON,

package/lib/errors/error-collector.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 25] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const errorsModule = require('./index')
 
 const logger = require('../logger').child({ component: 'error_tracer' })
@@ -112,8 +114,7 @@ class ErrorCollector {
    * possible.
    *
    * @param {Transaction} transaction
-   *
-   * @return {number} The number of unexpected errors
+   * @returns {number} The number of unexpected errors
    */
   onTransactionFinished(transaction) {
     if (!transaction) {
@@ -226,6 +227,8 @@ class ErrorCollector {
    *
    * @param {?Transaction}  transaction  Transaction associated with the error.
    * @param {Exception}  exception The Exception to be traced.
+   * @param error
+   * @param customAttributes
    */
   addUserError(transaction, error, customAttributes) {
     if (!error) {
@@ -260,7 +263,7 @@ class ErrorCollector {
    *
    * @param  {?Transaction}  transaction  Transaction associated with the error.
    * @param  {?Exception}  exception  The Exception object to be traced.
-   * @return  {bool}  True if the error was collected.
+   * @returns  {bool}  True if the error was collected.
    */
   collect(transaction, exception) {
     if (!exception) {

package/lib/errors/helper.js

@@ -21,20 +21,17 @@ module.exports = {
     if (!config.error_collector.expected_messages[type]) {
       return false
     }
-    if (config.error_collector.expected_messages[type].length > 0) {
-      if (-1 !== config.error_collector.expected_messages[type].indexOf(message)) {
-        return true
-      }
-    }
-    return false
+
+    return (
+      config.error_collector.expected_messages[type].length > 0 &&
+      config.error_collector.expected_messages[type].indexOf(message) !== -1
+    )
   },
   isExpectedErrorClass: function isExpectedErrorClass(config, className) {
-    if (config.error_collector.expected_classes.length > 0) {
-      if (-1 !== config.error_collector.expected_classes.indexOf(className)) {
-        return true
-      }
-    }
-    return false
+    return (
+      config.error_collector.expected_classes.length > 0 &&
+      config.error_collector.expected_classes.indexOf(className) !== -1
+    )
   },
   isExpectedException: function isExpectedException(transaction, exception, config, urltils) {
     const { type, message } = this.extractErrorInformation(transaction, exception, config, urltils)
@@ -123,11 +120,6 @@ module.exports = {
       return false
     }
 
-    if (configIgnoreMessages.length > 0) {
-      if (-1 !== configIgnoreMessages.indexOf(errorInfo.message)) {
-        return true
-      }
-    }
-    return false
+    return configIgnoreMessages.length > 0 && configIgnoreMessages.indexOf(errorInfo.message) !== -1
   }
 }