|
| 1 | +import { expect } from 'chai'; |
| 2 | +import { Done } from 'mocha'; |
| 3 | +import Redis from '../../lib/Redis'; |
| 4 | + |
| 5 | +describe('Redis Connection Socket Timeout', () => { |
| 6 | + const SOCKET_TIMEOUT_MS = 500; |
| 7 | + |
| 8 | + it('maintains stable connection with password authentication | https://github.com/redis/ioredis/issues/1919 ', (done) => { |
| 9 | + const redis = createRedis({ password: 'password' }); |
| 10 | + assertNoTimeoutAfterConnection(redis, done); |
| 11 | + }); |
| 12 | + |
| 13 | + it('maintains stable connection without initial authentication | https://github.com/redis/ioredis/issues/1919', (done) => { |
| 14 | + const redis = createRedis(); |
| 15 | + assertNoTimeoutAfterConnection(redis, done); |
| 16 | + }); |
| 17 | + |
| 18 | + it('should throw when socket timeout threshold is exceeded', (done) => { |
| 19 | + const redis = createRedis() |
| 20 | + |
| 21 | + redis.on('error', (err) => { |
| 22 | + expect(err.message).to.eql(`Socket timeout. Expecting data, but didn't receive any in ${SOCKET_TIMEOUT_MS}ms.`); |
| 23 | + done(); |
| 24 | + }); |
| 25 | + |
| 26 | + redis.connect(() => { |
| 27 | + redis.stream.removeAllListeners('data'); |
| 28 | + redis.ping(); |
| 29 | + }); |
| 30 | + }); |
| 31 | + |
| 32 | + function createRedis(options = {}) { |
| 33 | + return new Redis({ |
| 34 | + socketTimeout: SOCKET_TIMEOUT_MS, |
| 35 | + lazyConnect: true, |
| 36 | + ...options |
| 37 | + }); |
| 38 | + } |
| 39 | + |
| 40 | + function assertNoTimeoutAfterConnection(redisInstance: Redis, done: Done) { |
| 41 | + let timeoutObj: NodeJS.Timeout; |
| 42 | + |
| 43 | + redisInstance.on('error', (err) => { |
| 44 | + clearTimeout(timeoutObj); |
| 45 | + done(err.toString()); |
| 46 | + }); |
| 47 | + |
| 48 | + redisInstance.connect(() => { |
| 49 | + timeoutObj = setTimeout(() => { |
| 50 | + done(); |
| 51 | + }, SOCKET_TIMEOUT_MS * 2); |
| 52 | + }); |
| 53 | + } |
| 54 | +}); |
0 commit comments