factorio-clusterio/plugins/research_sync/controller.js

"use strict";
const fs = require("fs-extra");
const path = require("path");

const libFileOps = require("@clusterio/lib/file_ops");
const libPlugin = require("@clusterio/lib/plugin");
const RateLimiter = require("@clusterio/lib/RateLimiter");


async function loadTechnologies(controllerConfig, logger) {
	let filePath = path.join(controllerConfig.get("controller.database_directory"), "technologies.json");
	logger.verbose(`Loading ${filePath}`);
	try {
		return new Map(JSON.parse(await fs.readFile(filePath)));

	} catch (err) {
		if (err.code === "ENOENT") {
			logger.verbose("Creating new technologies database");
			return new Map();

		}
		throw err;
	}
}

async function saveTechnologies(controllerConfig, technologies, logger) {
	let filePath = path.join(controllerConfig.get("controller.database_directory"), "technologies.json");
	logger.verbose(`writing ${filePath}`);
	await libFileOps.safeOutputFile(filePath, JSON.stringify([...technologies.entries()], null, 4));
}

class ControllerPlugin extends libPlugin.BaseControllerPlugin {
	async init() {
		this.technologies = await loadTechnologies(this.controller.config, this.logger);
		this.progressRateLimiter = new RateLimiter({
			maxRate: 1,
			action: () => this.broadcastProgress(),
		});

		this.lastProgressBroadcast = Date.now();
		this.progressBroadcastId = null;
		this.progressToBroadcast = new Set();
	}

	async onShutdown() {
		this.progressRateLimiter.cancel();
		await saveTechnologies(this.controller.config, this.technologies, this.logger);
	}

	broadcastProgress() {
		let techs = [];
		for (let name of this.progressToBroadcast) {
			let tech = this.technologies.get(name);
			if (tech.progress) {
				techs.push({ name, level: tech.level, progress: tech.progress });
			}
		}
		this.progressToBroadcast.clear();

		this.lastProgressBroadcast = Date.now();
		if (techs.length) {
			this.broadcastEventToHosts(this.info.messages.progress, { technologies: techs });
		}
	}

	async contributionEventHandler(message) {
		let { name, level, contribution } = message.data;
		let tech = this.technologies.get(name);
		if (!tech) {
			tech = { level, progress: 0, researched: false };
			this.technologies.set(name, tech);

		// Ignore contribution to already researched technologies
		} else if (tech.level > level || tech.level === level && tech.researched) {
			return;
		}

		// Handle contributon to the next level of a researched technology
		if (tech.level === level - 1 && tech.researched) {
			tech.researched = false;
			tech.level = level;
		}

		// Ignore contributions to higher levels
		if (tech.level < level) {
			return;
		}

		let newProgress = tech.progress + contribution;
		if (newProgress < 1) {
			tech.progress = newProgress;
			this.progressToBroadcast.add(name);
			this.progressRateLimiter.activate();

		} else {
			tech.researched = true;
			tech.progress = null;
			this.progressToBroadcast.delete(name);

			this.broadcastEventToHosts(this.info.messages.finished, { name, level: tech.level });
		}
	}

	async finishedEventHandler(message) {
		let { name, level } = message.data;
		let tech = this.technologies.get(name);
		if (!tech || tech.level <= level) {
			this.progressToBroadcast.delete(name);
			this.technologies.set(name, { level, progress: null, researched: true });
		}
	}

	async syncTechnologiesRequestHandler(message) {
		function baseLevel(name) {
			let match = /-(\d+)$/.exec(name);
			if (!match) {
				return 1;
			}
			return Number.parseInt(match[1], 10);
		}

		for (let instanceTech of message.data.technologies) {
			let [name, level, progress, researched] = instanceTech;
			let tech = this.technologies.get(name);
			if (!tech) {
				this.technologies.set(name, { level, progress, researched });
				if (progress) {
					this.progressToBroadcast.add(name);
				} else if (researched || baseLevel(name) !== level) {
					this.broadcastEventToHosts(this.info.messages.finished, { name, level });
				}

			} else {
				if (tech.level > level || tech.level === level && tech.researched) {
					continue;
				}

				if (tech.level < level || researched) {
					// Send update if the unlocked level is greater
					if (level - !researched > tech.level - !tech.researched) {
						this.broadcastEventToHosts(this.info.messages.finished, { name, level: level - !researched });
					}
					tech.level = level;
					tech.progress = progress;
					tech.researched = researched;

					if (progress) {
						this.progressToBroadcast.add(name);
					} else {
						this.progressToBroadcast.delete(name);
					}

				} else if (tech.progress < progress) {
					tech.progress = progress;
					this.progressToBroadcast.add(name);
				}
			}
		}
		this.progressRateLimiter.activate();

		let technologies = [];
		for (let [name, tech] of this.technologies) {
			technologies.push([name, tech.level, tech.progress, tech.researched]);
		}

		return { technologies };
	}
}


module.exports = {
	ControllerPlugin,
};