rate-limiter-flexible 2.4.2 → 3.0.0

package/README.md

@@ -193,6 +193,8 @@ 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)
+* [useRedisPackage](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#useredispackage)
+* [useRedis3AndLowerPackage](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#useredis3andlowerpackage)
 
 ## API
 

package/lib/RateLimiterRedis.js

@@ -24,14 +24,12 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
    */
   constructor(opts) {
     super(opts);
-    if (opts.redis) {
-      this.client = opts.redis;
-    } else {
-      this.client = opts.storeClient;
-    }
+    this.client = opts.storeClient;
 
     this._rejectIfRedisNotReady = !!opts.rejectIfRedisNotReady;
 
+    this.useRedisPackage = opts.useRedisPackage;
+    this.useRedis3AndLowerPackage = opts.useRedis3AndLowerPackage;
     if (typeof this.client.defineCommand === 'function') {
       this.client.defineCommand("rlflxIncr", {
         numberOfKeys: 1,
@@ -79,32 +77,39 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
     return res;
   }
 
-  _upsert(rlKey, points, msDuration, forceExpire = false) {
-    return new Promise((resolve, reject) => {
-      if (!this._isRedisReady()) {
-        return reject(new Error('Redis connection is not ready'));
-      }
+  async _upsert(rlKey, points, msDuration, forceExpire = false) {
+    if (!this._isRedisReady()) {
+      throw new Error('Redis connection is not ready');
+    }
+
+    const secDuration = Math.floor(msDuration / 1000);
+    const multi = this.client.multi();
 
-      const secDuration = Math.floor(msDuration / 1000);
-      const multi = this.client.multi();
-      if (forceExpire) {
-        if (secDuration > 0) {
-          multi.set(rlKey, points, 'EX', secDuration);
-        } else {
-          multi.set(rlKey, points);
+    if (forceExpire) {
+      if (secDuration > 0) {
+        if(!this.useRedisPackage && !this.useRedis3AndLowerPackage){
+          multi.set(rlKey, points, "EX", secDuration);
+        }else{
+          multi.set(rlKey, points, { EX: secDuration });
         }
+      } else {
+        multi.set(rlKey, points);
+      }
 
-        multi.pttl(rlKey)
-          .exec((err, res) => {
-            if (err) {
-              return reject(err);
-            }
+      if(!this.useRedisPackage && !this.useRedis3AndLowerPackage){
+        return multi.pttl(rlKey).exec(true);
+      }
+      return multi.pTTL(rlKey).exec(true);
+    }
 
-            return resolve(res);
-          });
-      } else {
-        if (secDuration > 0) {
-          const incrCallback = function(err, result) {
+    if (secDuration > 0) {
+      if(!this.useRedisPackage && !this.useRedis3AndLowerPackage){
+        return this.client.rlflxIncr(
+          [rlKey].concat([String(points), String(secDuration)]));
+      }
+      if (this.useRedis3AndLowerPackage) {
+        return new Promise((resolve, reject) => {
+          const incrCallback = function (err, result) {
             if (err) {
               return reject(err);
             }
@@ -117,56 +122,55 @@ class RateLimiterRedis extends RateLimiterStoreAbstract {
           } else {
             this.client.eval(incrTtlLuaScript, 1, rlKey, points, secDuration, incrCallback);
           }
-        } else {
-          multi.incrby(rlKey, points)
-            .pttl(rlKey)
-            .exec((err, res) => {
-              if (err) {
-                return reject(err);
-              }
-
-              return resolve(res);
-            });
-        }
+        });
+      } else {
+        return this.client.eval(incrTtlLuaScript, {
+          keys: [rlKey],
+          arguments: [String(points), String(secDuration)],
+        });
       }
-    });
-  }
-
-  _get(rlKey) {
-    return new Promise((resolve, reject) => {
-      if (!this._isRedisReady()) {
-        return reject(new Error('Redis connection is not ready'));
+    } else {
+      if(!this.useRedisPackage && !this.useRedis3AndLowerPackage){
+        return multi.incrby(rlKey, points).pttl(rlKey).exec(true);
       }
 
-      this.client
+      return multi.incrBy(rlKey, points).pTTL(rlKey).exec(true);
+    }
+  }
+
+  async _get(rlKey) {
+    if (!this._isRedisReady()) {
+      throw new Error('Redis connection is not ready');
+    }
+    if(!this.useRedisPackage && !this.useRedis3AndLowerPackage){
+      return this.client
         .multi()
         .get(rlKey)
         .pttl(rlKey)
-        .exec((err, res) => {
-          if (err) {
-            reject(err);
-          } else {
-            const [points] = res;
-            if (points === null) {
-              return resolve(null)
-            }
-
-            resolve(res);
-          }
+        .exec()
+        .then((result) => {
+          const [[,points]] = result;
+          if (points === null) return null;
+          return result;
         });
-    });
+    }
+
+    return this.client
+      .multi()
+      .get(rlKey)
+      .pTTL(rlKey)
+      .exec(true)
+      .then((result) => {
+        const [points] = result;
+        if (points === null) return null;
+        return result;
+      });
   }
 
   _delete(rlKey) {
-    return new Promise((resolve, reject) => {
-      this.client.del(rlKey, (err, res) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(res > 0);
-        }
-      });
-    });
+    return this.client
+      .del(rlKey)
+      .then(result => result > 0);
   }
 }
 

package/lib/RateLimiterStoreAbstract.js

@@ -16,8 +16,8 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
   constructor(opts = {}) {
     super(opts);
 
-    this.inMemoryBlockOnConsumed = opts.inMemoryBlockOnConsumed || opts.inmemoryBlockOnConsumed;
-    this.inMemoryBlockDuration = opts.inMemoryBlockDuration || opts.inmemoryBlockDuration;
+    this.inMemoryBlockOnConsumed = opts.inMemoryBlockOnConsumed;
+    this.inMemoryBlockDuration = opts.inMemoryBlockDuration;
     this.insuranceLimiter = opts.insuranceLimiter;
     this._inMemoryBlockedKeys = new BlockedKeys();
   }
@@ -106,64 +106,6 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     }
   }
 
-  /**
-   * @deprecated Use camelCase version
-   * @returns {BlockedKeys}
-   * @private
-   */
-  get _inmemoryBlockedKeys() {
-    return this._inMemoryBlockedKeys
-  }
-
-  /**
-   * @deprecated Use camelCase version
-   * @param rlKey
-   * @returns {number}
-   */
-  getInmemoryBlockMsBeforeExpire(rlKey) {
-    return this.getInMemoryBlockMsBeforeExpire(rlKey)
-  }
-
-  /**
-   * @deprecated Use camelCase version
-   * @returns {number|number}
-   */
-  get inmemoryBlockOnConsumed() {
-    return this.inMemoryBlockOnConsumed;
-  }
-
-  /**
-   * @deprecated Use camelCase version
-   * @param value
-   */
-  set inmemoryBlockOnConsumed(value) {
-    this.inMemoryBlockOnConsumed = value;
-  }
-
-  /**
-   * @deprecated Use camelCase version
-   * @returns {number|number}
-   */
-  get inmemoryBlockDuration() {
-    return this.inMemoryBlockDuration;
-  }
-
-  /**
-   * @deprecated Use camelCase version
-   * @param value
-   */
-  set inmemoryBlockDuration(value) {
-    this.inMemoryBlockDuration = value
-  }
-
-  /**
-   * @deprecated Use camelCase version
-   * @returns {number}
-   */
-  get msInmemoryBlockDuration() {
-    return this.inMemoryBlockDuration * 1000;
-  }
-
   getInMemoryBlockMsBeforeExpire(rlKey) {
     if (this.inMemoryBlockOnConsumed > 0) {
       return this._inMemoryBlockedKeys.msBeforeExpire(rlKey);

package/lib/index.d.ts

@@ -231,14 +231,6 @@ interface IRateLimiterStoreOptions extends IRateLimiterOptions {
     storeType?: string;
     inMemoryBlockOnConsumed?: number;
     inMemoryBlockDuration?: number;
-    /**
-    * @deprecated Use camelCased inMemoryBlockOnConsumed option
-    */
-    inmemoryBlockOnConsumed?: number;
-    /**
-    * @deprecated Use camelCased inMemoryBlockOnConsumed option
-    */
-    inmemoryBlockDuration?: number;
     insuranceLimiter?: RateLimiterAbstract;
     dbName?: string;
     tableName?: string;
@@ -257,6 +249,8 @@ interface IRateLimiterMongoOptions extends IRateLimiterStoreOptions {
 
 interface IRateLimiterRedisOptions extends IRateLimiterStoreOptions {
   rejectIfRedisNotReady?: boolean;
+  useRedisPackage?: boolean;
+  useRedis3AndLowerPackage?: boolean;
 }
 
 interface ICallbackReady {

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.4.2",
+  "version": "3.0.0",
   "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": {
+    "dc:up": "docker-compose -f docker-compose.yml up -d",
+    "dc:down": "docker-compose -f docker-compose.yml down",
     "test": "istanbul -v cover -- _mocha --recursive",
     "debug-test": "mocha --inspect-brk lib/**/**.test.js",
     "coveralls": "cat ./coverage/lcov.info | coveralls",
@@ -46,9 +48,11 @@
     "eslint-plugin-import": "^2.7.0",
     "eslint-plugin-node": "^6.0.1",
     "eslint-plugin-security": "^1.4.0",
+    "ioredis": "^5.3.2",
     "istanbul": "^0.4.5",
     "memcached-mock": "^0.1.0",
-    "mocha": "^5.1.1",
+    "mocha": "^10.2.0",
+    "redis": "^4.6.8",
     "redis-mock": "^0.48.0",
     "sinon": "^5.0.10"
   },