rate-limiter-flexible 2.3.2 → 2.3.6

package/README.md

@@ -93,10 +93,13 @@ const headers = {
 * works in Cluster or PM2 without additional software [See RateLimiterCluster benchmark and detailed description here](https://github.com/animir/node-rate-limiter-flexible/wiki/Cluster)
 * useful `get`, `set`, `block`, `delete`, `penalty` and `reward` methods
 
-### Middlewares and plugins
+### Middlewares,  plugins and other packages
 * [Express middleware](https://github.com/animir/node-rate-limiter-flexible/wiki/Express-Middleware)
 * [Koa middleware](https://github.com/animir/node-rate-limiter-flexible/wiki/Koa-Middleware)
 * [Hapi plugin](https://github.com/animir/node-rate-limiter-flexible/wiki/Hapi-plugin)
+* GraphQL [graphql-rate-limit-directive](https://www.npmjs.com/package/graphql-rate-limit-directive)
+* NestJS try [nestjs-rate-limiter](https://www.npmjs.com/package/nestjs-rate-limiter)
+* Fastify based NestJS app try [nestjs-fastify-rate-limiter](https://www.npmjs.com/package/nestjs-fastify-rate-limiter)
 
 Some copy/paste examples on Wiki:
 * [Minimal protection against password brute-force](https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#minimal-protection-against-password-brute-force)

package/lib/RateLimiterMongo.js

@@ -4,21 +4,22 @@ const RateLimiterRes = require('./RateLimiterRes');
 /**
  * Get MongoDB driver version as upsert options differ
  * @params {Object} Client instance
- * @returns {Number|undefined} Major version
+ * @returns {Object} Version Object containing major, feature & minor versions.
  */
 function getDriverVersion(client) {
   try {
-    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);
+    const _client = client.client ? client.client : client;
 
-    return majorVersion;
+    const { version } = _client.topology.s.options.metadata.driver;
+    const _v = version.split('.').map(v => parseInt(v));
+
+    return {
+      major: _v[0],
+      feature: _v[1],
+      patch: _v[2],
+    };
   } catch (err) {
-    return undefined;
+    return { major: 0, feature: 0, patch: 0 };
   }
 }
 
@@ -174,7 +175,12 @@ class RateLimiterMongo extends RateLimiterStoreAbstract {
     const upsertOptions = {
       upsert: true,
     };
-    if (this._driverVersion >= 4) {
+    if ((this._driverVersion.major >= 4) ||
+        (this._driverVersion.major === 3 &&
+          (this._driverVersion.feature >=7) || 
+          (this._driverVersion.feature >= 6 && 
+              this._driverVersion.patch >= 7 ))) 
+    {
       upsertOptions.returnDocument = 'after';
     } else {
       upsertOptions.returnOriginal = false;

package/lib/RateLimiterQueue.js

@@ -51,7 +51,7 @@ class RateLimiterQueueInternal {
   getTokensRemaining() {
     return this._limiterFlexible.get(this._key)
       .then((rlRes) => {
-        return rlRes.remainingPoints
+        return rlRes !== null ? rlRes.remainingPoints : this._limiterFlexible.points;
       })
   }
 

package/lib/component/MemoryStorage/MemoryStorage.js

@@ -72,6 +72,9 @@ module.exports = class MemoryStorage {
    */
   delete(key) {
     if (this._storage[key]) {
+      if (this._storage[key].timeoutId) {
+        clearTimeout(this._storage[key].timeoutId);
+      }
       delete this._storage[key];
       return true;
     }

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.3.2",
+  "version": "2.3.6",
   "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": {