fix #2205 - reject commands in connect phase when `disableOfflineQueu…

…e` is `true`
redis · Nov 16, 2022 · e553270 · e553270
1 parent d097322
commit e553270
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/packages/client/lib/client/index.spec.ts b/packages/client/lib/client/index.spec.ts
@@ -3,7 +3,7 @@ import testUtils, { GLOBAL, waitTillBeenCalled } from '../test-utils';
 import RedisClient, { RedisClientType } from '.';
 import { RedisClientMultiCommandType } from './multi-command';
 import { RedisCommandArguments, RedisCommandRawReply, RedisModules, RedisFunctions, RedisScripts } from '../commands';
-import { AbortError, ClientClosedError, ConnectionTimeoutError, DisconnectsClientError, SocketClosedUnexpectedlyError, WatchError } from '../errors';
+import { AbortError, ClientClosedError, ClientOfflineError, ConnectionTimeoutError, DisconnectsClientError, SocketClosedUnexpectedlyError, WatchError } from '../errors';
 import { defineScript } from '../lua-script';
 import { spy } from 'sinon';
 import { once } from 'events';
@@ -874,4 +874,20 @@ describe('Client', () => {
             pingInterval: 1
         }
     });
+
+    testUtils.testWithClient('should reject commands in connect phase when `disableOfflineQueue`', async client => {
+        const connectPromise = client.connect();
+        await assert.rejects(
+            client.ping(),
+            ClientOfflineError
+        );
+        await connectPromise;
+        await client.disconnect();
+    }, {
+        ...GLOBAL.SERVERS.OPEN,
+        clientOptions: {
+            disableOfflineQueue: true
+        },
+        disableClientSetup: true
+    });
 });
diff --git a/packages/client/lib/client/index.ts b/packages/client/lib/client/index.ts
@@ -11,7 +11,7 @@ import { ScanCommandOptions } from '../commands/SCAN';
 import { HScanTuple } from '../commands/HSCAN';
 import { attachCommands, attachExtensions, fCallArguments, transformCommandArguments, transformCommandReply, transformLegacyCommandArguments } from '../commander';
 import { Pool, Options as PoolOptions, createPool } from 'generic-pool';
-import { ClientClosedError, DisconnectsClientError } from '../errors';
+import { ClientClosedError, ClientOfflineError, DisconnectsClientError } from '../errors';
 import { URL } from 'url';
 import { TcpSocketConnectOpts } from 'net';
 
@@ -405,16 +405,16 @@ export default class RedisClient<
     ): Promise<T> {
         if (!this.#socket.isOpen) {
             return Promise.reject(new ClientClosedError());
-        }
-
-        if (options?.isolated) {
+        } else if (options?.isolated) {
             return this.executeIsolated(isolatedClient =>
                 isolatedClient.sendCommand(args, {
                     ...options,
                     isolated: false
                 })
             );
-        }
+        } else if (!this.#socket.isReady && this.#options?.disableOfflineQueue) {
+            return Promise.reject(new ClientOfflineError());
+        } 
 
         const promise = this.#queue.addCommand<T>(args, options);
         this.#tick();

diff --git a/packages/client/lib/errors.ts b/packages/client/lib/errors.ts
@@ -22,6 +22,12 @@ export class ClientClosedError extends Error {
     }
 }
 
+export class ClientOfflineError extends Error {
+    constructor() {
+        super('The client is offline');
+    }
+}
+
 export class DisconnectsClientError extends Error {
     constructor() {
         super('Disconnects client');