Merge pull request #20 from fastify/ioredis

Use ioredis by default

Author: delvedor

.travis.yml

@@ -1,9 +1,9 @@
 language: node_js
 
 node_js:
+  - "9"
   - "8"
   - "6"
-  - "4"
 
 services:
   - redis-server

README.md

@@ -4,7 +4,7 @@
 
 Fastify Redis connection plugin, with this you can share the same Redis connection in every part of your server.
 
-Under the hood the official [redis](https://github.com/NodeRedis/node_redis) client is used, the ``options`` that you pass to `register` will be passed to the Redis client.
+Under the hood [ioredis](https://github.com/luin/ioredis) is used as client, the ``options`` that you pass to `register` will be passed to the Redis client.
 
 ## Install
 ```
@@ -14,18 +14,10 @@ npm i fastify-redis --save
 Add it to your project with `register` and you are done!
 You can access the *Redis* client via `fastify.redis`.
 
-If needed, you can pass a custom ``driver`` option, such as [ioredis](https://github.com/luin/ioredis). By default the official [redis](https://github.com/NodeRedis/node_redis) client is used.
-
-
 ```js
 const fastify = require('fastify')
 
-fastify.register(require('fastify-redis'), {
-  driver: require('ioredis'),
-  host: '127.0.0.1'
-}, err => {
-  if (err) throw err
-})
+fastify.register(require('fastify-redis'), { host: '127.0.0.1' })
 
 fastify.get('/foo', (req, reply) => {
   const { redis } = fastify
@@ -52,9 +44,9 @@ object with the `client` property set to the instance.
 
 ```js
 const fastify = Fastify()
-const redis = require('redis').createClient({host: 'localhost', port: 6379})
+const redis = require('redis').createClient({ host: 'localhost', port: 6379 })
 
-fastify.register(fastifyRedis, {client: redis})
+fastify.register(fastifyRedis, { client: redis })
 
 // ...
 // ...

index.js

@@ -1,17 +1,14 @@
 'use strict'
 
 const fp = require('fastify-plugin')
-const redis = require('redis')
+const Redis = require('ioredis')
 
 function fastifyRedis (fastify, options, next) {
   var client = options.client || null
 
   if (!client) {
     try {
-      // if custom redis module, default is redis.
-      const Driver = options.driver
-      delete options.driver
-      client = Driver ? new Driver(options) : redis.createClient(options)
+      client = new Redis(options)
     } catch (err) {
       return next(err)
     }
@@ -29,6 +26,6 @@ function close (fastify, done) {
 }
 
 module.exports = fp(fastifyRedis, {
-  fastify: '>=0.39',
+  fastify: '>=1.x',
   name: 'fastify-redis'
 })

package.json

@@ -5,7 +5,7 @@
   "main": "index.js",
   "scripts": {
     "test": "standard && tap test.js",
-    "redis": "docker run -p 6379:6379 redis:3.0.7"
+    "redis": "docker run -p 6379:6379 --rm redis:3.0.7"
   },
   "repository": {
     "type": "git",
@@ -16,7 +16,8 @@
     "redis",
     "database",
     "speed",
-    "cache"
+    "cache",
+    "ioredis"
   ],
   "author": "Tomas Della Vedova - @delvedor (http://delved.org)",
   "license": "MIT",
@@ -25,13 +26,13 @@
   },
   "homepage": "https://github.com/fastify/fastify-redis#readme",
   "devDependencies": {
-    "fastify": "^0.39.0",
-    "ioredis": "^3.2.1",
-    "standard": "^10.0.3",
-    "tap": "^11.0.1"
+    "fastify": "^1.2.1",
+    "redis": "^2.8.0",
+    "standard": "^11.0.1",
+    "tap": "^11.1.3"
   },
   "dependencies": {
-    "fastify-plugin": "^0.2.1",
-    "redis": "^2.8.0"
+    "fastify-plugin": "^0.2.2",
+    "ioredis": "^3.2.2"
   }
 }

test.js

@@ -10,27 +10,23 @@ t.beforeEach(done => {
 
   fastify.register(fastifyRedis, {
     host: '127.0.0.1'
-  }, (err) => {
-    t.error(err)
   })
 
   fastify.ready(err => {
     t.error(err)
 
-    fastify.redis.flushdb(() => {
+    fastify.redis.flushall(() => {
       fastify.close()
       done()
     })
   })
 })
 
 test('fastify.redis should exist', t => {
-  t.plan(3)
+  t.plan(2)
   const fastify = Fastify()
   fastify.register(fastifyRedis, {
     host: '127.0.0.1'
-  }, (err) => {
-    t.error(err)
   })
 
   fastify.ready(err => {
@@ -42,13 +38,11 @@ test('fastify.redis should exist', t => {
 })
 
 test('fastify.redis should be the redis client', t => {
-  t.plan(5)
+  t.plan(4)
   const fastify = Fastify()
 
   fastify.register(fastifyRedis, {
     host: '127.0.0.1'
-  }, (err) => {
-    t.error(err)
   })
 
   fastify.ready(err => {
@@ -66,57 +60,35 @@ test('fastify.redis should be the redis client', t => {
   })
 })
 
-test('fastify.redis should exist when use the custom redis driver', t => {
-  t.plan(3)
-  const fastify = Fastify()
-
-  fastify.register(fastifyRedis, {
-    driver: require('ioredis'),
-    host: '127.0.0.1'
-  }, (err) => {
-    t.error(err)
-  })
-
-  fastify.ready(err => {
-    t.error(err)
-    t.ok(fastify.redis)
-
-    fastify.close()
-  })
-})
-
-test('fastify.redis should be the redis client when use the custom redis driver', t => {
-  t.plan(5)
+test('promises support', t => {
+  t.plan(2)
   const fastify = Fastify()
 
   fastify.register(fastifyRedis, {
-    driver: require('ioredis'),
     host: '127.0.0.1'
-  }, (err) => {
-    t.error(err)
   })
 
   fastify.ready(err => {
     t.error(err)
 
-    fastify.redis.set('key', 'value', err => {
-      t.error(err)
-      fastify.redis.get('key', (err, val) => {
-        t.error(err)
+    fastify.redis.set('key', 'value')
+      .then(() => {
+        return fastify.redis.get('key')
+      })
+      .then(val => {
         t.equal(val, 'value')
-
         fastify.close()
       })
-    })
+      .catch(err => t.fail(err))
   })
 })
 
-test('fastify.redis should be a singleton', t => {
+test('custom client', t => {
   t.plan(5)
   const fastify = Fastify()
-  const redis = require('redis').createClient({host: 'localhost', port: 6379})
+  const redis = require('redis').createClient({ host: 'localhost', port: 6379 })
 
-  fastify.register(fastifyRedis, {client: redis})
+  fastify.register(fastifyRedis, { client: redis })
 
   fastify.ready(err => {
     t.error(err)