express-rate-limit 7.0.1 → 7.1.0

package/changelog.md

@@ -6,6 +6,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.1.0](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.1.0)
+
+### Changed
+
+- The `getKey` method is now always defined. If the store does not have the
+  required `get` method, `getKey` will throw an error explaining this.
+
+## [7.0.2](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.0.2)
+
+### Added
+
+- Added `cluster-memory-store` to the readme and made a couple of other minor
+  clarifications.
+
 ## [7.0.1](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.0.1)
 
 ### Added
@@ -362,6 +376,7 @@ Note: 6.5.0 was not released due to CI automation issues.
 
 ### Added
 
+- Support external stores (from version 2.3.0) onwards.
 - A `limiter.resetKey()` method to reset the hit counter for a particular client
 
 ### Changes

package/dist/index.cjs

@@ -506,10 +506,6 @@ var promisifyStore = (passedStore) => {
   }
   const legacyStore = passedStore;
   class PromisifiedStore {
-    /* istanbul ignore next */
-    async get(key) {
-      return void 0;
-    }
     async increment(key) {
       return new Promise((resolve, reject) => {
         legacyStore.incr(
@@ -699,10 +695,11 @@ var rateLimit = (passedOptions) => {
       next();
     }
   );
+  const getThrowFn = () => {
+    throw new Error("The current store does not support the get/getKey method");
+  };
   middleware.resetKey = config.store.resetKey.bind(config.store);
-  middleware.getKey = config.store.get?.bind(
-    config.store
-  );
+  middleware.getKey = typeof config.store.get === "function" ? config.store.get.bind(config.store) : getThrowFn;
   return middleware;
 };
 var lib_default = rateLimit;

package/dist/index.d.cts

@@ -165,7 +165,7 @@ export type RateLimitRequestHandler = RequestHandler & {
 	 *
 	 * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
 	 */
-	getKey?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+	getKey: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
 };
 /**
  * An interface that all hit counter stores must implement.

package/dist/index.d.mts

@@ -165,7 +165,7 @@ export type RateLimitRequestHandler = RequestHandler & {
 	 *
 	 * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
 	 */
-	getKey?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+	getKey: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
 };
 /**
  * An interface that all hit counter stores must implement.

package/dist/index.d.ts

@@ -165,7 +165,7 @@ export type RateLimitRequestHandler = RequestHandler & {
 	 *
 	 * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
 	 */
-	getKey?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+	getKey: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
 };
 /**
  * An interface that all hit counter stores must implement.

package/dist/index.mjs

@@ -478,10 +478,6 @@ var promisifyStore = (passedStore) => {
   }
   const legacyStore = passedStore;
   class PromisifiedStore {
-    /* istanbul ignore next */
-    async get(key) {
-      return void 0;
-    }
     async increment(key) {
       return new Promise((resolve, reject) => {
         legacyStore.incr(
@@ -671,10 +667,11 @@ var rateLimit = (passedOptions) => {
       next();
     }
   );
+  const getThrowFn = () => {
+    throw new Error("The current store does not support the get/getKey method");
+  };
   middleware.resetKey = config.store.resetKey.bind(config.store);
-  middleware.getKey = config.store.get?.bind(
-    config.store
-  );
+  middleware.getKey = typeof config.store.get === "function" ? config.store.get.bind(config.store) : getThrowFn;
   return middleware;
 };
 var lib_default = rateLimit;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "7.0.1",
+	"version": "7.1.0",
 	"description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
 	"author": {
 		"name": "Nathan Friedly",
@@ -83,7 +83,6 @@
 		"@types/jest": "29.5.4",
 		"@types/node": "20.5.9",
 		"@types/supertest": "2.0.12",
-		"cross-env": "7.0.3",
 		"del-cli": "5.1.0",
 		"dts-bundle-generator": "8.0.1",
 		"esbuild": "0.19.2",

package/readme.md

@@ -34,14 +34,18 @@ The default `MemoryStore` is probably fine.
 
 ### API Rate Limit Enforcement
 
-You may want to switch to a different [store](#store), especially if you have
-multiple servers or processes (for example, with the
-[node:cluster](https://nodejs.org/api/cluster.html) module). Using an external
-data store to syhcnronize hits
-([redis](https://npmjs.com/package/rate-limit-redis),
-[memcached](https://npmjs.org/package/rate-limit-memcached), [etc.](#store))
-guarentees the expected result even if some requests get handled by different
-servers/processes or a server is restarted.
+The default `MemoryStore` stores the hit counts for clients in memory, and is
+thus unsuitable for use when running multiple servers or processes.
+
+If you have multiple processes on a single server (via the
+[node:cluster](https://nodejs.org/api/cluster.html) module), the
+[`cluster-memory-store`](https://npmjs.com/package/@express-rate-limit/cluster-memory-store)
+will keep them all in sync without needing an external data store.
+
+If you have multiple servers, or want to maintain state across app restarts, use
+an external data store such as
+[redis](https://npmjs.com/package/rate-limit-redis),
+[memcached](https://npmjs.org/package/rate-limit-memcached), [etc.](#store).
 
 ### Alternate Rate Limiters
 
@@ -513,14 +517,15 @@ By default, the [`memory-store`](source/memory-store.ts) is used.
 
 Here is a list of external stores:
 
-| Name                                                                                   | Description                                                                                           | Legacy/Modern       |
-| -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------- |
-| [`memory-store`](source/memory-store.ts)                                               | _(default)_ Simple in-memory option. Does not share state when app has multiple processes or servers. | Modern as of v6.0.0 |
-| [`rate-limit-redis`](https://npmjs.com/package/rate-limit-redis)                       | A [Redis](http://redis.io/)-backed store, more suitable for large or demanding deployments.           | Modern as of v3.0.0 |
-| [`rate-limit-memcached`](https://npmjs.org/package/rate-limit-memcached)               | A [Memcached](https://memcached.org/)-backed store.                                                   | Legacy              |
-| [`rate-limit-mongo`](https://www.npmjs.com/package/rate-limit-mongo)                   | A [MongoDB](https://www.mongodb.com/)-backed store.                                                   | Legacy              |
-| [`precise-memory-rate-limit`](https://www.npmjs.com/package/precise-memory-rate-limit) | A memory store similar to the built-in one, except that it stores a distinct timestamp for each key.  | Modern as of v2.0.0 |
-| [`rate-limit-postgresql`](https://www.npmjs.com/package/@acpr/rate-limit-postgresql)   | A [PostgreSQL](https://www.postgresql.org/)-backed store.                                             | Modern as of v1.1.0 |
+| Name                                                                                         | Description                                                                                                                                   | Legacy/Modern       |
+| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
+| [`memory-store`](source/memory-store.ts)                                                     | _(default)_ Simple in-memory option. Does not share state when app has multiple processes or servers.                                         | Modern as of v6.0.0 |
+| [`cluster-memory-store`](https://npmjs.com/package/@express-rate-limit/cluster-memory-store) | A memory-store wrapper that shares state across all processes on a server via the [node:cluster](https://nodejs.org/api/cluster.html) module. | Modern              |
+| [`rate-limit-redis`](https://npmjs.com/package/rate-limit-redis)                             | A [Redis](http://redis.io/)-backed store, more suitable for large or demanding deployments.                                                   | Modern as of v3.0.0 |
+| [`rate-limit-memcached`](https://npmjs.org/package/rate-limit-memcached)                     | A [Memcached](https://memcached.org/)-backed store.                                                                                           | Modern as of v1.0.0 |
+| [`rate-limit-mongo`](https://www.npmjs.com/package/rate-limit-mongo)                         | A [MongoDB](https://www.mongodb.com/)-backed store.                                                                                           | Legacy              |
+| [`precise-memory-rate-limit`](https://www.npmjs.com/package/precise-memory-rate-limit)       | A memory store similar to the built-in one, except that it stores a distinct timestamp for each key.                                          | Modern as of v2.0.0 |
+| [`rate-limit-postgresql`](https://www.npmjs.com/package/@acpr/rate-limit-postgresql)         | A [PostgreSQL](https://www.postgresql.org/)-backed store.                                                                                     | Modern as of v1.1.0 |
 
 Take a look at
 [this guide](https://github.com/express-rate-limit/express-rate-limit/wiki/Creating-Your-Own-Store)
@@ -549,6 +554,10 @@ to complete a captcha to reset their rate limit, then call this function.
 
 Retrieves the hit count and reset time from the store for a given key.
 
+Note: `getKey` depends on store support. It works with the MemoryStore, but may
+not work with other stores. Calling it will throw an error if the store does not
+have a `get` method.
+
 ## Issues and Contributing
 
 If you encounter a bug or want to see something added/changed, please go ahead