newrelic 9.5.0 → 9.7.0

package/lib/shim/datastore-shim.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 52] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const dbutil = require('../db/utils')
 const hasOwnProperty = require('../util/properties').hasOwn
 const logger = require('../logger').child({ component: 'DatastoreShim' })
@@ -14,6 +16,7 @@ const ParsedStatement = require('../db/parsed-statement')
 const Shim = require('./shim')
 const urltils = require('../util/urltils')
 const util = require('util')
+const symbols = require('../symbols')
 
 /**
  * An enumeration of well-known datastores so that new instrumentations can use
@@ -67,26 +70,21 @@ const QUERY_PARSERS = {
  * Constructs a shim associated with the given agent instance, specialized for
  * instrumenting datastores.
  *
- * @constructor
- * @extends Shim
+ * @class
+ * @augments Shim
  * @classdesc
  *  A helper class for wrapping datastore modules.
- *
  * @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.
- *
  * @param {string} [datastoreId]
  *  The name of the datastore being instrumented. If available, use one of the
  *  values from {@link DatastoreShim.DATASTORE_NAMES}.
  *  Calls {@link DatastoreShim#setDatastore} if datastoreId is
  *  specified.
- *
  * @see Shim
  * @see DatastoreShim.DATASTORE_NAMES
  */
@@ -130,25 +128,18 @@ DatastoreShim.prototype.getDatabaseNameFromUseQuery = getDatabaseNameFromUseQuer
 
 /**
  * @callback QuerySpecFunction
- *
  * @summary
  *  Used for determining information about a query when it can not be simply
  *  found in the arguments.
- *
  * @param {Shim} shim
  *  The shim this function was passed to.
- *
  * @param {Function} func
  *  The function being recorded.
- *
  * @param {string} name
  *  The name of the function.
- *
  * @param {Array.<*>} args
  *  The arguments being passed into the function.
- *
- * @return {QuerySpec} The spec for how this query should be recorded.
- *
+ * @returns {QuerySpec} The spec for how this query should be recorded.
  * @see DatastoreShim#recordQuery
  * @see DatastoreShim#recordBatchQuery
  * @see QuerySpec
@@ -156,68 +147,50 @@ DatastoreShim.prototype.getDatabaseNameFromUseQuery = getDatabaseNameFromUseQuer
 
 /**
  * @callback QueryFunction
- *
  * @summary
  *  Pulls the query argument out from an array of arguments.
- *
  * @param {Shim} shim
  *  The shim this function was passed to.
- *
  * @param {Function} func
  *  The function being recorded.
- *
  * @param {string} name
  *  The name of the function.
- *
  * @param {Array.<*>} args
  *  The arguments being passed into the function.
- *
- * @return {string} The query string from the arguments list.
- *
+ * @returns {string} The query string from the arguments list.
  * @see QuerySpec
  * @see QuerySpecFunction
  */
 
 /**
  * @callback QueryParserFunction
- *
  * @summary
  *  Used to parse queries to extract the basic information about it.
- *
  * @param {string} query - The query to be parsed.
- *
- * @return {ParsedQueryData} An object containing the basic information about
+ * @returns {ParsedQueryData} An object containing the basic information about
  *  the query.
- *
  * @see DatastoreShim#setParser
  * @see ParsedQueryData
  */
 
 /**
  * @interface OperationSpec
- *
  * @description
  *  Describes the interface for an operation function.
- *
  * @property {string} [name]
  *  The name for this operation. If omitted, the operation function's name will
  *  used instead.
- *
  * @property {DatastoreParameters} [parameters]
  *  Extra parameters to be set on the metric for the operation.
- *
  * @property {bool} [record=true]
  *  Indicates if the operation should be recorded as a metric. A segment will be
  *  created even if this is `false`.
- *
  * @property {number|CallbackBindFunction} [callback]
  *  If a number, it is the offset in the arguments array for the operation's
  *  callback argument. If it is a function, it should perform the segment
  *  binding to the callback.
- *
  * @property {bool} [promise=false]
  *  If `true`, the return value will be wrapped as a Promise.
- *
  * @see DatastoreShim#recordOperation
  * @see QuerySpec
  * @see DatastoreParameters
@@ -225,20 +198,16 @@ DatastoreShim.prototype.getDatabaseNameFromUseQuery = getDatabaseNameFromUseQuer
 
 /**
  * @interface QuerySpec
- * @extends OperationSpec
- *
+ * @augments OperationSpec
  * @description
  *  Describes the interface for a query function. Extends {@link OperationSpec}
  *  with query-specific parameters.
- *
  * @property {bool} [stream=false]
  *  If `true`, the return value will be wrapped as a stream.
- *
  * @property {number|string|QueryFunction} query
  *  If a number, it is the offset in the arguments array for the query string
  *  argument. If a string, it is the query being executed. If a function, it
  *  will be passed the arguments and must return the query string.
- *
  * @see DatastoreShim#recordQuery
  * @see DatastoreShim#recordBatchQuery
  * @see QuerySpecFunction
@@ -249,44 +218,34 @@ DatastoreShim.prototype.getDatabaseNameFromUseQuery = getDatabaseNameFromUseQuer
 
 /**
  * @interface DatastoreParameters
- *
  * @description
  *  Extra parameters which may be added to an operation or query segment. All of
  *  these properties are optional.
- *
  * @property {string} host
  *  The host of the database server being interacted with. If provided, along
  *  with `port_path_or_id`, then an instance metric will also be generated for
  *  this database.
- *
  * @property {number|string} port_path_or_id
  *  The port number or path to domain socket used to connect to the database
  *  server.
- *
  * @property {string} database_name
  *  The name of the database being queried or operated on.
- *
  * @see OperationSpec
  * @see QuerySpec
  */
 
 /**
  * @interface ParsedQueryData
- *
  * @description
  *  Returned by a {@link QueryParserFunction}, this information is used to
  *  generate the name for recording datastore queries.
- *
  * @property {string} operation
  *  The datastore operation such as `SELECT` or `UPDATE`.
- *
  * @property {string} collection
  *  The collection being queried. This would be the table name from a SQL
  *  statement or the collection name in a MongoDB query.
- *
  * @property {string} [query]
  *  The query with any sensitive information redacted and comments removed.
- *
  * @see DatastoreShim#setParser
  * @see QueryParserFunction
  */
