style: Require jsdoc require-param-description and require-param-type (newrelic#3391)

Author: amychisholm03

eslint.config.js

@@ -69,13 +69,16 @@ const jsdocConfig = {
           'Tracer',
           'Exception',
           'MetricAggregator',
+          'Metrics',
           'EventEmitter',
           'Context'
         ]
       }
     ],
     'jsdoc/valid-types': 'error',
-    'jsdoc/check-param-names': 'error'
+    'jsdoc/check-param-names': 'error',
+    'jsdoc/require-param-description': 'error',
+    'jsdoc/require-param-type': 'error',
   }
 }
 const jsdocOverrides = {

lib/attributes.js

@@ -68,7 +68,7 @@ class Attributes {
    * in the list of allowed destinations. If there is a limit on the number of
    * attributes allowed, no more than that number will be included in the result.
    *
-   * @param {AttributeFilter.DESTINATIONS} dest
+   * @param {AttributeFilter.DESTINATIONS} dest - Allowed destinations
    * @returns {object}
    */
   get(dest) {
@@ -92,7 +92,7 @@ class Attributes {
   /**
    * Checks if a given key exists in the instance attributes object.
    *
-   * @param {string} key
+   * @param {string} key the key to check
    */
   has(key) {
     return !!this.attributes[key]
@@ -163,8 +163,8 @@ class Attributes {
    * Returns true if a given key is valid for any of the
    * provided destinations.
    *
-   * @param {DESTINATIONS} destinations
-   * @param {string} key
+   * @param {DESTINATIONS} destinations - The destinations to check against.
+   * @param {string} key the key to check
    */
   hasValidDestination(destinations, key) {
     const validDestinations = this.filter(destinations, key)

lib/collector/facts.js

@@ -130,7 +130,7 @@ function getAllIPAddresses() {
  * connections are the same real agent or a separate one.
  * https://github.com/newrelic/node-newrelic/issues/654
  *
- * @param appNames
+ * @param {Array<string>} appNames list of app names
  */
 function getIdentifierOverride(appNames) {
   return [

lib/collector/http-agents.js

@@ -19,7 +19,7 @@ let agentProxyWithKeepAlive = null
 /**
  * Returns an HTTP agent with keep-alive enabled
  *
- * @param config
+ * @param {Object} config configuration for HTTP agent
  */
 exports.keepAliveAgent = function keepAliveAgent(config) {
   config = config ? config : {}
@@ -45,7 +45,7 @@ exports.keepAliveAgent = function keepAliveAgent(config) {
  * to the proxy server as to how its connection is made
  * with New Relic's servers.
  *
- * @param config
+ * @param {Object} config configuration for proxy agent
  */
 exports.proxyAgent = function proxyAgent(config) {
   if (agentProxyWithKeepAlive !== null) {

lib/collector/remote-method.js

@@ -281,7 +281,7 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
  * Generate the request headers and wire up the request. There are many
  * parameters used to make a request:
  *
- * @param options
+ * @param {object} options options object
  * @param {string}   options.host       Hostname (or proxy hostname) for collector.
  * @param {string}   options.port       Port (or proxy port) for collector.
  * @param {string}   options.path       URL path for method being invoked on collector.
@@ -363,7 +363,7 @@ RemoteMethod.prototype._path = function _path({ redactLicenseKey } = {}) {
 }
 
 /**
- * @param {object} options
+ * @param {object} options options object
  * @param {number} options.body       - Data to be sent.
  * @param {object} options.nrHeaders  - NR request headers from the connect response.
  * @param {boolean}   options.compressed - The compression method used, if any.
@@ -401,7 +401,7 @@ RemoteMethod.prototype._headers = function _headers(options) {
  *
  * FIXME: come up with a better heuristic
  *
- * @param data
+ * @param {*} data the data that might get compressed
  */
 RemoteMethod.prototype._shouldCompress = function _shouldCompress(data) {
   return data && byteLength(data) > 65536

lib/config/index.js

@@ -1529,8 +1529,8 @@ function _laspReponse(keys) {
 /**
  * Applies the server side LASP policies to a local configuration object
  *
- * @param agent
- * @param {object} policies server side LASP policy
+ * @param {Agent} agent Agent instance
+ * @param {bject} policies server side LASP policy
  * @returns {object} { missingRequired, finalPolicies } list of missing required fields and finalized LASP policy
  */
 Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
@@ -1595,7 +1595,7 @@ Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
  * by the agent, if LASP-enabled. Responds with an error to shut down
  * the agent if necessary.
  *
- * @param agent
+ * @param {Agent} agent Agent instance
  * @param {object} policies lasp policy
  * @returns {CollectorResponse} The result of the processing, with the known
  *  policies as the response payload.
@@ -1745,9 +1745,9 @@ Config.prototype._warnDeprecations = function _warnDeprecations() {
  * the environment variables will override their corresponding
  * configuration file settings.
  *
- * @param {object} config Optional configuration to be used in place of a config file.
- * @param root0
- * @param root0.loggerInstance
+ * @param {object} [config] Optional configuration to be used in place of a config file.
+ * @param {object} [deps] Optional dependencies
+ * @param {object} [deps.loggerInstance] Logger instance
  * @returns {object} instantiated configuration object
  */
 function initialize(config, { loggerInstance } = {}) {

lib/harvester.js

@@ -74,7 +74,7 @@ module.exports = class Harvester {
   /**
    * Registers an aggregator with the Harvester instance.
    *
-   * @param aggregator
+   * @param {Object} aggregator Aggregator instance
    */
   add(aggregator) {
     this.aggregators.push(aggregator)

lib/header-processing.js

@@ -15,8 +15,8 @@ const CONTENT_LENGTH_REGEX = /^Content-Length$/i
  * Queue time is provided by certain providers by stamping the request
  * header with the time the request arrived at the router.
  *
- * @param {*} logger
- * @param {*} requestHeaders
+ * @param {Object} logger Logger instance
+ * @param {Object} requestHeaders Incoming request headers
  */
 function getQueueTime(logger, requestHeaders) {
   const headerValue = requestHeaders[REQUEST_START_HEADER] || requestHeaders[QUEUE_HEADER]
@@ -62,7 +62,7 @@ function convertUnit(time) {
  *
  * If no header is found, returns -1
  *
- * @param {*} headers
+ * @param {Object} headers Incoming request headers
  */
 function getContentLengthFromHeaders(headers) {
   const contentLength = -1

lib/instrumentation/@node-redis/client.js

@@ -43,7 +43,7 @@ module.exports = function initialize(_agent, redis, _moduleName, shim) {
 /**
  * Instruments a given command when added to the command queue by calling `shim.recordOperation`
  *
- * @param {object} params
+ * @param {object} params params object
  * @param {Shim} params.shim shim instance
  * @param {object} params.commandsQueue instance
  */

lib/instrumentation/aws-sdk/v2/instrumentation-helper.js

@@ -7,8 +7,8 @@
 
 /**
  * Series of tests to determine if the library
- * has the features needed to provide instrumentation
- * @param AWS
+ * has the features needed to provide instrumentation.
+ * @param {Object} AWS AWS SDK object
  */
 const instrumentationSupported = function instrumentationSupported(AWS) {
   // instrumentation requires the serviceClientOperationsMap property