rate-limiter-flexible 2.2.4 → 2.3.3

package/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false

package/README.md

@@ -184,6 +184,7 @@ Read detailed description on Wiki.
 * [set(key, points, secDuration)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimitersetkey-points-secduration) Set points by key.
 * [block(key, secDuration)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterblockkey-secduration) Block key for `secDuration` seconds.
 * [delete(key)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterdeletekey) Reset consumed points.
+* [deleteInMemoryBlockedAll](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterdeleteinmemoryblockedall)
 * [penalty(key, points = 1)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterpenaltykey-points--1) Increase number of consumed points in current duration.
 * [reward(key, points = 1)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimiterrewardkey-points--1) Decrease number of consumed points in current duration.
 * [getKey(key)](https://github.com/animir/node-rate-limiter-flexible/wiki/API-methods#ratelimitergetkeykey) Get internal prefixed key.

package/lib/RateLimiterMongo.js

@@ -8,7 +8,12 @@ const RateLimiterRes = require('./RateLimiterRes');
  */
 function getDriverVersion(client) {
   try {
-    const { version } = client.topology.s.options.metadata.driver;
+    let version;
+    if (client.client) {
+      ({ version } = client.client.topology.s.options.metadata.driver);
+    } else {
+      ({ version } = client.topology.s.options.metadata.driver);
+    }
     const majorVersion = parseInt(version);
 
     return majorVersion;

package/lib/RateLimiterStoreAbstract.js

@@ -261,8 +261,8 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     return new Promise((resolve, reject) => {
       this._get(rlKey, options)
         .then((res) => {
-          if (res === null) {
-            resolve(res);
+          if (res === null || typeof res === 'undefined') {
+            resolve(null);
           } else {
             resolve(this._getRateLimiterRes(rlKey, 0, res));
           }
@@ -284,6 +284,7 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     return new Promise((resolve, reject) => {
       this._delete(rlKey, options)
         .then((res) => {
+          this._inmemoryBlockedKeys.delete(rlKey);
           resolve(res);
         })
         .catch((err) => {
@@ -292,6 +293,13 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
     });
   }
 
+  /**
+   * Cleanup keys no-matter expired or not.
+   */
+  deleteInMemoryBlockedAll() {
+    this._inmemoryBlockedKeys.delete();
+  }
+
   /**
    * Get RateLimiterRes object filled depending on storeResult, which specific for exact store
    *
@@ -356,4 +364,21 @@ module.exports = class RateLimiterStoreAbstract extends RateLimiterAbstract {
   _delete(rlKey, options = {}) { // eslint-disable-line no-unused-vars
     throw new Error("You have to implement the method '_delete'!");
   }
+
+  /**
+   * Have to be implemented
+   * Resolve with object used for {@link _getRateLimiterRes} to generate {@link RateLimiterRes}
+   *
+   * @param {string} rlKey
+   * @param {number} points
+   * @param {number} msDuration
+   * @param {boolean} forceExpire
+   * @param {Object} options
+   * @abstract
+   *
+   * @return Promise<Object>
+   */
+  _upsert() {
+    throw new Error("You have to implement the method '_upsert'!");
+  }
 };

package/lib/component/BlockedKeys/BlockedKeys.js

@@ -57,4 +57,19 @@ module.exports = class BlockedKeys {
 
     return 0;
   }
+
+  /**
+   * If key is not given, delete all data in memory
+   * 
+   * @param {string|undefined} key
+   */
+  delete(key) {
+    if (key) {
+      delete this._keys[key];
+    } else {
+      Object.keys(this._keys).forEach((key) => {
+        delete this._keys[key];
+      });
+    }
+  }
 };

package/lib/component/index.d.ts

@@ -0,0 +1,9 @@
+export class RateLimiterQueueError extends Error {
+
+  constructor(message?: string, extra?: string);
+
+  readonly name: string;
+  readonly message: string;
+  readonly extra: string;
+
+}

package/lib/index.d.ts

@@ -141,6 +141,7 @@ export class RateLimiterAbstract {
     /**
      * Get RateLimiterRes in current duration. It always returns RateLimiterRes.isFirstInDuration=false.
      * @param key is usually IP address or some unique client id
+     * @param options
      * @returns  Promise, which:
      * - `resolved` with RateLimiterRes if key is set
      * - `resolved` with null if key is NOT set or expired
@@ -205,6 +206,11 @@ export class RateLimiterAbstract {
 
 export class RateLimiterStoreAbstract extends RateLimiterAbstract {
     constructor(opts: IRateLimiterStoreOptions);
+
+    /**
+     * Cleanup keys blocked in current process memory
+     */
+    deleteInMemoryBlockedAll(): void;
 }
 
 interface IRateLimiterOptions {

package/package.json

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