feat: node-redis

index.js

@@ -5,6 +5,7 @@ const { parse, format } = require('@lukeed/ms')
 
 const LocalStore = require('./store/LocalStore')
 const RedisStore = require('./store/RedisStore')
+const NodeRedisStore = require('./store/NodeRedisStore')
 
 const defaultMax = 1000
 const defaultTimeWindow = 60000
@@ -117,7 +118,11 @@ async function fastifyRateLimit (fastify, settings) {
     pluginComponent.store = new Store(globalParams)
   } else {
     if (settings.redis) {
-      pluginComponent.store = new RedisStore(globalParams.continueExceeding, globalParams.exponentialBackoff, settings.redis, settings.nameSpace)
+      if (settings.redis.constructor.name === 'Commander') {
+        pluginComponent.store = new NodeRedisStore(globalParams.continueExceeding, globalParams.exponentialBackoff, settings.redis, settings.nameSpace)
+      } else {
+        pluginComponent.store = new RedisStore(globalParams.continueExceeding, globalParams.exponentialBackoff, settings.redis, settings.nameSpace)
+      }
     } else {
       pluginComponent.store = new LocalStore(globalParams.continueExceeding, globalParams.exponentialBackoff, settings.cache)
     }
@@ -290,3 +295,4 @@ module.exports = fp(fastifyRateLimit, {
 })
 module.exports.default = fastifyRateLimit
 module.exports.fastifyRateLimit = fastifyRateLimit
+module.exports.NodeRedisStore = NodeRedisStore

package.json

@@ -60,6 +60,7 @@
   ],
   "devDependencies": {
     "@fastify/pre-commit": "^2.1.0",
+    "@redis/client": "^1.6.0",
     "@sinonjs/fake-timers": "^14.0.0",
     "@types/node": "^22.0.0",
     "c8": "^10.1.2",

store/NodeRedisStore.js

@@ -0,0 +1,59 @@
+'use strict'
+
+/**
+ * When using node-redis, you need to initialize the client with the rateLimit script like this:
+ * ```js
+ * const redis = createClient({
+ *   scripts: {
+ *     rateLimit: rateLimit.NodeRedisStore.rateLimitScript
+ *   }
+ * });
+ * ```
+ */
+
+const { lua } = require('./RedisStore')
+const { defineScript } = require('@redis/client')
+
+const rateLimitScript = defineScript({
+  NUMBER_OF_KEYS: 1,
+  SCRIPT: lua,
+  transformArguments (key, timeWindow, max, continueExceeding, exponentialBackoff) {
+    return [key, String(timeWindow), String(max), String(continueExceeding), String(exponentialBackoff)]
+  },
+  transformReply (reply) {
+    return reply
+  },
+})
+
+function NodeRedisStore (continueExceeding, exponentialBackoff, redis, key = 'fastify-rate-limit-') {
+  this.continueExceeding = continueExceeding
+  this.exponentialBackoff = exponentialBackoff
+  this.redis = redis
+  this.key = key
+
+  if (!this.redis.rateLimit) {
+    throw new Error(
+      'rateLimit script missing on Redis instance. Add it when creating client: ' +
+      'const redis = createClient({ scripts: { rateLimit: rateLimit.NodeRedisStore.rateLimitScript }})'
+    )
+  }
+}
+
+NodeRedisStore.prototype.incr = function (ip, cb, timeWindow, max) {
+  this
+    .redis
+    .rateLimit(this.key + ip, timeWindow, max, this.continueExceeding, this.exponentialBackoff)
+    .then(result => {
+      cb(null, { current: result[0], ttl: result[1] })
+    })
+    .catch(err => {
+      cb(err, null)
+    })
+}
+
+NodeRedisStore.prototype.child = function (routeOptions) {
+  return new NodeRedisStore(routeOptions.continueExceeding, routeOptions.exponentialBackoff, this.redis, `${this.key}${routeOptions.routeInfo.method}${routeOptions.routeInfo.url}-`)
+}
+
+module.exports = NodeRedisStore
+module.exports.rateLimitScript = rateLimitScript

store/RedisStore.js

@@ -62,3 +62,4 @@ RedisStore.prototype.child = function (routeOptions) {
 }
 
 module.exports = RedisStore
+module.exports.lua = lua