node-pluginsmanager 2.3.2 → 2.3.6

package/README.md

@@ -93,17 +93,23 @@ interface iPluginManagerOptions {
 
   * ``` on("error", (err: Error) => void) : this ``` fires if an error occurs
 
-  * ``` on("initialized", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)) => void) : this ``` fires if a plugin is initialized
-  * ``` on("allinitialized", () => void) : this ``` fires if all the plugins are initialized
+  * ``` on("loading", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin starts load
+  * ``` on("loaded", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin ends load
+  * ``` on("allloaded", (data?: any) => void) : this ``` fires if all the plugins are loaded
 
-  * ``` on("released", (pluginName: string) => void) : this ``` fires if a plugin is released
-  * ``` on("allreleased", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)) => void) : this ``` fires if all the plugins are released
-  * ``` on("destroyed", (pluginName: string) => void) : this ``` fires if a plugin is destroyed
-  * ``` on("alldestroyed", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)) => void) : this ``` fires if all the plugins are destroyed
+  * ``` on("initializing", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin starts init
+  * ``` on("initialized", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin ends init
+  * ``` on("allinitialized", (data?: any) => void) : this ``` fires if all the plugins are initialized
 
-  * ``` on("installed", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)) => void) : this ``` fires if a plugin is installed
-  * ``` on("updated", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)) => void) : this ``` fires if a plugin is updated
-  * ``` on("uninstalled", (pluginName: string) => void) : this ``` fires if a plugin is uninstalled
+  * ``` on("released", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin is released
+  * ``` on("allreleased", (data?: any) => void) : this ``` fires if all the plugins are released
+
+  * ``` on("destroyed", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is destroyed
+  * ``` on("alldestroyed", (data?: any) => void) : this ``` fires if all the plugins are destroyed
+
+  * ``` on("installed", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is installed
+  * ``` on("updated", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin is updated
+  * ``` on("uninstalled", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is uninstalled
 
 ## Examples
 
@@ -126,9 +132,22 @@ manager
       console.log("--- [event/error] '" + msg.error + "' ---");
   })
 
+  // load
+
+    .on("loading", (pluginName) => {
+      console.log("--- [event/loading] '" + pluginName + "' loading ---");
+    }).on("loaded", (plugin) => {
+      console.log("--- [event/loaded] '" + plugin.name + "' (v" + plugin.version + ") loaded ---");
+    })
+    .on("allloaded", () => {
+      console.log("--- [event/allloaded] all plugins allloaded ---");
+    })
+
   // init
 
-    .on("initialized", (plugin) => {
+    .on("initializing", (plugin) => {
+      console.log("--- [event/initializing] '" + plugin.name + "' (v" + plugin.version + ") initialized ---");
+    }).on("initialized", (plugin) => {
       console.log("--- [event/initialized] '" + plugin.name + "' (v" + plugin.version + ") initialized ---");
     })
     .on("allinitialized", () => {
@@ -143,6 +162,9 @@ manager
     .on("allreleased", () => {
       console.log("--- [event/released] all plugins released ---");
     })
+
+  // destroy
+
     .on("destroyed", (pluginName) => {
       console.log("--- [event/destroyed] '" + pluginName + " destroyed ---");
     })

package/lib/initSortedPlugins.js

@@ -1,9 +1,9 @@
-/*
-	eslint max-params: 0
-*/
-
 "use strict";
 
+// consts
+
+	const MAX_PARALLEL = 5;
+
 // private
 
 	// methods
@@ -17,6 +17,8 @@
 		*/
 		function _initPlugin (plugin, emit, data) {
 
+			emit("initializing", plugin, data);
+
 			return plugin.init(data).then(() => {
 
 				emit("initialized", plugin, data);
@@ -29,22 +31,44 @@
 
 		/**
 		* Load plugins with sort conditions
-		* @param {object} toLoad : plugins to init
+		* @param {object} pluginsToInit : plugins to init
 		* @param {function} emit : emit data function
 		* @param {object} data : data to send
 		* @param {number} i : stepper
 		* @return {Promise} : result operation
 		*/
-		function _initSortedPlugins (toLoad, emit, data, i = 0) {
+		function _initSortedPlugins (pluginsToInit, emit, data, i = 0) {
 
-			return i < toLoad.length ? Promise.resolve().then(() => {
+			return i < pluginsToInit.length ? Promise.resolve().then(() => {
 
-				return _initPlugin(toLoad[i], emit, data);
+				return _initPlugin(pluginsToInit[i], emit, data);
 
 			// loop
 			}).then(() => {
 
-				return _initSortedPlugins(toLoad, emit, data, i + 1);
+				return _initSortedPlugins(pluginsToInit, emit, data, i + 1);
+
+			}) : Promise.resolve();
+
+		}
+
+		/**
+		* Load plugins without sort conditions
+		* @param {object} pluginsToInit : plugins to init
+		* @param {function} emit : emit data function
+		* @param {object} data : data to send
+		* @return {Promise} : result operation
+		*/
+		function _initUnSortedPlugins (pluginsToInit, emit, data) {
+
+			return pluginsToInit.length ? Promise.all(pluginsToInit.splice(0, MAX_PARALLEL).map((p) => {
+
+				return _initPlugin(p, emit, data);
+
+			// loop
+			})).then(() => {
+
+				return _initUnSortedPlugins(pluginsToInit, emit, data);
 
 			}) : Promise.resolve();
 
@@ -52,30 +76,34 @@
 
 // module
 
-module.exports = (plugins, orderedPluginsNames, emit, data) => {
+module.exports = function initSortedPlugins (plugins, orderedPluginsNames, emit, data) {
 
 	// if no plugins, does not run
 	return !plugins.length ? Promise.resolve() : Promise.resolve().then(() => {
 
-		// first, sorted plugins
-		return _initSortedPlugins(orderedPluginsNames.map((pluginName) => {
+		const sortedPlugins = [
+			...plugins.filter((plugin) => {
+				return orderedPluginsNames.includes(plugin.name);
+			})
+		];
 
-			return plugins.find((plugin) => {
-				return plugin.name === pluginName;
-			});
-
-		}), emit, data);
+		// first, sorted plugins
+		return sortedPlugins.length ?
+			_initSortedPlugins(sortedPlugins, emit, data) :
+			Promise.resolve();
 
 	}).then(() => {
 
-		// then, all other plugins, asynchronously
-		return Promise.all(plugins.filter((plugin) => {
-			return !orderedPluginsNames.includes(plugin.name);
-		}).map((plugin) => {
-
-			return _initPlugin(plugin, emit, data);
+		const unsortedPlugin = [
+			...plugins.filter((plugin) => {
+				return !orderedPluginsNames.includes(plugin.name);
+			})
+		];
 
-		}));
+		// then, all other plugins, asynchronously
+		return unsortedPlugin.length ?
+			_initUnSortedPlugins(unsortedPlugin, emit, data) :
+			Promise.resolve();
 
 	});
 

package/lib/loadSortedPlugins.js

@@ -12,6 +12,10 @@
 	// locals
 	const createPluginByDirectory = require(join(__dirname, "createPluginByDirectory.js"));
 
+// consts
+
+	const MAX_PARALLEL = 5;
+
 // private
 
 	// methods
@@ -20,24 +24,26 @@
 		* Load plugins with sort conditions
 		* @param {string} globalDirectory : get plugins directory
 		* @param {string} externalRessourcesDirectory : get ressources directory
-		* @param {string} pluginName : get ressources directory
-		* @param {object} plugins : already loaded plugins
+		* @param {string} pluginFileName : get ressources directory
+		* @param {object} loadedPlugins : already loaded plugins
 		* @param {function} emit : emit data function
 		* @param {function|null} logger : if logger, send it to plugin
 		* @param {object} data : data to send
 		* @return {Promise} : result operation
 		*/
-		function _loadPlugin (globalDirectory, externalRessourcesDirectory, pluginName, plugins, emit, logger, data) {
+		function _loadPlugin (globalDirectory, externalRessourcesDirectory, pluginFileName, loadedPlugins, emit, logger, data) {
 
 			// is already loaded ?
-			const plugin = plugins.find((p) => {
-				return pluginName === p.name;
+			const plugin = loadedPlugins.find((p) => {
+				return pluginFileName === p.name;
 			});
 
 			// is already exists ?
 			return plugin ? Promise.resolve() : Promise.resolve().then(() => {
 
-				const directory = join(globalDirectory, pluginName);
+				emit("loading", pluginFileName, data);
+
+				const directory = join(globalDirectory, pluginFileName);
 
 				return createPluginByDirectory(directory, externalRessourcesDirectory, logger, data);
 
@@ -45,7 +51,7 @@
 			}).then((createdPlugin) => {
 
 				emit("loaded", createdPlugin, data);
-				plugins.push(createdPlugin);
+				loadedPlugins.push(createdPlugin);
 
 				return Promise.resolve();
 
@@ -57,24 +63,50 @@
 		* Load plugins with sort conditions
 		* @param {string} globalDirectory : get plugins directory
 		* @param {string} externalRessourcesDirectory : get ressources directory
-		* @param {Array} toLoad : plugins to load
-		* @param {object} plugins : already loaded plugins
+		* @param {Array} pluginsToLoad : plugins to load
+		* @param {object} loadedPlugins : already loaded plugins
 		* @param {function} emit : emit data function
 		* @param {function|null} logger : if logger, send it to plugin
 		* @param {object} data : data to send
 		* @param {number} i : stepper
 		* @return {Promise} : result operation
 		*/
-		function _loadSortedPlugins (globalDirectory, externalRessourcesDirectory, toLoad, plugins, emit, logger, data, i = 0) {
+		function _loadSortedPlugins (globalDirectory, externalRessourcesDirectory, pluginsToLoad, loadedPlugins, emit, logger, data, i = 0) {
 
-			return i < toLoad.length ? Promise.resolve().then(() => {
+			return i < pluginsToLoad.length ? Promise.resolve().then(() => {
 
-				return _loadPlugin(globalDirectory, externalRessourcesDirectory, toLoad[i], plugins, emit, logger, data);
+				return _loadPlugin(globalDirectory, externalRessourcesDirectory, pluginsToLoad[i], loadedPlugins, emit, logger, data);
 
 			// loop
 			}).then(() => {
 
-				return _loadSortedPlugins(globalDirectory, externalRessourcesDirectory, toLoad, plugins, emit, logger, data, i + 1);
+				return _loadSortedPlugins(globalDirectory, externalRessourcesDirectory, pluginsToLoad, loadedPlugins, emit, logger, data, i + 1);
+
+			}) : Promise.resolve();
+
+		}
+
+		/**
+		* Load plugins without sort conditions
+		* @param {string} globalDirectory : get plugins directory
+		* @param {string} externalRessourcesDirectory : get ressources directory
+		* @param {Array} pluginsToLoad : plugins to load
+		* @param {object} loadedPlugins : already loaded plugins
+		* @param {function} emit : emit data function
+		* @param {function|null} logger : if logger, send it to plugin
+		* @param {object} data : data to send
+		* @return {Promise} : result operation
+		*/
+		function _loadUnSortedPlugins (globalDirectory, externalRessourcesDirectory, pluginsToLoad, loadedPlugins, emit, logger, data) {
+
+			return pluginsToLoad.length ? Promise.all(pluginsToLoad.splice(0, MAX_PARALLEL).map((p) => {
+
+				return _loadPlugin(globalDirectory, externalRessourcesDirectory, p, loadedPlugins, emit, logger, data);
+
+			// loop
+			})).then(() => {
+
+				return _loadUnSortedPlugins(globalDirectory, externalRessourcesDirectory, pluginsToLoad, loadedPlugins, emit, logger, data);
 
 			}) : Promise.resolve();
 
@@ -82,24 +114,36 @@
 
 // module
 
-module.exports = (globalDirectory, externalRessourcesDirectory, files, plugins, orderedPluginsNames, emit, logger, data) => {
+module.exports = function loadSortedPlugins (
+	globalDirectory, externalRessourcesDirectory, files, loadedPlugins, orderedPluginsNames, emit, logger, data
+) {
 
 	// if no files, does not run
 	return !files.length ? Promise.resolve() : Promise.resolve().then(() => {
 
+		const sortedPluginsNames = [
+			...files.filter((pluginName) => {
+				return orderedPluginsNames.includes(pluginName);
+			})
+		];
+
 		// first, sorted plugins
-		return _loadSortedPlugins(globalDirectory, externalRessourcesDirectory, orderedPluginsNames, plugins, emit, logger, data);
+		return sortedPluginsNames.length ?
+			_loadSortedPlugins(globalDirectory, externalRessourcesDirectory, sortedPluginsNames, loadedPlugins, emit, logger, data) :
+			Promise.resolve();
 
 	}).then(() => {
 
-		// then, all other plugins, asynchronously
-		return Promise.all(files.filter((pluginName) => {
-			return !orderedPluginsNames.includes(pluginName);
-		}).map((file) => {
-
-			return _loadPlugin(globalDirectory, externalRessourcesDirectory, file, plugins, emit, logger, data);
+		const unsortedPluginsNames = [
+			...files.filter((pluginName) => {
+				return !orderedPluginsNames.includes(pluginName);
+			})
+		];
 
-		}));
+		// then, all other plugins, asynchronously
+		return unsortedPluginsNames.length ?
+			_loadUnSortedPlugins(globalDirectory, externalRessourcesDirectory, unsortedPluginsNames, loadedPlugins, emit, logger, data) :
+			Promise.resolve();
 
 	});
 

package/lib/main.js

@@ -77,7 +77,7 @@ module.exports = class PluginsManager extends Events {
 
 			getPluginsNames () {
 
-				return this.plugins.map((plugin) => {
+				return [ ...this.plugins ].map((plugin) => {
 					return plugin.name;
 				});
 
@@ -118,6 +118,12 @@ module.exports = class PluginsManager extends Events {
 
 			}
 
+			getOrder () {
+
+				return [ ...this._orderedPluginsNames ];
+
+			}
+
 		// checkers
 
 			checkAllModules () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-pluginsmanager",
-  "version": "2.3.2",
+  "version": "2.3.6",
   "description": "A plugins manager",
   "main": "lib/main.js",
   "typings": "lib/index.d.ts",
@@ -35,25 +35,25 @@
     "url": "https://github.com/Psychopoulet/node-pluginsmanager/issues"
   },
   "dependencies": {
-    "check-version-modules": "1.3.2",
+    "check-version-modules": "1.3.5",
     "node-promfs": "3.7.0"
   },
   "devDependencies": {
-    "@types/node": "15.12.2",
+    "@types/node": "16.11.10",
     "@types/socket.io": "3.0.2",
-    "@types/ws": "7.4.5",
-    "coveralls": "3.1.0",
-    "eslint": "7.28.0",
+    "@types/ws": "8.2.0",
+    "coveralls": "3.1.1",
+    "eslint": "8.3.0",
     "express": "4.17.1",
-    "husky": "6.0.0",
-    "mocha": "9.0.0",
-    "node-pluginsmanager-plugin": "4.4.0",
+    "husky": "7.0.4",
+    "mocha": "9.1.3",
+    "node-pluginsmanager-plugin": "4.7.2",
     "nyc": "15.1.0",
-    "typescript": "4.3.3",
-    "ws": "7.5.0"
+    "typescript": "4.5.2",
+    "ws": "8.3.0"
   },
   "homepage": "https://github.com/Psychopoulet/node-pluginsmanager#readme",
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=12.0.0"
   }
 }