Updated Fastify to v4. Dropped redis module support (#147)

* Updated Fastify to v4. Dropped redis module support

Signed-off-by: Matteo Collina <[email protected]>

* drop old node

Signed-off-by: Matteo Collina <[email protected]>

* fix

* fixup

* simplify module and test 100%

Signed-off-by: Matteo Collina <[email protected]>

Author: mcollina

.github/workflows/ci.yml

@@ -14,13 +14,13 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 10
-          - 12
           - 14
           - 16
+          - 18
         redis-tag:
           - 5
           - 6
+          - 7
     services:
       redis:
         image: redis:${{ matrix.redis-tag }}

README.md

@@ -91,21 +91,15 @@ closed.
 'use strict'
 
 const fastify = require('fastify')()
-const redis = require('redis').createClient({ host: 'localhost', port: 6379 })
+const Redis = require('ioredis')
 
-fastify.register(require('@fastify/redis'), { client: redis })
+const client = new Redis({ host: 'localhost', port: 6379 })
+
+fastify.register(require('@fastify/redis'), { client })
 ```
 
 Note: by default, *@fastify/redis* will **not** automatically close the client
-connection when the Fastify server shuts down. To opt-in to this behavior,
-register the client like so:
-
-```js
-fastify.register(require('@fastify/redis'), {
-  client: redis,
-  closeClient: true
-})
-```
+connection when the Fastify server shuts down.
 
 ## Registering multiple Redis client instances
 
@@ -115,7 +109,6 @@ By using the `namespace` option you can register multiple Redis client instances
 'use strict'
 
 const fastify = require('fastify')()
-const redis = require('redis').createClient({ host: 'localhost', port: 6379 })
 
 fastify
   .register(require('@fastify/redis'), {

index.js

@@ -17,8 +17,8 @@ function fastifyRedis (fastify, options, next) {
       return next(new Error(`Redis '${namespace}' instance namespace has already been registered`))
     }
 
-    const closeNamedInstance = (fastify, done) => {
-      fastify.redis[namespace].quit(done)
+    const closeNamedInstance = (fastify) => {
+      return fastify.redis[namespace].quit()
     }
 
     if (!client) {
@@ -36,12 +36,9 @@ function fastifyRedis (fastify, options, next) {
     }
 
     fastify.redis[namespace] = client
-    if (options.closeClient === true) {
-      fastify.addHook('onClose', closeNamedInstance)
-    }
   } else {
     if (fastify.redis) {
-      return next(new Error('fastify-redis has already been registered'))
+      return next(new Error('@fastify/redis has already been registered'))
     } else {
       if (!client) {
         try {
@@ -58,67 +55,70 @@ function fastifyRedis (fastify, options, next) {
       }
 
       fastify.decorate('redis', client)
-      if (options.closeClient === true) {
-        fastify.addHook('onClose', close)
-      }
     }
   }
 
-  if (!redisOptions.lazyConnect) {
-    const onEnd = function (err) {
-      client
-        .off('ready', onReady)
-        .off('error', onError)
-        .off('end', onEnd)
-        .quit(() => next(err))
-    }
+  // Testing this make the process crash on latest TAP :(
+  /* istanbul ignore next */
+  const onEnd = function (err) {
+    client
+      .off('ready', onReady)
+      .off('error', onError)
+      .off('end', onEnd)
+      .quit()
 
-    const onReady = function () {
-      client
-        .off('end', onEnd)
-        .off('error', onError)
-        .off('ready', onReady)
+    next(err)
+  }
 
-      next()
-    }
+  const onReady = function () {
+    client
+      .off('end', onEnd)
+      .off('error', onError)
+      .off('ready', onReady)
 
-    const onError = function (err) {
-      // Swallow network errors to allow ioredis
-      // to perform reconnection and emit 'end'
-      // event if reconnection eventually
-      // fails.
-      // Any other errors during startup will
-      // trigger the 'end' event.
-      if (err instanceof Redis.ReplyError) {
-        onEnd(err)
-      }
-    }
+    next()
+  }
 
-    // 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)
+  // Testing this make the process crash on latest TAP :(
+  /* istanbul ignore next */
+  const onError = function (err) {
+    if (err.code === 'ENOTFOUND') {
+      onEnd(err)
+      return
     }
 
-    return
+    // Swallow network errors to allow ioredis
+    // to perform reconnection and emit 'end'
+    // event if reconnection eventually
+    // fails.
+    // Any other errors during startup will
+    // trigger the 'end' event.
+    if (err instanceof Redis.ReplyError) {
+      onEnd(err)
+    }
   }
 
-  next()
+  // ioredis provides it in a .status property
+  if (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)
+
+    client.ping()
+  }
 }
 
-function close (fastify, done) {
-  fastify.redis.quit(done)
+function close (fastify) {
+  return fastify.redis.quit()
 }
 
 module.exports = fp(fastifyRedis, {
-  fastify: '>=1.x',
-  name: 'fastify-redis'
+  fastify: '4.x',
+  name: '@fastify/redis'
 })

package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "lint": "standard",
     "lint:fix": "standard --fix",
-    "redis": "docker run -p 6379:6379 --rm redis:5",
+    "redis": "docker run -p 6379:6379 --rm redis",
     "test": "npm run lint && npm run unit && npm run typescript",
     "typescript": "tsd",
     "unit": "tap test/test.js",
@@ -35,16 +35,16 @@
   "devDependencies": {
     "@types/ioredis": "^4.27.4",
     "@types/node": "^17.0.0",
-    "fastify": "^3.21.6",
+    "fastify": "^4.0.0-rc.2",
     "proxyquire": "^2.1.3",
-    "redis": "^3.1.2",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.20.0"
+    "tsd": "^0.20.0",
+    "why-is-node-running": "^2.2.2"
   },
   "dependencies": {
     "fastify-plugin": "^3.0.0",
-    "ioredis": "^4.27.9"
+    "ioredis": "^5.0.0"
   },
   "tsd": {
     "directory": "test/types"