newrelic 9.6.0 → 9.7.0

package/lib/util/cat.js

@@ -32,9 +32,11 @@ const MATCH_CAT_APP_DATA_HEADER = new RegExp(
 /**
  * Decodes the CAT id and transaction headers from incoming request
  *
- * @param {Object} headers incoming headers
+ * @param {object} headers incoming headers
+ * @param id
+ * @param transactionId
  * @param {string} encKey config.encoding_key used to decode CAT headers
- * @param {Object} { externalId, externalTransaction }
+ * @param {object} { externalId, externalTransaction }
  */
 cat.parseCatData = function parseCatData(id, transactionId, encKey) {
   if (!encKey) {
@@ -106,11 +108,11 @@ cat.assignCatToTransaction = function assignCatToTransaction(
  * Encodes the data to be set on the CAT app data header
  * for incoming requests
  *
- * @param {Object} config agent config
+ * @param {object} config agent config
  * @param {Transaction} transaction
  * @param {string} contentLength
- * @param {Boolean} useMqHeaders flag to return proper headers for MQ compliance
- * @return {Object} { key, data} to add as header
+ * @param {boolean} useMqHeaders flag to return proper headers for MQ compliance
+ * @returns {object} { key, data} to add as header
  */
 cat.encodeAppData = function encodeAppData(config, transaction, contentLength, useMqHeaders) {
   let appData = null
@@ -144,10 +146,10 @@ cat.encodeAppData = function encodeAppData(config, transaction, contentLength, u
 /**
  * Adds CAT headers to outbound request.
  *
- * @param {Object} config agent config
+ * @param {object} config agent config
  * @param {Transaction} transaction
- * @param {Object} headers object that contains headers the agent is adding to client request
- * @param {Boolean} useMqHeaders flag to return proper headers for MQ compliance
+ * @param {object} headers object that contains headers the agent is adding to client request
+ * @param {boolean} useMqHeaders flag to return proper headers for MQ compliance
  */
 cat.addCatHeaders = function addCatHeaders(config, transaction, headers, useMqHeaders) {
   if (!config.encoding_key) {
@@ -189,8 +191,8 @@ cat.addCatHeaders = function addCatHeaders(config, transaction, headers, useMqHe
  * Find the CAT id, transaction, app data headers
  * from the headers of either HTTP or MQ request
  *
- * @param {Object} headers
- * @return {Object} { id, transactionId, appData }
+ * @param {object} headers
+ * @returns {object} { id, transactionId, appData }
  */
 cat.extractCatHeaders = function extractCatHeaders(headers) {
   // Hunt down the CAT headers.
@@ -218,9 +220,10 @@ cat.extractCatHeaders = function extractCatHeaders(headers) {
  * Extracts the account Id from CAT data and verifies if it is
  * a trusted account id
  *
- * @param {Object} CAT data
+ * @param {object} CAT data
+ * @param data
  * @param {Array} trustedAccounts from config
- * @return {Boolean}
+ * @returns {boolean}
  */
 cat.isTrustedAccountId = function isTrustedAccountId(data, trustedAccounts) {
   const accountId = parseInt(data.split('#')[0], 10)
@@ -235,7 +238,7 @@ cat.isTrustedAccountId = function isTrustedAccountId(data, trustedAccounts) {
  * Decodes the CAT App Data header and extracts the downstream
  * CAT id, transaction id
  *
- * @param {Object} config agent config
+ * @param {object} config agent config
  * @param {string} obfAppData encoded app data to parse and use
  * @param {Array} decoded app data header
  */

package/lib/util/codec.js

@@ -16,7 +16,6 @@ module.exports = {
    *
    * @param {object} data
    *  The data to encode.
-   *
    * @param {Function} callback
    *  The callback to take the results. The first parameter is any errors from
    *  encoding, and the second parameter is the encoded data object.
@@ -43,7 +42,6 @@ module.exports = {
    *
    * @param {object} encoded
    *  The data to decode.
-   *
    * @param {Function} callback
    *  The callback to take the results. The first parameter is any errors from
    *  decoding, and the second parameter is the decoded data object.

package/lib/util/copy.js

@@ -14,8 +14,7 @@ exports.shallow = shallowCopy
  *
  * @param {object} source     - The object to copy the properties from.
  * @param {object} [dest={}]  - The object to copy the properties to.
- *
- * @return {object} The destination object.
+ * @returns {object} The destination object.
  */
 function shallowCopy(source, dest) {
   dest = dest || Object.create(null)

package/lib/util/deep-equal.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 35] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 function isArguments(object) {
   return Object.prototype.toString.call(object) === '[object Arguments]'
 }
@@ -64,6 +66,11 @@ function slice(args) {
  *   object.
  * o Users of this function are cool with mutually recursive data structures
  *   that are otherwise identical being treated as the same.
+ *
+ * @param a
+ * @param b
+ * @param ca
+ * @param cb
  */
 function deeper(a, b, ca, cb) {
   if (a === b) {

package/lib/util/flatten.js

@@ -14,12 +14,11 @@ exports.keys = flatKeys
  * Ex: {a: 5, b: {c: true, d: 7}} -> {a: 5, 'b.c': true, 'b.d': 7}
  *
  * @private
- *
  * @param {object} result Object to place key-value pairs into, normally called with `{}`.
  * @param {string} prefix Prefix for keys, normally called with `''`.
+ * @param seen
  * @param {object} obj    Object to be flattened.
- *
- * @return {object} Object with flattened key-value pairs
+ * @returns {object} Object with flattened key-value pairs
  */
 function flatten(result, prefix, obj, seen) {
   seen = seen || []
@@ -44,12 +43,11 @@ function flatten(result, prefix, obj, seen) {
  * Retrieves all the keys that would exist in the flattened version of the object.
  *
  * @private
- *
  * @param {object}  obj       - The object to get the flat keys of.
  * @param {string}  prefix    - A prefix for the keys, usually `''`.
+ * @param arrayIdxs
  * @param {bool}    arrayIdx  - Flag indicating if array indexes should be iterated.
- *
- * @return {array.<string>} An array of keys names.
+ * @returns {Array.<string>} An array of keys names.
  */
 function flatKeys(obj, prefix, arrayIdxs) {
   const keys = []

package/lib/util/hashes.js

@@ -41,9 +41,7 @@ function calculatePathHash(appName, pathName, referingPathHash) {
   const result = (rotated ^ hash) >>> 0
 
   // This is a trick to pad it out to 8 chars regardless of length.
-  const retval = ('00000000' + result.toString(16)).substr(-8)
-
-  return retval
+  return ('00000000' + result.toString(16)).substr(-8)
 }
 
 function getHash(appName, txName) {

package/lib/util/process-version.js

@@ -17,8 +17,7 @@ exports.prerelease = prerelease
  * Safely checks if the process version satisfies the given semver range.
  *
  * @param {string} check - The semantic version range to check.
- *
- * @return {bool} True if the process version satisfies the given version, false
+ * @returns {bool} True if the process version satisfies the given version, false
  *  otherwise.
  */
 function satisfies(check) {
@@ -33,7 +32,7 @@ function satisfies(check) {
 /**
  * Safely checks if the process version is a pre-release version.
  *
- * @return {bool} True if the process version is pre-release, false otherwise.
+ * @returns {bool} True if the process version is pre-release, false otherwise.
  */
 function prerelease() {
   try {

package/lib/util/properties.js

@@ -16,11 +16,9 @@ const hasOwnProperty = Object.hasOwnProperty
  * property, thus avoiding the potential `undefined is not a function` error.
  *
  * @private
- *
  * @param {*}       obj - The item to check for the property on.
  * @param {string}  key - The name of the property to look for.
- *
- * @return {bool} True if the given object has its own property with the given
+ * @returns {bool} True if the given object has its own property with the given
  *  key.
  */
 exports.hasOwn = function hasOwn(obj, key) {
@@ -31,8 +29,7 @@ exports.hasOwn = function hasOwn(obj, key) {
  * Checks if a given object is empty.
  *
  * @param {*} obj - The object to check for properties on.
- *
- * @return {bool} True if the object has no keys of its own.
+ * @returns {bool} True if the object has no keys of its own.
  */
 exports.isEmpty = function isEmpty(obj) {
   // Use this case for null prototyped objects.

package/lib/util/stream-sink.js

@@ -12,6 +12,8 @@ const util = require('util')
  * Pipe a readable stream into this sink that fulfills the Writable Stream
  * contract and the callback will be fired when the stream has been completely
  * read.
+ *
+ * @param callback
  */
 function StreamSink(callback) {
   EventEmitter.call(this)

package/lib/util/urltils.js

@@ -25,7 +25,7 @@ module.exports = {
   /**
    * Dictionary whose keys are all synonyms for localhost.
    *
-   * @const
+   * @constant
    */
   LOCALHOST_NAMES: LOCALHOST_NAMES,
 
@@ -33,8 +33,7 @@ module.exports = {
    * Checks if the given name is in the dictionary of localhost names.
    *
    * @param {string} host - The hostname to lookup.
-   *
-   * @return {bool} - True if the given hostname is a synonym for localhost.
+   * @returns {bool} - True if the given hostname is a synonym for localhost.
    */
   isLocalhost: function isLocahost(host) {
     return LOCALHOST_NAMES[host] != null
@@ -47,7 +46,6 @@ module.exports = {
    *
    * @param {Config} config The configuration containing the error list.
    * @param {string} code   The HTTP status code to check.
-   *
    * @returns {bool} Whether the status code should be ignored.
    */
   isError: function isError(config, code) {
@@ -59,7 +57,6 @@ module.exports = {
    *
    * @param {Config} config The configuration containing the error list.
    * @param {string} code   The HTTP status code to check.
-   *
    * @returns {bool} Whether the status code should be ignored.
    */
   isIgnoredError: function isIgnoredError(config, code) {
@@ -71,9 +68,7 @@ module.exports = {
    *
    * @param {Config} config The configuration containing the error list.
    * @param {string} code   The HTTP status code to check.
-   *
    * @returns {bool} Whether the status code is expected.
-   *
    */
   isExpectedError: function isExpectedError(config, code) {
     return isExpectedStatusCodeForErrors(config, code)
@@ -88,7 +83,7 @@ module.exports = {
    * 3. Remove trailing slash.
    *
    * @param {string} requestURL The URL fragment to be scrubbed.
-   * @return {string} The cleaned URL.
+   * @returns {string} The cleaned URL.
    */
   scrub: function scrub(requestURL) {
     if (typeof requestURL === 'string') {
@@ -153,8 +148,7 @@ module.exports = {
    * only a single parse of the given URL.
    *
    * @param {string} requestURL - The URL to scrub and extra parameters from.
-   *
-   * @return {object} An object containing the scrubbed url at `.path` and the
+   * @returns {object} An object containing the scrubbed url at `.path` and the
    *  parsed parameters at `.parameters`.
    */
   scrubAndParseParameters: function scrubAndParseParameters(requestURL) {

package/newrelic.js

@@ -35,7 +35,7 @@ exports.config = {
      *
      * NOTE: If excluding headers, they must be in camelCase form to be filtered.
      *
-     * @env NEW_RELIC_ATTRIBUTES_EXCLUDE
+     * @name NEW_RELIC_ATTRIBUTES_EXCLUDE
      */
     exclude: [
       'request.headers.cookie',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "9.6.0",
+  "version": "9.7.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -213,6 +213,7 @@
     "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-sonarjs": "^0.15.0",
     "express": "*",
     "glob": "^7.1.2",
     "got": "^11.8.5",