newrelic 7.5.2 → 8.3.0

package/lib/transaction/handle.js

@@ -5,27 +5,27 @@
 
 'use strict'
 
-const logger = require('../logger').child({component: 'transactionHandle'})
+const logger = require('../logger').child({ component: 'transactionHandle' })
 
 const NAMES = require('../../lib/metrics/names')
 
 class TransactionHandle {
   /**
-  * A light representation of a transaction instance, returned by calling
-  * {@link API#getTransaction}.
-  *
-  * @constructor
-  */
+   * A light representation of a transaction instance, returned by calling
+   * {@link API#getTransaction}.
+   *
+   * @constructor
+   */
   constructor(transaction, metrics) {
     this._transaction = transaction
     this._metrics = metrics
   }
 
   /**
-  * End the transaction.
-  *
-  * @param  {Function} callback
-  */
+   * End the transaction.
+   *
+   * @param  {Function} callback
+   */
   end(callback) {
     const tx = this._transaction.end()
     if (typeof callback === 'function') {
@@ -37,15 +37,15 @@ class TransactionHandle {
   }
 
   /**
-  * Mark the transaction to be ignored.
-  */
+   * Mark the transaction to be ignored.
+   */
   ignore() {
     this._transaction.setForceIgnore(true)
   }
 
   /**
-  * Return whether this Transaction is being sampled
-  */
+   * Return whether this Transaction is being sampled
+   */
   isSampled() {
     return this._transaction.isSampled()
   }
@@ -95,22 +95,22 @@ module.exports.Stub = class TransactionHandleStub {
     if (callback instanceof Function) {
       setImmediate(callback)
     }
-    logger.debug("No transaction found when calling Transaction.end")
+    logger.debug('No transaction found when calling Transaction.end')
   }
 
   ignore() {
-    logger.debug("No transaction found when calling Transaction.ignore")
+    logger.debug('No transaction found when calling Transaction.ignore')
   }
 
   isSampled() {
-    logger.debug("No transaction found when calling Transaction.isSampled")
+    logger.debug('No transaction found when calling Transaction.isSampled')
   }
 
   acceptDistributedTraceHeaders() {
-    logger.debug("No transaction found when calling Transaction.acceptDistributedTraceHeaders")
+    logger.debug('No transaction found when calling Transaction.acceptDistributedTraceHeaders')
   }
 
   insertDistributedTraceHeaders() {
-    logger.debug("No transaction found when calling Transaction.insertDistributedTraceHeaders")
+    logger.debug('No transaction found when calling Transaction.insertDistributedTraceHeaders')
   }
 }

package/lib/transaction/index.js

@@ -7,7 +7,7 @@
 
 const errorHelper = require('../errors/helper')
 var hashes = require('../util/hashes')
-var logger = require('../logger').child({component: 'transaction'})
+var logger = require('../logger').child({ component: 'transaction' })
 var Metrics = require('../metrics')
 var NAMES = require('../metrics/names')
 var NameState = require('./name-state')
@@ -58,7 +58,7 @@ const NEWRELIC_TRACE_HEADER = 'newrelic'
 
 const MULTIPLE_INSERT_MESSAGE =
   'insertDistributedTraceHeaders called on headers object that already contains ' +
-  'distributed trace data. These may be overwritten. traceparent? \'%s\', newrelic? \'%s\'.'
+  "distributed trace data. These may be overwritten. traceparent? '%s', newrelic? '%s'."
 
 /**
  * Bundle together the metrics and the trace segment for a single agent
@@ -67,7 +67,9 @@ const MULTIPLE_INSERT_MESSAGE =
  * @param {Object} agent The agent.
  */
 function Transaction(agent) {
-  if (!agent) throw new Error('every transaction must be bound to the agent')
+  if (!agent) {
+    throw new Error('every transaction must be bound to the agent')
+  }
 
   this.traceFlag = false
   if (agent.config.logging.diagnostics) {
@@ -77,11 +79,7 @@ function Transaction(agent) {
   }
 
   this.agent = agent
-  this.metrics = new Metrics(
-    agent.config.apdex_t,
-    agent.mapper,
-    agent.metricNameNormalizer
-  )
+  this.metrics = new Metrics(agent.config.apdex_t, agent.mapper, agent.metricNameNormalizer)
 
   ++agent.activeTransactions
 
@@ -132,7 +130,7 @@ function Transaction(agent) {
   this.parentTransportType = null
   this.parentTransportDuration = null
   this._traceId = null
-  Object.defineProperty(this, "traceId", {
+  Object.defineProperty(this, 'traceId', {
     get() {
       if (this._traceId === null) {
         this._traceId = hashes.makeId(32)
@@ -153,7 +151,7 @@ function Transaction(agent) {
   this.traceContext = new TraceContext(this)
 
   agent.emit('transactionStarted', this)
-  this.probe('Transaction created', {id: this.id})
+  this.probe('Transaction created', { id: this.id })
 }
 
 Transaction.TYPES = TYPES
@@ -165,7 +163,7 @@ Transaction.TRACE_CONTEXT_PARENT_HEADER = TRACE_CONTEXT_PARENT_HEADER
 Transaction.prototype.probe = function probe(action, extra) {
   if (this.traceStacks) {
     this.traceStacks.push({
-      stack: (new Error(action)).stack.split('\n'),
+      stack: new Error(action).stack.split('\n'),
       extra: extra
     })
   }
@@ -193,10 +191,12 @@ Transaction.prototype.isActive = function isActive() {
  * instances of this transaction annotated onto the call stack.
  */
 Transaction.prototype.end = function end() {
-  if (!this.timer.isActive()) return
+  if (!this.timer.isActive()) {
+    return
+  }
   if (this.traceFlag) {
     logger.warn(
-      {segment: {name: this.name, stacks: this.traceStacks}},
+      { segment: { name: this.name, stacks: this.traceStacks } },
       'Flagged transaction ended.'
     )
   }
@@ -380,7 +380,7 @@ Transaction.prototype.setForceIgnore = function setForceIgnore(ignore) {
   if (ignore != null) {
     this.forceIgnore = ignore
   } else {
-    logger.debug("Transaction#setForceIgnore called with null value")
+    logger.debug('Transaction#setForceIgnore called with null value')
   }
 }
 
@@ -406,8 +406,15 @@ Transaction.prototype.isIgnored = function getIgnore() {
 Transaction.prototype.finalizeNameFromUri = finalizeNameFromUri
 function finalizeNameFromUri(requestURL, statusCode) {
   if (logger.traceEnabled()) {
-    logger.trace({requestURL: requestURL, statusCode: statusCode, transactionId: this.id,
-      transactionName: this.name}, 'Setting transaction name')
+    logger.trace(
+      {
+        requestURL: requestURL,
+        statusCode: statusCode,
+        transactionId: this.id,
+        transactionName: this.name
+      },
+      'Setting transaction name'
+    )
   }
 
   this.url = urltils.scrub(requestURL)
@@ -425,24 +432,17 @@ function finalizeNameFromUri(requestURL, statusCode) {
     this.nameState.forEachParams(function forEachRouteParams(params) {
       for (var key in params) {
         if (props.hasOwn(params, key)) {
-          this.trace.attributes.addAttribute(
-            DESTS.NONE,
-            'request.parameters.' + key,
-            params[key]
-          )
+          this.trace.attributes.addAttribute(DESTS.NONE, 'request.parameters.' + key, params[key])
 
           const segment = this.agent.tracer.getSegment()
 
           if (!segment) {
-            logger
-              .trace('Active segment not available, not adding request.parameters attribute for %s',
-                key)
-          } else {
-            segment.attributes.addAttribute(
-              DESTS.NONE,
-              'request.parameters.' + key,
-              params[key]
+            logger.trace(
+              'Active segment not available, not adding request.parameters attribute for %s',
+              key
             )
+          } else {
+            segment.attributes.addAttribute(DESTS.NONE, 'request.parameters.' + key, params[key])
           }
         }
       }
@@ -470,11 +470,14 @@ function finalizeNameFromUri(requestURL, statusCode) {
   this._copyNameToActiveSpan(this.name)
 
   if (logger.traceEnabled()) {
-    logger.trace({
-      transactionId: this.id,
-      transactionName: this.name,
-      ignore: this.ignore
-    }, 'Finished setting transaction name from Uri')
+    logger.trace(
+      {
+        transactionId: this.id,
+        transactionName: this.name,
+        ignore: this.ignore
+      },
+      'Finished setting transaction name from Uri'
+    )
   }
 }
 
@@ -499,25 +502,17 @@ Transaction.prototype._markAsWeb = function _markAsWeb(rawURL) {
   var params = urltils.parseParameters(rawURL)
   for (var key in params) {
     if (props.hasOwn(params, key)) {
-      this.trace.attributes.addAttribute(
-        DESTS.NONE,
-        'request.parameters.' + key,
-        params[key]
-      )
+      this.trace.attributes.addAttribute(DESTS.NONE, 'request.parameters.' + key, params[key])
 
       const segment = this.agent.tracer.getSegment()
 
       if (!segment) {
-        logger
-          .trace(
-            'Active segment not available, not adding request.parameters span attribute for %s',
-            key)
-      } else {
-        segment.attributes.addAttribute(
-          DESTS.NONE,
-          'request.parameters.' + key,
-          params[key]
+        logger.trace(
+          'Active segment not available, not adding request.parameters span attribute for %s',
+          key
         )
+      } else {
+        segment.attributes.addAttribute(DESTS.NONE, 'request.parameters.' + key, params[key])
       }
     }
   }
@@ -563,11 +558,14 @@ Transaction.prototype.finalizeName = function finalizeName(name) {
   this._copyNameToActiveSpan(this.name)
 
   if (logger.traceEnabled()) {
-    logger.trace({
-      transactionId: this.id,
-      transactionName: this.name,
-      ignore: this.ignore
-    }, 'Finished setting transaction name from string')
+    logger.trace(
+      {
+        transactionId: this.id,
+        transactionName: this.name,
+        ignore: this.ignore
+      },
+      'Finished setting transaction name from string'
+    )
   }
 }
 
@@ -618,8 +616,12 @@ Transaction.prototype.getFullName = function getFullName() {
  * Returns a string or undefined.
  */
 Transaction.prototype.getScrubbedUrl = function getScrubbedUrl() {
-  if (!this.isWeb()) return
-  if (this._scrubbedUrl) return this._scrubbedUrl
+  if (!this.isWeb()) {
+    return
+  }
+  if (this._scrubbedUrl) {
+    return this._scrubbedUrl
+  }
 
   // If we don't have a parsedUrl, lets populate it from .url
   if (!this.parsedUrl) {
@@ -627,7 +629,9 @@ Transaction.prototype.getScrubbedUrl = function getScrubbedUrl() {
     // because that is what .isWeb() checks against. In the future it may be
     // instead checking a enum or other property so guard ourselves just in
     // case.
-    if (!this.url) return
+    if (!this.url) {
+      return
+    }
     this.parsedUrl = url.parse(this.url)
   }
 
@@ -722,7 +726,9 @@ Transaction.prototype._setApdex = function _setApdex(name, duration, keyApdexInM
  * @param {string} pathHash Path hash
  */
 Transaction.prototype.pushPathHash = function pushPathHash(pathHash) {
-  if (this.pathHashes.length >= 10 || this.pathHashes.indexOf(pathHash) !== -1) return
+  if (this.pathHashes.length >= 10 || this.pathHashes.indexOf(pathHash) !== -1) {
+    return
+  }
   this.pathHashes.unshift(pathHash)
 }
 
@@ -746,7 +752,9 @@ Transaction.prototype.alternatePathHashes = function alternatePathHashes() {
   var altHashes = this.pathHashes.slice()
   var curIndex = altHashes.indexOf(curHash)
 
-  if (curIndex !== -1) altHashes.splice(curIndex, 1)
+  if (curIndex !== -1) {
+    altHashes.splice(curIndex, 1)
+  }
 
   return altHashes.length === 0 ? null : altHashes.sort().join(',')
 }
@@ -831,7 +839,7 @@ Transaction.prototype.hasErrors = function _hasErrors() {
   var isErroredTransaction = urltils.isError(this.agent.config, this.statusCode)
   var transactionHasExceptions = this.exceptions.length > 0
   var transactionHasuserErrors = this.userErrors.length > 0
-  return (transactionHasExceptions || transactionHasuserErrors || isErroredTransaction)
+  return transactionHasExceptions || transactionHasuserErrors || isErroredTransaction
 }
 
 // Returns true if all the errors/exceptions collected so far are expected errors
@@ -840,21 +848,12 @@ Transaction.prototype.hasOnlyExpectedErrors = function hasOnlyExpectedErrors() {
     return false
   }
 
-  for (let i = 0;i < this.exceptions.length;i++) {
+  for (let i = 0; i < this.exceptions.length; i++) {
     const exception = this.exceptions[i]
     // this exception is neither expected nor ignored
     const isUnexpected = !(
-      errorHelper.isExpectedException(
-        this,
-        exception.error,
-        this.agent.config,
-        urltils
-      ) ||
-      errorHelper.shouldIgnoreError(
-        this,
-        exception.error,
-        this.agent.config
-      )
+      errorHelper.isExpectedException(this, exception.error, this.agent.config, urltils) ||
+      errorHelper.shouldIgnoreError(this, exception.error, this.agent.config)
     )
     if (isUnexpected) {
       return false
@@ -869,8 +868,7 @@ Transaction.prototype.hasOnlyExpectedErrors = function hasOnlyExpectedErrors() {
 Transaction.prototype.getIntrinsicAttributes = function getIntrinsicAttributes() {
   if (!this._intrinsicAttributes.totalTime) {
     var config = this.agent.config
-    this._intrinsicAttributes.totalTime =
-      this.trace.getTotalTimeDurationInMillis() * FROM_MILLIS
+    this._intrinsicAttributes.totalTime = this.trace.getTotalTimeDurationInMillis() * FROM_MILLIS
 
     if (config.distributed_tracing.enabled) {
       this.addDistributedTraceIntrinsics(this._intrinsicAttributes)
@@ -882,8 +880,7 @@ Transaction.prototype.getIntrinsicAttributes = function getIntrinsicAttributes()
       )
       this._intrinsicAttributes.trip_id = this.tripId || this.id
       if (this.referringTransactionGuid) {
-        this._intrinsicAttributes.referring_transaction_guid =
-          this.referringTransactionGuid
+        this._intrinsicAttributes.referring_transaction_guid = this.referringTransactionGuid
       }
       if (this.incomingCatId) {
         this._intrinsicAttributes.client_cross_process_id = this.incomingCatId
@@ -911,7 +908,8 @@ function acceptDistributedTraceHeaders(transportType, headers) {
   if (headers == null || typeof headers !== 'object') {
     logger.trace(
       'Ignoring distributed trace headers for transaction %s. Headers not passed in as object.',
-      this.id)
+      this.id
+    )
     return
   }
 
@@ -995,8 +993,7 @@ function acceptTraceContextPayload(traceparent, tracestate, transport) {
     return
   }
 
-  const traceContext =
-    this.traceContext.acceptTraceContextPayload(traceparent, tracestate)
+  const traceContext = this.traceContext.acceptTraceContextPayload(traceparent, tracestate)
 
   if (traceContext.acceptedTraceparent) {
     this.acceptedDistributedTrace = true
@@ -1039,9 +1036,7 @@ function _acceptDistributedTracePayload(payload, transport) {
     if (this.parentId) {
       this.agent.recordSupportability('DistributedTrace/AcceptPayload/Ignored/Multiple')
     } else {
-      this.agent.recordSupportability(
-        'DistributedTrace/AcceptPayload/Ignored/CreateBeforeAccept'
-      )
+      this.agent.recordSupportability('DistributedTrace/AcceptPayload/Ignored/CreateBeforeAccept')
     }
     return
   }
@@ -1053,7 +1048,7 @@ function _acceptDistributedTracePayload(payload, transport) {
   if (!distTraceEnabled || !trustedAccount) {
     logger.debug(
       'Invalid configuration for distributed trace payload, not accepting ' +
-      '(distributed_tracing.enabled: %s, trustKey: %s',
+        '(distributed_tracing.enabled: %s, trustKey: %s',
       distTraceEnabled,
       trustedAccount
     )
@@ -1070,16 +1065,10 @@ function _acceptDistributedTracePayload(payload, transport) {
 
   if (!parsed.v || !parsed.d) {
     if (!parsed.v) {
-      logger.warn(
-        'Received a distributed trace payload with no version field',
-        this.id
-      )
+      logger.warn('Received a distributed trace payload with no version field', this.id)
     }
     if (!parsed.d) {
-      logger.warn(
-        'Received a distributed trace payload with no data field',
-        this.id
-      )
+      logger.warn('Received a distributed trace payload with no data field', this.id)
     }
     this.agent.recordSupportability('DistributedTrace/AcceptPayload/ParseException')
     return
@@ -1090,7 +1079,8 @@ function _acceptDistributedTracePayload(payload, transport) {
     logger.warn('Invalid distributed trace payload, not accepting')
     this.agent.recordSupportability('DistributedTrace/AcceptPayload/Exception')
   }
-  if (majorVersion > 0) { // TODO: Add DistributedTracePayload class?
+  if (majorVersion > 0) {
+    // TODO: Add DistributedTracePayload class?
     this.agent.recordSupportability('DistributedTrace/AcceptPayload/Ignored/MajorVersion')
     return
   }
@@ -1107,16 +1097,14 @@ function _acceptDistributedTracePayload(payload, transport) {
     return data[key] != null
   })
   // Either parentSpanId or parentId are required.
-  if (!requiredKeysExist || data.tx == null && data.id == null) {
+  if (!requiredKeysExist || (data.tx == null && data.id == null)) {
     this.agent.recordSupportability('DistributedTrace/AcceptPayload/ParseException')
     return
   }
 
   const trustedAccountKey = data.tk || data.ac
   if (trustedAccountKey !== trustedAccount) {
-    this.agent.recordSupportability(
-      `DistributedTrace/AcceptPayload/Ignored/UntrustedAccount`
-    )
+    this.agent.recordSupportability(`DistributedTrace/AcceptPayload/Ignored/UntrustedAccount`)
     return
   }
 
@@ -1161,11 +1149,7 @@ Transaction.prototype._getParsedPayload = function _getParsedPayload(payload) {
       try {
         payload = Buffer.from(payload, 'base64').toString('utf-8')
       } catch (err) {
-        logger.warn(
-          err,
-          'Got unparseable distributed trace payload in transaction %s',
-          this.id
-        )
+        logger.warn(err, 'Got unparseable distributed trace payload in transaction %s', this.id)
         this.agent.recordSupportability('DistributedTrace/AcceptPayload/ParseException')
         return null
       }
@@ -1173,11 +1157,7 @@ Transaction.prototype._getParsedPayload = function _getParsedPayload(payload) {
     try {
       parsed = JSON.parse(payload)
     } catch (err) {
-      logger.warn(
-        err,
-        'Failed to parse distributed trace payload in transaction %s',
-        this.id
-      )
+      logger.warn(err, 'Failed to parse distributed trace payload in transaction %s', this.id)
       this.agent.recordSupportability('DistributedTrace/AcceptPayload/ParseException')
       return null
     }
@@ -1200,8 +1180,8 @@ function _createDistributedTracePayload() {
   if (!accountId || !appId || !distTraceEnabled) {
     logger.debug(
       'Invalid configuration for distributed trace payload ' +
-      '(distributed_tracing.enabled: %s, account_id: %s, application_id: %s) ' +
-      'in transaction %s',
+        '(distributed_tracing.enabled: %s, account_id: %s, application_id: %s) ' +
+        'in transaction %s',
       distTraceEnabled,
       accountId,
       appId,
@@ -1293,15 +1273,17 @@ Transaction.prototype._calculatePriority = function _calculatePriority() {
 
     // Truncate the priority after potentially modifying it to avoid floating
     // point errors.
-    this.priority = (this.priority * 1e6 | 0) / 1e6
+    this.priority = ((this.priority * 1e6) | 0) / 1e6
   }
 }
 
 function _makeValueSet(obj) {
-  return Object.keys(obj).map((t) => obj[t]).reduce(function reduceToMap(o, t) {
-    o[t] = true
-    return o
-  }, Object.create(null))
+  return Object.keys(obj)
+    .map((t) => obj[t])
+    .reduce(function reduceToMap(o, t) {
+      o[t] = true
+      return o
+    }, Object.create(null))
 }
 
 Transaction.prototype.addRequestParameters = addRequestParameters

package/lib/transaction/name-state.js

@@ -5,7 +5,7 @@
 
 'use strict'
 
-var logger = require('../logger.js').child({component: 'name-state'})
+var logger = require('../logger.js').child({ component: 'name-state' })
 var NAMES = require('../metrics/names')
 
 // TODO: Figure out a way to phase out legacy transaction names.
@@ -45,7 +45,7 @@ NameState.prototype.setName = function setName(prefix, verb, delimiter, path) {
   this.setPrefix(prefix)
   this.verb = verb && verb.toUpperCase()
   this.delimiter = delimiter
-  this.pathStack = path ? [{path: path, params: null}] : []
+  this.pathStack = path ? [{ path: path, params: null }] : []
   this._pathCache = null
   this.markedPath = []
   logger.trace('setName called on name state, path stack now %j', this.pathStack)
@@ -77,8 +77,7 @@ NameState.prototype.setPrefix = function setPrefix(prefix) {
     this.prefix = null
     return
   }
-  this.prefix = (prefix[prefix.length - 1] === '/') ?
-    prefix.substring(0, prefix.length - 1) : prefix
+  this.prefix = prefix[prefix.length - 1] === '/' ? prefix.substring(0, prefix.length - 1) : prefix
 }
 
 /**
@@ -109,7 +108,7 @@ NameState.prototype.isEmpty = function isEmpty() {
 NameState.prototype.appendPath = function appendPath(path, params) {
   if (!this._frozen && path != null) {
     var strPath = path instanceof RegExp ? path.source : String(path)
-    this.pathStack.push({path: strPath, params: params || null})
+    this.pathStack.push({ path: strPath, params: params || null })
 
     if (path !== '') {
       this._pathCache = null
@@ -178,7 +177,7 @@ NameState.prototype.getPath = function getPath() {
     }
   }
 
-  return this._pathCache = path
+  return (this._pathCache = path)
 }
 
 NameState.prototype.getNameNotFound = function getNameNotFound() {