lint passes!

Author: nfriedly

example/server.js

@@ -38,7 +38,9 @@ if (cluster.isPrimary) {
 		}),
 	)
 
-	app.get('/', (request, res) => res.send(`hello from ${process.pid}`))
+	app.get('/', (request, response) =>
+		response.send(`hello from ${process.pid}`),
+	)
 
 	// Tip: run with PORT=0 to have the system automatically choose an avaliable port
 	const server = app.listen(process.env.PORT ?? 3000, () => {

package.json

@@ -74,7 +74,21 @@
     "express-rate-limit": ">= 6"
   },
   "xo": {
-    "prettier": true
+    "prettier": true,
+    "overrides": [
+      {
+        "files": "test/**/*.ts",
+        "rules": {
+          "@typescript-eslint/no-unsafe-argument": 0,
+          "@typescript-eslint/no-unsafe-assignment": 0,
+          "@typescript-eslint/no-unsafe-call": 0,
+          "@typescript-eslint/no-unsafe-return": 0,
+          "import/extensions": 0,
+          "unicorn/prevent-abbreviations": 0,
+          "no-promise-executor-return": 0
+        }
+      }
+    ]
   },
   "prettier": "@express-rate-limit/prettier",
   "lint-staged": {

source/primary.ts

@@ -3,7 +3,11 @@
 
 import cluster, { type Worker } from 'node:cluster'
 import { MemoryStore, type Store } from 'express-rate-limit'
-import { type WorkerToPrimaryMessage, from } from './shared'
+import {
+	type WorkerToPrimaryMessage,
+	from,
+	type PrimaryToWorkerMessage,
+} from './shared.js'
 // Import type { Options } from './types'
 
 export class ClusterMemoryStorePrimary {
@@ -43,14 +47,18 @@ export class ClusterMemoryStorePrimary {
 			}
 
 			if (command in store && typeof store[command] === 'function') {
-				const result = await (
-					store[command] as (this: Store, ...[]) => Promise<any>
-				).apply(store, args)
-				worker.send({
+				const result: unknown =
+					await // eslint-disable-next-line no-empty-pattern
+					(store[command] as (this: Store, ...[]) => Promise<any>).apply(
+						store,
+						args,
+					)
+				const message: PrimaryToWorkerMessage = {
 					requestId,
 					result,
 					from,
-				})
+				}
+				worker.send(message)
 			} else {
 				console.error(
 					new Error(

source/shared.ts

@@ -1,18 +1,25 @@
-import type { Store } from 'express-rate-limit'
+import type { IncrementResponse, Store } from 'express-rate-limit'
 
 export const from = 'cluster-memory-store'
 
 export type Command = keyof Omit<Store, 'prefix' | 'localKeys'>
 
-export type WorkerToPrimaryMessage = {
+type Message = {
+	from: 'cluster-memory-store'
+}
+
+export type WorkerToPrimaryMessage = Message & {
 	command: Command
 	args: any[]
 	requestId: number
 	prefix: string
-	from: 'cluster-memory-store'
 }
 
-export type PrimaryToWorkerMessage = {
+export type PrimaryToWorkerMessage = Message & {
 	requestId: number
-	result: any
+	result: unknown
+}
+
+export type SerializedIncrementResponse = IncrementResponse & {
+	resetTime: string
 }

source/worker.ts

@@ -14,7 +14,8 @@ import {
 	type PrimaryToWorkerMessage,
 	type WorkerToPrimaryMessage,
 	from,
-} from './shared'
+	type SerializedIncrementResponse,
+} from './shared.js'
 
 /**
  * A `Store` for the `express-rate-limit` package that communicates with the primary process to store and retrieve hits
@@ -30,6 +31,19 @@ export class ClusterMemoryStoreWorker implements Store {
 	 */
 	prefix!: string
 
+	/**
+	 * Map of requestId to the data & calllback needed to finish handling a request without throwingany errors
+	 */
+	private readonly openRequests = new Map<
+		number,
+		{ timeoutId: NodeJS.Timeout; resolve: (value: unknown) => void }
+	>()
+
+	/**
+	 * Counter to generate reqiestIds, which are used to tie the response to the matching openRequest
+	 */
+	private currentRequestId = 0
+
 	/**
 	 * @constructor for `ClusterMemoryStore`.
 	 *
@@ -77,7 +91,9 @@ export class ClusterMemoryStoreWorker implements Store {
 	 * @returns {IncrementResponse} - The number of hits and reset time for that client.
 	 */
 	async increment(key: string): Promise<IncrementResponse> {
-		const { totalHits, resetTime } = await this.send('increment', [key])
+		const { totalHits, resetTime } = (await this.send('increment', [
+			key,
+		])) as SerializedIncrementResponse
 		return {
 			totalHits,
 			resetTime: new Date(resetTime), // Date objects are serialized to strings for IPC
@@ -90,7 +106,7 @@ export class ClusterMemoryStoreWorker implements Store {
 	 * @param key {string} - The identifier for a client
 	 */
 	async decrement(key: string): Promise<void> {
-		return this.send('decrement', [key])
+		await this.send('decrement', [key])
 	}
 
 	/**
@@ -99,16 +115,9 @@ export class ClusterMemoryStoreWorker implements Store {
 	 * @param key {string} - The identifier for a client.
 	 */
 	async resetKey(key: string): Promise<void> {
-		return this.send('resetKey', [key])
+		await this.send('resetKey', [key])
 	}
 
-	private readonly openRequests = new Map<
-		number,
-		{ timeoutId: NodeJS.Timeout; resolve: (value: unknown) => void }
-	>()
-
-	private currentRequestId = 0
-
 	private async send(command: Command, args: any[]): Promise<any> {
 		return new Promise((resolve, reject) => {
 			const requestId = this.currentRequestId++
@@ -119,6 +128,7 @@ export class ClusterMemoryStoreWorker implements Store {
 						`ClusterMemoryStoreWorker: no response recieved to ${command} command after ${timelimit}ms.`,
 					),
 				)
+				this.openRequests.delete(requestId)
 			}, timelimit)
 			this.openRequests.set(requestId, { timeoutId, resolve })
 			if (!process.send) {
@@ -167,6 +177,7 @@ export class ClusterMemoryStoreWorker implements Store {
 				const { timeoutId, resolve } = this.openRequests.get(
 					message_.requestId,
 				)!
+				this.openRequests.delete(message_.requestId)
 				clearTimeout(timeoutId)
 				resolve(message_.result)
 			} else {

test/realtime-e2e-test.ts

@@ -12,52 +12,59 @@ import {
 } from '../source/index'
 
 async function getStatus(port: number) {
-	const resp = await fetch(`http://localhost:${port}`);
+	const resp = await fetch(`http://localhost:${port}`)
 	return resp.status
 }
 
-	if (cluster.isPrimary) {
-		const rateLimiterStore = new ClusterMemoryStorePrimary()
-		rateLimiterStore.init()
-	
-		// One worker
-		const worker = cluster.fork()
-	
-		// get the port the worker ends up listening on
-		const port:number = await new Promise((resolve) => cluster.on('listening', (worker: any, address:any) => resolve(address.port)))
-
-		// make a few requests
-		assert.equal(await getStatus(port), 200) // success
-		assert.equal(await getStatus(port), 429) // rate limited
-		await new Promise(resolve => setTimeout(resolve, 100)) // wait for the limit to be reset
-		assert.equal(await getStatus(port), 200) // success
-		
-		// cleanup 
-		worker.kill()
-
-		console.log('test completed successfully')
-
-	} else {
-		// Worker
-		const app = express()
-	
-		app.use(
-			rateLimit({
-				store: new ClusterMemoryStoreWorker(),
-				validate: false,
-				limit: 1,
-				windowMs: 100
-			}),
-		)
-	
-		app.get('/', (request, response) => response.send(`hello from ${process.pid}`))
-	
-		// port 0 lets the system assign an avaliable port
-		const server = app.listen(0 /*, () => {
+if (cluster.isPrimary) {
+	const rateLimiterStore = new ClusterMemoryStorePrimary()
+	rateLimiterStore.init()
+
+	// One worker
+	const worker = cluster.fork()
+
+	// Get the port the worker ends up listening on
+	const port: number = await new Promise((resolve) =>
+		cluster.on('listening', (worker: any, address: any) => {
+			resolve(address.port)
+		}),
+	)
+
+	// Make a few requests
+	assert.equal(await getStatus(port), 200) // Success
+	assert.equal(await getStatus(port), 429) // Rate limited
+	await new Promise((resolve) => setTimeout(resolve, 100)) // Wait for the limit to be reset
+	assert.equal(await getStatus(port), 200) // Success
+
+	// cleanup
+	worker.kill()
+
+	console.log('test completed successfully')
+} else {
+	// Worker
+	const app = express()
+
+	app.use(
+		rateLimit({
+			store: new ClusterMemoryStoreWorker(),
+			validate: false,
+			limit: 1,
+			windowMs: 100,
+		}),
+	)
+
+	app.get('/', (request, response) =>
+		response.send(`hello from ${process.pid}`),
+	)
+
+	// Port 0 lets the system assign an avaliable port
+	const server = app.listen(
+		0 /* , () => {
 			console.log(
 				`Worker ${process.pid} listening at on http://localhost:${
 					(server.address() as any).port
 				}/`,
 			)
-		}*/)
-	}
+		} */,
+	)
+}