refactor(timeouts): remove redundant flag

the inMaintenance flag is no longer needed, now that
we have default values for maintRelaxedSocketTimeout and
maintRelaxedCommandTimeout

Author: nkaradzhov

packages/client/lib/client/commands-queue.ts

@@ -71,21 +71,23 @@ export default class RedisCommandsQueue {
 
   #pushHandlers: PushHandler[] = [this.#onPush.bind(this)];
 
-  #inMaintenance = false;
-
-  set inMaintenance(value: boolean) {
-    this.#inMaintenance = value;
-  }
-
   #maintenanceCommandTimeout: number | undefined
 
   setMaintenanceCommandTimeout(ms: number | undefined) {
-    dbgMaintenance(`Setting maintenance command timeout to ${ms}`);
     // Prevent possible api misuse
-    if (this.#maintenanceCommandTimeout === ms) return;
+    if (this.#maintenanceCommandTimeout === ms) {
+      dbgMaintenance(`Queue already set maintenanceCommandTimeout to ${ms}, skipping`);
+      return;
+    };
 
+    dbgMaintenance(`Setting maintenance command timeout to ${ms}`);
     this.#maintenanceCommandTimeout = ms;
 
+    if(this.#maintenanceCommandTimeout === undefined) {
+      dbgMaintenance(`Queue will keep maintenanceCommandTimeout for exisitng commands, just to be on the safe side. New commands will receive normal timeouts`);
+      return;
+    }
+
     let counter = 0;
     const total = this.#toWrite.length;
 
@@ -96,20 +98,16 @@ export default class RedisCommandsQueue {
       // Remove timeout listener if it exists
       RedisCommandsQueue.#removeTimeoutListener(command)
 
-      // Determine newTimeout
-      const newTimeout = this.#maintenanceCommandTimeout ?? command.timeout?.originalTimeout;
-      // if no timeout is given and the command didnt have any timeout before, skip
-      if (!newTimeout)  return;
-
       counter++;
+      const newTimeout = this.#maintenanceCommandTimeout;
 
       // Overwrite the command's timeout
       const signal = AbortSignal.timeout(newTimeout);
       command.timeout = {
         signal,
         listener: () => {
           this.#toWrite.remove(node);
-          command.reject(this.#inMaintenance ? new CommandTimeoutDuringMaintananceError(newTimeout) : new TimeoutError());
+          command.reject(new CommandTimeoutDuringMaintananceError(newTimeout));
         },
         originalTimeout: command.timeout?.originalTimeout
       };
@@ -224,15 +222,16 @@ export default class RedisCommandsQueue {
 
       // If #maintenanceCommandTimeout was explicitly set, we should
       // use it instead of the timeout provided by the command
-      const timeout = this.#maintenanceCommandTimeout || options?.timeout
+      const timeout = this.#maintenanceCommandTimeout ?? options?.timeout;
+      const wasInMaintenance = this.#maintenanceCommandTimeout !== undefined;
       if (timeout) {
 
         const signal = AbortSignal.timeout(timeout);
         value.timeout = {
           signal,
           listener: () => {
             this.#toWrite.remove(node);
-            value.reject(this.#inMaintenance ? new CommandTimeoutDuringMaintananceError(timeout) : new TimeoutError());
+            value.reject(wasInMaintenance ? new CommandTimeoutDuringMaintananceError(timeout) : new TimeoutError());
           },
           originalTimeout: options?.timeout
         };

packages/client/lib/client/enterprise-maintenance-manager.ts

@@ -27,7 +27,6 @@ export const dbgMaintenance = (...args: any[]) => {
 };
 
 export interface MaintenanceUpdate {
-  inMaintenance: boolean;
   relaxedCommandTimeout?: number;
   relaxedSocketTimeout?: number;
 }
@@ -233,7 +232,6 @@ export default class EnterpriseMaintenanceManager {
     }
 
     const update: MaintenanceUpdate = {
-      inMaintenance: true,
       relaxedCommandTimeout: this.#options.maintRelaxedCommandTimeout,
       relaxedSocketTimeout: this.#options.maintRelaxedSocketTimeout,
     };
@@ -250,7 +248,8 @@ export default class EnterpriseMaintenanceManager {
     }
 
     const update: MaintenanceUpdate = {
-      inMaintenance : false
+      relaxedCommandTimeout: undefined,
+      relaxedSocketTimeout: undefined
     };
 
     this.#client._maintenanceUpdate(update);

packages/client/lib/client/index.ts

@@ -957,9 +957,7 @@ export default class RedisClient<
     * @internal
     */
    _maintenanceUpdate(update: MaintenanceUpdate) {
-     this._self.#socket.inMaintenance = update.inMaintenance;
      this._self.#socket.setMaintenanceTimeout(update.relaxedSocketTimeout);
-     this._self.#queue.inMaintenance = update.inMaintenance;
      this._self.#queue.setMaintenanceCommandTimeout(update.relaxedCommandTimeout);
    }
 

packages/client/lib/client/socket.ts

@@ -85,12 +85,6 @@ export default class RedisSocket extends EventEmitter {
     return this.#socketEpoch;
   }
 
-  #inMaintenance = false;
-
-  set inMaintenance(value: boolean) {
-    this.#inMaintenance = value;
-  }
-
   constructor(initiator: RedisSocketInitiator, options?: RedisSocketOptions) {
     super();
 
@@ -249,7 +243,10 @@ export default class RedisSocket extends EventEmitter {
 
   setMaintenanceTimeout(ms?: number) {
     dbgMaintenance(`Set socket timeout to ${ms}`);
-    if (this.#maintenanceTimeout === ms) return;
+    if (this.#maintenanceTimeout === ms) {
+      dbgMaintenance(`Socket already set maintenanceCommandTimeout to ${ms}, skipping`);
+      return;
+    };
 
     this.#maintenanceTimeout = ms;
 
@@ -282,8 +279,8 @@ export default class RedisSocket extends EventEmitter {
 
     if (this.#socketTimeout) {
       socket.once('timeout', () => {
-        const error = this.#inMaintenance
-          ? new SocketTimeoutDuringMaintananceError(this.#socketTimeout!)
+        const error = this.#maintenanceTimeout
+          ? new SocketTimeoutDuringMaintananceError(this.#maintenanceTimeout)
           : new SocketTimeoutError(this.#socketTimeout!)
         socket.destroy(error);
       });