rate-limiter-flexible 2.1.5 → 2.1.10

package/README.md

@@ -161,6 +161,7 @@ See [releases](https://github.com/animir/node-rate-limiter-flexible/releases) fo
 * [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.
 * [tableName](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#tablename) Table/collection.
+* [tableCreated](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#tablecreated) Is table already created in MySQL or PostgreSQL.
 * [clearExpiredByTimeout](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#clearexpiredbytimeout) For MySQL and PostgreSQL.
 
 Smooth out traffic picks:
@@ -215,10 +216,11 @@ Make sure you've launched `npm run eslint` before creating PR, all errors have t
 You can try to run `npm run eslint-fix` to fix some issues.
 
 Any new limiter with storage have to be extended from `RateLimiterStoreAbstract`.
-It has to implement at least 4 methods:
+It has to implement 4 methods:
 * `_getRateLimiterRes` parses raw data from store to `RateLimiterRes` object.
-* `_upsert` inserts or updates limits data by key and returns raw data.
-* `_get` returns raw data by key.
+* `_upsert` must be atomic. it inserts or updates value by key and returns raw data. it must support `forceExpire` mode 
+    to overwrite key expiration time.
+* `_get` returns raw data by key or `null` if there is no key.
 * `_delete` deletes all key related data and returns `true` on deleted, `false` if key is not found.
 
 All other methods depends on store. See `RateLimiterRedis` or `RateLimiterPostgres` for example.

package/lib/BurstyRateLimiter.js

@@ -1,22 +1,47 @@
 const RateLimiterRes = require("./RateLimiterRes");
 
+/**
+ * Bursty rate limiter exposes only msBeforeNext time and doesn't expose points from bursty limiter by default
+ * @type {BurstyRateLimiter}
+ */
 module.exports = class BurstyRateLimiter {
   constructor(rateLimiter, burstLimiter) {
     this._rateLimiter = rateLimiter;
     this._burstLimiter = burstLimiter
   }
 
+  /**
+   * Merge rate limiter response objects. Responses can be null
+   *
+   * @param {RateLimiterRes} [rlRes] Rate limiter response
+   * @param {RateLimiterRes} [blRes] Bursty limiter response
+   */
+  _combineRes(rlRes, blRes) {
+    return new RateLimiterRes(
+      rlRes.remainingPoints,
+      Math.min(rlRes.msBeforeNext, blRes.msBeforeNext),
+      rlRes.consumedPoints,
+      rlRes.isFirstInDuration
+    )
+  }
+
+  /**
+   * @param key
+   * @param pointsToConsume
+   * @param options
+   * @returns {Promise<any>}
+   */
   consume(key, pointsToConsume = 1, options = {}) {
     return this._rateLimiter.consume(key, pointsToConsume, options)
       .catch((rlRej) => {
         if (rlRej instanceof RateLimiterRes) {
           return this._burstLimiter.consume(key, pointsToConsume, options)
-            .then(() => {
-              return Promise.resolve(rlRej)
+            .then((blRes) => {
+              return Promise.resolve(this._combineRes(rlRej, blRes))
             })
             .catch((blRej) => {
                 if (blRej instanceof RateLimiterRes) {
-                  return Promise.reject(rlRej)
+                  return Promise.reject(this._combineRes(rlRej, blRej))
                 } else {
                   return Promise.reject(blRej)
                 }
@@ -27,4 +52,23 @@ module.exports = class BurstyRateLimiter {
         }
       })
   }
+
+  /**
+   * It doesn't expose available points from burstLimiter
+   *
+   * @param key
+   * @returns {Promise<RateLimiterRes>}
+   */
+  get(key) {
+    return Promise.all([
+      this._rateLimiter.get(key),
+      this._burstLimiter.get(key),
+    ]).then(([rlRes, blRes]) => {
+      return this._combineRes(rlRes, blRes);
+    });
+  }
+
+  get points() {
+    return this._rateLimiter.points;
+  }
 };

package/lib/RateLimiterMySQL.js

@@ -28,24 +28,33 @@ class RateLimiterMySQL extends RateLimiterStoreAbstract {
 
     this.clearExpiredByTimeout = opts.clearExpiredByTimeout;
 
-    this._tableCreated = false;
-    this._createDbAndTable()
-      .then(() => {
-        this._tableCreated = true;
-        if (this.clearExpiredByTimeout) {
-          this._clearExpiredHourAgo();
-        }
-        if (typeof cb === 'function') {
-          cb();
-        }
-      })
-      .catch((err) => {
-        if (typeof cb === 'function') {
-          cb(err);
-        } else {
-          throw err;
-        }
-      });
+    this.tableCreated = opts.tableCreated;
+    if (!this.tableCreated) {
+      this._createDbAndTable()
+        .then(() => {
+          this.tableCreated = true;
+          if (this.clearExpiredByTimeout) {
+            this._clearExpiredHourAgo();
+          }
+          if (typeof cb === 'function') {
+            cb();
+          }
+        })
+        .catch((err) => {
+          if (typeof cb === 'function') {
+            cb(err);
+          } else {
+            throw err;
+          }
+        });
+    } else {
+      if (this.clearExpiredByTimeout) {
+        this._clearExpiredHourAgo();
+      }
+      if (typeof cb === 'function') {
+        cb();
+      }
+    }
   }
 
   clearExpired(expire) {
@@ -189,6 +198,14 @@ class RateLimiterMySQL extends RateLimiterStoreAbstract {
     this._tableName = typeof value === 'undefined' ? this.keyPrefix : value;
   }
 
+  get tableCreated() {
+    return this._tableCreated
+  }
+
+  set tableCreated(value) {
+    this._tableCreated = typeof value === 'undefined' ? false : !!value;
+  }
+
   get clearExpiredByTimeout() {
     return this._clearExpiredByTimeout;
   }
@@ -277,7 +294,7 @@ class RateLimiterMySQL extends RateLimiterStoreAbstract {
   }
 
   _upsert(key, points, msDuration, forceExpire = false) {
-    if (!this._tableCreated) {
+    if (!this.tableCreated) {
       return Promise.reject(Error('Table is not created yet'));
     }
 
@@ -301,7 +318,7 @@ class RateLimiterMySQL extends RateLimiterStoreAbstract {
   }
 
   _get(rlKey) {
-    if (!this._tableCreated) {
+    if (!this.tableCreated) {
       return Promise.reject(Error('Table is not created yet'));
     }
 
@@ -331,7 +348,7 @@ class RateLimiterMySQL extends RateLimiterStoreAbstract {
   }
 
   _delete(rlKey) {
-    if (!this._tableCreated) {
+    if (!this.tableCreated) {
       return Promise.reject(Error('Table is not created yet'));
     }
 

package/lib/RateLimiterPostgres.js

@@ -26,24 +26,30 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
 
     this.clearExpiredByTimeout = opts.clearExpiredByTimeout;
 
-    this._tableCreated = false;
-    this._createTable()
-      .then(() => {
-        this._tableCreated = true;
-        if (this.clearExpiredByTimeout) {
-          this._clearExpiredHourAgo();
-        }
-        if (typeof cb === 'function') {
-          cb();
-        }
-      })
-      .catch((err) => {
-        if (typeof cb === 'function') {
-          cb(err);
-        } else {
-          throw err;
-        }
-      });
+    this.tableCreated = opts.tableCreated;
+    if (!this.tableCreated) {
+      this._createTable()
+        .then(() => {
+          this.tableCreated = true;
+          if (this.clearExpiredByTimeout) {
+            this._clearExpiredHourAgo();
+          }
+          if (typeof cb === 'function') {
+            cb();
+          }
+        })
+        .catch((err) => {
+          if (typeof cb === 'function') {
+            cb(err);
+          } else {
+            throw err;
+          }
+        });
+    } else {
+      if (typeof cb === 'function') {
+        cb();
+      }
+    }
   }
 
   clearExpired(expire) {
@@ -152,17 +158,23 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
   }
 
   set clientType(value) {
+    const constructorName = this.client.constructor.name;
+
     if (typeof value === 'undefined') {
-      if (this.client.constructor.name === 'Client') {
+      if (constructorName === 'Client') {
         value = 'client';
-      } else if (this.client.constructor.name === 'Pool') {
+      } else if (
+        constructorName === 'Pool' ||
+        constructorName === 'BoundPool'
+      ) {
         value = 'pool';
-      } else if (this.client.constructor.name === 'Sequelize') {
+      } else if (constructorName === 'Sequelize') {
         value = 'sequelize';
       } else {
         throw new Error('storeType is not defined');
       }
     }
+
     this._clientType = value.toLowerCase();
   }
 
@@ -174,6 +186,14 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
     this._tableName = typeof value === 'undefined' ? this.keyPrefix : value;
   }
 
+  get tableCreated() {
+    return this._tableCreated
+  }
+
+  set tableCreated(value) {
+    this._tableCreated = typeof value === 'undefined' ? false : !!value;
+  }
+
   get clearExpiredByTimeout() {
     return this._clearExpiredByTimeout;
   }
@@ -220,7 +240,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
   }
 
   _upsert(key, points, msDuration, forceExpire = false) {
-    if (!this._tableCreated) {
+    if (!this.tableCreated) {
       return Promise.reject(Error('Table is not created yet'));
     }
 
@@ -248,7 +268,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
   }
 
   _get(rlKey) {
-    if (!this._tableCreated) {
+    if (!this.tableCreated) {
       return Promise.reject(Error('Table is not created yet'));
     }
 
@@ -272,7 +292,7 @@ class RateLimiterPostgres extends RateLimiterStoreAbstract {
   }
 
   _delete(rlKey) {
-    if (!this._tableCreated) {
+    if (!this.tableCreated) {
       return Promise.reject(Error('Table is not created yet'));
     }
 

package/lib/component/MemoryStorage/MemoryStorage.js

@@ -42,7 +42,9 @@ module.exports = class MemoryStorage {
       this._storage[key].timeoutId = setTimeout(() => {
         delete this._storage[key];
       }, durationMs);
-      this._storage[key].timeoutId.unref();
+      if (this._storage[key].timeoutId.unref) {
+        this._storage[key].timeoutId.unref();
+      }
     }
 
     return new RateLimiterRes(0, durationMs === 0 ? -1 : durationMs, this._storage[key].value, true);

package/lib/index.d.ts

@@ -67,6 +67,7 @@ interface IRateLimiterStoreOptions extends IRateLimiterOptions{
     insuranceLimiter?: RateLimiterAbstract;
     dbName?: string;
     tableName?: string;
+    tableCreated?: boolean;
 }
 
 interface IRateLimiterMongoOptions extends IRateLimiterStoreOptions{
@@ -157,7 +158,7 @@ interface IRateLimiterQueueOpts {
 }
 
 export class RateLimiterQueue {
-    constructor(limiterFlexible: RateLimiterAbstract, opts?: IRateLimiterQueueOpts);
+    constructor(limiterFlexible: RateLimiterAbstract | BurstyRateLimiter, opts?: IRateLimiterQueueOpts);
 
     getTokensRemaining(key?: string | number): Promise<RateLimiterRes>;
 

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "rate-limiter-flexible",
-  "version": "2.1.5",
+  "version": "2.1.10",
   "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": {
-    "test": "./node_modules/istanbul/lib/cli.js cover ./node_modules/.bin/_mocha --recursive",
+    "test": "istanbul -v cover -- _mocha --recursive",
     "debug-test": "mocha --inspect-brk lib/**/**.test.js",
-    "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls",
-    "eslint": "node_modules/eslint/bin/eslint.js --quiet lib/**/**.js test/**/**.js",
-    "eslint-fix": "node_modules/eslint/bin/eslint.js --fix lib/**/**.js test/**/**.js"
+    "coveralls": "cat ./coverage/lcov.info | coveralls",
+    "eslint": "eslint --quiet lib/**/**.js test/**/**.js",
+    "eslint-fix": "eslint --fix lib/**/**.js test/**/**.js"
   },
   "repository": {
     "type": "git",