You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-12-11 09:22:35 +03:00
* feat(errors): Add specialized timeout error types for maintenance scenarios - Added `SocketTimeoutDuringMaintananceError`, a subclass of `TimeoutError`, to handle socket timeouts during maintenance. - Added `CommandTimeoutDuringMaintenanceError`, another subclass of `TimeoutError`, to address command write timeouts during maintenance. * feat(linked-list): Add EmptyAwareSinglyLinkedList and enhance DoublyLinkedList functionality - Introduced `EmptyAwareSinglyLinkedList`, a subclass of `SinglyLinkedList` that emits an `empty` event when the list becomes empty due to `reset`, `shift`, or `remove` operations. - Added `nodes()` iterator method to `DoublyLinkedList` for iterating over nodes directly. - Enhanced unit tests for `DoublyLinkedList` and `SinglyLinkedList` to cover edge cases and new functionality. - Added comprehensive tests for `EmptyAwareSinglyLinkedList` to validate `empty` event emission under various scenarios. - Improved code formatting and consistency. * refactor(commands-queue): Improve push notification handling - Replaced `setInvalidateCallback` with a more flexible `addPushHandler` method, allowing multiple handlers for push notifications. - Introduced the `PushHandler` type to standardize push notification processing. - Refactored `RedisCommandsQueue` to use a `#pushHandlers` array, enabling dynamic and modular handling of push notifications. - Updated `RedisClient` to leverage the new handler mechanism for `invalidate` push notifications, simplifying and decoupling logic. * feat(commands-queue): Add method to wait for in-flight commands to complete - Introduced `waitForInflightCommandsToComplete` method to asynchronously wait for all in-flight commands to finish processing. - Utilized the `empty` event from `#waitingForReply` to signal when all commands have been completed. * feat(commands-queue): Introduce maintenance mode support for commands-queue - Added `#maintenanceCommandTimeout` and `setMaintenanceCommandTimeout` method to dynamically adjust command timeouts during maintenance * refator(client): Extract socket event listener setup into helper method * refactor(socket): Add maintenance mode support and dynamic timeout handling - Added `#maintenanceTimeout` and `setMaintenanceTimeout` method to dynamically adjust socket timeouts during maintenance. * feat(client): Add Redis Enterprise maintenance configuration options - Added `maintPushNotifications` option to control how the client handles Redis Enterprise maintenance push notifications (`disabled`, `enabled`, `au to`). - Added `maintMovingEndpointType` option to specify the endpoint type for reconnecting during a MOVING notification (`auto`, `internal-ip`, `external-ip`, etc.). - Added `maintRelaxedCommandTimeout` option to define a relaxed timeout for commands during maintenance. - Added `maintRelaxedSocketTimeout` option to define a relaxed timeout for the socket during maintenance. - Enforced RESP3 requirement for maintenance-related features (`maintPushNotifications`). * feat(client): Add socket helpers and pause mechanism - Introduced `#paused` flag with corresponding `_pause` and `_unpause` methods to temporarily halt writing commands to the socket during maintenance windows. - Updated `#write` method to respect the `#paused` flag, preventing new commands from being written during maintenance. - Added `_ejectSocket` method to safely detach from and return the current socket - Added `_insertSocket` method to receive and start using a new socket * feat(client): Add Redis Enterprise maintenance handling capabilities - Introduced `EnterpriseMaintenanceManager` to manage Redis Enterprise maintenance events and push notifications. - Integrated `EnterpriseMaintenanceManager` into `RedisClient` to handle maintenance push notifications and manage socket transitions. - Implemented graceful handling of MOVING, MIGRATING, and FAILOVER push notifications, including socket replacement and timeout adjustments. * test: add E2E test infrastructure for Redis maintenance scenarios * test: add E2E tests for Redis Enterprise maintenance timeout handling (#3) * test: add connection handoff test --------- Co-authored-by: Pavel Pashov <pavel.pashov@redis.com> Co-authored-by: Pavel Pashov <60297174+PavelPashov@users.noreply.github.com>
102 lines
2.4 KiB
TypeScript
102 lines
2.4 KiB
TypeScript
export class AbortError extends Error {
|
|
constructor() {
|
|
super('The command was aborted');
|
|
}
|
|
}
|
|
|
|
export class WatchError extends Error {
|
|
constructor(message = 'One (or more) of the watched keys has been changed') {
|
|
super(message);
|
|
}
|
|
}
|
|
|
|
export class ConnectionTimeoutError extends Error {
|
|
constructor() {
|
|
super('Connection timeout');
|
|
}
|
|
}
|
|
|
|
export class SocketTimeoutError extends Error {
|
|
constructor(timeout: number) {
|
|
super(`Socket timeout timeout. Expecting data, but didn't receive any in ${timeout}ms.`);
|
|
}
|
|
}
|
|
|
|
export class ClientClosedError extends Error {
|
|
constructor() {
|
|
super('The client is closed');
|
|
}
|
|
}
|
|
|
|
export class ClientOfflineError extends Error {
|
|
constructor() {
|
|
super('The client is offline');
|
|
}
|
|
}
|
|
|
|
export class DisconnectsClientError extends Error {
|
|
constructor() {
|
|
super('Disconnects client');
|
|
}
|
|
}
|
|
|
|
export class SocketClosedUnexpectedlyError extends Error {
|
|
constructor() {
|
|
super('Socket closed unexpectedly');
|
|
}
|
|
}
|
|
|
|
export class RootNodesUnavailableError extends Error {
|
|
constructor() {
|
|
super('All the root nodes are unavailable');
|
|
}
|
|
}
|
|
|
|
export class ReconnectStrategyError extends Error {
|
|
originalError: Error;
|
|
socketError: unknown;
|
|
|
|
constructor(originalError: Error, socketError: unknown) {
|
|
super(originalError.message);
|
|
this.originalError = originalError;
|
|
this.socketError = socketError;
|
|
}
|
|
}
|
|
|
|
export class ErrorReply extends Error {}
|
|
|
|
export class SimpleError extends ErrorReply {}
|
|
|
|
export class BlobError extends ErrorReply {}
|
|
|
|
export class TimeoutError extends Error {}
|
|
|
|
export class SocketTimeoutDuringMaintenanceError extends TimeoutError {
|
|
constructor(timeout: number) {
|
|
super(`Socket timeout during maintenance. Expecting data, but didn't receive any in ${timeout}ms.`);
|
|
}
|
|
}
|
|
|
|
export class CommandTimeoutDuringMaintenanceError extends TimeoutError {
|
|
constructor(timeout: number) {
|
|
super(`Command timeout during maintenance. Waited to write command for more than ${timeout}ms.`);
|
|
}
|
|
}
|
|
|
|
export class MultiErrorReply extends ErrorReply {
|
|
replies: Array<ErrorReply>;
|
|
errorIndexes: Array<number>;
|
|
|
|
constructor(replies: Array<ErrorReply>, errorIndexes: Array<number>) {
|
|
super(`${errorIndexes.length} commands failed, see .replies and .errorIndexes for more information`);
|
|
this.replies = replies;
|
|
this.errorIndexes = errorIndexes;
|
|
}
|
|
|
|
*errors() {
|
|
for (const index of this.errorIndexes) {
|
|
yield this.replies[index];
|
|
}
|
|
}
|
|
}
|