Release 1.2.2

Mark version 1.2.2 for release.

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - "9"
+  - 10
 before_install:
   - sudo apt-get -qq update
   - sudo apt-get install -y curl git tar

CHANGELOG.md

@@ -0,0 +1,41 @@
+Changelog
+=========
+
+Version 1.2.2
+-------------
+
+- Fixed possible crash with modded technologies named the same as a built-in
+  Object prototype property in researchSync.
+- Fixed progress of a current infinite tech carrying over to the next one
+  when researching it and another node completes it in researchSync.
+- Fixed progress of a previous infinite tech from another node being applied
+  to the current one in researchSync.
+- Fixed crash in researchSync when modded technologies are present only on some
+  nodes.
+- Fixed install failing due to bcrypt version less than 3 not being supported
+  on node v10.
+- Reordered install instructions to avoid problem with npm creating files owned
+  by root in the home directory.
+- Swapped curl out with wget in the install instructions as the latter comes
+  pre-installed on Ubuntu.
+
+### Breaking Changes
+
+- Node.js versions below 10 are no longer supported.
+
+
+Version 1.2.1
+-------------
+
+- Updated node-factorio-api to v0.3.8 to fix mod downloads randomly breaking
+  ([#229][#229].)
+- Fixed SIGINT being sent twice to Factorio server when interrupted by CTRL+C
+  on Linux ([#217][#217].)
+- Fixed package.json incorrectly reporting the license as ISC.
+
+[#217]: https://github.com/clusterio/factorioClusterio/issues/217
+[#229]: https://github.com/clusterio/factorioClusterio/issues/229
+
+### Breaking Changes
+
+- Added authentication to the socket.io server running on the master.

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:9.11.2
+FROM node:10
 RUN apt-get update && apt install git curl tar -y
 RUN mkdir factorioClusterio
 

README.md

@@ -8,6 +8,13 @@
 
 Discord for development/support/play: https://discord.gg/5XuDkje
 
+## Important notice
+
+This is the stable branch of the project.  The
+[master branch][http://github.com/clusterio/factorioClusterio/tree/master]
+is undergoing significant changes that breaks compatibility to plugins and
+existing installations and is not recommended for use.
+
 ### Ways to support me/the project:
 
 * Contribute with code/documentation. Always nice to move the project forward
@@ -88,19 +95,21 @@ NodeJS does not support EOL ubuntu releases. Make sure you are on the most recen
 
 Master and all slaves:
 
-    sudo curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
-    sudo apt install -y nodejs python-dev git wget curl tar build-essential
-    sudo npm install pm2 -g
-    git clone https://github.com/Danielv123/factorioClusterio.git
+    wget -qO - https://deb.nodesource.com/setup_10.x | sudo -E bash -
+    sudo apt install -y nodejs python-dev git build-essential
+    git clone -b 1.2.x https://github.com/Danielv123/factorioClusterio.git
     cd factorioClusterio
-    curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64
+    wget -O factorio.tar.gz https://www.factorio.com/get-download/latest/headless/linux64
     tar -xf factorio.tar.gz
     npm install --only=production
     cp config.json.dist config.json
     node ./lib/npmPostinstall.js
 
+downloads and installs nodejs, git and clusterio. To specify a version, change "latest" in the link to a version number like 0.14.21.
 
-downloads and installs nodejs, pm2, git and clusterio. To specify a version, change "latest" in the link to a version number like 0.14.21.
+Optional step (if you want to use pm2):
+
+    sudo npm install pm2 -g
 
 Now you need to edit the `config.json` file. If you skip this step nothing will work.
 Pretty much all the blank fields should be filled in, except on the master where a few can be omitted.
@@ -113,11 +122,12 @@ Pretty much all the blank fields should be filled in, except on the master where
 
 **Master**
 
+    node master.js
+
+Or with pm2 (it's recommened to run it without pm2 first):
+
     pm2 start master.js --name master
 
-OR
-
-    node master.js
 
 **Server Host**
 
@@ -159,7 +169,7 @@ Game Client = The people connecting to the server
 
 **Requirements**
 
-download and install nodeJS 8 or 9 from http://nodejs.org
+download and install nodeJS 10 from http://nodejs.org
 
 download and install git from https://git-scm.com/
 

client.js

@@ -53,6 +53,8 @@ if(!config.masterAuthToken || typeof config.masterAuthToken !== "string"){
 	console.error("Master server now needs an access token for write operations. As clusterio slaves depends \
 	upon this, please add your token to config.json in the field named masterAuthToken. \
 	You can retrieve your auth token from the master in secret-api-token.txt after running it once.");
+	process.exitCode = 1;
+	return;
 }
 const needleOptionsWithTokenAuthHeader = {
 	compressed:true,
@@ -359,7 +361,8 @@ write-data=${ path.resolve(config.instanceDirectory, instance) }\r\n
             '--rcon-port', Number(process.env.RCONPORT) || instconf.clientPort,
             '--rcon-password', instconf.clientPassword,
         ], {
-            'stdio': ['pipe', 'pipe', 'pipe']
+			'stdio': ['pipe', 'pipe', 'pipe'],
+			'detached': process.platform === "linux",
         }
     );
     factorio.stdout.on("data", data => {
@@ -471,7 +474,8 @@ write-data=${ path.resolve(config.instanceDirectory, instance) }\r\n
 				'--server-settings', instancedirectory + '/server-settings.json',
 				'--port', args.port || Number(process.env.FACTORIOPORT) || instanceconfig.factorioPort
 			], {
-				'stdio': ['pipe', 'pipe', 'pipe']
+				'stdio': ['pipe', 'pipe', 'pipe'],
+				'detached': process.platform === "linux",
 			}
 		);
 
@@ -570,7 +574,10 @@ async function instanceManagement(instanceconfig) {
     console.log("Started instanceManagement();");
 
     /* Open websocket connection to master */
-	var socket = ioClient("http://"+config.masterIP+":"+config.masterPort);
+	var socket = ioClient("http://"+config.masterIP+":"+config.masterPort+"?token="+config.masterAuthToken);
+	socket.on("error", err => {
+		console.log("SOCKET | Error: ", err);
+	});
 	socket.on("hello", data => {
 		console.log("SOCKET | registering slave!");
 		socket.emit("registerSlave", {

config.json.dist

@@ -14,7 +14,7 @@
 	"masterPort": 8080,
 	
 	"__commentsslPort": "HTTPS port for the master to listen to. Set to 0 or an empty string to not listen for HTTPS.",
-	"sslPort": 443,
+	"sslPort": 0,
 	"sslCert": "database/certificates/cert.crt",
 	"sslPrivKey": "database/certificates/cert.key",
 	

master.js

@@ -921,6 +921,18 @@ class wsSlave {
 	}
 }
 
+io.use((socket, next) => {
+	let token = socket.handshake.query.token;
+	authenticate.check(token).then((result) => {
+		if (result.ok) {
+			next();
+		} else {
+			console.error(`SOCKET | authentication failed for ${socket.handshake.address}`);
+			next(new Error(result.msg));
+		}
+	});
+});
+
 io.on('connection', function (socket) {
 	// cleanup dead sockets from disconnected people
 	let terminatedConnections = 0;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "clusterio",
-  "version": "1.7.0",
+  "version": "1.2.2",
   "description": "Interserver communication for factorio",
   "repository": "https://github.com/Danielv123/factorioClusterio",
   "main": "master.js",
@@ -15,12 +15,15 @@
     "factorio"
   ],
   "author": "Danielv123",
-  "license": "ISC",
+  "license": "MIT",
+  "engines": {
+    "node": ">=10"
+  },
   "dependencies": {
     "as-table": "^1.0.31",
     "averaged-timeseries": "^1.4.0",
     "base64url": "^3.0.0",
-    "bcrypt": "^2.0.1",
+    "bcrypt": "^3.0.6",
     "bcrypt-promise": "^2.0.0",
     "body-parser": "^1.18.2",
     "cli": "^1.0.1",
@@ -46,7 +49,7 @@
     "moment": "^2.22.2",
     "ncp": "^2.0.0",
     "needle": "^2.2.4",
-    "node-factorio-api": "^0.3.5",
+    "node-factorio-api": "^0.3.8",
     "node-forge": "^0.7.1",
     "prom-client": "^10.2.3",
     "rcon-client-fork": "^3.2.0",

sharedPlugins/researchSync/enableResearch.lua

@@ -11,15 +11,22 @@ local function updateTech()
     end
 end
 
-if game.forces['player'].technologies['{tech_name}'] then
+local force = game.forces['player']
+local tech = force.technologies['{tech_name}']
+if tech then
     if 1 == {tech_infinite} then
-        if (game.forces['player'].technologies['{tech_name}'].level ~= level) then
-            game.forces['player'].technologies['{tech_name}'].level = {tech_level}
+        if (tech.level ~= level) then
+            tech.level = {tech_level}
+            if tech == force.current_research then
+                force.research_progress = {tech_progress}
+            else
+                force.set_saved_technology_progress(tech.name, {tech_progress});
+            end
             updateTech()
         end
     else
-        if not game.forces['player'].technologies['{tech_name}'].researched then
-            game.forces['player'].technologies['{tech_name}'].researched = true
+        if not tech.researched then
+            tech.researched = true
             updateTech()
         end
     end

sharedPlugins/researchSync/index.js

@@ -169,21 +169,24 @@ class ResearchSync {
         })
     }
 
-    clear_contribution_to_researched_techs() {
-        // if between updates tech was researched
-        if (!this.prev_research)
-            return
-        for (let [name, research] of Object.entries(this.research)) {
-            let researched
-            if (research.infinite)
-                researched = this.prev_research[name].level < research.level
-            else
-                researched = this.prev_research[name].researched < research.researched
+	clear_contribution_to_researched_techs() {
+		for (let [name, tech] of Object.entries(this.research)) {
+			if (!Object.hasOwnProperty.call(this.prev_research, name)) {
+				continue;
+			}
 
-            if (researched)
-                research.contribution = 0
-        }
-    }
+			let researched;
+			if (tech.infinite) {
+				researched = this.prev_research[name].level < tech.level;
+			} else {
+				researched = this.prev_research[name].researched < tech.researched;
+			}
+
+			if (researched) {
+				tech.contribution = 0;
+			}
+		}
+	}
 
     get_cluster_techs(slavesData) {
         let cluster_techs = {}
@@ -193,7 +196,7 @@ class ResearchSync {
                 if (isNaN(node_tech.researched) || isNaN(node_tech.level) || isNaN(node_tech.infinite))
                     continue
 
-                if (cluster_techs[name]) {
+                if (Object.hasOwnProperty.call(cluster_techs, name)) {
                     if (cluster_techs[name].infinite === 1 && cluster_techs[name].level < node_tech.level) {
                         cluster_techs[name].level = node_tech.level
                     } else if (node_tech.researched > cluster_techs[name].researched) {
@@ -208,65 +211,85 @@ class ResearchSync {
     }
 
     recount_cluster_research_progress(slaves_data, cluster_researches) {
-        for (let [name, research] of Object.entries(cluster_researches))
-            research.progress = this.research[name].contribution
+		for (let [name, tech] of Object.entries(cluster_researches)) {
+			if (Object.hasOwnProperty.call(this.research, name)) {
+				tech.progress = this.research[name].contribution
+			} else {
+				tech.progress = 0;
+			}
+		}
 
         for (let slave_data of slaves_data) {
-            for (let [name, research] of Object.entries(slave_data.meta.research)) {
-                if (!cluster_researches[name])
-                    continue
-                if (isNaN(cluster_researches[name].progress)
-                    || isNaN(research.contribution)
-                    || isNaN(research.level)
-                    || isNaN(cluster_researches[name].level))
-                    continue
-                if (cluster_researches[name].level === research.level)
-                    cluster_researches[name].progress += research.contribution
+            for (let [name, tech] of Object.entries(slave_data.meta.research)) {
+				if (!Object.hasOwnProperty.call(cluster_researches, name)) {
+					continue;
+				}
+
+				if (
+					isNaN(cluster_researches[name].progress)
+					|| isNaN(tech.contribution)
+					|| isNaN(tech.level)
+					|| isNaN(cluster_researches[name].level)
+				) {
+					continue;
+				}
+
+				if (cluster_researches[name].level === tech.level) {
+					cluster_researches[name].progress += tech.contribution;
+				}
             }
         }
 
-        for (let [name, research] of Object.entries(cluster_researches)) {
-            if (research.progress > 1) {
-                research.progress = null
-                research.researched = 1
+		for (let [name, tech] of Object.entries(cluster_researches)) {
+			if (Object.hasOwnProperty.call(this.research, name) && tech.progress > 1) {
+				tech.progress = null
+				tech.researched = 1
                 this.research[name].contribution = 0
-                research.contribution = 0
-                if (this.research[name].level >= research.level)
-                    research.level = this.research[name].level + 1
+				tech.contribution = 0
+				if (this.research[name].level >= tech.level)
+					tech.level = this.research[name].level + 1
             }
         }
     }
 
     filter_researched_techs(cluster_researches) {
-        let local_researches = this.research
         let result = {};
-        for (let key in local_researches) {
-            if (!cluster_researches[key])
-                continue
-            if (isNaN(cluster_researches[key].researched) || isNaN(cluster_researches[key].level))
+		for (let [name, tech] of Object.entries(this.research)) {
+			if (!Object.hasOwnProperty.call(cluster_researches, name)) {
+				continue;
+			}
+
+			if (isNaN(cluster_researches[name].researched) || isNaN(cluster_researches[name].level))
                 continue
 
             let researched
-            if (local_researches[key].infinite)
-                researched = local_researches[key].level < cluster_researches[key].level
-            else
-                researched = local_researches[key].researched < cluster_researches[key].researched
+			if (tech.infinite) {
+				researched = tech.level < cluster_researches[name].level;
+			} else {
+				researched = tech.researched < cluster_researches[name].researched;
+			}
 
             if (researched)
-                result[key] = cluster_researches[key]
+                result[name] = cluster_researches[name]
         }
         return result;
     }
 
     filter_updated_techs(cluster_techs, to_research) {
-        let local_techs = this.research
         let result = {}
-        for (let name in local_techs) {
-            if (name in to_research || !cluster_techs[name])
-                continue
+		for (let [name, tech] of Object.entries(this.research)) {
+			if (Object.hasOwnProperty.call(to_research, name) || !Object.hasOwnProperty.call(cluster_techs, name)) {
+				continue;
+			}
             if (isNaN(cluster_techs[name].progress))
                 continue
-            if (local_techs[name].progress < cluster_techs[name].progress)
+
+			// Do not update progress for infinite techs with a local level that's higher.
+			if (tech.infinite && tech.level > cluster_techs[name].level) {
+				continue;
+			}
+
+            if (tech.progress < cluster_techs[name].progress)
                 result[name] = cluster_techs[name]
         }
         return result
@@ -274,8 +297,9 @@ class ResearchSync {
 
     research_technologies(to_research) {
         for (let name of Object.keys(to_research))
-            if (!this.research[name])
-                delete to_research[name]
+			if (!Object.hasOwnProperty.call(this.research, name)) {
+				delete to_research[name];
+			}
 
         const notify = Object.keys(to_research).length === 1
         for (let [name, tech] of Object.entries(to_research)) {
@@ -283,9 +307,9 @@ class ResearchSync {
             this.research[name].progress = null
             let command = this.functions.enableResearch;
             command = command.replace(/{tech_name}/g, name);
-            command = command.replace(/{tech_researched}/g, tech.researched);
             command = command.replace(/{tech_level}/g, tech.level);
             command = command.replace(/{tech_infinite}/g, tech.infinite);
+            command = command.replace(/{tech_progress}/g, tech.progress)
             command = command.replace(/{notify}/g, notify);
             this.messageInterface(command);
             let log_message = tech.infinite
@@ -299,8 +323,9 @@ class ResearchSync {
 
     update_technologies_progress(to_update) {
         for (let [name, tech] of Object.entries(to_update)) {
-            if (!this.research[name])
-                continue
+			if (!Object.hasOwnProperty.call(this.research, name)) {
+				continue;
+			}
             let progress = this.research[name].progress
             if (progress === null)
                 progress = 'nil'
@@ -317,11 +342,10 @@ class ResearchSync {
     }
 
     print_own_contribution() {
-        if (!this.prev_research)
-            return
         for (let [name, tech] of Object.entries(this.research)) {
-            if (!this.prev_research[name])
-                continue
+			if (!Object.hasOwnProperty.call(this.prev_research, name)) {
+				continue;
+			}
             let diff = this.research[name].contribution - this.prev_research[name].contribution
             if (Math.abs(diff) > Number.EPSILON * 1000)
                 this.log(`Own research ${name}: ${this.research[name].progress} += ${diff}`)
@@ -346,8 +370,10 @@ class ResearchSync {
 
         if (isNaN(level) || isNaN(researched))
             return
-        this.prev_research[name] = this.research[name]
-        if (!this.prev_research[name]) {
+
+		if (Object.hasOwnProperty.call(this.research, name)) {
+			this.prev_research[name] = this.research[name];
+		} else {
             this.prev_research[name] = {
                 researched: null,
                 level: null,