feat: add plugin.from where declare the plugin

lib/loader/mixin/plugin.js

@@ -157,7 +157,7 @@ module.exports = {
       const config = loadFile(configPath);
 
       for (const name in config) {
-        this.normalizePluginConfig(config, name);
+        this.normalizePluginConfig(config, name, configPath);
       }
 
       extendPlugins(plugins, config);
@@ -166,7 +166,7 @@ module.exports = {
     return plugins;
   },
 
-  normalizePluginConfig(plugins, name) {
+  normalizePluginConfig(plugins, name, configPath) {
     const plugin = plugins[name];
 
     // plugin_name: false
@@ -176,6 +176,7 @@ module.exports = {
         enable: plugin,
         dep: [],
         env: [],
+        from: configPath,
       };
       return;
     }
@@ -186,6 +187,7 @@ module.exports = {
     plugin.name = name;
     plugin.dep = plugin.dep || [];
     plugin.env = plugin.env || [];
+    plugin.from = configPath;
   },
 
   // Read plugin infomation from package.json and merge

test/fixtures/plugin-from/a/package.json

@@ -0,0 +1,5 @@
+{
+  "eggPlugin": {
+    "name": "a"
+  }
+}

test/fixtures/plugin-from/b/package.json

@@ -0,0 +1,5 @@
+{
+  "eggPlugin": {
+    "name": "b"
+  }
+}

test/fixtures/plugin-from/config/plugin.js

@@ -0,0 +1,3 @@
+'use strict';
+
+exports.a = true;

test/fixtures/plugin-from/framework/config/plugin.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const path = require('path');
+
+module.exports = {
+  a: {
+    enable: false,
+    path: path.join(__dirname, '../../a'),
+  },
+  b: {
+    enable: true,
+    path: path.join(__dirname, '../../b'),
+  },
+};

test/fixtures/plugin-from/framework/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "plugin-from-framework"
+}

test/fixtures/plugin-from/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "plugin-from"
+}

test/loader/mixin/load_plugin.test.js

@@ -6,6 +6,8 @@ const fs = require('fs');
 const mm = require('mm');
 const rimraf = require('rimraf');
 const utils = require('../../utils');
+const EggCore = require('../../..').EggCore;
+const EggLoader = require('../../..').EggLoader;
 
 describe('test/load_plugin.test.js', function() {
 
@@ -25,20 +27,23 @@ describe('test/load_plugin.test.js', function() {
       dep: [],
       env: [],
       path: path.join(baseDir, 'node_modules/b'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
     loader.plugins.c.should.eql({
       enable: true,
       name: 'c',
       dep: [],
       env: [],
       path: path.join(baseDir, 'node_modules/c'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
     loader.plugins.e.should.eql({
       enable: true,
       name: 'e',
       dep: [ 'f' ],
       env: [],
       path: path.join(baseDir, 'plugins/e'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
     loader.orderPlugins.should.be.an.Array;
   });
@@ -57,6 +62,7 @@ describe('test/load_plugin.test.js', function() {
       env: [],
       package: 'rds',
       path: path.join(baseDir, 'node_modules/rds'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
   });
 
@@ -74,6 +80,7 @@ describe('test/load_plugin.test.js', function() {
       dep: [],
       env: [],
       path: path.join(baseDir, 'node_modules/d'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
     should.not.exists(loader.plugins.d);
   });
@@ -92,6 +99,7 @@ describe('test/load_plugin.test.js', function() {
       env: [],
       path: path.join(baseDir, 'plugins/g'),
       version: '1.0.0',
+      from: path.join(baseDir, 'config/plugin.js'),
     });
   });
 
@@ -133,6 +141,7 @@ describe('test/load_plugin.test.js', function() {
       dep: [],
       env: [ 'unittest' ],
       path: path.join(baseDir, 'node_modules/d'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
     loader.plugins.foo.should.eql({
       enable: true,
@@ -339,6 +348,7 @@ describe('test/load_plugin.test.js', function() {
       dep: [ 'd1' ],
       env: [ 'local', 'prod' ],
       path: path.join(baseDir, 'node_modules/a1'),
+      from: path.join(baseDir, 'config/plugin.js'),
     });
   });
 
@@ -383,4 +393,21 @@ describe('test/load_plugin.test.js', function() {
     plugin.name.should.equal('a');
     plugin.path.should.equal(utils.getFilepath('realpath/a'));
   });
+
+  it('should get the defining plugin path in every plugin', () => {
+    app = utils.createApp('plugin-from', {
+      Application: class Application extends EggCore {
+        get [Symbol.for('egg#loader')]() {
+          return EggLoader;
+        }
+        get [Symbol.for('egg#eggPath')]() {
+          return utils.getFilepath('plugin-from/framework');
+        }
+      },
+    });
+    const loader = app.loader;
+    loader.loadPlugin();
+    loader.plugins.a.from.should.equal(utils.getFilepath('plugin-from/config/plugin.js'));
+    loader.plugins.b.from.should.equal(utils.getFilepath('plugin-from/framework/config/plugin.js'));
+  });
 });