redis v4 passing

Author: amychisholm03

lib/subscribers/redis/commands-executor.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const ClientPropagationSubscriber = require('./client-propagation')
+
+/**
+ * Listens to events on RedisClient.commandsExectutor for redis versions <=5.
+ * Replacement for send-command.js for that version.
+ */
+module.exports = class ClientCommandsExecutorSubscriber extends ClientPropagationSubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_commandsExecutor' })
+  }
+}

lib/subscribers/redis/config.js

@@ -7,9 +7,7 @@ const addCommand = {
   path: './redis/add-command',
   instrumentations: [{
     channelName: 'nr_addCommand',
-    module: { name: '@redis/client',
-      versionRange: '>=4',
-      filePath: 'dist/lib/client/commands-queue.js' },
+    module: { name: '@redis/client', versionRange: '>=1', filePath: 'dist/lib/client/commands-queue.js' },
     functionQuery: {
       className: 'RedisCommandsQueue',
       methodName: 'addCommand',
@@ -33,45 +31,45 @@ const sendCommand = {
   ]
 }
 
-const executeMulti = {
-  path: './redis/execute-multi',
+const clientSelect = {
+  path: './redis/select',
   instrumentations: [
     {
-      channelName: 'nr_executeMulti',
-      module: { name: '@redis/client', versionRange: '>=4', filePath: 'dist/lib/client/index.js' },
+      channelName: 'nr_select',
+      module: { name: '@redis/client', versionRange: '>=1', filePath: 'dist/lib/client/index.js' },
       functionQuery: {
         className: 'RedisClient',
-        methodName: '_executeMulti',
+        methodName: 'SELECT',
         kind: 'Async'
       }
-    },
+    }
   ]
 }
 
-const executePipeline = {
-  path: './redis/execute-multi',
+const clientMulti = {
+  path: './redis/multi',
   instrumentations: [
     {
-      channelName: 'nr_executePipeline',
-      module: { name: '@redis/client', versionRange: '>=4', filePath: 'dist/lib/client/index.js' },
+      channelName: 'nr_multi',
+      module: { name: '@redis/client', versionRange: '>=1', filePath: 'dist/lib/client/index.js' },
       functionQuery: {
         className: 'RedisClient',
-        methodName: '_executePipeline',
-        kind: 'Async'
+        methodName: 'MULTI',
+        kind: 'Sync'
       }
-    },
+    }
   ]
 }
 
-const clientSelect = {
-  path: './redis/select',
+const commandsExecutor = {
+  path: './redis/commands-executor',
   instrumentations: [
     {
-      channelName: 'nr_select',
-      module: { name: '@redis/client', versionRange: '>=4', filePath: 'dist/lib/client/index.js' },
+      channelName: 'nr_commandsExecutor',
+      module: { name: '@redis/client', versionRange: '>=1 <4', filePath: 'dist/lib/client/index.js' },
       functionQuery: {
         className: 'RedisClient',
-        methodName: 'SELECT',
+        methodName: 'commandsExecutor',
         kind: 'Async'
       }
     }
@@ -81,9 +79,9 @@ const clientSelect = {
 module.exports = {
   '@redis/client': [
     addCommand,
-    sendCommand,
+    sendCommand, // >=v5
     clientSelect,
-    executeMulti,
-    executePipeline
+    clientMulti,
+    commandsExecutor // v4
   ]
 }

lib/subscribers/redis/execute-multi.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const ClientPropagationSubscriber = require('./client-propagation')
+const { redisClientOpts } = require('../../symbols')
+
+/**
+ * Propagates the context in `RedisClient.MULTI` and
+ * `RedisClient[redisClientOpts]` into `RedisCommandQueue.addCommand`.
+ */
+module.exports = class ClientMultiSubscriber extends ClientPropagationSubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_multi' })
+    this.events = ['start']
+  }
+
+  start(data) {
+    const { self: client } = data
+    if (!client[redisClientOpts]) {
+      client[redisClientOpts] = this.getRedisParams(client.options)
+    }
+  }
+}

lib/subscribers/redis/execute-pipeline.js

@@ -1,6 +1,11 @@
 {
   "name": "redis-tests",
-  "targets": [{"name":"redis","minAgentVersion":"1.31.0"}],
+  "targets": [
+    {
+      "name": "redis",
+      "minAgentVersion": "1.31.0"
+    }
+  ],
   "version": "0.0.0",
   "private": true,
   "tests": [
@@ -29,5 +34,8 @@
         "tls.test.js"
       ]
     }
-  ]
+  ],
+  "dependencies": {
+    "redis": "^4.7.1"
+  }
 }

lib/subscribers/redis/multi.js

@@ -58,7 +58,7 @@ test('Redis instrumentation', async function (t) {
 
   await t.test('should log tracking metrics', function(t) {
     const { agent } = t.nr
-    const { version } = require('redis/package.json')
+    const { version } = require('@redis/client/package.json')
     assertPackageMetrics({ agent, pkg: '@redis/client', version, subscriberType: true })
   })