express-rate-limit 4.0.3 → 5.1.3

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Nathan Friedly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -109,13 +109,15 @@ A `req.rateLimit` property is added to all requests with the `limit`, `current`,
 
 Max number of connections during `windowMs` milliseconds before sending a 429 response.
 
-May be a number, or a function that returns a number or a promise.
+May be a number, or a function that returns a number or a promise. If `max` is a function, it will be called with `req` and `res` params.
 
 Defaults to `5`. Set to `0` to disable.
 
 ### windowMs
 
-How long in milliseconds to keep records of requests in memory.
+Timeframe for which requests are checked/remembered. Also used in the Retry-After header when the limit is reached.
+
+Note: with non-default stores, you may need to configure this value twice, once here and once on the store. In some cases the units also differ (e.g. seconds vs miliseconds)
 
 Defaults to `60000` (1 minute).
 
@@ -137,7 +139,13 @@ Defaults to `429`.
 
 Enable headers for request limit (`X-RateLimit-Limit`) and current usage (`X-RateLimit-Remaining`) on all responses and time to wait before retrying (`Retry-After`) when `max` is exceeded.
 
-Defaults to `true`.
+Defaults to `true`. Behavior may change in the next major release.
+
+### draft_polli_ratelimit_headers
+
+Enable headers conforming to the [ratelimit standardization proposal](https://tools.ietf.org/id/draft-polli-ratelimit-headers-01.html): `RateLimit-Limit`, `RateLimit-Remaining`, and, if the store supports it, `RateLimit-Reset`. May be used in conjunction with, or instead of the `headers` option.
+
+Defaults to `false`. Behavior and name will likely change in future releases.
 
 ### keyGenerator
 
@@ -200,7 +208,7 @@ Defaults to `false`.
 
 ### skip
 
-Function used to skip requests. Returning `true` from the function will skip limiting for that request.
+Function used to skip (whitelist) requests. Returning `true` from the function will skip limiting for that request.
 
 Defaults to always `false` (count all requests):
 
@@ -221,6 +229,7 @@ Available data stores are:
 - MemoryStore: _(default)_ Simple in-memory option. Does not share state when app has multiple processes or servers.
 - [rate-limit-redis](https://npmjs.com/package/rate-limit-redis): A [Redis](http://redis.io/)-backed store, more suitable for large or demanding deployments.
 - [rate-limit-memcached](https://npmjs.org/package/rate-limit-memcached): A [Memcached](https://memcached.org/)-backed store.
+- [rate-limit-mongo](https://www.npmjs.com/package/rate-limit-mongo): A [MongoDB](https://www.mongodb.com/)-backed store.
 
 You may also create your own store. It must implement the following in order to function:
 
@@ -273,6 +282,10 @@ Resets the rate limiting for a given key. (Allow users to complete a captcha or
 
 ## Summary of breaking changes:
 
+### v5 changes
+
+- Removed index.d.ts. (See [#138](https://github.com/nfriedly/express-rate-limit/issues/138))
+
 ### v4 Changes
 
 - Express Rate Limit no longer modifies the passed-in options object, it instead makes a clone of it.

package/lib/express-rate-limit.js

@@ -9,19 +9,20 @@ function RateLimit(options) {
       message: "Too many requests, please try again later.",
       statusCode: 429, // 429 status = Too Many Requests (RFC 6585)
       headers: true, //Send custom rate limit header with limit and remaining
+      draft_polli_ratelimit_headers: false, //Support for the new RateLimit standardization headers
       skipFailedRequests: false, // Do not count failed requests (status >= 400)
       skipSuccessfulRequests: false, // Do not count successful requests (status < 400)
       // allows to create custom keys (by default user IP is used)
-      keyGenerator: function(req /*, res*/) {
+      keyGenerator: function (req /*, res*/) {
         return req.ip;
       },
-      skip: function(/*req, res*/) {
+      skip: function (/*req, res*/) {
         return false;
       },
-      handler: function(req, res /*, next*/) {
+      handler: function (req, res /*, next*/) {
         res.status(options.statusCode).send(options.message);
       },
-      onLimitReached: function(/*req, res, optionsUsed*/) {}
+      onLimitReached: function (/*req, res, optionsUsed*/) {},
     },
     options
   );
@@ -39,7 +40,7 @@ function RateLimit(options) {
     throw new Error("The store is not valid.");
   }
 
-  ["global", "delayMs", "delayAfter"].forEach(key => {
+  ["global", "delayMs", "delayAfter"].forEach((key) => {
     // note: this doesn't trigger if delayMs or delayAfter are set to 0, because that essentially disables them
     if (options[key]) {
       throw new Error(
@@ -55,7 +56,7 @@ function RateLimit(options) {
 
     const key = options.keyGenerator(req, res);
 
-    options.store.incr(key, function(err, current, resetTime) {
+    options.store.incr(key, function (err, current, resetTime) {
       if (err) {
         return next(err);
       }
@@ -64,16 +65,15 @@ function RateLimit(options) {
         typeof options.max === "function" ? options.max(req, res) : options.max;
 
       Promise.resolve(maxResult)
-        .catch(next)
-        .then(max => {
+        .then((max) => {
           req.rateLimit = {
             limit: max,
             current: current,
             remaining: Math.max(max - current, 0),
-            resetTime: resetTime
+            resetTime: resetTime,
           };
 
-          if (options.headers) {
+          if (options.headers && !res.headersSent) {
             res.setHeader("X-RateLimit-Limit", max);
             res.setHeader("X-RateLimit-Remaining", req.rateLimit.remaining);
             if (resetTime instanceof Date) {
@@ -85,6 +85,16 @@ function RateLimit(options) {
               );
             }
           }
+          if (options.draft_polli_ratelimit_headers && !res.headersSent) {
+            res.setHeader("RateLimit-Limit", max);
+            res.setHeader("RateLimit-Remaining", req.rateLimit.remaining);
+            if (resetTime) {
+              const deltaSeconds = Math.ceil(
+                (resetTime.getTime() - Date.now()) / 1000
+              );
+              res.setHeader("RateLimit-Reset", Math.max(0, deltaSeconds));
+            }
+          }
 
           if (options.skipFailedRequests || options.skipSuccessfulRequests) {
             let decremented = false;
@@ -96,7 +106,7 @@ function RateLimit(options) {
             };
 
             if (options.skipFailedRequests) {
-              res.on("finish", function() {
+              res.on("finish", function () {
                 if (res.statusCode >= 400) {
                   decrementKey();
                 }
@@ -112,7 +122,7 @@ function RateLimit(options) {
             }
 
             if (options.skipSuccessfulRequests) {
-              res.on("finish", function() {
+              res.on("finish", function () {
                 if (res.statusCode < 400) {
                   options.store.decrement(key);
                 }
@@ -125,14 +135,15 @@ function RateLimit(options) {
           }
 
           if (max && current > max) {
-            if (options.headers) {
+            if (options.headers && !res.headersSent) {
               res.setHeader("Retry-After", Math.ceil(options.windowMs / 1000));
             }
             return options.handler(req, res, next);
           }
 
           next();
-        });
+        })
+        .catch(next);
     });
   }
 

package/lib/memory-store.js

@@ -10,7 +10,7 @@ function MemoryStore(windowMs) {
   let hits = {};
   let resetTime = calculateNextResetTime(windowMs);
 
-  this.incr = function(key, cb) {
+  this.incr = function (key, cb) {
     if (hits[key]) {
       hits[key]++;
     } else {
@@ -20,22 +20,21 @@ function MemoryStore(windowMs) {
     cb(null, hits[key], resetTime);
   };
 
-  this.decrement = function(key) {
+  this.decrement = function (key) {
     if (hits[key]) {
       hits[key]--;
     }
   };
 
   // export an API to allow hits all IPs to be reset
-  this.resetAll = function() {
+  this.resetAll = function () {
     hits = {};
     resetTime = calculateNextResetTime(windowMs);
   };
 
   // export an API to allow hits from one IP to be reset
-  this.resetKey = function(key) {
+  this.resetKey = function (key) {
     delete hits[key];
-    delete resetTime[key];
   };
 
   // simply reset ALL hits every windowMs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-rate-limit",
-  "version": "4.0.3",
+  "version": "5.1.3",
   "description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
   "homepage": "https://github.com/nfriedly/express-rate-limit",
   "author": {
@@ -10,10 +10,8 @@
   "repository": "nfriedly/express-rate-limit",
   "license": "MIT",
   "main": "lib/express-rate-limit.js",
-  "types": "index.d.ts",
   "files": [
-    "lib/",
-    "index.d.ts"
+    "lib/"
   ],
   "keywords": [
     "express-rate-limit",
@@ -35,18 +33,20 @@
   ],
   "dependencies": {},
   "devDependencies": {
-    "eslint": "^5.15.3",
-    "eslint-config-prettier": "^4.2.0",
-    "eslint-plugin-prettier": "^3.0.1",
-    "express": "^4.16.3",
-    "husky": "^2.2.0",
-    "mocha": "^6.1.4",
-    "prettier": "^1.17.0",
-    "pretty-quick": "^1.6.0",
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.10.1",
+    "eslint-plugin-prettier": "^3.1.2",
+    "express": "^4.17.1",
+    "husky": "^4.2.3",
+    "mocha": "^7.1.1",
+    "prettier": "^2.0.4",
+    "pretty-quick": "^2.0.1",
     "supertest": "^4.0.2"
   },
   "scripts": {
-    "test": "eslint . && mocha",
+    "lint": "eslint .",
+    "autofix": "npm run lint -- --fix",
+    "test": "npm run lint && mocha",
     "precommit": "pretty-quick --staged"
   }
 }

package/index.d.ts

@@ -1,39 +0,0 @@
-import {RequestHandler, Request, Response, NextFunction} from 'express';
-
-export interface Options {
-  max?: number;
-  message?: any;
-  headers?: boolean;
-  windowMs?: number;
-  store?: Store | any;
-  statusCode?: number;
-  skipFailedRequests?: boolean;
-  skipSuccessfulRequests?: boolean;
-
-  skip?(req?: Request, res?: Response): boolean;
-
-  onLimitReached?(req?: Request, res?: Response): void;
-
-  handler?(req: Request, res: Response, next?: NextFunction): void;
-
-  keyGenerator?(req: Request, res?: Response): string | Request['ip'];
-}
-
-export interface Store {
-  hits: {
-    [key: string]: number;
-  };
-
-  resetAll(): void;
-
-  resetTime: number;
-  setInterval: NodeJS.Timeout;
-
-  resetKey(key: string | any): void;
-
-  decrement(key: string | any): void;
-
-  incr(key: string | any, cb: (err?: Error, hits?: number) => void): void;
-}
-
-export declare function RateLimit(options?: Options): (req: Request, res: Response, next: NextFunction) => void;