node-redis: ConnectionTimeoutError: Connection timeout

Hello,

We had this issue on our project. The root cause is that we try to .connect(), and then require many node modules blocking the node loop with sync calls. The socket is blocked and the timeout is thrown. I suggest you to profile your applications to find if it’s the same kind of error.

The fix here is to increase the timout of the socket as follow:

const redisCluster = createCluster({
  rootNodes: [
    {
      url: '', // your host and port here
    },
  ],
  defaults: {
    socket: {
      connectTimeout: 50000,
    },
  },
});

Has anyone here tried using the pingInterval option?

createClient({
  url: "redis://localhost:6379",
  pingInterval: 1000,
})

I am using node-redis (via redis-om) with Deno+Fresh, and a clean Redis Stack container running in a local Docker. Here’s what I did, it seems to have solved the issue for now. Hope this helps someone.

import { Client } from "npm:redis-om"
import { createClient } from "npm:redis"

const nodeClient = createClient({
  url: "redis://localhost:6379",
  pingInterval: 1000,
})
await nodeClient.connect()
const omClient = new Client()
const redis = await omClient.use(nodeClient)

export { redis }

@leibale for me after several hours of debugging, it worked after I connect with the IP directly and increase the timeout to 50000 this is node-redis v4.6.1

RedisClient = createClient({
  url: `redis://${process.env.REDIS_CLIENT_HOST}:${process.env.REDIS_CLIENT_PORT}`,
  username: process.env.REDIS_USERNAME,
  password: process.env.REDIS_PASSWORD,
  socket: {
    connectTimeout: 50000,
  },
});

Unfortunately i couldn’t resolve this issue I ended up using “ioredis” package instead!!

@eladitzhakian

docker run -it -p 6379:6379 redis:4-alpine

import { createClient } from 'redis';

const client = createClient({ url: 'redis://localhost:6379' });

await client.connect();
await client.ping();
await client.disconnect();

works for me (the classic answer 😛)… wanna debug it together?

@menocomp great suggestion!

However, to my knowledge, I am not using a cluster and I therefore don’t think the solution applies to me 😦

I have also stumbled on to this only when using Jest (29) I have solved this in my unit tests by NOT mocking certain things

    jest.useFakeTimers({
      doNotFake: ['nextTick', 'performance', 'queueMicrotask']
    })

I feel like this is either a bug or rather a documentation issue.

For me as I want to migrate from v3 to v4 - I did get the timeout error as well, when I tried to use the official documentation like this:

  const clientTimeout = redis.createClient({
    password: '*****',
    socket: {
        port: 6379,
        host: '127.0.0.1',
        tls: true
    }
  });

But when I use the following code (with non-documented properties), the client does connect.

  const clientWORKING = redis.createClient({
    host: '127.0.0.1',
    port: 6379,
    password: '*****',
    tls : true
  });

So I would argue, that the documentation is not listing tls, host and port as root properties correctly.

The above code was run in a node test project using redis version 4.6.7

So its a Jest problem. Specifically with the fake timers in any version > 27.

jest.useFakeTimers({ legacyFakeTimers: true });

Have to use “legacy” now or everything locks up.

Adding pingInterval fixed read ETIMEDOUT error. Thanks

@kabapy in order to catch this error you gave to handle error events. This is not specific to this package, this is how node.js event emitter works. Just make sure to add client.on('error', err => ...);

Before calling client.connect and the app won’t crash on timeout.

BTW, there is already an issue + PR to add a note to the docs (https://github.com/redis/node-redis/issues/2302).

Got the may Be,

According to me this is issue because of race condition of async tasks. So to overcome that we can just go with await or we can connect to socket or server after

 redisClient.connect().then(() => {
 // other tasks
})

May be this solves issues then I am glad.

Running the command node --inspect dist/app.js with no issues indicates to me that there is a typescript compiler issue (perhaps from ts-node) going on in my case, moreso than it being an actual issue with redis.

@aarhusgregersen All requires are sync. You can profile your application using chrome about:inspect and nodejs --inspect-brk option