rate-limiter-flexible 2.1.3 → 2.1.7

package/README.md

@@ -126,6 +126,10 @@ Some copy/paste examples on Wiki:
 * [RLWrapperBlackAndWhite](https://github.com/animir/node-rate-limiter-flexible/wiki/Black-and-White-lists) Black and White lists
 * [RateLimiterQueue](https://github.com/animir/node-rate-limiter-flexible/wiki/RateLimiterQueue) Rate limiter with FIFO queue
 
+### Changelog
+
+See [releases](https://github.com/animir/node-rate-limiter-flexible/releases) for detailed changelog.
+
 ## Basic Options
 
 * **points** 
@@ -157,9 +161,10 @@ Some copy/paste examples on Wiki:
 * [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.
 
-Cut off load picks:
+Smooth out traffic picks:
 * [execEvenly](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#execevenly)
 * [execEvenlyMinDelayMs](https://github.com/animir/node-rate-limiter-flexible/wiki/Options#execevenlymindelayms)
 
@@ -218,3 +223,5 @@ It has to implement at least 4 methods:
 * `_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.
+
+Note: all changes should be covered by tests.

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/RateLimiterQueue.js

@@ -1,12 +1,46 @@
 const RateLimiterQueueError = require('./component/RateLimiterQueueError')
 const MAX_QUEUE_SIZE = 4294967295;
+const KEY_DEFAULT = 'limiter';
 
 module.exports = class RateLimiterQueue {
+  constructor(limiterFlexible, opts = {
+    maxQueueSize: MAX_QUEUE_SIZE,
+  }) {
+    this._queueLimiters = {
+      KEY_DEFAULT: new RateLimiterQueueInternal(limiterFlexible, opts)
+    };
+    this._limiterFlexible = limiterFlexible;
+    this._maxQueueSize = opts.maxQueueSize
+  }
+
+  getTokensRemaining(key = KEY_DEFAULT) {
+    if (this._queueLimiters[key]) {
+      return this._queueLimiters[key].getTokensRemaining()
+    } else {
+      return Promise.resolve(this._limiterFlexible.points)
+    }
+  }
+
+  removeTokens(tokens, key = KEY_DEFAULT) {
+    if (!this._queueLimiters[key]) {
+      this._queueLimiters[key] = new RateLimiterQueueInternal(
+        this._limiterFlexible, {
+          key,
+          maxQueueSize: this._maxQueueSize,
+        })
+    }
+
+    return this._queueLimiters[key].removeTokens(tokens)
+  }
+};
+
+class RateLimiterQueueInternal {
 
   constructor(limiterFlexible, opts = {
     maxQueueSize: MAX_QUEUE_SIZE,
+    key: KEY_DEFAULT,
   }) {
-    this._key = 'limiter';
+    this._key = opts.key;
     this._waitTimeout = null;
     this._queue = [];
     this._limiterFlexible = limiterFlexible;
@@ -90,4 +124,4 @@ module.exports = class RateLimiterQueue {
         }
       });
   }
-};
+}

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,11 @@ interface IRateLimiterQueueOpts {
 }
 
 export class RateLimiterQueue {
-    constructor(limiterFlexible: RateLimiterAbstract, opts?: IRateLimiterQueueOpts)
+    constructor(limiterFlexible: RateLimiterAbstract, opts?: IRateLimiterQueueOpts);
+
+    getTokensRemaining(key?: string | number): Promise<RateLimiterRes>;
+
+    removeTokens(tokens: number, key?: string | number): Promise<RateLimiterRes>;
 }
 
 export class BurstyRateLimiter {

package/package.json

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