Skip to content

redis client socket changes needed for sentinel #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v5
Choose a base branch
from
Open

redis client socket changes needed for sentinel #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/client/lib/client/socket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface RedisSocketCommonOptions {
/**
* Toggle [`keep-alive`](https://nodejs.org/api/net.html#net_socket_setkeepalive_enable_initialdelay)
*/
keepAlive?: number | false;
redisKeepAlive?: number | false;
/**
* When the socket closes unexpectedly (without calling `.close()`/`.destroy()`), the client uses `reconnectStrategy` to decide what to do. The following values are supported:
* 1. `false` -> do not reconnect, close the client and flush the command queue.
Expand All @@ -28,15 +28,15 @@ export interface RedisSocketCommonOptions {
reconnectStrategy?: false | number | ((retries: number, cause: Error) => false | Error | number);
}

type RedisNetSocketOptions = Partial<net.SocketConnectOpts> & {
export interface RedisNetConnectOpts extends Partial<net.TcpNetConnectOpts>, Partial<net.IpcNetConnectOpts>, RedisSocketCommonOptions {
tls?: false;
};

export interface RedisTlsSocketOptions extends tls.ConnectionOptions {
export interface RedisTlsSocketOptions extends Partial<tls.ConnectionOptions>, RedisSocketCommonOptions {
tls: true;
}
};

export type RedisSocketOptions = RedisSocketCommonOptions & (RedisNetSocketOptions | RedisTlsSocketOptions);
export type RedisSocketOptions = RedisNetConnectOpts | RedisTlsSocketOptions

interface CreateSocketReturn<T> {
connectEvent: string;
Expand All @@ -54,7 +54,7 @@ export default class RedisSocket extends EventEmitter {
}

options.connectTimeout ??= 5000;
options.keepAlive ??= 5000;
options.redisKeepAlive ??= 5000;
options.noDelay ??= true;

return options;
Expand Down Expand Up @@ -186,7 +186,7 @@ export default class RedisSocket extends EventEmitter {
socket
.setTimeout(0)
// https://github.com/nodejs/node/issues/31663
.setKeepAlive(this._options.keepAlive !== false, this._options.keepAlive || 0)
.setKeepAlive(this._options.redisKeepAlive !== false, this._options.redisKeepAlive || 0)
.off('error', reject)
.once('error', (err: Error) => this._onSocketError(err))
.once('close', hadError => {
Expand Down