redis-traffic-limiter 1.0.0

package/README.md

@@ -0,0 +1,115 @@
+# Redis Rate Limiter
+
+A lightweight Redis-based rate limiter for Node.js using Redis.
+
+Currently supported algorithms:
+
+- ✅ Fixed Window
+- ✅ Sliding Window
+
+---
+
+## Prerequisites
+
+Before using this package, make sure you have:
+
+- Node.js
+- Redis Server
+
+---
+
+## Install Redis
+
+### Ubuntu
+
+```bash
+sudo apt update
+sudo apt install redis-server
+```
+
+Start Redis
+
+```bash
+redis-server
+```
+
+### Windows
+
+Run Redis using Docker:
+
+```bash
+docker run -d \
+  --name redis \
+  -p 6379:6379 \
+  redis
+```
+
+---
+
+## Installation
+
+Install the package along with the official Redis client.
+
+```bash
+ npm install redis-traffic-limiter redis
+```
+
+---
+
+## Create a Redis Client
+
+```js
+import { createClient } from "redis";
+
+const redis = createClient({
+    url: "redis://localhost:6379"
+});
+
+await redis.connect();
+```
+
+Pass the connected Redis client while creating the limiter.
+
+---
+
+## Usage
+
+Example programs are available in the `examples/` directory.
+
+- `examples/fixed.js`
+- `examples/sliding.js`
+
+Run them using:
+
+```bash
+node examples/fixed.js
+```
+
+or
+
+```bash
+node examples/sliding.js
+```
+
+---
+
+## Supported Algorithms
+
+- Fixed Window
+- Sliding Window
+
+---
+
+## Notes
+
+- The package expects a **connected node-redis client**.
+- Redis connections are managed by your application.
+- `window` is specified in **milliseconds**.
+- Currently supports the official **node-redis** client only.
+- Support for additional Redis clients (e.g. ioredis) is planned for future releases.
+
+---
+
+## License
+
+MIT

package/example/FixedWindow.js

@@ -0,0 +1,27 @@
+import { createClient } from "redis";
+import { FixedWindow } from "../src/index.js";
+
+// Create a Redis client.
+// By default Redis runs on localhost:6379.
+const redis = createClient({
+    url: "redis://localhost:6379"
+});
+
+// Connect to Redis before using it.
+await redis.connect();
+
+// Create a Fixed Window limiter.
+// window is in milliseconds.
+const limiter = new FixedWindow({
+    redis,
+    window: 60000,
+    max: 5
+});
+
+// Consume one request for this user.
+const result = await limiter.consume("user:1");
+
+console.log(result);
+
+// Close the Redis connection.
+await redis.quit();

package/example/SlidingWindow.js

@@ -0,0 +1,25 @@
+import { createClient } from "redis";
+import { SlidingWindow } from "../src/index.js";
+
+// Create a Redis client.
+const redis = createClient({
+    url: "redis://localhost:6379"
+});
+
+// Connect to Redis.
+await redis.connect();
+
+// Create a Sliding Window limiter.
+const limiter = new SlidingWindow({
+    redis,
+    window: 60000,
+    max: 5
+});
+
+// Consume one request.
+const result = await limiter.consume("user:1");
+
+console.log(result);
+
+// Close Redis connection.
+await redis.quit();

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "redis-traffic-limiter",
+  "version": "1.0.0",
+  "description": "A lightweight Redis-based rate limiter for Node.js supporting Fixed Window and Sliding Window algorithms.",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "keywords": [
+    "redis",
+    "rate-limiter",
+    "traffic",
+    "limiter",
+    "nodejs",
+    "backend",
+    "fixed-window",
+    "sliding-window"
+  ],
+  "author": "Bhuvan",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "redis": "^6.1.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,2 @@
+export { default as FixedWindow } from "./limiter/FixedWindow.js";
+export { default as SlidingWindow } from "./limiter/SlidingWindow.js";

package/src/limiter/FixedWindow.js

@@ -0,0 +1,32 @@
+class FixedWindow {
+
+    constructor({ redis, window, max }) {
+        this.redis = redis;
+        this.window = window;
+        this.max = max;
+    }
+
+    async consume(key) {
+
+        const count = await this.redis.incr(key);
+
+        if (count === 1) {
+            await this.redis.expire(key, this.window);
+        }
+
+        if (count <= this.max) {
+            return {
+                allowed: true,
+                remaining: this.max - count
+            };
+        }
+
+        return {
+            allowed: false,
+            remaining: 0
+        };
+    }
+
+}
+
+export default FixedWindow;

package/src/limiter/SlidingWindow.js

@@ -0,0 +1,54 @@
+class SlidingWindow {
+
+    constructor({ redis, window, max }) {
+        this.redis = redis;
+        this.window = window; 
+        this.max = max;
+    }
+
+    async consume(key) {
+
+        const now = Date.now();
+
+        
+        await this.redis.zRemRangeByScore(
+            key,
+            0,
+            now - this.window
+        );
+
+        
+        const count = await this.redis.zCard(key);
+
+        
+        if (count >= this.max) {
+
+            return {
+                allowed: false,
+                remaining: 0
+            };
+
+        }
+
+       
+        await this.redis.zAdd(key, {
+            score: now,
+            value: `${now}-${Math.random()}`
+        });
+
+        
+        await this.redis.expire(
+            key,
+            Math.ceil(this.window / 1000)
+        );
+
+        return {
+            allowed: true,
+            remaining: this.max - count - 1
+        };
+
+    }
+
+}
+
+export default SlidingWindow;