Add save listing and subscriptions

Add link messages for listing saves and listening for changes to the
list of saves for instances along with a table in the instance view page
showing the save list for the instance and a list-saves command to ctl.
This commit is contained in:
Hornwitser committed 2021-06-01 11:22:22 +02:00
1 parent b53ed7f6ca
commit a96fae5ffd
16 files changed
+390 -3

No files matched your search

@@ -14,6 +14,8 @@ import AssignInstanceModal from "./AssignInstanceModal";
import StartStopInstanceButton from "./StartStopInstanceButton";
import CreateSaveModal from "./CreateSaveModal";
import LoadScenarioModal from "./LoadScenarioModal";
import SavesList from "./SavesList";
import SectionHeader from "./SectionHeader";
import { notifyErrorHandler } from "../util/notify";
import { useInstance } from "../model/instance";
import { useSlave } from "../model/slave";
@@ -47,7 +49,6 @@ export default function InstanceViewPage(props) {
let instanceButtons = <Space>
<StartStopInstanceButton instance={instance} />
<CreateSaveModal instance={instance} />
<LoadScenarioModal instance={instance} />
<Button
loading={exportingData}
@@ -115,6 +116,8 @@ export default function InstanceViewPage(props) {
<Descriptions.Item label="Status">{instance["status"]}</Descriptions.Item>
</Descriptions>
<SectionHeader title="Saves" extra=<CreateSaveModal instance={instance} /> />
<SavesList instance={instance} />
<Title level={5} style={{ marginTop: 16 }}>Console</Title>
<InstanceConsole id={instanceId} />
<InstanceRcon id={instanceId} disabled={instance["status"] !== "running"} />
@@ -0,0 +1,57 @@
import React, { useContext, useState } from "react";
import { Table, Tooltip } from "antd";
import CaretLeftOutlined from "@ant-design/icons/CaretLeftOutlined";
import LeftOutlined from "@ant-design/icons/LeftOutlined";
import ControlContext from "./ControlContext";
import { useSaves } from "../model/saves";
function formatBytes(bytes) {
if (bytes === 0) {
return "0 Bytes";
}
let units = [" Bytes", " kB", " MB", " GB", " TB"];
let factor = 1000;
let power = Math.min(Math.floor(Math.log(bytes) / Math.log(factor)), units.length);
return (power > 0 ? (bytes / factor ** power).toFixed(2) : bytes) + units[power];
}
export default function SavesList(props) {
let control = useContext(ControlContext);
let saves = useSaves(props.instance.id);
return <Table
size="small"
columns={[
{
title: "Name",
render: save => <>
{save.name}
{save.loaded && <Tooltip title="Currently loaded save"><CaretLeftOutlined/></Tooltip>}
{save.default && <Tooltip title="Save loaded by default"><LeftOutlined/></Tooltip>}
</>,
sorter: (a, b) => a.name.localeCompare(b.name),
},
{
title: "Size",
key: "size",
responsive: ["sm"],
render: save => formatBytes(save.size),
align: "right",
sorter: (a, b) => a.size - b.size,
},
{
title: "Last Modified",
key: "mtime_ms",
render: save => new Date(save.mtime_ms).toLocaleString(),
sorter: (a, b) => a.mtime_ms - b.mtime_ms,
defaultSortOrder: "descend",
},
]}
dataSource={saves}
rowKey={save => save.name}
pagination={false}
/>;
}
@@ -0,0 +1,8 @@
import React, { useContext, useState } from "react";
export default function SectionHeader(props) {
return <div className="section-header">
<div className="section-header-title">{props.title}</div>
{props.extra && <div className="section-header-extra">{props.extra}</div>}
</div>;
}
+21
View File
@@ -67,6 +67,27 @@ body {
padding-right: 64px;
}
.section-header {
display: flex;
align-items: center;
margin-top: 16px;
margin-bottom: 8px;
}
.section-header-title {
flex: auto;
overflow: hidden;
font-weight: bold;
font-size: 16px;
line-height: 1.5715;
white-space: nowrap;
text-overflow: ellipsis;
}
.section-header-extra {
margin-left: auto;
}
.site-name {
position: absolute;
top: -10px;
+2
View File
@@ -18,3 +18,5 @@ export { default as InstanceConsole } from "./components/InstanceConsole";
export { default as InstanceRcon } from "./components/InstanceRcon";
export { default as PageLayout } from "./components/PageLayout";
export { default as SavesList } from "./components/SavesList";
export { default as SectionHeader } from "./components/SectionHeader";
+34
View File
@@ -0,0 +1,34 @@
import React, { useEffect, useContext, useState } from "react";
import ControlContext from "../components/ControlContext";
import libLink from "@clusterio/lib/link";
import { logger } from "@clusterio/lib/logging";
export function useSaves(instanceId) {
let control = useContext(ControlContext);
let [saves, setSaves] = useState([]);
function updateSaves() {
libLink.messages.listSaves.send(control, { instance_id: instanceId }).then(result => {
setSaves(result.list);
}).catch(err => {
logger.error(`Failed to list instance saves: ${err}`);
});
}
useEffect(() => {
updateSaves();
function updateHandler(data) {
setSaves(data.list);
}
control.onSaveListUpdate(instanceId, updateHandler);
return () => {
control.offSaveListUpdate(instanceId, updateHandler);
};
}, [instanceId]);
return saves;
}
+58
View File
@@ -63,6 +63,7 @@ export class Control extends libLink.Link {
this.accountName = null;
this.instanceUpdateHandlers = new Map();
this.saveListUpdateHandlers = new Map();
this.instanceLogHandlers = new Map();
this.connector.on("connect", data => {
@@ -70,6 +71,9 @@ export class Control extends libLink.Link {
this.updateInstanceSubscriptions().catch(err => logger.error(
`Unexpected error updating instance subscriptions:\n${err.stack}`
));
this.updateSaveListSubscriptions().catch(err => logger.error(
`Unexpected error updating save list subscriptions:\n${err.stack}`
));
this.updateLogSubscriptions().catch(err => logger.error(
`Unexpected error updating log subscriptions:\n${err.stack}`
));
@@ -142,6 +146,60 @@ export class Control extends libLink.Link {
});
}
async saveListUpdateEventHandler(message) {
let handlers = this.saveListUpdateHandlers.get(message.data.instance_id);
for (let handler of handlers || []) {
handler(message.data);
}
};
async onSaveListUpdate(id, handler) {
if (!Number.isInteger(id)) {
throw new Error("Invalid instance id");
}
let handlers = this.saveListUpdateHandlers.get(id);
if (!handlers) {
handlers = [];
this.saveListUpdateHandlers.set(id, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateSaveListSubscriptions();
}
}
async offSaveListUpdate(id, handler) {
let handlers = this.saveListUpdateHandlers.get(id);
if (!handlers) {
throw new Error(`No handlers for instance ${id} exists`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for instance ${id}`);
handlers.splice(index, 1);
if (!handlers.length) {
this.saveListUpdateHandlers.delete(id);
await this.updateSaveListSubscriptions();
}
}
}
async updateSaveListSubscriptions() {
if (!this.connector.connected) {
return;
}
await libLink.messages.setSaveListSubscriptions.send(this, {
all: false,
instance_ids: [...this.saveListUpdateHandlers.keys()],
});
}
async logMessageEventHandler(message) {
let info = message.data.info;