fix(init): option parsing

Author: nkaradzhov

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

@@ -0,0 +1,49 @@
+import assert from "node:assert";
+import { createClient } from "../../";
+
+describe("EnterpriseMaintenanceManager does not prevent proper options parsing", () => {
+  it("should not throw when initializing without options", async () => {
+    const client = createClient();
+    assert.doesNotThrow(async () => {
+      //Expected to reject because there is no url or socket provided and there is no running server on localhost
+      await assert.rejects(client.connect);
+    });
+  });
+
+  it("should not throw when initializing without url/socket and with maint", async () => {
+    const client = createClient({
+      maintNotifications: "enabled",
+      RESP: 3,
+    });
+    assert.doesNotThrow(async () => {
+      //Expected to reject because there is no url or socket provided and there is no running server on localhost
+      await assert.rejects(client.connect);
+    });
+  });
+  it("should not throw when initializing with url and with maint", async () => {
+    const client = createClient({
+      maintNotifications: "enabled",
+      RESP: 3,
+      url: "redis://localhost:6379",
+    });
+    assert.doesNotThrow(async () => {
+      //Expected to reject because there is no url or socket provided and there is no running server on localhost
+      await assert.rejects(client.connect);
+    });
+  });
+
+  it("should not throw when initializing with socket and with maint", async () => {
+    const client = createClient({
+      maintNotifications: "enabled",
+      RESP: 3,
+      socket: {
+        host: "localhost",
+        port: 6379,
+      },
+    });
+    assert.doesNotThrow(async () => {
+      //Expected to reject because there is no url or socket provided and there is no running server on localhost
+      await assert.rejects(client.connect);
+    });
+  });
+});

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

@@ -5,7 +5,7 @@ import { isIP } from "net";
 import { lookup } from "dns/promises";
 import assert from "node:assert";
 import { setTimeout } from "node:timers/promises";
-import RedisSocket from "./socket";
+import RedisSocket, { RedisTcpSocketOptions } from "./socket";
 import diagnostics_channel from "node:diagnostics_channel";
 
 export const MAINTENANCE_EVENTS = {
@@ -80,15 +80,21 @@ export default class EnterpriseMaintenanceManager {
   }
 
   static async getHandshakeCommand(
-    tls: boolean,
-    host: string,
     options: RedisClientOptions,
   ): Promise<
     | { cmd: Array<RedisArgument>; errorHandler: (error: Error) => void }
     | undefined
   > {
     if (options.maintNotifications === "disabled") return;
 
+    const host = options.url
+      ? new URL(options.url).hostname
+      : (options.socket as RedisTcpSocketOptions | undefined)?.host;
+
+    if (!host) return;
+
+    const tls = options.socket?.tls ?? false
+
     const movingEndpointType = await determineEndpoint(tls, host, options);
     return {
       cmd: [

packages/client/lib/client/index.spec.ts

@@ -1,7 +1,7 @@
 import { strict as assert } from 'node:assert';
 import testUtils, { GLOBAL, waitTillBeenCalled } from '../test-utils';
 import RedisClient, { RedisClientOptions, RedisClientType } from '.';
-import { AbortError, ClientClosedError, ClientOfflineError, ConnectionTimeoutError, DisconnectsClientError, ErrorReply, MultiErrorReply, SocketClosedUnexpectedlyError, TimeoutError, WatchError } from '../errors';
+import { AbortError, ClientClosedError, ClientOfflineError, ConnectionTimeoutError, DisconnectsClientError, ErrorReply, MultiErrorReply, TimeoutError, WatchError } from '../errors';
 import { defineScript } from '../lua-script';
 import { spy, stub } from 'sinon';
 import { once } from 'node:events';

packages/client/lib/client/index.ts

@@ -1,5 +1,5 @@
 import COMMANDS from '../commands';
-import RedisSocket, { RedisSocketOptions, RedisTcpSocketOptions } from './socket';
+import RedisSocket, { RedisSocketOptions } from './socket';
 import { BasicAuth, CredentialsError, CredentialsProvider, StreamingCredentialsProvider, UnableToObtainNewCredentialsError, Disposable } from '../authx';
 import RedisCommandsQueue, { CommandOptions } from './commands-queue';
 import { EventEmitter } from 'node:events';
@@ -429,7 +429,7 @@ export default class RedisClient<
     return parsed;
   }
 
-  readonly #options?: RedisClientOptions<M, F, S, RESP, TYPE_MAPPING>;
+  readonly #options: RedisClientOptions<M, F, S, RESP, TYPE_MAPPING>;
   #socket: RedisSocket;
   readonly #queue: RedisCommandsQueue;
   #selectedDB = 0;
@@ -541,10 +541,10 @@ export default class RedisClient<
 
   }
 
-  #initiateOptions(options?: RedisClientOptions<M, F, S, RESP, TYPE_MAPPING>): RedisClientOptions<M, F, S, RESP, TYPE_MAPPING> | undefined {
+  #initiateOptions(options: RedisClientOptions<M, F, S, RESP, TYPE_MAPPING> = {}): RedisClientOptions<M, F, S, RESP, TYPE_MAPPING> {
 
     // Convert username/password to credentialsProvider if no credentialsProvider is already in place
-    if (!options?.credentialsProvider && (options?.username || options?.password)) {
+    if (!options.credentialsProvider && (options.username || options.password)) {
 
       options.credentialsProvider = {
         type: 'async-credentials-provider',
@@ -555,19 +555,19 @@ export default class RedisClient<
       };
     }
 
-    if (options?.database) {
+    if (options.database) {
       this._self.#selectedDB = options.database;
     }
 
-    if (options?.commandOptions) {
+    if (options.commandOptions) {
       this._commandOptions = options.commandOptions;
     }
 
-    if(options?.maintNotifications !== 'disabled') {
-      EnterpriseMaintenanceManager.setupDefaultMaintOptions(options!);
+    if(options.maintNotifications !== 'disabled') {
+      EnterpriseMaintenanceManager.setupDefaultMaintOptions(options);
     }
 
-    if (options?.url) {
+    if (options.url) {
       const parsedOptions = RedisClient.parseOptions(options);
       if (parsedOptions?.database) {
         this._self.#selectedDB = parsedOptions.database;
@@ -748,8 +748,7 @@ export default class RedisClient<
       commands.push({cmd: this.#clientSideCache.trackingOn()});
     }
 
-    const { tls, host } = this.#options!.socket as RedisTcpSocketOptions;
-    const maintenanceHandshakeCmd = await EnterpriseMaintenanceManager.getHandshakeCommand(!!tls, host!, this.#options!);
+    const maintenanceHandshakeCmd = await EnterpriseMaintenanceManager.getHandshakeCommand(this.#options);
     if(maintenanceHandshakeCmd) {
       commands.push(maintenanceHandshakeCmd);
     };