newrelic 8.2.0 → 8.5.1

package/lib/instrumentation/amqplib.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-var url = require('url')
+const url = require('url')
 
 // TODO: Make this an external module.
 // var newrelic = require('newrelic')
@@ -45,7 +45,7 @@ module.exports.selfRegister = function selfRegister(shimmer) {
 module.exports.instrumentPromiseAPI = instrumentChannelAPI
 module.exports.instrumentCallbackAPI = instrumentCallbackAPI
 
-var CHANNEL_METHODS = [
+const CHANNEL_METHODS = [
   'close',
   'open',
   'assertQueue',
@@ -63,7 +63,7 @@ var CHANNEL_METHODS = [
   'recover'
 ]
 
-var TEMP_RE = /^amq\./
+const TEMP_RE = /^amq\./
 
 function instrumentChannelAPI(shim, amqp) {
   instrumentAMQP(shim, amqp, true)
@@ -88,8 +88,8 @@ function instrumentAMQP(shim, amqp, promiseMode) {
   shim.setLibrary(shim.RABBITMQ)
 
   shim.record(amqp, 'connect', function recordConnect(shim, connect, name, args) {
-    var connArgs = args[0]
-    var params = null
+    let connArgs = args[0]
+    let params = null
 
     if (shim.isString(connArgs)) {
       connArgs = url.parse(connArgs)
@@ -114,13 +114,13 @@ function instrumentAMQP(shim, amqp, promiseMode) {
 }
 
 function wrapChannel(shim) {
-  var libChannel = shim.require('./lib/channel')
+  const libChannel = shim.require('./lib/channel')
   if (!libChannel || !libChannel.Channel || !libChannel.Channel.prototype) {
     shim.logger.debug('Could not get Channel class to instrument.')
     return
   }
 
-  var proto = libChannel.Channel.prototype
+  const proto = libChannel.Channel.prototype
   if (shim.isWrapped(proto.sendMessage)) {
     shim.logger.trace('Channel already instrumented.')
     return
@@ -133,15 +133,15 @@ function wrapChannel(shim) {
     }
 
     return function wrappedSendOrEnqueue() {
-      var segment = shim.getSegment()
-      var cb = arguments[arguments.length - 1]
+      const segment = shim.getSegment()
+      const cb = arguments[arguments.length - 1]
       if (!shim.isFunction(cb) || !segment) {
         shim.logger.debug({ cb: !!cb, segment: !!segment }, 'Not binding sendOrEnqueue callback')
         return fn.apply(this, arguments)
       }
 
       shim.logger.trace('Binding sendOrEnqueue callback to %s', segment.name)
-      var args = shim.argsToArray.apply(shim, arguments)
+      const args = shim.argsToArray.apply(shim, arguments)
       args[args.length - 1] = shim.bindSegment(cb, segment)
       return fn.apply(this, args)
     }
@@ -170,11 +170,11 @@ function wrapChannel(shim) {
 
   shim.recordProduce(proto, 'sendMessage', recordSendMessage)
   function recordSendMessage(shim, fn, n, args) {
-    var fields = args[0]
+    const fields = args[0]
     if (!fields) {
       return null
     }
-    var isDefault = fields.exchange === ''
+    const isDefault = fields.exchange === ''
     let exchange = 'Default'
     if (!isDefault) {
       exchange = TEMP_RE.test(fields.exchange) ? null : fields.exchange
@@ -205,12 +205,12 @@ function getParameters(parameters, fields) {
 }
 
 function wrapPromiseChannel(shim) {
-  var libPModel = shim.require('./lib/channel_model')
+  const libPModel = shim.require('./lib/channel_model')
   if (!libPModel || !libPModel.Channel || !libPModel.Channel.prototype) {
     shim.logger.debug('Could not get promise model Channel to instrument')
   }
 
-  var proto = libPModel.Channel.prototype
+  const proto = libPModel.Channel.prototype
   if (shim.isWrapped(proto.consume)) {
     shim.logger.trace('Promise model already isntrumented.')
     return
@@ -231,11 +231,11 @@ function wrapPromiseChannel(shim) {
         shim.logger.trace('No results from consume.')
         return null
       }
-      var parameters = Object.create(null)
+      const parameters = Object.create(null)
       getParameters(parameters, message.fields)
       getParameters(parameters, message.properties)
 
-      var headers = null
+      let headers = null
       if (message.properties && message.properties.headers) {
         headers = message.properties.headers
       }
@@ -245,7 +245,7 @@ function wrapPromiseChannel(shim) {
   })
 
   shim.recordPurgeQueue(proto, 'purgeQueue', function recordPurge(shim, fn, name, args) {
-    var queue = args[0] || null
+    let queue = args[0] || null
     if (TEMP_RE.test(queue)) {
       queue = null
     }
@@ -263,13 +263,13 @@ function wrapPromiseChannel(shim) {
 }
 
 function wrapCallbackChannel(shim) {
-  var libCbModel = shim.require('./lib/callback_model')
+  const libCbModel = shim.require('./lib/callback_model')
   if (!libCbModel || !libCbModel.Channel || !libCbModel.Channel.prototype) {
     shim.logger.debug('Could not get callback model Channel to instrument')
     return
   }
 
-  var proto = libCbModel.Channel.prototype
+  const proto = libCbModel.Channel.prototype
   if (shim.isWrapped(proto.consume)) {
     return
   }
@@ -309,16 +309,16 @@ function wrapCallbackChannel(shim) {
     destinationName: shim.FIRST,
     callback: shim.LAST,
     messageHandler: function handleConsumedMessage(shim, fn, name, args) {
-      var message = args[1]
+      const message = args[1]
       if (!message) {
         shim.logger.trace('No results from consume.')
         return null
       }
-      var parameters = Object.create(null)
+      const parameters = Object.create(null)
       getParameters(parameters, message.fields)
       getParameters(parameters, message.properties)
 
-      var headers = null
+      let headers = null
       if (message.properties && message.properties.headers) {
         headers = message.properties.headers
       }
@@ -328,7 +328,7 @@ function wrapCallbackChannel(shim) {
   })
 
   shim.recordPurgeQueue(proto, 'purgeQueue', function recordPurge(shim, fn, name, args) {
-    var queue = args[0]
+    let queue = args[0]
     if (TEMP_RE.test(queue)) {
       queue = null
     }
@@ -347,14 +347,14 @@ function wrapCallbackChannel(shim) {
 }
 
 function describeMessage(shim, consumer, name, args) {
-  var message = args[0]
+  const message = args[0]
   if (!message || !message.properties) {
     shim.logger.debug({ message: message }, 'Failed to find message in consume arguments.')
     return null
   }
 
-  var exchangeName = message.fields.exchange
-  var parameters = getParameters(Object.create(null), message.fields)
+  let exchangeName = message.fields.exchange
+  const parameters = getParameters(Object.create(null), message.fields)
   getParameters(parameters, message.properties)
 
   if (!exchangeName) {

package/lib/instrumentation/bluebird.js

@@ -93,16 +93,16 @@ module.exports = function initialize(agent, bluebird, moduleName, shim) {
   shim.wrap(bluebird.Promise, 'getNewLibraryCopy', function wrapNewCopy(shim, original) {
     return function wrappedNewCopy() {
       shim.logger.trace('Instrumenting new library copy...')
-      var copy = original.apply(this, arguments)
+      const copy = original.apply(this, arguments)
       module.exports(agent, copy, moduleName, shim)
       return copy
     }
   })
 
   // Need to copy over `coroutine.addYieldHandler`
-  var coroutine = Promise && Promise.coroutine
+  const coroutine = Promise && Promise.coroutine
   if (shim.isWrapped(coroutine)) {
-    var original = shim.getOriginal(coroutine)
+    const original = shim.getOriginal(coroutine)
     coroutine.addYieldHandler = original && original.addYieldHandler
   }
 }

package/lib/instrumentation/cassandra-driver.js

@@ -6,10 +6,14 @@
 'use strict'
 
 module.exports = function initialize(agent, cassandra, moduleName, shim) {
-  var proto = cassandra.Client.prototype
+  const proto = cassandra.Client.prototype
   shim.setDatastore(shim.CASSANDRA)
   shim.recordOperation(proto, ['connect', 'shutdown'], { callback: shim.LAST })
-  shim.recordQuery(proto, '_innerExecute', { query: shim.FIRST, callback: shim.LAST })
+  if (proto._innerExecute) {
+    shim.recordQuery(proto, '_innerExecute', { query: shim.FIRST, callback: shim.LAST })
+  } else {
+    shim.recordQuery(proto, '_execute', { query: shim.FIRST, callback: shim.LAST })
+  }
   shim.recordBatchQuery(proto, 'batch', {
     query: findBatchQueryArg,
     callback: shim.LAST
@@ -23,6 +27,6 @@ module.exports = function initialize(agent, cassandra, moduleName, shim) {
  * @return {string} The query for this batch request.
  */
 function findBatchQueryArg(shim, batch, fnName, args) {
-  var sql = (args[0] && args[0][0]) || ''
+  const sql = (args[0] && args[0][0]) || ''
   return sql.query || sql
 }

package/lib/instrumentation/connect.js

@@ -17,7 +17,7 @@ module.exports = function initialize(agent, connect, moduleName, shim) {
     return route
   })
 
-  var proto =
+  const proto =
     (connect && connect.HTTPServer && connect.HTTPServer.prototype) || // v1
     (connect && connect.proto) // v2
 
@@ -31,7 +31,7 @@ module.exports = function initialize(agent, connect, moduleName, shim) {
 }
 
 function wrapMiddleware(shim, middleware, name, route) {
-  var spec = {
+  const spec = {
     matchArity: true,
     route: route,
     type: shim.MIDDLEWARE,
@@ -56,9 +56,9 @@ function wrapMiddleware(shim, middleware, name, route) {
 
 function wrapConnectExport(shim, connect, v3) {
   shim.wrapExport(connect, function wrapExport(shim, fn) {
-    var wrapper = shim.wrap(fn, function wrapConnect(shim, _fn) {
+    const wrapper = shim.wrap(fn, function wrapConnect(shim, _fn) {
       return function wrappedConnect() {
-        var res = _fn.apply(this, arguments)
+        const res = _fn.apply(this, arguments)
         if (v3) {
           shim.wrapMiddlewareMounter(res, 'use', {
             route: shim.FIRST,

package/lib/instrumentation/core/async_hooks.js

@@ -5,16 +5,16 @@
 
 'use strict'
 
-var logger = require('../../logger').child({ component: 'async_hooks' })
-var promInit = require('../promise')
+const logger = require('../../logger').child({ component: 'async_hooks' })
+const promInit = require('../promise')
 
 module.exports = initialize
 
 /**
  * The spec for the native `Promise` class.
  */
-var STATIC_PROMISE_METHODS = ['accept', 'all', 'defer', 'race', 'reject', 'resolve']
-var NATIVE_PROMISE_SPEC = {
+const STATIC_PROMISE_METHODS = ['accept', 'all', 'defer', 'race', 'reject', 'resolve']
+const NATIVE_PROMISE_SPEC = {
   name: 'global',
   constructor: 'Promise',
   executor: true,
@@ -30,7 +30,7 @@ var NATIVE_PROMISE_SPEC = {
 }
 
 function initialize(agent, shim) {
-  var enableHooks = agent.config.checkAsyncHookStatus()
+  const enableHooks = agent.config.checkAsyncHookStatus()
   if (enableHooks && tryAsyncHooks(agent, shim)) {
     logger.debug('Using async_hooks.')
   } else {
@@ -134,7 +134,7 @@ function getPromiseResolveStyleHooks(segmentMap, agent, shim) {
         return
       }
 
-      let parentSegment = segmentMap.get(triggerId)
+      const parentSegment = segmentMap.get(triggerId)
 
       if (parentSegment && !parentSegment.transaction.isActive()) {
         // Stop propagating if the transaction was ended.

package/lib/instrumentation/core/domain.js

@@ -8,12 +8,12 @@
 module.exports = initialize
 
 function initialize(agent, domain, name, shim) {
-  var proto = domain.Domain.prototype
+  const proto = domain.Domain.prototype
   shim.wrap(proto, 'emit', wrapEmit)
 
   function wrapEmit(shim, original) {
     return function wrappedEmit(ev) {
-      var shouldRestoreContext =
+      const shouldRestoreContext =
         ev === 'error' && shim.getActiveSegment() === null && shim.getSegment(this)
 
       if (!shouldRestoreContext) {

package/lib/instrumentation/core/globals.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-var asyncHooks = require('./async_hooks')
+const asyncHooks = require('./async_hooks')
 
 module.exports = initialize
 

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

@@ -5,13 +5,13 @@
 
 'use strict'
 
-var recordExternal = require('../../metrics/recorders/http_external')
-var urltils = require('../../util/urltils')
-var hashes = require('../../util/hashes')
-var logger = require('../../logger').child({ component: 'outbound' })
-var shimmer = require('../../shimmer')
-var url = require('url')
-var copy = require('../../util/copy')
+const recordExternal = require('../../metrics/recorders/http_external')
+const cat = require('../../util/cat')
+const urltils = require('../../util/urltils')
+const logger = require('../../logger').child({ component: 'outbound' })
+const shimmer = require('../../shimmer')
+const url = require('url')
+const copy = require('../../util/copy')
 
 const NAMES = require('../../metrics/names')
 const SHIM_SYMBOLS = require('../../shim/constants').SYMBOLS
@@ -20,8 +20,6 @@ const DEFAULT_HOST = 'localhost'
 const DEFAULT_PORT = 80
 const DEFAULT_SSL_PORT = 443
 
-const NEWRELIC_ID_HEADER = 'x-newrelic-id'
-const NEWRELIC_TRANSACTION_HEADER = 'x-newrelic-transaction'
 const NEWRELIC_SYNTHETICS_HEADER = 'x-newrelic-synthetics'
 
 /**
@@ -96,13 +94,9 @@ module.exports = function instrumentOutbound(agent, opts, makeRequest) {
         transaction.insertDistributedTraceHeaders(outboundHeaders)
       }
     } else if (agent.config.cross_application_tracer.enabled) {
-      if (agent.config.encoding_key) {
-        _addCATHeaders(agent, transaction, outboundHeaders)
-      } else {
-        logger.trace('No encoding key found, not adding CAT headers')
-      }
+      cat.addCatHeaders(agent.config, transaction, outboundHeaders)
     } else {
-      logger.trace('CAT disabled, not adding headers!')
+      logger.trace('Both DT and CAT are disabled, not adding headers!')
     }
 
     if (Array.isArray(opts.headers)) {
@@ -129,7 +123,7 @@ module.exports = function instrumentOutbound(agent, opts, makeRequest) {
     if (parsed.parameters) {
       // Scrub and parse returns on object with a null prototype.
       // eslint-disable-next-line guard-for-in
-      for (let key in parsed.parameters) {
+      for (const key in parsed.parameters) {
         segment.addSpanAttribute(`request.parameters.${key}`, parsed.parameters[key])
       }
     }
@@ -196,12 +190,14 @@ function handleResponse(segment, hostname, req, res) {
   // If CAT is enabled, grab those headers!
   const agent = segment.transaction.agent
   if (agent.config.cross_application_tracer.enabled && !agent.config.distributed_tracing.enabled) {
-    pullCatHeaders(agent.config, segment, hostname, res.headers['x-newrelic-app-data'])
+    const { appData } = cat.extractCatHeaders(res.headers)
+    const decodedAppData = cat.parseAppData(agent.config, appData)
+    cat.assignCatToSegment(decodedAppData, segment, hostname)
   }
 
   // Again a custom emit wrapper because we want to watch for the `end` event.
   shimmer.wrapMethod(res, 'response', 'emit', function wrapEmit(emit) {
-    var boundEmit = agent.tracer.bindFunction(emit, segment)
+    const boundEmit = agent.tracer.bindFunction(emit, segment)
     return function wrappedResponseEmit(evnt) {
       if (evnt === 'end') {
         segment.end()
@@ -212,77 +208,12 @@ function handleResponse(segment, hostname, req, res) {
   _makeNonEnumerable(res, 'emit')
 }
 
-function pullCatHeaders(config, segment, host, obfAppData) {
-  if (!config.encoding_key) {
-    logger.trace('config.encoding_key is not set - not parsing response CAT headers')
-    return
-  }
-
-  if (!config.trusted_account_ids) {
-    logger.trace('config.trusted_account_ids is not set - not parsing response CAT headers')
-    return
-  }
-
-  // is our downstream request CAT-aware?
-  if (!obfAppData) {
-    logger.trace('Got no CAT app data in response header x-newrelic-app-data')
-  } else {
-    var appData = null
-    try {
-      appData = JSON.parse(hashes.deobfuscateNameUsingKey(obfAppData, config.encoding_key))
-    } catch (e) {
-      logger.warn('Got an unparsable CAT header x-newrelic-app-data: %s', obfAppData)
-      return
-    }
-    // Make sure it is a trusted account
-    if (appData.length && typeof appData[0] === 'string') {
-      var accountId = appData[0].split('#')[0]
-      accountId = parseInt(accountId, 10)
-      if (config.trusted_account_ids.indexOf(accountId) === -1) {
-        logger.trace('Response from untrusted CAT header account id: %s', accountId)
-      } else {
-        segment.catId = appData[0]
-        segment.catTransaction = appData[1]
-        segment.name =
-          NAMES.EXTERNAL.TRANSACTION + host + '/' + segment.catId + '/' + segment.catTransaction
-        if (appData.length >= 6) {
-          segment.addAttribute('transaction_guid', appData[5])
-        }
-        logger.trace('Got inbound response CAT headers in transaction %s', segment.transaction.id)
-      }
-    }
-  }
-}
-
 function _makeNonEnumerable(obj, prop) {
   try {
-    var desc = Object.getOwnPropertyDescriptor(obj, prop)
+    const desc = Object.getOwnPropertyDescriptor(obj, prop)
     desc.enumerable = false
     Object.defineProperty(obj, prop, desc)
   } catch (e) {
     logger.debug(e, 'Failed to make %s non enumerable.', prop)
   }
 }
-
-function _addCATHeaders(agent, tx, outboundHeaders) {
-  if (agent.config.obfuscatedId) {
-    outboundHeaders[NEWRELIC_ID_HEADER] = agent.config.obfuscatedId
-  }
-
-  var pathHash = hashes.calculatePathHash(
-    agent.config.applications()[0],
-    tx.getFullName() || '',
-    tx.referringPathHash
-  )
-  tx.pushPathHash(pathHash)
-
-  try {
-    let txData = JSON.stringify([tx.id, false, tx.tripId || tx.id, pathHash])
-    txData = hashes.obfuscateNameUsingKey(txData, agent.config.encoding_key)
-    outboundHeaders[NEWRELIC_TRANSACTION_HEADER] = txData
-
-    logger.trace('Added outbound request CAT headers in transaction %s', tx.id)
-  } catch (err) {
-    logger.trace(err, 'Failed to create CAT payload')
-  }
-}