express-rate-limit 5.2.6 → 5.3.0

package/README.md

@@ -1,6 +1,6 @@
 # Express Rate Limit
 
-![Node.js CI](https://github.com/nfriedly/express-rate-limit/workflows/Node.js%20CI/badge.svg)
+[![Node.js CI](https://github.com/nfriedly/express-rate-limit/workflows/Node.js%20CI/badge.svg)](https://github.com/nfriedly/express-rate-limit/actions)
 [![NPM version](https://img.shields.io/npm/v/express-rate-limit.svg)](https://npmjs.org/package/express-rate-limit "View this project on NPM")
 [![npm downloads](https://img.shields.io/npm/dm/express-rate-limit)](https://www.npmjs.com/package/express-rate-limit)
 
@@ -186,6 +186,19 @@ function (req, res, options) {
 }
 ```
 
+### requestWasSuccessful
+
+Function that is called when `skipFailedRequests` and/or `skipSuccessfulRequests` are set to `true`.
+May be overridden if, for example, a service sends out a 200 status code on errors.
+
+Defaults to
+
+```js
+function (req, res) {
+    return res.statusCode < 400;
+}
+```
+
 ### skipFailedRequests
 
 When set to `true`, failed requests won't be counted. Request considered failed when:

package/lib/express-rate-limit.js

@@ -10,8 +10,12 @@ function RateLimit(options) {
       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)
+      // ability to manually decide if request was successful. Used when `skipSuccessfulRequests` and/or `skipFailedRequests` are set to `true`
+      requestWasSuccessful: function (req, res) {
+        return res.statusCode < 400;
+      },
+      skipFailedRequests: false, // Do not count failed requests
+      skipSuccessfulRequests: false, // Do not count successful requests
       // allows to create custom keys (by default user IP is used)
       keyGenerator: function (req /*, res*/) {
         return req.ip;
@@ -114,7 +118,7 @@ function RateLimit(options) {
 
                 if (options.skipFailedRequests) {
                   res.on("finish", function () {
-                    if (res.statusCode >= 400) {
+                    if (!options.requestWasSuccessful(req, res)) {
                       decrementKey();
                     }
                   });
@@ -130,7 +134,7 @@ function RateLimit(options) {
 
                 if (options.skipSuccessfulRequests) {
                   res.on("finish", function () {
-                    if (res.statusCode < 400) {
+                    if (options.requestWasSuccessful(req, res)) {
                       options.store.decrement(key);
                     }
                   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-rate-limit",
-  "version": "5.2.6",
+  "version": "5.3.0",
   "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": {
@@ -41,6 +41,7 @@
     "mocha": "^8.2.1",
     "prettier": "^2.2.1",
     "pretty-quick": "^3.1.0",
+    "sinon": "^9.2.4",
     "supertest": "^6.1.3"
   },
   "scripts": {