fix(client): bring disableClientInfo option back

It disappeared in v5

fixes redis#2958

Author: nkaradzhov

packages/client/lib/client/index.ts

@@ -4,7 +4,7 @@ import { BasicAuth, CredentialsError, CredentialsProvider, StreamingCredentialsP
 import RedisCommandsQueue, { CommandOptions } from './commands-queue';
 import { EventEmitter } from 'node:events';
 import { attachConfig, functionArgumentsPrefix, getTransformReply, scriptArgumentsPrefix } from '../commander';
-import { ClientClosedError, ClientOfflineError, DisconnectsClientError, WatchError } from '../errors';
+import { ClientClosedError, ClientOfflineError, DisconnectsClientError, SimpleError, WatchError } from '../errors';
 import { URL } from 'node:url';
 import { TcpSocketConnectOpts } from 'node:net';
 import { PUBSUB_TYPE, PubSubType, PubSubListener, PubSubTypeListeners, ChannelListeners } from './pub-sub';
@@ -17,6 +17,7 @@ import { RedisLegacyClient, RedisLegacyClientType } from './legacy-mode';
 import { RedisPoolOptions, RedisClientPool } from './pool';
 import { RedisVariadicArgument, parseArgs, pushVariadicArguments } from '../commands/generic-transformers';
 import { BasicCommandParser, CommandParser } from './parser';
+import { version } from '../../package.json'
 
 export interface RedisClientOptions<
   M extends RedisModules = RedisModules,
@@ -80,6 +81,14 @@ export interface RedisClientOptions<
    * TODO
    */
   commandOptions?: CommandOptions<TYPE_MAPPING>;
+  /**
+   * If set to true, disables sending client identifier (user-agent like message) to the redis server
+   */
+  disableClientInfo?: boolean;
+  /**
+   * Tag to append to library name that is sent to the Redis server
+   */
+  clientInfoTag?: string;
 }
 
 type WithCommands<
@@ -538,6 +547,36 @@ export default class RedisClient<
         );
       }
 
+      if (!this.#options?.disableClientInfo) {
+        this.#queue.addCommand([
+          'CLIENT',
+          'SETINFO',
+          'LIB-NAME',
+          this.#options?.clientInfoTag
+          ? `node-redis(${this.#options.clientInfoTag})` : 'node-redis'
+        ], {
+          chainId,
+          asap: true
+        }).catch(err => {
+          // Client libraries are expected to ignore failures since they could be
+          // connected to an older server that doesn't support them.
+          if (err !instanceof SimpleError || !err.isUnknownCommand()) {
+            return;
+          }
+        });
+
+        this.#queue.addCommand(['CLIENT', 'SETINFO', 'LIB-VER', version],{
+          chainId,
+          asap: true
+        }).catch(err => {
+          // Client libraries are expected to ignore failures since they could be
+          // connected to an older server that doesn't support them.
+          if (err !instanceof SimpleError || !err.isUnknownCommand()) {
+            return;
+          }
+        });
+      }
+
       const commands = await this.#handshake(this.#selectedDB);
       for (let i = commands.length - 1; i >= 0; --i) {
         promises.push(

packages/client/lib/commands/CLIENT_INFO.spec.ts

@@ -2,6 +2,7 @@ import { strict as assert } from 'node:assert';
 import CLIENT_INFO from './CLIENT_INFO';
 import testUtils, { GLOBAL } from '../test-utils';
 import { parseArgs } from './generic-transformers';
+import { version } from '../../package.json';
 
 describe('CLIENT INFO', () => {
   testUtils.isVersionGreaterThanHook([6, 2]);
@@ -48,4 +49,94 @@ describe('CLIENT INFO', () => {
       }
     }
   }, GLOBAL.SERVERS.OPEN);
+
+  testUtils.testWithClient('client.clientInfo - disableClientInfo: false', async client => {
+    const reply = await client.clientInfo();
+    if (!testUtils.isVersionGreaterThan([7])) {
+      assert.strictEqual(reply.libName, undefined, 'LibName should be undefined for Redis < 7.0');
+      assert.strictEqual(reply.libVer, undefined, 'LibVer should be undefined for Redis < 7.0');
+    }
+    if (testUtils.isVersionGreaterThan([7])) {
+      assert.equal(reply.libName, 'node-redis');
+      assert.equal(reply.libVer, version);
+    }
+  }, GLOBAL.SERVERS.OPEN);
+
+  testUtils.testWithClient('client.clientInfo - disableClientInfo: true', async client => {
+    const reply = await client.clientInfo();
+    if (!testUtils.isVersionGreaterThan([7])) {
+      assert.strictEqual(reply.libName, undefined, 'LibName should be undefined for Redis < 7.0');
+      assert.strictEqual(reply.libVer, undefined, 'LibVer should be undefined for Redis < 7.0');
+    }
+    if (testUtils.isVersionGreaterThan([7])) {
+      assert.equal(reply.libName, '');
+      assert.equal(reply.libVer, '');
+    }
+  }, {
+    ...GLOBAL.SERVERS.OPEN,
+    clientOptions: {
+      disableClientInfo: true
+    }
+  });
+
+  testUtils.testWithClient('client.clientInfo - disableClientInfo: false', async client => {
+    const reply = await client.clientInfo();
+    if (!testUtils.isVersionGreaterThan([7])) {
+      assert.strictEqual(reply.libName, undefined, 'LibName should be undefined for Redis < 7.0');
+      assert.strictEqual(reply.libVer, undefined, 'LibVer should be undefined for Redis < 7.0');
+    }
+    if (testUtils.isVersionGreaterThan([7])) {
+      assert.equal(reply.libName, 'node-redis');
+      assert.equal(reply.libVer, version);
+    }
+  }, GLOBAL.SERVERS.OPEN);
+
+  testUtils.testWithClient('client.clientInfo - disableClientInfo: true - RESP 2', async client => {
+    const reply = await client.clientInfo();
+    if (!testUtils.isVersionGreaterThan([7])) {
+      assert.strictEqual(reply.libName, undefined, 'LibName should be undefined for Redis < 7.0');
+      assert.strictEqual(reply.libVer, undefined, 'LibVer should be undefined for Redis < 7.0');
+    }
+    if (testUtils.isVersionGreaterThan([7])) {
+      assert.equal(reply.libName, '');
+      assert.equal(reply.libVer, '');
+    }
+  }, {
+    ...GLOBAL.SERVERS.OPEN,
+    clientOptions: {
+      disableClientInfo: true,
+      RESP: 2
+    }
+  });
+
+  testUtils.testWithClient('client.clientInfo - disableClientInfo: false - RESP 3', async client => {
+    const reply = await client.clientInfo();
+    if (!testUtils.isVersionGreaterThan([7])) {
+      assert.strictEqual(reply.libName, undefined, 'LibName should be undefined for Redis < 7.0');
+      assert.strictEqual(reply.libVer, undefined, 'LibVer should be undefined for Redis < 7.0');
+    }
+    if (testUtils.isVersionGreaterThan([7])) {
+      assert.equal(reply.libName, 'node-redis');
+      assert.equal(reply.libVer, version);
+    }
+  }, GLOBAL.SERVERS.OPEN);
+
+  testUtils.testWithClient('client.clientInfo - disableClientInfo: true', async client => {
+    const reply = await client.clientInfo();
+    if (!testUtils.isVersionGreaterThan([7])) {
+      assert.strictEqual(reply.libName, undefined, 'LibName should be undefined for Redis < 7.0');
+      assert.strictEqual(reply.libVer, undefined, 'LibVer should be undefined for Redis < 7.0');
+    }
+    if (testUtils.isVersionGreaterThan([7])) {
+      assert.equal(reply.libName, '');
+      assert.equal(reply.libVer, '');
+    }
+  }, {
+    ...GLOBAL.SERVERS.OPEN,
+    clientOptions: {
+      disableClientInfo: true,
+      RESP: 3
+    }
+  });
+
 });

