mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-18 23:33:12 +09:00
Rename Master to Controller
The role of the master server as the party controlling every part of the cluster is not well reflected in its name and has caused confusion among users on several occasions. Rename master to controller to better reflects its role.
This commit is contained in:
1 parent
6ae4c8ef46
commit
70ad295a89
119 files changed
+1394
-1376
No files matched your search
@@ -8,6 +8,6 @@ Plugin sharing the in-game chat between instances.
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-global_chat
|
||||
npx clusteriomaster plugin add @clusterio/plugin-global_chat
|
||||
npx clusteriocontroller plugin add @clusterio/plugin-global_chat
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriocontroller with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
@@ -11,8 +11,8 @@ module.exports = {
|
||||
messages: {
|
||||
chat: new libLink.Event({
|
||||
type: "global_chat:chat",
|
||||
links: ["instance-slave", "slave-master", "master-slave", "slave-instance", "control-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller", "controller-slave", "slave-instance", "control-controller"],
|
||||
forwardTo: "controller",
|
||||
broadcastTo: "instance",
|
||||
eventProperties: {
|
||||
"instance_name": { type: "string" },
|
||||
|
||||
@@ -21,7 +21,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
this.messageQueue = [];
|
||||
}
|
||||
|
||||
onMasterConnectionEvent(event) {
|
||||
onControllerConnectionEvent(event) {
|
||||
if (event === "connect") {
|
||||
for (let message of this.messageQueue) {
|
||||
this.sendChat(message);
|
||||
|
||||
@@ -13,9 +13,9 @@ When a server crashes while you are online there won't be time to immediately up
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-inventory_sync
|
||||
npx clusteriomaster plugin add @clusterio/plugin-inventory_sync
|
||||
npx clusteriocontroller plugin add @clusterio/plugin-inventory_sync
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicated slave or ctl installation respectively.
|
||||
Substitute clusteriocontroller with clusterioslave or clusterioctl if this a dedicated slave or ctl installation respectively.
|
||||
|
||||
## Method of operation
|
||||
|
||||
@@ -23,17 +23,17 @@ This plugin does event based synchronization of inventories.
|
||||
The greatly simplified data flow is as follows:
|
||||
|
||||
1. Player joins server.
|
||||
2. Scenario script asks master for exclusive access to the player.
|
||||
3. Master grants exclusive access for the player to the instance.
|
||||
2. Scenario script asks controller for exclusive access to the player.
|
||||
3. Controller grants exclusive access for the player to the instance.
|
||||
4. Scenario script checks the access response and then acts according to the situation:
|
||||
|
||||
1. If the player has no inventory on the master then the current inventory becomes the synced inventory and the process is done.
|
||||
2. If the player inventory was previously uploaded and is the same as the one stored on the master then the current inventory becomes the synced inventory and the process is done.
|
||||
1. If the player has no inventory on the controller then the current inventory becomes the synced inventory and the process is done.
|
||||
2. If the player inventory was previously uploaded and is the same as the one stored on the controller then the current inventory becomes the synced inventory and the process is done.
|
||||
3. If the player inventory was previously uploaded but is not the same then the player inventory is deleted and the player is turned into a spectator.
|
||||
4. Otherwise the player inventory is kept.
|
||||
|
||||
5. Scenario script asks for the player inventory from the master.
|
||||
6. Master sends it to the scenario in a stream of chunks.
|
||||
5. Scenario script asks for the player inventory from the controller.
|
||||
6. Controller sends it to the scenario in a stream of chunks.
|
||||
7. Scenario displays and updates a progress bar as each chunk is received.
|
||||
8. Once all chunks have loaded the player's synced inventory is recreated from the data and the player can start playing.
|
||||
|
||||
@@ -41,5 +41,5 @@ When the player leaves the inventory is uploaded if it's a synced inventory and
|
||||
Should an error occur during this process the player is given the option to use a temporary inventory instead, which will be merged back into the synced inventory the next time the sync succeeds on that instance.
|
||||
|
||||
Communication between the server and instance goes over stdout or rcon, depending on the size of the data.
|
||||
Communication between the instance and the master server goes over websockets.
|
||||
Communication between the instance and the controller goes over websockets.
|
||||
Overall, we are able to achieve a latency between 3 and infinite ticks from server join, depending on the size of the inventory. The major limiter is rcon transfer speeds with larger inventories, especially if they contain blueprints.
|
||||
@@ -6,7 +6,7 @@ const libFileOps = require("@clusterio/lib/file_ops");
|
||||
const libPlugin = require("@clusterio/lib/plugin");
|
||||
|
||||
async function loadDatabase(config, logger) {
|
||||
let itemsPath = path.resolve(config.get("master.database_directory"), "inventories.json");
|
||||
let itemsPath = path.resolve(config.get("controller.database_directory"), "inventories.json");
|
||||
logger.verbose(`Loading ${itemsPath}`);
|
||||
try {
|
||||
let content = await fs.readFile(itemsPath);
|
||||
@@ -21,24 +21,24 @@ async function loadDatabase(config, logger) {
|
||||
}
|
||||
}
|
||||
|
||||
async function saveDatabase(masterConfig, playerDatastore, logger) {
|
||||
async function saveDatabase(controllerConfig, playerDatastore, logger) {
|
||||
if (playerDatastore) {
|
||||
let file = path.resolve(masterConfig.get("master.database_directory"), "inventories.json");
|
||||
let file = path.resolve(controllerConfig.get("controller.database_directory"), "inventories.json");
|
||||
logger.verbose(`writing ${file}`);
|
||||
let content = JSON.stringify(Array.from(playerDatastore));
|
||||
await libFileOps.safeOutputFile(file, content);
|
||||
}
|
||||
}
|
||||
|
||||
class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
class ControllerPlugin extends libPlugin.BaseControllerPlugin {
|
||||
async init() {
|
||||
this.acquiredPlayers = new Map();
|
||||
this.playerDatastore = await loadDatabase(this.master.config, this.logger);
|
||||
this.playerDatastore = await loadDatabase(this.controller.config, this.logger);
|
||||
this.autosaveId = setInterval(() => {
|
||||
saveDatabase(this.master.config, this.playerDatastore, this.logger).catch(err => {
|
||||
saveDatabase(this.controller.config, this.playerDatastore, this.logger).catch(err => {
|
||||
this.logger.error(`Unexpected error autosaving player data:\n${err.stack}`);
|
||||
});
|
||||
}, this.master.config.get("inventory_sync.autosave_interval") * 1000);
|
||||
}, this.controller.config.get("inventory_sync.autosave_interval") * 1000);
|
||||
}
|
||||
|
||||
async onInstanceStatusChanged(instance) {
|
||||
@@ -52,7 +52,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
|
||||
if (["unknown", "stopped"].includes(instance.status)) {
|
||||
let timeout = this.master.config.get("inventory_sync.player_lock_timeout") * 1000;
|
||||
let timeout = this.controller.config.get("inventory_sync.player_lock_timeout") * 1000;
|
||||
for (let acquisitonRecord of this.acquiredPlayers.values()) {
|
||||
if (acquisitonRecord.instanceId === instanceId && !acquisitonRecord.expires) {
|
||||
acquisitonRecord.expires = Date.now() + timeout;
|
||||
@@ -74,7 +74,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
if (
|
||||
!acquisitionRecord
|
||||
|| acquisitionRecord.instanceId === instanceId
|
||||
|| !this.master.instances.has(acquisitionRecord.instanceId)
|
||||
|| !this.controller.instances.has(acquisitionRecord.instanceId)
|
||||
|| acquisitionRecord.expires && acquisitionRecord.expires < Date.now()
|
||||
) {
|
||||
this.acquiredPlayers.set(playerName, { instanceId });
|
||||
@@ -88,7 +88,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
let { instance_id, player_name } = message.data;
|
||||
if (!this.acquire(instance_id, player_name)) {
|
||||
let acquisitionRecord = this.acquiredPlayers.get(player_name);
|
||||
let instance = this.master.instances.get(acquisitionRecord.instanceId);
|
||||
let instance = this.controller.instances.get(acquisitionRecord.instanceId);
|
||||
return {
|
||||
status: "busy",
|
||||
message: instance.config.get("instance.name"),
|
||||
@@ -117,7 +117,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
async uploadRequestHandler(message) {
|
||||
let { instance_id, player_name, player_data } = message.data;
|
||||
let instanceName = this.master.instances.get(instance_id).config.get("instance.name");
|
||||
let instanceName = this.controller.instances.get(instance_id).config.get("instance.name");
|
||||
let store = true;
|
||||
let acquisitionRecord = this.acquiredPlayers.get(player_name);
|
||||
if (!acquisitionRecord) {
|
||||
@@ -151,7 +151,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
async downloadRequestHandler(message) {
|
||||
let { instance_id, player_name } = message.data;
|
||||
let instanceName = this.master.instances.get(instance_id).config.get("instance.name");
|
||||
let instanceName = this.controller.instances.get(instance_id).config.get("instance.name");
|
||||
|
||||
let acquisitionRecord = this.acquiredPlayers.get(player_name);
|
||||
if (!acquisitionRecord) {
|
||||
@@ -168,7 +168,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
async onShutdown() {
|
||||
clearInterval(this.autosaveId);
|
||||
await saveDatabase(this.master.config, this.playerDatastore, this.logger);
|
||||
await saveDatabase(this.controller.config, this.playerDatastore, this.logger);
|
||||
}
|
||||
|
||||
async databaseStatsRequestHandler(message) {
|
||||
@@ -190,5 +190,5 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
MasterPlugin,
|
||||
ControllerPlugin,
|
||||
};
|
||||
@@ -1,17 +1,17 @@
|
||||
"use strict";
|
||||
const { libConfig, libLink, libUsers } = require("@clusterio/lib");
|
||||
|
||||
class MasterConfigGroup extends libConfig.PluginConfigGroup { }
|
||||
MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
|
||||
MasterConfigGroup.groupName = "inventory_sync";
|
||||
MasterConfigGroup.define({
|
||||
class ControllerConfigGroup extends libConfig.PluginConfigGroup { }
|
||||
ControllerConfigGroup.defaultAccess = ["controller", "slave", "control"];
|
||||
ControllerConfigGroup.groupName = "inventory_sync";
|
||||
ControllerConfigGroup.define({
|
||||
name: "autosave_interval",
|
||||
title: "Autosave Interval",
|
||||
description: "Interval the player data is autosaved at in seconds.",
|
||||
type: "number",
|
||||
initial_value: 600, // 10 minutes
|
||||
});
|
||||
MasterConfigGroup.define({
|
||||
ControllerConfigGroup.define({
|
||||
name: "player_lock_timeout",
|
||||
title: "Player Lock Timeout",
|
||||
description:
|
||||
@@ -19,10 +19,10 @@ MasterConfigGroup.define({
|
||||
type: "number",
|
||||
initial_value: 60,
|
||||
});
|
||||
MasterConfigGroup.finalize();
|
||||
ControllerConfigGroup.finalize();
|
||||
|
||||
class InstanceConfigGroup extends libConfig.PluginConfigGroup { }
|
||||
InstanceConfigGroup.defaultAccess = ["master", "slave", "control"];
|
||||
InstanceConfigGroup.defaultAccess = ["controller", "slave", "control"];
|
||||
InstanceConfigGroup.groupName = "inventory_sync";
|
||||
InstanceConfigGroup.define({
|
||||
name: "rcon_chunk_size",
|
||||
@@ -48,8 +48,8 @@ module.exports = {
|
||||
instanceEntrypoint: "instance",
|
||||
InstanceConfigGroup,
|
||||
|
||||
masterEntrypoint: "master",
|
||||
MasterConfigGroup,
|
||||
controllerEntrypoint: "controller",
|
||||
ControllerConfigGroup,
|
||||
|
||||
webEntrypoint: "./web",
|
||||
routes: ["/inventory"],
|
||||
@@ -57,8 +57,8 @@ module.exports = {
|
||||
messages: {
|
||||
acquire: new libLink.Request({
|
||||
type: "inventory_sync:acquire",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"instance_id": { type: "integer" },
|
||||
"player_name": { type: "string" },
|
||||
@@ -73,8 +73,8 @@ module.exports = {
|
||||
}),
|
||||
release: new libLink.Request({
|
||||
type: "inventory_sync:release",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"instance_id": { type: "integer" },
|
||||
"player_name": { type: "string" },
|
||||
@@ -82,8 +82,8 @@ module.exports = {
|
||||
}),
|
||||
upload: new libLink.Request({
|
||||
type: "inventory_sync:upload",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"instance_id": { type: "integer" },
|
||||
"player_name": { type: "string" },
|
||||
@@ -92,8 +92,8 @@ module.exports = {
|
||||
}),
|
||||
download: new libLink.Request({
|
||||
type: "inventory_sync:download",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"instance_id": { type: "integer" },
|
||||
"player_name": { type: "string" },
|
||||
@@ -104,7 +104,7 @@ module.exports = {
|
||||
}),
|
||||
databaseStats: new libLink.Request({
|
||||
type: "inventory_sync:databaseStats",
|
||||
links: ["control-master"],
|
||||
links: ["control-controller"],
|
||||
permission: "inventory_sync.inventory.view",
|
||||
responseProperties: {
|
||||
"database_size": { type: "integer" },
|
||||
|
||||
@@ -32,11 +32,11 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
.catch(err => this.logger.error(`Error handling ipc-inventory_sync_download:\n${err.stack}`)));
|
||||
}
|
||||
|
||||
onPrepareMasterDisconnect() {
|
||||
onPrepareControllerDisconnect() {
|
||||
this.disconnecting = true;
|
||||
}
|
||||
|
||||
onMasterConnectionEvent(event) {
|
||||
onControllerConnectionEvent(event) {
|
||||
if (event === "connect") {
|
||||
this.disconnecting = false;
|
||||
(async () => {
|
||||
@@ -60,7 +60,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
let response = {
|
||||
player_name: request.player_name,
|
||||
status: "error",
|
||||
message: "Master is temporarily unavailable",
|
||||
message: "Controller is temporarily unavailable",
|
||||
};
|
||||
|
||||
if (this.slave.connector.connected && !this.disconnecting) {
|
||||
|
||||
@@ -25,8 +25,8 @@ local function download_inventory(player_name, data, number, total)
|
||||
|
||||
if total == 0 then
|
||||
-- Download was requested but the player had no data stored.
|
||||
log("ERROR: Inventory sync failed, got empty player data for " .. player.name .. " from the master")
|
||||
player.print("ERROR: Inventory sync failed, got empty player data from the master")
|
||||
log("ERROR: Inventory sync failed, got empty player data for " .. player.name .. " from the controller")
|
||||
player.print("ERROR: Inventory sync failed, got empty player data from the controller")
|
||||
|
||||
progress_dialog.remove(player)
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@ function dialog_failed_download.create(player, acquire_response)
|
||||
|
||||
local reason
|
||||
if acquire_response.status == "timeout" then
|
||||
reason = "Timed out fetching inventory from the master server."
|
||||
reason = "Timed out fetching inventory from the controller."
|
||||
|
||||
elseif acquire_response.status == "busy" then
|
||||
reason =
|
||||
@@ -58,10 +58,10 @@ function dialog_failed_download.create(player, acquire_response)
|
||||
"If you just logged out from there it might take some time before the inventory is available."
|
||||
|
||||
elseif acquire_response.status == "error" then
|
||||
reason = "Error fetching inventory from the master server: " .. acquire_response.message .. "."
|
||||
reason = "Error fetching inventory from the controller: " .. acquire_response.message .. "."
|
||||
|
||||
else
|
||||
reason = "Unknown status " .. acquire_response.status .. " fetching inventory from the master server."
|
||||
reason = "Unknown status " .. acquire_response.status .. " fetching inventory from the controller."
|
||||
end
|
||||
|
||||
local p1 = content.add {
|
||||
@@ -129,7 +129,7 @@ dialog_failed_download.events = {
|
||||
global.inventory_sync.players[player.name].sync = false
|
||||
|
||||
elseif event.element.name == "inventory_sync_failed_download_retry" then
|
||||
-- Retry acquiring the player from the master
|
||||
-- Retry acquiring the player from the controller
|
||||
local player = game.get_player(event.player_index)
|
||||
inventory_sync.acquire(player)
|
||||
player.gui.screen.dialog_failed_download.destroy()
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
|
||||
Inventory Sync
|
||||
|
||||
When a player leaves the game, serialize the player state and upload it to the master.
|
||||
When a player joins the game, request the player data from master and deserialize the player state from it.
|
||||
When a player leaves the game, serialize the player state and upload it to the controller.
|
||||
When a player joins the game, request the player data from controller and deserialize the player state from it.
|
||||
|
||||
]]
|
||||
|
||||
@@ -23,7 +23,7 @@ end
|
||||
local function create_player(player, dirty)
|
||||
global.inventory_sync.players[player.name] = {
|
||||
dirty = dirty, -- Player inventory has changes that should be persisted
|
||||
sync = false, -- Player inventory is synced from the master
|
||||
sync = false, -- Player inventory is synced from the controller
|
||||
generation = 0,
|
||||
}
|
||||
end
|
||||
@@ -40,7 +40,7 @@ end
|
||||
|
||||
|
||||
inventory_sync = {}
|
||||
-- This function is called by instance.js as /sc inventory_sync.download_inventory("danielv", Escaped JSON string, package_number, total_packages_count) with data from the master
|
||||
-- This function is called by instance.js as /sc inventory_sync.download_inventory("danielv", Escaped JSON string, package_number, total_packages_count) with data from the controller
|
||||
inventory_sync.download_inventory = download_inventory
|
||||
|
||||
-- This function is called internally when a player leaves the game to
|
||||
@@ -280,7 +280,7 @@ function inventory_sync.sync_player(acquire_response)
|
||||
end
|
||||
|
||||
if acquire_response.status == "acquired" then
|
||||
-- The stored data on the master server has changed since the
|
||||
-- The stored data on the controller has changed since the
|
||||
-- download was started. Restart it.
|
||||
game.print("Restarting download")
|
||||
download_record.restart = true
|
||||
@@ -342,7 +342,7 @@ function inventory_sync.finish_download(player, finished_record)
|
||||
player_record.generation = finished_record.generation
|
||||
end
|
||||
|
||||
-- Download inventory from master
|
||||
-- Download inventory from controller
|
||||
inventory_sync.events[defines.events.on_player_joined_game] = function(event)
|
||||
-- Send acquire request even if an active download is currently in plogress
|
||||
local player = game.get_player(event.player_index)
|
||||
@@ -406,7 +406,7 @@ inventory_sync.events[defines.events.on_pre_player_left_game] = function(event)
|
||||
clusterio_api.send_json("inventory_sync_upload", result)
|
||||
end
|
||||
|
||||
-- Invoked by the instance code to confirm the master has received the uploaded data
|
||||
-- Invoked by the instance code to confirm the controller has received the uploaded data
|
||||
function inventory_sync.confirm_upload(player_name, generation)
|
||||
local player = game.get_player(player_name)
|
||||
if not player or player.connected then
|
||||
|
||||
@@ -40,7 +40,7 @@ export class WebPlugin extends libPlugin.BaseWebPlugin {
|
||||
];
|
||||
}
|
||||
|
||||
onMasterConnectionEvent(event) {
|
||||
onControllerConnectionEvent(event) {
|
||||
if (event === "connect") {
|
||||
|
||||
}
|
||||
|
||||
@@ -10,12 +10,12 @@ Once the player enters the second code into the dialog in-game the web interface
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-player_auth
|
||||
npx clusteriomaster plugin add @clusterio/plugin-player_auth
|
||||
npx clusteriocontroller plugin add @clusterio/plugin-player_auth
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriocontroller with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
|
||||
|
||||
## Master Configuration
|
||||
## Controller Configuration
|
||||
|
||||
#### player_auth.code_length
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ async function generateCode(length) {
|
||||
}
|
||||
|
||||
|
||||
class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
class ControllerPlugin extends libPlugin.BaseControllerPlugin {
|
||||
async init() {
|
||||
// Store of validation attempts by players
|
||||
this.players = new Map();
|
||||
@@ -43,9 +43,9 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
}, 60e3).unref();
|
||||
|
||||
this.master.app.get("/api/player_auth/servers", (req, res) => {
|
||||
this.controller.app.get("/api/player_auth/servers", (req, res) => {
|
||||
let servers = [];
|
||||
for (let instance of this.master.instances.values()) {
|
||||
for (let instance of this.controller.instances.values()) {
|
||||
if (instance.status === "running" && instance.config.get("player_auth.load_plugin")) {
|
||||
servers.push(instance.config.get("factorio.settings")["name"] || "unnamed server");
|
||||
}
|
||||
@@ -53,11 +53,11 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
res.send(servers);
|
||||
});
|
||||
|
||||
this.master.app.post("/api/player_auth/player_code", express.json(), (req, res, next) => {
|
||||
this.controller.app.post("/api/player_auth/player_code", express.json(), (req, res, next) => {
|
||||
this.handlePlayerCode(req, res).catch(next);
|
||||
});
|
||||
|
||||
this.master.app.post("/api/player_auth/verify", express.json(), (req, res, next) => {
|
||||
this.controller.app.post("/api/player_auth/verify", express.json(), (req, res, next) => {
|
||||
this.handleVerify(req, res).catch(next);
|
||||
});
|
||||
}
|
||||
@@ -76,8 +76,8 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
for (let entry of this.players.values()) {
|
||||
if (entry.playerCode === playerCode && entry.expires > Date.now()) {
|
||||
let verifyCode = await generateCode(this.master.config.get("player_auth.code_length"));
|
||||
let secret = Buffer.from(this.master.config.get("master.auth_secret"), "base64");
|
||||
let verifyCode = await generateCode(this.controller.config.get("player_auth.code_length"));
|
||||
let secret = Buffer.from(this.controller.config.get("controller.auth_secret"), "base64");
|
||||
let verifyToken = jwt.sign(
|
||||
{
|
||||
aud: "player_auth.verify_code",
|
||||
@@ -120,7 +120,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
return;
|
||||
}
|
||||
|
||||
let secret = Buffer.from(this.master.config.get("master.auth_secret"), "base64");
|
||||
let secret = Buffer.from(this.controller.config.get("controller.auth_secret"), "base64");
|
||||
try {
|
||||
let payload = jwt.verify(verifyToken, secret, { audience: "player_auth.verify_code" });
|
||||
if (payload.verify_code !== verifyCode) {
|
||||
@@ -139,7 +139,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
for (let [player, entry] of this.players) {
|
||||
if (entry.playerCode === playerCode && entry.expires > Date.now()) {
|
||||
if (entry.verifyCode === verifyCode) {
|
||||
let user = this.master.userManager.users.get(player);
|
||||
let user = this.controller.userManager.users.get(player);
|
||||
if (!user) {
|
||||
res.send({ error: true, message: "invalid user" });
|
||||
return;
|
||||
@@ -160,10 +160,10 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
|
||||
async fetchPlayerCodeRequestHandler(message) {
|
||||
let playerCode = await generateCode(this.master.config.get("player_auth.code_length"));
|
||||
let expires = Date.now() + this.master.config.get("player_auth.code_timeout") * 1000;
|
||||
let playerCode = await generateCode(this.controller.config.get("player_auth.code_length"));
|
||||
let expires = Date.now() + this.controller.config.get("player_auth.code_timeout") * 1000;
|
||||
this.players.set(message.data.player, { playerCode, verifyCode: null, expires });
|
||||
return { player_code: playerCode, master_url: this.master.getMasterUrl() };
|
||||
return { player_code: playerCode, controller_url: this.controller.getControllerUrl() };
|
||||
}
|
||||
|
||||
async setVerifyCodeRequestHandler(message) {
|
||||
@@ -182,7 +182,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
MasterPlugin,
|
||||
ControllerPlugin,
|
||||
|
||||
// For testing only
|
||||
_generateCode: generateCode,
|
||||
+13
-13
@@ -2,51 +2,51 @@
|
||||
let { libConfig, libLink } = require("@clusterio/lib");
|
||||
|
||||
|
||||
class MasterConfigGroup extends libConfig.PluginConfigGroup {}
|
||||
MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
|
||||
MasterConfigGroup.groupName = "player_auth";
|
||||
MasterConfigGroup.define({
|
||||
class ControllerConfigGroup extends libConfig.PluginConfigGroup {}
|
||||
ControllerConfigGroup.defaultAccess = ["controller", "slave", "control"];
|
||||
ControllerConfigGroup.groupName = "player_auth";
|
||||
ControllerConfigGroup.define({
|
||||
name: "code_length",
|
||||
title: "Code Length",
|
||||
description: "Length in characters of the generated codes.",
|
||||
type: "number",
|
||||
initial_value: 6,
|
||||
});
|
||||
MasterConfigGroup.define({
|
||||
ControllerConfigGroup.define({
|
||||
name: "code_timeout",
|
||||
title: "Code Timeout",
|
||||
description: "Time in seconds for the generated codes to stay valid.",
|
||||
type: "number",
|
||||
initial_value: 120,
|
||||
});
|
||||
MasterConfigGroup.finalize();
|
||||
ControllerConfigGroup.finalize();
|
||||
|
||||
module.exports = {
|
||||
name: "player_auth",
|
||||
title: "Player Auth",
|
||||
description: "Provides authentication to the cluster via logging into a Factorio server.",
|
||||
masterEntrypoint: "master",
|
||||
controllerEntrypoint: "controller",
|
||||
instanceEntrypoint: "instance",
|
||||
webEntrypoint: "./web",
|
||||
MasterConfigGroup,
|
||||
ControllerConfigGroup,
|
||||
|
||||
messages: {
|
||||
fetchPlayerCode: new libLink.Request({
|
||||
type: "player_auth:fetch_player_code",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"player": { type: "string" },
|
||||
},
|
||||
responseProperties: {
|
||||
"player_code": { type: "string" },
|
||||
"master_url": { type: "string" },
|
||||
"controller_url": { type: "string" },
|
||||
},
|
||||
}),
|
||||
setVerifyCode: new libLink.Request({
|
||||
type: "player_auth:set_verify_code",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"player": { type: "string" },
|
||||
"verify_code": { type: "string" },
|
||||
|
||||
@@ -30,7 +30,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
await this.sendRcon(`/web-login error ${event.player} ${err.message}`);
|
||||
return;
|
||||
}
|
||||
await this.sendRcon(`/web-login open ${event.player} ${response.master_url} ${response.player_code}`);
|
||||
await this.sendRcon(`/web-login open ${event.player} ${response.controller_url} ${response.player_code}`);
|
||||
|
||||
} else if (event.type === "set_verify_code") {
|
||||
try {
|
||||
|
||||
@@ -5,24 +5,24 @@ const jwt = require("jsonwebtoken");
|
||||
|
||||
const mock = require("../../../test/mock");
|
||||
|
||||
const master = require("../master");
|
||||
const controller = require("../controller");
|
||||
const instance = require("../instance");
|
||||
const info = require("../info");
|
||||
const libErrors = require("@clusterio/lib/errors");
|
||||
|
||||
|
||||
describe("player_auth", function() {
|
||||
describe("master.js", function() {
|
||||
describe("controller.js", function() {
|
||||
describe("generateCode()", function() {
|
||||
it("should generate a code of the given length", async function() {
|
||||
let code = await master._generateCode(20);
|
||||
let code = await controller._generateCode(20);
|
||||
assert.equal(typeof code, "string");
|
||||
assert.equal(code.length, 20, "incorrect length");
|
||||
});
|
||||
it("should only use the easy to recognize letters in the alphabet", async function() {
|
||||
let chars = new Set();
|
||||
for (let i = 0; i < 20; i++) {
|
||||
let code = await master._generateCode(15);
|
||||
let code = await controller._generateCode(15);
|
||||
for (let char of code) {
|
||||
chars.add(char);
|
||||
}
|
||||
@@ -35,25 +35,25 @@ describe("player_auth", function() {
|
||||
});
|
||||
});
|
||||
|
||||
describe("MasterPlugin", function() {
|
||||
let masterPlugin;
|
||||
let masterUrl;
|
||||
describe("ControllerPlugin", function() {
|
||||
let controllerPlugin;
|
||||
let controllerUrl;
|
||||
before(async function() {
|
||||
masterPlugin = await mock.createMasterPlugin(master.MasterPlugin, info);
|
||||
masterPlugin.master.mockConfigEntries.set("player_auth.code_length", 10);
|
||||
masterPlugin.master.mockConfigEntries.set("player_auth.code_timeout", 1);
|
||||
masterUrl = await masterPlugin.master.startServer();
|
||||
controllerPlugin = await mock.createControllerPlugin(controller.ControllerPlugin, info);
|
||||
controllerPlugin.controller.mockConfigEntries.set("player_auth.code_length", 10);
|
||||
controllerPlugin.controller.mockConfigEntries.set("player_auth.code_timeout", 1);
|
||||
controllerUrl = await controllerPlugin.controller.startServer();
|
||||
});
|
||||
after(async function() {
|
||||
if (masterPlugin) {
|
||||
await masterPlugin.master.stopServer();
|
||||
if (controllerPlugin) {
|
||||
await controllerPlugin.controller.stopServer();
|
||||
}
|
||||
});
|
||||
|
||||
describe("/api/player_auth/servers", function() {
|
||||
it("should return a list of running servers with player_auth loaded", async function() {
|
||||
function addInstance(id, status, load, name) {
|
||||
masterPlugin.master.instances.set(id, {
|
||||
controllerPlugin.controller.instances.set(id, {
|
||||
config: {
|
||||
get(field) {
|
||||
if (field === "player_auth.load_plugin") {
|
||||
@@ -73,12 +73,12 @@ describe("player_auth", function() {
|
||||
addInstance(4, "stopped", false, "stopped unloaded");
|
||||
addInstance(5, "running", true, undefined);
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/servers`,
|
||||
url: `${controllerUrl}/api/player_auth/servers`,
|
||||
parse: "json",
|
||||
});
|
||||
assert.deepEqual(result.body, ["running loaded", "unnamed server"]);
|
||||
for (let id of [1, 2, 3, 4, 5]) {
|
||||
masterPlugin.master.instances.delete(id);
|
||||
controllerPlugin.controller.instances.delete(id);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -86,7 +86,7 @@ describe("player_auth", function() {
|
||||
describe("/api/player_auth/player_code", function() {
|
||||
it("should return 400 on invalid json", async function() {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/player_code`,
|
||||
url: `${controllerUrl}/api/player_auth/player_code`,
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
@@ -98,7 +98,7 @@ describe("player_auth", function() {
|
||||
it("should return 400 on valid json which is not an object", async function() {
|
||||
for (let obj of [true, false, null, "string", 123, ["an", "array"]]) {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/player_code`,
|
||||
url: `${controllerUrl}/api/player_auth/player_code`,
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
@@ -111,7 +111,7 @@ describe("player_auth", function() {
|
||||
it("should return 400 if player_code is not a string", async function() {
|
||||
for (let obj of [true, false, null, 123, [], {}]) {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/player_code`,
|
||||
url: `${controllerUrl}/api/player_auth/player_code`,
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
@@ -123,9 +123,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should return invalid player_code if the code is expired", async function() {
|
||||
let expires = Date.now() - 1000;
|
||||
masterPlugin.players.set("expired", { playerCode: "expried", verifyCode: null, expires });
|
||||
controllerPlugin.players.set("expired", { playerCode: "expried", verifyCode: null, expires });
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/player_code`,
|
||||
url: `${controllerUrl}/api/player_auth/player_code`,
|
||||
method: "POST",
|
||||
data: { player_code: "expired" },
|
||||
parse: "json",
|
||||
@@ -134,9 +134,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should return a verify code and token if code is valid", async function() {
|
||||
let expires = Date.now() + 1000;
|
||||
masterPlugin.players.set("valid", { playerCode: "valid", verifyCode: null, expires });
|
||||
controllerPlugin.players.set("valid", { playerCode: "valid", verifyCode: null, expires });
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/player_code`,
|
||||
url: `${controllerUrl}/api/player_auth/player_code`,
|
||||
method: "POST",
|
||||
data: { player_code: "valid" },
|
||||
parse: "json",
|
||||
@@ -149,7 +149,7 @@ describe("player_auth", function() {
|
||||
describe("/api/player_auth/verify", function() {
|
||||
it("should return 400 on invalid json", async function() {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
@@ -161,7 +161,7 @@ describe("player_auth", function() {
|
||||
it("should return 400 on valid json which is not an object", async function() {
|
||||
for (let obj of [true, false, null, "string", 123, ["an", "array"]]) {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
@@ -175,7 +175,7 @@ describe("player_auth", function() {
|
||||
for (let obj of [true, false, null, 123, [], {}]) {
|
||||
for (let field of ["player_code", "verify_code", "verify_token"]) {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: {
|
||||
player_code: "str",
|
||||
@@ -191,7 +191,7 @@ describe("player_auth", function() {
|
||||
it("should return error if verify_token is not valid", async function() {
|
||||
async function verify(tokenParams, error) {
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: {
|
||||
player_code: "player",
|
||||
@@ -214,9 +214,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should return invalid player_code if the code is expired", async function() {
|
||||
let expires = Date.now() - 1000;
|
||||
masterPlugin.players.set("expired", { playerCode: "expried", verifyCode: "verify", expires });
|
||||
controllerPlugin.players.set("expired", { playerCode: "expried", verifyCode: "verify", expires });
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: {
|
||||
player_code: "expired",
|
||||
@@ -233,9 +233,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should return verified false if verify code has not yet been set", async function() {
|
||||
let expires = Date.now() + 1000;
|
||||
masterPlugin.players.set("unverified", { playerCode: "unverified", verifyCode: null, expires });
|
||||
controllerPlugin.players.set("unverified", { playerCode: "unverified", verifyCode: null, expires });
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: {
|
||||
player_code: "unverified",
|
||||
@@ -252,9 +252,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should return error if user is missing", async function() {
|
||||
let expires = Date.now() + 1000;
|
||||
masterPlugin.players.set("missing", { playerCode: "missing", verifyCode: "verify", expires });
|
||||
controllerPlugin.players.set("missing", { playerCode: "missing", verifyCode: "verify", expires });
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: {
|
||||
player_code: "missing",
|
||||
@@ -271,9 +271,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should return verified true with token if valid verification", async function() {
|
||||
let expires = Date.now() + 1000;
|
||||
masterPlugin.players.set("player", { playerCode: "player", verifyCode: "verify", expires });
|
||||
controllerPlugin.players.set("player", { playerCode: "player", verifyCode: "verify", expires });
|
||||
let result = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: {
|
||||
player_code: "player",
|
||||
@@ -293,10 +293,10 @@ describe("player_auth", function() {
|
||||
|
||||
describe(".fetchPlayerCodeRequestHandler()", function() {
|
||||
it("should return a code", async function() {
|
||||
let result = await masterPlugin.fetchPlayerCodeRequestHandler({ data: { player: "test" }});
|
||||
let result = await controllerPlugin.fetchPlayerCodeRequestHandler({ data: { player: "test" }});
|
||||
assert(typeof result.player_code === "string", "no code returned");
|
||||
assert(result.player_code.length === 10, "incorrect code length returned");
|
||||
let expires = masterPlugin.players.get("test").expires;
|
||||
let expires = controllerPlugin.players.get("test").expires;
|
||||
let msFromExpected = Math.abs(expires - Date.now() - 1000);
|
||||
assert(msFromExpected < 100, `expiry time expected outside window (${msFromExpected}ms)`);
|
||||
});
|
||||
@@ -305,7 +305,7 @@ describe("player_auth", function() {
|
||||
describe(".setVerifyCodeRequestHandler()", function() {
|
||||
it("should throw if player does not exist", async function() {
|
||||
await assert.rejects(
|
||||
masterPlugin.setVerifyCodeRequestHandler(
|
||||
controllerPlugin.setVerifyCodeRequestHandler(
|
||||
{ data: { player: "invalid", verify_code: "invalid" }}
|
||||
),
|
||||
new libErrors.RequestError("invalid player")
|
||||
@@ -313,9 +313,9 @@ describe("player_auth", function() {
|
||||
});
|
||||
it("should throw if player code has expired", async function() {
|
||||
let expires = Date.now() - 1000;
|
||||
masterPlugin.players.set("expired", { playerCode: "expried", verifyCode: null, expires });
|
||||
controllerPlugin.players.set("expired", { playerCode: "expried", verifyCode: null, expires });
|
||||
await assert.rejects(
|
||||
masterPlugin.setVerifyCodeRequestHandler(
|
||||
controllerPlugin.setVerifyCodeRequestHandler(
|
||||
{ data: { player: "expired", verify_code: "expired" }}
|
||||
),
|
||||
new libErrors.RequestError("invalid player")
|
||||
@@ -325,21 +325,23 @@ describe("player_auth", function() {
|
||||
|
||||
describe("integration", function() {
|
||||
it("should verify a full login flow", async function() {
|
||||
let app = masterPlugin.master.app;
|
||||
let { player_code } = await masterPlugin.fetchPlayerCodeRequestHandler({ data: { player: "test" }});
|
||||
let app = controllerPlugin.controller.app;
|
||||
let { player_code } = await controllerPlugin.fetchPlayerCodeRequestHandler(
|
||||
{ data: { player: "test" }}
|
||||
);
|
||||
|
||||
let playerCodeResult = await phin({
|
||||
url: `${masterUrl}/api/player_auth/player_code`,
|
||||
url: `${controllerUrl}/api/player_auth/player_code`,
|
||||
method: "POST",
|
||||
data: { player_code },
|
||||
parse: "json",
|
||||
});
|
||||
|
||||
let { verify_code, verify_token } = playerCodeResult.body;
|
||||
await masterPlugin.setVerifyCodeRequestHandler({ data: { player: "test", verify_code }});
|
||||
await controllerPlugin.setVerifyCodeRequestHandler({ data: { player: "test", verify_code }});
|
||||
|
||||
let verifyResult = await phin({
|
||||
url: `${masterUrl}/api/player_auth/verify`,
|
||||
url: `${controllerUrl}/api/player_auth/verify`,
|
||||
method: "POST",
|
||||
data: { player_code, verify_code, verify_token },
|
||||
parse: "json",
|
||||
@@ -359,7 +361,7 @@ describe("player_auth", function() {
|
||||
|
||||
describe(".handleEvent()", async function() {
|
||||
describe("open_dialog", async function() {
|
||||
it("should call /web-login error if not connected to master", async function() {
|
||||
it("should call /web-login error if not connected to controller", async function() {
|
||||
instancePlugin.instance.server.reset();
|
||||
instancePlugin.slave.connector.connected = false;
|
||||
await instancePlugin.handleEvent({ type: "open_dialog", player: "test" });
|
||||
@@ -367,7 +369,7 @@ describe("player_auth", function() {
|
||||
instancePlugin.slave.connector.connected = true;
|
||||
assert.equal(command, "/web-login error test login is temporarily unavailable");
|
||||
});
|
||||
it("should call /web-login error after error from the master", async function() {
|
||||
it("should call /web-login error after error from the controller", async function() {
|
||||
instancePlugin.instance.server.reset();
|
||||
instancePlugin.instance.connector.once("send", message => {
|
||||
instancePlugin.instance.connector.emit("message", {
|
||||
@@ -375,15 +377,15 @@ describe("player_auth", function() {
|
||||
type: "player_auth:fetch_player_code_response",
|
||||
data: {
|
||||
seq: message.seq,
|
||||
error: "master error",
|
||||
error: "controller error",
|
||||
},
|
||||
});
|
||||
});
|
||||
await instancePlugin.handleEvent({ type: "open_dialog", player: "test" });
|
||||
let command = instancePlugin.instance.server.rconCommands[0];
|
||||
assert.equal(command, "/web-login error test master error");
|
||||
assert.equal(command, "/web-login error test controller error");
|
||||
});
|
||||
it("should call /web-login open after a valid response from the master", async function() {
|
||||
it("should call /web-login open after a valid response from the controller", async function() {
|
||||
instancePlugin.instance.server.reset();
|
||||
instancePlugin.instance.connector.once("send", message => {
|
||||
instancePlugin.instance.connector.emit("message", {
|
||||
@@ -392,17 +394,17 @@ describe("player_auth", function() {
|
||||
data: {
|
||||
seq: message.seq,
|
||||
player_code: "code",
|
||||
master_url: "master-url",
|
||||
controller_url: "controller-url",
|
||||
},
|
||||
});
|
||||
});
|
||||
await instancePlugin.handleEvent({ type: "open_dialog", player: "test" });
|
||||
let command = instancePlugin.instance.server.rconCommands[0];
|
||||
assert.equal(command, "/web-login open test master-url code");
|
||||
assert.equal(command, "/web-login open test controller-url code");
|
||||
});
|
||||
});
|
||||
describe("open_dialog", async function() {
|
||||
it("should call /web-login code_set after a valid response from the master", async function() {
|
||||
it("should call /web-login code_set after a valid response from the controller", async function() {
|
||||
instancePlugin.instance.server.reset();
|
||||
instancePlugin.instance.connector.once("send", message => {
|
||||
instancePlugin.instance.connector.emit("message", {
|
||||
@@ -417,20 +419,20 @@ describe("player_auth", function() {
|
||||
let command = instancePlugin.instance.server.rconCommands[0];
|
||||
assert.equal(command, "/web-login code_set test");
|
||||
});
|
||||
it("should call /web-login error after error from the master", async function() {
|
||||
it("should call /web-login error after error from the controller", async function() {
|
||||
instancePlugin.instance.server.reset();
|
||||
instancePlugin.instance.connector.once("send", message => {
|
||||
instancePlugin.instance.connector.emit("message", {
|
||||
seq: 1,
|
||||
type: "player_auth:set_verify_code_response",
|
||||
data: { seq: message.seq, error: "master error" },
|
||||
data: { seq: message.seq, error: "controller error" },
|
||||
});
|
||||
});
|
||||
await instancePlugin.handleEvent(
|
||||
{ type: "set_verify_code", player: "test", verify_code: "verify" }
|
||||
);
|
||||
let command = instancePlugin.instance.server.rconCommands[0];
|
||||
assert.equal(command, "/web-login error test master error");
|
||||
assert.equal(command, "/web-login error test controller error");
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -8,6 +8,6 @@ Plugin synchronizing research progress between instances and the cluster.
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-research_sync
|
||||
npx clusteriomaster plugin add @clusterio/plugin-research_sync
|
||||
npx clusteriocontroller plugin add @clusterio/plugin-research_sync
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriocontroller with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
@@ -7,8 +7,8 @@ const libPlugin = require("@clusterio/lib/plugin");
|
||||
const RateLimiter = require("@clusterio/lib/RateLimiter");
|
||||
|
||||
|
||||
async function loadTechnologies(masterConfig, logger) {
|
||||
let filePath = path.join(masterConfig.get("master.database_directory"), "technologies.json");
|
||||
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)));
|
||||
@@ -23,15 +23,15 @@ async function loadTechnologies(masterConfig, logger) {
|
||||
}
|
||||
}
|
||||
|
||||
async function saveTechnologies(masterConfig, technologies, logger) {
|
||||
let filePath = path.join(masterConfig.get("master.database_directory"), "technologies.json");
|
||||
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 MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
class ControllerPlugin extends libPlugin.BaseControllerPlugin {
|
||||
async init() {
|
||||
this.technologies = await loadTechnologies(this.master.config, this.logger);
|
||||
this.technologies = await loadTechnologies(this.controller.config, this.logger);
|
||||
this.progressRateLimiter = new RateLimiter({
|
||||
maxRate: 1,
|
||||
action: () => this.broadcastProgress(),
|
||||
@@ -44,7 +44,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
async onShutdown() {
|
||||
this.progressRateLimiter.cancel();
|
||||
await saveTechnologies(this.master.config, this.technologies, this.logger);
|
||||
await saveTechnologies(this.controller.config, this.technologies, this.logger);
|
||||
}
|
||||
|
||||
broadcastProgress() {
|
||||
@@ -169,5 +169,5 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
|
||||
module.exports = {
|
||||
MasterPlugin,
|
||||
ControllerPlugin,
|
||||
};
|
||||
@@ -2,7 +2,7 @@
|
||||
const { libLink } = require("@clusterio/lib");
|
||||
|
||||
|
||||
// schema used for syncing technologies to and from the master
|
||||
// schema used for syncing technologies to and from the controller
|
||||
const technologies = {
|
||||
type: "array",
|
||||
items: {
|
||||
@@ -23,13 +23,13 @@ module.exports = {
|
||||
title: "Research Sync",
|
||||
description: "Synchronises technology research progress between instances.",
|
||||
instanceEntrypoint: "instance",
|
||||
masterEntrypoint: "master",
|
||||
controllerEntrypoint: "controller",
|
||||
|
||||
messages: {
|
||||
contribution: new libLink.Event({
|
||||
type: "research_sync:contribution",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
eventProperties: {
|
||||
"name": { type: "string" },
|
||||
"level": { type: "integer" },
|
||||
@@ -38,7 +38,7 @@ module.exports = {
|
||||
}),
|
||||
progress: new libLink.Event({
|
||||
type: "research_sync:progress",
|
||||
links: ["master-slave", "slave-instance"],
|
||||
links: ["controller-slave", "slave-instance"],
|
||||
broadcastTo: "instance",
|
||||
eventProperties: {
|
||||
"technologies": {
|
||||
@@ -57,8 +57,8 @@ module.exports = {
|
||||
}),
|
||||
finished: new libLink.Event({
|
||||
type: "research_sync:finished",
|
||||
links: ["instance-slave", "slave-master", "master-slave", "slave-instance"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller", "controller-slave", "slave-instance"],
|
||||
forwardTo: "controller",
|
||||
broadcastTo: "instance",
|
||||
eventProperties: {
|
||||
"name": { type: "string" },
|
||||
@@ -67,8 +67,8 @@ module.exports = {
|
||||
}),
|
||||
syncTechnologies: new libLink.Request({
|
||||
type: "research_sync:sync_technologies",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"technologies": technologies,
|
||||
},
|
||||
|
||||
@@ -66,8 +66,8 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
let response = await this.info.messages.syncTechnologies.send(this.instance, { technologies: techsToSend });
|
||||
this.syncStarted = true;
|
||||
let techsToSync = [];
|
||||
for (let masterTech of response.technologies) {
|
||||
let [name, level, progress, researched] = masterTech;
|
||||
for (let controllerTech of response.technologies) {
|
||||
let [name, level, progress, researched] = controllerTech;
|
||||
let instanceTech = instanceTechs.get(name);
|
||||
if (
|
||||
!instanceTech
|
||||
@@ -75,7 +75,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
|| (instanceTech.progress || null) !== progress
|
||||
|| instanceTech.researched !== researched
|
||||
) {
|
||||
techsToSync.push(masterTech);
|
||||
techsToSync.push(controllerTech);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ sync.events[clusterio_api.events.on_server_startup] = function(event)
|
||||
}
|
||||
end
|
||||
|
||||
-- Used when syncing completed technologies from the master
|
||||
-- Used when syncing completed technologies from the controller
|
||||
global.research_sync.ignore_research_finished = false
|
||||
|
||||
local force = game.forces["player"]
|
||||
@@ -165,14 +165,14 @@ function research_sync.update_progress(data)
|
||||
local techs = game.json_to_table(data)
|
||||
local force = game.forces["player"]
|
||||
|
||||
for _, masterTech in ipairs(techs) do
|
||||
local tech = force.technologies[masterTech.name]
|
||||
if tech and tech.level == masterTech.level then
|
||||
for _, controllerTech in ipairs(techs) do
|
||||
local tech = force.technologies[controllerTech.name]
|
||||
if tech and tech.level == controllerTech.level then
|
||||
send_contribution(tech)
|
||||
set_technology_progress(tech, masterTech.progress)
|
||||
set_technology_progress(tech, controllerTech.progress)
|
||||
global.research_sync.technologies[tech.name] = {
|
||||
level = tech.level,
|
||||
progress = masterTech.progress
|
||||
progress = controllerTech.progress
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,4 +3,4 @@
|
||||
|
||||
"use strict";
|
||||
require("../instance");
|
||||
require("../master");
|
||||
require("../controller");
|
||||
@@ -8,9 +8,9 @@ Plugin exporting item production, fluid production, kill count, entity build and
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-statistics_exporter
|
||||
npx clusteriomaster plugin add @clusterio/plugin-statistics_exporter
|
||||
npx clusteriocontroller plugin add @clusterio/plugin-statistics_exporter
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriocontroller with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
|
||||
|
||||
## Instance Configuration
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
const { libConfig } = require("@clusterio/lib");
|
||||
|
||||
class InstanceConfigGroup extends libConfig.PluginConfigGroup {}
|
||||
InstanceConfigGroup.defaultAccess = ["master", "slave", "control"];
|
||||
InstanceConfigGroup.defaultAccess = ["controller", "slave", "control"];
|
||||
InstanceConfigGroup.groupName = "statistics_exporter";
|
||||
InstanceConfigGroup.define({
|
||||
name: "command_timeout",
|
||||
|
||||
@@ -84,7 +84,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
// Wait configured timeout for the metrics to be collected. It may
|
||||
// take a long time for the command to go through if the command
|
||||
// stream is overloaded. Should the timeout be exceeded the
|
||||
// previous values for the metrics will end up being sent to master.
|
||||
// previous values for the metrics will end up being sent to controller.
|
||||
let timeout = this.instance.config.get("statistics_exporter.command_timeout") * 1000;
|
||||
await libHelpers.timeout(this.gatherMetrics(), timeout);
|
||||
}
|
||||
|
||||
@@ -8,6 +8,6 @@ Plugin for the Subpsace Storage mod.
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-subspace_storage
|
||||
npx clusteriomaster plugin add @clusterio/plugin-subspace_storage
|
||||
npx clusteriocontroller plugin add @clusterio/plugin-subspace_storage
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriocontroller with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
@@ -22,15 +22,15 @@ const importCounter = new Counter(
|
||||
"Resources imported by instance",
|
||||
{ labels: ["instance_id", "resource"] }
|
||||
);
|
||||
const masterInventoryGauge = new Gauge(
|
||||
"clusterio_subspace_storage_master_inventory",
|
||||
"Amount of resources stored on master",
|
||||
const controllerInventoryGauge = new Gauge(
|
||||
"clusterio_subspace_storage_controller_inventory",
|
||||
"Amount of resources stored on controller",
|
||||
{ labels: ["resource"] }
|
||||
);
|
||||
|
||||
|
||||
async function loadDatabase(config, logger) {
|
||||
let itemsPath = path.resolve(config.get("master.database_directory"), "items.json");
|
||||
let itemsPath = path.resolve(config.get("controller.database_directory"), "items.json");
|
||||
logger.verbose(`Loading ${itemsPath}`);
|
||||
try {
|
||||
let content = await fs.readFile(itemsPath);
|
||||
@@ -45,9 +45,9 @@ async function loadDatabase(config, logger) {
|
||||
}
|
||||
}
|
||||
|
||||
async function saveDatabase(masterConfig, items, logger) {
|
||||
async function saveDatabase(controllerConfig, items, logger) {
|
||||
if (items && items.size < 50000) {
|
||||
let file = path.resolve(masterConfig.get("master.database_directory"), "items.json");
|
||||
let file = path.resolve(controllerConfig.get("controller.database_directory"), "items.json");
|
||||
logger.verbose(`writing ${file}`);
|
||||
let content = JSON.stringify(items.serialize());
|
||||
await libFileOps.safeOutputFile(file, content);
|
||||
@@ -56,10 +56,10 @@ async function saveDatabase(masterConfig, items, logger) {
|
||||
}
|
||||
}
|
||||
|
||||
class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
class ControllerPlugin extends libPlugin.BaseControllerPlugin {
|
||||
async init() {
|
||||
|
||||
this.items = await loadDatabase(this.master.config, this.logger);
|
||||
this.items = await loadDatabase(this.controller.config, this.logger);
|
||||
this.itemUpdateRateLimiter = new RateLimiter({
|
||||
maxRate: 1,
|
||||
action: () => {
|
||||
@@ -72,21 +72,21 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
});
|
||||
this.itemsLastUpdate = new Map(this.items._items.entries());
|
||||
this.autosaveId = setInterval(() => {
|
||||
saveDatabase(this.master.config, this.items, this.logger).catch(err => {
|
||||
saveDatabase(this.controller.config, this.items, this.logger).catch(err => {
|
||||
this.logger.error(`Unexpected error autosaving items:\n${err.stack}`);
|
||||
});
|
||||
}, this.master.config.get("subspace_storage.autosave_interval") * 1000);
|
||||
}, this.controller.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") {
|
||||
if (this.controller.config.get("subspace_storage.division_method") === "neural_dole") {
|
||||
this.neuralDole.doMagic();
|
||||
}
|
||||
}, 1000);
|
||||
|
||||
this.subscribedControlLinks = new Set();
|
||||
|
||||
routes.addApiRoutes(this.master.app, this.items);
|
||||
routes.addApiRoutes(this.controller.app, this.items);
|
||||
}
|
||||
|
||||
updateStorage() {
|
||||
@@ -128,7 +128,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
this.updateStorage();
|
||||
|
||||
if (this.master.config.get("subspace_storage.log_item_transfers")) {
|
||||
if (this.controller.config.get("subspace_storage.log_item_transfers")) {
|
||||
this.logger.verbose(
|
||||
`Imported the following from ${message.data.instance_id}:\n${JSON.stringify(message.data.items)}`
|
||||
);
|
||||
@@ -136,7 +136,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
|
||||
async removeRequestHandler(message) {
|
||||
let method = this.master.config.get("subspace_storage.division_method");
|
||||
let method = this.controller.config.get("subspace_storage.division_method");
|
||||
let instanceId = message.data.instance_id;
|
||||
|
||||
let itemsRemoved = [];
|
||||
@@ -153,7 +153,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
}
|
||||
|
||||
} else {
|
||||
let instance = this.master.instances.get(instanceId);
|
||||
let instance = this.controller.instances.get(instanceId);
|
||||
let instanceName = instance ? instance.config.get("instance.name") : "unkonwn";
|
||||
|
||||
// use fancy neural net to calculate a "fair" dole division rate.
|
||||
@@ -171,7 +171,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
let count = dole.doleDivider({
|
||||
object: { name: item[0], count: item[1], instanceId, instanceName },
|
||||
items: this.items,
|
||||
logItemTransfers: this.master.config.get("subspace_storage.log_item_transfers"),
|
||||
logItemTransfers: this.controller.config.get("subspace_storage.log_item_transfers"),
|
||||
logger: this.logger,
|
||||
});
|
||||
if (count > 0) {
|
||||
@@ -192,7 +192,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
|
||||
this.updateStorage();
|
||||
|
||||
if (itemsRemoved.length && this.master.config.get("subspace_storage.log_item_transfers")) {
|
||||
if (itemsRemoved.length && this.controller.config.get("subspace_storage.log_item_transfers")) {
|
||||
this.logger.verbose(`Exported the following to ${instanceId}:\n${JSON.stringify(itemsRemoved)}`);
|
||||
}
|
||||
}
|
||||
@@ -219,7 +219,7 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
onMetrics() {
|
||||
if (this.items) {
|
||||
for (let [key, count] of this.items._items) {
|
||||
masterInventoryGauge.labels(key).set(Number(count) || 0);
|
||||
controllerInventoryGauge.labels(key).set(Number(count) || 0);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -228,10 +228,10 @@ class MasterPlugin extends libPlugin.BaseMasterPlugin {
|
||||
this.itemUpdateRateLimiter.cancel();
|
||||
clearInterval(this.autosaveId);
|
||||
clearInterval(this.doleMagicId);
|
||||
await saveDatabase(this.master.config, this.items, this.logger);
|
||||
await saveDatabase(this.controller.config, this.items, this.logger);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
MasterPlugin,
|
||||
ControllerPlugin,
|
||||
};
|
||||
@@ -25,9 +25,9 @@ function sigmoid3(x) {
|
||||
|
||||
// DOSE - Doses items for item X slave Y
|
||||
// Numreq - number of items that are requested for item X for slave Y
|
||||
// Instore - number of items for item X in master gauge (currently)
|
||||
// Instore - number of items for item X in controller gauge (currently)
|
||||
// store_last_tick -
|
||||
// Number of items for item X in master gauge at time of last tick
|
||||
// Number of items for item X in controller gauge at time of last tick
|
||||
// dole - Current dole for item X
|
||||
// carry - carry for item X slave Y
|
||||
// prev_req - Numreq for previous request for item X slave Y
|
||||
@@ -99,10 +99,10 @@ function dose(numreq, instore, store_last_tick, dole, carry, prev_req, numreq_to
|
||||
// TICK -
|
||||
// Updates values for item X, should be called once for each item for
|
||||
// each round of all slaves requesting that item Instore - number of
|
||||
// items for item X in master gauge (currently)
|
||||
// items for item X in controller gauge (currently)
|
||||
// dole - Current dole for item X
|
||||
// store_last_tick -
|
||||
// Number of items for item X in master gauge at time of last tick (not this one)
|
||||
// Number of items for item X in controller gauge at time of last tick (not this one)
|
||||
// * doleinfo_last -
|
||||
// Object with 2 values for last "tick period": numreq - total number or
|
||||
// requests for item, numslave - number of slaves requesting that item
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
"use strict";
|
||||
const { libConfig, libLink, libUsers } = require("@clusterio/lib");
|
||||
|
||||
class MasterConfigGroup extends libConfig.PluginConfigGroup {}
|
||||
MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
|
||||
MasterConfigGroup.groupName = "subspace_storage";
|
||||
MasterConfigGroup.define({
|
||||
class ControllerConfigGroup extends libConfig.PluginConfigGroup {}
|
||||
ControllerConfigGroup.defaultAccess = ["controller", "slave", "control"];
|
||||
ControllerConfigGroup.groupName = "subspace_storage";
|
||||
ControllerConfigGroup.define({
|
||||
name: "autosave_interval",
|
||||
title: "Autosave Interval",
|
||||
description: "Interval the storage is autosaved at in seconds.",
|
||||
type: "number",
|
||||
initial_value: 60,
|
||||
});
|
||||
MasterConfigGroup.define({
|
||||
ControllerConfigGroup.define({
|
||||
name: "division_method",
|
||||
title: "Division Method",
|
||||
description: "Method for dividing resource requests between instances.",
|
||||
@@ -19,17 +19,17 @@ MasterConfigGroup.define({
|
||||
enum: ["simple", "dole", "neural_dole"],
|
||||
initial_value: "simple",
|
||||
});
|
||||
MasterConfigGroup.define({
|
||||
ControllerConfigGroup.define({
|
||||
name: "log_item_transfers",
|
||||
title: "Log Item Transfers",
|
||||
description: "Spam master console with item transfers done.",
|
||||
description: "Spam controller console with item transfers done.",
|
||||
type: "boolean",
|
||||
initial_value: false,
|
||||
});
|
||||
MasterConfigGroup.finalize();
|
||||
ControllerConfigGroup.finalize();
|
||||
|
||||
class InstanceConfigGroup extends libConfig.PluginConfigGroup {}
|
||||
InstanceConfigGroup.defaultAccess = ["master", "slave", "control"];
|
||||
InstanceConfigGroup.defaultAccess = ["controller", "slave", "control"];
|
||||
InstanceConfigGroup.groupName = "subspace_storage";
|
||||
InstanceConfigGroup.define({
|
||||
name: "log_item_transfers",
|
||||
@@ -68,8 +68,8 @@ module.exports = {
|
||||
instanceEntrypoint: "instance",
|
||||
InstanceConfigGroup,
|
||||
|
||||
masterEntrypoint: "master",
|
||||
MasterConfigGroup,
|
||||
controllerEntrypoint: "controller",
|
||||
ControllerConfigGroup,
|
||||
|
||||
webEntrypoint: "./web",
|
||||
routes: ["/storage"],
|
||||
@@ -78,8 +78,8 @@ module.exports = {
|
||||
// XXX this should be a request to be reliable
|
||||
place: new libLink.Event({
|
||||
type: "subspace_storage:place",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
eventProperties: {
|
||||
"instance_id": { type: "integer" },
|
||||
"items": items,
|
||||
@@ -87,8 +87,8 @@ module.exports = {
|
||||
}),
|
||||
remove: new libLink.Request({
|
||||
type: "subspace_storage:remove",
|
||||
links: ["instance-slave", "slave-master"],
|
||||
forwardTo: "master",
|
||||
links: ["instance-slave", "slave-controller"],
|
||||
forwardTo: "controller",
|
||||
requestProperties: {
|
||||
"instance_id": { type: "integer" },
|
||||
"items": items,
|
||||
@@ -99,16 +99,16 @@ module.exports = {
|
||||
}),
|
||||
getStorage: new libLink.Request({
|
||||
type: "subspace_storage:get_storage",
|
||||
links: ["instance-slave", "slave-master", "control-master"],
|
||||
links: ["instance-slave", "slave-controller", "control-controller"],
|
||||
permission: "subspace_storage.storage.view",
|
||||
forwardTo: "master",
|
||||
forwardTo: "controller",
|
||||
responseProperties: {
|
||||
"items": items,
|
||||
},
|
||||
}),
|
||||
updateStorage: new libLink.Event({
|
||||
type: "subspace_storage:update_storage",
|
||||
links: ["master-slave", "slave-instance", "master-control"],
|
||||
links: ["controller-slave", "slave-instance", "controller-control"],
|
||||
broadcastTo: "instance",
|
||||
eventProperties: {
|
||||
"items": items,
|
||||
@@ -117,7 +117,7 @@ module.exports = {
|
||||
|
||||
setStorageSubscription: new libLink.Request({
|
||||
type: "subspace_storage:set_storage_subscription",
|
||||
links: ["control-master"],
|
||||
links: ["control-controller"],
|
||||
permission: "subspace_storage.storage.view",
|
||||
requestProperties: {
|
||||
"storage": { type: "boolean" },
|
||||
|
||||
@@ -26,7 +26,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
async onStart() {
|
||||
this.pingId = setInterval(() => {
|
||||
if (!this.slave.connected) {
|
||||
return; // Only ping if we are actually connected to the master.
|
||||
return; // Only ping if we are actually connected to the controller.
|
||||
}
|
||||
this.sendRcon(
|
||||
"/sc __subspace_storage__ global.ticksSinceMasterPinged = 0", true
|
||||
@@ -51,7 +51,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
// provide items --------------------------------------------------------------
|
||||
async provideItems(items) {
|
||||
if (!this.slave.connector.hasSession) {
|
||||
// For now the items are voided if the master connection is
|
||||
// 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:");
|
||||
@@ -66,7 +66,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
});
|
||||
|
||||
if (this.instance.config.get("subspace_storage.log_item_transfers")) {
|
||||
this.logger.verbose("Exported the following to master:");
|
||||
this.logger.verbose("Exported the following to controller:");
|
||||
this.logger.verbose(JSON.stringify(items));
|
||||
}
|
||||
}
|
||||
@@ -84,7 +84,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
|
||||
}
|
||||
|
||||
if (this.instance.config.get("subspace_storage.log_item_transfers")) {
|
||||
this.logger.verbose("Imported following from master:");
|
||||
this.logger.verbose("Imported following from controller:");
|
||||
this.logger.verbose(JSON.stringify(response.items));
|
||||
}
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
function addApiRoutes(app, items) {
|
||||
|
||||
/**
|
||||
* GET endpoint to read the masters current inventory of items.
|
||||
* GET endpoint to read the controllers current inventory of items.
|
||||
*
|
||||
* @memberof clusterioMaster
|
||||
* @memberof clusterioController
|
||||
* @instance
|
||||
* @alias api/inventory
|
||||
* @returns {object[]} JSON [{name:"iron-plate", count:100},{name:"copper-plate",count:5}]
|
||||
@@ -22,9 +22,9 @@ function addApiRoutes(app, items) {
|
||||
});
|
||||
|
||||
/**
|
||||
* GET endpoint to read the masters inventory as an object with key:value pairs
|
||||
* GET endpoint to read the controllers inventory as an object with key:value pairs
|
||||
*
|
||||
* @memberof clusterioMaster
|
||||
* @memberof clusterioController
|
||||
* @instance
|
||||
* @alias api/inventoryAsObject
|
||||
* @returns {object} JSON {"iron-plate":100, "copper-plate":5}
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
"use strict";
|
||||
require("../instance");
|
||||
require("../master");
|
||||
require("../controller");
|
||||
require("../dole");
|
||||
require("../dole_nn_base");
|
||||
@@ -7,7 +7,7 @@ const { get } = require("../../../test/integration");
|
||||
|
||||
describe("subspace_storage endpoints", function() {
|
||||
describe("GET /api/inventory", function() {
|
||||
it("should return the masters current inventory", async function() {
|
||||
it("should return the controllers current inventory", async function() {
|
||||
let res = await get("/api/inventory");
|
||||
let inventory = res.body;
|
||||
assert.equal(typeof inventory, "object", "Inventory should be an object");
|
||||
|
||||
@@ -129,7 +129,7 @@ export class WebPlugin extends libPlugin.BaseWebPlugin {
|
||||
this.callbacks = [];
|
||||
}
|
||||
|
||||
onMasterConnectionEvent(event) {
|
||||
onControllerConnectionEvent(event) {
|
||||
if (event === "connect") {
|
||||
this.updateSubscription();
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user