From 6f59a556e0562a9444fc7921598ea62d68b7644a Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 31 Jul 2026 05:57:11 +0200 Subject: [PATCH] refactor(widgets): share table layout state --- .../src/beszel-system-table/component.spec.ts | 14 +- .../src/beszel-system-table/component.tsx | 124 ++------------ .../src/common/use-persisted-table-layout.ts | 159 ++++++++++++++++++ packages/widgets/src/docker/component.spec.ts | 16 +- packages/widgets/src/docker/component.tsx | 124 ++------------ 5 files changed, 202 insertions(+), 235 deletions(-) create mode 100644 packages/widgets/src/common/use-persisted-table-layout.ts diff --git a/packages/widgets/src/beszel-system-table/component.spec.ts b/packages/widgets/src/beszel-system-table/component.spec.ts index 6bbe59fc3..0dd3e655d 100644 --- a/packages/widgets/src/beszel-system-table/component.spec.ts +++ b/packages/widgets/src/beszel-system-table/component.spec.ts @@ -1,15 +1,20 @@ import { describe, expect, test } from "vitest"; -import { parseColumnOrder, parseColumnWidths } from "./component"; +import { parseColumnOrder, parseColumnWidths } from "../common/use-persisted-table-layout"; + +const columnAccessors = ["name", "cpu", "memory", "disk", "temp"]; describe("Beszel table column layout options", () => { test("ignores malformed column layout JSON", () => { - expect(parseColumnOrder("{")).toEqual([]); - expect(parseColumnWidths("[]")).toEqual({}); + expect(parseColumnOrder("{", columnAccessors)).toEqual([]); + expect(parseColumnWidths("[]", columnAccessors)).toEqual({}); }); test("removes stale and duplicate column accessors", () => { - expect(parseColumnOrder(JSON.stringify(["memory", "removed", "cpu", "memory"]))).toEqual(["memory", "cpu"]); + expect(parseColumnOrder(JSON.stringify(["memory", "removed", "cpu", "memory"]), columnAccessors)).toEqual([ + "memory", + "cpu", + ]); }); test("keeps only finite positive widths for known columns", () => { @@ -22,6 +27,7 @@ describe("Beszel table column layout options", () => { removed: 100, temp: null, }), + columnAccessors, ), ).toEqual({ cpu: 140 }); }); diff --git a/packages/widgets/src/beszel-system-table/component.tsx b/packages/widgets/src/beszel-system-table/component.tsx index 32b1fd5a3..c155eda37 100644 --- a/packages/widgets/src/beszel-system-table/component.tsx +++ b/packages/widgets/src/beszel-system-table/component.tsx @@ -2,10 +2,10 @@ import "./styles.css"; -import { useCallback, useEffect, useMemo, useRef, useState } from "react"; +import { useCallback, useEffect, useMemo, useState } from "react"; import { Center, Group, Indicator, Loader, Progress, Text } from "@mantine/core"; import type { DataTableColumn, DataTableSortStatus } from "mantine-datatable"; -import { DataTable, useDataTableColumns } from "mantine-datatable"; +import { DataTable } from "mantine-datatable"; import { Activity, Battery, @@ -28,6 +28,7 @@ import { showErrorNotification } from "@homarr/notifications"; import { useScopedI18n } from "@homarr/translation/client"; import type { WidgetComponentProps } from "../definition"; +import { usePersistedTableLayout } from "../common/use-persisted-table-layout"; import type { BeszelSystemRow } from "../beszel/_shared/types"; import { loadAvgColor, statusColorMap, thresholdColor } from "../beszel/_shared/colors"; import { @@ -89,40 +90,6 @@ const getSizeConfig = (width: number): SizeConfig => { }; }; -export const parseColumnOrder = (value: string): string[] => { - if (!value) return []; - try { - const parsed: unknown = JSON.parse(value); - if (!Array.isArray(parsed)) return []; - - const allowed = new Set(columnAccessors); - return parsed.filter( - (accessor, index): accessor is string => - typeof accessor === "string" && allowed.has(accessor) && parsed.indexOf(accessor) === index, - ); - } catch { - return []; - } -}; - -export const parseColumnWidths = (value: string): Record => { - if (!value) return {}; - try { - const parsed: unknown = JSON.parse(value); - if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) return {}; - - const allowed = new Set(columnAccessors); - return Object.fromEntries( - Object.entries(parsed).filter( - (entry): entry is [string, number] => - allowed.has(entry[0]) && typeof entry[1] === "number" && Number.isFinite(entry[1]) && entry[1] > 0, - ), - ); - } catch { - return {}; - } -}; - export default function BeszelSystemTableWidget({ options, integrationIds, @@ -159,9 +126,6 @@ export default function BeszelSystemTableWidget({ [boardId, hasChangeAccess, itemId, saveItemOptions, setOptions], ); - const savedOrder = useMemo(() => parseColumnOrder(options.columnOrder), [options.columnOrder]); - const savedWidths = useMemo(() => parseColumnWidths(options.columnWidths), [options.columnWidths]); - const filteredSystems = useBeszelFilteredSystems(results, options.statusFilter); const [sortStatus, setSortStatus] = useState>({ @@ -376,79 +340,15 @@ export default function BeszelSystemTableWidget({ return cols.filter(Boolean) as DataTableColumn[]; }, [options, t, size]); - const visibleAccessors = useMemo(() => columns.map(({ accessor }) => String(accessor)), [columns]); - const visibleAccessorSet = useMemo(() => new Set(visibleAccessors), [visibleAccessors]); - const restoredOrder = useMemo( - () => [ - ...savedOrder.filter((accessor) => visibleAccessorSet.has(accessor)), - ...visibleAccessors.filter((accessor) => !savedOrder.includes(accessor)), - ], - [savedOrder, visibleAccessors, visibleAccessorSet], - ); - const storeKey = `beszel-system-table-${itemId ?? "preview"}-${[...visibleAccessors].toSorted().join(",")}`; - const { effectiveColumns, columnsOrder, columnsWidth, setColumnsOrder, setMultipleColumnWidths } = - useDataTableColumns({ - key: storeKey, - columns, - }); - - const lastStoreKey = useRef(storeKey); - const hydrated = useRef(false); - useEffect(() => { - if (lastStoreKey.current !== storeKey) { - lastStoreKey.current = storeKey; - hydrated.current = false; - } - if (hydrated.current) return; - - if (restoredOrder.length > 0) setColumnsOrder(restoredOrder); - const visibleWidths = Object.entries(savedWidths) - .filter(([accessor]) => visibleAccessorSet.has(accessor)) - .map(([accessor, columnWidth]) => ({ accessor, width: columnWidth })); - if (visibleWidths.length > 0) setMultipleColumnWidths(visibleWidths); - - requestAnimationFrame(() => { - hydrated.current = true; - }); - }, [restoredOrder, savedWidths, setColumnsOrder, setMultipleColumnWidths, storeKey, visibleAccessorSet]); - - const previousOrder = useRef(columnsOrder); - const previousWidths = useRef(columnsWidth); - useEffect(() => { - if (!hydrated.current) return; - - const orderChanged = JSON.stringify(columnsOrder) !== JSON.stringify(previousOrder.current); - const widthsChanged = JSON.stringify(columnsWidth) !== JSON.stringify(previousWidths.current); - previousOrder.current = columnsOrder; - previousWidths.current = columnsWidth; - if (!orderChanged && !widthsChanged) return; - - const newLayout: Partial> = {}; - if (orderChanged) { - const fullOrder = [...savedOrder, ...columnAccessors.filter((accessor) => !savedOrder.includes(accessor))]; - const reorderedVisibleColumns = [...columnsOrder]; - const mergedOrder = fullOrder.map((accessor) => - visibleAccessorSet.has(accessor) ? (reorderedVisibleColumns.shift() ?? accessor) : accessor, - ); - newLayout.columnOrder = JSON.stringify(mergedOrder); - } - if (widthsChanged) { - const widthMap: Record = { ...savedWidths }; - for (const entry of columnsWidth) { - const accessor = Object.keys(entry)[0]; - if (!accessor || !visibleAccessorSet.has(accessor)) continue; - const columnWidth = entry[accessor as keyof typeof entry]; - if (typeof columnWidth === "number" && Number.isFinite(columnWidth) && columnWidth > 0) { - widthMap[accessor] = columnWidth; - } else if (typeof columnWidth === "string" && columnWidth.endsWith("px")) { - const parsedWidth = Number.parseInt(columnWidth, 10); - if (Number.isFinite(parsedWidth) && parsedWidth > 0) widthMap[accessor] = parsedWidth; - } - } - newLayout.columnWidths = JSON.stringify(widthMap); - } - persistLayout(newLayout); - }, [columnsOrder, columnsWidth, persistLayout, savedOrder, savedWidths, visibleAccessorSet]); + const { effectiveColumns, storeKey } = usePersistedTableLayout({ + columns, + columnAccessors, + columnOrder: options.columnOrder, + columnWidths: options.columnWidths, + itemId, + storeKeyPrefix: "beszel-system-table", + onLayoutChange: persistLayout, + }); const handleRowClick = useCallback( ({ record }: { record: SystemRowWithKey }) => { diff --git a/packages/widgets/src/common/use-persisted-table-layout.ts b/packages/widgets/src/common/use-persisted-table-layout.ts new file mode 100644 index 000000000..fe7882a46 --- /dev/null +++ b/packages/widgets/src/common/use-persisted-table-layout.ts @@ -0,0 +1,159 @@ +"use client"; + +import { useEffect, useMemo, useRef } from "react"; +import type { DataTableColumn } from "mantine-datatable"; +import { useDataTableColumns } from "mantine-datatable"; + +interface TableLayoutOptions { + columnOrder?: string; + columnWidths?: string; +} + +interface UsePersistedTableLayoutProps { + columns: DataTableColumn[]; + columnAccessors: readonly string[]; + columnOrder: string; + columnWidths: string; + itemId: string | undefined; + storeKeyPrefix: string; + onLayoutChange: (layout: TableLayoutOptions) => void; +} + +const layoutSaveDelay = 350; + +export const parseColumnOrder = (value: string, columnAccessors: readonly string[]): string[] => { + if (!value) return []; + try { + const parsed: unknown = JSON.parse(value); + if (!Array.isArray(parsed)) return []; + + const allowed = new Set(columnAccessors); + return parsed.filter( + (accessor, index): accessor is string => + typeof accessor === "string" && allowed.has(accessor) && parsed.indexOf(accessor) === index, + ); + } catch { + return []; + } +}; + +export const parseColumnWidths = (value: string, columnAccessors: readonly string[]): Record => { + if (!value) return {}; + try { + const parsed: unknown = JSON.parse(value); + if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) return {}; + + const allowed = new Set(columnAccessors); + return Object.fromEntries( + Object.entries(parsed).filter( + (entry): entry is [string, number] => + allowed.has(entry[0]) && typeof entry[1] === "number" && Number.isFinite(entry[1]) && entry[1] > 0, + ), + ); + } catch { + return {}; + } +}; + +export const usePersistedTableLayout = ({ + columns, + columnAccessors, + columnOrder, + columnWidths, + itemId, + storeKeyPrefix, + onLayoutChange, +}: UsePersistedTableLayoutProps) => { + const savedOrder = useMemo(() => parseColumnOrder(columnOrder, columnAccessors), [columnAccessors, columnOrder]); + const savedWidths = useMemo(() => parseColumnWidths(columnWidths, columnAccessors), [columnAccessors, columnWidths]); + const visibleAccessors = useMemo(() => columns.map(({ accessor }) => String(accessor)), [columns]); + const visibleAccessorSet = useMemo(() => new Set(visibleAccessors), [visibleAccessors]); + const restoredOrder = useMemo( + () => [ + ...savedOrder.filter((accessor) => visibleAccessorSet.has(accessor)), + ...visibleAccessors.filter((accessor) => !savedOrder.includes(accessor)), + ], + [savedOrder, visibleAccessors, visibleAccessorSet], + ); + const storeKey = `${storeKeyPrefix}-${itemId ?? "preview"}-${[...visibleAccessors].toSorted().join(",")}`; + const { effectiveColumns, columnsOrder, columnsWidth, setColumnsOrder, setMultipleColumnWidths } = + useDataTableColumns({ + key: storeKey, + columns, + }); + + const lastStoreKey = useRef(storeKey); + const hydrated = useRef(false); + useEffect(() => { + if (lastStoreKey.current !== storeKey) { + lastStoreKey.current = storeKey; + hydrated.current = false; + } + if (hydrated.current) return; + + if (restoredOrder.length > 0) setColumnsOrder(restoredOrder); + const visibleWidths = Object.entries(savedWidths) + .filter(([accessor]) => visibleAccessorSet.has(accessor)) + .map(([accessor, width]) => ({ accessor, width })); + if (visibleWidths.length > 0) setMultipleColumnWidths(visibleWidths); + + const animationFrame = requestAnimationFrame(() => { + hydrated.current = true; + }); + return () => cancelAnimationFrame(animationFrame); + }, [restoredOrder, savedWidths, setColumnsOrder, setMultipleColumnWidths, storeKey, visibleAccessorSet]); + + const previousOrder = useRef(columnsOrder); + const previousWidths = useRef(columnsWidth); + const pendingLayout = useRef({}); + const saveTimeout = useRef(undefined); + useEffect( + () => () => { + window.clearTimeout(saveTimeout.current); + }, + [], + ); + useEffect(() => { + if (!hydrated.current) return; + + const orderChanged = JSON.stringify(columnsOrder) !== JSON.stringify(previousOrder.current); + const widthsChanged = JSON.stringify(columnsWidth) !== JSON.stringify(previousWidths.current); + previousOrder.current = columnsOrder; + previousWidths.current = columnsWidth; + if (!orderChanged && !widthsChanged) return; + + const newLayout: TableLayoutOptions = {}; + if (orderChanged) { + const fullOrder = [...savedOrder, ...columnAccessors.filter((accessor) => !savedOrder.includes(accessor))]; + const reorderedVisibleColumns = [...columnsOrder]; + const mergedOrder = fullOrder.map((accessor) => + visibleAccessorSet.has(accessor) ? (reorderedVisibleColumns.shift() ?? accessor) : accessor, + ); + newLayout.columnOrder = JSON.stringify(mergedOrder); + } + if (widthsChanged) { + const widthMap: Record = { ...savedWidths }; + for (const entry of columnsWidth) { + const accessor = Object.keys(entry)[0]; + if (!accessor || !visibleAccessorSet.has(accessor)) continue; + const width = entry[accessor]; + if (typeof width === "number" && Number.isFinite(width) && width > 0) { + widthMap[accessor] = width; + } else if (typeof width === "string" && width.endsWith("px")) { + const parsedWidth = Number.parseInt(width, 10); + if (Number.isFinite(parsedWidth) && parsedWidth > 0) widthMap[accessor] = parsedWidth; + } + } + newLayout.columnWidths = JSON.stringify(widthMap); + } + + pendingLayout.current = { ...pendingLayout.current, ...newLayout }; + window.clearTimeout(saveTimeout.current); + saveTimeout.current = window.setTimeout(() => { + onLayoutChange(pendingLayout.current); + pendingLayout.current = {}; + }, layoutSaveDelay); + }, [columnAccessors, columnsOrder, columnsWidth, onLayoutChange, savedOrder, savedWidths, visibleAccessorSet]); + + return { effectiveColumns, storeKey }; +}; diff --git a/packages/widgets/src/docker/component.spec.ts b/packages/widgets/src/docker/component.spec.ts index effeb7bef..4be915c5a 100644 --- a/packages/widgets/src/docker/component.spec.ts +++ b/packages/widgets/src/docker/component.spec.ts @@ -1,18 +1,19 @@ import { describe, expect, test } from "vitest"; -import { parseColumnOrder, parseColumnWidths } from "./component"; +import { parseColumnOrder, parseColumnWidths } from "../common/use-persisted-table-layout"; + +const columnAccessors = ["name", "state", "host", "cpuUsage", "memoryUsage", "actions"]; describe("Docker table column layout options", () => { test("ignores malformed column layout JSON", () => { - expect(parseColumnOrder("{")).toEqual([]); - expect(parseColumnWidths("[]")).toEqual({}); + expect(parseColumnOrder("{", columnAccessors)).toEqual([]); + expect(parseColumnWidths("[]", columnAccessors)).toEqual({}); }); test("removes stale and duplicate column accessors", () => { - expect(parseColumnOrder(JSON.stringify(["memoryUsage", "removed", "name", "memoryUsage"]))).toEqual([ - "memoryUsage", - "name", - ]); + expect( + parseColumnOrder(JSON.stringify(["memoryUsage", "removed", "name", "memoryUsage"]), columnAccessors), + ).toEqual(["memoryUsage", "name"]); }); test("keeps only finite positive widths for known columns", () => { @@ -25,6 +26,7 @@ describe("Docker table column layout options", () => { removed: 100, actions: null, }), + columnAccessors, ), ).toEqual({ name: 180 }); }); diff --git a/packages/widgets/src/docker/component.tsx b/packages/widgets/src/docker/component.tsx index 2a4a31027..9423639e4 100644 --- a/packages/widgets/src/docker/component.tsx +++ b/packages/widgets/src/docker/component.tsx @@ -2,7 +2,7 @@ import "./styles.css"; -import { useCallback, useEffect, useMemo, useRef, useState } from "react"; +import { useCallback, useEffect, useMemo, useState } from "react"; import { useRouter } from "next/navigation"; import { ActionIcon, Avatar, Badge, Box, Center, Group, Menu, Portal, Stack, Text, Tooltip } from "@mantine/core"; import { @@ -17,7 +17,7 @@ import { IconTrash, } from "@tabler/icons-react"; import type { DataTableColumn, DataTableSortStatus } from "mantine-datatable"; -import { DataTable, useDataTableColumns } from "mantine-datatable"; +import { DataTable } from "mantine-datatable"; import type { RouterOutputs } from "@homarr/api"; import { clientApi } from "@homarr/api/client"; @@ -33,6 +33,7 @@ import { showErrorNotification, showSuccessNotification } from "@homarr/notifica import { useScopedI18n } from "@homarr/translation/client"; import type { WidgetComponentProps } from "../definition"; +import { usePersistedTableLayout } from "../common/use-persisted-table-layout"; type DockerContainer = RouterOutputs["docker"]["getContainers"]["containers"][number]; type ContainerAction = "start" | "stop" | "restart" | "remove"; @@ -54,40 +55,6 @@ const columnAccessors = ["name", "state", "host", "cpuUsage", "memoryUsage", "ac const createContainerLogsPath = (container: Pick) => `/manage/tools/docker/logs/${container.id}?name=${encodeURIComponent(container.name)}`; -export const parseColumnOrder = (value: string): string[] => { - if (!value) return []; - try { - const parsed: unknown = JSON.parse(value); - if (!Array.isArray(parsed)) return []; - - const allowed = new Set(columnAccessors); - return parsed.filter( - (accessor, index): accessor is string => - typeof accessor === "string" && allowed.has(accessor) && parsed.indexOf(accessor) === index, - ); - } catch { - return []; - } -}; - -export const parseColumnWidths = (value: string): Record => { - if (!value) return {}; - try { - const parsed: unknown = JSON.parse(value); - if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) return {}; - - const allowed = new Set(columnAccessors); - return Object.fromEntries( - Object.entries(parsed).filter( - (entry): entry is [string, number] => - allowed.has(entry[0]) && typeof entry[1] === "number" && Number.isFinite(entry[1]) && entry[1] > 0, - ), - ); - } catch { - return {}; - } -}; - const ContainerStateBadge = ({ state }: { state: ContainerState }) => { const t = useScopedI18n("docker.field.state.option"); @@ -286,9 +253,6 @@ export default function DockerWidget({ [boardId, hasChangeAccess, itemId, saveItemOptions, setOptions], ); - const savedOrder = useMemo(() => parseColumnOrder(options.columnOrder), [options.columnOrder]); - const savedWidths = useMemo(() => parseColumnWidths(options.columnWidths), [options.columnWidths]); - const defaultDirection = options.descendingDefaultSort ? "desc" : "asc"; const [sortStatus, setSortStatus] = useState>({ columnAccessor: options.defaultSort, @@ -325,79 +289,15 @@ export default function DockerWidget({ selectedColumns.has(String(accessor)), ); }, [actionHandlers, isEditMode, options.enableRowSorting, selectedColumns, t]); - const visibleAccessors = useMemo(() => columns.map(({ accessor }) => String(accessor)), [columns]); - const visibleAccessorSet = useMemo(() => new Set(visibleAccessors), [visibleAccessors]); - const restoredOrder = useMemo( - () => [ - ...savedOrder.filter((accessor) => visibleAccessorSet.has(accessor)), - ...visibleAccessors.filter((accessor) => !savedOrder.includes(accessor)), - ], - [savedOrder, visibleAccessors, visibleAccessorSet], - ); - const storeKey = `docker-containers-${itemId ?? "preview"}-${[...visibleAccessors].toSorted().join(",")}`; - const { effectiveColumns, columnsOrder, columnsWidth, setColumnsOrder, setMultipleColumnWidths } = - useDataTableColumns({ - key: storeKey, - columns, - }); - - const lastStoreKey = useRef(storeKey); - const hydrated = useRef(false); - useEffect(() => { - if (lastStoreKey.current !== storeKey) { - lastStoreKey.current = storeKey; - hydrated.current = false; - } - if (hydrated.current) return; - - if (restoredOrder.length > 0) setColumnsOrder(restoredOrder); - const visibleWidths = Object.entries(savedWidths) - .filter(([accessor]) => visibleAccessorSet.has(accessor)) - .map(([accessor, columnWidth]) => ({ accessor, width: columnWidth })); - if (visibleWidths.length > 0) setMultipleColumnWidths(visibleWidths); - - requestAnimationFrame(() => { - hydrated.current = true; - }); - }, [restoredOrder, savedWidths, setColumnsOrder, setMultipleColumnWidths, storeKey, visibleAccessorSet]); - - const previousOrder = useRef(columnsOrder); - const previousWidths = useRef(columnsWidth); - useEffect(() => { - if (!hydrated.current) return; - - const orderChanged = JSON.stringify(columnsOrder) !== JSON.stringify(previousOrder.current); - const widthsChanged = JSON.stringify(columnsWidth) !== JSON.stringify(previousWidths.current); - previousOrder.current = columnsOrder; - previousWidths.current = columnsWidth; - if (!orderChanged && !widthsChanged) return; - - const newLayout: Partial> = {}; - if (orderChanged) { - const fullOrder = [...savedOrder, ...columnAccessors.filter((accessor) => !savedOrder.includes(accessor))]; - const reorderedVisibleColumns = [...columnsOrder]; - const mergedOrder = fullOrder.map((accessor) => - visibleAccessorSet.has(accessor) ? (reorderedVisibleColumns.shift() ?? accessor) : accessor, - ); - newLayout.columnOrder = JSON.stringify(mergedOrder); - } - if (widthsChanged) { - const widthMap: Record = { ...savedWidths }; - for (const entry of columnsWidth) { - const accessor = Object.keys(entry)[0]; - if (!accessor || !visibleAccessorSet.has(accessor)) continue; - const columnWidth = entry[accessor as keyof typeof entry]; - if (typeof columnWidth === "number" && Number.isFinite(columnWidth) && columnWidth > 0) { - widthMap[accessor] = columnWidth; - } else if (typeof columnWidth === "string" && columnWidth.endsWith("px")) { - const parsedWidth = Number.parseInt(columnWidth, 10); - if (Number.isFinite(parsedWidth) && parsedWidth > 0) widthMap[accessor] = parsedWidth; - } - } - newLayout.columnWidths = JSON.stringify(widthMap); - } - persistLayout(newLayout); - }, [columnsOrder, columnsWidth, persistLayout, savedOrder, savedWidths, visibleAccessorSet]); + const { effectiveColumns, storeKey } = usePersistedTableLayout({ + columns, + columnAccessors, + columnOrder: options.columnOrder, + columnWidths: options.columnWidths, + itemId, + storeKeyPrefix: "docker-containers", + onLayoutChange: persistLayout, + }); const [contextMenu, setContextMenu] = useState(null); const closeContextMenu = useCallback(() => setContextMenu(null), []);