feat(session): add support for redis session driver

thetutlage · thetutlage · commit 677cc4e3bcfd · 2016-08-22T18:27:39.000+05:30
redis driver support for sessions, adonis-redis must be installed Closes adonisjs#190
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "main": "index.js",
   "scripts": {
     "test": "npm run lint && istanbul cover _mocha --report lcovonly -- -R spec test/unit test/acceptance && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
-    "coverage": "npm run lint && istanbul cover _mocha test/unit test/acceptance  --bail",
+    "coverage": "npm run lint && istanbul cover _mocha test/unit test/acceptance --bail",
     "lint": "standard src/**/*.js src/**/**/*.js test/**/*.js providers/*.js"
   },
   "standard": {
@@ -28,6 +28,7 @@
   "license": "MIT",
   "devDependencies": {
     "adonis-fold": "^3.0.2",
+    "adonis-redis": "^1.0.0",
     "chai": "^3.3.0",
     "cheerio": "^0.20.0",
     "co-mocha": "^1.1.3",
diff --git a/src/Session/Drivers/Cookie/index.js b/src/Session/Drivers/Cookie/index.js
@@ -106,12 +106,6 @@ class Cookie {
     this.cookieManager.remove(this.request, this.response, this.cookieName)
   }
 
-  /**
-   * Cookie values are automatically deleted as per
-   * their expiry. This method does not do anything
-   */
-  * gc () {}
-
   /**
    * called by session class to pass on the request
    * and response object.
diff --git a/src/Session/Drivers/Redis/index.js b/src/Session/Drivers/Redis/index.js
@@ -0,0 +1,81 @@
+'use strict'
+
+/**
+ * adonis-framework
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+/**
+ * Redis session driver to store sessions within
+ * redis.
+ * @class
+ * @alias SessionRedisDriver
+ */
+class Redis {
+
+  /**
+   * Injects ['Adonis/Src/Helpers', 'Adonis/Src/Config']
+   */
+  static get inject () {
+    return ['Adonis/Src/Helpers', 'Adonis/Src/Config', 'Adonis/Addons/RedisFactory']
+  }
+
+  /**
+   * @constructor
+   */
+  constructor (Helpers, Config, RedisFactory) {
+    const redisConfig = Config.get('session.redis')
+    this.ttl = Config.get('session.age')
+    this.redis = new RedisFactory(redisConfig, Helpers, false) // do not use cluster for sessions
+  }
+
+  /**
+   * Reads values for a session id from redis.
+   *
+   * @param  {String} sessionId
+   *
+   * @return {Object}
+   */
+  * read (sessionId) {
+    try {
+      const sessionValues = yield this.redis.get(sessionId)
+      yield this.redis.expire(sessionId, this.ttl) // updating expiry after activity
+      return JSON.parse(sessionValues)
+    } catch (e) {
+      return {}
+    }
+  }
+
+  /**
+   * Writes values for a session id to redis.
+   *
+   * @param  {String} sessionId
+   * @param  {Object} values
+   *
+   * @return {Boolean}
+   */
+  * write (sessionId, values) {
+    const response = yield this.redis.set(sessionId, JSON.stringify(values))
+    yield this.redis.expire(sessionId, this.ttl)
+    return !!response
+  }
+
+  /**
+   * Destorys the record of a given sessionId
+   *
+   * @param  {String} sessionId
+   *
+   * @return {Boolean}           [description]
+   */
+  * destroy (sessionId) {
+    const response = yield this.redis.del(sessionId)
+    return !!response
+  }
+
+}
+
+module.exports = Redis
diff --git a/src/Session/Drivers/index.js b/src/Session/Drivers/index.js
@@ -11,5 +11,6 @@
 
 module.exports = {
   file: require('./File'),
-  cookie: require('./Cookie')
+  cookie: require('./Cookie'),
+  redis: require('./Redis')
 }
diff --git a/test/functional/providers.spec.js b/test/functional/providers.spec.js
@@ -96,4 +96,16 @@ describe('Providers', function () {
       expect(Response.name).to.equal('Response')
     })
   })
+
+  context('Session', function () {
+    it('should return Session class', function () {
+      const Config = Ioc.use('Adonis/Src/Config')
+      const get = sinon.stub(Config, 'get')
+      get.withArgs('session.driver').returns('cookie')
+      const sessionManager = Ioc.use('Adonis/Src/Session')
+      const Session = require('../../src/Session')
+      expect(sessionManager).deep.equal(Session)
+      Config.get.restore()
+    })
+  })
 })
diff --git a/test/unit/sessions.spec.js b/test/unit/sessions.spec.js

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@`
`11`	`11`
`12`	`12`	`module.exports = {`
`13`	`13`	`file: require('./File'),`
`14`		`- cookie: require('./Cookie')`
	`14`	`+ cookie: require('./Cookie'),`
	`15`	`+ redis: require('./Redis')`
`15`	`16`	`}`