newrelic 7.5.2 → 8.3.0

package/lib/shim/promise-shim.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-const logger = require('../logger').child({component: 'PromiseShim'})
+const logger = require('../logger').child({ component: 'PromiseShim' })
 const Shim = require('./shim')
 
 /**
@@ -13,6 +13,7 @@ const Shim = require('./shim')
  *
  * @extends Shim
  */
+/* eslint-disable camelcase */
 class PromiseShim extends Shim {
   /**
    * Constructs a shim associated with the given agent instance, specialized for
@@ -31,7 +32,7 @@ class PromiseShim extends Shim {
    */
   constructor(agent, moduleName, resolvedName) {
     super(agent, moduleName, resolvedName)
-    this._logger = logger.child({module: moduleName})
+    this._logger = logger.child({ module: moduleName })
     this._class = null
   }
 
@@ -399,9 +400,9 @@ function _wrapThen(shim, fn, name, useAllParams) {
 
     function wrapHandler(handler, i, length) {
       if (
-        !shim.isFunction(handler) ||          // Not a function
-        shim.isWrapped(handler)   ||          // Already wrapped
-        (!useAllParams && i !== (length - 1)) // Don't want all and not last
+        !shim.isFunction(handler) || // Not a function
+        shim.isWrapped(handler) || // Already wrapped
+        (!useAllParams && i !== length - 1) // Don't want all and not last
       ) {
         isWrapped = shim.isWrapped(handler)
         return handler
@@ -532,7 +533,7 @@ class Contextualizer {
   }
 
   setSegment(segment) {
-    return this.context.segments[this.idx] = segment
+    return (this.context.segments[this.idx] = segment)
   }
 
   toJSON() {
@@ -553,16 +554,20 @@ class Contextualizer {
 
     // No `finally` means we need to hook into resolve and reject individually and
     // pass through whatever happened.
-    return prom.then(function __NR_thenContext(val) {
-      __NR_continueContext()
-      return val
-    }, function __NR_catchContext(err) {
-      __NR_continueContext()
-      throw err // Re-throwing promise rejection, this is not New Relic's error.
-    })
+    return prom.then(
+      function __NR_thenContext(val) {
+        __NR_continueContext()
+        return val
+      },
+      function __NR_catchContext(err) {
+        __NR_continueContext()
+        throw err // Re-throwing promise rejection, this is not New Relic's error.
+      }
+    )
 
     function __NR_continueContext() {
       self.setSegment(nextContext.getSegment())
     }
   }
 }
+/* eslint-enable camelcase */

package/lib/shim/shim.js

@@ -8,7 +8,7 @@
 const arity = require('../util/arity')
 const constants = require('./constants')
 const hasOwnProperty = require('../util/properties').hasOwn
-const logger = require('../logger').child({component: 'Shim'})
+const logger = require('../logger').child({ component: 'Shim' })
 const path = require('path')
 const specs = require('./specs')
 const util = require('util')
@@ -33,7 +33,7 @@ function Shim(agent, moduleName, resolvedName) {
     throw new Error('Shim must be initialized with an agent and module name.')
   }
 
-  this._logger = logger.child({module: moduleName})
+  this._logger = logger.child({ module: moduleName })
   this._agent = agent
   this._toExport = null
   this._debug = false
@@ -593,7 +593,7 @@ function wrap(nodule, properties, spec, args) {
   }
 
   // TODO: Add option for omitting __NR_original; unwrappable: false
-  spec = this.setDefaults(spec, {matchArity: false})
+  spec = this.setDefaults(spec, { matchArity: false })
 
   // If we're just wrapping one thing, just wrap it and return.
   if (properties == null) {
@@ -794,7 +794,7 @@ function wrapClass(nodule, properties, spec, args) {
     properties = null
   }
   if (this.isFunction(spec)) {
-    spec = {pre: null, post: spec}
+    spec = { pre: null, post: spec }
   } else {
     spec.pre = spec.pre || null
     spec.post = spec.post || null
@@ -812,9 +812,7 @@ function wrapClass(nodule, properties, spec, args) {
 
     // When es6 classes are being wrapped, we need to use an es6 class due to
     // the fact our es5 wrapper depends on calling the constructor without `new`.
-    var wrapper = spec.es6 || /^class /.test(Base.toString())
-      ? _es6WrapClass
-      : _es5WrapClass
+    var wrapper = spec.es6 || /^class /.test(Base.toString()) ? _es6WrapClass : _es5WrapClass
 
     return wrapper(shim, Base, fnName, spec, args)
   })
@@ -837,7 +835,7 @@ function wrapClass(nodule, properties, spec, args) {
  * @return {*} The return value from `spec`.
  */
 function wrapExport(nodule, spec) {
-  return this._toExport = this.wrap(nodule, null, spec)
+  return (this._toExport = this.wrap(nodule, null, spec))
 }
 
 /**
@@ -950,10 +948,7 @@ function record(nodule, properties, recordNamer) {
         return fnApply.call(fn, this, arguments)
       }
 
-      if (
-        segDesc.callbackRequired &&
-        !_hasValidCallbackArg(shim, args, segDesc.callback)
-      ) {
+      if (segDesc.callbackRequired && !_hasValidCallbackArg(shim, args, segDesc.callback)) {
         return fnApply.call(fn, this, arguments)
       }
 
@@ -961,7 +956,8 @@ function record(nodule, properties, recordNamer) {
       //  - We are _not_ making an internal segment.
       //  - OR the parent segment is either not internal or not from this shim.
       var shouldCreateSegment = !(
-        parent.opaque || (segDesc.internal && parent.internal && shim === parent.shim)
+        parent.opaque ||
+        (segDesc.internal && parent.internal && shim === parent.shim)
       )
 
       var segment = shouldCreateSegment ? _rawCreateSegment(shim, segDesc) : parent
@@ -1019,15 +1015,18 @@ function record(nodule, properties, recordNamer) {
         ret = shim.applySegment(fn, segment, true, ctx, args, segDesc.inContext)
         if (segDesc.after && segDesc.promise && shim.isPromise(ret)) {
           promised = true
-          return ret.then(function onThen(val) {
-            segment.touch()
-            segDesc.after(shim, fn, name, null, val)
-            return val
-          }, function onCatch(err) {
-            segment.touch()
-            segDesc.after(shim, fn, name, err, null)
-            throw err // NOTE: This is not an error from our instrumentation.
-          })
+          return ret.then(
+            function onThen(val) {
+              segment.touch()
+              segDesc.after(shim, fn, name, null, val)
+              return val
+            },
+            function onCatch(err) {
+              segment.touch()
+              segDesc.after(shim, fn, name, err, null)
+              throw err // NOTE: This is not an error from our instrumentation.
+            }
+          )
         }
         return ret
       } catch (err) {
@@ -1199,7 +1198,7 @@ function bindSegment(nodule, property, segment, full) {
   // segment is `null`, and thus `true` (the full param) is detected as the
   // segment.
   if (segment != null && !this.isObject(segment)) {
-    this.logger.debug({segment: segment}, 'Segment is not a segment, not binding.')
+    this.logger.debug({ segment: segment }, 'Segment is not a segment, not binding.')
     return nodule
   }
 
@@ -1254,7 +1253,8 @@ function bindCallbackSegment(args, cbIdx, parentSegment) {
       // Bad index.
       this.logger.debug(
         'Invalid index %d for args of length %d, not binding callback segment',
-        cbIdx, args.length
+        cbIdx,
+        args.length
       )
       return
     }
@@ -1271,10 +1271,13 @@ function bindCallbackSegment(args, cbIdx, parentSegment) {
         if (realParent) {
           realParent.opaque = false
         }
-        var segment = _rawCreateSegment(shim, new specs.SegmentSpec({
-          name: 'Callback: ' + name,
-          parent: realParent
-        }))
+        var segment = _rawCreateSegment(
+          shim,
+          new specs.SegmentSpec({
+            name: 'Callback: ' + name,
+            parent: realParent
+          })
+        )
 
         if (segment) {
           segment.async = false
@@ -1310,7 +1313,6 @@ function getSegment(obj) {
   return this.tracer.getSegment()
 }
 
-
 /**
  * Retrieves the segment associated with the given object, or the currently
  * active segment if no object is given.
@@ -1349,7 +1351,7 @@ function getActiveSegment(obj) {
  *
  */
 function setActiveSegment(segment) {
-  return this.tracer.segment = segment
+  return (this.tracer.segment = segment)
 }
 
 /**
@@ -1467,7 +1469,7 @@ function createSegment(name, recorder, parent) {
   var opts = null
   if (this.isString(name)) {
     // createSegment(name [, recorder] [, parent])
-    opts = new specs.SegmentSpec({name})
+    opts = new specs.SegmentSpec({ name })
 
     // if the recorder arg is not used, it can either be omitted or null
     if (this.isFunction(recorder) || this.isNull(recorder)) {
@@ -1509,7 +1511,7 @@ function _rawCreateSegment(shim, opts) {
     }
     shim.logger.trace(opts, 'Created segment')
   } else {
-    shim.logger.debug(opts,'Failed to create segment')
+    shim.logger.debug(opts, 'Failed to create segment')
   }
 
   return segment
@@ -1525,7 +1527,7 @@ function _rawCreateSegment(shim, opts) {
  * @return {string} The name of the object if it has one, else `<anonymous>`.
  */
 function getName(obj) {
-  return String((!obj || obj === true) ? obj : (obj.name || '<anonymous>'))
+  return String(!obj || obj === true ? obj : obj.name || '<anonymous>')
 }
 
 /**
@@ -1690,7 +1692,7 @@ function normalizeIndex(arrayLength, idx) {
   if (idx < 0) {
     idx = arrayLength + idx
   }
-  return (idx < 0 || idx >= arrayLength) ? null : idx
+  return idx < 0 || idx >= arrayLength ? null : idx
 }
 
 /**
@@ -1856,7 +1858,7 @@ function proxy(source, properties, dest) {
         return source[prop]
       },
       set: function proxySet(val) {
-        return source[prop] = val
+        return (source[prop] = val)
       }
     })
   })
@@ -1877,7 +1879,7 @@ function shimRequire(filePath) {
     return require(path.resolve(this._moduleRoot, filePath))
   } catch (e) {
     this.logger.debug(
-      'Failed to load \'%s\' from module root: \'%s\'. Stack: %s',
+      "Failed to load '%s' from module root: '%s'. Stack: %s",
       filePath,
       this._moduleRoot,
       e.stack
@@ -1901,13 +1903,16 @@ function interceptPromise(prom, cb) {
   if (this.isFunction(prom.finally)) {
     return prom.finally(cb)
   }
-  return prom.then(function onThen(arg) {
-    cb()
-    return arg
-  }, function onCatch(err) {
-    cb()
-    throw err // This is not our error, just rethrowing the promise rejection.
-  })
+  return prom.then(
+    function onThen(arg) {
+      cb()
+      return arg
+    },
+    function onCatch(err) {
+      cb()
+      throw err // This is not our error, just rethrowing the promise rejection.
+    }
+  )
 }
 
 /**
@@ -2178,7 +2183,8 @@ function _bindStream(shim, stream, segment, spec) {
   if (!segment || !shim.isFunction(stream.emit)) {
     shim.logger.trace(
       'Not binding stream; have segment=%j; typeof emit=%s',
-      !!segment, typeof stream.emit
+      !!segment,
+      typeof stream.emit
     )
     return
   }
@@ -2239,28 +2245,28 @@ function _bindStream(shim, stream, segment, spec) {
 }
 
 /**
-* Wraps an es6-style class using a subclass.
-*
-* - `_es6WrapClass(shim, Base, fnName, spec, args)`
-*
-* @private
-*
-* @param {Shim} shim
-*  The shim performing the wrapping/binding.
-*
-* @param {class} Base
-*  The es6 class to be wrapped.
-*
-* @param {string} fnName
-*  The name of the base class.
-*
-* @param {ClassWrapSpec} spec
-*  The spec with pre- and post-execution hooks to call.
-*
-* @param {Array.<*>} args
-*  Extra arguments to pass through to the pre- and post-execution hooks.
-*
-* @return {class} A class that extends Base with execution hooks.
+ * Wraps an es6-style class using a subclass.
+ *
+ * - `_es6WrapClass(shim, Base, fnName, spec, args)`
+ *
+ * @private
+ *
+ * @param {Shim} shim
+ *  The shim performing the wrapping/binding.
+ *
+ * @param {class} Base
+ *  The es6 class to be wrapped.
+ *
+ * @param {string} fnName
+ *  The name of the base class.
+ *
+ * @param {ClassWrapSpec} spec
+ *  The spec with pre- and post-execution hooks to call.
+ *
+ * @param {Array.<*>} args
+ *  Extra arguments to pass through to the pre- and post-execution hooks.
+ *
+ * @return {class} A class that extends Base with execution hooks.
  */
 function _es6WrapClass(shim, Base, fnName, spec, args) {
   return class WrappedClass extends Base {

package/lib/shim/specs/index.js

@@ -48,35 +48,34 @@ function WrapSpec(spec) {
 }
 
 function SegmentSpec(spec) {
-  this.name       = hasOwnProperty(spec, 'name') ? spec.name : null
-  this.recorder   = hasOwnProperty(spec, 'recorder') ? spec.recorder : null
-  this.inContext  = hasOwnProperty(spec, 'inContext') ? spec.inContext : null
-  this.parent     = hasOwnProperty(spec, 'parent') ? spec.parent : null
+  this.name = hasOwnProperty(spec, 'name') ? spec.name : null
+  this.recorder = hasOwnProperty(spec, 'recorder') ? spec.recorder : null
+  this.inContext = hasOwnProperty(spec, 'inContext') ? spec.inContext : null
+  this.parent = hasOwnProperty(spec, 'parent') ? spec.parent : null
   this.parameters = hasOwnProperty(spec, 'parameters') ? spec.parameters : null
-  this.internal   = hasOwnProperty(spec, 'internal') ? spec.internal : false
-  this.opaque     = hasOwnProperty(spec, 'opaque') ? spec.opaque : false
+  this.internal = hasOwnProperty(spec, 'internal') ? spec.internal : false
+  this.opaque = hasOwnProperty(spec, 'opaque') ? spec.opaque : false
 }
 
 function RecorderSpec(spec) {
   SegmentSpec.call(this, spec)
-  this.stream           = hasOwnProperty(spec, 'stream') ? spec.stream : null
-  this.promise          = hasOwnProperty(spec, 'promise') ? spec.promise : null
-  this.callback         = hasOwnProperty(spec, 'callback') ? spec.callback : null
-  this.rowCallback      = hasOwnProperty(spec, 'rowCallback') ? spec.rowCallback : null
-  this.after            = hasOwnProperty(spec, 'after') ? spec.after : null
-  this.callbackRequired =
-    hasOwnProperty(spec, 'callbackRequired') ? spec.callbackRequired : null
+  this.stream = hasOwnProperty(spec, 'stream') ? spec.stream : null
+  this.promise = hasOwnProperty(spec, 'promise') ? spec.promise : null
+  this.callback = hasOwnProperty(spec, 'callback') ? spec.callback : null
+  this.rowCallback = hasOwnProperty(spec, 'rowCallback') ? spec.rowCallback : null
+  this.after = hasOwnProperty(spec, 'after') ? spec.after : null
+  this.callbackRequired = hasOwnProperty(spec, 'callbackRequired') ? spec.callbackRequired : null
 }
 util.inherits(RecorderSpec, SegmentSpec)
 
 function MiddlewareSpec(spec) {
   RecorderSpec.call(this, spec)
-  this.req        = hasOwnProperty(spec, 'req' ) ? spec.req : ARG_INDEXES.FIRST
-  this.res        = hasOwnProperty(spec, 'res' ) ? spec.res : ARG_INDEXES.SECOND
-  this.next       = hasOwnProperty(spec, 'next' ) ? spec.next : ARG_INDEXES.THIRD
-  this.type       = hasOwnProperty(spec, 'type' ) ? spec.type : 'MIDDLEWARE'
-  this.route      = hasOwnProperty(spec, 'route' ) ? spec.route : null
-  this.params     = hasOwnProperty(spec, 'params') ? spec.params : _defaultGetParams
+  this.req = hasOwnProperty(spec, 'req') ? spec.req : ARG_INDEXES.FIRST
+  this.res = hasOwnProperty(spec, 'res') ? spec.res : ARG_INDEXES.SECOND
+  this.next = hasOwnProperty(spec, 'next') ? spec.next : ARG_INDEXES.THIRD
+  this.type = hasOwnProperty(spec, 'type') ? spec.type : 'MIDDLEWARE'
+  this.route = hasOwnProperty(spec, 'route') ? spec.route : null
+  this.params = hasOwnProperty(spec, 'params') ? spec.params : _defaultGetParams
   this.appendPath = hasOwnProperty(spec, 'appendPath') ? spec.appendPath : true
 }
 util.inherits(MiddlewareSpec, RecorderSpec)

package/lib/shim/transaction-shim.js

@@ -7,7 +7,7 @@
 
 const cat = require('../util/cat')
 const hashes = require('../util/hashes')
-const logger = require('../logger').child({component: 'TransactionShim'})
+const logger = require('../logger').child({ component: 'TransactionShim' })
 const Shim = require('./shim')
 const Transaction = require('../transaction')
 const util = require('util')
@@ -50,7 +50,7 @@ const TRANSACTION_TYPES_SET = Transaction.TYPES_SET
  */
 function TransactionShim(agent, moduleName, resolvedName) {
   Shim.call(this, agent, moduleName, resolvedName)
-  this._logger = logger.child({module: moduleName})
+  this._logger = logger.child({ module: moduleName })
 }
 module.exports = TransactionShim
 util.inherits(TransactionShim, Shim)
@@ -71,7 +71,6 @@ Object.keys(Transaction.TYPES).forEach(function defineTypeEnum(type) {
   Shim.defineProperty(TransactionShim.prototype, type, Transaction.TYPES[type])
 })
 
-
 /**
  * Enumeration of possible transaction transport types used for distributed tracing.
  *
@@ -81,16 +80,8 @@ Object.keys(Transaction.TYPES).forEach(function defineTypeEnum(type) {
  * @memberof TransactionShim.prototype
  * @enum {string}
  */
-Shim.defineProperty(
-  TransactionShim,
-  'TRANSPORT_TYPES',
-  Transaction.TRANSPORT_TYPES
-)
-Shim.defineProperty(
-  TransactionShim.prototype,
-  'TRANSPORT_TYPES',
-  Transaction.TRANSPORT_TYPES
-)
+Shim.defineProperty(TransactionShim, 'TRANSPORT_TYPES', Transaction.TRANSPORT_TYPES)
+Shim.defineProperty(TransactionShim.prototype, 'TRANSPORT_TYPES', Transaction.TRANSPORT_TYPES)
 
 TransactionShim.prototype.bindCreateTransaction = bindCreateTransaction
 TransactionShim.prototype.pushTransactionName = pushTransactionName
@@ -158,9 +149,10 @@ function bindCreateTransaction(nodule, property, spec) {
   // Refuse to perform the wrapping if `spec.type` is not valid.
   if (!TRANSACTION_TYPES_SET[spec.type]) {
     this.logger.error(
-      {stack: (new Error()).stack},
+      { stack: new Error().stack },
       'Invalid spec type "%s", must be one of %j.',
-      spec.type, Object.keys(TRANSACTION_TYPES_SET)
+      spec.type,
+      Object.keys(TRANSACTION_TYPES_SET)
     )
     return nodule
   }
@@ -293,7 +285,8 @@ function handleCATHeaders(headers, segment, transportType) {
   var catId = null
   var transactionData = null
   var appData = null
-  for (var key in headers) { // eslint-disable-line guard-for-in
+  // eslint-disable-next-line guard-for-in
+  for (var key in headers) {
     if (MATCH_CAT_ID_HEADER.test(key)) {
       catId = headers[key]
     } else if (MATCH_CAT_TRANSACTION_HEADER.test(key)) {
@@ -344,9 +337,7 @@ function insertCATRequestHeaders(headers, useAlternateHeaderNames) {
   const distributedTracingEnabled = this.agent.config.distributed_tracing.enabled
 
   if (!distributedTracingEnabled && !crossAppTracingEnabled) {
-    this.logger.trace(
-      'Distributed Tracing and CAT are both disabled, not adding headers.'
-    )
+    this.logger.trace('Distributed Tracing and CAT are both disabled, not adding headers.')
     return
   }
 
@@ -404,7 +395,7 @@ function insertCATRequestHeaders(headers, useAlternateHeaderNames) {
         this.logger.trace('Added CAT headers for transaction %s', tx.id)
       }
     } catch (e) {
-      this.logger.warn({error: e.stack}, 'Failed to serialize CAT header!')
+      this.logger.warn({ error: e.stack }, 'Failed to serialize CAT header!')
     }
   }
 }
@@ -465,23 +456,24 @@ function insertCATReplyHeader(headers, useAlternateHeaderNames) {
   var appData = null
   var txName = tx.getFullName()
   try {
-    appData = hashes.obfuscateNameUsingKey(JSON.stringify([
-      config.cross_process_id,
-      txName,
-      tx.queueTime / 1000,
-      tx.catResponseTime / 1000,
-      contentLength,
-      tx.id,
-      false
-    ]), config.encoding_key)
+    appData = hashes.obfuscateNameUsingKey(
+      JSON.stringify([
+        config.cross_process_id,
+        txName,
+        tx.queueTime / 1000,
+        tx.catResponseTime / 1000,
+        contentLength,
+        tx.id,
+        false
+      ]),
+      config.encoding_key
+    )
   } catch (e) {
-    this.logger.warn({error: e.stack}, 'Failed to serialize CAT data for %s', txName)
+    this.logger.warn({ error: e.stack }, 'Failed to serialize CAT data for %s', txName)
   }
 
   // Add the header.
-  headers[
-    useAlternateHeaderNames ? MQ_CAT_APP_DATA_HEADER : HTTP_CAT_APP_DATA_HEADER
-  ] = appData
+  headers[useAlternateHeaderNames ? MQ_CAT_APP_DATA_HEADER : HTTP_CAT_APP_DATA_HEADER] = appData
   this.logger.trace('Added outbound response CAT headers for transaction %s', tx.id)
 }
 
@@ -505,9 +497,7 @@ function _handleCATReplyHeader(shim, segment, appData) {
   // Attempt to parse the app data header.
   var config = shim.agent.config
   try {
-    appData = JSON.parse(
-      hashes.deobfuscateNameUsingKey(appData, config.encoding_key)
-    )
+    appData = JSON.parse(hashes.deobfuscateNameUsingKey(appData, config.encoding_key))
   } catch (e) {
     shim.logger.warn('Unparsable CAT application data header: %s', appData)
     return