diff --git a/packages/client/lib/client/index.ts b/packages/client/lib/client/index.ts index 3a14dc40e1..3efa793eeb 100644 --- a/packages/client/lib/client/index.ts +++ b/packages/client/lib/client/index.ts @@ -21,7 +21,8 @@ export interface RedisClientOptions< F extends RedisFunctions = RedisFunctions, S extends RedisScripts = RedisScripts, RESP extends RespVersions = RespVersions, - TYPE_MAPPING extends TypeMapping = TypeMapping + TYPE_MAPPING extends TypeMapping = TypeMapping, + SocketOptions extends RedisSocketOptions = RedisSocketOptions > extends CommanderConfig { /** * `redis[s]://[[username][:password]@][host][:port][/db-number]` @@ -31,7 +32,7 @@ export interface RedisClientOptions< /** * Socket connection properties */ - socket?: RedisSocketOptions; + socket?: SocketOptions; /** * ACL username ([see ACL guide](https://redis.io/topics/acl)) */ diff --git a/packages/client/lib/client/socket.ts b/packages/client/lib/client/socket.ts index 03dbcde154..dcadad4c3d 100644 --- a/packages/client/lib/client/socket.ts +++ b/packages/client/lib/client/socket.ts @@ -9,25 +9,9 @@ type NetOptions = { tls?: false; }; -type TcpOptions = NetOptions & Omit< - net.TcpNetConnectOpts, - 'timeout' | 'onread' | 'readable' | 'writable' | 'port' -> & { - port?: number; -}; - -type IpcOptions = NetOptions & Omit< - net.IpcNetConnectOpts, - 'timeout' | 'onread' | 'readable' | 'writable' ->; - -type TlsOptions = { - tls: true; -} & tls.ConnectionOptions; - type ReconnectStrategyFunction = (retries: number, cause: Error) => false | Error | number; -export type RedisSocketOptions = { +type RedisSocketOptionsCommon = { /** * Connection timeout (in milliseconds) */ @@ -39,7 +23,30 @@ export type RedisSocketOptions = { * 3. `(retries: number, cause: Error) => false | number | Error` -> `number` is the same as configuring a `number` directly, `Error` is the same as `false`, but with a custom error. */ reconnectStrategy?: false | number | ReconnectStrategyFunction; -} & (TcpOptions | IpcOptions | TlsOptions); +} + +type RedisTcpOptions = RedisSocketOptionsCommon & NetOptions & Omit< + net.TcpNetConnectOpts, + 'timeout' | 'onread' | 'readable' | 'writable' | 'port' +> & { + port?: number; +}; + +type RedisTlsOptions = RedisSocketOptionsCommon & tls.ConnectionOptions & { + tls: true; + host: string; +} + +type RedisIpcOptions = RedisSocketOptionsCommon & Omit< + net.IpcNetConnectOpts, + 'timeout' | 'onread' | 'readable' | 'writable' +> & { + tls: false; +} + +export type RedisTcpSocketOptions = RedisTcpOptions | RedisTlsOptions; + +export type RedisSocketOptions = RedisTcpSocketOptions | RedisIpcOptions; export type RedisSocketInitiator = () => void | Promise; diff --git a/packages/client/lib/cluster/index.ts b/packages/client/lib/cluster/index.ts index e26582942d..d6018fc270 100644 --- a/packages/client/lib/cluster/index.ts +++ b/packages/client/lib/cluster/index.ts @@ -8,6 +8,7 @@ import RedisClusterSlots, { NodeAddressMap, ShardNode } from './cluster-slots'; import RedisClusterMultiCommand, { RedisClusterMultiCommandType } from './multi-command'; import { PubSubListener } from '../client/pub-sub'; import { ErrorReply } from '../errors'; +import { RedisTcpSocketOptions } from '../client/socket'; interface ClusterCommander< M extends RedisModules, @@ -21,7 +22,7 @@ interface ClusterCommander< } export type RedisClusterClientOptions = Omit< - RedisClientOptions, + RedisClientOptions, keyof ClusterCommander >; diff --git a/packages/client/lib/sentinel/index.ts b/packages/client/lib/sentinel/index.ts index 210bf954ea..57819133e0 100644 --- a/packages/client/lib/sentinel/index.ts +++ b/packages/client/lib/sentinel/index.ts @@ -14,6 +14,8 @@ import { setTimeout } from 'node:timers/promises'; import RedisSentinelModule from './module' import { RedisVariadicArgument } from '../commands/generic-transformers'; import { WaitQueue } from './wait-queue'; +import { TcpNetConnectOpts } from 'node:net'; +import { RedisTcpSocketOptions } from '../client/socket'; interface ClientInfo { id: number; @@ -578,8 +580,8 @@ class RedisSentinelInternal< } readonly #name: string; - readonly #nodeClientOptions: RedisClientOptions; - readonly #sentinelClientOptions: RedisClientOptions; + readonly #nodeClientOptions: RedisClientOptions; + readonly #sentinelClientOptions: RedisClientOptions; readonly #scanInterval: number; readonly #passthroughClientErrorEvents: boolean; @@ -624,12 +626,12 @@ class RedisSentinelInternal< this.#scanInterval = options.scanInterval ?? 0; this.#passthroughClientErrorEvents = options.passthroughClientErrorEvents ?? false; - this.#nodeClientOptions = options.nodeClientOptions ? Object.assign({} as RedisClientOptions, options.nodeClientOptions) : {}; + this.#nodeClientOptions = options.nodeClientOptions ? Object.assign({} as RedisClientOptions, options.nodeClientOptions) : {}; if (this.#nodeClientOptions.url !== undefined) { throw new Error("invalid nodeClientOptions for Sentinel"); } - this.#sentinelClientOptions = options.sentinelClientOptions ? Object.assign({} as RedisClientOptions, options.sentinelClientOptions) : {}; + this.#sentinelClientOptions = options.sentinelClientOptions ? Object.assign({} as RedisClientOptions, options.sentinelClientOptions) : {}; this.#sentinelClientOptions.modules = RedisSentinelModule; if (this.#sentinelClientOptions.url !== undefined) { @@ -754,7 +756,8 @@ class RedisSentinelInternal< await this.#reset(); continue; } - this.#trace("attemping to send command to " + client.options?.socket?.host + ":" + client.options?.socket?.port) + const sockOpts = client.options?.socket as TcpNetConnectOpts | undefined; + this.#trace("attemping to send command to " + sockOpts?.host + ":" + sockOpts?.port) try { /* @@ -1198,7 +1201,8 @@ class RedisSentinelInternal< if (replicaCloseSet.has(str) || !replica.isOpen) { if (replica.isOpen) { - this.#trace(`destroying replica client to ${replica.options?.socket?.host}:${replica.options?.socket?.port}`); + const sockOpts = replica.options?.socket as TcpNetConnectOpts | undefined; + this.#trace(`destroying replica client to ${sockOpts?.host}:${sockOpts?.port}`); replica.destroy() } if (!removedSet.has(str)) { diff --git a/packages/client/lib/sentinel/types.ts b/packages/client/lib/sentinel/types.ts index 571100766e..1f868ec517 100644 --- a/packages/client/lib/sentinel/types.ts +++ b/packages/client/lib/sentinel/types.ts @@ -3,6 +3,7 @@ import { CommandOptions } from '../client/commands-queue'; import { CommandSignature, CommanderConfig, RedisFunctions, RedisModules, RedisScripts, RespVersions, TypeMapping } from '../RESP/types'; import COMMANDS from '../commands'; import RedisSentinel, { RedisSentinelClient } from '.'; +import { RedisTcpSocketOptions } from '../client/socket'; export interface RedisNode { host: string; @@ -31,11 +32,11 @@ export interface RedisSentinelOptions< /** * The configuration values for every node in the cluster. Use this for example when specifying an ACL user to connect with */ - nodeClientOptions?: RedisClientOptions; + nodeClientOptions?: RedisClientOptions; /** * The configuration values for every sentinel in the cluster. Use this for example when specifying an ACL user to connect with */ - sentinelClientOptions?: RedisClientOptions; + sentinelClientOptions?: RedisClientOptions; /** * The number of clients connected to the master node */ diff --git a/packages/client/lib/sentinel/utils.ts b/packages/client/lib/sentinel/utils.ts index 44de98fe71..4ae829183a 100644 --- a/packages/client/lib/sentinel/utils.ts +++ b/packages/client/lib/sentinel/utils.ts @@ -1,5 +1,5 @@ import { Command, RedisFunction, RedisScript, RespVersions } from '../RESP/types'; -import { RedisSocketOptions } from '../client/socket'; +import { RedisSocketOptions, RedisTcpSocketOptions } from '../client/socket'; import { functionArgumentsPrefix, getTransformReply, scriptArgumentsPrefix } from '../commander'; import { NamespaceProxySentinel, NamespaceProxySentinelClient, NodeInfo, ProxySentinel, ProxySentinelClient, RedisNode } from './types'; @@ -27,9 +27,11 @@ export function createNodeList(nodes: Array) { } export function clientSocketToNode(socket: RedisSocketOptions): RedisNode { + const s = socket as RedisTcpSocketOptions; + return { - host: socket.host!, - port: socket.port! + host: s.host!, + port: s.port! } }