rate-limiter-flexible 2.3.10 → 2.3.12

package/README.md

@@ -29,7 +29,7 @@ Allow **traffic bursts** with [BurstyRateLimiter](https://github.com/animir/node
 
 **Friendly.** No matter which node package you prefer: `redis` or `ioredis`, `sequelize`/`typeorm` or `knex`, `memcached`, native driver or `mongoose`. It works with all of them.
 
-**In memory blocks.** Avoid extra requests to store with [inmemoryBlockOnConsumed](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockonconsumed).
+**In memory blocks.** Avoid extra requests to store with [inMemoryBlockOnConsumed](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockonconsumed).
 
 **Deno compatible** See [this example](https://gist.github.com/animir/d06ca92931677f330d3f2d4c6c3108e4) 
 
@@ -164,8 +164,8 @@ See [releases](https://github.com/animir/node-rate-limiter-flexible/releases) fo
 ### Other options on Wiki:
 * [keyPrefix](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#keyprefix) Make keys unique among different limiters.
 * [blockDuration](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#blockduration) Block for N seconds, if consumed more than points.
-* [inmemoryBlockOnConsumed](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockonconsumed) Avoid extra requests to store.
-* [inmemoryBlockDuration](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockduration)
+* [inMemoryBlockOnConsumed](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockonconsumed) Avoid extra requests to store.
+* [inMemoryBlockDuration](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockduration)
 * [insuranceLimiter](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#insurancelimiter) Make it more stable with less efforts.
 * [storeType](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#storetype) Have to be set to `knex`, if you use it.
 * [dbName](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#dbname) Where to store points.
@@ -215,7 +215,7 @@ Average latency during test pure NodeJS endpoint in cluster of 4 workers with ev
 7. MySQL     14.59 ms (with connection pool 100)
 ```
 
-Note, you can speed up limiters with [inmemoryBlockOnConsumed](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockonconsumed) option.
+Note, you can speed up limiters with [inMemoryBlockOnConsumed](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#inmemoryblockonconsumed) option.
 
 ## Contribution
 

package/lib/RateLimiterStoreAbstract.js

@@ -8,18 +8,18 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
    * @param opts Object Defaults {
    *   ... see other in RateLimiterAbstract
    *
-   *   inmemoryBlockOnConsumed: 40, // Number of points when key is blocked
-   *   inmemoryBlockDuration: 10, // Block duration in seconds
+   *   inMemoryBlockOnConsumed: 40, // Number of points when key is blocked
+   *   inMemoryBlockDuration: 10, // Block duration in seconds
    *   insuranceLimiter: RateLimiterAbstract
    * }
    */
   constructor(opts = {}) {
     super(opts);
 
-    this.inmemoryBlockOnConsumed = opts.inmemoryBlockOnConsumed;
-    this.inmemoryBlockDuration = opts.inmemoryBlockDuration;
+    this.inMemoryBlockOnConsumed = opts.inMemoryBlockOnConsumed || opts.inmemoryBlockOnConsumed;
+    this.inMemoryBlockDuration = opts.inMemoryBlockDuration || opts.inmemoryBlockDuration;
     this.insuranceLimiter = opts.insuranceLimiter;
-    this._inmemoryBlockedKeys = new BlockedKeys();
+    this._inMemoryBlockedKeys = new BlockedKeys();
   }
 
   get client() {
@@ -50,10 +50,10 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
   _afterConsume(resolve, reject, rlKey, changedPoints, storeResult, options = {}) {
     const res = this._getRateLimiterRes(rlKey, changedPoints, storeResult);
 
-    if (this.inmemoryBlockOnConsumed > 0 && !(this.inmemoryBlockDuration > 0)
-      && res.consumedPoints >= this.inmemoryBlockOnConsumed
+    if (this.inMemoryBlockOnConsumed > 0 && !(this.inMemoryBlockDuration > 0)
+      && res.consumedPoints >= this.inMemoryBlockOnConsumed
     ) {
-      this._inmemoryBlockedKeys.addMs(rlKey, res.msBeforeNext);
+      this._inMemoryBlockedKeys.addMs(rlKey, res.msBeforeNext);
       if (res.consumedPoints > this.points) {
         return reject(res);
       } else {
@@ -67,10 +67,10 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
         blockPromise = this._block(rlKey, res.consumedPoints, this.msBlockDuration, options);
       }
 
-      if (this.inmemoryBlockOnConsumed > 0 && res.consumedPoints >= this.inmemoryBlockOnConsumed) {
-        // Block key for this.inmemoryBlockDuration seconds
-        this._inmemoryBlockedKeys.add(rlKey, this.inmemoryBlockDuration);
-        res.msBeforeNext = this.msInmemoryBlockDuration;
+      if (this.inMemoryBlockOnConsumed > 0 && res.consumedPoints >= this.inMemoryBlockOnConsumed) {
+        // Block key for this.inMemoryBlockDuration seconds
+        this._inMemoryBlockedKeys.add(rlKey, this.inMemoryBlockDuration);
+        res.msBeforeNext = this.msInMemoryBlockDuration;
       }
 
       blockPromise
@@ -106,38 +106,96 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     }
   }
 
-  getInmemoryBlockMsBeforeExpire(rlKey) {
-    if (this.inmemoryBlockOnConsumed > 0) {
-      return this._inmemoryBlockedKeys.msBeforeExpire(rlKey);
-    }
+  /**
+   * @deprecated Use camelCase version
+   * @returns {BlockedKeys}
+   * @private
+   */
+  get _inmemoryBlockedKeys() {
+    return this._inMemoryBlockedKeys
+  }
 
-    return 0;
+  /**
+   * @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;
+    return this.inMemoryBlockOnConsumed;
   }
 
+  /**
+   * @deprecated Use camelCase version
+   * @param value
+   */
   set inmemoryBlockOnConsumed(value) {
-    this._inmemoryBlockOnConsumed = value ? parseInt(value) : 0;
-    if (this.inmemoryBlockOnConsumed > 0 && this.points > this.inmemoryBlockOnConsumed) {
-      throw new Error('inmemoryBlockOnConsumed option must be greater or equal "points" option');
-    }
+    this.inMemoryBlockOnConsumed = value;
   }
 
+  /**
+   * @deprecated Use camelCase version
+   * @returns {number|number}
+   */
   get inmemoryBlockDuration() {
-    return this._inmemoryBlockDuration;
+    return this.inMemoryBlockDuration;
   }
 
+  /**
+   * @deprecated Use camelCase version
+   * @param value
+   */
   set inmemoryBlockDuration(value) {
-    this._inmemoryBlockDuration = value ? parseInt(value) : 0;
-    if (this.inmemoryBlockDuration > 0 && this.inmemoryBlockOnConsumed === 0) {
-      throw new Error('inmemoryBlockOnConsumed option must be set up');
-    }
+    this.inMemoryBlockDuration = value
   }
 
+  /**
+   * @deprecated Use camelCase version
+   * @returns {number}
+   */
   get msInmemoryBlockDuration() {
-    return this._inmemoryBlockDuration * 1000;
+    return this.inMemoryBlockDuration * 1000;
+  }
+
+  getInMemoryBlockMsBeforeExpire(rlKey) {
+    if (this.inMemoryBlockOnConsumed > 0) {
+      return this._inMemoryBlockedKeys.msBeforeExpire(rlKey);
+    }
+
+    return 0;
+  }
+
+  get inMemoryBlockOnConsumed() {
+    return this._inMemoryBlockOnConsumed;
+  }
+
+  set inMemoryBlockOnConsumed(value) {
+    this._inMemoryBlockOnConsumed = value ? parseInt(value) : 0;
+    if (this.inMemoryBlockOnConsumed > 0 && this.points > this.inMemoryBlockOnConsumed) {
+      throw new Error('inMemoryBlockOnConsumed option must be greater or equal "points" option');
+    }
+  }
+
+  get inMemoryBlockDuration() {
+    return this._inMemoryBlockDuration;
+  }
+
+  set inMemoryBlockDuration(value) {
+    this._inMemoryBlockDuration = value ? parseInt(value) : 0;
+    if (this.inMemoryBlockDuration > 0 && this.inMemoryBlockOnConsumed === 0) {
+      throw new Error('inMemoryBlockOnConsumed option must be set up');
+    }
+  }
+
+  get msInMemoryBlockDuration() {
+    return this._inMemoryBlockDuration * 1000;
   }
 
   get insuranceLimiter() {
@@ -195,9 +253,9 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     return new Promise((resolve, reject) => {
       const rlKey = this.getKey(key);
 
-      const inmemoryBlockMsBeforeExpire = this.getInmemoryBlockMsBeforeExpire(rlKey);
-      if (inmemoryBlockMsBeforeExpire > 0) {
-        return reject(new RateLimiterRes(0, inmemoryBlockMsBeforeExpire));
+      const inMemoryBlockMsBeforeExpire = this.getInMemoryBlockMsBeforeExpire(rlKey);
+      if (inMemoryBlockMsBeforeExpire > 0) {
+        return reject(new RateLimiterRes(0, inMemoryBlockMsBeforeExpire));
       }
 
       this._upsert(rlKey, pointsToConsume, this._getKeySecDuration(options) * 1000, false, options)
@@ -284,7 +342,7 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     return new Promise((resolve, reject) => {
       this._delete(rlKey, options)
         .then((res) => {
-          this._inmemoryBlockedKeys.delete(rlKey);
+          this._inMemoryBlockedKeys.delete(rlKey);
           resolve(res);
         })
         .catch((err) => {
@@ -297,7 +355,7 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
    * Cleanup keys no-matter expired or not.
    */
   deleteInMemoryBlockedAll() {
-    this._inmemoryBlockedKeys.delete();
+    this._inMemoryBlockedKeys.delete();
   }
 
   /**
@@ -378,7 +436,7 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
    *
    * @return Promise<Object>
    */
-  _upsert() {
+  _upsert(rlKey, points, msDuration, forceExpire = false, options = {}) {
     throw new Error("You have to implement the method '_upsert'!");
   }
 };

package/lib/RateLimiterUnion.js

@@ -2,8 +2,8 @@ const RateLimiterAbstract = require('./RateLimiterAbstract');
 
 module.exports = class RateLimiterUnion {
   constructor(...limiters) {
-    if (limiters.length < 2) {
-      throw new Error('RateLimiterUnion: at least two limiters have to be set');
+    if (limiters.length < 1) {
+      throw new Error('RateLimiterUnion: at least one limiter have to be passed');
     }
     limiters.forEach((limiter) => {
       if (!(limiter instanceof RateLimiterAbstract)) {

package/lib/index.d.ts

@@ -229,7 +229,15 @@ interface IRateLimiterClusterOptions extends IRateLimiterOptions {
 interface IRateLimiterStoreOptions extends IRateLimiterOptions {
     storeClient: any;
     storeType?: string;
+    inMemoryBlockOnConsumed?: number;
+    inMemoryBlockDuration?: number;
+    /**
+    * @deprecated Use camelCased inMemoryBlockOnConsumed option
+    */
     inmemoryBlockOnConsumed?: number;
+    /**
+    * @deprecated Use camelCased inMemoryBlockOnConsumed option
+    */
     inmemoryBlockDuration?: number;
     insuranceLimiter?: RateLimiterAbstract;
     dbName?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.3.10",
+  "version": "2.3.12",
   "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": {