initial commit
This commit is contained in:
165
node_modules/ioredis/built/redis/RedisOptions.d.ts
generated
vendored
Normal file
165
node_modules/ioredis/built/redis/RedisOptions.d.ts
generated
vendored
Normal file
@@ -0,0 +1,165 @@
|
||||
import { CommanderOptions } from "../utils/Commander";
|
||||
import ConnectorConstructor from "../connectors/ConnectorConstructor";
|
||||
import { SentinelConnectionOptions } from "../connectors/SentinelConnector";
|
||||
import { StandaloneConnectionOptions } from "../connectors/StandaloneConnector";
|
||||
export declare type ReconnectOnError = (err: Error) => boolean | 1 | 2;
|
||||
export interface CommonRedisOptions extends CommanderOptions {
|
||||
Connector?: ConnectorConstructor;
|
||||
retryStrategy?: (times: number) => number | void | null;
|
||||
/**
|
||||
* If a command does not return a reply within a set number of milliseconds,
|
||||
* a "Command timed out" error will be thrown.
|
||||
*/
|
||||
commandTimeout?: number;
|
||||
/**
|
||||
* Enable/disable keep-alive functionality.
|
||||
* @link https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay
|
||||
* @default 0
|
||||
*/
|
||||
keepAlive?: number;
|
||||
/**
|
||||
* Enable/disable the use of Nagle's algorithm.
|
||||
* @link https://nodejs.org/api/net.html#socketsetnodelaynodelay
|
||||
* @default true
|
||||
*/
|
||||
noDelay?: boolean;
|
||||
/**
|
||||
* Set the name of the connection to make it easier to identity the connection
|
||||
* in client list.
|
||||
* @link https://redis.io/commands/client-setname
|
||||
*/
|
||||
connectionName?: string;
|
||||
/**
|
||||
* If set, client will send AUTH command with the value of this option as the first argument when connected.
|
||||
* This is supported since Redis 6.
|
||||
*/
|
||||
username?: string;
|
||||
/**
|
||||
* If set, client will send AUTH command with the value of this option when connected.
|
||||
*/
|
||||
password?: string;
|
||||
/**
|
||||
* Database index to use.
|
||||
*
|
||||
* @default 0
|
||||
*/
|
||||
db?: number;
|
||||
/**
|
||||
* When the client reconnects, channels subscribed in the previous connection will be
|
||||
* resubscribed automatically if `autoResubscribe` is `true`.
|
||||
* @default true
|
||||
*/
|
||||
autoResubscribe?: boolean;
|
||||
/**
|
||||
* Whether or not to resend unfulfilled commands on reconnect.
|
||||
* Unfulfilled commands are most likely to be blocking commands such as `brpop` or `blpop`.
|
||||
* @default true
|
||||
*/
|
||||
autoResendUnfulfilledCommands?: boolean;
|
||||
/**
|
||||
* Whether or not to reconnect on certain Redis errors.
|
||||
* This options by default is `null`, which means it should never reconnect on Redis errors.
|
||||
* You can pass a function that accepts an Redis error, and returns:
|
||||
* - `true` or `1` to trigger a reconnection.
|
||||
* - `false` or `0` to not reconnect.
|
||||
* - `2` to reconnect and resend the failed command (who triggered the error) after reconnection.
|
||||
* @example
|
||||
* ```js
|
||||
* const redis = new Redis({
|
||||
* reconnectOnError(err) {
|
||||
* const targetError = "READONLY";
|
||||
* if (err.message.includes(targetError)) {
|
||||
* // Only reconnect when the error contains "READONLY"
|
||||
* return true; // or `return 1;`
|
||||
* }
|
||||
* },
|
||||
* });
|
||||
* ```
|
||||
* @default null
|
||||
*/
|
||||
reconnectOnError?: ReconnectOnError | null;
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
readOnly?: boolean;
|
||||
/**
|
||||
* When enabled, numbers returned by Redis will be converted to JavaScript strings instead of numbers.
|
||||
* This is necessary if you want to handle big numbers (above `Number.MAX_SAFE_INTEGER` === 2^53).
|
||||
* @default false
|
||||
*/
|
||||
stringNumbers?: boolean;
|
||||
/**
|
||||
* How long the client will wait before killing a socket due to inactivity during initial connection.
|
||||
* @default 10000
|
||||
*/
|
||||
connectTimeout?: number;
|
||||
/**
|
||||
* This option is used internally when you call `redis.monitor()` to tell Redis
|
||||
* to enter the monitor mode when the connection is established.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
monitor?: boolean;
|
||||
/**
|
||||
* The commands that don't get a reply due to the connection to the server is lost are
|
||||
* put into a queue and will be resent on reconnect (if allowed by the `retryStrategy` option).
|
||||
* This option is used to configure how many reconnection attempts should be allowed before
|
||||
* the queue is flushed with a `MaxRetriesPerRequestError` error.
|
||||
* Set this options to `null` instead of a number to let commands wait forever
|
||||
* until the connection is alive again.
|
||||
*
|
||||
* @default 20
|
||||
*/
|
||||
maxRetriesPerRequest?: number | null;
|
||||
/**
|
||||
* @default 10000
|
||||
*/
|
||||
maxLoadingRetryTime?: number;
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
enableAutoPipelining?: boolean;
|
||||
/**
|
||||
* @default []
|
||||
*/
|
||||
autoPipeliningIgnoredCommands?: string[];
|
||||
offlineQueue?: boolean;
|
||||
commandQueue?: boolean;
|
||||
/**
|
||||
*
|
||||
* By default, if the connection to Redis server has not been established, commands are added to a queue
|
||||
* and are executed once the connection is "ready" (when `enableReadyCheck` is true, "ready" means
|
||||
* the Redis server has loaded the database from disk, otherwise means the connection to the Redis
|
||||
* server has been established). If this option is false, when execute the command when the connection
|
||||
* isn't ready, an error will be returned.
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
enableOfflineQueue?: boolean;
|
||||
/**
|
||||
* The client will sent an INFO command to check whether the server is still loading data from the disk (
|
||||
* which happens when the server is just launched) when the connection is established, and only wait until
|
||||
* the loading process is finished before emitting the `ready` event.
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
enableReadyCheck?: boolean;
|
||||
/**
|
||||
* When a Redis instance is initialized, a connection to the server is immediately established. Set this to
|
||||
* true will delay the connection to the server until the first command is sent or `redis.connect()` is called
|
||||
* explicitly.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
lazyConnect?: boolean;
|
||||
/**
|
||||
* @default undefined
|
||||
*/
|
||||
scripts?: Record<string, {
|
||||
lua: string;
|
||||
numberOfKeys?: number;
|
||||
readOnly?: boolean;
|
||||
}>;
|
||||
}
|
||||
export declare type RedisOptions = CommonRedisOptions & SentinelConnectionOptions & StandaloneConnectionOptions;
|
||||
export declare const DEFAULT_REDIS_OPTIONS: RedisOptions;
|
||||
55
node_modules/ioredis/built/redis/RedisOptions.js
generated
vendored
Normal file
55
node_modules/ioredis/built/redis/RedisOptions.js
generated
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.DEFAULT_REDIS_OPTIONS = void 0;
|
||||
exports.DEFAULT_REDIS_OPTIONS = {
|
||||
// Connection
|
||||
port: 6379,
|
||||
host: "localhost",
|
||||
family: 4,
|
||||
connectTimeout: 10000,
|
||||
disconnectTimeout: 2000,
|
||||
retryStrategy: function (times) {
|
||||
return Math.min(times * 50, 2000);
|
||||
},
|
||||
keepAlive: 0,
|
||||
noDelay: true,
|
||||
connectionName: null,
|
||||
// Sentinel
|
||||
sentinels: null,
|
||||
name: null,
|
||||
role: "master",
|
||||
sentinelRetryStrategy: function (times) {
|
||||
return Math.min(times * 10, 1000);
|
||||
},
|
||||
sentinelReconnectStrategy: function () {
|
||||
// This strategy only applies when sentinels are used for detecting
|
||||
// a failover, not during initial master resolution.
|
||||
// The deployment can still function when some of the sentinels are down
|
||||
// for a long period of time, so we may not want to attempt reconnection
|
||||
// very often. Therefore the default interval is fairly long (1 minute).
|
||||
return 60000;
|
||||
},
|
||||
natMap: null,
|
||||
enableTLSForSentinelMode: false,
|
||||
updateSentinels: true,
|
||||
failoverDetector: false,
|
||||
// Status
|
||||
username: null,
|
||||
password: null,
|
||||
db: 0,
|
||||
// Others
|
||||
enableOfflineQueue: true,
|
||||
enableReadyCheck: true,
|
||||
autoResubscribe: true,
|
||||
autoResendUnfulfilledCommands: true,
|
||||
lazyConnect: false,
|
||||
keyPrefix: "",
|
||||
reconnectOnError: null,
|
||||
readOnly: false,
|
||||
stringNumbers: false,
|
||||
maxRetriesPerRequest: 20,
|
||||
maxLoadingRetryTime: 10000,
|
||||
enableAutoPipelining: false,
|
||||
autoPipeliningIgnoredCommands: [],
|
||||
sentinelMaxConnections: 10,
|
||||
};
|
||||
4
node_modules/ioredis/built/redis/event_handler.d.ts
generated
vendored
Normal file
4
node_modules/ioredis/built/redis/event_handler.d.ts
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
export declare function connectHandler(self: any): () => void;
|
||||
export declare function closeHandler(self: any): () => void;
|
||||
export declare function errorHandler(self: any): (error: any) => void;
|
||||
export declare function readyHandler(self: any): () => void;
|
||||
280
node_modules/ioredis/built/redis/event_handler.js
generated
vendored
Normal file
280
node_modules/ioredis/built/redis/event_handler.js
generated
vendored
Normal file
@@ -0,0 +1,280 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.readyHandler = exports.errorHandler = exports.closeHandler = exports.connectHandler = void 0;
|
||||
const redis_errors_1 = require("redis-errors");
|
||||
const Command_1 = require("../Command");
|
||||
const errors_1 = require("../errors");
|
||||
const utils_1 = require("../utils");
|
||||
const DataHandler_1 = require("../DataHandler");
|
||||
const debug = (0, utils_1.Debug)("connection");
|
||||
function connectHandler(self) {
|
||||
return function () {
|
||||
self.setStatus("connect");
|
||||
self.resetCommandQueue();
|
||||
// AUTH command should be processed before any other commands
|
||||
let flushed = false;
|
||||
const { connectionEpoch } = self;
|
||||
if (self.condition.auth) {
|
||||
self.auth(self.condition.auth, function (err) {
|
||||
if (connectionEpoch !== self.connectionEpoch) {
|
||||
return;
|
||||
}
|
||||
if (err) {
|
||||
if (err.message.indexOf("no password is set") !== -1) {
|
||||
console.warn("[WARN] Redis server does not require a password, but a password was supplied.");
|
||||
}
|
||||
else if (err.message.indexOf("without any password configured for the default user") !== -1) {
|
||||
console.warn("[WARN] This Redis server's `default` user does not require a password, but a password was supplied");
|
||||
}
|
||||
else if (err.message.indexOf("wrong number of arguments for 'auth' command") !== -1) {
|
||||
console.warn(`[ERROR] The server returned "wrong number of arguments for 'auth' command". You are probably passing both username and password to Redis version 5 or below. You should only pass the 'password' option for Redis version 5 and under.`);
|
||||
}
|
||||
else {
|
||||
flushed = true;
|
||||
self.recoverFromFatalError(err, err);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
if (self.condition.select) {
|
||||
self.select(self.condition.select).catch((err) => {
|
||||
// If the node is in cluster mode, select is disallowed.
|
||||
// In this case, reconnect won't help.
|
||||
self.silentEmit("error", err);
|
||||
});
|
||||
}
|
||||
if (!self.options.enableReadyCheck) {
|
||||
exports.readyHandler(self)();
|
||||
}
|
||||
/*
|
||||
No need to keep the reference of DataHandler here
|
||||
because we don't need to do the cleanup.
|
||||
`Stream#end()` will remove all listeners for us.
|
||||
*/
|
||||
new DataHandler_1.default(self, {
|
||||
stringNumbers: self.options.stringNumbers,
|
||||
});
|
||||
if (self.options.enableReadyCheck) {
|
||||
self._readyCheck(function (err, info) {
|
||||
if (connectionEpoch !== self.connectionEpoch) {
|
||||
return;
|
||||
}
|
||||
if (err) {
|
||||
if (!flushed) {
|
||||
self.recoverFromFatalError(new Error("Ready check failed: " + err.message), err);
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (self.connector.check(info)) {
|
||||
exports.readyHandler(self)();
|
||||
}
|
||||
else {
|
||||
self.disconnect(true);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
}
|
||||
exports.connectHandler = connectHandler;
|
||||
function abortError(command) {
|
||||
const err = new redis_errors_1.AbortError("Command aborted due to connection close");
|
||||
err.command = {
|
||||
name: command.name,
|
||||
args: command.args,
|
||||
};
|
||||
return err;
|
||||
}
|
||||
// If a contiguous set of pipeline commands starts from index zero then they
|
||||
// can be safely reattempted. If however we have a chain of pipelined commands
|
||||
// starting at index 1 or more it means we received a partial response before
|
||||
// the connection close and those pipelined commands must be aborted. For
|
||||
// example, if the queue looks like this: [2, 3, 4, 0, 1, 2] then after
|
||||
// aborting and purging we'll have a queue that looks like this: [0, 1, 2]
|
||||
function abortIncompletePipelines(commandQueue) {
|
||||
let expectedIndex = 0;
|
||||
for (let i = 0; i < commandQueue.length;) {
|
||||
const command = commandQueue.peekAt(i).command;
|
||||
const pipelineIndex = command.pipelineIndex;
|
||||
if (pipelineIndex === undefined || pipelineIndex === 0) {
|
||||
expectedIndex = 0;
|
||||
}
|
||||
if (pipelineIndex !== undefined && pipelineIndex !== expectedIndex++) {
|
||||
commandQueue.remove(i, 1);
|
||||
command.reject(abortError(command));
|
||||
continue;
|
||||
}
|
||||
i++;
|
||||
}
|
||||
}
|
||||
// If only a partial transaction result was received before connection close,
|
||||
// we have to abort any transaction fragments that may have ended up in the
|
||||
// offline queue
|
||||
function abortTransactionFragments(commandQueue) {
|
||||
for (let i = 0; i < commandQueue.length;) {
|
||||
const command = commandQueue.peekAt(i).command;
|
||||
if (command.name === "multi") {
|
||||
break;
|
||||
}
|
||||
if (command.name === "exec") {
|
||||
commandQueue.remove(i, 1);
|
||||
command.reject(abortError(command));
|
||||
break;
|
||||
}
|
||||
if (command.inTransaction) {
|
||||
commandQueue.remove(i, 1);
|
||||
command.reject(abortError(command));
|
||||
}
|
||||
else {
|
||||
i++;
|
||||
}
|
||||
}
|
||||
}
|
||||
function closeHandler(self) {
|
||||
return function () {
|
||||
self.setStatus("close");
|
||||
if (!self.prevCondition) {
|
||||
self.prevCondition = self.condition;
|
||||
}
|
||||
if (self.commandQueue.length) {
|
||||
abortIncompletePipelines(self.commandQueue);
|
||||
self.prevCommandQueue = self.commandQueue;
|
||||
}
|
||||
if (self.offlineQueue.length) {
|
||||
abortTransactionFragments(self.offlineQueue);
|
||||
}
|
||||
if (self.manuallyClosing) {
|
||||
self.manuallyClosing = false;
|
||||
debug("skip reconnecting since the connection is manually closed.");
|
||||
return close();
|
||||
}
|
||||
if (typeof self.options.retryStrategy !== "function") {
|
||||
debug("skip reconnecting because `retryStrategy` is not a function");
|
||||
return close();
|
||||
}
|
||||
const retryDelay = self.options.retryStrategy(++self.retryAttempts);
|
||||
if (typeof retryDelay !== "number") {
|
||||
debug("skip reconnecting because `retryStrategy` doesn't return a number");
|
||||
return close();
|
||||
}
|
||||
debug("reconnect in %sms", retryDelay);
|
||||
self.setStatus("reconnecting", retryDelay);
|
||||
self.reconnectTimeout = setTimeout(function () {
|
||||
self.reconnectTimeout = null;
|
||||
self.connect().catch(utils_1.noop);
|
||||
}, retryDelay);
|
||||
const { maxRetriesPerRequest } = self.options;
|
||||
if (typeof maxRetriesPerRequest === "number") {
|
||||
if (maxRetriesPerRequest < 0) {
|
||||
debug("maxRetriesPerRequest is negative, ignoring...");
|
||||
}
|
||||
else {
|
||||
const remainder = self.retryAttempts % (maxRetriesPerRequest + 1);
|
||||
if (remainder === 0) {
|
||||
debug("reach maxRetriesPerRequest limitation, flushing command queue...");
|
||||
self.flushQueue(new errors_1.MaxRetriesPerRequestError(maxRetriesPerRequest));
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
function close() {
|
||||
self.setStatus("end");
|
||||
self.flushQueue(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
|
||||
}
|
||||
}
|
||||
exports.closeHandler = closeHandler;
|
||||
function errorHandler(self) {
|
||||
return function (error) {
|
||||
debug("error: %s", error);
|
||||
self.silentEmit("error", error);
|
||||
};
|
||||
}
|
||||
exports.errorHandler = errorHandler;
|
||||
function readyHandler(self) {
|
||||
return function () {
|
||||
self.setStatus("ready");
|
||||
self.retryAttempts = 0;
|
||||
if (self.options.monitor) {
|
||||
self.call("monitor").then(() => self.setStatus("monitoring"), (error) => self.emit("error", error));
|
||||
const { sendCommand } = self;
|
||||
self.sendCommand = function (command) {
|
||||
if (Command_1.default.checkFlag("VALID_IN_MONITOR_MODE", command.name)) {
|
||||
return sendCommand.call(self, command);
|
||||
}
|
||||
command.reject(new Error("Connection is in monitoring mode, can't process commands."));
|
||||
return command.promise;
|
||||
};
|
||||
self.once("close", function () {
|
||||
delete self.sendCommand;
|
||||
});
|
||||
return;
|
||||
}
|
||||
const finalSelect = self.prevCondition
|
||||
? self.prevCondition.select
|
||||
: self.condition.select;
|
||||
if (self.options.connectionName) {
|
||||
debug("set the connection name [%s]", self.options.connectionName);
|
||||
self.client("setname", self.options.connectionName).catch(utils_1.noop);
|
||||
}
|
||||
if (self.options.readOnly) {
|
||||
debug("set the connection to readonly mode");
|
||||
self.readonly().catch(utils_1.noop);
|
||||
}
|
||||
if (self.prevCondition) {
|
||||
const condition = self.prevCondition;
|
||||
self.prevCondition = null;
|
||||
if (condition.subscriber && self.options.autoResubscribe) {
|
||||
// We re-select the previous db first since
|
||||
// `SELECT` command is not valid in sub mode.
|
||||
if (self.condition.select !== finalSelect) {
|
||||
debug("connect to db [%d]", finalSelect);
|
||||
self.select(finalSelect);
|
||||
}
|
||||
const subscribeChannels = condition.subscriber.channels("subscribe");
|
||||
if (subscribeChannels.length) {
|
||||
debug("subscribe %d channels", subscribeChannels.length);
|
||||
self.subscribe(subscribeChannels);
|
||||
}
|
||||
const psubscribeChannels = condition.subscriber.channels("psubscribe");
|
||||
if (psubscribeChannels.length) {
|
||||
debug("psubscribe %d channels", psubscribeChannels.length);
|
||||
self.psubscribe(psubscribeChannels);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (self.prevCommandQueue) {
|
||||
if (self.options.autoResendUnfulfilledCommands) {
|
||||
debug("resend %d unfulfilled commands", self.prevCommandQueue.length);
|
||||
while (self.prevCommandQueue.length > 0) {
|
||||
const item = self.prevCommandQueue.shift();
|
||||
if (item.select !== self.condition.select &&
|
||||
item.command.name !== "select") {
|
||||
self.select(item.select);
|
||||
}
|
||||
self.sendCommand(item.command, item.stream);
|
||||
}
|
||||
}
|
||||
else {
|
||||
self.prevCommandQueue = null;
|
||||
}
|
||||
}
|
||||
if (self.offlineQueue.length) {
|
||||
debug("send %d commands in offline queue", self.offlineQueue.length);
|
||||
const offlineQueue = self.offlineQueue;
|
||||
self.resetOfflineQueue();
|
||||
while (offlineQueue.length > 0) {
|
||||
const item = offlineQueue.shift();
|
||||
if (item.select !== self.condition.select &&
|
||||
item.command.name !== "select") {
|
||||
self.select(item.select);
|
||||
}
|
||||
self.sendCommand(item.command, item.stream);
|
||||
}
|
||||
}
|
||||
if (self.condition.select !== finalSelect) {
|
||||
debug("connect to db [%d]", finalSelect);
|
||||
self.select(finalSelect);
|
||||
}
|
||||
};
|
||||
}
|
||||
exports.readyHandler = readyHandler;
|
||||
Reference in New Issue
Block a user