ioredis support

[directormac]

Just followed the read me and what was suggested by @MathurAditya724 .

and in reference to #10

Reproducible snippet

import Redis from 'ioredis';
import { env } from './env.util';
import { rateLimiter } from 'hono-rate-limiter';
import { generateId } from './crypto.util';

import { type Store } from 'hono-rate-limiter';
import { RedisStore } from 'rate-limit-redis';

const client = new Redis(env.REDIS_URL);

const limiter = rateLimiter({
	windowMs: 15 * 60 * 1000,
	limit: 100,
	// Change the header according to your proxy
	keyGenerator: (c) => c.req.header('X-Forwarded-for') + generateId(20),
	store: new RedisStore({
		sendCommand: (...args: string[]) => client.sendCommand(args)
	}) as unknown as Store // Adding the correct type
});

export { client, limiter };

Type error is

[MathurAditya724]

Hey @directormac, apologies that it took me some time to go through the issue, but upon close inspection, the problem isn't in hono-rate-limiter but in rate-limit-redis and ioredis types. To resolve it you can write sendCommand: (...args: string[]) => client.sendCommand(args) as Promise<RedisReply>, because out of the box ioredis returns unknown.

You can check the reference here -
redis-rate-limiter - https://github.com/express-rate-limit/rate-limit-redis/blob/main/source/types.ts#L14
ioredis - https://github.com/redis/ioredis/blob/main/lib/Redis.ts#L423

[directormac]

Hi @MathurAditya724

so here is the new snippet according to that

const limiter = rateLimiter({
	windowMs: 15 * 60 * 1000,
	limit: 100,
	keyGenerator: (c) => c.req.header("X-Forwarded-for") + generateId(20),
	store: new RedisStore({
		sendCommand: (...args) => client.sendCommand(args) as Promise<RedisReply>,
	}) as unknown as Store,
});

export { client, limiter };

Only wrong args being passed now would it be safe to assume that the args are commands? and just cast it like this

client.sendCommand(args as unknown as Command) as Promise<RedisReply>,

[MathurAditya724]

Yes, I also don't like these semi-typed functions, but this API is neither created nor maintained by me so can't change that. This usage is given here https://github.com/express-rate-limit/rate-limit-redis/tree/main?tab=readme-ov-file#examples, and honesty I went through the code base when I was building @hono-rate-limiter/redis package, it's safe you don't have to worry about it.

[directormac]

You should also put this in the examples incase someone needs it and close this issue.

[MathurAditya724]

Yes, I am thinking the same

[directormac]

Solution

const limiter = rateLimiter({
	windowMs: 15 * 60 * 1000,
	limit: 100,
	keyGenerator: (c) => c.req.header("X-Forwarded-for") + generateId(20),
	store: new RedisStore({
		sendCommand: (...args) => client.sendCommand(args as unknown as Command) as Promise<RedisReply>,
	}) as unknown as Store,
});

export { client, limiter };

[csulit]

Object literal may only specify known properties, and 'sendCommand' does not exist in type 'Options'.ts(2353)

something change?

[real2two]

Object literal may only specify known properties, and 'sendCommand' does not exist in type 'Options'.ts(2353)

something change?

+1 The solution above doesn't work for me either. (Object literal may only specify known properties, and 'sendCommand' does not exist in type 'Options'. ts(2353))

EDIT: I realized I was looking at the wrong library (@hono-rate-limiter/redis) when I was supposed to use rate-limit-redis instead.

import { rateLimiter, type Store } from "hono-rate-limiter";
import { RedisStore, type RedisReply } from "rate-limit-redis";

const store = new RedisStore({
  sendCommand: (...args) => {
    return client.call(...args) as Promise<RedisReply>;
  },
}) as unknown as Store;

This still doesn't work as intended either though, because the rate limit seems to never expire (windowMs). I set the windowMs to 1 and I keep getting 429 (Too Many Requests) indefinetely.

[MathurAditya724]

I am not sure why you would be putting 1 as a value in windowMs, Try putting something like 1 * 60 * 1000 (1 minute). Cause based on your setup the IO might take some time to update the values.

[MathurAditya724]

Object literal may only specify known properties, and 'sendCommand' does not exist in type 'Options'.ts(2353)

something change?

Can you share a reproduction or your code?