@@ -303,11 +262,9 @@ DatastoreShim.prototype.getDatabaseNameFromUseQuery = getDatabaseNameFromUseQuer
  * segments or metrics.
  *
  * @memberof DatastoreShim.prototype
- *
  * @param {string} datastore
  *  The name of this datastore. Use one of the well-known constants listed in
  *  {@link DatastoreShim.DATASTORE_NAMES} if available for the datastore.
- *
  * @see DatastoreShim.DATASTORE_NAMES
  * @see DatastoreShim#recordBatchQuery
  * @see DatastoreShim#recordQuery
@@ -333,12 +290,10 @@ function setDatastore(datastore) {
  * Sets the query parser used by this shim instance.
  *
  * @memberof DatastoreShim.prototype
- *
  * @param {string|QueryParserFunction} parser
  *  The string used to look up a default parser or the function used to parse
  *  queries. It is recommended that you use one of the well-known constants if
  *  available in the {@link DatastoreShim.QUERY_PARSERS}.
- *
  * @see DatastoreShim.QUERY_PARSERS
  * @see QueryParserFunction
  * @see ParsedQueryData
@@ -374,20 +329,15 @@ function setParser(parser) {
  * will result in an exception.
  *
  * @memberof DatastoreShim.prototype
- *
- * @param {Object|Function} nodule
+ * @param {object | Function} nodule
  *  The source for the properties to wrap, or a single function to wrap.
- *
  * @param {string|Array.<string>} [properties]
  *  One or more properties to wrap. If omitted, the `nodule` parameter is
  *  assumed to be the function to wrap.
- *
  * @param {OperationSpec|SegmentFunction} opSpec
  *  The spec for this operation function.
- *
- * @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 Shim#wrap
  * @see Shim#record
  * @see OperationSpec
@@ -451,20 +401,15 @@ function recordOperation(nodule, properties, opSpec) {
  * will result in an exception.
  *
  * @memberof DatastoreShim.prototype
- *
- * @param {Object|Function} nodule
+ * @param {object | Function} nodule
  *  The source for the properties to wrap, or a single function to wrap.
- *
  * @param {string|Array.<string>} [properties]
  *  One or more properties to wrap. If omitted, the `nodule` parameter is
  *  assumed to be the function to wrap.
- *
  * @param {QuerySpec|QuerySpecFunction} querySpec
  *  The spec for this query function.
- *
- * @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 Shim#wrap
  * @see Shim#record
  * @see DatastoreShim#recordBatchQuery
@@ -489,20 +434,15 @@ function recordQuery(nodule, properties, querySpec) {
  * will result in an exception.
  *
  * @memberof DatastoreShim.prototype
- *
- * @param {Object|Function} nodule
+ * @param {object | Function} nodule
  *  The source for the properties to wrap, or a single function to wrap.
- *
  * @param {string|Array.<string>} [properties]
  *  One or more properties to wrap. If omitted, the `nodule` parameter is
  *  assumed to be the function to wrap.
- *
  * @param {QuerySpec|QuerySpecFunction} querySpec
  *  The spec for this query function.
- *
- * @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 Shim#wrap
  * @see Shim#record
  * @see DatastoreShim#recordQuery
@@ -521,13 +461,9 @@ function recordBatchQuery(nodule, properties, querySpec) {
  * will result in an exception.
  *
  * @memberof DatastoreShim.prototype
- *
  * @param {string} query - The query to parse.
- *
- * @param {Object} nodule - Context for the queryParse to run under.
- *
- * @return {ParsedStatement} The parsed query object.
- *
+ * @param {object} nodule - Context for the queryParse to run under.
+ * @returns {ParsedStatement} The parsed query object.
  * @see DatastoreShim#setParser
  */
 function parseQuery(query, nodule) {
@@ -562,13 +498,10 @@ function parseQuery(query, nodule) {
  * - `bindRowCallbackSegment(args, cbIdx [, parentSegment])`
  *
  * @memberof DatastoreShim.prototype
- *
  * @param {Array} args
  *  The arguments array to replace the callback in.
- *
- * @param {Number} cbIdx
+ * @param {number} cbIdx
  *  The index of the callback in the arguments array.
- *
  * @param {TraceSegment} [parentSegment]
  *  Optional. The segment to be the parent row callback's segment. Defaults to
  *  the segment active when the row callback is first called.
@@ -616,7 +549,7 @@ function bindRowCallbackSegment(args, cbIdx, parentSegment) {
   }, parentSegment)
 
   // Mark this as wrapped and put it in the args array.
-  this.setInternalProperty(wrapper, '__NR_original', cb)
+  wrapper[symbols.original] = cb
   args[idx] = wrapper
 }
 
@@ -626,7 +559,6 @@ function bindRowCallbackSegment(args, cbIdx, parentSegment) {
  * If the current segment was not created by this shim then no action is taken.
  *
  * @memberof DatastoreShim.prototype
- *
  * @param {string}        host      - The name of the database host.
  * @param {number|string} port      - The port, path, or ID of the database server.
  * @param {string}        database  - The name of the database in use.
@@ -661,8 +593,7 @@ function captureInstanceAttributes(host, port, database) {
  * Parses the database name from a `USE` SQL query.
  *
  * @param {string} query - The SQL query to parse the database name from.
- *
- * @return {?string} The name of the database if it could be parsed, otherwise
+ * @returns {?string} The name of the database if it could be parsed, otherwise
  *  `null`.
  */
 function getDatabaseNameFromUseQuery(query) {
@@ -682,23 +613,17 @@ function getDatabaseNameFromUseQuery(query) {
  *
  * @private
  * @this DatastoreShim
- *
  * @param {string} suffix
  *  Suffix to be added to the segment name.
- *
- * @param {Object|Function} nodule
+ * @param {object | Function} nodule
  *  The source for the properties to wrap, or a single function to wrap.
- *
  * @param {string|Array.<string>} [properties]
  *  One or more properties to wrap. If omitted, the `nodule` parameter is
  *  assumed to be the function to wrap.
- *
  * @param {QuerySpec|QueryFunction} querySpec
  *  The spec for this query function.
- *
- * @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 Shim#wrap
  * @see Shim#record
  * @see DatastoreShim#recordQuery
@@ -785,10 +710,8 @@ function _recordQuery(suffix, nodule, properties, querySpec) {
  * @private
  * @this DatastoreShim
  * @implements {MetricFunction}
- *
  * @param {TraceSegment}  segment - The segment being recorded.
  * @param {string}        [scope] - The scope of the segment.
- *
  * @see DatastoreShim#recordOperation
  * @see MetricFunction
  */
@@ -838,14 +761,12 @@ function _recordOperationMetrics(segment, scope) {
  *
  * @private
  * @this DatastoreShim
- *
  * @param {Function}  fn      - The query function to be executed.
  * @param {string}    fnName  - The name of the query function.
  * @param {QuerySpec} spec    - The query spec.
  * @param {*}         ctx     - The context of the query function's execution.
  * @param {Array}     args    - The arguments for the query function.
- *
- * @return {?string} The query from the arguments if found, otherwise `null`.
+ * @returns {?string} The query from the arguments if found, otherwise `null`.
  */
 function _extractQueryStr(fn, fnName, spec, ctx, args) {
   let queryStr = spec.query
@@ -873,10 +794,8 @@ function _extractQueryStr(fn, fnName, spec, ctx, args) {
  *
  * @private
  * @this DatastoreShim
- *
  * @param {object} [parameters={}] - The segment parameters to clean up.
- *
- * @return {object} - The normalized segment parameters.
+ * @returns {object} - The normalized segment parameters.
  */
 function _normalizeParameters(parameters) {
   parameters = parameters || Object.create(null)

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' })