factorio-clusterio/lib/plugin.js

/**
 * Plugin interfaces and utilities.
 * @module
 */
"use strict";
const fs = require("fs-extra");
const path = require("path");

const errors = require("lib/errors");


/**
 * Base class for instance plugins
 * @static
 */
class BaseInstancePlugin {
	constructor(info, instance, slave) {
		/**
		 * The plugin's own info module
		 */
		this.info = info;

		/**
		 * Instance the plugin started for
		 * @type {module:slave~Instance}
		 */
		this.instance = instance;

		/**
		 * Slave running the instance
		 *
		 * With the exepction of accessing the slave's config you should
		 * avoid ineracting with the slave object directly.
		 *
		 * @type {module:slave~Slave}
		 */
		this.slave = slave;
	}

	/**
	 * Called immediately after the class is instantiated
	 */
	async init() { }

	/**
	 * Called before collecting Prometheus metrics
	 *
	 * Invoked before the default metrics of prometheus is collected.  Note
	 * that since this is done while replying to /metrics this should not
	 * take a long time, otherwise the requst will time out.
	 *
	 * Although you can return the results of collecting your prometheus
	 * collectors directly, all gauges in the default registry is already
	 * automatically collected.  It's therefore recommended to only update
	 * the Gauges/Counters/etc in onMetric and let Clusterio deal will
	 * collecting the values.
	 *
	 * @returns an async iterator of prometheus metric results or undefined.
	 */
	async onMetrics() { }

	/**
	 * Called after the Factorio server is started
	 */
	async onStart() { }

	/**
	 * Called before the Factorio server is stopped
	 *
	 * This will not be called if for example the Factorio server crashes or
	 * is killed.
	 */
	async onStop() { }

	/**
	 * Called when the Factorio server exited
	 */
	onExit() { }

	/**
	 * Called when the Factorio outputs a line
	 *
	 * Called when the Factorio server outputs a line on either stdout or
	 * stderr.  The output is a parsed form of the line and contains the
	 * following properties (those marked with ? are optional):
	 *
	 * - source: Where the message came from, one of "stdout" and "stderr".
	 * - format: Timestamp format, one of "date", "seconds" and "none".
	 * - time?: Timestamp of the message.  Not present if format is "none".
	 * - type: Type of message, one of "log", "action" and "generic".
	 * - level?: Log level for "log" type.  i.e "Info" normally.
	 * - file?: File reported for "log" type.
	 * - action?: Kind of action for "action" type. i.e "CHAT" for chat.
	 * - message: Main content of the line.
	 */
	async onOutput(output) { }
}

/**
 * Base class for master plugins
 * @static
 */
class BaseMasterPlugin {
	constructor(info, master, metrics) {
		this.info = info;
		this.master = master;
		this.metrics = metrics;
	}

	/**
	 * Called immediately after the class is instantiated
	 */
	async init() { }

	/**
	 * Called before collecting Prometheus metrics
	 *
	 * Invoked before the default metrics of prometheus is collected.  Note
	 * that since this is done while replying to /metrics this should not
	 * take a long time, otherwise the requst will time out.
	 *
	 * Although you can return the results of collecting your prometheus
	 * collectors directly, all gauges in the default registry is already
	 * automatically collected.  It's therefore recommended to only update
	 * the Gauges/Counters/etc in onMetric and let Clusterio deal will
	 * collecting the values.
	 *
	 * @returns an async iterator of prometheus metric results or undefined.
	 */
	async onMetrics() { }

	/**
	 * Called when the master server is shutting down
	 */
	async onShutdown() { }
}

/**
 * Load plugin information
 *
 * Searches through the plugin directory and loads each plugin's info
 * module.  Once loaded the info modules will not be reloaded should this
 * function be called again.
 *
 * @returns {Map<string, Object>} mapping of plugin name to info module.
 * @static
 */
async function loadPluginInfos(baseDir) {
	let plugins = [];
	for (let pluginDir of await fs.readdir(baseDir)) {
		let pluginInfo;

		try {
			// Note: Require path is relative to this module
			pluginInfo = require(path.posix.join('..', baseDir, pluginDir, 'info'));

		} catch (err) {
			if (err.code === 'MODULE_NOT_FOUND') {
				continue;
			} else {
				throw new errors.PluginError(pluginDir, err);
			}
		}

		if (pluginInfo.name !== pluginDir) {
			throw new errors.EnvironmentError(
				`Plugin dir ${baseDir}/${pluginDir} does not match the name of the plugin (${pluginInfo.name})`
			);
		}

		plugins.push(pluginInfo);
	}
	return plugins;
}

/**
 * Attach plugin messages
 *
 * Attaches all messages defined in the `.message` property of the
 * `pluginInfo` passed with handlers taken from `pluin`.
 *
 * @param {module:lib/link.Link} link - Link to attach handlers to.
 * @param {object} pluginInfo - Plugin info object.
 * @param plugin - The instance of the plugin to use handlers from.
 */
function attachPluginMessages(link, pluginInfo, plugin) {
	let messageDefinitions = pluginInfo.messages || [];
	for (let [name, messageFormat] of Object.entries(messageDefinitions)) {
		let handler = name + messageFormat.constructor.name + 'Handler';
		if (plugin === null || !plugin[handler]) {
			messageFormat.attach(link);

		} else {
			messageFormat.attach(link, async function(message, format) {
				return await plugin[handler](message, format, this);
			});
		}
	}
}


module.exports = {
	BaseInstancePlugin,
	BaseMasterPlugin,

	loadPluginInfos,
	attachPluginMessages,
};