Merge pull request #131 from JsSucks/plugin-depenencies

Plugin depenencies

client/src/modules/contentmanager.js

@@ -154,7 +154,7 @@ export default class {
                 mainPath
             }
 
-            const content = await this.loadContent(paths, configs, readConfig.info, readConfig.main);
+            const content = await this.loadContent(paths, configs, readConfig.info, readConfig.main, readConfig.dependencies);
             if (reload) this.localContent[index] = content;
             else this.localContent.push(content);
             return content;

client/src/modules/pluginmanager.js

@@ -9,6 +9,7 @@
 */
 
 import ContentManager from './contentmanager';
+import ExtModuleManager from './extmodulemanager';
 import Plugin from './plugin';
 import PluginApi from './pluginapi';
 import Vendor from './vendor';
@@ -44,8 +45,22 @@ export default class extends ContentManager {
     static get refreshPlugins() { return this.refreshContent }
 
     static get loadContent() { return this.loadPlugin }
-    static async loadPlugin(paths, configs, info, main) {
-        const plugin = window.require(paths.mainPath)(Plugin, new PluginApi(info), Vendor);
+    static async loadPlugin(paths, configs, info, main, dependencies) {
+
+        const deps = [];
+        if (dependencies) {
+            for (const [key, value] of Object.entries(dependencies)) {
+                const extModule = ExtModuleManager.findModule(key);
+                if (!extModule) {
+                    throw {
+                        'message': `Dependency: ${key}:${value} is not loaded`
+                    };
+                }
+                deps[key] = extModule.__require;
+            }
+        }
+
+        const plugin = window.require(paths.mainPath)(Plugin, new PluginApi(info), Vendor, deps);
         const instance = new plugin({ configs, info, main, paths: { contentPath: paths.contentPath, dirName: paths.dirName, mainPath: paths.mainPath } });
         return instance;
     }

tests/plugins/Depend Error Test/config.json

@@ -0,0 +1,16 @@
+{
+    "info": {
+        "id": "depend-error",
+        "name": "Depend Error",
+        "authors": [ "Jiiks" ],
+        "version": 1.0,
+        "description": "Depend Error Plugin Description",
+        "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iQ2FscXVlXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IiB2aWV3Qm94PSIwIDAgMjAwMCAyMDAwIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCAyMDAwIDIwMDAiIHhtbDpzcGFjZT0icHJlc2VydmUiPjxnPjxwYXRoIGZpbGw9IiMzRTgyRTUiIGQ9Ik0xNDAyLjIsNjMxLjdjLTkuNy0zNTMuNC0yODYuMi00OTYtNjQyLjYtNDk2SDY4LjR2NzE0LjFsNDQyLDM5OFY0OTAuN2gyNTdjMjc0LjUsMCwyNzQuNSwzNDQuOSwwLDM0NC45SDU5Ny42djMyOS41aDE2OS44YzI3NC41LDAsMjc0LjUsMzQ0LjgsMCwzNDQuOGgtNjk5djM1NC45aDY5MS4yYzM1Ni4zLDAsNjMyLjgtMTQyLjYsNjQyLjYtNDk2YzAtMTYyLjYtNDQuNS0yODQuMS0xMjIuOS0zNjguNkMxMzU3LjcsOTE1LjgsMTQwMi4yLDc5NC4zLDE0MDIuMiw2MzEuN3oiLz48cGF0aCBmaWxsPSIjRkZGRkZGIiBkPSJNMTI2Mi41LDEzNS4yTDEyNjIuNSwxMzUuMmwtNzYuOCwwYzI2LjYsMTMuMyw1MS43LDI4LjEsNzUsNDQuM2M3MC43LDQ5LjEsMTI2LjEsMTExLjUsMTY0LjYsMTg1LjNjMzkuOSw3Ni42LDYxLjUsMTY1LjYsNjQuMywyNjQuNmwwLDEuMnYxLjJjMCwxNDEuMSwwLDU5Ni4xLDAsNzM3LjF2MS4ybDAsMS4yYy0yLjcsOTktMjQuMywxODgtNjQuMywyNjQuNmMtMzguNSw3My44LTkzLjgsMTM2LjItMTY0LjYsMTg1LjNjLTIyLjYsMTUuNy00Ni45LDMwLjEtNzIuNiw0My4xaDcyLjVjMzQ2LjIsMS45LDY3MS0xNzEuMiw2NzEtNTY3LjlWNzE2LjdDMTkzMy41LDMxMi4yLDE2MDguNywxMzUuMiwxMjYyLjUsMTM1LjJ6Ii8+PC9nPjwvc3ZnPg=="
+    },
+    "main": "index.js",
+    "type": "plugin", 
+    "dependencies": {
+        "Nonexistent Module": "1.0" 
+    }, 
+    "defaultConfig": []
+}

tests/plugins/Depend Error Test/index.js

@@ -0,0 +1,12 @@
+module.exports = (Plugin, Api, Vendor) => {
+
+    return class extends Plugin {
+        onStart() {
+            return true;
+        }
+
+        onStop() {
+            return true;
+        }
+    }
+}

tests/plugins/Example/config.json

@@ -9,6 +9,9 @@
     },
     "main": "index.js",
     "type": "plugin", 
+    "dependencies": {
+        "Example Module": "1.0" 
+    }, 
     "defaultConfig": [
         {
             "category_default_comment": "default category has no header and is always displayed first",

tests/plugins/Example/index.js

@@ -1,4 +1,4 @@
-module.exports = (Plugin, Api, Vendor) => {
+module.exports = (Plugin, Api, Vendor, Dependencies) => {
 
     const { $, moment, _ } = Vendor;
     const { Events, Logger } = Api;
@@ -21,7 +21,7 @@ module.exports = (Plugin, Api, Vendor) => {
                 console.log('Received internal setting update:', event);
             });
 
-            const exampleModule = new (Api.import('Example Module'));
+            const exampleModule = new Dependencies['Example Module'];
             Logger.log(`2+4=${exampleModule.add(2, 4)}`);
             return true;
         }