newrelic 11.23.0 → 11.23.1

package/NEWS.md

@@ -1,3 +1,13 @@
+### v11.23.1 (2024-07-11)
+
+#### Bug fixes
+
+* Updated redis v4 instrumentation to work with transactions(multi/exec) ([#2343](https://github.com/newrelic/node-newrelic/pull/2343)) ([39eb842](https://github.com/newrelic/node-newrelic/commit/39eb8421b84f7fe298acf5c9c89de31ee0cc2604))
+
+#### Documentation
+
+* Updated compatibility report ([#2342](https://github.com/newrelic/node-newrelic/pull/2342)) ([5c9e3e6](https://github.com/newrelic/node-newrelic/commit/5c9e3e6bfa8a388c7dd071ecb0231b069f065645))
+
 ### v11.23.0 (2024-07-10)
 
 #### Features

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

@@ -7,63 +7,78 @@
 
 const {
   OperationSpec,
-  params: { DatastoreParameters }
+  params: { DatastoreParameters },
+  ClassWrapSpec
 } = require('../../shim/specs')
-const CLIENT_COMMANDS = ['select', 'quit', 'SELECT', 'QUIT']
-const opts = Symbol('clientOptions')
+const { redisClientOpts } = require('../../symbols')
 
 module.exports = function initialize(_agent, redis, _moduleName, shim) {
   shim.setDatastore(shim.REDIS)
-  const COMMANDS = Object.keys(shim.require('dist/lib/client/commands.js').default)
-  const CMDS_TO_INSTRUMENT = [...COMMANDS, ...CLIENT_COMMANDS]
-  shim.wrap(redis, 'createClient', function wrapCreateClient(shim, original) {
-    return function wrappedCreateClient() {
-      const client = original.apply(this, arguments)
-      client[opts] = getRedisParams(client.options)
-      CMDS_TO_INSTRUMENT.forEach(instrumentClientCommand.bind(null, shim, client))
-      if (client.options.legacyMode) {
-        client.v4[opts] = getRedisParams(client.options)
-        CMDS_TO_INSTRUMENT.forEach(instrumentClientCommand.bind(null, shim, client.v4))
+  const commandsQueue = shim.require('dist/lib/client/commands-queue.js')
+
+  shim.wrapClass(
+    commandsQueue,
+    'default',
+    new ClassWrapSpec({
+      post: function postConstructor(shim) {
+        instrumentAddCommand({ shim, commandsQueue: this })
       }
+    })
+  )
+
+  shim.wrap(redis, 'createClient', function wrapCreateClient(_shim, createClient) {
+    return function wrappedCreateClient(options) {
+      // saving connection opts to shim
+      // since the RedisCommandsQueue gets constructed at createClient
+      // we can delete the symbol afterwards to ensure the appropriate
+      // connection options are for the given RedisCommandsQueue
+      shim[redisClientOpts] = getRedisParams(options)
+      const client = createClient.apply(this, arguments)
+      delete shim[redisClientOpts]
       return client
     }
   })
 }
 
 /**
- * Instruments a given command on the client by calling `shim.recordOperation`
+ * Instruments a given command when added to the command queue by calling `shim.recordOperation`
  *
- * @param {Shim} shim shim instance
- * @param {object} client redis client instance
- * @param {string} cmd command to instrument
+ * @param {object} params
+ * @param {Shim} params.shim shim instance
+ * @param {object} params.commandsQueue instance
  */
-function instrumentClientCommand(shim, client, cmd) {
+function instrumentAddCommand({ shim, commandsQueue }) {
   const { agent } = shim
+  const clientOpts = shim[redisClientOpts]
 
-  shim.recordOperation(client, cmd, function wrapCommand(_shim, _fn, _fnName, args) {
-    const [key, value] = args
-    const parameters = Object.assign({}, client[opts])
-    // If selecting a database, subsequent commands
-    // will be using said database, update the clientOptions
-    // but not the current parameters(feature parity with v3)
-    if (cmd.toLowerCase() === 'select') {
-      client[opts].database_name = key
-    }
-    if (agent.config.attributes.enabled) {
-      if (key) {
-        parameters.key = JSON.stringify(key)
+  shim.recordOperation(
+    commandsQueue,
+    'addCommand',
+    function wrapAddCommand(_shim, _fn, _fnName, args) {
+      const [cmd, key, value] = args[0]
+      const parameters = Object.assign({}, clientOpts)
+      // If selecting a database, subsequent commands
+      // will be using said database, update the clientOpts
+      // but not the current parameters(feature parity with v3)
+      if (cmd.toLowerCase() === 'select') {
+        clientOpts.database_name = key
       }
-      if (value) {
-        parameters.value = JSON.stringify(value)
+      if (agent.config.attributes.enabled) {
+        if (key) {
+          parameters.key = JSON.stringify(key)
+        }
+        if (value) {
+          parameters.value = JSON.stringify(value)
+        }
       }
-    }
 
-    return new OperationSpec({
-      name: (cmd && cmd.toLowerCase()) || 'other',
-      parameters,
-      promise: true
-    })
-  })
+      return new OperationSpec({
+        name: (cmd && cmd.toLowerCase()) || 'other',
+        parameters,
+        promise: true
+      })
+    }
+  )
 }
 
 /**
@@ -73,6 +88,21 @@ function instrumentClientCommand(shim, client, cmd) {
  * @returns {object} params
  */
 function getRedisParams(clientOpts) {
+  // need to replicate logic done in RedisClient
+  // to parse the url to assign to socket.host/port
+  // see: https://github.com/redis/node-redis/blob/5576a0db492cda2cd88e09881bc330aa956dd0f5/packages/client/lib/client/index.ts#L160
+  if (clientOpts?.url) {
+    const parsedURL = new URL(clientOpts.url)
+    clientOpts.socket = { host: parsedURL.hostname }
+    if (parsedURL.port) {
+      clientOpts.socket.port = parsedURL.port
+    }
+
+    if (parsedURL.pathname) {
+      clientOpts.database = parsedURL.pathname.substring(1)
+    }
+  }
+
   return new DatastoreParameters({
     host: clientOpts?.socket?.host || 'localhost',
     port_path_or_id: clientOpts?.socket?.path || clientOpts?.socket?.port || '6379',

package/lib/symbols.js

@@ -27,6 +27,7 @@ module.exports = {
   langchainRunId: Symbol('runId'),
   prismaConnection: Symbol('prismaConnection'),
   prismaModelCall: Symbol('modelCall'),
+  redisClientOpts: Symbol('clientOptions'),
   segment: Symbol('segment'),
   shim: Symbol('shim'),
   storeDatabase: Symbol('storeDatabase'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.23.0",
+  "version": "11.23.1",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [