newrelic 9.6.0 → 9.7.0

package/lib/shim/index.js

@@ -24,6 +24,13 @@ SHIM_TYPE_MAP[constants.MODULE_TYPE.PROMISE] = PromiseShim
 SHIM_TYPE_MAP[constants.MODULE_TYPE.TRANSACTION] = TransactionShim
 SHIM_TYPE_MAP[constants.MODULE_TYPE.WEB_FRAMEWORK] = WebFrameworkShim
 
+/**
+ *
+ * @param type
+ * @param agent
+ * @param moduleName
+ * @param resolvedName
+ */
 function createShimFromType(type, agent, moduleName, resolvedName) {
   let shim = null
   if (properties.hasOwn(SHIM_TYPE_MAP, type)) {

package/lib/shim/message-shim.js

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

package/lib/shim/promise-shim.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 30] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const logger = require('../logger').child({ component: 'PromiseShim' })
 const Shim = require('./shim')
 const symbols = require('../symbols')
@@ -12,7 +14,7 @@ const symbols = require('../symbols')
 /**
  * A helper class for wrapping promise modules.
  *
- * @extends Shim
+ * @augments Shim
  */
 /* eslint-disable camelcase */
 class PromiseShim extends Shim {
@@ -22,13 +24,10 @@ class PromiseShim extends Shim {
    *
    * @param {Agent} agent
    *  The agent this shim will use.
-   *
    * @param {string} moduleName
    *  The name of the module being instrumented.
-   *
    * @param {string} resolvedName
    *  The full path to the loaded module.
-   *
    * @see Shim
    */
   constructor(agent, moduleName, resolvedName) {
@@ -50,7 +49,7 @@ class PromiseShim extends Shim {
   /**
    * Sets the class used to identify promises from the wrapped promise library.
    *
-   * @param {function} clss - The promise library's class.
+   * @param {Function} clss - The promise library's class.
    */
   setClass(clss) {
     this._class = clss
@@ -61,10 +60,8 @@ class PromiseShim extends Shim {
    * library being wrapped.
    *
    * @param {*} obj - The object to check the instance type of.
-   *
-   * @return {bool} True if the provided object is an instance of a promise from
+   * @returns {bool} True if the provided object is an instance of a promise from
    *  this promise library.
-   *
    * @see PromiseShim#setClass
    */
   isPromiseInstance(obj) {
@@ -83,16 +80,13 @@ class PromiseShim extends Shim {
    * better to wrap that using {@link PromiseShim#wrapExecutorCaller} than to
    * use this method.
    *
-   * @param {object|function} nodule
+   * @param {object | Function} nodule
    *  The source of the properties to wrap, or a single function to wrap.
-   *
-   * @param {string|array.<string>} [properties]
+   * @param {string | Array.<string>} [properties]
    *  One or more properties to wrap. If omitted, the `nodule` parameter is
    *  assumed to be the constructor to wrap.
-   *
-   * @return {object|function} The first parameter to this function, after
+   * @returns {object | Function} The first parameter to this function, after
    *  wrapping it or its properties.
-   *
    * @see PromiseShim#wrapExecutorCaller
    */
   wrapConstructor(nodule, properties) {
@@ -136,16 +130,13 @@ class PromiseShim extends Shim {
    * Wrapping the executor caller method directly is preferable to wrapping
    * the constructor of the promise class.
    *
-   * @param {object|function} nodule
+   * @param {object | Function} nodule
    *  The source of the properties to wrap, or a single function to wrap.
-   *
-   * @param {string|array.<string>} [properties]
+   * @param {string | Array.<string>} [properties]
    *  One or more properties to wrap. If omitted, the `nodule` parameter is
    *  assumed to be the function to wrap.
-   *
-   * @return {object|function} The first parameter to this function, after
+   * @returns {object | Function} The first parameter to this function, after
    *  wrapping it or its properties.
-   *
    * @see PromiseShim#wrapConstructor
    */
   wrapExecutorCaller(nodule, properties) {
@@ -197,14 +188,12 @@ class PromiseShim extends Shim {
    * and Bluebird's `Promise.delay`. These are static methods which accept some
    * arbitrary value and return a Promise instance.
    *
-   * @param {object|function} nodule
+   * @param {object | Function} nodule
    *  The source of the properties to wrap, or a single function to wrap.
-   *
-   * @param {string|array.<string>} [properties]
+   * @param {string | Array.<string>} [properties]
    *  One or more properties to wrap. If omitted, the `nodule` parameter is
    *  assumed to be the function to wrap.
-   *
-   * @return {object|function} The first parameter to this function, after
+   * @returns {object | Function} The first parameter to this function, after
    *  wrapping it or its properties.
    */
   wrapCast(nodule, properties) {
@@ -236,16 +225,13 @@ class PromiseShim extends Shim {
    * and Bluebird's `Promise#map`. These are methods which take a function to
    * execute once the promise resolves and hands back a new promise.
    *
-   * @param {object|function} nodule
+   * @param {object | Function} nodule
    *  The source of the properties to wrap, or a single function to wrap.
-   *
-   * @param {string|array.<string>} [properties]
+   * @param {string | Array.<string>} [properties]
    *  One or more properties to wrap. If omitted, the `nodule` parameter is
    *  assumed to be the function to wrap.
-   *
-   * @return {object|function} The first parameter to this function, after
+   * @returns {object | Function} The first parameter to this function, after
    *  wrapping it or its properties.
-   *
    * @see PromiseShim#setClass
    * @see PromiseShim#wrapCatch
    */
@@ -266,16 +252,13 @@ class PromiseShim extends Shim {
    * an additional argument to `Promise#catch` which is usually an error class
    * to filter rejections by. This wrap method will handle that case.
    *
-   * @param {object|function} nodule
+   * @param {object | Function} nodule
    *  The source of the properties to wrap, or a single function to wrap.
-   *
-   * @param {string|array.<string>} [properties]
+   * @param {string | Array.<string>} [properties]
    *  One or more properties to wrap. If omitted, the `nodule` parameter is
    *  assumed to be the function to wrap.
-   *
-   * @return {object|function} The first parameter to this function, after
+   * @returns {object | Function} The first parameter to this function, after
    *  wrapping it or its properties.
-   *
    * @see PromiseShim#setClass
    * @see PromiseShim#wrapThen
    */
@@ -289,14 +272,12 @@ class PromiseShim extends Shim {
    * - `wrapPromisify(nodule, properties)`
    * - `wrapPromisify(func)`
    *
-   * @param {object|function} nodule
+   * @param {object | Function} nodule
    *  The source of the properties to wrap, or a single function to wrap.
-   *
-   * @param {string|array.<string>} [properties]
+   * @param {string | Array.<string>} [properties]
    *  One or more properties to wrap. If omitted, the `nodule` parameter is
    *  assumed to be the function to wrap.
-   *
-   * @return {object|function} The first parameter to this function, after
+   * @returns {object | Function} The first parameter to this function, after
    *  wrapping it or its properties.
    */
   wrapPromisify(nodule, properties) {
@@ -316,6 +297,9 @@ class PromiseShim extends Shim {
         })
 
         return __NR_wrappedPromisified
+        /**
+         *
+         */
         function __NR_wrappedPromisified() {
           const segment = shim.getActiveSegment()
           if (!segment) {
@@ -335,6 +319,8 @@ module.exports = PromiseShim
 // -------------------------------------------------------------------------- //
 
 /**
+ * @param shim
+ * @param args
  * @private
  */
 function _wrapExecutorContext(shim, args) {
@@ -347,6 +333,11 @@ function _wrapExecutorContext(shim, args) {
   contextExporter[symbols.executorContext] = context
   args[0] = contextExporter
 
+  /**
+   *
+   * @param resolve
+   * @param reject
+   */
   function contextExporter(resolve, reject) {
     context.self = this
     context.args = shim.argsToArray.apply(shim, arguments)
@@ -356,6 +347,8 @@ function _wrapExecutorContext(shim, args) {
 }
 
 /**
+ * @param context
+ * @param fn
  * @private
  */
 function _wrapResolver(context, fn) {
@@ -369,6 +362,10 @@ function _wrapResolver(context, fn) {
 }
 
 /**
+ * @param shim
+ * @param fn
+ * @param name
+ * @param useAllParams
  * @private
  */
 function _wrapThen(shim, fn, name, useAllParams) {
@@ -399,6 +396,12 @@ function _wrapThen(shim, fn, name, useAllParams) {
     }
     return next
 
+    /**
+     *
+     * @param handler
+     * @param i
+     * @param length
+     */
     function wrapHandler(handler, i, length) {
       if (
         !shim.isFunction(handler) || // Not a function
@@ -566,6 +569,9 @@ class Contextualizer {
       }
     )
 
+    /**
+     *
+     */
     function __NR_continueContext() {
       self.setSegment(nextContext.getSegment())
     }

package/lib/shim/shim.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 59] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const arity = require('../util/arity')
 const hasOwnProperty = require('../util/properties').hasOwn
 const logger = require('../logger').child({ component: 'Shim' })
@@ -348,7 +350,7 @@ Shim.prototype[symbols.unwrap] = unwrapAll
  *    segment = shim.createSegment(seg.name, seg.recorder, seg.parent)
  *  }
  *  ```
- * @property {object.<string, *>} $cache
+ * @property {Object<string, *>} $cache
  *  Adds the value as an extra parameter to all specs in the same context as the
  *  cache. If the current context is a function, the cache will be recreated on
  *  each invocation of the function. This value can be useful for passing a
@@ -466,7 +468,7 @@ function execute(nodule, spec) {
   if (this.isFunction(spec)) {
     spec(this, nodule)
   } else {
-    _specToFunction(spec)(this, nodule)
+    _specToFunction(spec)
   }
 }
 
@@ -595,7 +597,7 @@ function wrapReturn(nodule, properties, spec, args) {
     properties = null
   }
   if (!this.isFunction(spec)) {
-    spec = _specToFunction(spec)
+    _specToFunction(spec)
   }
   if (!this.isArray(args)) {
     args = []
@@ -1105,7 +1107,7 @@ function bindSegment(nodule, property, segment, full) {
     return nodule
   }
 
-  const wrapped = this.wrap(nodule, property, function wrapFunc(shim, func) {
+  return this.wrap(nodule, property, function wrapFunc(shim, func) {
     if (!shim.isFunction(func)) {
       return func
     }
@@ -1120,8 +1122,6 @@ function bindSegment(nodule, property, segment, full) {
     shim.storeSegment(binder, segment)
     return binder
   })
-
-  return wrapped
 }
 
 /**
@@ -1300,7 +1300,7 @@ function applySegment(func, segment, full, context, args, inContextCB) {
   const contextManager = this._contextManager
   const prevSegment = contextManager.getContext()
 
-  return contextManager.runInContext(segment, () => {
+  return contextManager.runInContext(segment, function runInContextCb() {
     if (full) {
       segment.start()
     }

package/lib/shim/webframework-shim.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 69] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const genericRecorder = require('../metrics/recorders/generic')
 const logger = require('../logger.js').child({ component: 'WebFrameworkShim' })
 const metrics = require('../metrics/names')

package/lib/spans/map-to-streaming-type.js

@@ -42,8 +42,6 @@ function mapToStreamingType(value) {
       [protoTypeString]: value
     }
   }
-
-  return
 }
 
 module.exports = mapToStreamingType

package/lib/spans/span-context.js

@@ -40,6 +40,8 @@ class SpanContext {
    * ends with an ignored error status code.
    *
    * Last error wins.
+   *
+   * @param details
    */
   setError(details) {
     this.hasError = true

package/lib/spans/span-event-aggregator.js

@@ -63,8 +63,8 @@ class SpanEventAggregator extends EventAggregator {
    *
    * @param {TraceSegment}  segment         - The segment to add.
    * @param {string}        [parentId=null] - The GUID of the parent span.
-   *
-   * @return {boolean} True if the segment was added, or false if it was discarded.
+   * @param isRoot
+   * @returns {boolean} True if the segment was added, or false if it was discarded.
    */
   addSegment(segment, parentId, isRoot) {
     // Check if the priority would be accepted before creating the event object.

package/lib/spans/span-event.js

@@ -83,8 +83,8 @@ class SpanEvent {
    *
    * @param {TraceSegment}  segment         - The segment to turn into a span event.
    * @param {?string}       [parentId=null] - The ID of the segment's parent.
-   *
-   * @return {SpanEvent} The constructed event.
+   * @param isRoot
+   * @returns {SpanEvent} The constructed event.
    */
   static fromSegment(segment, parentId = null, isRoot = false) {
     const spanContext = segment.getSpanContext()

package/lib/spans/span-streamer.js

@@ -83,6 +83,8 @@ class SpanStreamer {
    *  Sends the span over the stream. Spans are only sent here if the stream is
    *  in a writable state. If the stream becomes unwritable after sending the
    *  span, a drain event handler is setup to continue writing when possible.
+   *
+   * @param span
    */
   send(span) {
     // false indicates the stream has reached the highWaterMark
@@ -104,6 +106,8 @@ class SpanStreamer {
    *  initially blocked, used to time how long the stream was blocked. If this
    *  is not defined, it is assumed this is being called after a reconnect,
    *  and the metric is not used.
+   *
+   * @param waitDrainStart
    */
   drain(waitDrainStart) {
     // Metric can be used to see how frequently completing drains as well as

package/lib/spans/streaming-span-event-aggregator.js

@@ -60,8 +60,6 @@ class StreamingSpanEventAggregator extends Aggregator {
     }
 
     this.emit(`finished ${this.method} data send.`)
-
-    return
   }
 
   /**
@@ -78,8 +76,8 @@ class StreamingSpanEventAggregator extends Aggregator {
    *
    * @param {TraceSegment}  segment         - The segment to add.
    * @param {string}        [parentId=null] - The GUID of the parent span.
-   *
-   * @return {bool} True if the segment was added, or false if it was discarded.
+   * @param isRoot
+   * @returns {bool} True if the segment was added, or false if it was discarded.
    */
   addSegment(segment, parentId, isRoot) {
     if (!this.started) {

package/lib/spans/streaming-span-event.js

@@ -61,6 +61,7 @@ class StreamingSpanEvent {
 
   /**
    * Add a key/value pair to the Span's custom/user attributes collection.
+   *
    * @param {string} key Name of the attribute to be stored.
    * @param {string|boolean|number} value Value of the attribute to be stored.
    * @param {boolean} [truncateExempt=false] Set to true if attribute should not be truncated.
@@ -75,6 +76,7 @@ class StreamingSpanEvent {
 
   /**
    * Add a key/value pair to the Span's agent attributes collection.
+   *
    * @param {string} key Name of the attribute to be stored.
    * @param {string|boolean|number} value Value of the attribute to be stored.
    * @param {boolean} [truncateExempt=false] Set to true if attribute should not be truncated.
@@ -95,13 +97,12 @@ class StreamingSpanEvent {
 
   toStreamingFormat() {
     // Attributes are pre-formatted.
-    const formatted = {
+    return {
       trace_id: this._traceId,
       intrinsics: this._intrinsicAttributes,
       user_attributes: this._customAttributes,
       agent_attributes: this._agentAttributes
     }
-    return formatted
   }
 
   static fromSegment(segment, parentId = null, isRoot = false) {

package/lib/system-info.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 29] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const exec = require('child_process').exec
 const readProc = require('./utilization/common').readProc
 const getBootId = require('./utilization/docker-info').getBootId
@@ -173,11 +175,7 @@ module.exports._getMemoryStats = function getMemoryStats(callback) {
 }
 
 function getKernelVersion(callback) {
-  if (platform.match(/darwin/i)) {
-    getSysctlValue(['kern.version'], function getMem(version) {
-      callback(version)
-    })
-  } else if (platform.match(/bsd/i)) {
+  if (platform.match(/darwin/i) || platform.match(/bsd/i)) {
     getSysctlValue(['kern.version'], function getMem(version) {
       callback(version)
     })

package/lib/timer.js

@@ -6,7 +6,7 @@
 'use strict'
 
 /**
-
+ 
  * Explicit enumeration of the states a transaction can be in:
  *
  * PENDING upon instantiation (implicitly, no start time set)
@@ -106,21 +106,21 @@ Timer.prototype.softEnd = function softEnd() {
 }
 
 /**
- * @return {bool} Is this timer currently running?
+ * @returns {bool} Is this timer currently running?
  */
 Timer.prototype.isRunning = function isRunning() {
   return this.state === RUNNING
 }
 
 /**
- * @return {bool} Is this timer still alive?
+ * @returns {bool} Is this timer still alive?
  */
 Timer.prototype.isActive = function isActive() {
   return this.state < STOPPED
 }
 
 /**
- * @return {bool} Has the timer been touched or ended?
+ * @returns {bool} Has the timer been touched or ended?
  */
 Timer.prototype.hasEnd = function hasEnd() {
   return !!this.hrDuration
@@ -192,7 +192,7 @@ Timer.prototype.getDurationInMillis = function getDurationInMillis() {
 /**
  * Get a single object containing the interval this timer was active.
  *
- * @return {Array} 2-tuple of start time in milliseconds, end time in
+ * @returns {Array} 2-tuple of start time in milliseconds, end time in
  *                 milliseconds.
  */
 Timer.prototype.toRange = function toRange() {
@@ -205,7 +205,7 @@ Timer.prototype.toRange = function toRange() {
  * milliseconds since start.
  *
  * @param {Timer} other The point relative to which this timer started.
- * @return {number} The offset in (floating-point) milliseconds.
+ * @returns {number} The offset in (floating-point) milliseconds.
  */
 Timer.prototype.startedRelativeTo = function startedRelativeTo(other) {
   if (this.hrstart && other.hrstart) {
@@ -220,6 +220,8 @@ Timer.prototype.startedRelativeTo = function startedRelativeTo(other) {
 
 /**
  * Returns true if this timer ends after the other.
+ *
+ * @param other
  */
 Timer.prototype.endsAfter = function compare(other) {
   return this.getDurationInMillis() + this.start > other.getDurationInMillis() + other.start

package/lib/transaction/dt-payload.js

@@ -15,7 +15,8 @@ module.exports = class DistributedTracePayload {
    * The class responsible for producing distributed trace payloads.
    * Created by calling {@link TransactionHandle#_createDistributedTracePayload}.
    *
-   * @constructor
+   * @param payload
+   * @class
    */
   constructor(payload) {
     logger.trace('DistributedTracePayload created with %s', payload)
@@ -27,7 +28,7 @@ module.exports = class DistributedTracePayload {
   }
 
   /**
-   * @returns {String} The base64 encoded JSON representation of the
+   * @returns {string} The base64 encoded JSON representation of the
    * distributed trace payload.
    */
   text() {
@@ -38,7 +39,7 @@ module.exports = class DistributedTracePayload {
   /**
    * Construct a payload suitable for HTTP transport.
    *
-   * @returns {String} The base64 encoded JSON representation of the
+   * @returns {string} The base64 encoded JSON representation of the
    * distributed trace payload.
    */
   httpSafe() {

package/lib/transaction/handle.js

@@ -14,7 +14,9 @@ class TransactionHandle {
    * A light representation of a transaction instance, returned by calling
    * {@link API#getTransaction}.
    *
-   * @constructor
+   * @param transaction
+   * @param metrics
+   * @class
    */
   constructor(transaction, metrics) {
     this._transaction = transaction
@@ -54,7 +56,9 @@ class TransactionHandle {
    * Parsing incoming headers for use in a distributed trace.
    * W3C TraceContext format is preferred over the NewRelic DT format.
    * NewRelic DT format will be used if no `traceparent` header is found.
+   *
    * @param @param {string} [transportType='Unknown'] - The transport type that delivered the trace.
+   * @param transportType
    * @param {object} headers - Headers to search for supported formats. Keys must be lowercase.
    */
   acceptDistributedTraceHeaders(transportType, headers) {
@@ -64,7 +68,8 @@ class TransactionHandle {
 
   /**
    * Inserts distributed trace headers into the provided headers map.
-   * @param {Object} headers
+   *
+   * @param {object} headers
    */
   insertDistributedTraceHeaders(headers) {
     incrementApiSupportMetric(this._metrics, 'insertDistributedTraceHeaders')
@@ -74,6 +79,11 @@ class TransactionHandle {
 
 module.exports = TransactionHandle
 
+/**
+ *
+ * @param metrics
+ * @param functionName
+ */
 function incrementApiSupportMetric(metrics, functionName) {
   if (!metrics) {
     logger.warnOnce(