Remove getLua and getCommand from clusterTools

Remove the unused and badly behaved getCommand and getLua functions from
clusterTools.  The main issue with these is that encourage the use of
large commands that have negative impact on the performance of the
servers, as such large commands have to be transmitted to all players
that are connected.  These functions also have poor handling of lua
comments and will fail on strings containing for example "--".

CHANGELOG.md

@@ -51,6 +51,9 @@ Version 2.0.0
   directory inside the instance folder.
 - Hotpatch scenarios and code loading is no longer compatible with Clusterio.
   Breaks playerManager, serverSelect, and tranTeleports.
+- Removed getLua and getCommand from lib/clusterTools.  If you need to run
+  more than the most trivial of code in commands use the save patcher and
+  add in a remote interface.
 
 
 Version 1.2.2

lib/clusterTools/getCommand.js

@@ -1,16 +0,0 @@
-const fs = require("fs-extra");
-
-const getLua = require("./getLua.js");
-
-let commandCache;
-module.exports = async function getCommand(file, COMPRESS = true){
-	commandCache = commandCache || {};
-	if(!commandCache[file]){
-		commandCache[file] = await getLua(file);
-		return commandCache[file];
-	} else if(typeof commandCache[file] == "string"){
-		return commandCache[file];
-	} else {
-		throw new Error("Command not found");
-	}
-}

lib/clusterTools/getLua.js

@@ -1,40 +0,0 @@
-const fs = require("fs-extra");
-
-module.exports = function getLua(filePath, COMPRESS_LUA = true){
-	return new Promise((resolve, reject) => {
-		fs.readFile(filePath, "utf8", (err, contents) => {
-			if(err){
-				reject(err);
-			} else {
-				// split content into lines
-				contents = contents.split(/\r?\n/);
-
-				// join those lines after making them safe again
-				contents = contents.reduce((acc, val) => {
-					val = val.replace(/\\/g ,'\\\\');
-					// remove leading and trailing spaces
-					val = val.trim();
-					// escape single quotes
-					val = val.replace(/'/g ,'\\\'');
-
-					// remove single line comments
-					let singleLineCommentPosition = val.indexOf("--");
-					let multiLineCommentPosition = val.indexOf("--[[");
-
-					if(multiLineCommentPosition === -1 && singleLineCommentPosition !== -1) {
-						val = val.substr(0, singleLineCommentPosition);
-					}
-
-					return acc + val + '\\n';
-				}, ""); // need the "" or it will not process the first row, potentially leaving a single line comment in that disables the whole code
-
-				// console.log(contents);
-
-				// this takes about 46 ms to minify train_stop_tracking.lua in my tests on an i3 6100u
-				if(COMPRESS_LUA) contents = require("luamin").minify(contents);
-				
-				resolve(contents);
-			}
-		});
-	});
-}

lib/clusterTools/index.js

@@ -1,20 +1,11 @@
 /**
 
 Functions frequently needed from different places in the cluster. Ex:
-  * Loading Lua scripts
   * Getting an instance's displayname from their ID
 
 */
 
 module.exports = ({config} = {}) => ({
-	/**
-		async function to get Lua from a file, remove comments, minify and return.
-		
-		arg1 is the file path
-		arg2 is whether or not to compress the Lua. Makes debugging harder, but reduces bandwidth when many players are online. Recommended for polling commands. Defaults to true.
-		Promise resolves with a string of Lua.
-	*/
-	getLua: require("./getLua.js"),
 	/**
 		async function to get an instances displayname from their instanceID
 		
@@ -22,12 +13,4 @@ module.exports = ({config} = {}) => ({
 		Promise resolves with a string, either the displayName or instanceID if not found.
 	*/
 	getInstanceName: require("./getInstanceName.js")(config),
-	/**
-		async function same as getLua, but using an in memory cache to lower FS operations.
-		
-		arg1 is the file path
-		arg2 is whether or not to compress, default true
-		Promise resolves with a string of Lua.
-	*/
-	getCommand: require("./getCommand.js"),
-})
+})

sharedPlugins/serverManager/index.js

@@ -2,7 +2,6 @@ const needle = require("needle");
 const fs = require("fs-extra");
 
 const pluginConfig = require("./config");
-const COMPRESS_LUA = false;
 
 module.exports = class remoteCommands {
 	constructor(mergedConfig, messageInterface, extras){