newrelic 9.6.0 → 9.7.0

package/lib/errors/index.js

@@ -5,11 +5,14 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 22] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const DESTINATIONS = require('../config/attribute-filter').DESTINATIONS
 const NAMES = require('../metrics/names')
 const props = require('../util/properties')
 const urltils = require('../util/urltils')
 const errorHelper = require('../errors/helper')
+const ERROR_EXPECTED_PATH = 'error.expected'
 
 class Exception {
   constructor({ error, timestamp, customAttributes, agentAttributes }) {
@@ -101,9 +104,9 @@ function createError(transaction, exception, config) {
     }
   }
 
-  params.intrinsics['error.expected'] = false
+  params.intrinsics[ERROR_EXPECTED_PATH] = false
   if (errorHelper.isExpected(type, message, transaction, config, urltils)) {
-    params.intrinsics['error.expected'] = true
+    params.intrinsics[ERROR_EXPECTED_PATH] = true
   }
 
   const res = [0, name, message, type, params]
@@ -116,6 +119,11 @@ function createError(transaction, exception, config) {
 /**
  * Creates a structure for error event that is sent to the collector.
  * The error parameter is an output of the createError() function for a given exception.
+ *
+ * @param transaction
+ * @param error
+ * @param timestamp
+ * @param config
  */
 function createEvent(transaction, error, timestamp, config) {
   const message = error[2]
@@ -126,7 +134,7 @@ function createEvent(transaction, error, timestamp, config) {
     transaction,
     errorClass,
     message,
-    errorParams.intrinsics['error.expected'],
+    errorParams.intrinsics[ERROR_EXPECTED_PATH],
     timestamp,
     config
   )
@@ -136,9 +144,7 @@ function createEvent(transaction, error, timestamp, config) {
   const userAttributes = Object.assign(Object.create(null), errorParams.userAttributes)
   const agentAttributes = Object.assign(Object.create(null), errorParams.agentAttributes)
 
-  const errorEvent = [intrinsicAttributes, userAttributes, agentAttributes]
-
-  return errorEvent
+  return [intrinsicAttributes, userAttributes, agentAttributes]
 }
 
 // eslint-disable-next-line max-params

package/lib/grpc/connection.js

@@ -41,9 +41,9 @@ class GrpcConnection extends EventEmitter {
    * Standard property setting/initialization, and sets an initial
    * connection state of disconnected
    *
-   * @param {Object} traceObserverConfig config item config.infinite_tracing.trace_observer
+   * @param {object} traceObserverConfig config item config.infinite_tracing.trace_observer
    * @param {MetricAggregator} metrics metric aggregator, for supportability metrics
-   * @param {Number} [reconnectDelayMs=15000] number of milliseconds to wait before reconnecting
+   * @param {number} [reconnectDelayMs=15000] number of milliseconds to wait before reconnecting
    * for error states that require a reconnect delay.
    */
   constructor(traceObserverConfig, metrics, reconnectDelayMs) {
@@ -97,6 +97,7 @@ class GrpcConnection extends EventEmitter {
    *
    * @param {int} state The connection state (See connectionStates above)
    * @param {ClientDuplexStreamImpl} state The GRPC stream, when defined
+   * @param stream
    */
   _setState(state, stream = null) {
     this._state = state
@@ -146,6 +147,8 @@ class GrpcConnection extends EventEmitter {
    *
    * @param {string} licenseKey
    * @param {string} runId
+   * @param requestHeadersMap
+   * @param env
    */
   _getMetadata(licenseKey, runId, requestHeadersMap, env) {
     const metadata = new grpc.Metadata()
@@ -170,6 +173,7 @@ class GrpcConnection extends EventEmitter {
    * when appropriate env vars are set
    *
    * @param {Metadata} metadata
+   * @param env
    */
   _setTestMetadata(metadata, env) {
     for (const [key, envVar] of Object.entries(GRPC_TEST_META)) {
@@ -183,6 +187,7 @@ class GrpcConnection extends EventEmitter {
 
   /**
    * Disconnects from gRPC endpoint and schedules establishing a new connection.
+   *
    * @param {number} reconnectDelayMs number of milliseconds to wait before reconnecting.
    */
   _reconnect(reconnectDelayMs = 0) {
@@ -291,6 +296,8 @@ class GrpcConnection extends EventEmitter {
 
   /**
    * Creates the GRPC credentials needed
+   *
+   * @param grpcApi
    */
   _generateCredentials(grpcApi) {
     let certBuffer = null
@@ -349,6 +356,8 @@ class GrpcConnection extends EventEmitter {
    * ChannelImplementation and related objects will stay in memory even after
    * the stream is closed and we do not have a handle to the client. Currently
    * impacting grpc-js@1.2.11 and several earlier versions.
+   *
+   * @param endpoint
    */
   _createClient(endpoint) {
     logger.trace('Creating gRPC client for: ', endpoint)
@@ -360,9 +369,7 @@ class GrpcConnection extends EventEmitter {
     const traceApi = protoDescriptor.com.newrelic.trace.v1
 
     const credentials = this._generateCredentials(grpc)
-    const client = new traceApi.IngestService(endpoint, credentials)
-
-    return client
+    return new traceApi.IngestService(endpoint, credentials)
   }
 }
 

package/lib/header-attributes.js

@@ -139,7 +139,8 @@ function _collectHeaders(headers, nameMap, prefix, transaction) {
 
 /**
  * Adds request headers as request.headers.* attributes to the given transaction.
- * @param {Object.<string, string>} headers - Request headers to add attributes for.
+ *
+ * @param {Object<string, string>} headers - Request headers to add attributes for.
  * @param {Transaction} transaction - Transaction to add header attributes to.
  */
 function collectRequestHeaders(headers, transaction) {
@@ -148,7 +149,8 @@ function collectRequestHeaders(headers, transaction) {
 
 /**
  * Adds response headers as response.headers.* attributes to the given transaction.
- * @param {Object.<string, string>} headers - Response headers to add attributes for.
+ *
+ * @param {Object<string, string>} headers - Response headers to add attributes for.
  * @param {Transaction} transaction - Transaction to add header attributes to.
  */
 function collectResponseHeaders(headers, transaction) {

package/lib/header-processing.js

@@ -14,6 +14,7 @@ const CONTENT_LENGTH_REGEX = /^Content-Length$/i
  *
  * Queue time is provided by certain providers by stamping the request
  * header with the time the request arrived at the router.
+ *
  * @param {*} logger
  * @param {*} requestHeaders
  */
@@ -37,8 +38,7 @@ function getQueueTime(logger, requestHeaders) {
     return null
   }
 
-  const convertedQueueTime = convertUnit(parsedQueueTime)
-  return convertedQueueTime
+  return convertUnit(parsedQueueTime)
 }
 
 function convertUnit(time) {

package/lib/instrumentation/@hapi/hapi.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 68] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const record = require('../../metrics/recorders/generic')
 // This object defines all the events that we want to wrap extensions
 // for, as they are the only ones associated with requests.

package/lib/instrumentation/@node-redis/client.js

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/* eslint sonarjs/cognitive-complexity: ["error", 20] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 'use strict'
 const CLIENT_COMMANDS = ['select', 'quit', 'SELECT', 'QUIT']
 

package/lib/instrumentation/amqplib.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 16] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252*/
+
 const url = require('url')
 
 // TODO: Make this an external module.

package/lib/instrumentation/core/async_hooks.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 18] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const logger = require('../../logger').child({ component: 'async_hooks' })
 const asyncHooks = require('async_hooks')
 

package/lib/instrumentation/core/globals.js

@@ -38,14 +38,17 @@ function initialize(agent, nodule, name, shim) {
     return function wrappedEmit(ev, error, promise) {
       // Check for unhandledRejections here so we don't change the behavior of
       // the event.
-      if (ev === 'unhandledRejection' && error && !process.domain) {
-        if (process.listenerCount('unhandledRejection') === 0) {
-          // If there are no unhandledRejection handlers report the error.
-          const segment = promise[symbols.context] && promise[symbols.context].getSegment()
-          const tx = segment && segment.transaction
-          shim.logger.trace('Captured unhandled rejection for transaction %s', tx && tx.id)
-          agent.errors.add(tx, error)
-        }
+      if (
+        ev === 'unhandledRejection' &&
+        error &&
+        !process.domain &&
+        process.listenerCount('unhandledRejection') === 0
+      ) {
+        // If there are no unhandledRejection handlers report the error.
+        const segment = promise[symbols.context] && promise[symbols.context].getSegment()
+        const tx = segment && segment.transaction
+        shim.logger.trace('Captured unhandled rejection for transaction %s', tx && tx.id)
+        agent.errors.add(tx, error)
       }
 
       return original.apply(this, arguments)

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

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 40] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const recordExternal = require('../../metrics/recorders/http_external')
 const cat = require('../../util/cat')
 const urltils = require('../../util/urltils')
@@ -25,10 +27,10 @@ const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
 /**
  * Instruments an outbound HTTP request.
  *
- * @param {Agent} agent
- * @param {object} opts
- * @param {Function} makeRequest
- * @returns {http.ClientRequest} The instrumented outbound request.
+ * @param {object} agent instantiation of lib/agent.js
+ * @param {object} opts HTTP request options
+ * @param {Function} makeRequest function for issuing actual HTTP request
+ * @returns {object} The instrumented outbound HTTP request.
  */
 module.exports = function instrumentOutbound(agent, opts, makeRequest) {
   if (typeof opts === 'string') {
@@ -151,10 +153,10 @@ module.exports = function instrumentOutbound(agent, opts, makeRequest) {
  * Notices the given error if there is no listener for the `error` event on the
  * request object.
  *
- * @param {TraceSegment} segment
- * @param {http.ClientRequest} req
- * @param {Error} error
- * @returns {bool} True if the error will be collected by New Relic.
+ * @param {object} segment TraceSegment instance
+ * @param {object} req http.ClientRequest
+ * @param {Error} error If provided, unhandled error that occurred during request
+ * @returns {boolean} True if the error will be collected by New Relic.
  */
 function handleError(segment, req, error) {
   if (req.listenerCount('error') > 0) {
@@ -171,10 +173,10 @@ function handleError(segment, req, error) {
 /**
  * Ties the response object to the request segment.
  *
- * @param {TraceSegment} segment
- * @param {string} hostname
- * @param {http.ClientRequest} req
- * @param {http.IncomingMessage} res
+ * @param {object} segment TraceSegment instance
+ * @param {string} hostname host of the HTTP request
+ * @param {object} req http.ClientRequest
+ * @param {object} res http.IncomingMessage
  */
 function handleResponse(segment, hostname, req, res) {
   // Add response attributes for spans

package/lib/instrumentation/core/http.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 42] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const shimmer = require('../../shimmer')
 const logger = require('../../logger').child({ component: 'http' })
 const recordWeb = require('../../metrics/recorders/http')
@@ -243,10 +245,11 @@ function wrapResponseEnd(agent, proto) {
       }
 
       // If an error happened, add it to the aggregator.
-      if (txInfo.error) {
-        if (!txInfo.errorHandled || urltils.isError(agent.config, this.statusCode)) {
-          agent.errors.add(txInfo.transaction, txInfo.error)
-        }
+      if (
+        txInfo.error &&
+        (!txInfo.errorHandled || urltils.isError(agent.config, this.statusCode))
+      ) {
+        agent.errors.add(txInfo.transaction, txInfo.error)
       }
 
       // End all the segments leading up to and including this one.
@@ -479,8 +482,7 @@ module.exports = function initialize(agent, http, moduleName) {
           args[1] = agent.tracer.bindFunction(args[1], segment, true)
         }
 
-        const sock = agent.tracer.bindFunction(original, segment, true).apply(this, args)
-        return sock
+        return agent.tracer.bindFunction(original, segment, true).apply(this, args)
       }
     }
   )
@@ -494,7 +496,7 @@ module.exports = function initialize(agent, http, moduleName) {
  * @param {string} header - The raw X-NewRelic-Synthetics header
  * @param {string} encKey - Encoding key handed down from the server
  * @param {Array.<number>} trustedIds - Array of accounts to trust the header from.
- * @param {Transaction} transaction - Where the synthetics data is attached to.
+ * @param {object} transaction - Where the synthetics data is attached to.
  */
 function handleSyntheticsHeader(header, encKey, trustedIds, transaction) {
   const synthData = parseSyntheticsHeader(header, encKey, trustedIds)
@@ -512,7 +514,7 @@ function handleSyntheticsHeader(header, encKey, trustedIds, transaction) {
  * @param {string} header - The raw X-NewRelic-Synthetics header
  * @param {string} encKey - Encoding key handed down from the server
  * @param {Array.<number>} trustedIds - Array of accounts to trust the header from.
- * @return {Object|null} - On successful parse and verification an object of
+ * @returns {object | null} - On successful parse and verification an object of
  *                            synthetics data is returned, otherwise null is
  *                            returned.
  */

package/lib/instrumentation/core/timers.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 16] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const symbols = require('../../symbols')
 
 module.exports = initialize

package/lib/instrumentation/fastify.js

@@ -148,9 +148,7 @@ function wrapMiddleware(shim, middleware, name, route) {
   const segmentName = `onRequest/${name}`
   const spec = buildMiddlewareSpecForMiddlewareFunction(shim, segmentName, route)
 
-  const newMiddlewareFunction = shim.recordMiddleware(middleware, spec)
-
-  return newMiddlewareFunction
+  return shim.recordMiddleware(middleware, spec)
 }
 
 /**

package/lib/instrumentation/grpc-js/grpc.js

@@ -78,8 +78,10 @@ function wrapStart(shim, original) {
         segment.addAttribute('grpc.statusCode', code)
         segment.addAttribute('grpc.statusText', details)
 
-        if (code !== 0 && shim.agent.config.grpc.record_errors) {
-          // this is currently just creating an error from the details string
+        const agent = shim.agent
+        const config = agent.config
+
+        if (shouldTrackError(code, config)) {
           shim.agent.errors.add(segment.transaction, details)
         }
 
@@ -184,9 +186,10 @@ function wrapRegister(shim, original) {
 
     function instrumentEventListeners(stream, transaction) {
       const agent = shim.agent
+      const config = agent.config
       stream.call.once('callEnd', (statusCode) => {
         transaction.trace.attributes.addAttribute(DESTINATION, 'response.status', statusCode)
-        if (statusCode !== 0 && agent.config.grpc.record_errors) {
+        if (shouldTrackError(statusCode, config)) {
           const status = constants.Status[statusCode]
           const error = new Error(`gRPC status code ${statusCode}: ${status}`)
           agent.errors.add(transaction, error)
@@ -202,6 +205,14 @@ function wrapRegister(shim, original) {
   }
 }
 
+function shouldTrackError(statusCode, config) {
+  return (
+    statusCode > 0 &&
+    config.grpc.record_errors &&
+    !config.grpc.ignore_status_codes.includes(statusCode)
+  )
+}
+
 module.exports = function instrument(shim) {
   const genericShim = shim.makeSpecializedShim(shim.GENERIC, 'call-stream')
   const callStream = genericShim.require('./build/src/call-stream')

package/lib/instrumentation/memcached.js

@@ -21,6 +21,11 @@ function wrapKeys(metacall) {
  * Thanks to Hernan Silberman!
  *
  * instrument the memcached driver to intercept calls and keep stats on them.
+ *
+ * @param agent
+ * @param memcached
+ * @param moduleName
+ * @param shim
  */
 module.exports = function initialize(agent, memcached, moduleName, shim) {
   const proto = memcached && memcached.prototype

package/lib/instrumentation/mongodb/common.js

@@ -4,6 +4,9 @@
  */
 
 'use strict'
+
+/* eslint sonarjs/cognitive-complexity: ["error", 18] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const { CURSOR_OPS, COLLECTION_OPS, DB_OPS } = require('./constants')
 const common = module.exports
 common.NR_ATTRS = Symbol('NR_ATTRS')

package/lib/instrumentation/mongodb/v2-mongo.js

@@ -11,7 +11,7 @@ const { captureAttributesOnStarted, makeQueryDescFunc } = require('./common')
  * parser used to grab the collection and operation
  * from a running query
  *
- * @param {Object} operation
+ * @param {object} operation
  */
 function queryParser(operation) {
   let collection = this.collectionName || 'unknown'
@@ -29,7 +29,7 @@ function queryParser(operation) {
  * add necessary attributes to segments
  *
  * @param {Shim} shim
- * @param {Object} mongodb resolved package
+ * @param {object} mongodb resolved package
  */
 module.exports = function instrument(shim, mongodb) {
   shim.setParser(queryParser)
@@ -65,6 +65,9 @@ module.exports = function instrument(shim, mongodb) {
    * Iterate over permutations and properly
    * wrap depending on the `recordDesc` above
    * See: https://github.com/mongodb/node-mongodb-native/blob/v3.0.5/lib/collection.js#L384
+   *
+   * @param _
+   * @param modules
    */
   function instrumentModules(_, modules) {
     modules.forEach((module) => {
@@ -80,7 +83,7 @@ module.exports = function instrument(shim, mongodb) {
    * if it needs to be wrapped as an operation or query
    *
    * @param {string} objectName name of class getting instrumented
-   * @param {Object} object reference to the class getting instrumented
+   * @param {object} object reference to the class getting instrumented
    * @param {Define} meta describes the methods and if they are callbacks
    * promises, and return values
    */

package/lib/instrumentation/mongodb.js

@@ -25,7 +25,7 @@ module.exports = initialize
  * based on version of mongodb
  *
  * @param {Agent} agent
- * @param {Object} mongodb resolved package
+ * @param {object} mongodb resolved package
  * @param {string} moduleName name of module
  * @param {Shim} shim
  */

package/lib/instrumentation/nr-winston-transport.js

@@ -36,7 +36,7 @@ class NrTransport extends TransportStream {
    */
   log(logLine, callback) {
     const metadata = this.agent.getLinkingMetadata()
-    const formattedLine = reformatLogLine(logLine, metadata, this.agent)
+    const formattedLine = reformatLogLine(logLine, metadata)
     this.agent.logs.add(formattedLine)
     callback()
   }
@@ -52,10 +52,9 @@ module.exports = NrTransport
  *
  * @param {object} logLine log line
  * @param {object} metadata linking metadata
- * @param {object} agent NR agent
  * @returns {object} copy of log line with NR linking metadata
  */
-function reformatLogLine(logLine, metadata, agent) {
+function reformatLogLine(logLine, metadata) {
   // Add the metadata to a copy of the logLine
   const formattedLine = Object.assign({}, logLine, metadata)
 
@@ -63,7 +62,7 @@ function reformatLogLine(logLine, metadata, agent) {
     reformatError(formattedLine)
   }
 
-  reformatTimestamp(formattedLine, agent)
+  reformatTimestamp(formattedLine)
 
   return formattedLine
 }

package/lib/instrumentation/promise.js

@@ -5,10 +5,13 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 101] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const util = require('util')
 const properties = require('../util/properties')
 const shimmer = require('../shimmer')
 const symbols = require('../symbols')
+const ANONYMOUS = '<anonymous>'
 
 /**
  * @namespace Library.Spec
@@ -144,7 +147,7 @@ module.exports = function initialize(agent, library, spec) {
       cnstrctArgs.unshift(Promise) // `unshift` === `push_front`
       promise = new (Promise.bind.apply(Promise, cnstrctArgs))()
     } else {
-      const segmentName = 'Promise ' + (executor.name || '<anonymous>')
+      const segmentName = 'Promise ' + (executor.name || ANONYMOUS)
       const context = {
         promise: null,
         self: null,
@@ -215,12 +218,12 @@ module.exports = function initialize(agent, library, spec) {
         args: null
       }
       if (!this[symbols.context]) {
-        const segmentName = 'Promise ' + executor.name || '<anonymous>'
+        const segmentName = 'Promise ' + executor.name || ANONYMOUS
         const segment = _createSegment(segmentName)
         Contextualizer.link(null, this, segment, spec.useFinally)
       }
       const args = [].slice.call(arguments)
-      args[0] = wrapExecutorContext(context, this[symbols.context].getSegment())
+      args[0] = wrapExecutorContext(context)
       const ret = caller.apply(this, args)
 
       // Bluebird catches executor errors and auto-rejects when it catches them,
@@ -339,7 +342,7 @@ module.exports = function initialize(agent, library, spec) {
           }
 
           let promSegment = next[symbols.context].getSegment()
-          const segmentName = segmentNamePrefix + (fn.name || '<anonymous>')
+          const segmentName = segmentNamePrefix + (fn.name || ANONYMOUS)
           const segment = _createSegment(segmentName, promSegment)
           if (segment && segment !== promSegment) {
             next[symbols.context].setSegment(segment)

package/lib/instrumentation/redis.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 52] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const hasOwnProperty = require('../util/properties').hasOwn
 const stringify = require('json-stringify-safe')
 

package/lib/instrumentation/undici.js

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

package/lib/metrics/mapper.js

@@ -67,9 +67,8 @@ MetricMapper.prototype.load = function load(raw) {
 }
 
 /**
- * @param {String} name  The metric name.
- * @param {String} scope The scope for the metric, if set.
- *
+ * @param {string} name  The metric name.
+ * @param {string} scope The scope for the metric, if set.
  * @returns {object} Either a metric spec based on the parameters, or the
  *                   server-sent ID.
  */

package/lib/metrics/metric-aggregator.js

@@ -43,9 +43,7 @@ class MetricAggregator extends Aggregator {
     const beginSeconds = this._metrics.started * FROM_MILLIS
     const endSeconds = Date.now() * FROM_MILLIS
 
-    const payload = [this.runId, beginSeconds, endSeconds, this._metrics.toJSON()]
-
-    return payload
+    return [this.runId, beginSeconds, endSeconds, this._metrics.toJSON()]
   }
 
   _getMergeData() {