newrelic 9.6.0 → 9.7.0

package/lib/metrics/names.js

@@ -10,6 +10,10 @@ const NODEJS = {
 }
 
 const ALL = 'all'
+const POSTGRES_LITERAL = 'Postgres'
+const CASSANDRA_LITERAL = 'Cassandra'
+const EXPRESS_LITERAL = 'Expressjs'
+const OTHER_TRANSACTION_MESSAGE = 'OtherTransaction/Message'
 
 const SUPPORTABILITY = {
   PREFIX: 'Supportability/',
@@ -133,24 +137,24 @@ const REDIS = {
 }
 
 const POSTGRES = {
-  PREFIX: 'Postgres',
-  STATEMENT: DB.STATEMENT + '/Postgres/',
-  OPERATION: DB.OPERATION + '/Postgres/',
-  INSTANCE: DB.INSTANCE + '/Postgres/'
+  PREFIX: POSTGRES_LITERAL,
+  STATEMENT: DB.STATEMENT + `/${POSTGRES_LITERAL}/`,
+  OPERATION: DB.OPERATION + `/${POSTGRES_LITERAL}/`,
+  INSTANCE: DB.INSTANCE + `/${POSTGRES_LITERAL}/`
 }
 
 const CASSANDRA = {
-  PREFIX: 'Cassandra',
-  OPERATION: DB.OPERATION + '/Cassandra/',
-  STATEMENT: DB.STATEMENT + '/Cassandra/',
-  INSTANCE: DB.INSTANCE + '/Cassandra/',
-  ALL: DB.PREFIX + 'Cassandra/' + ALL
+  PREFIX: CASSANDRA_LITERAL,
+  OPERATION: DB.OPERATION + `/${CASSANDRA_LITERAL}/`,
+  STATEMENT: DB.STATEMENT + `/${CASSANDRA_LITERAL}/`,
+  INSTANCE: DB.INSTANCE + `/${CASSANDRA_LITERAL}/`,
+  ALL: DB.PREFIX + `${CASSANDRA_LITERAL}/` + ALL
 }
 
 const EXPRESS = {
-  PREFIX: 'Expressjs/',
-  MIDDLEWARE: MIDDLEWARE.PREFIX + 'Expressjs/',
-  ERROR_HANDLER: MIDDLEWARE.PREFIX + 'Expressjs/'
+  PREFIX: `${EXPRESS_LITERAL}/`,
+  MIDDLEWARE: MIDDLEWARE.PREFIX + `${EXPRESS_LITERAL}/`,
+  ERROR_HANDLER: MIDDLEWARE.PREFIX + `${EXPRESS_LITERAL}/`
 }
 
 const RESTIFY = {
@@ -216,12 +220,12 @@ const OTHER_TRANSACTION = {
   PREFIX: 'OtherTransaction',
   RESPONSE_TIME: 'OtherTransaction',
   TOTAL_TIME: 'OtherTransactionTotalTime',
-  MESSAGE: 'OtherTransaction/Message'
+  MESSAGE: OTHER_TRANSACTION_MESSAGE
 }
 
 const MESSAGE_TRANSACTION = {
-  PREFIX: 'OtherTransaction/Message',
-  RESPONSE_TIME: 'OtherTransaction/Message',
+  PREFIX: OTHER_TRANSACTION_MESSAGE,
+  RESPONSE_TIME: OTHER_TRANSACTION_MESSAGE,
   TOTAL_TIME: 'OtherTransactionTotalTime/Message'
 }
 

package/lib/metrics/normalizer/rule.js

@@ -9,6 +9,8 @@ const logger = require('../../logger').child({ component: 'normalizer_rule' })
 
 /**
  * JavaScript just has to do things slightly differently.
+ *
+ * @param input
  */
 const replaceReplacer = function replaceReplacer(input) {
   return input.replace(/\\/g, '$')
@@ -20,7 +22,7 @@ const replaceReplacer = function replaceReplacer(input) {
  * fairly straightforward mapping of the concepts in metric normalization
  * rules into an object form.
  *
- * @param {Object} json A JavaScript object literal parsed out from the JSON
+ * @param {object} json A JavaScript object literal parsed out from the JSON
  *                      from the collector.
  */
 function NormalizerRule(json) {
@@ -74,8 +76,7 @@ NormalizerRule.prototype.getSegments = function getSegments(input) {
  * Does not set {NormalizerRule#matched}.
  *
  * @param {string} input - URL to match.
- *
- * @return {bool} - True if this rule matches the given input, otherwise false.
+ * @returns {bool} - True if this rule matches the given input, otherwise false.
  */
 NormalizerRule.prototype.matches = function matches(input) {
   const segments = this.getSegments(input)
@@ -106,8 +107,7 @@ NormalizerRule.prototype.matches = function matches(input) {
  * XXX `RegExp#lastIndex` to `0`.
  *
  * @param {string} input - URL to normalize.
- *
- * @return {string?} - The normalized url, or `null` if this is an ignore rule
+ * @returns {string?} - The normalized url, or `null` if this is an ignore rule
  *  that matched this url.
  */
 NormalizerRule.prototype.apply = function apply(input) {
@@ -150,8 +150,7 @@ NormalizerRule.prototype.toJSON = function toJSON() {
  *
  * @param {RegExp} re     - The regular expression to add flags to.
  * @param {string} flags  - The flags to add to the regex.
- *
- * @return {RegExp} - A regular expression with all the given flags added.
+ * @returns {RegExp} - A regular expression with all the given flags added.
  */
 function _addRegExpFlags(re, flags) {
   let foundMissing = false

package/lib/metrics/normalizer/tx_segment.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 17] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const logger = require('../../logger').child({ component: 'tx_segment_normalizer' })
 
 module.exports = TxSegmentNormalizer
@@ -29,8 +31,7 @@ function TxSegmentNormalizer() {
  *  6. Join together the modified segments with slashes, and re-prepend the prefix.
  *
  * @param {string} path - The transaction metric path to normalize.
- *
- * @return {NormalizationResults} - The results of normalizing the given path.
+ * @returns {NormalizationResults} - The results of normalizing the given path.
  */
 TxSegmentNormalizer.prototype.normalize = function normalize(path) {
   let currentTerm

package/lib/metrics/normalizer.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 24] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const EventEmitter = require('events').EventEmitter
 const util = require('util')
 const logger = require('../logger').child({ component: 'metric_normalizer' })
@@ -41,6 +43,7 @@ function plain(normalized, path) {
  * @param {object} config The agent's configuration blob, which has a parameter
  *                        that indicates whether to enforce the normalization
  *                        backstop.
+ * @param type
  */
 function MetricNormalizer(config, type) {
   if (!config) {
@@ -68,8 +71,7 @@ util.inherits(MetricNormalizer, EventEmitter)
 // -------------------------------------------------------------------------- //
 
 /**
- * @typedef {Object} NormalizationResults
- *
+ * @typedef {object} NormalizationResults
  * @property {bool}   matched - True if a rule was found that matched.
  * @property {bool}   ignore  - True if the given input should be ignored.
  * @property {string} value   - The normalized input value.
@@ -83,6 +85,7 @@ util.inherits(MetricNormalizer, EventEmitter)
  *
  * @param object json The de-serialized JSON response sent on collector
  *                    connection.
+ * @param json
  */
 MetricNormalizer.prototype.load = function load(json) {
   if (json) {
@@ -196,7 +199,6 @@ MetricNormalizer.prototype.addSimple = function addSimple(pattern, name) {
  * Turn a (scrubbed) URL path into partial metric name.
  *
  * @param {string} path - The URL path to turn into a name.
- *
  * @returns {NormalizationResults} - The results of normalization.
  */
 MetricNormalizer.prototype.normalize = function normalize(path) {

package/lib/parse-proc-cpuinfo.js

@@ -6,10 +6,15 @@
 'use strict'
 
 const logger = require('./logger.js').child({ component: 'proc-cpuinfo' })
+const PHYSICAL_ID = 'physical id'
+const CPU_CORES = 'cpu cores'
+const PROCESSOR = 'processor'
+const CORE_ID = 'core id'
+
 module.exports = parseProcCPUInfo
 
 function parseProcCPUInfo(data) {
-  const relevantAttributes = ['processor', 'physical id', 'cpu cores', 'core id']
+  const relevantAttributes = [PROCESSOR, PHYSICAL_ID, CPU_CORES, CORE_ID]
 
   let processorStats = {
     logical: null,
@@ -102,12 +107,12 @@ function countProcessorStats(processors) {
   for (let i = 0; i < processors.length; i++) {
     const processor = processors[i]
     if (
-      processor['physical id'] &&
-      processor['cpu cores'] &&
-      phys.indexOf(processor['physical id']) === -1
+      processor[PHYSICAL_ID] &&
+      processor[CPU_CORES] &&
+      phys.indexOf(processor[PHYSICAL_ID]) === -1
     ) {
-      phys.push(processor['physical id'])
-      cores.push(processor['cpu cores'])
+      phys.push(processor[PHYSICAL_ID])
+      cores.push(processor[CPU_CORES])
     }
   }
 

package/lib/serverless/api-gateway.js

@@ -38,8 +38,7 @@ class LambdaProxyWebResponse {
 /**
  * Determines if Lambda event appears to be a valid Lambda Proxy event.
  *
- * @param {Object} event The event to inspect.
- *
+ * @param {object} event The event to inspect.
  * @returns {boolean} Whether the given object contains fields necessary
  *                    to create a web transaction.
  */
@@ -50,8 +49,8 @@ function isLambdaProxyEvent(event) {
 /**
  * Determines if Lambda event appears to be a valid Lambda Proxy response.
  *
- * @param {Object} event The response to inspect.
- *
+ * @param {object} event The response to inspect.
+ * @param response
  * @returns {boolean} Whether the given object contains fields necessary
  *                    to create a web transaction.
  */

package/lib/serverless/aws-lambda.js

@@ -5,6 +5,8 @@
 
 'use strict'
 
+/* eslint sonarjs/cognitive-complexity: ["error", 29] -- TODO: https://issues.newrelic.com/browse/NEWRELIC-5252 */
+
 const apiGateway = require('./api-gateway')
 const headerAttributes = require('../header-attributes')
 const get = require('../util/get')
@@ -348,12 +350,10 @@ function setWebRequest(shim, transaction, request) {
 }
 
 function lowercaseObjectKeys(original) {
-  const lowercaseObject = Object.keys(original).reduce((destination, key) => {
+  return Object.keys(original).reduce((destination, key) => {
     destination[key.toLowerCase()] = original[key]
     return destination
   }, {})
-
-  return lowercaseObject
 }
 
 function endTransaction(transaction, enderIndex) {

package/lib/shim/conglomerate-shim.js

@@ -22,7 +22,7 @@ const SHIM_CLASSES = {
  * A shim for wrapping all-in-one modules which implement multiple services.
  *
  * @private
- * @extends Shim
+ * @augments Shim
  */
 class ConglomerateShim extends Shim {
   constructor(agent, moduleName, resolvedName) {
@@ -56,8 +56,7 @@ class ConglomerateShim extends Shim {
    *
    * @param {MODULE_TYPE} type  - The type of shim to construct.
    * @param {string} submodule  - The name of the submodule this will instrument.
-   *
-   * @return {Shim} A new shim of the given type.
+   * @returns {Shim} A new shim of the given type.
    */
   makeSpecializedShim(type, submodule) {
     const ShimClass = SHIM_CLASSES[type]

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' })
@@ -68,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
  */
@@ -131,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
@@ -157,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
@@ -226,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
@@ -250,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
  */
@@ -304,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
@@ -334,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
@@ -375,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
@@ -452,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
@@ -490,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
@@ -522,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) {
@@ -563,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.
@@ -627,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.
@@ -662,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) {
@@ -683,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
@@ -786,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
  */
@@ -839,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
@@ -874,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)