@clusterio/plugin-subspace_storage/instance.ts

Clusterio plugin for sharing storage between Factorio servers

import * as lib from "@clusterio/lib";
import { BaseInstancePlugin } from "@clusterio/host";

import {
	PlaceEvent,
	RemoveRequest,
	GetStorageRequest,
	UpdateStorageEvent,
	Item,
} from "./messages";

type IpcItems = [name: string, count: number, quality: string][];

export class InstancePlugin extends BaseInstancePlugin {
	pendingTasks!: Set<any>;
	pingId?: ReturnType<typeof setTimeout>;
	timeUpdateId?: ReturnType<typeof setInterval>;
	cachedInventoryItems: Item[] = [];

	unexpectedError(err: Error) {
		this.logger.error(`Unexpected error:\n${err.stack}`);
	}

	async init() {
		if (!this.instance.config.get("factorio.enable_script_commands")) {
			throw new Error("subspace_storage plugin requires script commands.");
		}

		this.pendingTasks = new Set();
		this.instance.server.on("ipc-subspace_storage:output", (output: IpcItems) => {
			this.logger.info("Received output items:");
			this.logger.info(JSON.stringify(output));
			this.provideItems(output).catch(err => this.unexpectedError(err));
		});
		this.instance.server.on("ipc-subspace_storage:orders", (orders: IpcItems) => {
			if (this.instance.status !== "running" || !this.host.connected) {
				return;
			}

			let task = this.requestItems(orders).catch(err => this.unexpectedError(err));
			this.pendingTasks.add(task);
			task.finally(() => { this.pendingTasks.delete(task); });
		});

		this.instance.handle(UpdateStorageEvent, this.handleUpdateStorageEvent.bind(this));
	}

	async onStart() {
		this.pingId = setInterval(() => {
			if (!this.host.connected) {
				return; // Only ping if we are actually connected to the controller.
			}
			this.sendRcon(
				"/sc __subspace_storage__ global.ticksSinceMasterPinged = 0", true
			).catch(err => this.unexpectedError(err));
		}, 5000);

		let items = await this.instance.sendTo("controller", new GetStorageRequest());

        // Cache items for periodic time updates
		this.cachedInventoryItems = items;

        // Ensure a payload with updated time is sent every second
		this.timeUpdateId = setInterval(() => {
			if (this.instance.status !== "running") {
				return;
			}

			const payloadItems = [
				...this.cachedInventoryItems,
				new Item("signal-unixtime", Math.floor(Date.now() / 1000), "normal"),
			];
			const payloadJson = lib.escapeString(JSON.stringify(payloadItems));
			const task = this.sendRcon(`/sc __subspace_storage__ UpdateInvData("${payloadJson}")`, true)
				.catch(err => this.unexpectedError(err));
			this.pendingTasks.add(task);
			task.finally(() => { this.pendingTasks.delete(task); });
		}, 1000);
	}

	async onStop() {
		clearInterval(this.pingId);
		clearInterval(this.timeUpdateId);
		await Promise.all(this.pendingTasks);
	}

	onExit() {
		clearInterval(this.pingId);
		clearInterval(this.timeUpdateId);
	}

	// provide items --------------------------------------------------------------
	async provideItems(items: IpcItems) {
		if (!this.host.connector.hasSession) {
			// For now the items are voided if the controller connection is
			// down, which is no different from the previous behaviour.
			if (this.instance.config.get("subspace_storage.log_item_transfers")) {
				this.logger.verbose("Voided the following items:");
				this.logger.verbose(JSON.stringify(items));
			}
			return;
		}

		const fromIpcItems = items.map(item => new Item(item[0], item[1], item[2]));
		this.instance.sendTo("controller", new PlaceEvent(fromIpcItems));

		if (this.instance.config.get("subspace_storage.log_item_transfers")) {
			this.logger.verbose("Exported the following to controller:");
			this.logger.verbose(JSON.stringify(items));
		}
	}

	// request items --------------------------------------------------------------
	async requestItems(requestItems: IpcItems) {
		this.logger.info(`Requesting items: ${JSON.stringify(requestItems)}`);
		// Request the items all at once
		const fromIpcItems = requestItems.map(item => new Item(item[0], item[1], item[2]));
		let items = await this.instance.sendTo("controller", new RemoveRequest(fromIpcItems));

		if (!items.length) {
			return;
		}

		if (this.instance.config.get("subspace_storage.log_item_transfers")) {
			this.logger.verbose("Imported following from controller:");
			this.logger.verbose(JSON.stringify(items));
		}

		let itemsJson = lib.escapeString(JSON.stringify(items));
		await this.sendRcon(`/sc __subspace_storage__ Import("${itemsJson}")`, true);
	}

	// combinator signals ---------------------------------------------------------
	async handleUpdateStorageEvent(event: UpdateStorageEvent) {
		if (this.instance.status !== "running") {
			return;
		}
        // Cache latest inventory from controller
		this.cachedInventoryItems = event.items;
	}
}