chore: fine tuning

Author: aryamohanan

packages/collector/test/tracing/database/redis/allowRootExitSpanApp.js

@@ -19,7 +19,8 @@ require('../../../..')({
 const redis = require(process.env.REDIS_PKG);
 const { delay } = require('@instana/core/test/test_util');
 
-const logPrefix = `Redis allowRootExitSpan App (version: ${process.env.REDIS_VERSION}, 
+const redisVersion = process.env.REDIS_VERSION;
+const logPrefix = `Redis allowRootExitSpan App (version: ${redisVersion}, 
 require: ${process.env.REDIS_PKG}):\t`;
 
 log(logPrefix);
@@ -41,7 +42,12 @@ let client;
     const result = await client.multi().set('key', 'value').get('key').exec();
     log('value:', result);
 
-    await client.close();
+    // In v5, the quit is replaced by close
+    if (redisVersion === 'latest') {
+      await client.close();
+    } else {
+      await client.quit();
+    }
   } catch (err) {
     log('Failed to connect to Redis:', err);
   }

packages/collector/test/tracing/database/redis/app.js

@@ -149,7 +149,7 @@ app.get('/blocking', async (req, res) => {
 
 app.get('/scan-iterator', async (req, res) => {
   if (redisVersion === 'latest') {
-    // Redis v5: SCAN iterators return batches of keys, enabling multi-key commands like mGet
+    // v5: SCAN iterators return batches of keys, enabling multi-key commands like mGet
     // eslint-disable-next-line no-restricted-syntax
     for await (const keys of connection.scanIterator()) {
       try {
@@ -159,7 +159,7 @@ app.get('/scan-iterator', async (req, res) => {
       }
     }
   } else {
-    // Redis v4: SCAN iterators return individual keys
+    // v4: SCAN iterators return individual keys
     // eslint-disable-next-line no-restricted-syntax
     for await (const key of connection.scanIterator()) {
       try {

packages/collector/test/tracing/database/redis/mockVersion.js

@@ -15,9 +15,9 @@ let mockedModuleName;
 if (REDIS_PKG === 'redis') {
   mockedModuleName = REDIS_VERSION === 'latest' ? 'redis' : `redis-${REDIS_VERSION}`;
 } else if (REDIS_PKG === '@redis/client') {
-  // NOTE: The @redis/client package was introduced with Redis v4 (client v1).
-  // In Redis v5, the versioning of @redis/client was aligned with Redis itself,
-  // so @redis/client v5 corresponds to Redis v5.
+  // NOTE: The '@redis/client' package was introduced with Redis v4 (client v1).
+  // In Redis v5, the versioning of '@redis/client' was aligned with Redis itself,
+  // so '@redis/client' v5 corresponds to Redis v5.
   mockedModuleName = REDIS_VERSION === 'latest' ? '@redis/client' : `@redis/client-${REDIS_VERSION}`;
 }
 

packages/collector/test/tracing/database/redis/test.js

@@ -90,7 +90,7 @@ const legacyVersion = 'v3';
             // In v5, Redis moved “Isolation Pool” into RedisClientPool.
             // see: //github.com/redis/node-redis/blob/master/docs/pool.md
             if (redisVersion === 'latest') {
-              mochaSuiteFn('When clientpool is used', function () {
+              mochaSuiteFn('When connected via clientpool', function () {
                 globalAgent.setUpCleanUpHooks();
                 let controls;
 
@@ -771,7 +771,7 @@ const legacyVersion = 'v3';
                             span => expect(span.n).to.equal('node.http.server'),
                             span => expect(span.data.http.method).to.equal('GET')
                           ]);
-                          // NOTE: Redis v5 SCAN iterators yield batches of keys, enabling multi-key commands like MGET.
+                          // NOTE: v5 SCAN iterators yield batches of keys, enabling multi-key commands like MGET.
                           // See: https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md#scan-iterators
                           const expectedSpanCount = redisVersion === 'latest' ? 1 : 4;
                           const expectedRedisCommand = redisVersion === 'latest' ? 'mGet' : 'get';
@@ -797,8 +797,8 @@ const legacyVersion = 'v3';
               }
 
               // See https://redis.js.org/#node-redis-usage-basic-example blocking commands
-              // In Redis v5, the "Isolation Pool" was introduced via RedisClientPool.
-              // Since it requires a new type of pool connection, a separate test suite  created starting from v5.
+              // In v5, the "Isolation Pool" was introduced via RedisClientPool.
+              // Since it requires a new type of pool connection, skipping the test.
               if (redisVersion !== 'latest') {
                 it('blocking', () => testBlockingCommand(controls, setupType));
               }

packages/core/src/tracing/instrumentation/database/redis.js

@@ -26,11 +26,11 @@ exports.deactivate = function deactivate() {
 };
 
 exports.init = function init() {
-  // In v5, the location of the commands module has changed.
-  hook.onFileLoad(/\/@redis\/client\/dist\/lib\/commands\/index.js/, captureCommands);
   // v4 commands, "redis-commands" is outdated and no longer compatible with it
   hook.onFileLoad(/\/@redis\/client\/dist\/lib\/cluster\/commands.js/, captureCommands);
 
+  // In v5, the location of the commands module has changed.
+  hook.onFileLoad(/\/@redis\/client\/dist\/lib\/commands\/index.js/, captureCommands);
   hook.onModuleLoad('redis', instrument);
   hook.onModuleLoad('@redis/client', instrument);
 };