'passIfNotConnected' option is not compatible with ioredis client

I love the idea of the passIfNotConnected option that was recently added in https://github.com/wyattjoh/rate-limit-redis/pull/29

However, it is based on the redis (“node-redis”) client implementation of the client.connected Boolean, which is not compatible with the ioredis client.

In ioredis, they seem to use the following complex set of checks for determining if the client is connected (e.g. source example):

if (
  this.status === "connecting" ||
  this.status === "connect" ||
  this.status === "ready"
) {
  reject(new Error("Redis is already connecting/connected"));
  return;
}

[luin]

Hi, I’m the author of ioredis (and contributor of node_redis) and happened to see this issue. Thank @JamesMGreene for pointing this out!

I think to better reflect the intent, we should check .ready instead of .connected as when .connected is true, the client may be not ready to send/receive commands.

The equivalent of .ready in ioredis is .status === 'ready'. So to support ioredis, the easiest change would be changing the following code in redis-store.js:

if (!options.client.connected && options.passIfNotConnected) {

To:

const clientConnected =
  options.client.status == 'ready' || // ioredis
  options.client.ready; // node_redis
if (!clientConnected && options.passIfNotConnected) {

I haven’t tried it myself but this may be a valid workaround to those using ioredis:

Looks good to me. To be more complete:

const Redis = require("ioredis");
const client = new Redis(/* ... options ... */);
client.connected = false;
client.ready = false;

client.on('connect', function () { client.connected = true; });
client.on('ready', function () { client.ready = true; });
client.on('close', function () {
  client.connected = false;
  client.ready = false;
});

[stale[bot]]

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.