Fix ERR_AVVIO_PLUGIN_TIMEOUT with 'ready' client (#116)

* Fix ERR_AVVIO_PLUGIN_TIMEOUT with 'ready' client

Adds two testcases with an existing custom client which is already
connected to redis and will not emit 'ready' events anymore. One with
'ioredis' and one with 'node-redis' as custom modules.

* Add comments to checking the connection-ready state

Author: michaelrommel

index.js

@@ -94,10 +94,19 @@ function fastifyRedis (fastify, options, next) {
       }
     }
 
-    client
-      .on('end', onEnd)
-      .on('error', onError)
-      .on('ready', onReady)
+    // node-redis provides the connection-ready  state in a .ready property,
+    // whereas ioredis provides it in a .status property
+    if (client.ready === true || client.status === 'ready') {
+      // client is already connected, do not register event handlers
+      // call next() directly to avoid ERR_AVVIO_PLUGIN_TIMEOUT
+      next()
+    } else {
+      // ready event can still be emitted
+      client
+        .on('end', onEnd)
+        .on('error', onError)
+        .on('ready', onReady)
+    }
 
     return
   }

test/test.js

@@ -215,6 +215,87 @@ test('custom client', (t) => {
   })
 })
 
+test('custom ioredis client that is already connected', (t) => {
+  t.plan(10)
+  const fastify = Fastify()
+  const Redis = require('ioredis')
+  const redis = new Redis({ host: 'localhost', port: 6379 })
+
+  // use the client now, so that it is connected and ready
+  redis.set('key', 'value', (err) => {
+    t.error(err)
+    redis.get('key', (err, val) => {
+      t.error(err)
+      t.equal(val, 'value')
+
+      fastify.register(fastifyRedis, {
+        client: redis,
+        lazyConnect: false
+      })
+
+      fastify.ready((err) => {
+        t.error(err)
+        t.equal(fastify.redis, redis)
+
+        fastify.redis.set('key2', 'value2', (err) => {
+          t.error(err)
+          fastify.redis.get('key2', (err, val) => {
+            t.error(err)
+            t.equal(val, 'value2')
+
+            fastify.close(function (err) {
+              t.error(err)
+              fastify.redis.quit(function (err) {
+                t.error(err)
+              })
+            })
+          })
+        })
+      })
+    })
+  })
+})
+
+test('custom redis client that is already connected', (t) => {
+  t.plan(10)
+  const fastify = Fastify()
+  const redis = require('redis').createClient({ host: 'localhost', port: 6379 })
+
+  // use the client now, so that it is connected and ready
+  redis.set('key', 'value', (err) => {
+    t.error(err)
+    redis.get('key', (err, val) => {
+      t.error(err)
+      t.equal(val, 'value')
+
+      fastify.register(fastifyRedis, {
+        client: redis,
+        lazyConnect: false
+      })
+
+      fastify.ready((err) => {
+        t.error(err)
+        t.equal(fastify.redis, redis)
+
+        fastify.redis.set('key2', 'value2', (err) => {
+          t.error(err)
+          fastify.redis.get('key2', (err, val) => {
+            t.error(err)
+            t.equal(val, 'value2')
+
+            fastify.close(function (err) {
+              t.error(err)
+              fastify.redis.quit(function (err) {
+                t.error(err)
+              })
+            })
+          })
+        })
+      })
+    })
+  })
+})
+
 test('custom client gets closed', (t) => {
   t.plan(7)
   const fastify = Fastify()