fix: added connection error handling (#98)

* fix: added connection error handling

* doc: added connection error handling doc

* doc: fix README typos

Co-authored-by: Vincent LE GOFF <[email protected]>

* doc: fix README typos

Co-authored-by: Vincent LE GOFF <[email protected]>

* refactor: added error propagation from ioredis

- added tests for connection with password

* doc: removed error examples on error handling sections

* fix: added redis image tag on ci workflow

* rafactor: generalize error inside tests

* feat: added matrix on redis tags (test)

* refactor: add space after comma

Co-authored-by: KaKa <[email protected]>

Co-authored-by: Vincent LE GOFF <[email protected]>
Co-authored-by: KaKa <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -17,9 +17,10 @@ jobs:
     strategy:
       matrix:
         node-version: [10, 12, 14, 16]
+        redis-tag: [5, 6]
     services:
       redis:
-        image: redis
+        image: redis:${{ matrix.redis-tag }}
         ports:
         - 6379:6379
         options: --entrypoint redis-server

README.md

@@ -186,6 +186,10 @@ fastify.listen(3000, function (err) {
 ```
 *NB you can find more information about Redis streams and the relevant commands [here](https://redis.io/topics/streams-intro) and [here](https://redis.io/commands#stream).*
 
+## Redis connection error
+Majority of errors are silent due to the `ioredis` silent error handling but during the plugin registration it will check that the connection with the redis instance is correctly estabilished.
+In this case you can receive an `ERR_AVVIO_PLUGIN_TIMEOUT` error if the connection can't be estabilished in the expected time frame or a dedicated error for an invalid connection.
+
 ## Acknowledgements
 
 This project is kindly sponsored by:

index.js

@@ -64,7 +64,13 @@ function fastifyRedis (fastify, options, next) {
     }
   }
 
-  next()
+  if (!redisOptions.lazyConnect) {
+    return client.info((err, _) => {
+      return err ? next(err) : next()
+    })
+  } else {
+    next()
+  }
 }
 
 function close (fastify, done) {

test/test.js

@@ -6,6 +6,35 @@ const test = t.test
 const Fastify = require('fastify')
 const fastifyRedis = require('..')
 
+const TEST_PASSWORD = 'my_secret_password'
+
+const setRedisPassword = async (password) => {
+  const fastify = Fastify()
+
+  fastify.register(fastifyRedis, {
+    host: '127.0.0.1'
+  })
+
+  await fastify.ready()
+  await fastify.redis.flushall()
+  await fastify.redis.config(['set', 'requirepass', password])
+  await fastify.close()
+}
+
+const unsetRedisPassword = async (currentPassword) => {
+  const fastify = Fastify()
+
+  fastify.register(fastifyRedis, {
+    host: '127.0.0.1',
+    password: currentPassword
+  })
+
+  await fastify.ready()
+  await fastify.redis.flushall()
+  await fastify.redis.config(['set', 'requirepass', ''])
+  await fastify.close()
+}
+
 t.beforeEach(async () => {
   const fastify = Fastify()
 
@@ -44,6 +73,7 @@ test('fastify.redis should support url', (t) => {
         otherOption: 'foo'
       })
       this.quit = () => {}
+      this.info = cb => cb(null, 'info')
       return this
     }
   })
@@ -345,3 +375,80 @@ test('Should not throw within different contexts', (t) => {
     t.error(error)
   })
 })
+
+test('Should throw when trying to connect on an invalid host', (t) => {
+  t.plan(2)
+
+  const fastify = Fastify({ pluginTimeout: 20000 })
+  t.teardown(() => fastify.close())
+
+  fastify
+    .register(fastifyRedis, {
+      host: 'invalid_host'
+    })
+
+  fastify.ready((err) => {
+    t.type(err, 'MaxRetriesPerRequestError')
+    t.equal(err.message, 'Reached the max retries per request limit (which is 20). Refer to "maxRetriesPerRequest" option for details.')
+  })
+})
+
+test('Should not throw when trying to connect on an invalid host but the lazyConnect option has been provided', (t) => {
+  t.plan(1)
+
+  const fastify = Fastify()
+  t.teardown(() => fastify.close())
+
+  fastify
+    .register(fastifyRedis, {
+      host: 'invalid_host',
+      lazyConnect: true
+    })
+
+  fastify.ready((err) => {
+    t.error(err)
+  })
+})
+
+test('Should throw authentication error when trying to connect on a valid host with a wrong password', (t) => {
+  t.plan(1)
+
+  const fastify = Fastify()
+  t.teardown(async () => {
+    fastify.close()
+    await unsetRedisPassword(TEST_PASSWORD)
+  })
+
+  setRedisPassword(TEST_PASSWORD)
+    .then(_ => {
+      fastify.register(fastifyRedis, {
+        host: '127.0.0.1',
+        password: 'my_wrong_secret_password'
+      })
+
+      fastify.ready(err => {
+        t.ok(err)
+      })
+    })
+})
+
+test('Should throw authentication error when trying to connect on a valid host without a password', (t) => {
+  t.plan(1)
+
+  const fastify = Fastify()
+  t.teardown(async () => {
+    fastify.close()
+    await unsetRedisPassword(TEST_PASSWORD)
+  })
+
+  setRedisPassword(TEST_PASSWORD)
+    .then(_ => {
+      fastify.register(fastifyRedis, {
+        host: '127.0.0.1'
+      })
+
+      fastify.ready(err => {
+        t.ok(err)
+      })
+    })
+})