refactor(maint): rename options

Author: nkaradzhov

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

@@ -64,12 +64,12 @@ export default class EnterpriseMaintenanceManager {
   #client: Client;
 
   static setupDefaultMaintOptions(options: RedisClientOptions) {
-    if (options.maintPushNotifications === undefined) {
-      options.maintPushNotifications =
+    if (options.maintNotifications === undefined) {
+      options.maintNotifications =
         options?.RESP === 3 ? "auto" : "disabled";
     }
-    if (options.maintMovingEndpointType === undefined) {
-      options.maintMovingEndpointType = "auto";
+    if (options.maintEndpointType === undefined) {
+      options.maintEndpointType = "auto";
     }
     if (options.maintRelaxedSocketTimeout === undefined) {
       options.maintRelaxedSocketTimeout = 10000;
@@ -87,7 +87,7 @@ export default class EnterpriseMaintenanceManager {
     | { cmd: Array<RedisArgument>; errorHandler: (error: Error) => void }
     | undefined
   > {
-    if (options.maintPushNotifications === "disabled") return;
+    if (options.maintNotifications === "disabled") return;
 
     const movingEndpointType = await determineEndpoint(tls, host, options);
     return {
@@ -100,7 +100,7 @@ export default class EnterpriseMaintenanceManager {
       ],
       errorHandler: (error: Error) => {
         dbgMaintenance("handshake failed:", error);
-        if (options.maintPushNotifications === "enabled") {
+        if (options.maintNotifications === "enabled") {
           throw error;
         }
       },
@@ -189,7 +189,7 @@ export default class EnterpriseMaintenanceManager {
     // reconnect to its currently configured endpoint after half of the grace
     // period that was communicated by the server is over.
     if (url === null) {
-      assert(this.#options.maintMovingEndpointType === "none");
+      assert(this.#options.maintEndpointType === "none");
       assert(this.#options.socket !== undefined);
       assert("host" in this.#options.socket);
       assert(typeof this.#options.socket.host === "string");
@@ -329,12 +329,12 @@ async function determineEndpoint(
   host: string,
   options: RedisClientOptions,
 ): Promise<MovingEndpointType> {
-  assert(options.maintMovingEndpointType !== undefined);
-  if (options.maintMovingEndpointType !== "auto") {
+  assert(options.maintEndpointType !== undefined);
+  if (options.maintEndpointType !== "auto") {
     dbgMaintenance(
-      `Determine endpoint type: ${options.maintMovingEndpointType}`,
+      `Determine endpoint type: ${options.maintEndpointType}`,
     );
-    return options.maintMovingEndpointType;
+    return options.maintEndpointType;
   }
 
   const ip = isIP(host) ? host : (await lookup(host, { family: 0 })).address;

packages/client/lib/client/index.ts

@@ -154,7 +154,7 @@ export interface RedisClientOptions<
    *
    * The default is `auto`.
    */
-  maintPushNotifications?: 'disabled' | 'enabled' | 'auto';
+  maintNotifications?: 'disabled' | 'enabled' | 'auto';
   /**
    * Controls how the client requests the endpoint to reconnect to during a MOVING notification in Redis Enterprise maintenance.
    *
@@ -167,19 +167,19 @@ export interface RedisClientOptions<
 
    * The default is `auto`.
    */
-  maintMovingEndpointType?: MovingEndpointType;
+  maintEndpointType?: MovingEndpointType;
   /**
    * Specifies a more relaxed timeout (in milliseconds) for commands during a maintenance window.
-   * This helps minimize command timeouts during maintenance. If not provided, the `commandOptions.timeout`
-   * will be used instead. Timeouts during maintenance period result in a `CommandTimeoutDuringMaintenance` error.
+   * This helps minimize command timeouts during maintenance. Timeouts during maintenance period result
+   * in a `CommandTimeoutDuringMaintenance` error.
    *
    * The default is 10000
    */
   maintRelaxedCommandTimeout?: number;
   /**
    * Specifies a more relaxed timeout (in milliseconds) for the socket during a maintenance window.
-   * This helps minimize socket timeouts during maintenance. If not provided, the `socket.timeout`
-   * will be used instead. Timeouts during maintenance period result in a `SocketTimeoutDuringMaintenance` error.
+   * This helps minimize socket timeouts during maintenance. Timeouts during maintenance period result
+   * in a `SocketTimeoutDuringMaintenance` error.
    *
    * The default is 10000
    */
@@ -503,7 +503,7 @@ export default class RedisClient<
     this.#socket = this.#initiateSocket();
 
 
-    if(options?.maintPushNotifications !== 'disabled') {
+    if(options?.maintNotifications !== 'disabled') {
       new EnterpriseMaintenanceManager(this.#queue, this, this.#options!);
     };
 
@@ -535,7 +535,7 @@ export default class RedisClient<
       throw new Error('Client Side Caching is only supported with RESP3');
     }
 
-    if (options?.maintPushNotifications && options?.maintPushNotifications !== 'disabled' && options?.RESP !== 3) {
+    if (options?.maintNotifications && options?.maintNotifications !== 'disabled' && options?.RESP !== 3) {
       throw new Error('Graceful Maintenance is only supported with RESP3');
     }
 
@@ -563,7 +563,7 @@ export default class RedisClient<
       this._commandOptions = options.commandOptions;
     }
 
-    if(options?.maintPushNotifications !== 'disabled') {
+    if(options?.maintNotifications !== 'disabled') {
       EnterpriseMaintenanceManager.setupDefaultMaintOptions(options!);
     }