fix(cache): Redis

doc/Plugins.md

@@ -48,10 +48,12 @@ The hooks structure must be as following:
 /**
  * registerHooks
  * @param object config explorer configuration
- * @param string url the base url of your plugin (/p/pluginName)
  * @param mixed user the user object, null if no user
+ * @param Object {notify, cache}
+ * @see Notify
+ * @see Cache
  */
-function registerHooks(config, url, user) {
+function registerHooks(config, user, utils) {
   return {
     directory: function(tree, path) {
       dosomethingwith(config.plugins.pluginName.myConfigValue)

doc/examples/config.yml

@@ -46,9 +46,10 @@ https:
   enabled: true # default option!
   key: './certs/key.pem' # change those are dummies
   cert: './certs/cert.pem'
-plugins: # those are enable by default, use below options to disable them
+plugins: # those are enable by default, use above options to disable them
   upload: {}
   archive: {}
+  move: {}
 cache: 'memory' # redis is available too
 redis: {}
   # host: 'somesocket.sock'

index.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 var p = require('path')
 var http = require('http')
 var https = require('https')
@@ -15,11 +15,12 @@ var https_options = {
 
 require('./server.js')(config)
 .then(function(app) {
+
   var server = http.createServer(app)
-              .listen(config.port, function() {
-                if(!config.quiet)
-                  console.log('HTTP listening on %s', config.port)
-              })
+  .listen(config.port, function() {
+    if(!config.quiet)
+      console.log('HTTP listening on %s', config.port)
+  })
 
   var socket = require('./lib/socket.js')(server, app)
 
@@ -52,7 +53,9 @@ require('./server.js')(config)
     console.error(err); 
   })
 
-  return interactor.run(plugins_paths, config)
+  var cache = app.get('cache')
+
+  return interactor.run(plugins_paths, config, cache)
   .then(function() {
     interactor.ipc.on('notify:*', function(data) {
       var event = this.event

lib/cache/redis.js

@@ -2,6 +2,7 @@
 var Promise = require('bluebird')
 var Cache = require('./cache.js')
 var util = require('util')
+var redis = require('ioredis')
 
 /**
  * RedisCache 
@@ -15,7 +16,7 @@ function RedisCache(namespace, client) {
 
   Cache.apply(this, arguments)
 
-  if(!(client.constructor.name == 'Redis')) {
+  if(!client) {
     throw new TypeError("Client should be a Redis instance") 
   }
 

lib/job/interactor.js

@@ -34,13 +34,12 @@ util.inherits(Interactor, EventEmitter)
  * @param array plugins strings representing a directory in plugin_path
  * @return Promise resolved when job has started
  */
-Interactor.prototype.run = function(plugins, config) {
+Interactor.prototype.run = function(plugins, config, cache) {
   if(this.job) {
     throw new ReferenceError("Job is already running with this interactor")
   }
 
   var self = this
-  let cache = require('../cache/index.js')(config)
 
   debug('Forking job with plugins %o', plugins)
 

lib/job/notify.js

@@ -11,7 +11,7 @@ function Notify(namespace, cache) {
     throw new TypeError('Notify needs a namespace, none given') 
   }
 
-  this.memory = new cache(namespace)
+  this.memory = cache(namespace)
 }
 
 /**

lib/plugins.js

@@ -57,6 +57,7 @@ function registerPluginsRoutes(app) {
 
   var config = app.get('config')
   var plugins = app.get('plugins')
+  var cache = app.get('cache')
   var allowKeyAccess = config.allowKeyAccess
 
   for(let name in plugins) {
@@ -72,7 +73,8 @@ function registerPluginsRoutes(app) {
         prepareTree: middlewares.prepareTree(app),
         HTTPError: HTTPError,
         interactor: interactor,
-        tree: tree
+        tree: tree,
+        cache: cache
       }, config)
 
       debug('Using router for plugin %s on /p/%s', name, name)

middlewares/prepareTree.js

@@ -114,8 +114,8 @@ function prepareTree(app) {
 
     if(opts.cache === true) {
       opts.cache = {
-        time: new cache('tree:time'),
-        size: new cache('tree:size')
+        time: cache('tree:time'),
+        size: cache('tree:size')
       }
     }
 

middlewares/registerHooks.js

@@ -1,6 +1,7 @@
 'use strict';
 var p = require('path')
 var Promise = require('bluebird')
+var Notify = require('../lib/job/notify.js')
 
 var debug = require('debug')('explorer:middlewares:registerHooks')
 
@@ -9,6 +10,7 @@ function registerHooks(app) {
 
   var plugins = app.get('plugins')
   var config = app.get('config')
+  var cache = app.get('cache')
 
   return function(req, res, next) {
     res.locals.hooks = {}
@@ -24,7 +26,10 @@ function registerHooks(app) {
     for(let name in plugins) {
       if('hooks' in plugins[name]) {
         debug('Registering hooks for %s', name)
-        hooks[name] = plugins[name].hooks(config, p.join('/p', name), req.user) 
+        hooks[name] = plugins[name].hooks(config, req.user, {
+          cache: cache,
+          notify: Notify
+        })
       }
     }
 

plugins/move/hooks.js

@@ -1,13 +1,11 @@
 'use strict';
-var Notify = require('../../lib/job/notify.js')
 var fs = require('fs')
 var p = require('path')
 var hamljs = require('hamljs')
 var clipboard = fs.readFileSync(p.join(__dirname, './clipboard.haml'))
 
-function registerHooks(config, url, user) {
-  var cache = require('../../lib/cache')(config)
-  var memory = new Notify('clipboard', cache)
+function registerHooks(config, user, utils) {
+  var memory = new utils.notify('clipboard', utils.cache)
 
   return memory.get(user.username)
   .then(function(paths) {
@@ -27,7 +25,6 @@ function registerHooks(config, url, user) {
 
         return hamljs.render(clipboard, {locals: {
           paths: paths,
-          url: url,
           path: path
         }})
       }

plugins/move/router.js

@@ -90,8 +90,7 @@ function cutPromises(items, dest) {
 
 var Move = function(router, utils, config) {
 
-  var cache = require('../../lib/cache')(config)
-  var memory = new Notify('clipboard', cache)
+  var memory = new Notify('clipboard', utils.cache)
 
   /**
    * @api {post} /p/move/action/copy Copy

plugins/upload/hooks.js

@@ -1,11 +1,11 @@
-function registerHooks(config, url, user) {
+function registerHooks(config) {
   return {
     menu: function() {
 
       if(config.upload.disabled === true)
         return ''
 
-      return '<li><a href="'+url+'"><i class="icon-upload"></i>Upload</a></li>'
+      return '<li><a href="/p/upload"><i class="icon-upload"></i>Upload</a></li>'
     } 
   }
 }

server.js

@@ -1,3 +1,4 @@
+'use strict';
 var express = require('express')
 var p = require('path')
 var util = require('util')
@@ -30,7 +31,15 @@ module.exports = function(config) {
   app.use(bodyParser.json({limit: config.upload.maxSize}))
 
   app.set('config', config)
-  app.set('cache', require('./lib/cache')(config))
+
+  let cache = require('./lib/cache')(config)
+
+  app.set('cache', function getCache(namespace) {
+    if(config.cache == 'redis')
+      return new cache(namespace, require('./lib/redis.js')(config))
+    else
+      return new cache(namespace)
+  })
 
   app.set('view engine', 'haml')
   app.set('view cache', true)
@@ -101,7 +110,7 @@ module.exports = function(config) {
     return res.status(404).render('404.haml')
   })
 
-  var users = new Users({database: p.resolve(__dirname, config.database)})
+  let users = new Users({database: p.resolve(__dirname, config.database)})
 
   //load users from file to memory
   return users.load()

test/api/archive.js

@@ -3,7 +3,7 @@ var p = require('path')
 var fs = require('fs')
 var rimraf = require('rimraf')
 var async = require('async')
-var interactor = require('../../lib/job/interactor.js')
+var interactor = bootstrap.interactor
 
 var archive_path = p.join(__dirname, '../fixtures/tmp')
 var list
@@ -18,10 +18,7 @@ describe('archive', function() {
 
   before(bootstrap.autoAgent)
   before(bootstrap.login)
-  before(function() {
-    this.timeout(5000)
-    return interactor.run([p.resolve(__dirname, '../../plugins/archive')], bootstrap.config)
-  })
+  before(bootstrap.runInteractor([p.resolve(__dirname, '../../plugins/archive')]))
 
   it('should post file', function(cb) {
     var getNotification = function(notifications) {
@@ -57,10 +54,6 @@ describe('archive', function() {
 
   after(bootstrap.logout)
   after(bootstrap.removeAgent)
-
-  after(function(cb) {
-    interactor.once('exit', cb)
-    interactor.kill()
-  })
+  after(bootstrap.killInteractor())
 
 })

test/api/move.js

@@ -3,7 +3,7 @@ var p = require('path')
 var fs = require('fs')
 var rimraf = require('rimraf')
 var async = require('async')
-var interactor = require('../../lib/job/interactor.js')
+var interactor = bootstrap.interactor
 
 var fixtures = p.join(__dirname, '../fixtures/tree/move')
 var move_path = p.join(__dirname, '../fixtures/tree/move/dest')
@@ -38,10 +38,7 @@ describe('move', function() {
 
   before(bootstrap.autoAgent)
   before(bootstrap.login)
-  before(function() {
-    this.timeout(5000)
-    return interactor.run([p.resolve(__dirname, '../../plugins/move')], bootstrap.config)
-  })
+  before(bootstrap.runInteractor([p.resolve(__dirname, '../../plugins/move')]))
 
   before(deleteFiles)
   before(createFiles)
@@ -190,9 +187,6 @@ describe('move', function() {
   after(bootstrap.logout)
   after(bootstrap.removeAgent)
 
-  after(function(cb) {
-    interactor.once('exit', cb)
-    interactor.kill()
-  })
+  after(bootstrap.killInteractor())
 
 })

test/api/upload.js

@@ -3,7 +3,7 @@ var p = require('path')
 var fs = require('fs')
 var rimraf = require('rimraf')
 var async = require('async')
-var interactor = require('../../lib/job/interactor.js')
+var interactor = bootstrap.interactor
 
 var upload_path = p.join(__dirname, '../fixtures/upload')
 var list
@@ -18,10 +18,7 @@ describe('upload', function() {
 
   before(bootstrap.autoAgent)
   before(bootstrap.login)
-  before(function() {
-    this.timeout(5000)
-    return interactor.run([p.resolve(__dirname, '../../plugins/upload')], bootstrap.config)
-  })
+  before(bootstrap.runInteractor([p.resolve(__dirname, '../../plugins/upload')]))
 
   it('should get upload', function(cb) {
     this.request.get('/p/upload')
@@ -95,10 +92,5 @@ describe('upload', function() {
 
   after(bootstrap.logout)
   after(bootstrap.removeAgent)
-
-  after(function(cb) {
-    interactor.once('exit', cb)
-    interactor.kill()
-  })
-
+  after(bootstrap.killInteractor())
 })

test/job/interactor.js

@@ -1,11 +1,12 @@
 'use strict';
 
+var cache = require('../../lib/cache')(bootstrap.config)
 var interactor = require('../../lib/job/interactor.js')
 
 describe('interactor', function() {
   it('should run', function(cb) {
     this.timeout(5000)
-    interactor.run([__dirname + '/../fixtures/testjob'], bootstrap.config) 
+    interactor.run([__dirname + '/../fixtures/testjob'], bootstrap.config, cache) 
     .then(function(plugins) {
       expect(plugins).to.deep.equal(['testjob'])
       return cb()
@@ -75,7 +76,7 @@ describe('interactor', function() {
   })
 
   it('should run again', function(cb) {
-    interactor.run([__dirname + '/../fixtures/testjob'], bootstrap.config) 
+    interactor.run([__dirname + '/../fixtures/testjob'], bootstrap.config, cache) 
     interactor.ipc.once('job.start', function(plugins) {
       return cb() 
     })

test/tools/bootstrap.js

@@ -1,5 +1,4 @@
 'use strict';
-
 var p = require('path')
 var fs = require('fs')
 var util = require('util') 
@@ -18,6 +17,8 @@ if(!fs.existsSync(config.database)) {
   fs.writeFileSync(config.database, fs.readFileSync(p.join(cwd, '/../doc/examples/data/users')))
 }
 
+var cache = require('../../lib/cache')(config)
+
 var options = {
   headers: []
 }
@@ -70,5 +71,22 @@ module.exports = {
   removeAgent: function(cb) {
     this.request = null
     return cb()
+  },
+  interactor: require('../../lib/job/interactor.js'),
+  runInteractor: function(plugins) {
+    var self = this
+
+    return function() {
+       return self.interactor
+      .run(plugins, self.config, cache)
+    }
+  },
+  killInteractor: function() {
+    var self = this
+
+    return function(cb) {
+      self.interactor.once('exit', cb)
+      self.interactor.kill()
+    }
   }
 }