Files
factorio-clusterio/packages/web_ui/src/components/InstanceList.tsx
T
BastiaanandClaude Opus 5.5 d250394580 Show the mod pack an instance uses in the web UI (#1177)
InstanceDetails now carries factorio.mod_pack_id as modPackId, so the
instance list and pages can show it without fetching each config. The
web UI resolves an unset value to the controller default and tags it
"Default". The name links to the mod pack page.

Closes #852

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 00:07:26 +00:00

173 lines
5.5 KiB
TypeScript

import React from "react";
import { message, Button, Table, Space } from "antd";
import CopyOutlined from "@ant-design/icons/CopyOutlined";
import type { SizeType } from "antd/es/config-provider/SizeContext";
import type { ColumnType } from "antd/es/table/interface";
import { useAccount } from "../model/account";
import { useSystems } from "../model/system";
import { useHosts } from "../model/host";
import { useDefaultModPack, useModPacks } from "../model/mod_pack";
import { RestartRequired } from "./system_metrics";
import InstanceStatusTag from "./InstanceStatusTag";
import InstanceModPack from "./InstanceModPack";
import InstanceControlButton, { InstanceControlButtonPermissions } from "./InstanceControlButton";
import * as lib from "@clusterio/lib";
import Link from "./Link";
import { instanceModPack, instancePublicAddress } from "../util/instance";
import useTableQueryState from "../util/useTableQueryState";
import useColumnSearch from "../util/useColumnSearch";
import useRowNavigation from "../util/useRowNavigation";
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
type InstanceListProps = {
instances: ReadonlyMap<number, Readonly<lib.InstanceDetails>>;
size?: SizeType;
hideAssignedHost?: boolean;
};
export default function InstanceList(props: InstanceListProps) {
let account = useAccount();
let [hosts] = useHosts();
const [systems] = useSystems();
const [modPacks] = useModPacks();
const defaultModPack = useDefaultModPack();
const tableState = useTableQueryState<lib.InstanceDetails>({
namespace: "instance", defaultSortKey: "name",
});
const nameSearch = useColumnSearch<lib.InstanceDetails>(
tableState, "name", instance => instance.name, "Search instances"
);
const rowNav = useRowNavigation();
function hostName(hostId?: number) {
if (hostId === undefined) {
return "";
}
return hosts.get(hostId)?.name ?? String(hostId);
}
function modPackOf(instance: lib.InstanceDetails) {
return instanceModPack(instance.modPackId, modPacks, defaultModPack);
}
function modPackName(instance: lib.InstanceDetails) {
const { id, modPack } = modPackOf(instance);
return modPack?.name ?? (id !== undefined ? String(id) : "");
}
function integerFactorioVersionOrDefault(instance: lib.InstanceDetails) {
const v = instance.factorioVersion;
if (v && lib.isPartialVersion(v)) {
return lib.integerPartialVersion(v);
}
return -1;
}
let columns: ColumnType<lib.InstanceDetails>[] = [
{
title: "Name",
dataIndex: "name",
sorter: (a, b) => strcmp(a["name"], b["name"]),
sortOrder: tableState.sortOrder("name"),
filteredValue: tableState.filteredValue("name"),
className: "table-link-cell",
render: (_, instance) => <Link to={`/instances/${instance.id}/view`} style={{ color: "inherit" }}>
{instance.name}
</Link>,
...nameSearch,
},
{
title: "Assigned Host",
key: "assignedHost",
className: "table-link-cell",
render: (_, instance) => <Space>
{instance.assignedHost !== undefined && <Link
to={`/hosts/${instance.assignedHost}/view`}
onClick={e => e.stopPropagation()}
>
{hostName(instance.assignedHost)}
</Link>}
<RestartRequired system={instance.assignedHost ? systems.get(instance.assignedHost) : undefined}/>
</Space>,
sorter: (a, b) => strcmp(hostName(a.assignedHost), hostName(b.assignedHost)),
sortOrder: tableState.sortOrder("assignedHost"),
responsive: ["sm"],
},
{
title: "Public address",
key: "publicAddress",
render: (_, instance) => {
let publicAddress = instancePublicAddress(instance, hosts.get(instance.assignedHost!) ?? null);
return publicAddress ? <>
{publicAddress}
<Button
type="text"
icon={<CopyOutlined />}
onClick={(e) => {
e.stopPropagation();
navigator.clipboard.writeText(publicAddress ?? "");
message.success("Copied public address!");
}}
/>
</> : "";
},
sorter: (a, b) => strcmp(
instancePublicAddress(a, hosts.get(a.assignedHost!) ?? null),
instancePublicAddress(b, hosts.get(b.assignedHost!) ?? null)
),
sortOrder: tableState.sortOrder("publicAddress"),
responsive: ["lg"],
},
{
title: "Factorio Version",
key: "version",
render: (_, instance) => instance.factorioVersion ?? "unknown",
sorter: (a, b) => integerFactorioVersionOrDefault(a) - integerFactorioVersionOrDefault(b),
sortOrder: tableState.sortOrder("version"),
responsive: ["xl"],
},
{
title: "Mod Pack",
key: "modPack",
className: "table-link-cell",
render: (_, instance) => <InstanceModPack resolved={modPackOf(instance)} />,
sorter: (a, b) => strcmp(modPackName(a), modPackName(b)),
sortOrder: tableState.sortOrder("modPack"),
responsive: ["lg"],
},
{
title: "Status",
key: "status",
render: (_, instance) => <InstanceStatusTag status={instance["status"]} />,
sorter: (a, b) => strcmp(a["status"], b["status"]),
sortOrder: tableState.sortOrder("status"),
},
];
if (account.hasAnyPermission(...InstanceControlButtonPermissions)) {
columns.push({
key: "action",
render: (_, instance) => <InstanceControlButton size="small" instance={instance} />,
responsive: ["sm"],
align: "right",
width: 100,
});
}
if (props.hideAssignedHost) {
columns.splice(1, 1);
}
return <Table
size={props.size || "large"}
columns={columns}
dataSource={[...props.instances.values()]}
rowKey={instance => instance["id"]}
pagination={tableState.pagination}
onChange={tableState.onChange}
onRow={record => rowNav(`/instances/${record.id}/view`)}
/>;
}