plugin options precedence

Author: rjrodger

lib/errors.js

@@ -107,12 +107,16 @@ module.exports = {
     "The definition function for the plugin <%=fullname%> has failed: <%=message%>. This error is considered fatal as all plugins have to initialize correctly. You should test the plugin by itself to verify that it is working correctly. Also ensure that the configuration options passed to the plugin are correct. These are shown below under in the DETAILS section. There could also be a bug in the plugin. If you think that is the case, please create a github issue on the plugin's repository<%=repo%>, and include this error report.",
 
   no_transport_client: "The transport client defined by <%=config%> does not exist for message: <%=msg%>",
-  
+
+  invalid_plugin_option: "Plugin <%=name%>: option value is not valid: <%=err_msg%> in options <%=options%>",
+
+
   // Legacy error message codes
 
   act_invalid_args:
     'Action <%=pattern%> has invalid arguments; <%=message%>; ' +
-    'arguments were: <%=msg%>.'
+    'arguments were: <%=msg%>.',
+
 }
 
 module.exports.deprecation = {

lib/plugins.js

@@ -15,7 +15,7 @@ var internals = {
         'The plugin <%=name%> uses an unsupported legacy ' +
         'callback to indicate plugin definition is complete: <%=init_func_sig%> ' +
         '... }. The correct format is: function(options) { ... }. For more details, ' +
-        'please see http://senecajs.org/tutorials/how-to-write-a-plugin.html'
+        'please see http://senecajs.org/tutorials/how-to-write-a-plugin.html',
     }
   })
 }
@@ -198,6 +198,8 @@ module.exports.make_delegate = make_delegate
 function resolve_options(fullname, plugindef, seneca) {
   var so = seneca.options()
 
+  var defaults = plugindef.defaults || {}
+  
   var fullname_options = _.extend(
     {},
     so[fullname],
@@ -226,7 +228,16 @@ function resolve_options(fullname, plugindef, seneca) {
     plugindef.options || {}
   )
 
-  return outopts
+  try {
+    return seneca.util.Optioner(defaults, {allow_unknown: true})
+      .check(outopts)
+  } catch (e) {
+    throw Common.error('invalid_plugin_option', {
+      name: fullname,
+      err_msg: e.message,
+      options: outopts
+    })
+  }
 }
 
 function make_delegate(instance, plugin) {

package-lock.json

@@ -94,7 +94,7 @@
     "rolling-stats": "0.1",
     "semver": "5.5",
     "seneca-transport": "2.3",
-    "use-plugin": "2.3",
+    "use-plugin": "2.4.1",
     "wreck": "12.5"
   },
   "devDependencies": {

package.json

@@ -10,7 +10,7 @@ var Util = require('util')
 var _ = require('lodash')
 var GateExecutor = require('gate-executor')
 var Jsonic = require('jsonic')
-var Makeuse = require('use-plugin')
+var UsePlugin = require('use-plugin')
 var Nid = require('nid')
 var Norma = require('norma')
 var Patrun = require('patrun')
@@ -222,7 +222,8 @@ var seneca_util = {
   Jsonic: Jsonic,
   Nid: Nid,
   Patrun: Patrun,
-  Joi: Makeuse.Joi,
+  Joi: UsePlugin.Joi,
+  Optioner: UsePlugin.Optioner,
 
   clean: Common.clean,
   pattern: Common.pattern,
@@ -510,11 +511,12 @@ function make_seneca(initial_options) {
 
   // private$.plugins = {}
   private$.plugin_order = { byname: [], byref: [] }
-  private$.use = Makeuse({
+  private$.use = UsePlugin({
     prefix: 'seneca-',
     module: opts.$.internal.module || module,
     msgprefix: false,
-    builtin: ''
+    builtin: '',
+    merge_defaults: false
   })
 
   private$.actrouter = opts.$.internal.actrouter

seneca.js

@@ -113,7 +113,7 @@ describe('plugin', function() {
   it('bad-default-options', function(fin) {
     Seneca({ log: 'silent', debug: { undead: true } })
       .test(function(err) {
-        expect(err.code).equals('plugin_invalid_option')
+        expect(err.code).equals('invalid_plugin_option')
         fin()
       })
       .use(
@@ -776,4 +776,33 @@ describe('plugin', function() {
       fin()
     })
   })
+
+
+  it('plugins-options-precedence', function(fin) {
+    var si = Seneca({
+      log: 'silent',
+      legacy: { transport: false },
+      plugin: {
+        foo: {a:2,c:2},
+        bar: {a:2,c:1},
+      }
+    })
+
+    function bar(opts) {
+      expect(opts).equal({a:3,b:1,c:1,d:1})
+    }
+    bar.defaults = {a:1,b:1}
+    
+    si
+      .use({name:'foo', defaults:{a:1,b:1}, init: function(opts) {
+        expect(opts).equal({a:2,b:2,c:3,d:1})
+      }}, {b:2,c:3,d:1})
+      .use(bar, {a:3,d:1})
+
+      .ready(function() {
+        console.log(this.options().plugin)
+        fin()
+      })
+  })
+
 })