fix single arg commands

Author: s1gr1d

packages/node/src/integrations/tracing/redis.ts

@@ -28,7 +28,7 @@ let _redisOptions: RedisOptions = {};
 export const instrumentRedis = generateInstrumentOnce(INTEGRATION_NAME, () => {
   return new IORedisInstrumentation({
     responseHook: (span, redisCommand, cmdArgs, response) => {
-      const safeKey = getCacheKeySafely(cmdArgs);
+      const safeKey = getCacheKeySafely(redisCommand, cmdArgs);
 
       span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.redis');
 

packages/node/src/utils/redisCache.ts

@@ -1,5 +1,7 @@
 import type { CommandArgs as IORedisCommandArgs } from '@opentelemetry/instrumentation-ioredis';
 
+const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];
+
 export const GET_COMMANDS = ['get', 'mget'];
 export const SET_COMMANDS = ['set' /* todo: 'setex' */];
 // todo: del, expire
@@ -24,28 +26,32 @@ function keyHasPrefix(key: string, prefixes: string[]): boolean {
 }
 
 /** Safely converts a redis key to a string (comma-separated if there are multiple keys) */
-export function getCacheKeySafely(cmdArgs: IORedisCommandArgs): string {
+export function getCacheKeySafely(redisCommand: string, cmdArgs: IORedisCommandArgs): string {
   try {
     if (cmdArgs.length === 0) {
       return '';
     }
 
-    const keys: string[] = [];
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const joinArgsWithComma = (acc: string, currArg: string | Buffer | number | any[]): string =>
+      acc.length === 0 ? processArg(currArg) : `${acc}, ${processArg(currArg)}`;
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const processArg = (arg: string | Buffer | number | any[]): void => {
+    const processArg = (arg: string | Buffer | number | any[]): string => {
       if (typeof arg === 'string' || typeof arg === 'number' || Buffer.isBuffer(arg)) {
-        keys.push(arg.toString());
+        return arg.toString();
       } else if (Array.isArray(arg)) {
-        arg.forEach(processArg);
+        return arg.reduce(joinArgsWithComma, '');
       } else {
-        keys.push('<unknown>');
+        return '<unknown>';
       }
     };
 
-    cmdArgs.forEach(processArg);
+    if (SINGLE_ARG_COMMANDS.includes(redisCommand) && cmdArgs.length > 0) {
+      return processArg(cmdArgs[0]);
+    }
 
-    return keys.join(', ');
+    return cmdArgs.reduce(joinArgsWithComma, '');
   } catch (e) {
     return '';
   }

packages/node/test/integrations/tracing/redis.test.ts

@@ -7,33 +7,55 @@ import {
 } from '../../../src/utils/redisCache';
 
 describe('Redis', () => {
-  describe('getCacheKeySafely', () => {
+  describe('getCacheKeySafely (single arg)', () => {
     it('should return an empty string if there are no command arguments', () => {
-      const result = getCacheKeySafely([]);
+      const result = getCacheKeySafely('get', []);
       expect(result).toBe('');
     });
 
     it('should return a string representation of a single argument', () => {
       const cmdArgs = ['key1'];
-      const result = getCacheKeySafely(cmdArgs);
+      const result = getCacheKeySafely('get', cmdArgs);
       expect(result).toBe('key1');
     });
 
-    it('should return a comma-separated string for multiple arguments', () => {
-      const cmdArgs = ['key1', 'key2', 'key3'];
-      const result = getCacheKeySafely(cmdArgs);
-      expect(result).toBe('key1, key2, key3');
+    it('should return only the key for multiple arguments', () => {
+      const cmdArgs = ['key1', 'the-value'];
+      const result = getCacheKeySafely('get', cmdArgs);
+      expect(result).toBe('key1');
     });
 
     it('should handle number arguments', () => {
-      const cmdArgs = [1, 2, 3];
-      const result = getCacheKeySafely(cmdArgs);
-      expect(result).toBe('1, 2, 3');
+      const cmdArgs = [1, 'the-value'];
+      const result = getCacheKeySafely('get', cmdArgs);
+      expect(result).toBe('1');
+    });
+
+    it('should handle Buffer arguments', () => {
+      const cmdArgs = [Buffer.from('key1'), Buffer.from('key2')];
+      const result = getCacheKeySafely('get', cmdArgs);
+      expect(result).toBe('key1');
+    });
+
+    it('should return <unknown> if the arg type is not supported', () => {
+      const cmdArgs = [Symbol('key1')];
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      const result = getCacheKeySafely('get', cmdArgs);
+      expect(result).toBe('<unknown>');
+    });
+  });
+
+  describe('getCacheKeySafely (multiple args)', () => {
+    it('should return a comma-separated string for multiple arguments with mget command', () => {
+      const cmdArgs = ['key1', 'key2', 'key3'];
+      const result = getCacheKeySafely('mget', cmdArgs);
+      expect(result).toBe('key1, key2, key3');
     });
 
     it('should handle Buffer arguments', () => {
       const cmdArgs = [Buffer.from('key1'), Buffer.from('key2')];
-      const result = getCacheKeySafely(cmdArgs);
+      const result = getCacheKeySafely('mget', cmdArgs);
       expect(result).toBe('key1, key2');
     });
 
@@ -42,30 +64,30 @@ describe('Redis', () => {
         ['key1', 'key2'],
         ['key3', 'key4'],
       ];
-      const result = getCacheKeySafely(cmdArgs);
+      const result = getCacheKeySafely('mget', cmdArgs);
       expect(result).toBe('key1, key2, key3, key4');
     });
 
     it('should handle mixed type arguments', () => {
       const cmdArgs = [Buffer.from('key1'), ['key2', 'key3'], [Buffer.from('key4'), 'key5', 'key6', 7, ['key8']]];
-      const result = getCacheKeySafely(cmdArgs);
+      const result = getCacheKeySafely('mget', cmdArgs);
       expect(result).toBe('key1, key2, key3, key4, key5, key6, 7, key8');
     });
 
-    it('should handle nested arrays in arguments', () => {
+    it('should handle nested arrays with mixed types in arguments', () => {
       const cmdArgs = [
         ['key1', 'key2'],
-        ['key3', 'key4', ['key5', ['key6']]],
+        ['key3', 'key4', [Buffer.from('key5'), ['key6']]],
       ];
-      const result = getCacheKeySafely(cmdArgs);
+      const result = getCacheKeySafely('mget', cmdArgs);
       expect(result).toBe('key1, key2, key3, key4, key5, key6');
     });
 
     it('should return <unknown> if the arg type is not supported', () => {
       const cmdArgs = [Symbol('key1')];
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore
-      const result = getCacheKeySafely(cmdArgs);
+      const result = getCacheKeySafely('mget', cmdArgs);
       expect(result).toBe('<unknown>');
     });
   });