mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2026-11-19 15:23:12 +09:00
Address review: page layout, five more features, framework changes
Framework: - Intervals are gone. Update periods are hardcoded on_nth_tick values again, since nobody has needed to change them. - apply is a single loop over the declared fields and logs a warning when an override is invalid. receive_update also warns about unknown keys. - Nested tables are addressed as "section.key". Lists of strings can be overridden. Features.optional declares a value with no default. - Features.on_apply rebuilds values derived from the config, such as lookup sets. It also runs during on_load. exp_roles is assumed to be present: - AFK Kick picks a role (active_role_id) instead of a custom check function. - Chat Auto Reply, Protection, and Nuke Protection no longer take a permission as a setting. New features, each chosen for an edge case: - Discord Alerts: conditional handlers, and a command map that becomes a list. - Entity Protection: lists turned into sets at load, and bookkeeping that must keep running while disabled. - Nuke Protection: config keyed by defines, flattened to a banned items list. - Popups: one config shared by two control files. - Spawn Area: nested sections, and settings that only apply when the map is created. Page: now laid out like the role page. It has a search across every setting, one long list with a sticky sidebar to jump between sections, and the enabled switch separated at the front of each header with Reset to defaults on the right. Changed rows are highlighted, and a bottom bar offers Revert and Apply. Role settings use a role picker and lists use a tag select. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
69e9f172a3
commit
4bc1773c82
23 files changed
+989
-670
No files matched your search
@@ -1,146 +1,323 @@
|
||||
import React, { useContext, useState } from "react";
|
||||
import { Button, Card, Col, Empty, Form, Input, InputNumber, Row, Space, Switch, Typography, theme } from "antd";
|
||||
import { Button, Checkbox, Col, Divider, Input, InputNumber, Row, Select, Space, Switch } from "antd";
|
||||
|
||||
import { ControlContext, PageHeader, PageLayout, notifyErrorHandler, useAccount } from "@clusterio/web_ui";
|
||||
import { ControlContext, PageHeader, PageLayout, notifyErrorHandler, useAccount, useRoles } from "@clusterio/web_ui";
|
||||
|
||||
import { Feature, FeatureField, FeatureValue, features } from "../../features.js";
|
||||
import { Feature, FeatureField, FeatureValue, features, isDefaultValue } from "../../features.js";
|
||||
import { FeatureRecord, FeatureUpdateRequest } from "../../messages.js";
|
||||
import { useFeatures } from "../index";
|
||||
|
||||
function FeatureListItem(props: { feature: Feature, enabled: boolean, selected: boolean, onClick: () => void }) {
|
||||
const { token } = theme.useToken();
|
||||
type FeatureState = { enabled: boolean, values: Record<string, FeatureValue> };
|
||||
type PendingChanges = Record<string, { enabled?: boolean, values: Record<string, FeatureValue> }>;
|
||||
|
||||
// Same colours as the role and permission group pages
|
||||
const borderColor = "#424242";
|
||||
const modifiedColor = "#2a1912";
|
||||
|
||||
function sameValue(a: FeatureValue | undefined, b: FeatureValue | undefined) {
|
||||
if (Array.isArray(a) && Array.isArray(b)) {
|
||||
return a.length === b.length && a.every((item, index) => item === b[index]);
|
||||
}
|
||||
return a === b;
|
||||
}
|
||||
|
||||
/** The stored state of a feature, with defaults for values which were not set. */
|
||||
function storedState(feature: Feature, record: FeatureRecord | undefined): FeatureState {
|
||||
return {
|
||||
enabled: record?.enabled ?? true,
|
||||
values: {
|
||||
...Object.fromEntries(feature.fields.map(field => [field.name, field.default])),
|
||||
...record?.values,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/** Group fields by the section in their name, "turrets.enabled" is in the "turrets" section. */
|
||||
function groupFields(fields: FeatureField[]) {
|
||||
const groups = new Map<string, FeatureField[]>();
|
||||
for (const field of fields) {
|
||||
const section = field.name.includes(".") ? field.name.slice(0, field.name.lastIndexOf(".")) : "";
|
||||
if (!groups.has(section)) {
|
||||
groups.set(section, []);
|
||||
}
|
||||
groups.get(section)!.push(field);
|
||||
}
|
||||
return [...groups.entries()];
|
||||
}
|
||||
|
||||
/** Converts a section name into Title Case, same as the group titles on the role page */
|
||||
function formatSectionTitle(name: string) {
|
||||
return name
|
||||
.replace(/\./g, " / ")
|
||||
.replace(/_/g, " ")
|
||||
.split(" ")
|
||||
.filter(Boolean)
|
||||
.map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
|
||||
.join(" ");
|
||||
}
|
||||
|
||||
function matches(text: string, query: string) {
|
||||
return text.toLowerCase().includes(query);
|
||||
}
|
||||
|
||||
/** The fields of a feature which match the search, every field if the feature itself matches. */
|
||||
function searchFields(feature: Feature, query: string) {
|
||||
if (!query || matches(feature.title, query) || matches(feature.description, query) || matches(feature.name, query)) {
|
||||
return feature.fields;
|
||||
}
|
||||
return feature.fields.filter(field => (
|
||||
matches(field.title, query) || matches(field.description, query) || matches(field.name, query)
|
||||
));
|
||||
}
|
||||
|
||||
function RoleSelect(props: { value: FeatureValue, disabled: boolean, onChange: (value: FeatureValue) => void }) {
|
||||
const [roles, synced] = useRoles();
|
||||
return <Select
|
||||
showSearch
|
||||
allowClear
|
||||
placeholder="No role"
|
||||
optionFilterProp="label"
|
||||
style={{ minWidth: 200 }}
|
||||
value={props.value ?? undefined}
|
||||
onChange={value => props.onChange(value ?? null)}
|
||||
options={[...roles.values()].map(role => ({ label: role.name, value: role.id }))}
|
||||
disabled={props.disabled || !synced}
|
||||
loading={!synced}
|
||||
/>;
|
||||
}
|
||||
|
||||
function FieldInput(props: { field: FeatureField, value: FeatureValue, disabled: boolean, onChange: (value: FeatureValue) => void }) {
|
||||
const { field, value, disabled, onChange } = props;
|
||||
switch (field.type) {
|
||||
case "number":
|
||||
return <InputNumber
|
||||
value={value as number}
|
||||
min={field.min}
|
||||
addonAfter={field.unit}
|
||||
disabled={disabled}
|
||||
onChange={next => onChange(next ?? field.default)}
|
||||
/>;
|
||||
case "string":
|
||||
return <Input value={value as string} disabled={disabled} onChange={e => onChange(e.target.value)} style={{ maxWidth: 400 }} />;
|
||||
case "string_list":
|
||||
return <Select
|
||||
mode="tags"
|
||||
value={value as string[]}
|
||||
disabled={disabled}
|
||||
onChange={next => onChange(next)}
|
||||
open={false}
|
||||
style={{ width: "100%", maxWidth: 600 }}
|
||||
/>;
|
||||
case "role":
|
||||
return <RoleSelect value={value} disabled={disabled} onChange={onChange} />;
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/** A single setting, laid out like a permission on the role page. */
|
||||
function FieldItem(props: {
|
||||
field: FeatureField, value: FeatureValue, stored: FeatureValue, disabled: boolean, onChange: (value: FeatureValue) => void,
|
||||
}) {
|
||||
const { field, value, stored, disabled, onChange } = props;
|
||||
const modified = !sameValue(value, stored);
|
||||
return <div style={{
|
||||
marginBottom: 8,
|
||||
padding: "4px 6px",
|
||||
background: modified ? modifiedColor : undefined,
|
||||
borderRadius: 4,
|
||||
}}>
|
||||
{field.type === "boolean"
|
||||
? <Checkbox checked={value as boolean} disabled={disabled} onChange={e => onChange(e.target.checked)}>
|
||||
{field.title}
|
||||
</Checkbox>
|
||||
: <Space wrap>
|
||||
<span>{field.title}</span>
|
||||
<FieldInput field={field} value={value} disabled={disabled} onChange={onChange} />
|
||||
</Space>}
|
||||
<div style={{ marginLeft: field.type === "boolean" ? 24 : 0, color: "#888", fontSize: 12 }}>
|
||||
{field.description}
|
||||
</div>
|
||||
</div>;
|
||||
}
|
||||
|
||||
function FeatureSection(props: {
|
||||
feature: Feature,
|
||||
fields: FeatureField[],
|
||||
state: FeatureState,
|
||||
stored: FeatureState,
|
||||
canEdit: boolean,
|
||||
onEnabled: (enabled: boolean) => void,
|
||||
onValue: (name: string, value: FeatureValue) => void,
|
||||
onReset: () => void,
|
||||
}) {
|
||||
const { feature, fields, state, stored, canEdit } = props;
|
||||
const atDefaults = feature.fields.every(field => isDefaultValue(field, state.values[field.name]));
|
||||
return <div id={`feature-${feature.name}`} style={{ border: `1px solid ${borderColor}`, padding: 12, borderRadius: 6, scrollMarginTop: 80 }}>
|
||||
<div style={{ display: "flex", alignItems: "center", gap: 12 }}>
|
||||
<div style={{
|
||||
padding: "4px 6px",
|
||||
borderRadius: 4,
|
||||
background: state.enabled !== stored.enabled ? modifiedColor : undefined,
|
||||
}}>
|
||||
<Switch checked={state.enabled} disabled={!canEdit} onChange={props.onEnabled} />
|
||||
</div>
|
||||
<div style={{ flexGrow: 1 }}>
|
||||
<strong>{feature.title}</strong>
|
||||
<div style={{ color: "#888", fontSize: 12 }}>{feature.description}</div>
|
||||
</div>
|
||||
{canEdit && feature.fields.length > 0 && <Button size="small" disabled={atDefaults} onClick={props.onReset}>
|
||||
Reset to defaults
|
||||
</Button>}
|
||||
</div>
|
||||
{fields.length > 0 && <>
|
||||
<Divider style={{ margin: "12px 0" }} />
|
||||
<div style={{ opacity: state.enabled ? 1 : 0.6 }}>
|
||||
{groupFields(fields).map(([section, sectionFields]) => <div key={section}>
|
||||
{section && <div style={{ fontWeight: 600, margin: "8px 6px 4px" }}>{formatSectionTitle(section)}</div>}
|
||||
{sectionFields.map(field => <FieldItem
|
||||
key={field.name}
|
||||
field={field}
|
||||
value={state.values[field.name]}
|
||||
stored={stored.values[field.name]}
|
||||
disabled={!canEdit}
|
||||
onChange={value => props.onValue(field.name, value)}
|
||||
/>)}
|
||||
</div>)}
|
||||
</div>
|
||||
</>}
|
||||
</div>;
|
||||
}
|
||||
|
||||
function FeatureNav(props: { feature: Feature, enabled: boolean }) {
|
||||
return <div
|
||||
role="button"
|
||||
onClick={props.onClick}
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: token.marginXS,
|
||||
padding: `${token.paddingXS}px ${token.paddingSM}px`,
|
||||
marginBottom: token.marginXS,
|
||||
cursor: "pointer",
|
||||
borderRadius: token.borderRadius,
|
||||
border: `1px solid ${props.enabled ? token.colorSuccessBorder : token.colorBorder}`,
|
||||
outline: props.selected ? `2px solid ${token.colorPrimary}` : undefined,
|
||||
background: props.enabled ? token.colorSuccessBg : undefined,
|
||||
}}
|
||||
onClick={() => document.getElementById(`feature-${props.feature.name}`)?.scrollIntoView({ behavior: "smooth" })}
|
||||
style={{ display: "flex", alignItems: "center", gap: 8, padding: "4px 8px", cursor: "pointer", borderRadius: 4 }}
|
||||
>
|
||||
<span style={{
|
||||
width: 8,
|
||||
height: 8,
|
||||
borderRadius: "50%",
|
||||
flexShrink: 0,
|
||||
background: props.enabled ? token.colorSuccess : token.colorTextQuaternary,
|
||||
background: props.enabled ? "#52c41a" : "#595959",
|
||||
}} />
|
||||
{props.feature.title}
|
||||
</div>;
|
||||
}
|
||||
|
||||
/** Returned as an element rather than a component so Form.Item can pass its value and onChange to it. */
|
||||
function fieldInput(field: FeatureField, disabled: boolean) {
|
||||
switch (field.type) {
|
||||
case "boolean":
|
||||
return <Switch disabled={disabled} />;
|
||||
case "number":
|
||||
return <InputNumber disabled={disabled} min={field.min} addonAfter={field.unit} />;
|
||||
case "string":
|
||||
return <Input disabled={disabled} />;
|
||||
}
|
||||
}
|
||||
|
||||
function defaultValues(feature: Feature) {
|
||||
return Object.fromEntries(feature.fields.map(field => [field.name, field.default]));
|
||||
}
|
||||
|
||||
function FeatureForm(props: { feature: Feature, record: FeatureRecord | undefined }) {
|
||||
const { feature, record } = props;
|
||||
const control = useContext(ControlContext);
|
||||
const account = useAccount();
|
||||
const [form] = Form.useForm();
|
||||
const [dirty, setDirty] = useState(false);
|
||||
const [saving, setSaving] = useState(false);
|
||||
const canEdit = account.hasPermission("exp_scenario.config.edit");
|
||||
|
||||
const initialValues = {
|
||||
enabled: record?.enabled ?? true,
|
||||
...defaultValues(feature),
|
||||
...record?.values,
|
||||
};
|
||||
|
||||
function save() {
|
||||
const { enabled, ...values } = form.getFieldsValue() as { enabled: boolean } & Record<string, FeatureValue>;
|
||||
setSaving(true);
|
||||
control.send(new FeatureUpdateRequest(feature.name, enabled, values))
|
||||
.then(() => setDirty(false))
|
||||
.catch(notifyErrorHandler(`Error saving ${feature.title}`))
|
||||
.finally(() => setSaving(false));
|
||||
}
|
||||
|
||||
return <Card
|
||||
title={<>
|
||||
{feature.title}
|
||||
<Typography.Paragraph type="secondary" style={{ fontWeight: "normal", margin: 0 }}>
|
||||
{feature.description}
|
||||
</Typography.Paragraph>
|
||||
</>}
|
||||
>
|
||||
<Form
|
||||
form={form}
|
||||
layout="vertical"
|
||||
initialValues={initialValues}
|
||||
onValuesChange={() => setDirty(true)}
|
||||
onFinish={save}
|
||||
>
|
||||
<Form.Item name="enabled" label="Enabled" valuePropName="checked">
|
||||
<Switch disabled={!canEdit} />
|
||||
</Form.Item>
|
||||
{feature.fields.map(field => <Form.Item
|
||||
key={field.name}
|
||||
name={field.name}
|
||||
label={field.title}
|
||||
extra={field.description}
|
||||
valuePropName={field.type === "boolean" ? "checked" : "value"}
|
||||
rules={field.type === "boolean" ? [] : [{ required: true, message: `${field.title} is required` }]}
|
||||
>
|
||||
{fieldInput(field, !canEdit)}
|
||||
</Form.Item>)}
|
||||
{canEdit && <Space>
|
||||
<Button type="primary" htmlType="submit" loading={saving} disabled={!dirty}>Save</Button>
|
||||
<Button onClick={() => {
|
||||
form.setFieldsValue(defaultValues(feature));
|
||||
setDirty(true);
|
||||
}}>Reset to defaults</Button>
|
||||
</Space>}
|
||||
</Form>
|
||||
</Card>;
|
||||
}
|
||||
|
||||
/** Enable, disable, and configure the scenario features listed in features.ts. */
|
||||
export default function FeaturesPage() {
|
||||
const control = useContext(ControlContext);
|
||||
const account = useAccount();
|
||||
const [records] = useFeatures();
|
||||
const [selected, setSelected] = useState(features[0]?.name);
|
||||
const feature = features.find(f => f.name === selected);
|
||||
const record = selected ? records.get(selected) : undefined;
|
||||
const [pending, setPending] = useState<PendingChanges>({});
|
||||
const [search, setSearch] = useState("");
|
||||
const canEdit = Boolean(account.hasPermission("exp_scenario.config.edit"));
|
||||
|
||||
const stored = Object.fromEntries(features.map(feature => [feature.name, storedState(feature, records.get(feature.name))]));
|
||||
const current = (name: string): FeatureState => ({
|
||||
enabled: pending[name]?.enabled ?? stored[name].enabled,
|
||||
values: { ...stored[name].values, ...pending[name]?.values },
|
||||
});
|
||||
|
||||
/** Record a change, dropping it again if it matches what is stored */
|
||||
function change(name: string, update: (entry: PendingChanges[string]) => void) {
|
||||
setPending(prev => {
|
||||
const entry = { enabled: prev[name]?.enabled, values: { ...prev[name]?.values } };
|
||||
update(entry);
|
||||
if (entry.enabled === stored[name].enabled) {
|
||||
delete entry.enabled;
|
||||
}
|
||||
for (const [key, value] of Object.entries(entry.values)) {
|
||||
if (sameValue(value, stored[name].values[key])) {
|
||||
delete entry.values[key];
|
||||
}
|
||||
}
|
||||
const next = { ...prev };
|
||||
if (entry.enabled === undefined && !Object.keys(entry.values).length) {
|
||||
delete next[name];
|
||||
} else {
|
||||
next[name] = entry;
|
||||
}
|
||||
return next;
|
||||
});
|
||||
}
|
||||
|
||||
function applyChanges() {
|
||||
for (const name of Object.keys(pending)) {
|
||||
const state = current(name);
|
||||
control.send(new FeatureUpdateRequest(name, state.enabled, state.values))
|
||||
.then(() => setPending(prev => {
|
||||
const next = { ...prev };
|
||||
delete next[name];
|
||||
return next;
|
||||
}))
|
||||
.catch(notifyErrorHandler(`Error saving ${features.find(f => f.name === name)?.title ?? name}`));
|
||||
}
|
||||
}
|
||||
|
||||
const query = search.trim().toLowerCase();
|
||||
const shown = features
|
||||
.map(feature => ({ feature, fields: searchFields(feature, query) }))
|
||||
.filter(({ feature, fields }) => !query || fields.length || matches(feature.title, query));
|
||||
|
||||
return <PageLayout nav={[{ name: "Scenario Features" }]}>
|
||||
<PageHeader title="Scenario Features" />
|
||||
<Row gutter={[16, 16]}>
|
||||
<Col xs={24} md={8} lg={6}>
|
||||
<Card title="Features">
|
||||
{features.map(f => <FeatureListItem
|
||||
key={f.name}
|
||||
feature={f}
|
||||
enabled={records.get(f.name)?.enabled ?? true}
|
||||
selected={f.name === selected}
|
||||
onClick={() => setSelected(f.name)}
|
||||
|
||||
{Object.keys(pending).length > 0 && <div style={{
|
||||
position: "fixed",
|
||||
bottom: 24,
|
||||
left: "50%",
|
||||
transform: "translateX(-50%)",
|
||||
background: modifiedColor,
|
||||
borderRadius: 8,
|
||||
boxShadow: "0 8px 24px rgba(0,0,0,0.12)",
|
||||
padding: "10px 14px",
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: 12,
|
||||
zIndex: 1000,
|
||||
}}>
|
||||
<span style={{ color: "#FFF" }}>You have unsaved changes</span>
|
||||
<Space>
|
||||
<Button onClick={() => setPending({})}>Revert</Button>
|
||||
<Button type="primary" onClick={applyChanges}>Apply</Button>
|
||||
</Space>
|
||||
</div>}
|
||||
|
||||
<Input.Search placeholder="Search features and settings" allowClear
|
||||
onChange={e => setSearch(e.target.value)} style={{ marginBottom: 16 }} />
|
||||
|
||||
<Row gutter={16} wrap={false}>
|
||||
<Col flex="200px">
|
||||
{/* Clear of the fixed page header */}
|
||||
<div style={{ position: "sticky", top: 80 }}>
|
||||
{shown.map(({ feature }) => <FeatureNav
|
||||
key={feature.name}
|
||||
feature={feature}
|
||||
enabled={current(feature.name).enabled}
|
||||
/>)}
|
||||
</Card>
|
||||
</div>
|
||||
</Col>
|
||||
<Col xs={24} md={16} lg={18}>
|
||||
{feature
|
||||
// Remount on save from anywhere so the form shows the stored values
|
||||
? <FeatureForm key={`${feature.name}:${record?.updatedAtMs ?? 0}`} feature={feature} record={record} />
|
||||
: <Card><Empty /></Card>}
|
||||
<Col flex="auto" style={{ minWidth: 0 }}>
|
||||
<Space direction="vertical" style={{ width: "100%" }}>
|
||||
{shown.map(({ feature, fields }) => <FeatureSection
|
||||
key={feature.name}
|
||||
feature={feature}
|
||||
fields={fields}
|
||||
state={current(feature.name)}
|
||||
stored={stored[feature.name]}
|
||||
canEdit={canEdit}
|
||||
onEnabled={enabled => change(feature.name, entry => { entry.enabled = enabled; })}
|
||||
onValue={(key, value) => change(feature.name, entry => { entry.values[key] = value; })}
|
||||
onReset={() => change(feature.name, entry => {
|
||||
for (const field of feature.fields) {
|
||||
entry.values[field.name] = field.default;
|
||||
}
|
||||
})}
|
||||
/>)}
|
||||
</Space>
|
||||
</Col>
|
||||
</Row>
|
||||
</PageLayout>;
|
||||
|
||||
Reference in new issue
Block a user