ioredis compatibility

[bkniffler]

Any chance we could get this ioredis compatible? Would like to use upstash via ioredis to remove http overhead, and ioredis is one of the recommended clients for upstash, but its not compatible with ratelimit-js.

[ogzhanolguncu]

Totally doable, but our main focus on serverless environments. Maybe we can let people use ioredis and/or redis for serverful environments. I'll discuss this with the team.

Edit:
For now you can do the following -> #60

[sourabpramanik]

@ogzhanolguncu If the team is moving forward with this integration, I would like to work on it.

[bkniffler]

@ogzhanolguncu the linked solution does not work, up stash rate limit depends on more functions by now.
hset, evalsha, scriptLoad, smismember, multi

using ioredis for these methods seems to not work either out of the box, think the adapter needs more effort to be made working. would love this to be part of ratelimit-js, then at least its clear when compatibility breaks.

[bkniffler]

Any chance this is going to land sometime?

[ogzhanolguncu]

Sorry to say that, but team don't wanna move forward with that approach for now. But, we can't say you guys can't come up with an adapter 😉 If you know what I mean. So feel free to @sourabpramanik or @bkniffler make your own adapters.

[sourabpramanik]

Gotcha @ogzhanolguncu

[ogzhanolguncu]

If you have a working solution make sure to put it here so other people can use it.

[LouisHaftmann]

I got it working with this but it has a lot of type assertions which is not ideal:

import { Ratelimit } from '@upstash/ratelimit'
import { Redis } from 'ioredis'

const redis = new Redis(`redis://localhost:6379`)
const limiter = new Ratelimit({
  redis: {
    sadd: async <TData>(key: string, ...members: TData[]) =>
      redis.sadd(key, ...members.map(String)),
    eval: async <TArgs extends unknown[], TData = unknown>(
      script: string,
      keys: string[],
      args: TArgs,
    ) => redis.eval(script, keys.length, ...keys, ...(args ?? []).map(String)) as Promise<TData>,
    scriptLoad: async (script: string) => redis.script('LOAD', script) as Promise<string>,
    smismember: async (key: string, members: unknown[]) =>
      redis.smismember(key, ...(members as string[])) as Promise<(0 | 1)[]>,
    evalsha: async <TData>(sha1: string, keys: string[], args: unknown[]) =>
      redis.evalsha(sha1, keys.length, ...keys, ...(args as string[])) as TData,
    hset: async <TData>(key: string, kv: Record<string, TData>) => redis.hset(key, kv),
  } as any,
  // ...
})

[yarabramasta]

I got it working with this but it has a lot of type assertions which is not ideal:

import { Ratelimit } from '@upstash/ratelimit'
import { Redis } from 'ioredis'

const redis = new Redis(`redis://localhost:6379`)
const limiter = new Ratelimit({
  redis: {
    sadd: async <TData>(key: string, ...members: TData[]) =>
      redis.sadd(key, ...members.map(String)),
    eval: async <TArgs extends unknown[], TData = unknown>(
      script: string,
      keys: string[],
      args: TArgs,
    ) => redis.eval(script, keys.length, ...keys, ...(args ?? []).map(String)) as Promise<TData>,
    scriptLoad: async (script: string) => redis.script('LOAD', script) as Promise<string>,
    smismember: async (key: string, members: unknown[]) =>
      redis.smismember(key, ...(members as string[])) as Promise<(0 | 1)[]>,
    evalsha: async <TData>(sha1: string, keys: string[], args: unknown[]) =>
      redis.evalsha(sha1, keys.length, ...keys, ...(args as string[])) as TData,
    hset: async <TData>(key: string, kv: Record<string, TData>) => redis.hset(key, kv),
  } as any,
  // ...
})

which version do you use?
im using "@upstash/ratelimit": "^2.0.5" and now demanding only get and set

type Redis = Pick<Redis$1, "get" | "set">;
type RegionRatelimitConfig = {
    /**
     * Instance of `@upstash/redis`
     * @see https://github.com/upstash/upstash-redis#quick-start
     */
    redis: Redis;
    ...
}

[LouisHaftmann]

I tried it with just get and set but it actually uses the functions from the old type. The type is just wrong.

[CahidArda]

For simple usage, the old type is sufficient.

But we added opt-in features later which required other methods too. Features such as traffic protection.