diff --git a/sharedPlugins/clusterioMod/dole.js b/plugins/subspace_storage/dole.js similarity index 63% rename from sharedPlugins/clusterioMod/dole.js rename to plugins/subspace_storage/dole.js index 4d732e85..7f2f2b0d 100644 --- a/sharedPlugins/clusterioMod/dole.js +++ b/plugins/subspace_storage/dole.js @@ -1,6 +1,18 @@ const doleNN = require("./dole_nn_base") -const Prometheus = require('prom-client'); +const prometheus = require("lib/prometheus"); + + +const prometheusNNDoleGauge = new prometheus.Gauge( + "clusterio_nn_dole_gauge", + "Current demand being supplied by Neural Network ; 1 means all demand covered, 0.5 means about half of each supply is covered, 0 means no items are given", + { labels: ["resource"] } +); +const prometheusDoleFactorGauge = new prometheus.Gauge( + "clusterio_dole_factor_gauge", + "The current dole division factor for this resource", + { labels: ["resource"] } +); class neuralDole { @@ -17,14 +29,9 @@ class neuralDole { } constructor({ - items, gaugePrefix + items }){ // Set some storage variables for the dole divider - this.prometheusNNDoleGauge = new Prometheus.Gauge({ - name: gaugePrefix+'nn_dole_gauge', - help: 'Current demand being supplied by Neural Network ; 1 means all demand covered, 0.5 means about half of each supply is covered, 0 means no items are given', - labelNames: ["itemName"], - }); this.items = items this.itemsLastTick = new Map(items._items) this.dole = {} @@ -32,32 +39,26 @@ class neuralDole { this.lastRequest = {} this.stats=[] this.debt= {} + } + doMagic() { + for (let [name, count] of this.items._items) { + let magicData = doleNN.Tick( + count, + this.dole[name], + this.itemsLastTick.get(name), + this.getRequestStats(name,5) + ) + this.stats[name]=this.stats[name] || [] + this.stats[name].unshift({req:0,given:0});//stats[name][0] is the one we currently collect + if (this.stats[name].length>10) this.stats[name].pop();//remove if too many samples in stats - setInterval(()=>{ - for (let [name, count] of this.items._items) { - let magicData = doleNN.Tick( - count, - this.dole[name], - this.itemsLastTick.get(name), - this.getRequestStats(name,5) - ) - this.stats[name]=this.stats[name] || [] - this.stats[name].unshift({req:0,given:0});//stats[name][0] is the one we currently collect - if (this.stats[name].length>10) this.stats[name].pop();//remove if too many samples in stats - - this.dole[name] = magicData[0] - // DONE handle magicData[1] for graphing for our users - this.prometheusNNDoleGauge.labels(name).set(magicData[1] || 0); - } - this.itemsLastTick = new Map(this.items._items) - }, 1000) + this.dole[name] = magicData[0] + // DONE handle magicData[1] for graphing for our users + prometheusNNDoleGauge.labels(name).set(magicData[1] || 0); + } + this.itemsLastTick = new Map(this.items._items) } - divider({ - res, - object, - masterConfig, - prometheusImportGauge - }){ + divider(object) { let magicData = doleNN.Dose( object.count, // numReq this.items.getItemCount(object.name), @@ -83,29 +84,18 @@ class neuralDole { // Remove item from DB and send it this.items.removeItem(object.name, magicData[0]); - if (masterConfig.get('log_item_transfers')) { - console.log("removed: " + object.name + " " + magicData[0] + " . " + this.items.getItemCount(object.name) + " and sent to " + object.instanceID + " | " + object.instanceName); - } - prometheusImportGauge.labels(object.instanceID, object.name).inc(Number(magicData[0]) || 0); - res.send({ - name: object.name, - count: magicData[0], - }) + return magicData[0]; } } // If the server regularly can't fulfill requests, this number grows until it can. Then it slowly shrinks back down. let _doleDivisionFactor = {}; function doleDivider({ - itemCount, object, items, - masterConfig, - prometheusDoleFactorGauge, - prometheusImportGauge, - req,res, }){ + let itemCount = items.getItemCount(object.name); const doleDivisionRetardation = 10; //lower rates will equal more dramatic swings const maxDoleDivision = 250; //a higher cap will divide the store more ways, but will take longer to recover as supplies increase @@ -120,19 +110,15 @@ function doleDivider({ if (itemCount > object.count) { //If successful, increase dole _doleDivisionFactor[object.name] = Math.max((_doleDivisionFactor[object.name]||0)||1, 1) - 1; - if (masterConfig.get('log_item_transfers')) { - console.log("removed: " + object.name + " " + object.count + " . " + itemCount + " and sent to " + object.instanceID + " | " + object.instanceName); - } items.removeItem(object.name, object.count) prometheusDoleFactorGauge.labels(object.name).set(_doleDivisionFactor[object.name] || 0); - prometheusImportGauge.labels(object.instanceID, object.name).inc(object.count || 0); - res.send({count: object.count, name: object.name}); + return object.count; } else { // if we didn't have enough, attempt giving out a smaller amount next time _doleDivisionFactor[object.name] = Math.min(maxDoleDivision, Math.max((_doleDivisionFactor[object.name]||0)||1, 1) * 2); prometheusDoleFactorGauge.labels(object.name).set(_doleDivisionFactor[object.name] || 0); - res.send({name:object.name, count:0}); + return 0; //console.log('failure out of ' + object.name + " | " + object.count + " from " + object.instanceID + " ("+object.instanceName+")"); } } diff --git a/sharedPlugins/clusterioMod/dole_nn_base.js b/plugins/subspace_storage/dole_nn_base.js similarity index 100% rename from sharedPlugins/clusterioMod/dole_nn_base.js rename to plugins/subspace_storage/dole_nn_base.js diff --git a/plugins/subspace_storage/info.js b/plugins/subspace_storage/info.js new file mode 100644 index 00000000..dbbfc683 --- /dev/null +++ b/plugins/subspace_storage/info.js @@ -0,0 +1,106 @@ +const link = require("lib/link"); +const config = require("lib/config"); + +class MasterConfigGroup extends config.PluginConfigGroup {} +MasterConfigGroup.groupName = "subspace_storage"; +MasterConfigGroup.define({ + name: "autosave_interval", + title: "Autosave Interval", + description: "Interval the storage is autosaved at in seconds.", + type: "number", + initial_value: 60, +}); +MasterConfigGroup.define({ + name: "division_method", + title: "Division Method", + description: "Method for dividing resource requests between instances.", + type: "string", + enum: ["simple", "dole", "neural_dole"], + initial_value: "simple", +}); +MasterConfigGroup.define({ + name: "log_item_transfers", + title: "Log Item Trassfers", + description: "Spam master console with item transfers done.", + type: "boolean", + initial_value: false, +}); +MasterConfigGroup.finalize(); + +class InstanceConfigGroup extends config.PluginConfigGroup {} +InstanceConfigGroup.groupName = "subspace_storage"; +InstanceConfigGroup.define({ + name: "log_item_transfers", + title: "Log Item Trassfers", + description: "Spam slave console with item transfers done.", + type: "boolean", + initial_value: false, +}); +InstanceConfigGroup.finalize(); + +// JSON schema for subspace storage items +const items = { + type: "array", + items: { + type: "array", + minItems: 2, + maxItems: 2, + items: [ + { type: "string" }, + { type: "integer" }, + ], + }, +} + +module.exports = { + name: "subspace_storage", + title: "Subspace Storage", + description: "Provides shared storage across instances for the Subspace Storage mod", + version: "2.0.0-alpha", + instanceEntrypoint: "instance", + InstanceConfigGroup, + + masterEntrypoint: "master", + MasterConfigGroup, + + messages: { + // XXX this should be a request to be reliable + place: new link.Event({ + type: "subspace_storage:place", + links: ["instance-slave", "slave-master"], + forwardTo: "master", + eventProperties: { + "instance_id": { type: "integer" }, + "items": items, + }, + }), + remove: new link.Request({ + type: "subspace_storage:remove", + links: ["instance-slave", "slave-master"], + forwardTo: "master", + requestProperties: { + "instance_id": { type: "integer" }, + "items": items, + }, + responseProperties: { + "items": items, + }, + }), + getStorage: new link.Request({ + type: "subspace_storage:get_storage", + links: ["instance-slave", "slave-master"], + forwardTo: "master", + responseProperties: { + "items": items, + }, + }), + updateStorage: new link.Event({ + type: "subspace_storage:update_storage", + links: ["master-slave", "slave-instance"], + broadcastTo: "instance", + eventProperties: { + "items": items, + }, + }), + }, +} diff --git a/plugins/subspace_storage/instance.js b/plugins/subspace_storage/instance.js new file mode 100644 index 00000000..5e7c9848 --- /dev/null +++ b/plugins/subspace_storage/instance.js @@ -0,0 +1,94 @@ +const fs = require("fs-extra"); + +const plugin = require("lib/plugin"); +const luaTools = require("lib/luaTools"); + +function unexpectedError(err) { + console.log("Unexpected error in subspace_storage") + console.log("------------------------------------") + console.log(err); +} + +class InstancePlugin extends plugin.BaseInstancePlugin { + async init() { + this.instance.server.on("ipc-subspace_storage:output", (output) => { + this.provideItems(output).catch(unexpectedError); + }); + this.instance.server.on("ipc-subspace_storage:orders", (orders) => { + this.requestItems(orders).catch(unexpectedError); + }); + } + + async onStart() { + this.pingId = setInterval(() => { + this.instance.server.sendRcon( + "/sc __subspace_storage__ global.ticksSinceMasterPinged = 0" + ).catch(unexpectedError); + }, 5000); + + let response = await this.info.messages.getStorage.send(this.instance); + let itemsJson = luaTools.escapeString(JSON.stringify(response.items)); + await this.instance.server.sendRcon(`/sc __subspace_storage__ UpdateInvData("${itemsJson}", true)`); + } + + async onStop() { + clearInterval(this.pingId); + } + + // provide items -------------------------------------------------------------- + async provideItems(items) { + this.info.messages.place.send(this.instance, { + items, + instance_id: this.instance.config.get("instance.id"), + }); + + if (this.instance.config.get("subspace_storage.log_item_transfers")) { + console.log("Exported the following to master:") + console.log(items); + } + } + + // request items -------------------------------------------------------------- + async requestItems(items) { + // Request the items all at once + let response = await this.info.messages.remove.send(this.instance, { + instance_id: this.instance.config.get("instance.id"), + items, + }); + + if (!response.items.length) { + return; + } + + if (this.instance.config.get("subspace_storage.log_item_transfers")) { + console.log("Imported following from master:") + console.log(response.items); + } + + let itemsJson = luaTools.escapeString(JSON.stringify(response.items)); + await this.instance.server.sendRcon(`/sc __subspace_storage__ Import("${itemsJson}")`); + } + + // combinator signals --------------------------------------------------------- + async updateStorageEventHandler(message, event) { + let items = message.data.items; + + // XXX this should be done on the lua side + // Ensure counts don't overflow + for (let item of items) { + if (item[1] > 0x7ffffff) { + item[1] = 0x7ffffff; + } + } + + // XXX this should be moved to instance/clusterio api + items.push(["signal-unixtime", Math.floor(Date.now()/1000)]); + + let itemsJson = luaTools.escapeString(JSON.stringify(items)); + await this.instance.server.sendRcon(`/sc __subspace_storage__ UpdateInvData("${itemsJson}")`); + } +} + +module.exports = { + InstancePlugin, +}; diff --git a/plugins/subspace_storage/master.js b/plugins/subspace_storage/master.js new file mode 100644 index 00000000..8fbd78dd --- /dev/null +++ b/plugins/subspace_storage/master.js @@ -0,0 +1,217 @@ +"use strict"; +const fs = require("fs-extra"); +const path = require("path"); + +const database = require("lib/database"); +const plugin = require("lib/plugin"); +const prometheus = require("lib/prometheus"); + +const routes = require("./routes"); +const dole = require("./dole"); + + +const prometheusExportGauge = new prometheus.Gauge( + "clusterio_export_gauge", + "Resources exported by instance", + { labels: ["instance_id", "resource"] } +); +const prometheusImportGauge = new prometheus.Gauge( + "clusterio_import_gauge", + "Resources imported by instance", + { labels: ["instance_id", "resource"] } +); + + +class MasterPlugin extends plugin.BaseMasterPlugin { + async init() { + this.prometheusMasterInventoryGauge = new prometheus.Gauge( + "clusterio_master_inventory_gauge", + "Amount of resources stored on master", + { labels: ["resource"] } + ); + + this.ui = { + sidebar: [ + { + getHtml: () => ` +
+ Storage +
`, + }, + ], + }; + + this.items = await loadDatabase(this.master.config); + this.itemsLastUpdate = new Map(this.items._items.entries()); + this.autosaveId = setInterval(() => { + saveDatabase(this.master.config, this.items).catch(err => { + console.log("Unexpected error autosaving items in subspace_storage") + console.log("-----------------------------------------------------") + console.log(err); + }); + }, this.master.config.get("subspace_storage.autosave_interval") * 1000); + + this.neuralDole = new dole.neuralDole({ items: this.items }); + this.doleMagicId = setInterval(() => { + if (this.master.config.get("subspace_storage.division_method") === "neural_dole") { + this.neuralDole.doMagic() + } + }, 1000); + + routes.addApiRoutes(this.master.app, this.items, this.metrics.endpointHitCounter); + routes.addWebRoutes(this.master.app); + } + + updateStorage() { + let itemsToUpdate = new Map(); + for (let [name, count] of this.items._items) { + if (this.itemsLastUpdate.get(name) === count) { + continue; + } + itemsToUpdate.set(name, count); + } + + if (!itemsToUpdate.size) { + return; + } + + itemsToUpdate = [...itemsToUpdate.entries()]; + for (let slaveConnection of this.master.slaveConnections.values()) { + this.info.messages.updateStorage.send(slaveConnection, { items: itemsToUpdate }); + } + this.itemsLastUpdate = new Map(this.items._items.entries()); + } + + async getStorageRequestHandler(message) { + return { items: [...this.items._items.entries()] }; + } + + async placeEventHandler(message) { + let instanceId = message.data.instance_id; + + for (let item of message.data.items) { + this.items.addItem(item[0], item[1]); + prometheusExportGauge.labels(String(instanceId), item[0]).inc(item[1]); + } + + this.updateStorage(); + + if (this.master.config.get("subspace_storage.log_item_transfers")) { + console.log(`Imported the following from ${message.data.instance_id}:`) + console.log(message.data.items); + } + } + + async removeRequestHandler(message) { + let method = this.master.config.get("subspace_storage.division_method"); + let instanceId = message.data.instance_id; + + let itemsRemoved = []; + if (method === "simple") { + // Give out as much items as possible until there are 0 left. This + // might lead to one slave getting all the items and the rest nothing. + for (let item of message.data.items) { + let count = this.items.getItemCount(item[0]); + let toRemove = Math.min(count, item[1]); + if (toRemove > 0) { + this.items.removeItem(item[0], toRemove); + itemsRemoved.push([item[0], toRemove]); + } + } + + } else { + let instanceConfig = this.master.db.instances.get(instanceId); + let instanceName = instanceConfig ? instanceConfig.get("instance.name") : "unkonwn"; + + // use fancy neural net to calculate a "fair" dole division rate. + if (method === "neural_dole") { + for (let item of message.data.items) { + let count = neuralDole.divider({ name: item[0], count: item[1], instanceId, instanceName }); + if (count > 0) { + itemsRemoved.push([item[0], count]); + } + } + + // Use dole division. Makes it really slow to drain out the last little bit. + } else if (method === "dole") { + for (let item of message.data.items) { + let count = dole.doleDivider({ + object: { name: item[0], count: item[1], instanceId, instanceName}, + items: this.items, + }); + if (count > 0) { + itemsRemoved.push([item[0], count]); + } + } + + // Should not be possible + } else { + throw Error(`Unkown division_method ${method}`); + } + } + + if (itemsRemoved.length) { + for (let item of itemsRemoved) { + prometheusImportGauge.labels(String(instanceId), item[0]).inc(item[1]); + } + + this.updateStorage(); + + if (itemsRemoved.length && this.master.config.get("subspace_storage.log_item_transfers")) { + console.log(`Exported the following to ${instanceId}`); + console.log(itemsRemoved); + } + } + + return { + items: itemsRemoved, + } + } + + onMetrics() { + if (this.items) { + for (let [key, count] of this.items._items) { + this.prometheusMasterInventoryGauge.labels(key).set(Number(count) || 0); + } + } + } + + async onExit() { + clearInterval(this.autosaveId); + clearInterval(this.doleMagicId); + await saveDatabase(this.master.config, this.items); + } +} + +async function loadDatabase(config) { + let itemsPath = path.resolve(config.get("master.database_directory"), "items.json"); + console.log(`Loading ${itemsPath}`); + try { + let content = await fs.readFile(itemsPath); + return new database.ItemDatabase(JSON.parse(content)); + + } catch (err) { + if (err.code === "ENOENT") { + console.log("Creating new item database"); + return new database.ItemDatabase(); + + } else { + throw err; + } + } +} + +async function saveDatabase(masterConfig, items) { + if (items && items.size < 50000) { + let file = path.resolve(masterConfig.get("master.database_directory"), "items.json"); + console.log(`writing ${file}`); + let content = JSON.stringify(items.serialize()); + await fs.outputFile(file, content); + } else if (items) { + console.error(`Item database too large, not saving (${items.size})`); + } +} + +module.exports = { + MasterPlugin, +}; diff --git a/plugins/subspace_storage/routes.js b/plugins/subspace_storage/routes.js new file mode 100644 index 00000000..9bcfdc2a --- /dev/null +++ b/plugins/subspace_storage/routes.js @@ -0,0 +1,55 @@ +const express = require("express"); +const path = require("path"); + +const authenticate = require("lib/authenticate"); +const prometheus = require("lib/prometheus"); + + +function addWebRoutes(app) { + app.use("/subspace_storage", express.static(path.join(__dirname, "static"))); + app.get("/subspace_storage/storage", (req, res) => { res.render("subspace_storage/views/storage"); }); +} + +function addApiRoutes(app, items, endpointHitCounter) { + + /** + * GET endpoint to read the masters current inventory of items. + * + * @memberof clusterioMaster + * @instance + * @alias api/inventory + * @returns {object[]} JSON [{name:"iron-plate", count:100},{name:"copper-plate",count:5}] + */ + app.get("/api/inventory", function(req, res) { + endpointHitCounter.labels(req.route.path).inc(); + res.header("Access-Control-Allow-Origin", "*"); + res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); + // Check it and send it + var inventory = []; + for (let [name, count] of items._items) { + inventory.push({ name, count }); + } + res.send(JSON.stringify(inventory)); + }); + + /** + * GET endpoint to read the masters inventory as an object with key:value pairs + * + * @memberof clusterioMaster + * @instance + * @alias api/inventoryAsObject + * @returns {object} JSON {"iron-plate":100, "copper-plate":5} + */ + app.get("/api/inventoryAsObject", function(req, res) { + endpointHitCounter.labels(req.route.path).inc(); + res.header("Access-Control-Allow-Origin", "*"); + res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); + // Check it and send it + res.send(JSON.stringify(items.serialise())); + }); +} + +module.exports = { + addWebRoutes, + addApiRoutes, +} diff --git a/plugins/subspace_storage/static/storage.js b/plugins/subspace_storage/static/storage.js new file mode 100644 index 00000000..9a99819d --- /dev/null +++ b/plugins/subspace_storage/static/storage.js @@ -0,0 +1,83 @@ +// function to draw data we recieve from ajax requests +_lastData = []; +function drawcontents(data) { + data = data || _lastData; //Cache data so we can drawcontents without waiting for the server, for the search box. + _lastData = data; + + // allow searching for multiple criteria separated by space + var searchArgs = document.querySelector("#search").value; + searchArgs = searchArgs.trim(); + searchArgs = '(' + searchArgs.replace(/ +/g,")|(") + ')'; + const search = new RegExp(searchArgs, 'i'); + data = data.filter(function(item) { + return search.test(item.name); + }) + + sortByKey(data, "count"); + + const table = document.querySelector("#contents tbody"); //tables have tbody inserted automatically + const rows = table.children; + + //update existing rows or create new ones + data.forEach(function(item, i) { + // format count to have .s in it for large number readability (1,000,000) + item.count = item.count.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ","); + + let row = rows[i]; + if(!row) { + row = document.createElement('tr'); + row.innerHTML = ""; + table.appendChild(row); + } + + const img = row.querySelector('img'); + const imgName = getImageFromName(item.name); + if(img.getAttribute('src') !== imgName) { + img.setAttribute('src',imgName); + } + + const name = row.querySelector('.name'); + if(name.textContent !== item.name) { + name.textContent = item.name; + } + + const count = row.querySelector('.count'); + if(count.textContent !== ''+item.count) { + count.textContent = item.count; + } + }); + + //remove excess rows, for example, after filtering + while (data.length < rows.length) { + table.removeChild(rows[data.length]); + } +} + +// get cluster inventory from master +function updateInventory() { + var xmlhttp = new XMLHttpRequest(); + xmlhttp.onreadystatechange = function() { + if(xmlhttp.readyState == 4 && xmlhttp.status == 200) { + let data = JSON.parse(xmlhttp.responseText); + drawcontents(data); + } + } + xmlhttp.open("GET", "/api/inventory", true); + xmlhttp.send(); +} +if(JSON.parse(localStorage.settings)["Periodically update storage screen"]) { + setInterval(updateInventory, 500); +} else { + updateInventory(); +} + +// function to sort arrays of objects after a keys value +function sortByKey(array, key) { + array.sort(function(a, b) { + return b[key] - a[key]; + }); +} + +document.querySelector("#search").addEventListener('input', function() { + drawcontents(); +}); diff --git a/sharedPlugins/clusterioMod/test/missing.js b/plugins/subspace_storage/test/missing.js similarity index 77% rename from sharedPlugins/clusterioMod/test/missing.js rename to plugins/subspace_storage/test/missing.js index 5b080fef..7eadd460 100644 --- a/sharedPlugins/clusterioMod/test/missing.js +++ b/plugins/subspace_storage/test/missing.js @@ -1,7 +1,7 @@ // These are libraries that does not have any units test, they are // required here in order to track coverage for them. -require('../index'); -require('../masterPlugin'); +require('../instance'); +require('../master'); require('../dole'); require('../dole_nn_base'); diff --git a/plugins/subspace_storage/test/routes.js b/plugins/subspace_storage/test/routes.js new file mode 100644 index 00000000..7fceeef4 --- /dev/null +++ b/plugins/subspace_storage/test/routes.js @@ -0,0 +1,44 @@ +const assert = require("assert").strict; +const express = require("express"); +const bodyParser = require("body-parser"); +const request = require("supertest"); +const jwt = require("jsonwebtoken"); + +const authenticate = require('lib/authenticate'); +const database = require("lib/database"); +const prometheus = require("lib/prometheus"); + +const routes = require("../routes"); + + +const testSecret = "TestSecretDoNotUse"; +authenticate.setAuthSecret(testSecret); + +const token = jwt.sign({ id: "api" }, testSecret, { expiresIn: 600 }); + +describe("subspace_storage endpoints", function() { + const app = express(); + app.use(bodyParser.json({ limit: '10mb', })); + app.use(bodyParser.urlencoded({ parameterLimit: 100000, limit: '10mb', extended: true })); + const items = new database.ItemDatabase(); + items.addItem("steel-plate", 20); + const gauge = new prometheus.Gauge("test_gauge", "test", { labels: ["route"] }); + routes.addApiRoutes(app, items, gauge); + + let persistentMaster = request(app); + describe("#GET /api/inventory", function() { + it("returns the masters current inventory", function() { + return persistentMaster.get("/api/inventory").expect(200).then(function(res) { + let inventory = JSON.parse(res.text); + assert.equal(typeof inventory, "object", "Inventory should be an object"); + assert(inventory.length >= 1, "There should be at least 1 entry in the inventory"); + + let contains20SteelPlate = false; + inventory.forEach(itemStack => { + if(itemStack.name == "steel-plate" && itemStack.count >= 20) contains20SteelPlate = true; + }); + assert(contains20SteelPlate, "Please ensure there are at least 20 steel plate in the inventory") + }); + }); + }); +}); diff --git a/sharedPlugins/clusterioMod/views/storage.ejs b/plugins/subspace_storage/views/storage.ejs similarity index 75% rename from sharedPlugins/clusterioMod/views/storage.ejs rename to plugins/subspace_storage/views/storage.ejs index c274964b..da151dd7 100644 --- a/sharedPlugins/clusterioMod/views/storage.ejs +++ b/plugins/subspace_storage/views/storage.ejs @@ -1,7 +1,7 @@ <%- include("head") %> - + @@ -31,18 +31,10 @@ -
-
-
-
-
- diff --git a/sharedPlugins/clusterioMod/config.js b/sharedPlugins/clusterioMod/config.js deleted file mode 100644 index 3ffae1eb..00000000 --- a/sharedPlugins/clusterioMod/config.js +++ /dev/null @@ -1,10 +0,0 @@ -/* - Clusterio plugin to allow for chat between instances. -*/ -module.exports = { - // Name of package. For display somewhere I guess. - name: "clusterioMod", - version: "1.0.0", - description: "Server side handling of functionality in the clusterio lua mod", - masterPlugin: "masterPlugin.js", -} diff --git a/sharedPlugins/clusterioMod/index.js b/sharedPlugins/clusterioMod/index.js deleted file mode 100644 index 3a845b63..00000000 --- a/sharedPlugins/clusterioMod/index.js +++ /dev/null @@ -1,194 +0,0 @@ -const needle = require("needle"); -const fs = require("fs-extra"); - -const objectOps = require("lib/objectOps"); -const fileOps = require("lib/fileOps"); - -const pluginConfig = require("./config"); - - -function ensureFileSync(path) { - if (!fs.existsSync(path)) { - fs.outputFileSync(path, ""); - } -} - -module.exports = class remoteCommands { - constructor(mergedConfig, messageInterface, extras){ - // Ugly global - global.confirmedOrders = []; - - this.messageInterface = messageInterface; - this.config = mergedConfig; - this.socket = extras.socket; - const that = this; - const instance = process.argv[3]; - const instancedirectory = this.config.instanceDirectory + '/' + instance; - - const needleOptionsWithTokenAuthHeader = { - headers: { - 'x-access-token': this.config.masterAuthToken - }, - }; - - ensureFileSync(instancedirectory + "/script-output/output.txt"); - ensureFileSync(instancedirectory + "/script-output/orders.txt"); - - // provide items -------------------------------------------------------------- - // trigger when something happens to output.txt - fs.watch(instancedirectory + "/script-output/output.txt", function (eventType, filename) { - // get array of lines in file - let items = fs.readFileSync(instancedirectory + "/script-output/output.txt", "utf8").split("\n"); - // if you found anything, reset the file - if (items[0]) { - fs.writeFileSync(instancedirectory + "/script-output/output.txt", ""); - } - for (let i = 0; i < items.length; i++) { - if (items[i]) { - let g = items[i].split(" "); - g[0] = g[0].replace("\u0000", ""); - // console.log("exporting " + JSON.stringify(g)); - // send our entity and count to the master for him to keep track of - needle.post(that.config.masterURL + '/api/place', { - name: g[0], - count: g[1], - instanceName: instance, // name of instance - instanceID: that.config.unique, // a hash computed from the randomly generated rcon password - }, needleOptionsWithTokenAuthHeader, function (err, resp, body) { - if(body == "failure") console.error("#### Export failed! Lost: "+g[1]+" "+g[0]); - if(that.config.logItemTransfers){ - if(body == "success") console.log(`Exported ${g[1]} ${g[0]} to master`); - } - }); - } - } - }); - - // request items -------------------------------------------------------------- - setInterval(function () { - // get array of lines in file - let items = fs.readFileSync(instancedirectory + "/script-output/orders.txt", "utf8").split("\n"); - // if we actually got anything from the file, proceed and reset file - if (items[0]) { - fs.writeFileSync(instancedirectory + "/script-output/orders.txt", ""); - // prepare a package of all our requested items in a more transfer friendly format - var preparedPackage = {}; - for (let i = 0; i < items.length; i++) { - (function (i) { - if (items[i]) { - items[i] = items[i].split(" "); - items[i][0] = items[i][0].replace("\u0000", ""); - items[i][0] = items[i][0].replace(",", ""); - if (preparedPackage[items[i][0]]) { - // if we have buffered some already, sum the new items - if (typeof Number(preparedPackage[items[i][0]].count) == "number" && typeof Number(items[i][1]) == "number") { - preparedPackage[items[i][0]] = { - "name": items[i][0], - "count": Number(preparedPackage[items[i][0]].count) + Number(items[i][1]), - "instanceName":instance, - "instanceID":that.config.unique, - }; - // else just add em in without summing - } else if (typeof Number(items[i][1]) == "number") { - preparedPackage[items[i][0]] = { - "name": items[i][0], - "count": Number(items[i][1]), - "instanceName":instance, - "instanceID":that.config.unique, - }; - } - // this condition will NEVER be triggered but we know how that goes - } else if (typeof Number(items[i][1]) == "number") { - preparedPackage[items[i][0]] = { - "name": items[i][0], - "count": Number(items[i][1]), - "instanceName":instance, - "instanceID":that.config.unique, - }; - } - } - })(i); - } - // request our items, one item at a time - for (let i = 0; i < Object.keys(preparedPackage).length; i++) { - // console.log(preparedPackage[Object.keys(preparedPackage)[i]]); - function callback(err, response, body) { - if (response && response.body && typeof response.body == "object") { - // buffer confirmed orders - confirmedOrders[confirmedOrders.length] = {name:response.body.name,count:response.body.count} - if(that.config.logItemTransfers){ - console.log(`Imported ${response.body.count} ${response.body.name} from master`); - } - } - } - needle.post( - that.config.masterURL + '/api/remove', - preparedPackage[Object.keys(preparedPackage)[i]], - needleOptionsWithTokenAuthHeader, - callback - ); - } - // if we got some confirmed orders - // console.log("Importing " + confirmedOrders.length + " items! " + JSON.stringify(confirmedOrders)); - //if (!(confirmedOrders.length>0)){return;} - let cmd="local t={"; - for(let i=0;i { - needle.get(that.config.masterURL + '/api/inventory', function (err, response, body) { - if(err){ - console.error("Unable to get JSON master/api/inventory, master might be unaccessible"); - } else if (response && response.body) { - // Take the inventory we (hopefully) got and turn it into the format LUA accepts - if(Buffer.isBuffer(response.body)) {console.log(response.body.toString("utf-8")); throw new Error();} // We are probably contacting the wrong webserver - try { - var inventory = JSON.parse(response.body); - var inventoryFrame = {}; - for (let i = 0; i < inventory.length; i++) { - inventoryFrame[inventory[i].name] = Number(inventory[i].count); - if(inventoryFrame[inventory[i].name] >= Math.pow(2, 31)){ - inventoryFrame[inventory[i].name] = Math.pow(2, 30); // set it waaay lower, 31 -1 would probably suffice - } - } - inventoryFrame["signal-unixtime"] = Math.floor(Date.now()/1000); - // console.log("RCONing inventory! " + JSON.stringify(inventoryFrame)); - let first = true; - let cmd="local s={"; - for (let key in inventoryFrame) - { - cmd+='["'+key+'"]='+inventoryFrame[key]+","; - } - if (!(cmd==="local s={")){ - that.messageInterface("/silent-command remote.call('clusterio', 'runcode', '"+(first ? 'global.ticksSinceMasterPinged=0 ':'')+cmd.slice(0, -1)+"}"+ " for name,count in pairs(s) do global.invdata[name]=count end')"); - } - that.messageInterface("/silent-command remote.call('clusterio', 'runcode', 'UpdateInvCombinators()')"); - } catch (e){ - console.log(e); - } - } - }); - }, 1550); - // Make sure world has its worldID - setTimeout(function(){ - messageInterface("/silent-command remote.call('clusterio','setWorldID',"+that.config.unique+")") - }, 20000); - } - async factorioOutput(data){ - - } -} -async function sleep(s){ - return new Promise((resolve, reject) => { - setTimeout(resolve, s*1000); - }); -} diff --git a/sharedPlugins/clusterioMod/masterPlugin.js b/sharedPlugins/clusterioMod/masterPlugin.js deleted file mode 100644 index efbd75ce..00000000 --- a/sharedPlugins/clusterioMod/masterPlugin.js +++ /dev/null @@ -1,101 +0,0 @@ -"use strict"; -const fs = require("fs-extra"); -const path = require("path"); -const Express = require("express"); -const ejs = require("ejs"); - -const database = require("lib/database"); -const routes = require("./routes"); - - -class masterPlugin { - constructor({ - config, pluginConfig, pluginPath, socketio, express, db, Prometheus, prometheusPrefix, endpointHitCounter, - }) { - this.config = config; - this.pluginConfig = pluginConfig; - this.pluginPath = pluginPath; - this.io = socketio; - - this.express = express; - this.db = db, - this.Prometheus = Prometheus; - this.prometheusPrefix = prometheusPrefix; - this.endpointHitCounter = endpointHitCounter; - - this.prometheusMasterInventoryGauge = new Prometheus.Gauge({ - name: prometheusPrefix+'master_inventory_gauge', - help: 'Amount of items stored on master', - labelNames: ["itemName"], - }); - - this.ui = { - sidebar: [ - { - getHtml: () => ` -
- Storage -
`, - }, - ], - }; - } - - onMetrics() { - if (this.items) { - for (let [key, count] of this.items._items) { - this.prometheusMasterInventoryGauge.labels(key).set(Number(count) || 0); - } - } - } - - async onLoadFinish() { - this.items = await loadDatabase(this.config); - this.autosaveId = setInterval(async () => { - await saveDatabase(this.config, this.items); - },this.config.autosaveInterval || 60000); - - routes.addApiRoutes( - this.express, this.config, this.db, this.items, - this.Prometheus, this.prometheusPrefix, this.endpointHitCounter, - ); - - routes.addWebRoutes(this.express); - } - - async onExit(){ - clearInterval(this.autosaveId); - await saveDatabase(this.config, this.items); - } -} - -async function loadDatabase(config) { - let itemsPath = path.resolve(config.databaseDirectory, "items.json"); - console.log(`Loading ${itemsPath}`); - try { - let content = await fs.readFile(itemsPath); - return new database.ItemDatabase(JSON.parse(content)); - - } catch (err) { - if (err.code === "ENOENT") { - console.log("Creating new item database"); - return new database.ItemDatabase(); - - } else { - throw err; - } - } -} - -async function saveDatabase(config, items) { - if (items && items.size < 50000) { - let file = path.resolve(config.databaseDirectory, "items.json"); - console.log(`writing ${file}`); - let content = JSON.stringify(items.serialize()); - await fs.outputFile(file, content); - } else if (items) { - console.error(`Item database too large, not saving (${items.size})`); - } -} - -module.exports = masterPlugin; diff --git a/sharedPlugins/clusterioMod/routes.js b/sharedPlugins/clusterioMod/routes.js deleted file mode 100644 index bd0baece..00000000 --- a/sharedPlugins/clusterioMod/routes.js +++ /dev/null @@ -1,208 +0,0 @@ -const express = require("express"); -const path = require("path"); - -const authenticate = require("lib/authenticate"); - -const dole = require("./dole"); - - -function addWebRoutes(app) { - app.use('/clusterioMod', express.static(path.join(__dirname, 'static'))); - app.get('/clusterioMod/storage', (req, res) => { res.render('clusterioMod/views/storage'); }); -} - -function addApiRoutes( - app, config, db, items, Prometheus, prometheusPrefix, endpointHitCounter, -) { - const prometheusExportGauge = new Prometheus.Gauge({ - name: prometheusPrefix+'export_gauge', - help: 'Items exported by instance', - labelNames: ["instanceID", "itemName"], - }); - const prometheusImportGauge = new Prometheus.Gauge({ - name: prometheusPrefix+'import_gauge', - help: 'Items imported by instance', - labelNames: ["instanceID", "itemName"], - }); - const prometheusDoleFactorGauge = new Prometheus.Gauge({ - name: prometheusPrefix+'dole_factor_gauge', - help: 'The current dole division factor for this item', - labelNames: ["itemName"], - }); - - // Only initialize neural network when it's enabled, otherwise it might override gauge - let neuralDole; - if(config.useNeuralNetDoleDivider) { - neuralDole=new dole.neuralDole({ - db, gaugePrefix: prometheusPrefix - }); - } - - /** - * POST endpoint for storing items in master's inventory. - - * @memberof clusterioMaster - * @instance - * @alias api/place - * @param {itemStack} itemStack the number and type of items to store (see typedef) - * @param {string} [itemStack.instanceID="unknown"] - * the unique/instanceID which is a numerical value for an instance - * @param {string} [itemStack.instanceName="unknown"] - * the name of an instance for identification in statistics, as - * provided when launching it. ex node client start [name] - * @returns {string} status either "success" or "failure" - */ - app.post("/api/place", authenticate.middleware, function(req, res) { - endpointHitCounter.labels(req.route.path).inc(); - res.header("Access-Control-Allow-Origin", "*"); - res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); - let x; - try { - x = JSON.parse(req.body); - } catch (e) { - x = req.body; - } - if(!x.instanceName) { - x.instanceName = "unknown"; - } - if(!x.instanceID) { - x.instanceID = "unknown"; - for (let [instanceID, slave] of db.slaves) { - if(slave.instanceName == req.body.instanceName) { - x.instanceID = instanceID; - break; - } - } - } - if(x.instanceID - && x.instanceName - && !isNaN(Number(x.count)) - && x.name - && typeof x.name == "string"){ - if(config.logItemTransfers){ - console.log("added: " + req.body.name + " " + req.body.count+" from "+x.instanceName+" ("+x.instanceID+")"); - } - // gather statistics - prometheusExportGauge.labels(x.instanceID, req.body.name).inc(Number(req.body.count) || 0); - // save items we get - var count = Number(req.body.count); - items.addItem(req.body.name, count); - - // Attempt confirming - res.send("success"); - } else { - res.send("failure"); - } - }); - - /** - * POST endpoint to remove items from DB when client orders items. - * - * @memberof clusterioMaster - * @instance - * @alias api/remove - * @param {itemStack} itemStack the name of and the number of items to remove (see typedef) - * @param {string} [itemStack.instanceID="unknown"] - * the unique/instanceID which is a numerical value for an instance - * @param {string} [itemStack.instanceName="unknown"] - * the name of an instance for identification in statistics, as - * provided when launching it. ex node client start [name] - * @returns {itemStack} - * the number of items actually removed, may be lower than what was - * asked for due to shortages. - */ - app.post("/api/remove", authenticate.middleware, function(req, res) { - endpointHitCounter.labels(req.route.path).inc(); - res.header("Access-Control-Allow-Origin", "*"); - res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); - // save items we get - var object = req.body; - if(!object.instanceID) { - object.instanceID = "unknown" - } - if(!object.instanceName) { - object.instanceName = "unknown"; - } - if (db.slaves.has(String(object.instanceID))) { - object.instanceName = db.slaves.get(String(object.instanceID)).instanceName; - } - let itemCount = items.getItemCount(object.name); - if ( - (config.disableImportsOfEverythingExceptElectricity === true || config.disableImportsOfEverythingExceptElectricity === "true" ) - && object.name != "electricity" - ) { - if(config.logItemTransfers){ - console.log('failure could not find ' + object.name); - } - res.send({name:object.name, count:0}); - } else if(config.disableFairItemDistribution){ - // Give out as much items as possible until there are 0 left. This might lead to one slave getting all the items and the rest nothing. - let numberToRemove = Math.min(Math.abs(Number(object.count)),itemCount); - items.removeItem(object.name, numberToRemove); - res.send({count: numberToRemove, name: object.name}); - - // track statistics and do graphing things - prometheusImportGauge.labels(object.instanceID, object.name).inc(Number(numberToRemove) || 0); - } else if(config.useNeuralNetDoleDivider){ - // use fancy neural net to calculate a "fair" dole division rate. - neuralDole.divider({ - res, - object, - config, - prometheusImportGauge - }) - } else { - // Use dole division. Makes it really slow to drain out the last little bit. - dole.doleDivider({ - itemCount, - object, - db, - config, - prometheusDoleFactorGauge, - prometheusImportGauge, - req,res, - }) - } - }); - - /** - * GET endpoint to read the masters current inventory of items. - * - * @memberof clusterioMaster - * @instance - * @alias api/inventory - * @returns {object[]} JSON [{name:"iron-plate", count:100},{name:"copper-plate",count:5}] - */ - app.get("/api/inventory", function(req, res) { - endpointHitCounter.labels(req.route.path).inc(); - res.header("Access-Control-Allow-Origin", "*"); - res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); - // Check it and send it - var inventory = []; - for (let [name, count] of items._items) { - inventory.push({ name, count }); - } - res.send(JSON.stringify(inventory)); - }); - - /** - * GET endpoint to read the masters inventory as an object with key:value pairs - * - * @memberof clusterioMaster - * @instance - * @alias api/inventoryAsObject - * @returns {object} JSON {"iron-plate":100, "copper-plate":5} - */ - app.get("/api/inventoryAsObject", function(req, res) { - endpointHitCounter.labels(req.route.path).inc(); - res.header("Access-Control-Allow-Origin", "*"); - res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); - // Check it and send it - res.send(JSON.stringify(items.serialise())); - }); -} - -module.exports = { - addWebRoutes, - addApiRoutes, -} diff --git a/sharedPlugins/clusterioMod/static/storage.js b/sharedPlugins/clusterioMod/static/storage.js deleted file mode 100644 index 0a8f561f..00000000 --- a/sharedPlugins/clusterioMod/static/storage.js +++ /dev/null @@ -1,208 +0,0 @@ -// function to draw data we recieve from ajax requests -_lastData = []; -function drawcontents(data) { - data = data || _lastData; //Cache data so we can drawcontents without waiting for the server, for the search box. - _lastData = data; - - // allow searching for multiple criteria separated by space - var searchArgs = document.querySelector("#search").value; - searchArgs = searchArgs.trim(); - searchArgs = '(' + searchArgs.replace(/ +/g,")|(") + ')'; - const search = new RegExp(searchArgs, 'i'); - data = data.filter(function(item) { - return search.test(item.name); - }) - - sortByKey(data, "count"); - - const table = document.querySelector("#contents tbody"); //tables have tbody inserted automatically - const rows = table.children; - - //update existing rows or create new ones - data.forEach(function(item, i) { - // format count to have .s in it for large number readability (1,000,000) - item.count = item.count.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ","); - - let row = rows[i]; - if(!row) { - row = document.createElement('tr'); - row.innerHTML = ""; - table.appendChild(row); - } - - const img = row.querySelector('img'); - const imgName = getImageFromName(item.name); - if(img.getAttribute('src') !== imgName) { - img.setAttribute('src',imgName); - } - - const name = row.querySelector('.name'); - if(name.textContent !== item.name) { - name.textContent = item.name; - row.onclick = ()=>{ - makeItemGraphs(item.name); - } - } - - const count = row.querySelector('.count'); - if(count.textContent !== ''+item.count) { - count.textContent = item.count; - } - }); - - //remove excess rows, for example, after filtering - while (data.length < rows.length) { - table.removeChild(rows[data.length]); - } -} - -// get cluster inventory from master -function updateInventory() { - var xmlhttp = new XMLHttpRequest(); - xmlhttp.onreadystatechange = function() { - if(xmlhttp.readyState == 4 && xmlhttp.status == 200) { - let data = JSON.parse(xmlhttp.responseText); - drawcontents(data); - } - } - xmlhttp.open("GET", "/api/inventory", true); - xmlhttp.send(); -} -if(JSON.parse(localStorage.settings)["Periodically update storage screen"]) { - setInterval(updateInventory, 500); -} else { - updateInventory(); -} - -// function to sort arrays of objects after a keys value -function sortByKey(array, key) { - array.sort(function(a, b) { - return b[key] - a[key]; - }); -} - -document.querySelector("#search").addEventListener('input', function() { - drawcontents(); -}); - -// Make graph of cluster IO items -/*getJSON("/api/getStats", function(err, data){ - -}*/ -function getItemStatData(item, callback){ - var xhr = new XMLHttpRequest(); - var url = "/api/getStats"; - xhr.open("POST", url, true); - xhr.setRequestHeader("Content-type", "application/json"); - xhr.onreadystatechange = function () { - if (xhr.readyState === 4 && xhr.status === 200) { - var json = JSON.parse(xhr.responseText); - console.log(json.email + ", " + json.password); - callback(json); - } - }; - var requestData = JSON.stringify({ - "statistic": "place", - "itemName": "shit", - }); - xhr.send(data); -} - -function makeItemGraphs(itemName){ - getJSON("/api/slaves", function(err, slaves){ - if(err) throw err; - if(typeof slaves == "string"){ - slaves = JSON.parse(slaves); - } - let instanceIDs = Object.keys(slaves); - let HTML = "" - // Draw in/out chart for unregistered slaves as well - instanceIDs.unshift("unknown"); - instanceIDs.forEach(function(instanceID){ - if(instanceID == "unknown" || Date.now() - slaves[instanceID].time < 120000 || JSON.parse(localStorage.settings)["Display offline slaves"]){ - HTML += '
'; - ["place", "remove"].forEach(statistic => { - console.log("Making chart for "+instanceID+"'s "+statistic+" statistic"); - - setTimeout(function(){ - let xmlhttp = new XMLHttpRequest(); // new HttpRequest instance - xmlhttp.open("POST", "/api/getStats"); - xmlhttp.setRequestHeader("Content-Type", "application/json"); - xmlhttp.onreadystatechange = function(){ - console.log(xmlhttp.status); - if(xmlhttp.readyState === XMLHttpRequest.DONE && xmlhttp.status === 200) { - // console.log(xmlhttp.responseText); - if(isJSON(xmlhttp.responseText) && JSON.parse(xmlhttp.responseText).statusForDebugging === undefined){ - let slaveDisplayName = "unknown"; - try { - slaveDisplayName = slaves[instanceID].instanceName; - } catch(e) {} - let whatGraphIsIt = "Item IO from "; - // if(statistic == "remove") whatGraphIsIt = "Items taken from cluster by"; - - let chartData = JSON.parse(xmlhttp.response).data; - switch(statistic){ - case "place": - chartData.name = "Items exported:"; - break; - case "remove": - chartData.name = "Items imported:"; - break; - } - drawChartWhenCalledTwice(chartData, whatGraphIsIt + " " + slaveDisplayName); - //drawChart(statistic+"contentGraph"+instanceID, [JSON.parse(xmlhttp.response).data], `${whatGraphIsIt} ${slaveDisplayName} (${instanceID}) ${itemName}`); - // console.log(JSON.parse(xmlhttp.response).data); - } - } - } - xmlhttp.send(JSON.stringify({statistic:statistic, itemName:itemName, instanceID:instanceID})); - },1); - }); - let chartLines = []; - function drawChartWhenCalledTwice(data, slaveDisplayName){ - chartLines.push(data); - if(chartLines.length >= 2){ - drawChart("contentGraph"+instanceID, chartLines, `${slaveDisplayName} (${instanceID}) ${itemName}`); - } - } - } - }); - document.querySelector("#graphDisplay > #storageGraphContainer").innerHTML = HTML; - }); -} -let chartsByID = {}; -function drawChart(selector, chartData, title) { - // selector is ID of element, ex "chartContainer" or "-123199123" - console.log(chartData) - chartsByID[selector] = new CanvasJS.Chart(selector, { - title:{ - text: title || "Production graph" - }, - toolTip:{ - shared: true, - // content: "{name}: {y}", - }, - zoomEnabled: true, - axisY:{ - includeZero: true, - }, - legend: { - cursor: "pointer", - itemclick: function (e) { - //console.log("legend click: " + e.dataPointIndex); - //console.log(e); - if (typeof (e.dataSeries.visible) === "undefined" || e.dataSeries.visible) { - e.dataSeries.visible = false; - } else { - e.dataSeries.visible = true; - } - e.chart.render(); - } - }, - data: chartData - }); - chart = chartsByID[selector]; - // console.log(chart) - chart.render(); - return chart; -} diff --git a/sharedPlugins/clusterioMod/test/routes.js b/sharedPlugins/clusterioMod/test/routes.js deleted file mode 100644 index a2872284..00000000 --- a/sharedPlugins/clusterioMod/test/routes.js +++ /dev/null @@ -1,109 +0,0 @@ -const assert = require("assert").strict; -const express = require("express"); -const bodyParser = require("body-parser"); -const request = require("supertest"); -const Prometheus = require('prom-client'); -const jwt = require("jsonwebtoken"); - -const authenticate = require('lib/authenticate'); -const database = require("lib/database"); - -const routes = require("../routes"); - - -const testSecret = "TestSecretDoNotUse"; -authenticate.setAuthSecret(testSecret); - -const token = jwt.sign({ id: "api" }, testSecret, { expiresIn: 600 }); - -describe("clusterioMod endpoints", function() { - const app = express(); - app.use(bodyParser.json({ limit: '10mb', })); - app.use(bodyParser.urlencoded({ parameterLimit: 100000, limit: '10mb', extended: true })); - const config = { - disableFairItemDistribution: true, - }; - const items = new database.ItemDatabase(); - const gauge = new Prometheus.Gauge({ name: 'test_gauge', help: "test", labelNames: ['route'] }); - routes.addApiRoutes(app, config, { slaves: new Map() }, items, Prometheus, "test_", gauge); - - let persistentMaster = request(app); - describe("#POST /api/place", function() { - it("adds an itemStack to the masters inventory", function() { - return persistentMaster.post("/api/place").send({ - name:"steel-plate", - count:20, - instanceName:"unitTest" - }).set( - "X-Access-Token", token - ).expect(200).then(function(res) { - assert.equal(res.text, "success", "something went wrong with the request") - }); - }); - }); - describe("#GET /api/inventory", function() { - it("returns the masters current inventory", function() { - return persistentMaster.get("/api/inventory").expect(200).then(function(res) { - let inventory = JSON.parse(res.text); - assert.equal(typeof inventory, "object", "Inventory should be an object"); - assert(inventory.length >= 1, "There should be at least 1 entry in the inventory"); - - let contains20SteelPlate = false; - inventory.forEach(itemStack => { - if(itemStack.name == "steel-plate" && itemStack.count >= 20) contains20SteelPlate = true; - }); - assert(contains20SteelPlate, "Please ensure there are at least 20 steel plate in the inventory") - }); - }); - }); - describe("#POST /api/remove", function() { - it("returns an itemStack of how many items were removed", function() { - return persistentMaster.post("/api/remove").send({ - name:"steel-plate", - count:10 - }).set( - "X-Access-Token", token - ).expect(200).then(function(res) { - assert.equal(res.body.count, 10, `Expected 10 steel got ${res.text}`); - }); - }); - it("works correctly for items named addItem or removeItem", async function() { - function add(item) { - return persistentMaster.post("/api/place").send({ - name: item, - count: 10 - }).set( - "X-Access-Token", token - ).expect(200).then(function(res) { - assert.equal(res.text, 'success', `/api/place ${item} failed with ${res.text}`); - }) - } - - function remove(item) { - return persistentMaster.post("/api/remove").send({ - name: item, - count: 10 - }).set( - "X-Access-Token", token - ).expect(200).then(function(res) { - assert.deepEqual(res.body, {"name":item,"count":10}); - }); - } - - await Promise.all([add("addItem"), add("removeItem")]); - await Promise.all([remove("addItem"), remove("removeItem")]); - }); - it("returns an empty itemStack if you don't have any of the item you request", function() { - return persistentMaster.post("/api/remove").send({ - name:"imaginaryItem", - count:999999 - }).set( - "X-Access-Token", token - ).expect(200).then(function(res) { - assert.equal(res.body.name, "imaginaryItem", "Make sure body.name is the item we asked for"); - assert.equal(res.body.count, 0, "Count should be 0 since we are asking for something that does not exist anywhere"); - assert.equal(Object.keys(res.body).length, 2, "name and count should be the only keys on this object"); - }); - }); - }); -}); diff --git a/test/integration/clusterio.js b/test/integration/clusterio.js index debd0714..2815856d 100644 --- a/test/integration/clusterio.js +++ b/test/integration/clusterio.js @@ -86,6 +86,9 @@ describe("Integration of Clusterio", function() { it("creates the instance", async function() { await clusterctl._commands.get("create-instance").run({id: 44, name: "test"}, testControl); assert(master._db.instances.has(44), "Instance was not created"); + + // XXX breaks tests. + master._db.instances.get(44).set("subspace_storage.enabled", false); }); });