newrelic 8.9.1 → 8.10.0

package/NEWS.md

@@ -1,3 +1,20 @@
+### v8.10.0 (2022-04-18)
+
+* Added instrumentation for `mysql2/promise`.
+   * This previously only existed in our standalone `@newrelic/mysql`, but now gives feature partiy between the two.
+
+* Removed unused native CPU metric sampler.  This logic was no longer getting touched if running Node.js > 6.1.0.
+
+* Fixed promise interceptor from re-throwing errors.
+
+* Added transaction naming documentation ported from a discussion forum post: https://discuss.newrelic.com/t/relic-solution-the-philosophy-of-naming-your-node-agent-transactions/.
+
+* Added `promises.tap.js` to mysql2 versioned tests.
+
+* Updated @newrelic/test-utilities to latest.
+ * Removed unused test file in restify versioned tests.
+  * Added `--strict` flag to versioned test runner to properly fail CI runs when test files are not included.
+
 ### v8.9.1 (2022-03-22)
 
 * Fixed `shim.wrapReturn` to call `Reflect.construct` in construct Proxy trap.  Also including `newTarget` to work with inherited classes.

package/THIRD_PARTY_NOTICES.md

@@ -712,7 +712,7 @@ This product includes source derived from [@newrelic/aws-sdk](https://github.com
 
 ### @newrelic/koa
 
-This product includes source derived from [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa) ([v6.1.0](https://github.com/newrelic/node-newrelic-koa/tree/v6.1.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-koa/blob/v6.1.0/LICENSE):
+This product includes source derived from [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa) ([v6.1.1](https://github.com/newrelic/node-newrelic-koa/tree/v6.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-koa/blob/v6.1.1/LICENSE):
 
 ```
 Apache License
@@ -1770,7 +1770,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.3.0](https://github.com/newrelic/node-test-utilities/tree/v6.3.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.3.0/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.5.2](https://github.com/newrelic/node-test-utilities/tree/v6.5.2)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.5.2/LICENSE):
 
 ```
                                  Apache License
@@ -2456,7 +2456,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### glob
 
-This product includes source derived from [glob](https://github.com/isaacs/node-glob) ([v7.1.7](https://github.com/isaacs/node-glob/tree/v7.1.7)), distributed under the [ISC License](https://github.com/isaacs/node-glob/blob/v7.1.7/LICENSE):
+This product includes source derived from [glob](https://github.com/isaacs/node-glob) ([v7.2.0](https://github.com/isaacs/node-glob/tree/v7.2.0)), distributed under the [ISC License](https://github.com/isaacs/node-glob/blob/v7.2.0/LICENSE):
 
 ```
 The ISC License
@@ -3377,7 +3377,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @newrelic/native-metrics
 
-This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v7.1.1](https://github.com/newrelic/node-native-metrics/tree/v7.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v7.1.1/LICENSE):
+This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v8.0.0](https://github.com/newrelic/node-native-metrics/tree/v8.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v8.0.0/LICENSE):
 
 ```
                                  Apache License

package/lib/instrumentation/{mysql.js → mysql/mysql.js}

@@ -5,17 +5,17 @@
 
 'use strict'
 
-const dbutils = require('../db/utils')
-const properties = require('../util/properties')
+const dbutils = require('../../db/utils')
+const properties = require('../../util/properties')
 
-module.exports = function initialize(agent, mysql, moduleName, shim) {
+exports.callbackInitialize = function callbackInitialize(shim, mysql) {
   shim.setDatastore(shim.MYSQL)
   shim.__wrappedPoolConnection = false
 
   shim.wrapReturn(mysql, 'createConnection', wrapCreateConnection)
   function wrapCreateConnection(shim, fn, fnName, connection) {
     shim.logger.debug('Wrapping Connection#query')
-    if (wrapQueriable(shim, connection, false)) {
+    if (wrapQueryable(shim, connection, false)) {
       const connProto = Object.getPrototypeOf(connection)
       shim.setInternalProperty(connProto, '__NR_storeDatabase', true)
       shim.unwrap(mysql, 'createConnection')
@@ -25,7 +25,7 @@ module.exports = function initialize(agent, mysql, moduleName, shim) {
   shim.wrapReturn(mysql, 'createPool', wrapCreatePool)
   function wrapCreatePool(shim, fn, fnName, pool) {
     shim.logger.debug('Wrapping Pool#query and Pool#getConnection')
-    if (wrapQueriable(shim, pool, true) && wrapGetConnection(shim, pool)) {
+    if (wrapQueryable(shim, pool, true) && wrapGetConnection(shim, pool)) {
       shim.unwrap(mysql, 'createPool')
     }
   }
@@ -48,6 +48,13 @@ module.exports = function initialize(agent, mysql, moduleName, shim) {
   }
 }
 
+exports.promiseInitialize = function promiseInitialize(shim) {
+  const callbackAPI = shim.require('./index')
+  if (callbackAPI && !shim.isWrapped(callbackAPI.createConnection)) {
+    exports.callbackInitialize(shim, callbackAPI)
+  }
+}
+
 function wrapGetConnection(shim, connectable) {
   if (!connectable || !connectable.getConnection || shim.isWrapped(connectable.getConnection)) {
     shim.logger.trace(
@@ -91,7 +98,7 @@ function wrapGetConnectionCallback(shim, cb) {
   return function wrappedGetConnectionCallback(err, conn) {
     try {
       shim.logger.debug('Wrapping PoolConnection#query')
-      if (!err && wrapQueriable(shim, conn, false)) {
+      if (!err && wrapQueryable(shim, conn, false)) {
         // Leave getConnection wrapped in order to maintain TX state, but we can
         // simplify the wrapping of its callback in future calls.
         shim.__wrappedPoolConnection = true
@@ -106,20 +113,20 @@ function wrapGetConnectionCallback(shim, cb) {
   }
 }
 
-function wrapQueriable(shim, queriable, isPoolQuery) {
-  if (!queriable || !queriable.query || shim.isWrapped(queriable.query)) {
+function wrapQueryable(shim, queryable, isPoolQuery) {
+  if (!queryable || !queryable.query || shim.isWrapped(queryable.query)) {
     shim.logger.debug(
       {
-        queriable: !!queriable,
-        query: !!(queriable && queriable.query),
-        isWrapped: !!(queriable && shim.isWrapped(queriable.query))
+        queryable: !!queryable,
+        query: !!(queryable && queryable.query),
+        isWrapped: !!(queryable && shim.isWrapped(queryable.query))
       },
-      'Not wrappying queriable'
+      'Not wrapping queryable'
     )
     return false
   }
 
-  const proto = Object.getPrototypeOf(queriable)
+  const proto = Object.getPrototypeOf(queryable)
 
   let describe
   if (isPoolQuery) {
@@ -131,7 +138,7 @@ function wrapQueriable(shim, queriable, isPoolQuery) {
 
   shim.recordQuery(proto, 'query', describe)
 
-  if (queriable.execute) {
+  if (queryable.execute) {
     shim.recordQuery(proto, 'execute', describe)
   }
 

package/lib/instrumentation/mysql/nr-hooks.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const instrumentation = require('./mysql')
+
+/**
+ * We only need to register the instrumentation once for both mysql and mysql2
+ *  because there is some 🪄 in shimmer
+ * See: https://github.com/newrelic/node-newrelic/blob/main/lib/shimmer.js#L459
+ */
+module.exports = [
+  {
+    type: 'datastore',
+    moduleName: 'mysql',
+    onRequire: instrumentation.callbackInitialize
+  },
+  {
+    type: 'datastore',
+    moduleName: 'mysql2/promise',
+    onRequire: instrumentation.promiseInitialize
+  }
+]

package/lib/instrumentations.js

@@ -25,7 +25,7 @@ module.exports = function instrumentations() {
     'koa': { module: '@newrelic/koa' },
     'memcached': { type: MODULE_TYPE.DATASTORE },
     'mongodb': { type: MODULE_TYPE.DATASTORE },
-    'mysql': { type: MODULE_TYPE.DATASTORE },
+    'mysql': { module: './instrumentation/mysql' },
     'pg': { type: MODULE_TYPE.DATASTORE },
     'q': { type: null },
     'redis': { type: MODULE_TYPE.DATASTORE },

package/lib/sampler.js

@@ -109,17 +109,6 @@ function sampleCpu(agent) {
   }
 }
 
-function sampleCpuNative(agent, nativeMetrics) {
-  const recordCPU = generateCPUMetricRecorder(agent)
-  nativeMetrics.on('usage', function collectResourceUsage(usage) {
-    recordCPU(usage.diff.ru_utime / MILLIS, usage.diff.ru_stime / MILLIS)
-  })
-
-  return function cpuSampler() {
-    // NOOP?
-  }
-}
-
 function sampleLoop(agent, nativeMetrics) {
   return function loopSampler() {
     // Convert from microseconds to seconds
@@ -195,16 +184,8 @@ module.exports = {
       }
     }
 
-    // Add CPU sampling using the built-in data if available, otherwise pulling
-    // from the native module.
-    if (process.cpuUsage) {
-      // introduced in 6.1.0
-      samplers.push(new Sampler(sampleCpu(agent), SAMPLE_INTERVAL))
-    } else if (this.nativeMetrics && this.nativeMetrics.usageEnabled) {
-      samplers.push(new Sampler(sampleCpuNative(agent, this.nativeMetrics), SAMPLE_INTERVAL))
-    } else {
-      logger.debug('Not adding CPU metric sampler.')
-    }
+    // Add CPU sampling using the built-in data (introduced in 6.1.0)
+    samplers.push(new Sampler(sampleCpu(agent), SAMPLE_INTERVAL))
 
     this.state = 'running'
   },

package/lib/serverless/aws-lambda.js

@@ -199,20 +199,19 @@ class AwsLambda {
     // we need to store the error in uncaughtException
     // otherwise the transaction will end before they are captured
     function lambdaInterceptPromise(prom, resultProcessor, cb) {
-      return prom.then(
+      prom.then(
         function onThen(arg) {
           if (resultProcessor) {
             resultProcessor(arg)
           }
           cb()
-          return arg
         },
         function onCatch(err) {
           uncaughtException = err
           cb()
-          throw err // This is not our error, just rethrowing the promise rejection.
         }
       )
+      return prom
     }
 
     function wrapCallbackAndCaptureError(transaction, txnEnder, cb, processResult) {

package/lib/shim/shim.js

@@ -1746,19 +1746,8 @@ function shimRequire(filePath) {
  * @returns {Promise} A new promise to replace the original one.
  */
 function interceptPromise(prom, cb) {
-  if (this.isFunction(prom.finally)) {
-    return prom.finally(cb)
-  }
-  return prom.then(
-    function onThen(arg) {
-      cb()
-      return arg
-    },
-    function onCatch(err) {
-      cb()
-      throw err // This is not our error, just rethrowing the promise rejection.
-    }
-  )
+  prom.then(cb, cb)
+  return prom
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "8.9.1",
+  "version": "8.10.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -173,13 +173,13 @@
     "semver": "^5.3.0"
   },
   "optionalDependencies": {
-    "@newrelic/native-metrics": "^7.1.1"
+    "@newrelic/native-metrics": "^8.0.0"
   },
   "devDependencies": {
     "@newrelic/eslint-config": "^0.0.3",
     "@newrelic/newrelic-oss-cli": "^0.1.2",
     "@newrelic/proxy": "^2.0.0",
-    "@newrelic/test-utilities": "^6.3.0",
+    "@newrelic/test-utilities": "^6.5.2",
     "@octokit/rest": "^18.0.15",
     "@slack/bolt": "^3.7.0",
     "ajv": "^6.12.6",