feat!: release v2 (#6545)

Co-authored-by: Artur <145776561+arturict@users.noreply.github.com>
Co-authored-by: arturict <arturict@users.noreply.github.com>
Co-authored-by: Thomas <thomas@ajnart.fr>
Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com>
Co-authored-by: Danura30082 <danura30082+github@gmail.com>
Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com>
Co-authored-by: ajnart <thomas@ajnart.fr>
Co-authored-by: ajnart <thomas@ajnart.dev>
Co-authored-by: chenjun <chenjun@foxmail.com>
Co-authored-by: Wikibear <wikibear@users.noreply.github.com>
Co-authored-by: Bergasha <bergasha@gmail.com>
Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com>
Co-authored-by: Lucas Araujo <lucas.lra@gmail.com>
Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com>
Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social>
Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com>
Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com>
Co-authored-by: thrawnx <tight.bulb9384@fastmail.com>
Co-authored-by: Chris <58918656+nordada@users.noreply.github.com>
Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com>
Co-authored-by: Yanis <naamaneyanis@gmail.com>
Co-authored-by: Wikibear <me@sej.de>
Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>
This commit is contained in:
3286 files changed
+284386 -139176

No files matched your search

+226 -57
View File
@@ -1,21 +1,60 @@
"use client";
import { useEffect, useRef, useState } from "react";
import { Box, Card, Group, Stack, Tooltip, useMantineColorScheme } from "@mantine/core";
import { useEffect, useMemo, useRef, useState } from "react";
import { Box, Card, Group, ScrollArea, SimpleGrid, Text, Tooltip, useComputedColorScheme } from "@mantine/core";
import { clientApi } from "@homarr/api/client";
import { useRequiredBoard } from "@homarr/boards/context";
import { formatBytesPair } from "@homarr/common";
import { formatBytesPair as formatBytesPairDefault } from "@homarr/common";
import { useByteFormatter } from "@homarr/settings";
import { useI18n } from "@homarr/translation/client";
import { WidgetEmptyState } from "../common/empty-state";
import { IntegrationErrorIndicator } from "../common/integration-error-indicator";
import { getUsableWidgetQueryData, isInitialWidgetQueryPending } from "../common/query-state";
import { WidgetQueryLoadingState } from "../common/query-state-indicator";
import type { WidgetComponentProps } from "../definition";
import { filterStorageVolumes, storageDeviceNamesMatch } from "../filter-storage-volumes";
import { NoIntegrationDataError } from "../errors/no-data-integration";
type DisplayMode = WidgetComponentProps<"systemDisks">["options"]["displayMode"];
type DiskDisplayMode = WidgetComponentProps<"systemDisks">["options"]["displayMode"];
const getDisplayText = (item: { used: string; available: string; percentage: number }, displayMode: DisplayMode) => {
const advancedColumnBreakpoints = [
{ minimumWidth: 1820, columns: 7 },
{ minimumWidth: 1560, columns: 6 },
{ minimumWidth: 1300, columns: 5 },
{ minimumWidth: 1040, columns: 4 },
{ minimumWidth: 780, columns: 3 },
{ minimumWidth: 520, columns: 2 },
{ minimumWidth: 0, columns: 1 },
] as const;
const getSystemDisksLayout = (width: number, diskCount: number, isAdvanced: boolean) => {
if (!isAdvanced) {
return {
columns: 1,
showSecondaryText: false,
showTemperature: true,
};
}
const breakpoint = advancedColumnBreakpoints.find((candidate) => width >= candidate.minimumWidth);
const columns = Math.min(diskCount, breakpoint?.columns ?? 1);
return {
columns: Math.max(1, columns),
showSecondaryText: true,
showTemperature: true,
};
};
export const clampPercentage = (percentage: number): number => Math.min(100, Math.max(0, percentage));
export const getDisplayText = (
item: { used: string; available: string; percentage: number },
displayMode: DiskDisplayMode,
translatedFreeText?: string,
formatBytesPair: typeof formatBytesPairDefault = formatBytesPairDefault,
) => {
switch (displayMode) {
case "percentage":
return `${Math.round(item.percentage)}%`;
@@ -23,18 +62,28 @@ const getDisplayText = (item: { used: string; available: string; percentage: num
const usedInBytes = Number(item.used);
const availableInBytes = Number(item.available);
if (Number.isFinite(usedInBytes) && Number.isFinite(availableInBytes)) {
const { used, available } = formatBytesPair(usedInBytes, availableInBytes);
return `${used} / ${available}`;
const { used, total } = formatBytesPair(usedInBytes, usedInBytes + availableInBytes);
return `${used} / ${total}`;
}
return `${item.used} / ${item.available}`;
}
case "free":
return `${Math.round(100 - item.percentage)}% free`;
return translatedFreeText ?? `${Math.round(100 - clampPercentage(item.percentage))}% free`;
default:
return `${Math.round(item.percentage)}%`;
}
};
export const getAdvancedDisplayTexts = (
item: { used: string; available: string; percentage: number },
translatedFreeText?: string,
formatBytesPair: typeof formatBytesPairDefault = formatBytesPairDefault,
) => ({
percentage: getDisplayText(item, "percentage"),
absolute: getDisplayText(item, "absolute", undefined, formatBytesPair),
free: getDisplayText(item, "free", translatedFreeText),
});
interface SystemDiskCardProps {
deviceName: string;
percentage: number;
@@ -42,6 +91,13 @@ interface SystemDiskCardProps {
temperature: number | null | undefined;
healthy: boolean;
showBackgroundBar: boolean;
integrationName?: string;
secondaryText?: string;
freeText?: string;
smartStatus?: string;
isAdvanced: boolean;
showSecondaryText: boolean;
showTemperature: boolean;
}
const SystemDiskCard = ({
@@ -51,10 +107,17 @@ const SystemDiskCard = ({
temperature,
healthy,
showBackgroundBar,
integrationName,
secondaryText,
freeText,
smartStatus,
isAdvanced,
showSecondaryText,
showTemperature,
}: SystemDiskCardProps) => {
const board = useRequiredBoard();
const scheme = useMantineColorScheme();
const t = useI18n();
const colorScheme = useComputedColorScheme("light");
const t = useI18n("widget.systemDisks");
const valueRef = useRef<HTMLParagraphElement>(null);
const [valueFits, setValueFits] = useState(true);
@@ -72,46 +135,94 @@ const SystemDiskCard = ({
measure();
const observer = new ResizeObserver(measure);
observer.observe(card);
observer.observe(value);
return () => observer.disconnect();
}, [displayText, healthy]);
}, []);
const unhealthyLabel = t("widget.systemDisks.status.unhealthy");
const unhealthyLabel = t("status.unhealthy");
const hasTemperature = temperature !== null && temperature !== undefined;
const temperatureText = hasTemperature ? `${temperature}°C` : "—°C";
const hasHiddenTemperature = hasTemperature && !showTemperature;
const hasHiddenSecondaryText = Boolean(secondaryText && secondaryText !== displayText && !showSecondaryText);
const tooltipLabel = [
healthy ? displayText : `${displayText} (${unhealthyLabel})`,
hasHiddenSecondaryText ? secondaryText : null,
hasHiddenTemperature ? `${temperature}°C` : null,
]
.filter(Boolean)
.join(" · ");
const backgroundColor = "rgb(from var(--mantine-color-primaryColor-filled) r g b / calc(var(--opacity, 1) * 0.12))";
const borderColor = "rgb(from var(--mantine-color-secondaryColor-filled) r g b / calc(var(--opacity, 1) * 0.45))";
const legacyBackground = colorScheme === "dark" ? "dark.7" : "gray.1";
const cardBackground = isAdvanced ? backgroundColor : legacyBackground;
const progressBackground = healthy ? "var(--mantine-color-green-light)" : "var(--mantine-color-red-light)";
const legacyProgressColor = healthy ? "green" : "red";
return (
<Tooltip
label={healthy ? displayText : `${displayText} (${unhealthyLabel})`}
disabled={valueFits}
label={tooltipLabel}
disabled={valueFits && !hasHiddenTemperature && !hasHiddenSecondaryText}
position="top"
withinPortal
>
<Card
radius={board.itemRadius}
py={"xs"}
bg={scheme.colorScheme === "dark" ? "dark.7" : "gray.1"}
style={{ overflow: "hidden", position: "relative" }}
py="xs"
withBorder={isAdvanced}
bg={cardBackground}
style={{ overflow: "hidden", position: "relative", borderColor: isAdvanced ? borderColor : undefined }}
>
<Group justify="space-between" style={{ zIndex: 1 }}>
<div>
<p style={{ margin: 0 }}>
<b>{deviceName}</b>
</p>
<p ref={valueRef} style={{ margin: 0, visibility: valueFits ? "visible" : "hidden" }}>
<Group justify="space-between" wrap="nowrap" style={{ zIndex: 1, minWidth: 0 }}>
<div style={{ minWidth: 0, flex: 1 }}>
<Text fw={700} size={isAdvanced ? "sm" : undefined} truncate="end">
{deviceName}
</Text>
{integrationName && (
<Text size="xs" c="dimmed" truncate="end">
{integrationName}
</Text>
)}
<Text
ref={valueRef}
size={isAdvanced ? "sm" : undefined}
style={{ visibility: valueFits ? "visible" : "hidden" }}
>
<span>{displayText}</span>
{!healthy && <span style={{ marginLeft: 5 }}>{unhealthyLabel}</span>}
</p>
</Text>
{showSecondaryText && secondaryText && secondaryText !== displayText && (
<Text size="xs" c="dimmed">
{secondaryText}
</Text>
)}
{isAdvanced && freeText && freeText !== displayText && (
<Text size="xs" c="dimmed">
{freeText}
</Text>
)}
{isAdvanced && (
<Text size="xs" c={healthy ? "dimmed" : "red"}>
{t("status.smart")}: {smartStatus?.trim() || "—"}
</Text>
)}
</div>
<div style={{ flexShrink: 0 }}>
{showTemperature && (hasTemperature || isAdvanced) ? (
<Text size={isAdvanced ? "sm" : undefined}>{temperatureText}</Text>
) : null}
</div>
<div>{temperature ? <p style={{ margin: 0 }}>{temperature}°C</p> : null}</div>
</Group>
<Box
bg={healthy ? "green" : "red"}
bg={isAdvanced ? undefined : legacyProgressColor}
style={{
position: "absolute",
top: 0,
left: 0,
width: `${percentage}%`,
width: `${clampPercentage(percentage)}%`,
height: "100%",
zIndex: 0,
display: showBackgroundBar ? "block" : "none",
backgroundColor: isAdvanced ? progressBackground : undefined,
}}
></Box>
</Card>
@@ -119,41 +230,99 @@ const SystemDiskCard = ({
);
};
export default function SystemResources({ integrationIds, options }: WidgetComponentProps<"systemDisks">) {
export default function SystemResources({
integrationIds,
options,
width,
displayMode,
}: WidgetComponentProps<"systemDisks">) {
const t = useI18n("widget.systemDisks");
const { formatBytesPair } = useByteFormatter();
const queryInput = { integrationIds };
const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery(queryInput);
const healthQuery = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery(queryInput);
const results = getUsableWidgetQueryData(healthQuery) ?? [];
const data = results.filter(
(entry): entry is typeof entry & { healthInfo: NonNullable<typeof entry.healthInfo> } => entry.healthInfo !== null,
);
const disks = data.flatMap((entry) => {
const fileSystem = filterStorageVolumes(
entry.healthInfo.fileSystem,
options.visibleStorageVolumes,
entry.integrationId,
);
const smart = filterStorageVolumes(entry.healthInfo.smart, options.visibleStorageVolumes, entry.integrationId);
return fileSystem.map((item) => ({
integrationId: entry.integrationId,
integrationName: entry.integrationName,
item,
smartItem: smart.find((candidate) => storageDeviceNamesMatch(candidate.deviceName, item.deviceName)),
}));
});
const isAdvanced = displayMode === "advanced";
const layout = useMemo(
() => getSystemDisksLayout(width, disks.length, isAdvanced),
[disks.length, isAdvanced, width],
);
const queryIndicators = (
<Group gap={0}>
<IntegrationErrorIndicator results={results} />
</Group>
);
const emptyState = (
<Box h="100%" pos="relative">
<Box pos="absolute" top={4} right={8} style={{ zIndex: 2 }}>
{queryIndicators}
</Box>
<WidgetEmptyState />
</Box>
);
const lastItem = data.at(-1);
if (isInitialWidgetQueryPending(healthQuery)) return <WidgetQueryLoadingState />;
if (data.length === 0) return emptyState;
if (!lastItem) return <WidgetEmptyState />;
const rawFileSystem = lastItem.healthInfo.fileSystem;
if (rawFileSystem.length === 0) {
throw new NoIntegrationDataError();
}
const fileSystem = filterStorageVolumes(rawFileSystem, options.visibleStorageVolumes, lastItem.integrationId);
const smart = filterStorageVolumes(lastItem.healthInfo.smart, options.visibleStorageVolumes, lastItem.integrationId);
if (fileSystem.length === 0) return <WidgetEmptyState />;
const hasNoFileSystems = data.every((entry) => entry.healthInfo.fileSystem.length === 0);
const hasFailedSource = results.some((entry) => Boolean(entry.error));
if (hasNoFileSystems && !hasFailedSource && !healthQuery.error) throw new NoIntegrationDataError();
if (hasNoFileSystems || disks.length === 0) return emptyState;
return (
<Stack gap="xs" p="xs" h="100%">
{fileSystem.map((item) => {
const smartItem = smart.find((smart) => storageDeviceNamesMatch(smart.deviceName, item.deviceName));
<Box h="100%" pos="relative">
<Box pos="absolute" top={4} right={8} style={{ zIndex: 2 }}>
{queryIndicators}
</Box>
<ScrollArea h="100%">
<SimpleGrid cols={layout.columns} spacing="xs" p="xs">
{disks.map(({ integrationId, integrationName, item, smartItem }) => {
const freeText = t("status.free", {
percentage: String(Math.round(100 - clampPercentage(item.percentage))),
});
const advancedDisplayTexts = getAdvancedDisplayTexts(item, freeText, formatBytesPair);
return (
<SystemDiskCard
key={`disk-${item.deviceName}`}
deviceName={item.deviceName}
percentage={item.percentage}
displayText={getDisplayText(item, options.displayMode)}
temperature={options.showTemperatureIfAvailable ? smartItem?.temperature : undefined}
healthy={smartItem?.healthy ?? true} // fall back to healthy if no information is available
showBackgroundBar={options.showBackgroundBar}
/>
);
})}
</Stack>
return (
<SystemDiskCard
key={`${integrationId}:${item.deviceName}`}
deviceName={item.deviceName}
percentage={item.percentage}
displayText={
isAdvanced
? advancedDisplayTexts.percentage
: getDisplayText(item, options.displayMode, freeText, formatBytesPair)
}
temperature={isAdvanced || options.showTemperatureIfAvailable ? smartItem?.temperature : undefined}
healthy={smartItem?.healthy ?? true} // fall back to healthy if no information is available
showBackgroundBar={isAdvanced || options.showBackgroundBar}
integrationName={isAdvanced || data.length > 1 ? integrationName : undefined}
secondaryText={advancedDisplayTexts.absolute}
freeText={advancedDisplayTexts.free}
smartStatus={smartItem?.overallStatus}
isAdvanced={isAdvanced}
showSecondaryText={layout.showSecondaryText}
showTemperature={layout.showTemperature}
/>
);
})}
</SimpleGrid>
</ScrollArea>
</Box>
);
}
@@ -0,0 +1,28 @@
import { describe, expect, test } from "vitest";
import { clampPercentage, getAdvancedDisplayTexts, getDisplayText } from "./component";
describe("system disk display", () => {
test("clamps malformed utilization before sizing the background", () => {
expect(clampPercentage(-4)).toBe(0);
expect(clampPercentage(108)).toBe(100);
});
test("falls back to provider values when sizes are already formatted", () => {
expect(getDisplayText({ used: "5 GiB", available: "10 GiB", percentage: 50 }, "absolute")).toBe("5 GiB / 10 GiB");
});
test("provides every value used by the advanced view", () => {
expect(
getAdvancedDisplayTexts({ used: `${5 * 1024 ** 3}`, available: `${5 * 1024 ** 3}`, percentage: 50 }),
).toEqual({
percentage: "50%",
absolute: "5.4 GB / 10.7 GB",
free: "50% free",
});
});
test("clamps free space derived from malformed utilization", () => {
expect(getDisplayText({ used: "11", available: "10", percentage: 108 }, "free")).toBe("0% free");
});
});
+7 -3
View File
@@ -1,14 +1,18 @@
import { IconServer2 } from "@tabler/icons-react";
import { getWidgetIntegrationConfig } from "@homarr/definitions";
import { createWidgetDefinition } from "../definition";
import { supportsStorageVolumeSelection } from "../filter-storage-volumes";
import { optionsBuilder } from "../options";
import { createStorageVolumeMultiSelectOptions } from "../storage-volume-options";
export const { definition, componentLoader } = createWidgetDefinition("systemDisks", {
supportsAdvancedFocus: true,
icon: IconServer2,
queryKey: [["widget", "healthMonitoring"]],
refetchInterval: 5,
supportedIntegrations: ["dashDot", "openmediavault", "truenas", "unraid", "synology"],
refetchInterval: 10,
...getWidgetIntegrationConfig("systemDisks"),
createOptions() {
return optionsBuilder.from(
(factory) => ({
@@ -26,7 +30,7 @@ export const { definition, componentLoader } = createWidgetDefinition("systemDis
{
visibleStorageVolumes: {
shouldHide(_, integrationKinds) {
return integrationKinds.length === 0 || !integrationKinds.every((kind) => kind === "synology");
return !supportsStorageVolumeSelection(integrationKinds);
},
},
},