feat: pass custom options

README.md

@@ -59,12 +59,17 @@ There's a built-in [development mode](https://github.com/eggjs/egg-watcher/blob/
 
 ### Customize Watching Mode
 
-Firstly define your custom event source like this:
+Say we want to build a custom event source plugin (package name: `egg-watcher-custom`, eggPlugin.name: `watcherCustom`).
+
+Firstly define our custom event source like this:
 
 ```js
-// custom_event_source.js
+// {plugin_root}/lib/custom_event_source.js
 const Base = require('sdk-base');
 class CustomEventSource extends Base {
+  // `opts` comes from app.config[${eventSourceName}]
+  // `eventSourceName` will be registered later in
+  // `config.watcher.eventSources` as the key shown below
   constructor(opts) {
     super(opts);
     this.ready(true);
@@ -99,7 +104,7 @@ Then add your custom event source to config:
 // config.default.js
 exports.watcher = {
   eventSources: {
-    custom: require('../custom'),
+    custom: require('../lib/custom_event_source'),
   },
 };
 ```
@@ -111,9 +116,14 @@ Choose to use your custom watching mode in your desired env.
 exports.watcher = {
   type: 'custom',
 };
+
+// this will pass to your CustomEventSource constructor as opts
+exports.watcherCustom = {
+  // foo: 'bar',
+};
 ```
 
-If possible, plugins named like `egg-watcher-${customName}`(`egg-watcher-vagrant` eg.) are welcomed.
+If possible, plugins named like `egg-watcher-${customName}`(`egg-watcher-vagrant` eg.) are recommended.
 
 ## Questions & Suggestions
 

agent.js

@@ -4,13 +4,13 @@ const Watcher = require('./lib/watcher');
 
 module.exports = agent => {
   const logger = agent.coreLogger;
-  const config = agent.config.watcher;
-  config.logger = agent.coreLogger;
 
   const watcher = agent.watcher = agent.cluster(Watcher)
     .delegate('watch', 'subscribe')
-    .create(config)
-    .on('error', e => logger.error(e));
+    .create(agent.config)
+    .on('info', logger.info.bind(logger))
+    .on('warn', logger.warn.bind(logger))
+    .on('error', logger.error.bind(logger));
 
   agent.beforeStart(function* () {
     yield watcher.ready();

app.js

@@ -4,12 +4,13 @@ const Watcher = require('./lib/watcher');
 
 module.exports = app => {
   const logger = app.coreLogger;
-  const config = app.config.watcher;
 
   const watcher = app.watcher = app.cluster(Watcher)
-      .delegate('watch', 'subscribe')
-      .create(config)
-      .on('error', e => logger.error(e));
+    .delegate('watch', 'subscribe')
+    .create(app.config)
+    .on('info', logger.info.bind(logger))
+    .on('warn', logger.warn.bind(logger))
+    .on('error', logger.error.bind(logger));
 
   app.beforeStart(function* () {
     yield watcher.ready();

lib/event-sources/default.js

@@ -4,19 +4,19 @@ const Base = require('sdk-base');
 
 class DefaultEventSource extends Base {
 
-  constructor(options) {
+  constructor() {
     super();
-    this.logger = options.logger;
-    this.logger.warn('[egg-watcher] defaultEventSource watcher will NOT take effect');
+    // delay emit so that can be listened
+    setImmediate(() => this.emit('warn', '[egg-watcher] defaultEventSource watcher will NOT take effect'));
     this.ready(true);
   }
 
   watch() {
-    this.logger.warn('[egg-watcher] using defaultEventSource watcher.watch does NOTHING');
+    this.emit('warn', '[egg-watcher] using defaultEventSource watcher.watch() does NOTHING');
   }
 
   unwatch() {
-    this.logger.warn('[egg-watcher] using defaultEventSource watcher.unwatch does NOTHING');
+    this.emit('warn', '[egg-watcher] using defaultEventSource watcher.unwatch() does NOTHING');
   }
 
 }

lib/watcher.js

@@ -2,20 +2,28 @@
 
 const Base = require('sdk-base');
 const utils = require('./utils');
+const camelcase = require('camelcase');
 
 module.exports = class Watcher extends Base {
-  constructor(options) {
+  constructor(config) {
     super();
 
+    const options = config.watcher;
+
     let EventSource = options.eventSources[options.type];
     if (typeof EventSource === 'string') {
       EventSource = require(EventSource);
     }
 
-    this._eventSource = new EventSource(options)
+    // chokidar => watcherChokidar
+    const key = camelcase('watcher', options.type);
+    const eventSourceOpts = config[key];
+    this._eventSource = new EventSource(eventSourceOpts)
       .on('change', this._onChange.bind(this))
       .on('fuzzy-change', this._onFuzzyChange.bind(this))
-      .on('error', this.emit.bind(this, 'error'));
+      .on('info', msg => this.emit('info', msg))
+      .on('warn', msg => this.emit('warn', msg))
+      .on('error', err => this.emit('error', err));
 
     this._eventSource.ready(() => this.ready(true));
   }

package.json

@@ -19,6 +19,7 @@
     "autod": "autod"
   },
   "dependencies": {
+    "camelcase": "^4.0.0",
     "detect-port": "^1.1.0",
     "sdk-base": "^3.0.1",
     "wt": "^1.1.1"

test/fixtures/apps/watcher-custom-event-source/config/config.unittest.js

@@ -3,3 +3,8 @@
 exports.watcher = {
   type: 'custom',
 };
+
+exports.watcherCustom = {
+  foo: 'bar',
+};
+

test/fixtures/apps/watcher-custom-event-source/config/plugin.js

@@ -2,7 +2,7 @@
 
 const path = require('path');
 
-exports['custom-event-source'] = {
+exports.watcherCustom = {
   enable: true,
-  path: path.join(__dirname, '../plugins/custom-event-source'),
+  path: path.join(__dirname, '../plugins/egg-watcher-custom'),
 };

test/fixtures/apps/watcher-custom-event-source/plugins/custom-event-source/custom.js → test/fixtures/apps/watcher-custom-event-source/plugins/egg-watcher-custom/custom.js

@@ -4,15 +4,19 @@ const Base = require('sdk-base');
 
 class CustomEventSource extends Base {
 
-  constructor(/* options */) {
+  constructor(options) {
     super();
+    this._options = options;
     this.ready(true);
   }
 
   watch(path) {
+    this.emit('info', 'info12345');
+    this.emit('warn', 'warn12345');
     this._h = setInterval(() => {
       this.emit('change', {
         path,
+        foo: this._options.foo,
       });
     }, 1000);
   }

test/fixtures/apps/watcher-custom-event-source/plugins/egg-watcher-custom/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "egg-watcher-custom",
+  "eggPlugin": {
+    "name": "watcherCustom",
+    "dep": [
+      "watcher"
+    ]
+  }
+}

test/fixtures/apps/watcher-type-default/app.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = app => {
+  app.watcher.watch('xx', () => {});
+};

test/watcher.test.js

@@ -11,16 +11,14 @@ describe('test/watcher.test.js', () => {
     app && app.close();
   });
 
-  it('should warn user if config.watcher.type is default', done => {
+  it('should warn user if config.watcher.type is default', function* () {
     app = mm.cluster({
       plugin: 'watcher',
       baseDir: 'apps/watcher-type-default',
     });
-    app.ready(() => {
-      const content = fs.readFileSync(__dirname + '/fixtures/apps/watcher-type-default/logs/watcher-type-default/egg-agent.log').toString();
-      assert(content.includes('defaultEventSource watcher will NOT take effect'));
-      done();
-    });
+    yield app.ready();
+    const content = fs.readFileSync(__dirname + '/fixtures/apps/watcher-type-default/logs/watcher-type-default/egg-agent.log', 'utf8');
+    assert(content.includes('defaultEventSource watcher will NOT take effect'));
   });
 
   it('should work if config.watcher.type is custom', done => {
@@ -31,6 +29,13 @@ describe('test/watcher.test.js', () => {
     app.ready(() => {
       app.watcher.watch('xxxx', info => {
         assert(info.path === 'xxxx');
+
+        // ensure use config.custom
+        assert(info.foo === 'bar');
+
+        const content = fs.readFileSync(__dirname + '/fixtures/apps/watcher-custom-event-source/logs/watcher-custom-event-source/egg-agent.log', 'utf8');
+        assert(content.includes('warn12345'));
+        assert(content.includes('info12345'));
         /*
         // TODO wait unsubscribe implementaion in cluster-client
         co(function* () {