[Plugin] refactor plugins to order by id.

Signed-off-by: Eric Wang <[email protected]>

Author: skygragon

lib/commands/version.js

@@ -65,7 +65,7 @@ cmd.handler = function(argv) {
 
   log.info('\n[Plugins]');
   _.each(Plugin.plugins, function(p, k) {
-    prettyLine(p.id, 'v' + p.ver);
+    prettyLine(p.name, 'v' + p.ver);
   });
 };
 

lib/plugin.js

@@ -1,3 +1,5 @@
+var _ = require('underscore');
+
 var h = require('./helper');
 var log = require('./log');
 
@@ -16,26 +18,32 @@ Plugin.prototype.setNext = function(next) {
   this.next = this.__proto__ = next;
 };
 
-Plugin.plugins = {};
+Plugin.plugins = [];
 
-Plugin.init = function(root) {
+Plugin.init = function(head) {
+  var plugins = [];
   h.getDirData(['lib', 'plugins']).forEach(function(f) {
     var p = f.data;
     if (!p) return;
 
-    log.trace('found plugin: ' + p.id + '=' + p.ver);
+    log.trace('found plugin: ' + p.name + '=' + p.ver);
     p.init();
-    Plugin.plugins[f.name] = p;
-    log.trace('inited plugin: ' + p.id);
+    plugins.push(p);
+    log.trace('inited plugin: ' + p.name);
+  });
+
+  // chain the plugins together
+  // the one has bigger `id` comes first
+  plugins = _.sortBy(plugins, function(p) {
+    return -p.id;
   });
 
-  var last = root;
-  var chains = ['retry', 'cache', 'leetcode'];
-  chains.forEach(function(name) {
-    var p = Plugin.plugins[name];
+  var last = head;
+  plugins.forEach(function(p) {
     last.setNext(p);
     last = p;
   });
+  Plugin.plugins = plugins;
 };
 
 module.exports = Plugin;

lib/plugins/cache.js

@@ -6,7 +6,7 @@ var log = require('../log');
 var Plugin = require('../plugin');
 var session = require('../session');
 
-var plugin = new Plugin('cache', 'Cache', '20170722', 'Plugin to provide local cache.');
+var plugin = new Plugin(20, 'Cache', '2017.07.24', 'Plugin to provide local cache.');
 
 plugin.init = function() {
   cache.init();

lib/plugins/leetcode.js

@@ -10,8 +10,8 @@ var Plugin = require('../plugin');
 var queue = require('../queue');
 var session = require('../session');
 
-var plugin = new Plugin('leetcode', 'Leetcode Client', '20170722',
-    'Plugin to access leetcode APIs.');
+var plugin = new Plugin(10, 'Leetcode Client', '2017.07.24',
+    'Plugin to talk with leetcode APIs.');
 
 // update options with user credentials
 function signOpts(opts, user) {

lib/plugins/retry.js

@@ -3,8 +3,8 @@ var log = require('../log');
 var Plugin = require('../plugin');
 var session = require('../session');
 
-var plugin = new Plugin('retry', 'Retry on error', '20170722',
-    'Plugin to retry last requests on error.');
+var plugin = new Plugin(30, 'Retry', '2017.07.24',
+    'Plugin to retry last failed request if AUTO_LOGIN is on.');
 
 var count = {};
 

test/test_plugin.js

@@ -7,10 +7,10 @@ var Plugin = rewire('../lib/plugin');
 var h = rewire('../lib/helper');
 
 describe('plugin', function() {
-  var cache = new Plugin('cache', 'Cache', '1.0', '');
-  var leetcode = new Plugin('leetcode', 'Leetcode', '2.0', '');
-  var retry = new Plugin('retry', 'Retry', '3.0', '');
-  var core = new Plugin('core', 'Core', '4.0', '');
+  var leetcode = new Plugin(0, 'Leetcode', '2.0', '');
+  var cache = new Plugin(1, 'Cache', '1.0', '');
+  var retry = new Plugin(2, 'Retry', '3.0', '');
+  var core = new Plugin(3, 'Core', '4.0', '');
 
   before(function() {
     log.init();
@@ -26,17 +26,21 @@ describe('plugin', function() {
         {name: 'cache', data: cache},
         {name: 'leetcode', data: leetcode},
         {name: 'retry', data: retry},
-        {name: 'core', data: core},
         {name: 'bad', data: null}
       ];
     };
     Plugin.__set__('h', h);
   });
 
   it('should init ok', function() {
-    assert.deepEqual(_.keys(Plugin.plugins), []);
+    assert.deepEqual(Plugin.plugins, []);
     Plugin.init(core);
-    assert.deepEqual(_.keys(Plugin.plugins), ['cache', 'leetcode', 'retry', 'core']);
+    assert.deepEqual(Plugin.plugins.length, 3);
+
+    var names = Plugin.plugins.map(function(p) {
+      return p.name;
+    });
+    assert.deepEqual(names, ['Retry', 'Cache', 'Leetcode']);
 
     assert.equal(core.next, retry);
     assert.equal(retry.next, cache);