Add slave update subscriptions

Allow the web interface to listen for updates to the slave list and
apply it live to the places where slaves are shown in the web interface.
This commit is contained in:
Hornwitser committed 2021-06-02 16:19:18 +02:00
1 parent cc438574ff
commit 2be91cbd3a
12 files changed
+275 -29

No files matched your search

+2
View File
@@ -918,6 +918,8 @@ class Control extends libLink.Link {
this.keepOpen = false; this.keepOpen = false;
} }
async slaveUpdateEventHandler() { }
async instanceUpdateEventHandler() { } async instanceUpdateEventHandler() { }
async saveListUpdateEventHandler() { } async saveListUpdateEventHandler() { }
+29 -7
View File
@@ -331,6 +331,14 @@ messages.setMasterConfigProp = new Request({
}, },
}); });
let slaveProperties = {
"agent": { type: "string" },
"version": { type: "string" },
"name": { type: "string" },
"id": { type: "integer" },
"connected": { type: "boolean" },
};
messages.listSlaves = new Request({ messages.listSlaves = new Request({
type: "list_slaves", type: "list_slaves",
links: ["control-master"], links: ["control-master"],
@@ -341,18 +349,25 @@ messages.listSlaves = new Request({
items: { items: {
additionalProperties: false, additionalProperties: false,
required: ["agent", "version", "name", "id", "connected"], required: ["agent", "version", "name", "id", "connected"],
properties: { properties: slaveProperties,
"agent": { type: "string" },
"version": { type: "string" },
"name": { type: "string" },
"id": { type: "integer" },
"connected": { type: "boolean" },
},
}, },
}, },
}, },
}); });
messages.setSlaveSubscriptions = new Request({
type: "set_slave_subscriptions",
links: ["control-master"],
permission: "core.slave.subscribe",
requestProperties: {
"all": { type: "boolean" },
"slave_ids": {
type: "array",
items: { type: "integer" },
},
},
});
let instanceProperties = { let instanceProperties = {
"name": { type: "string" }, "name": { type: "string" },
"id": { type: "integer" }, "id": { type: "integer" },
@@ -1083,6 +1098,13 @@ messages.logMessage = new Event({
}, },
}); });
messages.slaveUpdate = new Event({
type: "slave_update",
links: ["master-control"],
eventProperties: slaveProperties,
});
messages.instanceInitialized = new Event({ messages.instanceInitialized = new Event({
type: "instance_initialized", type: "instance_initialized",
links: ["instance-slave"], links: ["instance-slave"],
+6
View File
@@ -322,6 +322,12 @@ definePermission({
description: "Get the full list of slaves in the cluster.", description: "Get the full list of slaves in the cluster.",
grantByDefault: true, grantByDefault: true,
}); });
definePermission({
name: "core.slave.subscribe",
title: "Subscribe to slave updates",
description: "Subscribe to be notified on updates on the details of slaves.",
grantByDefault: true,
});
definePermission({ definePermission({
name: "core.slave.generate_token", name: "core.slave.generate_token",
title: "Generate slave token", title: "Generate slave token",
+18
View File
@@ -39,6 +39,11 @@ class ControlConnection extends BaseConnection {
*/ */
this.user = user; this.user = user;
this.slaveSubscriptions = {
all: false,
slave_ids: [],
};
this.instanceSubscriptions = { this.instanceSubscriptions = {
all: false, all: false,
instance_ids: [], instance_ids: [],
@@ -107,6 +112,19 @@ class ControlConnection extends BaseConnection {
return { list }; return { list };
} }
async setSlaveSubscriptionsRequestHandler(message) {
this.slaveSubscriptions = message.data;
}
slaveUpdated(slave, update) {
if (
this.slaveSubscriptions.all
|| this.slaveSubscriptions.slave_ids.includes(slave.id)
) {
libLink.messages.slaveUpdate.send(this, update);
}
}
generateSlaveToken(slaveId) { generateSlaveToken(slaveId) {
return jwt.sign({ aud: "slave", slave: slaveId }, this._master.config.get("master.auth_secret")); return jwt.sign({ aud: "slave", slave: slaveId }, this._master.config.get("master.auth_secret"));
} }
+18
View File
@@ -360,6 +360,24 @@ class Master {
} }
} }
slaveUpdated(slave) {
let update = {
agent: slave.agent,
version: slave.version,
id: slave.id,
name: slave.name,
connected: this.wsServer.slaveConnections.has(slave.id),
};
for (let controlConnection of this.wsServer.controlConnections) {
if (controlConnection.connector.closing) {
continue;
}
controlConnection.slaveUpdated(slave, update);
}
}
addInstanceHooks(instance) { addInstanceHooks(instance) {
instance.config.on("fieldChanged", (group, field, prev) => { instance.config.on("fieldChanged", (group, field, prev) => {
if (group.name === "instance" && field === "name") { if (group.name === "instance" && field === "name") {
+2
View File
@@ -274,9 +274,11 @@ ${err.stack}`
connector.on("close", () => { connector.on("close", () => {
if (this.slaveConnections.get(data.id) === connection) { if (this.slaveConnections.get(data.id) === connection) {
this.slaveConnections.delete(data.id); this.slaveConnections.delete(data.id);
this.master.slaveUpdated(this.master.slaves.get(data.id));
} }
}); });
this.slaveConnections.set(data.id, connection); this.slaveConnections.set(data.id, connection);
this.master.slaveUpdated(this.master.slaves.get(data.id));
} else if (type === "register_control") { } else if (type === "register_control") {
@@ -5,24 +5,20 @@ import libLink from "@clusterio/lib/link";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify"; import { notifyErrorHandler } from "../util/notify";
import { useSlaveList } from "../model/slave";
const { Paragraph } = Typography; const { Paragraph } = Typography;
export default function AssignInstanceModal(props) { export default function AssignInstanceModal(props) {
let [visible, setVisible] = useState(false); let [visible, setVisible] = useState(false);
let [slaves, setSlaves] = useState([]); let [slaveList] = useSlaveList();
let [loading, setLoading] = useState(true);
let [applying, setApplying] = useState(false); let [applying, setApplying] = useState(false);
let [form] = Form.useForm(); let [form] = Form.useForm();
let control = useContext(ControlContext); let control = useContext(ControlContext);
function open() { function open() {
setVisible(true); setVisible(true);
libLink.messages.listSlaves.send(control).then((result) => {
setSlaves(result.list);
setLoading(false);
});
} }
function handleAssign() { function handleAssign() {
@@ -73,8 +69,8 @@ export default function AssignInstanceModal(props) {
</Paragraph> </Paragraph>
<Form form={form} initialValues={{ slave: props.slaveId }}> <Form form={form} initialValues={{ slave: props.slaveId }}>
<Form.Item name="slave" label="Slave"> <Form.Item name="slave" label="Slave">
<Select loading={loading}> <Select>
{slaves.map((slave) => <Select.Option {slaveList.map((slave) => <Select.Option
key={slave["id"]} key={slave["id"]}
value={slave["id"]} value={slave["id"]}
disabled={!slave["connected"]} disabled={!slave["connected"]}
+27 -13
View File
@@ -1,28 +1,42 @@
import React, { useContext } from "react"; import React, { useContext } from "react";
import { Table } from "antd";
import libLink from "@clusterio/lib/link"; import libLink from "@clusterio/lib/link";
import DataTable from "./data-table";
import ControlContext from "./ControlContext"; import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout"; import PageLayout from "./PageLayout";
import { useSlaveList } from "../model/slave";
export default function SlavesPage() { export default function SlavesPage() {
let control = useContext(ControlContext); let control = useContext(ControlContext);
let [slaveList] = useSlaveList();
async function listSlaves() {
let result = await libLink.messages.listSlaves.send(control);
return result["list"].map((item) => ({
key: item["id"],
"Name": item["name"],
"Agent": item["agent"],
"Version": item["version"],
"Connected": item["connected"] && "Yes",
}));
}
return <PageLayout nav={[{ name: "Slaves" }]}> return <PageLayout nav={[{ name: "Slaves" }]}>
<h2>Slaves</h2> <h2>Slaves</h2>
<DataTable DataFunction={listSlaves} /> <Table
columns={[
{
title: "Name",
dataIndex: "name",
},
{
title: "Agent",
dataIndex: "agent",
},
{
title: "Version",
dataIndex: "version",
},
{
title: "Connected",
key: "connected",
render: slave => slave["connected"] && "Yes",
},
]}
dataSource={slaveList}
rowKey={slave => slave["id"]}
pagination={false}
/>
</PageLayout>; </PageLayout>;
}; };
+45
View File
@@ -27,7 +27,52 @@ export function useSlave(id) {
useEffect(() => { useEffect(() => {
updateSlave(); updateSlave();
function updateHandler(newSlave) {
setSlave({ ...newSlave, present: true });
}
control.onSlaveUpdate(id, updateHandler);
return () => {
control.offSlaveUpdate(id, updateHandler);
};
}, [id]); }, [id]);
return [slave, updateSlave]; return [slave, updateSlave];
} }
export function useSlaveList() {
let control = useContext(ControlContext);
let [slaveList, setSlaveList] = useState([]);
function updateSlaveList() {
libLink.messages.listSlaves.send(control).then(result => {
setSlaveList(result.list);
});
}
useEffect(() => {
updateSlaveList();
function updateHandler(newSlave) {
setSlaveList(oldList => {
let newList = oldList.concat();
let index = newList.findIndex(s => s.id === newSlave.id);
if (index !== -1) {
newList[index] = newSlave;
} else {
newList.push(newSlave);
}
return newList;
});
}
control.onSlaveUpdate(null, updateHandler);
return () => {
control.offSlaveUpdate(null, updateHandler);
};
}, []);
return [slaveList];
}
+61
View File
@@ -62,12 +62,16 @@ export class Control extends libLink.Link {
*/ */
this.accountName = null; this.accountName = null;
this.slaveUpdateHandlers = new Map();
this.instanceUpdateHandlers = new Map(); this.instanceUpdateHandlers = new Map();
this.saveListUpdateHandlers = new Map(); this.saveListUpdateHandlers = new Map();
this.instanceLogHandlers = new Map(); this.instanceLogHandlers = new Map();
this.connector.on("connect", data => { this.connector.on("connect", data => {
this.accountName = data.account.name; this.accountName = data.account.name;
this.updateSlaveSubscriptions().catch(err => logger.error(
`Unexpected error updating slave subscriptions:\n${err.stack}`
));
this.updateInstanceSubscriptions().catch(err => logger.error( this.updateInstanceSubscriptions().catch(err => logger.error(
`Unexpected error updating instance subscriptions:\n${err.stack}` `Unexpected error updating instance subscriptions:\n${err.stack}`
)); ));
@@ -92,6 +96,63 @@ export class Control extends libLink.Link {
} }
} }
async slaveUpdateEventHandler(message) {
let handlers = [].concat(
this.slaveUpdateHandlers.get(null) || [],
this.slaveUpdateHandlers.get(message.data.id) || [],
);
for (let handler of handlers) {
handler(message.data);
}
}
async onSlaveUpdate(id, handler) {
if (id !== null && !Number.isInteger(id)) {
throw new Error("Invalid slave id");
}
let handlers = this.slaveUpdateHandlers.get(id);
if (!handlers) {
handlers = [];
this.slaveUpdateHandlers.set(id, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateSlaveSubscriptions();
}
}
async offSlaveUpdate(id, handler) {
let handlers = this.slaveUpdateHandlers.get(id);
if (!handlers || !handlers.length) {
throw new Error(`No handlers for slave ${id} exists`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for slave ${id}`);
}
handlers.slice(index, 1);
if (!handlers.length) {
this.slaveUpdateHandlers.delete(id);
await this.updateSlaveSubscriptions();
}
}
async updateSlaveSubscriptions() {
if (!this.connector.connected) {
return;
}
await libLink.messages.setSlaveSubscriptions.send(this, {
all: this.slaveUpdateHandlers.has(null),
slave_ids: [...this.slaveUpdateHandlers.keys()].filter(e => e !== null),
});
}
async instanceUpdateEventHandler(message) { async instanceUpdateEventHandler(message) {
let handlers = this.instanceUpdateHandlers.get(message.data.id); let handlers = this.instanceUpdateHandlers.get(message.data.id);
for (let handler of handlers || []) { for (let handler of handlers || []) {
+54 -1
View File
@@ -10,7 +10,7 @@ const libUsers = require("@clusterio/lib/users");
const testStrings = require("../lib/factorio/test_strings"); const testStrings = require("../lib/factorio/test_strings");
const { const {
TestControl, TestControlConnector, url, controlToken, slowTest, TestControl, TestControlConnector, url, controlToken, slowTest,
get, exec, execCtl, sendRcon, getControl, instancesDir, get, exec, execCtl, sendRcon, getControl, spawn, instancesDir,
} = require("./index"); } = require("./index");
@@ -62,6 +62,59 @@ describe("Integration of Clusterio", function() {
}); });
}); });
describe("clusterioslave", function() {
describe("slaveUpdateEventHandler()", function() {
it("should trigger when a new slave is added", async function() {
slowTest(this);
getControl().slaveUpdates = [];
let config = "alt-slave-config.json";
let configPath = path.join("temp", "test", config);
await fs.remove(configPath);
await execCtl(`slave create-config --id 5 --name alt-slave --generate-token --output ${config}`);
await exec(
`node ../../packages/slave --config ${config} config set slave.tls_ca ../../test/file/tls/cert.pem`
);
let slaveProcess;
try {
slaveProcess = await spawn(
"alt-slave:", `node ../../packages/slave run --config ${config}`, /SOCKET \| registering slave/
);
} finally {
if (slaveProcess) {
slaveProcess.kill("SIGINT");
await events.once(slaveProcess, "exit");
}
}
let sawUpdate = false;
let sawConnected = false;
let sawDisconnected = false;
for (let update of getControl().slaveUpdates) {
if (update.name !== "alt-slave") {
continue;
}
sawUpdate = true;
if (update.connected) {
sawConnected = true;
} else {
sawDisconnected = true;
}
}
assert(sawUpdate, "No slave update was sent");
assert(sawConnected, "No slave update with status connected was sent");
assert(sawDisconnected, "No slave update with status disconnected was sent");
let result = await libLink.messages.listSlaves.send(getControl());
let slaves = new Map(result.list.map(instance => [instance.id, instance]));
assert(slaves.has(5), "Slave list was not updated");
});
});
});
describe("clusterioctl", function() { describe("clusterioctl", function() {
describe("master config list", function() { describe("master config list", function() {
it("runs", async function() { it("runs", async function() {
+9
View File
@@ -25,10 +25,14 @@ class TestControl extends libLink.Link {
constructor(connector) { constructor(connector) {
super("control", "master", connector); super("control", "master", connector);
libLink.attachAllMessages(this); libLink.attachAllMessages(this);
this.slaveUpdates = [];
this.instanceUpdates = []; this.instanceUpdates = [];
this.saveListUpdates = []; this.saveListUpdates = [];
this.connector.on("connect", () => { this.connector.on("connect", () => {
libLink.messages.setSlaveSubscriptions.send(
this, { all: true, slave_ids: [] }
).catch(err => logger.error(`Error setting slave subscriptions:\n${err.stack}`));
libLink.messages.setInstanceSubscriptions.send( libLink.messages.setInstanceSubscriptions.send(
this, { all: true, instance_ids: [] } this, { all: true, instance_ids: [] }
).catch(err => logger.error(`Error setting instance subscriptions:\n${err.stack}`)); ).catch(err => logger.error(`Error setting instance subscriptions:\n${err.stack}`));
@@ -45,6 +49,10 @@ class TestControl extends libLink.Link {
async debugWsMessageEventHandler() { } async debugWsMessageEventHandler() { }
async slaveUpdateEventHandler(message) {
this.slaveUpdates.push(message.data);
}
async instanceUpdateEventHandler(message) { async instanceUpdateEventHandler(message) {
this.instanceUpdates.push(message.data); this.instanceUpdates.push(message.data);
} }
@@ -223,6 +231,7 @@ module.exports = {
execCtl, execCtl,
sendRcon, sendRcon,
getControl, getControl,
spawn,
url, url,
controlToken, controlToken,