From 04948588865cd55b9b29e082843fd8209128a207 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Sat, 7 Nov 2020 18:36:41 +0100 Subject: [PATCH] Move loadPluginInfos out of lib/plugin.js Move the code for loading plugins infos from Node.js packages into a separate module in order to break it out from lib/plugin.js which is also used on the web interface side. This resolves a warning of using an expression with require on the webpack build. --- packages/ctl/ctl.js | 3 +- packages/lib/plugin.js | 43 ------------------------- packages/lib/plugin_loader.js | 52 ++++++++++++++++++++++++++++++ packages/master/master.js | 3 +- packages/slave/slave.js | 3 +- test/lib/plugin.js | 52 ------------------------------ test/lib/plugin_loader.js | 59 +++++++++++++++++++++++++++++++++++ 7 files changed, 117 insertions(+), 98 deletions(-) create mode 100644 packages/lib/plugin_loader.js create mode 100644 test/lib/plugin_loader.js diff --git a/packages/ctl/ctl.js b/packages/ctl/ctl.js index 51e94f35..7c41f0fc 100755 --- a/packages/ctl/ctl.js +++ b/packages/ctl/ctl.js @@ -17,6 +17,7 @@ const libLink = require("@clusterio/lib/link"); const libErrors = require("@clusterio/lib/errors"); const libConfig = require("@clusterio/lib/config"); const libPlugin = require("@clusterio/lib/plugin"); +const libPluginLoader = require("@clusterio/lib/plugin_loader"); const libCommand = require("@clusterio/lib/command"); const libSharedCommands = require("@clusterio/lib/shared_commands"); @@ -628,7 +629,7 @@ async function startControl() { rootCommands.add(debugCommands); console.log("Loading Plugin info"); - let pluginInfos = await libPlugin.loadPluginInfos(pluginList); + let pluginInfos = await libPluginLoader.loadPluginInfos(pluginList); libConfig.registerPluginConfigGroups(pluginInfos); libConfig.finalizeConfigs(); diff --git a/packages/lib/plugin.js b/packages/lib/plugin.js index 3fe5a9f3..5444ba23 100644 --- a/packages/lib/plugin.js +++ b/packages/lib/plugin.js @@ -3,9 +3,6 @@ * @module lib/plugin */ "use strict"; -const path = require("path"); - -const libErrors = require("@clusterio/lib/errors"); /** @@ -386,45 +383,6 @@ class BaseControlPlugin { async addCommands(rootCommand) { } } -/** - * Load plugin information - * - * Loads plugin info modules for the paths to the given plugins. Once - * loaded the info modules will not be reloaded should this function be - * called again. - * - * @param {Map} pluginList - - * Mapping of plugin name to require path for the plugins to load. - * @returns {Array} Array of plugin info modules. - * @static - */ -async function loadPluginInfos(pluginList) { - let plugins = []; - for (let [pluginName, pluginPath] of pluginList) { - let pluginInfo; - let pluginPackage; - - try { - pluginInfo = require(path.posix.join(pluginPath, "info")); - pluginPackage = require(path.posix.join(pluginPath, "package.json")); - - } catch (err) { - throw new libErrors.PluginError(pluginName, err); - } - - if (pluginInfo.name !== pluginName) { - throw new libErrors.EnvironmentError( - `Expected plugin at ${pluginPath} to be named ${pluginName} but got ${pluginInfo.name}` - ); - } - - pluginInfo.requirePath = pluginPath; - pluginInfo.version = pluginPackage.version; - plugins.push(pluginInfo); - } - return plugins; -} - /** * Attach plugin messages * @@ -485,7 +443,6 @@ module.exports = { BaseMasterPlugin, BaseControlPlugin, - loadPluginInfos, attachPluginMessages, invokeHook, }; diff --git a/packages/lib/plugin_loader.js b/packages/lib/plugin_loader.js new file mode 100644 index 00000000..8307eef4 --- /dev/null +++ b/packages/lib/plugin_loader.js @@ -0,0 +1,52 @@ +/** + * Helpers for loading plugins in Node.js + * @module lib/plugin_loader + */ +"use strict"; + +const libErrors = require("@clusterio/lib/errors"); +const path = require("path"); + + +/** + * Load plugin information + * + * Loads plugin info modules for the paths to the given plugins. Once + * loaded the info modules will not be reloaded should this function be + * called again. + * + * @param {Map} pluginList - + * Mapping of plugin name to require path for the plugins to load. + * @returns {Array} Array of plugin info modules. + * @static + */ +async function loadPluginInfos(pluginList) { + let plugins = []; + for (let [pluginName, pluginPath] of pluginList) { + let pluginInfo; + let pluginPackage; + + try { + pluginInfo = require(path.posix.join(pluginPath, "info")); + pluginPackage = require(path.posix.join(pluginPath, "package.json")); + + } catch (err) { + throw new libErrors.PluginError(pluginName, err); + } + + if (pluginInfo.name !== pluginName) { + throw new libErrors.EnvironmentError( + `Expected plugin at ${pluginPath} to be named ${pluginName} but got ${pluginInfo.name}` + ); + } + + pluginInfo.requirePath = pluginPath; + pluginInfo.version = pluginPackage.version; + plugins.push(pluginInfo); + } + return plugins; +} + +module.exports = { + loadPluginInfos, +}; diff --git a/packages/master/master.js b/packages/master/master.js index 32827da3..cbdbf0ac 100755 --- a/packages/master/master.js +++ b/packages/master/master.js @@ -49,6 +49,7 @@ const libSchema = require("@clusterio/lib/schema"); const libLink = require("@clusterio/lib/link"); const libErrors = require("@clusterio/lib/errors"); const libPlugin = require("@clusterio/lib/plugin"); +const libPluginLoader = require("@clusterio/lib/plugin_loader"); const libPrometheus = require("@clusterio/lib/prometheus"); const libConfig = require("@clusterio/lib/config"); const libUsers = require("@clusterio/lib/users"); @@ -1611,7 +1612,7 @@ async function startServer() { } console.log("Loading Plugin info"); - pluginInfos = await libPlugin.loadPluginInfos(pluginList); + pluginInfos = await libPluginLoader.loadPluginInfos(pluginList); libConfig.registerPluginConfigGroups(pluginInfos); libConfig.finalizeConfigs(); diff --git a/packages/slave/slave.js b/packages/slave/slave.js index 71974e5f..e6746b69 100755 --- a/packages/slave/slave.js +++ b/packages/slave/slave.js @@ -28,6 +28,7 @@ const libFileOps = require("@clusterio/lib/file_ops"); const libFactorio = require("@clusterio/lib/factorio"); const libLink = require("@clusterio/lib/link"); const libPlugin = require("@clusterio/lib/plugin"); +const libPluginLoader = require("@clusterio/lib/plugin_loader"); const libErrors = require("@clusterio/lib/errors"); const libPrometheus = require("@clusterio/lib/prometheus"); const libLuaTools = require("@clusterio/lib/lua_tools"); @@ -1419,7 +1420,7 @@ async function startSlave() { } console.log("Loading Plugin info"); - let pluginInfos = await libPlugin.loadPluginInfos(pluginList); + let pluginInfos = await libPluginLoader.loadPluginInfos(pluginList); libConfig.registerPluginConfigGroups(pluginInfos); libConfig.finalizeConfigs(); diff --git a/test/lib/plugin.js b/test/lib/plugin.js index 5ef3b34f..2ca64415 100644 --- a/test/lib/plugin.js +++ b/test/lib/plugin.js @@ -1,7 +1,5 @@ "use strict"; const assert = require("assert").strict; -const fs = require("fs-extra"); -const path = require("path"); const mock = require("../mock"); const libLink = require("@clusterio/lib/link"); @@ -41,56 +39,6 @@ describe("lib/plugin", function() { }); }); - describe("loadPluginInfos()", function() { - let baseDir = path.join("temp", "test", "plugin"); - let missingPlugin = path.join(baseDir, "missing_plugin"); - let testPlugin = path.join(baseDir, "test_plugin"); - let brokenPlugin = path.join(baseDir, "broken_plugin"); - let invalidPlugin = path.join(baseDir, "invalid_plugin"); - before(async function() { - async function writePlugin(pluginPath, infoName) { - await fs.outputFile( - path.join(pluginPath, "info.js"), - `module.exports = { name: "${infoName}" };` - ); - await fs.outputFile( - path.join(pluginPath, "package.json"), - '{ "version": "0.0.1" }' - ); - } - - await writePlugin(testPlugin, "test"); - await writePlugin(brokenPlugin, "broken"); - await fs.outputFile(path.join(brokenPlugin, "info.js"), "Syntax Error"); - await writePlugin(invalidPlugin, "wrong"); - }); - - it("should throw on missing plugin", async function() { - await assert.rejects( - libPlugin.loadPluginInfos(new Map([["missing", missingPlugin]]), []), - new RegExp(`^Error: PluginError: Cannot find module '${missingPlugin}/info'`) - ); - }); - it("should load test plugin", async function() { - assert.deepEqual( - await libPlugin.loadPluginInfos(new Map([["test", path.resolve(testPlugin)]])), - [{ name: "test", version: "0.0.1", requirePath: path.resolve(testPlugin) }] - ); - }); - it("should reject on broken plugin", async function() { - await assert.rejects( - libPlugin.loadPluginInfos(new Map([["broken", path.resolve(brokenPlugin)]])), - { message: "PluginError: Unexpected identifier" } - ); - }); - it("should reject on invalid plugin", async function() { - await assert.rejects( - libPlugin.loadPluginInfos(new Map([["invalid", path.resolve(invalidPlugin)]])), - { message: `Expected plugin at ${path.resolve(invalidPlugin)} to be named invalid but got wrong` } - ); - }); - }); - describe("attachPluginMessages()", function() { let mockLink = new libLink.Link("source", "target", new mock.MockConnector()); let mockEvent = new libLink.Event({ type: "test:test", links: ["target-source"] }); diff --git a/test/lib/plugin_loader.js b/test/lib/plugin_loader.js new file mode 100644 index 00000000..c5ce7332 --- /dev/null +++ b/test/lib/plugin_loader.js @@ -0,0 +1,59 @@ +"use strict"; +const assert = require("assert").strict; +const fs = require("fs-extra"); +const path = require("path"); + +const libPluginLoader = require("@clusterio/lib/plugin_loader"); + + +describe("lib/plugin_loader", function() { + describe("loadPluginInfos()", function() { + let baseDir = path.join("temp", "test", "plugin"); + let missingPlugin = path.join(baseDir, "missing_plugin"); + let testPlugin = path.join(baseDir, "test_plugin"); + let brokenPlugin = path.join(baseDir, "broken_plugin"); + let invalidPlugin = path.join(baseDir, "invalid_plugin"); + before(async function() { + async function writePlugin(pluginPath, infoName) { + await fs.outputFile( + path.join(pluginPath, "info.js"), + `module.exports = { name: "${infoName}" };` + ); + await fs.outputFile( + path.join(pluginPath, "package.json"), + '{ "version": "0.0.1" }' + ); + } + + await writePlugin(testPlugin, "test"); + await writePlugin(brokenPlugin, "broken"); + await fs.outputFile(path.join(brokenPlugin, "info.js"), "Syntax Error"); + await writePlugin(invalidPlugin, "wrong"); + }); + + it("should throw on missing plugin", async function() { + await assert.rejects( + libPluginLoader.loadPluginInfos(new Map([["missing", missingPlugin]]), []), + new RegExp(`^Error: PluginError: Cannot find module '${missingPlugin}/info'`) + ); + }); + it("should load test plugin", async function() { + assert.deepEqual( + await libPluginLoader.loadPluginInfos(new Map([["test", path.resolve(testPlugin)]])), + [{ name: "test", version: "0.0.1", requirePath: path.resolve(testPlugin) }] + ); + }); + it("should reject on broken plugin", async function() { + await assert.rejects( + libPluginLoader.loadPluginInfos(new Map([["broken", path.resolve(brokenPlugin)]])), + { message: "PluginError: Unexpected identifier" } + ); + }); + it("should reject on invalid plugin", async function() { + await assert.rejects( + libPluginLoader.loadPluginInfos(new Map([["invalid", path.resolve(invalidPlugin)]])), + { message: `Expected plugin at ${path.resolve(invalidPlugin)} to be named invalid but got wrong` } + ); + }); + }); +});