packages/client/lib/commands/CLIENT_INFO.ts

@@ -52,6 +52,14 @@ export interface ClientInfoReply {
    * available since 7.0
    */
   resp?: number;
+  /**
+   * available since 7.0
+   */
+  libName?: string;
+  /**
+   * available since 7.0
+   */
+  libVer?: string;
 }
 
 const CLIENT_INFO_REGEX = /([^\s=]+)=([^\s]*)/g;
@@ -67,7 +75,6 @@ export default {
     for (const item of rawReply.toString().matchAll(CLIENT_INFO_REGEX)) {
       map[item[1]] = item[2];
     }
-
     const reply: ClientInfoReply = {
       id: Number(map.id),
       addr: map.addr,
@@ -89,7 +96,9 @@ export default {
       totMem: Number(map['tot-mem']),
       events: map.events,
       cmd: map.cmd,
-      user: map.user
+      user: map.user,
+      libName: map['lib-name'],
+      libVer: map['lib-ver']
     };
 
     if (map.laddr !== undefined) {

packages/client/lib/errors.ts

@@ -64,7 +64,11 @@ export class ErrorReply extends Error {
   }
 }
 
-export class SimpleError extends ErrorReply {}
+export class SimpleError extends ErrorReply {
+  isUnknownCommand(): boolean {
+    return this.message.indexOf('ERR unknown command') !== -1;
+  }
+}
 
 export class BlobError extends ErrorReply {}
 

packages/client/tsconfig.json

@@ -1,11 +1,12 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "./dist"
+    "outDir": "./dist",
   },
   "include": [
     "./index.ts",
-    "./lib/**/*.ts"
+    "./lib/**/*.ts",
+    "./package.json"
   ],
   "exclude": [
     "./lib/test-utils.ts",
@@ -18,6 +19,6 @@
       "./lib"
     ],
     "entryPointStrategy": "expand",
-    "out": "../../documentation/client"
+    "out": "../../documentation/client",
   }
 }

tsconfig.base.json

@@ -15,6 +15,7 @@
     "sourceMap": true,
     "declaration": true,
     "declarationMap": true,
-    "allowJs": true
+    "allowJs": true,
+    "resolveJsonModule": true
   }
 }