rate-limiter-flexible 2.3.12 → 2.4.1

package/README.md

@@ -180,6 +180,7 @@ Smooth out traffic picks:
 Specific:
 * [indexKeyPrefix](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#indexkeyprefix) Combined indexes of MongoDB.
 * [timeoutMs](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#timeoutms) For Cluster.
+* [rejectIfRedisNotReady](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#rejectifredisnotready)
 
 ## API
 

package/lib/RateLimiterRedis.js

@@ -19,6 +19,7 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
    *   ... see other in RateLimiterStoreAbstract
    *
    *   redis: RedisClient
+   *   rejectIfRedisNotReady: boolean = false - reject / invoke insuranceLimiter immediately when redis connection is not "ready"
    * }
    */
   constructor(opts) {
@@ -29,6 +30,8 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
       this.client = opts.storeClient;
     }
 
+    this._rejectIfRedisNotReady = !!opts.rejectIfRedisNotReady;
+
     if (typeof this.client.defineCommand === 'function') {
       this.client.defineCommand("rlflxIncr", {
         numberOfKeys: 1,
@@ -37,6 +40,28 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
     }
   }
 
+  /**
+   * Prevent actual redis call if redis connection is not ready
+   * Because of different connection state checks for ioredis and node-redis, only this clients would be actually checked.
+   * For any other clients all the requests would be passed directly to redis client
+   * @return {boolean}
+   * @private
+   */
+  _isRedisReady() {
+    if (!this._rejectIfRedisNotReady) {
+      return true;
+    }
+    // ioredis client
+    if (this.client.status && this.client.status !== 'ready') {
+      return false;
+    }
+    // node-redis client
+    if (typeof this.client.isReady === 'function' && !this.client.isReady()) {
+      return false;
+    }
+    return true;
+  }
+
   _getRateLimiterRes(rlKey, changedPoints, result) {
     let [consumed, resTtlMs] = result;
     // Support ioredis results format
@@ -56,6 +81,10 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
 
   _upsert(rlKey, points, msDuration, forceExpire = false) {
     return new Promise((resolve, reject) => {
+      if (!this._isRedisReady()) {
+        return reject(new Error('Redis connection is not ready'));
+      }
+
       const secDuration = Math.floor(msDuration / 1000);
       const multi = this.client.multi();
       if (forceExpire) {
@@ -105,6 +134,10 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
 
   _get(rlKey) {
     return new Promise((resolve, reject) => {
+      if (!this._isRedisReady()) {
+        return reject(new Error('Redis connection is not ready'));
+      }
+
       this.client
         .multi()
         .get(rlKey)

package/lib/index.d.ts

@@ -255,6 +255,10 @@ interface IRateLimiterMongoOptions extends IRateLimiterStoreOptions {
     };
 }
 
+interface IRateLimiterRedisOptions extends IRateLimiterStoreOptions {
+  rejectIfRedisNotReady?: boolean;
+}
+
 interface ICallbackReady {
     (error?: Error): void;
 }
@@ -284,7 +288,9 @@ export class RateLimiterClusterMasterPM2 {
     constructor(pm2: any);
 }
 
-export class RateLimiterRedis extends RateLimiterStoreAbstract {}
+export class RateLimiterRedis extends RateLimiterStoreAbstract {
+  constructor(opts: IRateLimiterRedisOptions);
+}
 
 export interface IRateLimiterMongoFunctionOptions {
     attrs: { [key: string]: any };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.3.12",
+  "version": "2.4.1",
   "description": "Node.js rate limiter by key and protection from DDoS and Brute-Force attacks in process Memory, Redis, MongoDb, Memcached, MySQL, PostgreSQL, Cluster or PM",
   "main": "index.js",
   "scripts": {