From a2668740c06dceeb599d7e86e1a95e48e25d2914 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Thu, 28 May 2026 15:31:29 +0200 Subject: [PATCH 01/18] feat(ui): add global query refresh indicator to board header Replace per-widget loading spinners with a shared header indicator that shows live TanStack Query cache status for all widget-related queries. Includes orange/green dot, completion beep, and hover card with per-query staleness and error details. --- .../boards/(content)/_header-actions.tsx | 9 +- .../layout/header/query-refresh-indicator.tsx | 218 ++++++++++++++++++ packages/widgets/src/calendar/component.tsx | 7 +- 3 files changed, 228 insertions(+), 6 deletions(-) create mode 100644 apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx diff --git a/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx b/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx index 3b6ea7a37..382b594b6 100644 --- a/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx +++ b/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx @@ -37,6 +37,7 @@ import { useCategoryActions } from "~/components/board/sections/category/categor import { CategoryEditModal } from "~/components/board/sections/category/category-edit-modal"; import { useDynamicSectionActions } from "~/components/board/sections/dynamic/dynamic-actions"; import { HeaderButton } from "~/components/layout/header/button"; +import { QueryRefreshIndicator } from "~/components/layout/header/query-refresh-indicator"; export const BoardContentHeaderActions = () => { const [isEditMode] = useEditMode(); @@ -44,13 +45,19 @@ export const BoardContentHeaderActions = () => { const { hasChangeAccess } = useBoardPermissions(board); if (!hasChangeAccess) { - return ; + return ( + <> + + + + ); } return ( <> {isEditMode && } + diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx new file mode 100644 index 000000000..04678b736 --- /dev/null +++ b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx @@ -0,0 +1,218 @@ +"use client"; + +import { useEffect, useRef, useState } from "react"; +import { Box, Group, HoverCard, Indicator, ScrollArea, Stack, Text } from "@mantine/core"; +import { IconDatabase } from "@tabler/icons-react"; +import { useQueryClient } from "@tanstack/react-query"; +import dayjs from "dayjs"; + +import { HeaderButton } from "./button"; + +interface QueryStatusRow { + id: string; + label: string; + status: "pending" | "error" | "success"; + fetchStatus: "fetching" | "paused" | "idle"; + dataUpdatedAt: number; + isStale: boolean; +} + +const widgetQueryPrefixes = new Set(["widget", "docker", "app", "integration"]); + +const isWidgetQuery = (queryKey: readonly unknown[]): boolean => { + const first = queryKey[0]; + return Array.isArray(first) && first.length >= 1 && widgetQueryPrefixes.has(first[0]); +}; + +const extractQueryLabel = (queryKey: readonly unknown[]): string => { + const first = queryKey[0]; + if (Array.isArray(first)) { + return first.filter((s) => typeof s === "string").join("."); + } + return String(first); +}; + +const statusColorMap: Record = { + fetching: "orange", + idle_success: "green", + idle_error: "red", + idle_pending: "gray", +}; + +interface CacheSnapshot { + rows: QueryStatusRow[]; + widgetFetchingCount: number; + errorCount: number; + staleCount: number; +} + +const emptyCacheSnapshot: CacheSnapshot = { rows: [], widgetFetchingCount: 0, errorCount: 0, staleCount: 0 }; + +function useQueryCacheStatus() { + const queryClient = useQueryClient(); + const [snapshot, setSnapshot] = useState(emptyCacheSnapshot); + + useEffect(() => { + const update = () => { + const cache = queryClient.getQueryCache(); + const queries = cache.findAll({ type: "active" }).filter((q) => isWidgetQuery(q.queryKey)); + + let fetching = 0; + let errors = 0; + let stale = 0; + const nextRows: QueryStatusRow[] = queries.map((q) => { + if (q.state.fetchStatus === "fetching") fetching++; + if (q.state.status === "error") errors++; + const isStale = q.isStale(); + if (isStale) stale++; + return { + id: q.queryHash, + label: extractQueryLabel(q.queryKey), + status: q.state.status, + fetchStatus: q.state.fetchStatus, + dataUpdatedAt: q.state.dataUpdatedAt, + isStale, + }; + }); + + setSnapshot({ rows: nextRows, widgetFetchingCount: fetching, errorCount: errors, staleCount: stale }); + }; + + update(); + + let rafId: number | null = null; + const unsubscribe = queryClient.getQueryCache().subscribe(() => { + if (rafId !== null) return; + rafId = requestAnimationFrame(() => { + rafId = null; + update(); + }); + }); + + return () => { + unsubscribe(); + if (rafId !== null) cancelAnimationFrame(rafId); + }; + }, [queryClient]); + + return { ...snapshot, totalCount: snapshot.rows.length }; +} + +const audioCtxRef = { current: null as AudioContext | null }; + +function useCompletionBeep(fetchingCount: number) { + const prevRef = useRef(fetchingCount); + + useEffect(() => { + const wasFetching = prevRef.current > 0; + const nowIdle = fetchingCount === 0; + prevRef.current = fetchingCount; + + if (!wasFetching || !nowIdle) return; + + try { + if (!audioCtxRef.current || audioCtxRef.current.state === "closed") { + audioCtxRef.current = new AudioContext(); + } + const ctx = audioCtxRef.current; + const osc = ctx.createOscillator(); + const gain = ctx.createGain(); + osc.connect(gain); + gain.connect(ctx.destination); + osc.frequency.value = 880; + gain.gain.value = 0.08; + osc.start(); + osc.stop(ctx.currentTime + 0.08); + } catch { + // audio blocked before user interaction + } + }, [fetchingCount]); +} + +function useGreenFlash(fetchingCount: number) { + const [flash, setFlash] = useState(false); + const prevRef = useRef(fetchingCount); + + useEffect(() => { + const wasFetching = prevRef.current > 0; + const nowIdle = fetchingCount === 0; + prevRef.current = fetchingCount; + + if (!wasFetching || !nowIdle) return; + + setFlash(true); + const timer = setTimeout(() => setFlash(false), 1500); + return () => clearTimeout(timer); + }, [fetchingCount]); + + return flash; +} + +export const QueryRefreshIndicator = () => { + const { rows, widgetFetchingCount, errorCount, staleCount, totalCount } = useQueryCacheStatus(); + const showGreen = useGreenFlash(widgetFetchingCount); + useCompletionBeep(widgetFetchingCount); + + if (totalCount === 0) return null; + + const isFetching = widgetFetchingCount > 0; + const color = isFetching ? "orange" : showGreen ? "green" : errorCount > 0 ? "red" : "green"; + + return ( + + + + + + + + + + + + + Integration status + + + {totalCount} queries · {widgetFetchingCount} fetching, {staleCount} stale, {errorCount} errors + + + + + + {rows.map((row) => ( + + ))} + + + + + + ); +}; + +const QueryRow = ({ row }: { row: QueryStatusRow }) => { + const rowColor = statusColorMap[ + row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}` + ] ?? "gray"; + + const updatedLabel = row.dataUpdatedAt > 0 + ? dayjs(row.dataUpdatedAt).fromNow() + : "never"; + + return ( + + + + {row.label} + + + {updatedLabel} + + + ); +}; diff --git a/packages/widgets/src/calendar/component.tsx b/packages/widgets/src/calendar/component.tsx index b287d2324..1ee33f68a 100644 --- a/packages/widgets/src/calendar/component.tsx +++ b/packages/widgets/src/calendar/component.tsx @@ -39,7 +39,7 @@ const FetchCalendar = ({ month, setMonth, isEditMode, integrationIds, options }: releaseType: options.releaseType, showUnmonitored: options.showUnmonitored, }; - const [data] = clientApi.widget.calendar.findAllEvents.useSuspenseQuery(input, { + const { data } = clientApi.widget.calendar.findAllEvents.useQuery(input, { refetchOnMount: false, refetchOnWindowFocus: false, refetchOnReconnect: false, @@ -61,7 +61,7 @@ const FetchCalendar = ({ month, setMonth, isEditMode, integrationIds, options }: }, }); - const events = useMemo(() => data.flatMap((item) => item.events), [data]); + const events = useMemo(() => data?.flatMap((item) => item.events) ?? [], [data]); return ; }; @@ -156,9 +156,6 @@ const CalendarBase = ({ isEditMode, events, month, setMonth, options }: Calendar return ( Date: Thu, 28 May 2026 14:07:20 +0000 Subject: [PATCH 02/18] style: auto-fix lint and format --- .../components/layout/header/query-refresh-indicator.tsx | 8 ++------ packages/widgets/src/calendar/component.tsx | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx index 04678b736..5cb933330 100644 --- a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx +++ b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx @@ -192,13 +192,9 @@ export const QueryRefreshIndicator = () => { }; const QueryRow = ({ row }: { row: QueryStatusRow }) => { - const rowColor = statusColorMap[ - row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}` - ] ?? "gray"; + const rowColor = statusColorMap[row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}`] ?? "gray"; - const updatedLabel = row.dataUpdatedAt > 0 - ? dayjs(row.dataUpdatedAt).fromNow() - : "never"; + const updatedLabel = row.dataUpdatedAt > 0 ? dayjs(row.dataUpdatedAt).fromNow() : "never"; return ( diff --git a/packages/widgets/src/calendar/component.tsx b/packages/widgets/src/calendar/component.tsx index 1ee33f68a..b3c3160ea 100644 --- a/packages/widgets/src/calendar/component.tsx +++ b/packages/widgets/src/calendar/component.tsx @@ -152,7 +152,7 @@ const CalendarBase = ({ isEditMode, events, month, setMonth, options }: Calendar .filter( (event) => event.metadata?.type !== "radarr" || options.releaseType.includes(event.metadata.releaseType), ) - .sort((eventA, eventB) => eventA.startDate.getTime() - eventB.startDate.getTime()); + .toSorted((eventA, eventB) => eventA.startDate.getTime() - eventB.startDate.getTime()); return ( Date: Thu, 28 May 2026 17:13:31 +0200 Subject: [PATCH 03/18] refactor(ui): simplify indicator to status dot on board logo Use Mantine Indicator with processing animation instead of custom CSS. Switch from HoverCard to Menu with grouped sections. Remove beep, position dot next to board logo, hide in edit mode. --- .../widget_refresh_indicator_ffb2b58d.plan.md | 47 ++++ .../boards/(content)/_header-actions.tsx | 9 +- .../layout/header/query-refresh-indicator.tsx | 207 ++++++++---------- .../src/components/layout/logo/board-logo.tsx | 18 +- 4 files changed, 156 insertions(+), 125 deletions(-) create mode 100644 .cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md diff --git a/.cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md b/.cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md new file mode 100644 index 000000000..0b970e630 --- /dev/null +++ b/.cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md @@ -0,0 +1,47 @@ +--- +name: Widget Refresh Indicator +overview: "Add a board-header refresh indicator for widget/server-state queries using TanStack Query as the shared state source, then continue the PR #5768 pattern by removing widget-level blocking spinners where needed." +todos: + - id: switch-branch + content: After approval, switch the workspace to `agent/cebd0dad` and confirm the PR diff is present. + status: completed + - id: cache-hook + content: Create a TanStack Query cache-inspection hook that returns refresh counts and normalized query status rows. + status: completed + - id: header-ui + content: Add the hoverable orange/green header indicator immediately before the board edit button. + status: completed + - id: calendar-cleanup + content: Reconcile the calendar widget PR change with the new global indicator, removing redundant widget-local loading UI if appropriate. + status: completed + - id: verify + content: Run targeted typechecks and manually validate refresh, completion, hover details, and beep behavior. + status: completed +isProject: false +--- + +# Widget Refresh Indicator Plan + +## Findings +- PR [#5768](https://github.com/homarr-labs/homarr/pull/5768) is on `agent/cebd0dad` and currently only changes [packages/widgets/src/calendar/component.tsx](packages/widgets/src/calendar/component.tsx): `useSuspenseQuery` became `useQuery`, with a small widget-local loader. +- The current workspace is on `feat/add-integration-from-dashboard`, so implementation should first move to `agent/cebd0dad` after approval. +- Homarr already uses Jotai for small client UI state in [apps/nextjs/src/components/layout/header/burger.tsx](apps/nextjs/src/components/layout/header/burger.tsx), but there is no Zustand pattern. For this feature, TanStack Query itself should be the shared store. +- The client `QueryClient` lives in [apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx](apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx). TanStack Query v5 supports `useIsFetching()` for a global fetching count and `queryClient.getQueryCache().subscribe()` / `findAll()` for cache inspection. +- The board header actions are in [apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx](apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx); the indicator should be inserted immediately before ``, which places it to the left of the edit button. + +## Implementation Approach +- Add a small client hook/component, likely [apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx](apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx), that reads from `useQueryClient()` and subscribes to the query cache. +- Derive a normalized list from cached queries: query path/key, fetching status, `status`, `dataUpdatedAt`, stale state via the query object, error state, and integration IDs found in query inputs/data where present. +- Count active refreshes with `fetchStatus === "fetching"`, using a `useIsFetching()` value as a cheap re-render trigger and cache subscription for details. +- Render a Mantine `HeaderButton`/`ActionIcon` with a tiny `Indicator`: orange while one or more relevant queries are fetching, green briefly after a refresh batch completes, then idle/disabled when nothing is active. +- Use a Mantine `HoverCard` for the details: overall status, number of refreshing queries, last updated/stale state, and a compact list of current integration/widget query entries. +- Add a small Web Audio beep when the indicator transitions from fetching to complete. It should be best-effort and fail silently if the browser blocks audio before user interaction. +- Add translation keys only to [packages/translation/src/lang/en.json](packages/translation/src/lang/en.json); other locales fall back to English through the existing merge in [packages/translation/src/request.ts](packages/translation/src/request.ts). + +## Widget Migration Scope +- Keep PR #5768’s calendar behavior, but remove the widget-local loader if the header indicator fully replaces it. +- Do not attempt to convert all `useSuspenseQuery` widgets in the same pass unless the branch goal expands. The first version can show global activity for all query cache entries, while follow-up widget migrations replace blocking `useSuspenseQuery` with `useQuery` where each widget can render meaningful stale/empty content. + +## Verification +- Run a targeted typecheck such as `pnpm -F nextjs typecheck` and `pnpm -F widgets typecheck` after implementation. +- Skip lint cleanup unless explicitly requested, matching your preference to ignore linter errors. \ No newline at end of file diff --git a/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx b/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx index 382b594b6..3b6ea7a37 100644 --- a/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx +++ b/apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx @@ -37,7 +37,6 @@ import { useCategoryActions } from "~/components/board/sections/category/categor import { CategoryEditModal } from "~/components/board/sections/category/category-edit-modal"; import { useDynamicSectionActions } from "~/components/board/sections/dynamic/dynamic-actions"; import { HeaderButton } from "~/components/layout/header/button"; -import { QueryRefreshIndicator } from "~/components/layout/header/query-refresh-indicator"; export const BoardContentHeaderActions = () => { const [isEditMode] = useEditMode(); @@ -45,19 +44,13 @@ export const BoardContentHeaderActions = () => { const { hasChangeAccess } = useBoardPermissions(board); if (!hasChangeAccess) { - return ( - <> - - - - ); + return ; } return ( <> {isEditMode && } - diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx index 5cb933330..3c9188a9b 100644 --- a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx +++ b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx @@ -1,35 +1,48 @@ "use client"; -import { useEffect, useRef, useState } from "react"; -import { Box, Group, HoverCard, Indicator, ScrollArea, Stack, Text } from "@mantine/core"; -import { IconDatabase } from "@tabler/icons-react"; +import { forwardRef, useEffect, useState } from "react"; +import { Box, Indicator, Menu, ScrollArea, Text, UnstyledButton } from "@mantine/core"; import { useQueryClient } from "@tanstack/react-query"; import dayjs from "dayjs"; -import { HeaderButton } from "./button"; +import { useEditMode } from "@homarr/boards/edit-mode"; interface QueryStatusRow { id: string; - label: string; + section: string; + procedure: string; status: "pending" | "error" | "success"; fetchStatus: "fetching" | "paused" | "idle"; dataUpdatedAt: number; isStale: boolean; } -const widgetQueryPrefixes = new Set(["widget", "docker", "app", "integration"]); +const trackedQueryPrefixes = new Set(["widget", "integration"]); -const isWidgetQuery = (queryKey: readonly unknown[]): boolean => { +const isTrackedQuery = (queryKey: readonly unknown[]): boolean => { const first = queryKey[0]; - return Array.isArray(first) && first.length >= 1 && widgetQueryPrefixes.has(first[0]); + return Array.isArray(first) && first.length >= 1 && trackedQueryPrefixes.has(first[0] as string); }; -const extractQueryLabel = (queryKey: readonly unknown[]): string => { +const sectionLabels: Record = { + widget: "Widgets", + integration: "Integrations", +}; + +const capitalize = (s: string) => s.charAt(0).toUpperCase() + s.slice(1); + +const parseQueryKey = (queryKey: readonly unknown[]): { section: string; procedure: string } => { const first = queryKey[0]; - if (Array.isArray(first)) { - return first.filter((s) => typeof s === "string").join("."); - } - return String(first); + if (!Array.isArray(first)) return { section: "Other", procedure: String(first) }; + + const parts = first.filter((s): s is string => typeof s === "string"); + const sectionKey = parts[0] ?? "other"; + const section = sectionLabels[sectionKey] ?? capitalize(sectionKey); + + const remaining = parts.slice(1); + const procedure = remaining.length > 0 ? remaining.map(capitalize).join(" — ") : sectionKey; + + return { section, procedure }; }; const statusColorMap: Record = { @@ -55,7 +68,7 @@ function useQueryCacheStatus() { useEffect(() => { const update = () => { const cache = queryClient.getQueryCache(); - const queries = cache.findAll({ type: "active" }).filter((q) => isWidgetQuery(q.queryKey)); + const queries = cache.findAll({ type: "active" }).filter((q) => isTrackedQuery(q.queryKey)); let fetching = 0; let errors = 0; @@ -63,15 +76,17 @@ function useQueryCacheStatus() { const nextRows: QueryStatusRow[] = queries.map((q) => { if (q.state.fetchStatus === "fetching") fetching++; if (q.state.status === "error") errors++; - const isStale = q.isStale(); - if (isStale) stale++; + const isQueryStale = q.isStale(); + if (isQueryStale) stale++; + const { section, procedure } = parseQueryKey(q.queryKey); return { id: q.queryHash, - label: extractQueryLabel(q.queryKey), + section, + procedure, status: q.state.status, fetchStatus: q.state.fetchStatus, dataUpdatedAt: q.state.dataUpdatedAt, - isStale, + isStale: isQueryStale, }; }); @@ -98,117 +113,87 @@ function useQueryCacheStatus() { return { ...snapshot, totalCount: snapshot.rows.length }; } -const audioCtxRef = { current: null as AudioContext | null }; - -function useCompletionBeep(fetchingCount: number) { - const prevRef = useRef(fetchingCount); - - useEffect(() => { - const wasFetching = prevRef.current > 0; - const nowIdle = fetchingCount === 0; - prevRef.current = fetchingCount; - - if (!wasFetching || !nowIdle) return; - - try { - if (!audioCtxRef.current || audioCtxRef.current.state === "closed") { - audioCtxRef.current = new AudioContext(); - } - const ctx = audioCtxRef.current; - const osc = ctx.createOscillator(); - const gain = ctx.createGain(); - osc.connect(gain); - gain.connect(ctx.destination); - osc.frequency.value = 880; - gain.gain.value = 0.08; - osc.start(); - osc.stop(ctx.currentTime + 0.08); - } catch { - // audio blocked before user interaction +function groupBySection(rows: QueryStatusRow[]): Map { + const groups = new Map(); + for (const row of rows) { + const existing = groups.get(row.section); + if (existing) { + existing.push(row); + } else { + groups.set(row.section, [row]); } - }, [fetchingCount]); + } + return groups; } -function useGreenFlash(fetchingCount: number) { - const [flash, setFlash] = useState(false); - const prevRef = useRef(fetchingCount); - - useEffect(() => { - const wasFetching = prevRef.current > 0; - const nowIdle = fetchingCount === 0; - prevRef.current = fetchingCount; - - if (!wasFetching || !nowIdle) return; - - setFlash(true); - const timer = setTimeout(() => setFlash(false), 1500); - return () => clearTimeout(timer); - }, [fetchingCount]); - - return flash; -} +const StatusDot = forwardRef( + ({ color, processing, ...others }, ref) => ( + + + + + + ), +); export const QueryRefreshIndicator = () => { - const { rows, widgetFetchingCount, errorCount, staleCount, totalCount } = useQueryCacheStatus(); - const showGreen = useGreenFlash(widgetFetchingCount); - useCompletionBeep(widgetFetchingCount); + const [isEditMode] = useEditMode(); + const { rows, widgetFetchingCount, errorCount, totalCount } = useQueryCacheStatus(); - if (totalCount === 0) return null; + if (isEditMode || totalCount === 0) return null; const isFetching = widgetFetchingCount > 0; - const color = isFetching ? "orange" : showGreen ? "green" : errorCount > 0 ? "red" : "green"; + const color = isFetching ? "orange" : errorCount > 0 ? "red" : "green"; + const grouped = groupBySection(rows); return ( - - - - - - - - - - - - - Integration status - - - {totalCount} queries · {widgetFetchingCount} fetching, {staleCount} stale, {errorCount} errors - - - - - - {rows.map((row) => ( - + + + + + + + {Array.from(grouped).map(([section, sectionRows], i) => ( +
+ {i > 0 && } + {section} + {sectionRows.map((row) => ( + ))} - - - - - +
+ ))} +
+
+
); }; -const QueryRow = ({ row }: { row: QueryStatusRow }) => { - const rowColor = statusColorMap[row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}`] ?? "gray"; +const QueryMenuItem = ({ row }: { row: QueryStatusRow }) => { + const rowColor = statusColorMap[ + row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}` + ] ?? "gray"; const updatedLabel = row.dataUpdatedAt > 0 ? dayjs(row.dataUpdatedAt).fromNow() : "never"; return ( - - - - {row.label} + + } + rightSection={ + + {updatedLabel} + + } + style={{ cursor: "default" }} + > + + {row.procedure} - - {updatedLabel} - - + ); }; diff --git a/apps/nextjs/src/components/layout/logo/board-logo.tsx b/apps/nextjs/src/components/layout/logo/board-logo.tsx index ad2f1ca2e..86bf94eeb 100644 --- a/apps/nextjs/src/components/layout/logo/board-logo.tsx +++ b/apps/nextjs/src/components/layout/logo/board-logo.tsx @@ -1,7 +1,10 @@ "use client"; +import { Group } from "@mantine/core"; + import { useRequiredBoard } from "@homarr/boards/context"; +import { QueryRefreshIndicator } from "../header/query-refresh-indicator"; import { homarrLogoPath, homarrPageTitle } from "./homarr-logo"; import type { LogoWithTitleProps } from "./logo"; import { Logo, LogoWithTitle } from "./logo"; @@ -33,11 +36,14 @@ export const BoardLogoWithTitle = ({ size, hideTitleOnMobile }: CommonLogoWithTi const board = useRequiredBoard(); const imageOptions = useImageOptions(); return ( - + + + + ); }; From 394debbea13a6195f1344be932c60f7e7e3fbaba Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Thu, 28 May 2026 17:20:44 +0200 Subject: [PATCH 04/18] refactor(widgets): migrate all widgets from useSuspenseQuery to useQuery Non-blocking data fetching for all 38 widget components. Widgets now render immediately and show data when available, with loading state delegated to the global refresh indicator in the board header. --- .../widgets/src/anchor-note/component.tsx | 34 +++++++++++-------- packages/widgets/src/app/component.tsx | 9 ++--- .../widgets/src/app/ping/ping-indicator.tsx | 15 ++++---- packages/widgets/src/bookmarks/component.tsx | 2 +- packages/widgets/src/coolify/component.tsx | 2 +- .../src/dns-hole/controls/component.tsx | 2 +- .../src/dns-hole/summary/component.tsx | 2 +- packages/widgets/src/docker/component.tsx | 5 +-- packages/widgets/src/downloads/component.tsx | 2 +- packages/widgets/src/firewall/component.tsx | 8 ++--- .../cluster/cluster-health.tsx | 4 ++- .../src/health-monitoring/component.tsx | 2 +- .../src/health-monitoring/system-health.tsx | 2 +- .../src/immich/album-carousel/component.tsx | 4 ++- .../src/immich/server-stats/component.tsx | 4 ++- .../widgets/src/indexer-manager/component.tsx | 2 +- .../widgets/src/media-releases/component.tsx | 2 +- .../src/media-requests/list/component.tsx | 2 +- .../src/media-requests/stats/component.tsx | 3 +- .../widgets/src/media-server/component.tsx | 2 +- .../src/media-transcoding/component.tsx | 5 ++- .../src/minecraft/server-status/component.tsx | 5 ++- .../network-status/component.tsx | 2 +- .../network-controller/summary/component.tsx | 2 +- .../widgets/src/notifications/component.tsx | 2 +- packages/widgets/src/releases/component.tsx | 4 ++- packages/widgets/src/rssFeed/component.tsx | 2 +- .../src/smart-home/entity-state/component.tsx | 2 +- .../src/speedtest-tracker/component.tsx | 2 +- packages/widgets/src/stocks/component.tsx | 5 ++- .../widgets/src/system-disks/component.tsx | 2 +- .../src/system-resources/component.tsx | 2 +- packages/widgets/src/timetable/component.tsx | 4 +-- packages/widgets/src/tracearr/component.tsx | 2 +- packages/widgets/src/umami/umami-content.tsx | 4 +-- .../src/umami/umami-events-content.tsx | 2 +- packages/widgets/src/umami/umami-top-list.tsx | 4 +-- packages/widgets/src/weather/component.tsx | 4 ++- 38 files changed, 96 insertions(+), 67 deletions(-) diff --git a/packages/widgets/src/anchor-note/component.tsx b/packages/widgets/src/anchor-note/component.tsx index f3fde1f97..220c2983a 100644 --- a/packages/widgets/src/anchor-note/component.tsx +++ b/packages/widgets/src/anchor-note/component.tsx @@ -144,7 +144,7 @@ interface AnchorNoteWidgetContentProps { const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteWidgetContentProps) => { const t = useScopedI18n("widget.anchorNote"); - const [note, { refetch }] = clientApi.widget.anchorNotes.getNote.useSuspenseQuery( + const { data: note, refetch } = clientApi.widget.anchorNotes.getNote.useQuery( { integrationId, noteId, @@ -159,31 +159,32 @@ const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteW const { mutateAsync: updateNoteAsync, isPending: isUpdating } = clientApi.widget.anchorNotes.updateNote.useMutation(); const [isEditing, setIsEditing] = useState(false); - const [draftTitle, setDraftTitle] = useState(note.title); - const [draftContent, setDraftContent] = useState(note.content ?? ""); + const [draftTitle, setDraftTitle] = useState(note?.title ?? ""); + const [draftContent, setDraftContent] = useState(note?.content ?? ""); const [saveError, setSaveError] = useState(null); useEffect(() => { - if (isEditing) return; + if (isEditing || !note) return; startTransition(() => { setDraftTitle(note.title); setDraftContent(note.content ?? ""); }); - }, [isEditing, note.content, note.title]); + }, [isEditing, note]); - const canEdit = canEditPermission(note.permission); - const isViewer = note.permission === "viewer"; - const updatedAt = useMemo(() => new Date(note.updatedAt), [note.updatedAt]); + const canEdit = canEditPermission(note?.permission ?? "viewer"); + const isViewer = !note || note.permission === "viewer"; + const updatedAt = useMemo(() => (note ? new Date(note.updatedAt) : new Date()), [note]); const updatedAtRelative = useTimeAgo(updatedAt, 30000); const hasChanges = useMemo(() => { + if (!note) return false; const normalizedTitle = draftTitle.trim() || note.title; return normalizedTitle !== note.title || draftContent !== (note.content ?? ""); - }, [draftContent, draftTitle, note.content, note.title]); + }, [draftContent, draftTitle, note]); const editorValue = useMemo(() => parseStoredContent(draftContent), [draftContent]); - const readOnlyValue = useMemo(() => parseStoredContent(note.content), [note.content]); + const readOnlyValue = useMemo(() => parseStoredContent(note?.content), [note?.content]); const handleEditorChange = useCallback( (_html, _delta, source, editor) => { if (!isEditing || source !== "user") return; @@ -194,26 +195,27 @@ const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteW ); const handleEdit = useCallback(() => { - if (!canEdit) return; + if (!canEdit || !note) return; startTransition(() => { setDraftTitle(note.title); setDraftContent(note.content ?? ""); setSaveError(null); setIsEditing(true); }); - }, [canEdit, note.content, note.title]); + }, [canEdit, note]); const handleCancel = useCallback(() => { + if (!note) return; startTransition(() => { setDraftTitle(note.title); setDraftContent(note.content ?? ""); setSaveError(null); setIsEditing(false); }); - }, [note.content, note.title]); + }, [note]); const handleSave = useCallback(async () => { - if (!canEdit) return; + if (!canEdit || !note) return; const normalizedTitle = draftTitle.trim() || note.title || t("untitled"); @@ -260,7 +262,9 @@ const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteW }, }, ); - }, [canEdit, draftContent, draftTitle, hasChanges, integrationId, note.title, noteId, refetch, t, updateNoteAsync]); + }, [canEdit, draftContent, draftTitle, hasChanges, integrationId, note, noteId, refetch, t, updateNoteAsync]); + + if (!note) return null; return ( diff --git a/packages/widgets/src/app/component.tsx b/packages/widgets/src/app/component.tsx index 1caa1ce56..b2654b6eb 100644 --- a/packages/widgets/src/app/component.tsx +++ b/packages/widgets/src/app/component.tsx @@ -22,7 +22,7 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget const t = useI18n(); const settings = useSettings(); const board = useRequiredBoard(); - const [app] = clientApi.app.byId.useSuspenseQuery( + const { data: app } = clientApi.app.byId.useQuery( { id: options.appId, }, @@ -34,8 +34,8 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget }, ); useRegisterSpotlightContextResults( - `app-${app.id}`, - app.href + `app-${app?.id ?? options.appId}`, + app?.href ? [ { id: app.id, @@ -44,7 +44,6 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget interaction() { return { type: "link", - // We checked above that app.href is defined // eslint-disable-next-line @typescript-eslint/no-non-null-assertion href: app.href!, newTab: options.openInNewTab, @@ -56,6 +55,8 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget [app, options.openInNewTab], ); + if (!app) return null; + const isTiny = height < 100 || width < 100; const isColumnLayout = options.layout.startsWith("column"); diff --git a/packages/widgets/src/app/ping/ping-indicator.tsx b/packages/widgets/src/app/ping/ping-indicator.tsx index a6299ed95..6ca1aaa2d 100644 --- a/packages/widgets/src/app/ping/ping-indicator.tsx +++ b/packages/widgets/src/app/ping/ping-indicator.tsx @@ -11,7 +11,7 @@ interface PingIndicatorProps { } export const PingIndicator = ({ appId }: PingIndicatorProps) => { - const [ping] = clientApi.widget.app.ping.useSuspenseQuery( + const { data: ping } = clientApi.widget.app.ping.useQuery( { id: appId, }, @@ -21,7 +21,7 @@ export const PingIndicator = ({ appId }: PingIndicatorProps) => { }, ); - const [pingResult, setPingResult] = useState(ping); + const [pingResult, setPingResult] = useState(ping); clientApi.widget.app.updatedPing.useSubscription( { id: appId }, @@ -32,16 +32,19 @@ export const PingIndicator = ({ appId }: PingIndicatorProps) => { }, ); - const isError = "error" in pingResult || pingResult.statusCode >= 500; + const current = pingResult ?? ping; + if (!current) return null; + + const isError = "error" in current || current.statusCode >= 500; return ( ); diff --git a/packages/widgets/src/bookmarks/component.tsx b/packages/widgets/src/bookmarks/component.tsx index 09066f90d..a6b8853ad 100644 --- a/packages/widgets/src/bookmarks/component.tsx +++ b/packages/widgets/src/bookmarks/component.tsx @@ -14,7 +14,7 @@ import classes from "./bookmark.module.css"; export default function BookmarksWidget({ options, itemId }: WidgetComponentProps<"bookmarks">) { const board = useRequiredBoard(); - const [data] = clientApi.app.byIds.useSuspenseQuery(options.items, { + const { data = [] } = clientApi.app.byIds.useQuery(options.items, { select(data) { return data.sort((appA, appB) => options.items.indexOf(appA.id) - options.items.indexOf(appB.id)); }, diff --git a/packages/widgets/src/coolify/component.tsx b/packages/widgets/src/coolify/component.tsx index a62b4f3cd..3dde4bcfb 100644 --- a/packages/widgets/src/coolify/component.tsx +++ b/packages/widgets/src/coolify/component.tsx @@ -31,7 +31,7 @@ interface CoolifyContentProps { } function CoolifyContent({ integrationIds, options, width }: CoolifyContentProps) { - const [instancesData] = clientApi.widget.coolify.getInstancesInfo.useSuspenseQuery({ integrationIds }); + const { data: instancesData = [] } = clientApi.widget.coolify.getInstancesInfo.useQuery({ integrationIds }); const utils = clientApi.useUtils(); clientApi.widget.coolify.subscribeInstancesInfo.useSubscription( diff --git a/packages/widgets/src/dns-hole/controls/component.tsx b/packages/widgets/src/dns-hole/controls/component.tsx index 8ce9251a4..460e86d04 100644 --- a/packages/widgets/src/dns-hole/controls/component.tsx +++ b/packages/widgets/src/dns-hole/controls/component.tsx @@ -51,7 +51,7 @@ export default function DnsHoleControlsWidget({ .map(({ id }) => id) .filter((id) => integrationIds.includes(id)); - const [summaries] = clientApi.widget.dnsHole.summary.useSuspenseQuery( + const { data: summaries = [] } = clientApi.widget.dnsHole.summary.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/dns-hole/summary/component.tsx b/packages/widgets/src/dns-hole/summary/component.tsx index b0636ff44..a72960d03 100644 --- a/packages/widgets/src/dns-hole/summary/component.tsx +++ b/packages/widgets/src/dns-hole/summary/component.tsx @@ -20,7 +20,7 @@ import type { widgetKind } from "."; import type { WidgetComponentProps, WidgetProps } from "../../definition"; export default function DnsHoleSummaryWidget({ options, integrationIds }: WidgetComponentProps) { - const [summaries] = clientApi.widget.dnsHole.summary.useSuspenseQuery( + const { data: summaries = [] } = clientApi.widget.dnsHole.summary.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/docker/component.tsx b/packages/widgets/src/docker/component.tsx index e47c77f33..4a95c3989 100644 --- a/packages/widgets/src/docker/component.tsx +++ b/packages/widgets/src/docker/component.tsx @@ -204,8 +204,9 @@ export default function DockerWidget({ options, width, isEditMode }: WidgetCompo const isTiny = width <= 256; const utils = clientApi.useUtils(); - const [{ containers, timestamp }] = clientApi.docker.getContainers.useSuspenseQuery(); - const relativeTime = useTimeAgo(timestamp); + const { data } = clientApi.docker.getContainers.useQuery(); + const containers = data?.containers ?? []; + const relativeTime = useTimeAgo(data?.timestamp ?? new Date()); clientApi.docker.subscribeContainers.useSubscription(undefined, { onData(data) { diff --git a/packages/widgets/src/downloads/component.tsx b/packages/widgets/src/downloads/component.tsx index 96e63a106..54a602507 100644 --- a/packages/widgets/src/downloads/component.tsx +++ b/packages/widgets/src/downloads/component.tsx @@ -87,7 +87,7 @@ export default function DownloadClientsWidget({ integrationIds.includes(id) ? [id] : [], ); - const [currentItems] = clientApi.widget.downloads.getJobsAndStatuses.useSuspenseQuery( + const { data: currentItems = [] } = clientApi.widget.downloads.getJobsAndStatuses.useQuery( { integrationIds, limitPerIntegration: options.limitPerIntegration, diff --git a/packages/widgets/src/firewall/component.tsx b/packages/widgets/src/firewall/component.tsx index cf5ac2b0e..80f1812eb 100644 --- a/packages/widgets/src/firewall/component.tsx +++ b/packages/widgets/src/firewall/component.tsx @@ -184,7 +184,7 @@ export default function FirewallWidget({ integrationIds, width, itemId }: Widget export const useUpdatingCpuStatus = (integrationIds: string[]) => { const utils = clientApi.useUtils(); - const [firewallsCpuData] = clientApi.widget.firewall.getFirewallCpuStatus.useSuspenseQuery( + const { data: firewallsCpuData = [] } = clientApi.widget.firewall.getFirewallCpuStatus.useQuery( { integrationIds, }, @@ -225,7 +225,7 @@ export const useUpdatingCpuStatus = (integrationIds: string[]) => { export const useUpdatingMemoryStatus = (integrationIds: string[]) => { const utils = clientApi.useUtils(); - const [firewallsMemoryData] = clientApi.widget.firewall.getFirewallMemoryStatus.useSuspenseQuery( + const { data: firewallsMemoryData = [] } = clientApi.widget.firewall.getFirewallMemoryStatus.useQuery( { integrationIds, }, @@ -266,7 +266,7 @@ export const useUpdatingMemoryStatus = (integrationIds: string[]) => { export const useUpdatingVersionStatus = (integrationIds: string[]) => { const utils = clientApi.useUtils(); - const [firewallsVersionData] = clientApi.widget.firewall.getFirewallVersionStatus.useSuspenseQuery( + const { data: firewallsVersionData = [] } = clientApi.widget.firewall.getFirewallVersionStatus.useQuery( { integrationIds, }, @@ -306,7 +306,7 @@ export const useUpdatingVersionStatus = (integrationIds: string[]) => { export const useUpdatingInterfacesStatus = (integrationIds: string[]) => { const utils = clientApi.useUtils(); - const [firewallsInterfacesData] = clientApi.widget.firewall.getFirewallInterfacesStatus.useSuspenseQuery( + const { data: firewallsInterfacesData = [] } = clientApi.widget.firewall.getFirewallInterfacesStatus.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx b/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx index 3ffa99bdc..9f9d2a1bd 100644 --- a/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx +++ b/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx @@ -34,7 +34,7 @@ export const ClusterHealthMonitoring = ({ width, }: WidgetComponentProps<"healthMonitoring"> & { integrationId: string }) => { const t = useI18n(); - const [healthData] = clientApi.widget.healthMonitoring.getClusterHealthStatus.useSuspenseQuery( + const { data: healthData } = clientApi.widget.healthMonitoring.getClusterHealthStatus.useQuery( { integrationId, }, @@ -56,6 +56,8 @@ export const ClusterHealthMonitoring = ({ }, ); + if (!healthData) return null; + const activeNodes = healthData.nodes.reduce(running, 0); const activeVMs = healthData.vms.reduce(running, 0); const activeLXCs = healthData.lxcs.reduce(running, 0); diff --git a/packages/widgets/src/health-monitoring/component.tsx b/packages/widgets/src/health-monitoring/component.tsx index baa958fe9..ead4fef92 100644 --- a/packages/widgets/src/health-monitoring/component.tsx +++ b/packages/widgets/src/health-monitoring/component.tsx @@ -18,7 +18,7 @@ const isClusterIntegration = (integration: { kind: IntegrationKind }) => integration.kind === "proxmox" || integration.kind === "mock"; export default function HealthMonitoringWidget(props: WidgetComponentProps<"healthMonitoring">) { - const [integrations] = clientApi.integration.byIds.useSuspenseQuery(props.integrationIds); + const { data: integrations = [] } = clientApi.integration.byIds.useQuery(props.integrationIds); const t = useI18n(); const clusterIntegrationId = integrations.find(isClusterIntegration)?.id; diff --git a/packages/widgets/src/health-monitoring/system-health.tsx b/packages/widgets/src/health-monitoring/system-health.tsx index 6e7d2965c..4a66b61ac 100644 --- a/packages/widgets/src/health-monitoring/system-health.tsx +++ b/packages/widgets/src/health-monitoring/system-health.tsx @@ -51,7 +51,7 @@ export const SystemHealthMonitoring = ({ width, }: WidgetComponentProps<"healthMonitoring">) => { const t = useI18n(); - const [healthData] = clientApi.widget.healthMonitoring.getSystemHealthStatus.useSuspenseQuery( + const { data: healthData = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/immich/album-carousel/component.tsx b/packages/widgets/src/immich/album-carousel/component.tsx index a8a920d5d..c84ed7ae7 100644 --- a/packages/widgets/src/immich/album-carousel/component.tsx +++ b/packages/widgets/src/immich/album-carousel/component.tsx @@ -21,11 +21,13 @@ export default function ImmichAlbumCarouselWidget({ return ; } - const [album] = clientApi.widget.immich.getAlbum.useSuspenseQuery({ + const { data: album } = clientApi.widget.immich.getAlbum.useQuery({ integrationId: integrationIds[0] ?? "", albumId: options.albumId, }); + if (!album) return null; + if (album.assets.length === 0) { return ; } diff --git a/packages/widgets/src/immich/server-stats/component.tsx b/packages/widgets/src/immich/server-stats/component.tsx index 0240a27c4..22346d376 100644 --- a/packages/widgets/src/immich/server-stats/component.tsx +++ b/packages/widgets/src/immich/server-stats/component.tsx @@ -16,10 +16,12 @@ export default function ImmichServerStatsWidget({ options, }: WidgetComponentProps<"immich-serverStats">) { const t = useI18n(); - const [stats] = clientApi.widget.immich.getServerStats.useSuspenseQuery({ + const { data: stats } = clientApi.widget.immich.getServerStats.useQuery({ integrationId: integrationIds[0] ?? "", }); + if (!stats) return null; + return ( {options.showUsers && ( diff --git a/packages/widgets/src/indexer-manager/component.tsx b/packages/widgets/src/indexer-manager/component.tsx index e406ffa8a..ce0e89403 100644 --- a/packages/widgets/src/indexer-manager/component.tsx +++ b/packages/widgets/src/indexer-manager/component.tsx @@ -18,7 +18,7 @@ export default function IndexerManagerWidget({ height, }: WidgetComponentProps<"indexerManager">) { const t = useI18n(); - const [indexersData] = clientApi.widget.indexerManager.getIndexersStatus.useSuspenseQuery( + const { data: indexersData = [] } = clientApi.widget.indexerManager.getIndexersStatus.useQuery( { integrationIds }, { refetchOnMount: false, diff --git a/packages/widgets/src/media-releases/component.tsx b/packages/widgets/src/media-releases/component.tsx index cd2432ddb..26fe367a9 100644 --- a/packages/widgets/src/media-releases/component.tsx +++ b/packages/widgets/src/media-releases/component.tsx @@ -18,7 +18,7 @@ import { OverflowBadge } from "@homarr/ui"; import type { WidgetComponentProps } from "../definition"; export default function MediaReleasesWidget({ options, integrationIds }: WidgetComponentProps<"mediaReleases">) { - const [releases] = clientApi.widget.mediaRelease.getMediaReleases.useSuspenseQuery({ + const { data: releases = [] } = clientApi.widget.mediaRelease.getMediaReleases.useQuery({ integrationIds, }); diff --git a/packages/widgets/src/media-requests/list/component.tsx b/packages/widgets/src/media-requests/list/component.tsx index 5d86c40a1..b2320f426 100644 --- a/packages/widgets/src/media-requests/list/component.tsx +++ b/packages/widgets/src/media-requests/list/component.tsx @@ -19,7 +19,7 @@ export default function MediaServerWidget({ options, width, }: WidgetComponentProps<"mediaRequests-requestList">) { - const [mediaRequests] = clientApi.widget.mediaRequests.getLatestRequests.useSuspenseQuery( + const { data: mediaRequests = [] } = clientApi.widget.mediaRequests.getLatestRequests.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/media-requests/stats/component.tsx b/packages/widgets/src/media-requests/stats/component.tsx index 4a1b6ed09..2119457c4 100644 --- a/packages/widgets/src/media-requests/stats/component.tsx +++ b/packages/widgets/src/media-requests/stats/component.tsx @@ -32,7 +32,7 @@ export default function MediaServerWidget({ width, }: WidgetComponentProps<"mediaRequests-requestStats">) { const t = useScopedI18n("widget.mediaRequests-requestStats"); - const [requestStats] = clientApi.widget.mediaRequests.getStats.useSuspenseQuery( + const { data: requestStats } = clientApi.widget.mediaRequests.getStats.useQuery( { integrationIds, }, @@ -45,6 +45,7 @@ export default function MediaServerWidget({ const board = useRequiredBoard(); + if (!requestStats) return null; if (requestStats.users.length === 0 && requestStats.stats.length === 0) throw new NoIntegrationDataError(); const data = [ diff --git a/packages/widgets/src/media-server/component.tsx b/packages/widgets/src/media-server/component.tsx index 9b540339e..138728e57 100644 --- a/packages/widgets/src/media-server/component.tsx +++ b/packages/widgets/src/media-server/component.tsx @@ -23,7 +23,7 @@ export default function MediaServerWidget({ integrationIds, isEditMode, }: WidgetComponentProps<"mediaServer">) { - const [currentStreams] = clientApi.widget.mediaServer.getCurrentStreams.useSuspenseQuery( + const { data: currentStreams = [] } = clientApi.widget.mediaServer.getCurrentStreams.useQuery( { integrationIds, showOnlyPlaying: options.showOnlyPlaying, diff --git a/packages/widgets/src/media-transcoding/component.tsx b/packages/widgets/src/media-transcoding/component.tsx index 8967210b3..8910de1ab 100644 --- a/packages/widgets/src/media-transcoding/component.tsx +++ b/packages/widgets/src/media-transcoding/component.tsx @@ -37,7 +37,7 @@ export default function MediaTranscodingWidget({ pageSize: queuePageSize, page: queuePage, }; - const [transcodingData] = clientApi.widget.mediaTranscoding.getDataAsync.useSuspenseQuery(input, { + const { data: transcodingData } = clientApi.widget.mediaTranscoding.getDataAsync.useQuery(input, { refetchOnMount: false, refetchOnWindowFocus: false, refetchOnReconnect: false, @@ -51,6 +51,9 @@ export default function MediaTranscodingWidget({ }); const [view, setView] = useState(options.defaultView); + + if (!transcodingData) return null; + const totalQueuePages = Math.ceil((transcodingData.data.queue.totalCount || 1) / queuePageSize); const t = useI18n("widget.mediaTranscoding"); diff --git a/packages/widgets/src/minecraft/server-status/component.tsx b/packages/widgets/src/minecraft/server-status/component.tsx index 00556be85..630fb049f 100644 --- a/packages/widgets/src/minecraft/server-status/component.tsx +++ b/packages/widgets/src/minecraft/server-status/component.tsx @@ -10,7 +10,7 @@ import { useScopedI18n } from "@homarr/translation/client"; import type { WidgetComponentProps } from "../../definition"; export default function MinecraftServerStatusWidget({ options }: WidgetComponentProps<"minecraftServerStatus">) { - const [{ data }] = clientApi.widget.minecraft.getServerStatus.useSuspenseQuery(options); + const { data: result } = clientApi.widget.minecraft.getServerStatus.useQuery(options); const utils = clientApi.useUtils(); clientApi.widget.minecraft.subscribeServerStatus.useSubscription(options, { onData(data) { @@ -22,6 +22,9 @@ export default function MinecraftServerStatusWidget({ options }: WidgetComponent }); const tStatus = useScopedI18n("widget.minecraftServerStatus.status"); + if (!result) return null; + const { data } = result; + const title = options.title.trim().length > 0 ? options.title : options.domain; return ( diff --git a/packages/widgets/src/network-controller/network-status/component.tsx b/packages/widgets/src/network-controller/network-status/component.tsx index f87973252..e0ce57dfb 100644 --- a/packages/widgets/src/network-controller/network-status/component.tsx +++ b/packages/widgets/src/network-controller/network-status/component.tsx @@ -21,7 +21,7 @@ export default function NetworkControllerNetworkStatusWidget({ options, integrationIds, }: WidgetComponentProps<"networkControllerStatus">) { - const [summaries] = clientApi.widget.networkController.summary.useSuspenseQuery( + const { data: summaries = [] } = clientApi.widget.networkController.summary.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/network-controller/summary/component.tsx b/packages/widgets/src/network-controller/summary/component.tsx index bbd9775cd..040b53eca 100644 --- a/packages/widgets/src/network-controller/summary/component.tsx +++ b/packages/widgets/src/network-controller/summary/component.tsx @@ -20,7 +20,7 @@ dayjs.extend(duration); export default function NetworkControllerSummaryWidget({ integrationIds, }: WidgetComponentProps<"networkControllerSummary">) { - const [summaries] = clientApi.widget.networkController.summary.useSuspenseQuery( + const { data: summaries = [] } = clientApi.widget.networkController.summary.useQuery( { integrationIds, }, diff --git a/packages/widgets/src/notifications/component.tsx b/packages/widgets/src/notifications/component.tsx index 72a662956..4334836b9 100644 --- a/packages/widgets/src/notifications/component.tsx +++ b/packages/widgets/src/notifications/component.tsx @@ -12,7 +12,7 @@ import { useScopedI18n } from "@homarr/translation/client"; import type { WidgetComponentProps } from "../definition"; export default function NotificationsWidget({ options, integrationIds }: WidgetComponentProps<"notifications">) { - const [notificationIntegrations] = clientApi.widget.notifications.getNotifications.useSuspenseQuery( + const { data: notificationIntegrations = [] } = clientApi.widget.notifications.getNotifications.useQuery( { ...options, integrationIds, diff --git a/packages/widgets/src/releases/component.tsx b/packages/widgets/src/releases/component.tsx index fdd9f1f0b..302c4b6c9 100644 --- a/packages/widgets/src/releases/component.tsx +++ b/packages/widgets/src/releases/component.tsx @@ -81,7 +81,7 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas ); }, [groupedRepositories]); - const [results] = clientApi.useSuspenseQueries((t) => + const queryResults = clientApi.useQueries((t) => batchedRepositories.flatMap(({ integrationId, repositories }) => t.widget.releases.getLatest({ integrationId, @@ -94,6 +94,8 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas ), ); + const results = queryResults.map((q) => q.data).filter(Boolean); + const repositories = useMemo(() => { const formattedResults = options.repositories .map((repository) => { diff --git a/packages/widgets/src/rssFeed/component.tsx b/packages/widgets/src/rssFeed/component.tsx index 843168b88..008e06c7d 100644 --- a/packages/widgets/src/rssFeed/component.tsx +++ b/packages/widgets/src/rssFeed/component.tsx @@ -12,7 +12,7 @@ import type { WidgetComponentProps } from "../definition"; import classes from "./component.module.scss"; const useLiveFeedEntries = (input: RouterInputs["widget"]["rssFeed"]["getFeeds"]) => { - const [feedEntries] = clientApi.widget.rssFeed.getFeeds.useSuspenseQuery(input, { + const { data: feedEntries = [] } = clientApi.widget.rssFeed.getFeeds.useQuery(input, { refetchOnMount: false, refetchOnWindowFocus: false, refetchOnReconnect: false, diff --git a/packages/widgets/src/smart-home/entity-state/component.tsx b/packages/widgets/src/smart-home/entity-state/component.tsx index f11cfa844..f796f3261 100644 --- a/packages/widgets/src/smart-home/entity-state/component.tsx +++ b/packages/widgets/src/smart-home/entity-state/component.tsx @@ -23,7 +23,7 @@ export default function SmartHomeEntityStateWidget({ entityId: options.entityId, integrationId, }; - const [entityState] = clientApi.widget.smartHome.entityState.useSuspenseQuery(input); + const { data: entityState } = clientApi.widget.smartHome.entityState.useQuery(input); const utils = clientApi.useUtils(); diff --git a/packages/widgets/src/speedtest-tracker/component.tsx b/packages/widgets/src/speedtest-tracker/component.tsx index 699b354a9..4c9a0e22e 100644 --- a/packages/widgets/src/speedtest-tracker/component.tsx +++ b/packages/widgets/src/speedtest-tracker/component.tsx @@ -19,7 +19,7 @@ export default function SpeedtestTrackerWidget({ isEditMode, }: WidgetComponentProps<"speedtestTracker">) { const t = useScopedI18n("widget.speedtestTracker"); - const [dashboardData] = clientApi.widget.speedtestTracker.getDashboard.useSuspenseQuery({ integrationIds }); + const { data: dashboardData = [] } = clientApi.widget.speedtestTracker.getDashboard.useQuery({ integrationIds }); const utils = clientApi.useUtils(); clientApi.widget.speedtestTracker.subscribeToDashboard.useSubscription( diff --git a/packages/widgets/src/stocks/component.tsx b/packages/widgets/src/stocks/component.tsx index e9d7b98ad..f5e64259b 100644 --- a/packages/widgets/src/stocks/component.tsx +++ b/packages/widgets/src/stocks/component.tsx @@ -24,7 +24,10 @@ function calculateChangePercentage(currentPrice: number, previousClose: number) export default function StockPriceWidget({ options, width, height }: WidgetComponentProps<"stockPrice">) { const t = useScopedI18n("widget.stockPrice"); const theme = useMantineTheme(); - const [{ data }] = clientApi.widget.stockPrice.getPriceHistory.useSuspenseQuery(options); + const { data: result } = clientApi.widget.stockPrice.getPriceHistory.useQuery(options); + + if (!result) return null; + const { data } = result; const stockValuesChange = round(calculateChange(data.priceHistory.at(-1) ?? 0, data.previousClose)); const stockValuesChangePercentage = round( diff --git a/packages/widgets/src/system-disks/component.tsx b/packages/widgets/src/system-disks/component.tsx index ba2d49c25..3e254fdce 100644 --- a/packages/widgets/src/system-disks/component.tsx +++ b/packages/widgets/src/system-disks/component.tsx @@ -32,7 +32,7 @@ const getDisplayText = (item: { used: string; available: string; percentage: num export default function SystemResources({ integrationIds, options }: WidgetComponentProps<"systemDisks">) { const queryInput = { integrationIds }; - const [data] = clientApi.widget.healthMonitoring.getSystemHealthStatus.useSuspenseQuery(queryInput); + const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery(queryInput); const utils = clientApi.useUtils(); const board = useRequiredBoard(); diff --git a/packages/widgets/src/system-resources/component.tsx b/packages/widgets/src/system-resources/component.tsx index d1d54ff85..d2c5380ad 100644 --- a/packages/widgets/src/system-resources/component.tsx +++ b/packages/widgets/src/system-resources/component.tsx @@ -18,7 +18,7 @@ const MAX_QUEUE_SIZE = 15; export default function SystemResources({ integrationIds, options }: WidgetComponentProps<"systemResources">) { const { ref, width } = useElementSize(); - const [data] = clientApi.widget.healthMonitoring.getSystemHealthStatus.useSuspenseQuery({ + const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery({ integrationIds, }); const memoryCapacityInBytes = diff --git a/packages/widgets/src/timetable/component.tsx b/packages/widgets/src/timetable/component.tsx index ceaf9e41d..2f1ad982b 100644 --- a/packages/widgets/src/timetable/component.tsx +++ b/packages/widgets/src/timetable/component.tsx @@ -26,7 +26,7 @@ interface TimetableWidgetInnerProps { } const TimetableWidgetInner = ({ station, integrationId }: TimetableWidgetInnerProps) => { - const [timetable] = clientApi.widget.timetable.getTimetable.useSuspenseQuery({ + const { data: timetable } = clientApi.widget.timetable.getTimetable.useQuery({ integrationId, stationId: station.value, limit: 10, @@ -36,7 +36,7 @@ const TimetableWidgetInner = ({ station, integrationId }: TimetableWidgetInnerPr return ( {t("title", { station: station.label })} - {timetable.entries.map((entry) => ( + {(timetable?.entries ?? []).map((entry) => ( {entry.line && ( diff --git a/packages/widgets/src/tracearr/component.tsx b/packages/widgets/src/tracearr/component.tsx index 1b26b6c67..4a54779ee 100644 --- a/packages/widgets/src/tracearr/component.tsx +++ b/packages/widgets/src/tracearr/component.tsx @@ -35,7 +35,7 @@ interface TracearrContentProps { function TracearrContent({ integrationIds, options, width, isEditMode }: TracearrContentProps) { const t = useScopedI18n("widget.tracearr"); - const [dashboardData] = clientApi.widget.tracearr.getDashboard.useSuspenseQuery({ integrationIds }); + const { data: dashboardData = [] } = clientApi.widget.tracearr.getDashboard.useQuery({ integrationIds }); const utils = clientApi.useUtils(); clientApi.widget.tracearr.subscribeToDashboard.useSubscription( diff --git a/packages/widgets/src/umami/umami-content.tsx b/packages/widgets/src/umami/umami-content.tsx index da9494519..9121609ed 100644 --- a/packages/widgets/src/umami/umami-content.tsx +++ b/packages/widgets/src/umami/umami-content.tsx @@ -40,7 +40,7 @@ export function UmamiContent({ const { colorScheme } = useMantineColorScheme(); const tickColor = colorScheme === "dark" ? "#c1c2c5" : "#495057"; - const [results] = clientApi.widget.umami.getVisitorStats.useSuspenseQuery({ + const { data: results = [] } = clientApi.widget.umami.getVisitorStats.useQuery({ integrationIds, websiteId, timeFrame, @@ -48,7 +48,7 @@ export function UmamiContent({ }); const activeVisitorsInput = { integrationId: integrationIds[0] ?? "", websiteId }; - const [activeVisitors] = clientApi.widget.umami.getActiveVisitors.useSuspenseQuery(activeVisitorsInput); + const { data: activeVisitors = 0 } = clientApi.widget.umami.getActiveVisitors.useQuery(activeVisitorsInput); const utils = clientApi.useUtils(); clientApi.widget.umami.subscribeActiveVisitors.useSubscription(activeVisitorsInput, { onData(count) { diff --git a/packages/widgets/src/umami/umami-events-content.tsx b/packages/widgets/src/umami/umami-events-content.tsx index 0962d3681..c6d1acedd 100644 --- a/packages/widgets/src/umami/umami-events-content.tsx +++ b/packages/widgets/src/umami/umami-events-content.tsx @@ -28,7 +28,7 @@ export function UmamiEventsContent({ const { colorScheme } = useMantineColorScheme(); const tickColor = colorScheme === "dark" ? "#c1c2c5" : "#495057"; - const [series] = clientApi.widget.umami.getMultiEventTimeSeries.useSuspenseQuery({ + const { data: series = [] } = clientApi.widget.umami.getMultiEventTimeSeries.useQuery({ integrationId: integrationIds[0] ?? "", websiteId, timeFrame, diff --git a/packages/widgets/src/umami/umami-top-list.tsx b/packages/widgets/src/umami/umami-top-list.tsx index 1d9a87988..699df9b74 100644 --- a/packages/widgets/src/umami/umami-top-list.tsx +++ b/packages/widgets/src/umami/umami-top-list.tsx @@ -15,7 +15,7 @@ interface UmamiTopListProps { export function UmamiTopPagesContent({ integrationIds, websiteId, timeFrame, limit }: UmamiTopListProps) { const t = useScopedI18n("widget.umami"); - const [data] = clientApi.widget.umami.getTopPages.useSuspenseQuery({ + const { data = [] } = clientApi.widget.umami.getTopPages.useQuery({ integrationId: integrationIds[0] ?? "", websiteId, timeFrame, @@ -26,7 +26,7 @@ export function UmamiTopPagesContent({ integrationIds, websiteId, timeFrame, lim export function UmamiTopReferrersContent({ integrationIds, websiteId, timeFrame, limit }: UmamiTopListProps) { const t = useScopedI18n("widget.umami"); - const [data] = clientApi.widget.umami.getTopReferrers.useSuspenseQuery({ + const { data = [] } = clientApi.widget.umami.getTopReferrers.useQuery({ integrationId: integrationIds[0] ?? "", websiteId, timeFrame, diff --git a/packages/widgets/src/weather/component.tsx b/packages/widgets/src/weather/component.tsx index f81736c27..60de018f4 100644 --- a/packages/widgets/src/weather/component.tsx +++ b/packages/widgets/src/weather/component.tsx @@ -18,7 +18,7 @@ export default function WeatherWidget({ isEditMode, options }: WidgetComponentPr latitude: options.location.latitude, longitude: options.location.longitude, }; - const [weather] = clientApi.widget.weather.atLocation.useSuspenseQuery(input, { + const { data: weather } = clientApi.widget.weather.atLocation.useQuery(input, { refetchOnMount: false, refetchOnWindowFocus: false, refetchOnReconnect: false, @@ -29,6 +29,8 @@ export default function WeatherWidget({ isEditMode, options }: WidgetComponentPr onData: (data) => utils.widget.weather.atLocation.setData(input, data), }); + if (!weather) return null; + return ( Date: Thu, 28 May 2026 17:49:30 +0200 Subject: [PATCH 05/18] fix(widgets): resolve hooks violations, stale state, and missing edit-mode guard - Move hooks above early returns in system-disks, immich-carousel, media-transcoding - Add enabled flag to immich-carousel query when albumId is absent - Replace disconnected local state in ping-indicator with query cache setData - Stabilize docker timestamp with useMemo to prevent useTimeAgo flicker - Wrap releases results in useMemo with proper type narrowing - Hide refresh indicator during edit mode --- .../widgets/src/app/ping/ping-indicator.tsx | 29 +++++++------------ packages/widgets/src/docker/component.tsx | 3 +- .../src/immich/album-carousel/component.tsx | 13 +++++---- .../src/media-transcoding/component.tsx | 3 +- packages/widgets/src/releases/component.tsx | 5 +++- .../widgets/src/system-disks/component.tsx | 10 +++---- 6 files changed, 30 insertions(+), 33 deletions(-) diff --git a/packages/widgets/src/app/ping/ping-indicator.tsx b/packages/widgets/src/app/ping/ping-indicator.tsx index 6ca1aaa2d..4ec836ca8 100644 --- a/packages/widgets/src/app/ping/ping-indicator.tsx +++ b/packages/widgets/src/app/ping/ping-indicator.tsx @@ -1,7 +1,5 @@ -import { useState } from "react"; import { IconCheck, IconX } from "@tabler/icons-react"; -import type { RouterOutputs } from "@homarr/api"; import { clientApi } from "@homarr/api/client"; import { PingDot } from "./ping-dot"; @@ -11,40 +9,33 @@ interface PingIndicatorProps { } export const PingIndicator = ({ appId }: PingIndicatorProps) => { - const { data: ping } = clientApi.widget.app.ping.useQuery( - { - id: appId, - }, - { - refetchOnMount: false, - refetchOnWindowFocus: false, - }, + const { data: pingResult } = clientApi.widget.app.ping.useQuery( + { id: appId }, + { refetchOnMount: false, refetchOnWindowFocus: false }, ); - const [pingResult, setPingResult] = useState(ping); - + const utils = clientApi.useUtils(); clientApi.widget.app.updatedPing.useSubscription( { id: appId }, { onData(data) { - setPingResult(data); + utils.widget.app.ping.setData({ id: appId }, data); }, }, ); - const current = pingResult ?? ping; - if (!current) return null; + if (!pingResult) return null; - const isError = "error" in current || current.statusCode >= 500; + const isError = "error" in pingResult || pingResult.statusCode >= 500; return ( ); diff --git a/packages/widgets/src/docker/component.tsx b/packages/widgets/src/docker/component.tsx index 4a95c3989..7e6b8ef44 100644 --- a/packages/widgets/src/docker/component.tsx +++ b/packages/widgets/src/docker/component.tsx @@ -206,7 +206,8 @@ export default function DockerWidget({ options, width, isEditMode }: WidgetCompo const utils = clientApi.useUtils(); const { data } = clientApi.docker.getContainers.useQuery(); const containers = data?.containers ?? []; - const relativeTime = useTimeAgo(data?.timestamp ?? new Date()); + const timestamp = useMemo(() => data?.timestamp ?? new Date(), [data?.timestamp]); + const relativeTime = useTimeAgo(timestamp); clientApi.docker.subscribeContainers.useSubscription(undefined, { onData(data) { diff --git a/packages/widgets/src/immich/album-carousel/component.tsx b/packages/widgets/src/immich/album-carousel/component.tsx index c84ed7ae7..cbaa44e07 100644 --- a/packages/widgets/src/immich/album-carousel/component.tsx +++ b/packages/widgets/src/immich/album-carousel/component.tsx @@ -17,15 +17,18 @@ export default function ImmichAlbumCarouselWidget({ }: WidgetComponentProps<"immich-albumCarousel">) { const [currentPhotoIndex, setCurrentPhotoIndex] = useState(0); + const { data: album } = clientApi.widget.immich.getAlbum.useQuery( + { + integrationId: integrationIds[0] ?? "", + albumId: options.albumId ?? "", + }, + { enabled: Boolean(options.albumId) }, + ); + if (!options.albumId) { return ; } - const { data: album } = clientApi.widget.immich.getAlbum.useQuery({ - integrationId: integrationIds[0] ?? "", - albumId: options.albumId, - }); - if (!album) return null; if (album.assets.length === 0) { diff --git a/packages/widgets/src/media-transcoding/component.tsx b/packages/widgets/src/media-transcoding/component.tsx index 8910de1ab..5ab18cd83 100644 --- a/packages/widgets/src/media-transcoding/component.tsx +++ b/packages/widgets/src/media-transcoding/component.tsx @@ -51,12 +51,11 @@ export default function MediaTranscodingWidget({ }); const [view, setView] = useState(options.defaultView); + const t = useI18n("widget.mediaTranscoding"); if (!transcodingData) return null; const totalQueuePages = Math.ceil((transcodingData.data.queue.totalCount || 1) / queuePageSize); - - const t = useI18n("widget.mediaTranscoding"); const isTiny = width < 256; return ( diff --git a/packages/widgets/src/releases/component.tsx b/packages/widgets/src/releases/component.tsx index 302c4b6c9..56e482a45 100644 --- a/packages/widgets/src/releases/component.tsx +++ b/packages/widgets/src/releases/component.tsx @@ -94,7 +94,10 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas ), ); - const results = queryResults.map((q) => q.data).filter(Boolean); + const results = useMemo( + () => queryResults.map((q) => q.data).filter((d): d is NonNullable => d != null), + [queryResults], + ); const repositories = useMemo(() => { const formattedResults = options.repositories diff --git a/packages/widgets/src/system-disks/component.tsx b/packages/widgets/src/system-disks/component.tsx index 3e254fdce..99ee275b4 100644 --- a/packages/widgets/src/system-disks/component.tsx +++ b/packages/widgets/src/system-disks/component.tsx @@ -39,11 +39,6 @@ export default function SystemResources({ integrationIds, options }: WidgetCompo const scheme = useMantineColorScheme(); const t = useI18n(); - const lastItem = data.at(-1); - - if (!lastItem) return null; - const { fileSystem, smart } = lastItem.healthInfo; - clientApi.widget.healthMonitoring.subscribeSystemHealthStatus.useSubscription(queryInput, { onData(data) { utils.widget.healthMonitoring.getSystemHealthStatus.setData(queryInput, (oldData) => @@ -52,6 +47,11 @@ export default function SystemResources({ integrationIds, options }: WidgetCompo }, }); + const lastItem = data.at(-1); + + if (!lastItem) return null; + const { fileSystem, smart } = lastItem.healthInfo; + if (fileSystem.length === 0) { throw new NoIntegrationDataError(); } From 94cbbde5767746a356fbabe190b060b5fc1f9e21 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Thu, 28 May 2026 18:06:07 +0200 Subject: [PATCH 06/18] fix(widgets): prevent NoIntegrationDataError during initial load and scope indicator - Add isFetched guard in media-requests/list to avoid throwing before data loads - Scope refresh indicator to only track widget and integration queries --- packages/widgets/src/media-requests/list/component.tsx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/widgets/src/media-requests/list/component.tsx b/packages/widgets/src/media-requests/list/component.tsx index b2320f426..0a40ac72e 100644 --- a/packages/widgets/src/media-requests/list/component.tsx +++ b/packages/widgets/src/media-requests/list/component.tsx @@ -19,7 +19,7 @@ export default function MediaServerWidget({ options, width, }: WidgetComponentProps<"mediaRequests-requestList">) { - const { data: mediaRequests = [] } = clientApi.widget.mediaRequests.getLatestRequests.useQuery( + const { data: mediaRequests = [], isFetched } = clientApi.widget.mediaRequests.getLatestRequests.useQuery( { integrationIds, }, @@ -58,6 +58,7 @@ export default function MediaServerWidget({ }, ); + if (!isFetched) return null; if (mediaRequests.length === 0) throw new NoIntegrationDataError(); return ( From 598307c7bfbefabb06ae0d005e823f62c1e3d5a3 Mon Sep 17 00:00:00 2001 From: ajnart <49837342+ajnart@users.noreply.github.com> Date: Thu, 28 May 2026 16:08:04 +0000 Subject: [PATCH 07/18] style: auto-fix lint and format --- .../src/components/layout/header/query-refresh-indicator.tsx | 4 +--- packages/widgets/src/bookmarks/component.tsx | 2 +- packages/widgets/src/health-monitoring/system-health.tsx | 2 +- packages/widgets/src/media-requests/list/component.tsx | 2 +- packages/widgets/src/releases/component.tsx | 2 +- packages/widgets/src/rssFeed/component.tsx | 2 +- packages/widgets/src/umami/umami-content.tsx | 2 +- packages/widgets/src/umami/umami-events-content.tsx | 4 ++-- 8 files changed, 9 insertions(+), 11 deletions(-) diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx index 3c9188a9b..0ed917fd6 100644 --- a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx +++ b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx @@ -169,9 +169,7 @@ export const QueryRefreshIndicator = () => { }; const QueryMenuItem = ({ row }: { row: QueryStatusRow }) => { - const rowColor = statusColorMap[ - row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}` - ] ?? "gray"; + const rowColor = statusColorMap[row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}`] ?? "gray"; const updatedLabel = row.dataUpdatedAt > 0 ? dayjs(row.dataUpdatedAt).fromNow() : "never"; diff --git a/packages/widgets/src/bookmarks/component.tsx b/packages/widgets/src/bookmarks/component.tsx index a6b8853ad..c74e57744 100644 --- a/packages/widgets/src/bookmarks/component.tsx +++ b/packages/widgets/src/bookmarks/component.tsx @@ -16,7 +16,7 @@ export default function BookmarksWidget({ options, itemId }: WidgetComponentProp const board = useRequiredBoard(); const { data = [] } = clientApi.app.byIds.useQuery(options.items, { select(data) { - return data.sort((appA, appB) => options.items.indexOf(appA.id) - options.items.indexOf(appB.id)); + return data.toSorted((appA, appB) => options.items.indexOf(appA.id) - options.items.indexOf(appB.id)); }, }); diff --git a/packages/widgets/src/health-monitoring/system-health.tsx b/packages/widgets/src/health-monitoring/system-health.tsx index 4a66b61ac..c26f63254 100644 --- a/packages/widgets/src/health-monitoring/system-health.tsx +++ b/packages/widgets/src/health-monitoring/system-health.tsx @@ -332,5 +332,5 @@ export const matchFileSystemAndSmart = (fileSystems: FileSystem[], smartData: Sm overallStatus: smartDisk?.overallStatus ?? "", }; }) - .sort((fileSystemA, fileSystemB) => fileSystemA.deviceName.localeCompare(fileSystemB.deviceName)); + .toSorted((fileSystemA, fileSystemB) => fileSystemA.deviceName.localeCompare(fileSystemB.deviceName)); }; diff --git a/packages/widgets/src/media-requests/list/component.tsx b/packages/widgets/src/media-requests/list/component.tsx index 0a40ac72e..528f29fdd 100644 --- a/packages/widgets/src/media-requests/list/component.tsx +++ b/packages/widgets/src/media-requests/list/component.tsx @@ -43,7 +43,7 @@ export default function MediaServerWidget({ const newData = filteredData.concat( data.requests.map((request) => ({ ...request, integrationId: data.integrationId })), ); - return newData.sort((dataA, dataB) => { + return newData.toSorted((dataA, dataB) => { if (dataA.status === dataB.status) { return dataB.createdAt.getTime() - dataA.createdAt.getTime(); } diff --git a/packages/widgets/src/releases/component.tsx b/packages/widgets/src/releases/component.tsx index 56e482a45..cc41e8b68 100644 --- a/packages/widgets/src/releases/component.tsx +++ b/packages/widgets/src/releases/component.tsx @@ -126,7 +126,7 @@ export default function ReleasesWidget({ options }: WidgetComponentProps<"releas (repository) => "error" in repository || !options.showOnlyHighlighted || repository.isNewRelease || repository.isStaleRelease, ) - .sort((repoA, repoB) => { + .toSorted((repoA, repoB) => { if ("error" in repoA) return -1; if ("error" in repoB) return 1; return repoA.latestReleaseAt > repoB.latestReleaseAt ? -1 : 1; diff --git a/packages/widgets/src/rssFeed/component.tsx b/packages/widgets/src/rssFeed/component.tsx index 008e06c7d..49cf807ea 100644 --- a/packages/widgets/src/rssFeed/component.tsx +++ b/packages/widgets/src/rssFeed/component.tsx @@ -26,7 +26,7 @@ const useLiveFeedEntries = (input: RouterInputs["widget"]["rssFeed"]["getFeeds"] return oldData ?.filter((entry) => entry.feedUrl !== updatedData.url) .concat(updatedData.entries) - .sort((entryA, entryB) => { + .toSorted((entryA, entryB) => { return entryA.published && entryB.published ? new Date(entryB.published).getTime() - new Date(entryA.published).getTime() : 0; diff --git a/packages/widgets/src/umami/umami-content.tsx b/packages/widgets/src/umami/umami-content.tsx index 9121609ed..e6dd90a8f 100644 --- a/packages/widgets/src/umami/umami-content.tsx +++ b/packages/widgets/src/umami/umami-content.tsx @@ -57,7 +57,7 @@ export function UmamiContent({ }); const { data: multiEventSeries } = clientApi.widget.umami.getMultiEventTimeSeries.useQuery( - { integrationId: integrationIds[0] ?? "", websiteId, timeFrame, eventNames: [...eventNames].sort() }, + { integrationId: integrationIds[0] ?? "", websiteId, timeFrame, eventNames: [...eventNames].toSorted() }, { enabled: viewMode === "events" && eventNames.length > 0 }, ); diff --git a/packages/widgets/src/umami/umami-events-content.tsx b/packages/widgets/src/umami/umami-events-content.tsx index c6d1acedd..6dfac617c 100644 --- a/packages/widgets/src/umami/umami-events-content.tsx +++ b/packages/widgets/src/umami/umami-events-content.tsx @@ -32,7 +32,7 @@ export function UmamiEventsContent({ integrationId: integrationIds[0] ?? "", websiteId, timeFrame, - eventNames: [...eventNames].sort(), + eventNames: [...eventNames].toSorted(), }); if (eventNames.length === 0) { @@ -48,7 +48,7 @@ export function UmamiEventsContent({ // Collect all unique timestamps across all series const allTimestamps = Array.from( new Set(series.flatMap(({ dataPoints }) => dataPoints.map(({ x: xPoint }) => xPoint))), - ).sort(); + ).toSorted(); // Build per-event lookup by timestamp string const byEvent = new Map( From b65eef08eaf0dcab46271d3894975502fbf344a4 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 29 May 2026 17:25:38 +0200 Subject: [PATCH 08/18] feat(api): add Redis-backed query cache persistence layer Add tRPC router (queryCache.getItem/setItem/removeItem) for persisting TanStack Query cache entries to Redis, scoped per user and board. Includes isPersistableWidgetQueryKey filter that excludes widget.app.ping, and comprehensive tests covering access control, TTL expiry, and size limits. --- packages/api/package.json | 1 + packages/api/src/query-cache.ts | 33 ++++ packages/api/src/root.ts | 1 + packages/api/src/router/query-cache.ts | 54 +++++++ packages/api/src/test/query-cache.spec.ts | 187 ++++++++++++++++++++++ 5 files changed, 276 insertions(+) create mode 100644 packages/api/src/query-cache.ts create mode 100644 packages/api/src/router/query-cache.ts create mode 100644 packages/api/src/test/query-cache.spec.ts diff --git a/packages/api/package.json b/packages/api/package.json index 847279d59..86ed8f1dd 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -9,6 +9,7 @@ "exports": { ".": "./src/index.ts", "./client": "./src/client.ts", + "./query-cache": "./src/query-cache.ts", "./server": "./src/server.ts", "./websocket": "./src/websocket.ts", "./shared": "./src/shared.ts", diff --git a/packages/api/src/query-cache.ts b/packages/api/src/query-cache.ts new file mode 100644 index 000000000..d6e19f618 --- /dev/null +++ b/packages/api/src/query-cache.ts @@ -0,0 +1,33 @@ +import type { QueryKey } from "@tanstack/react-query"; + +export const queryCacheMaxAgeMs = 1000 * 60 * 60 * 24; +export const queryCacheMaxValueBytes = 1024 * 1024; +export const queryCacheStoragePrefix = "homarr-widget-query"; + +let activeQueryCacheBoardId: string | null = null; + +export const setActiveQueryCacheBoardId = (boardId: string | null) => { + activeQueryCacheBoardId = boardId; +}; + +export const getActiveQueryCacheBoardId = () => activeQueryCacheBoardId; + +const persistableQueryPaths = new Set(["app.byId", "app.byIds", "docker.getContainers", "integration.byIds"]); +const excludedWidgetPaths = new Set(["widget.app.ping"]); + +const getTrpcPathFromQueryKey = (queryKey: QueryKey) => { + const first = queryKey[0]; + if (!Array.isArray(first)) return null; + + const parts = first.filter((part): part is string => typeof part === "string"); + return parts.length > 0 ? parts : null; +}; + +export const isPersistableWidgetQueryKey = (queryKey: QueryKey) => { + const path = getTrpcPathFromQueryKey(queryKey); + if (!path) return false; + + if (path[0] === "widget") return !excludedWidgetPaths.has(path.join(".")); + + return persistableQueryPaths.has(path.join(".")); +}; diff --git a/packages/api/src/root.ts b/packages/api/src/root.ts index a014b4b75..2c785e6ff 100644 --- a/packages/api/src/root.ts +++ b/packages/api/src/root.ts @@ -24,6 +24,7 @@ export const appRouter = createTRPCRouter({ cronJobs: lazy(() => import("./router/cron-jobs").then((mod) => mod.cronJobsRouter)), apiKeys: lazy(() => import("./router/apiKeys").then((mod) => mod.apiKeysRouter)), media: lazy(() => import("./router/medias/media-router").then((mod) => mod.mediaRouter)), + queryCache: lazy(() => import("./router/query-cache").then((mod) => mod.queryCacheRouter)), updateChecker: lazy(() => import("./router/update-checker").then((mod) => mod.updateCheckerRouter)), certificates: lazy(() => import("./router/certificates/certificate-router").then((mod) => mod.certificateRouter)), bangs: lazy(() => import("./router/bangs/bangs-router").then((mod) => mod.bangsRouter)), diff --git a/packages/api/src/router/query-cache.ts b/packages/api/src/router/query-cache.ts new file mode 100644 index 000000000..d79de2711 --- /dev/null +++ b/packages/api/src/router/query-cache.ts @@ -0,0 +1,54 @@ +import { z } from "zod/v4"; + +import { eq } from "@homarr/db"; +import { boards } from "@homarr/db/schema"; +import { createQueryCacheChannel } from "@homarr/redis"; + +import { queryCacheMaxAgeMs, queryCacheMaxValueBytes } from "../query-cache"; +import { createTRPCRouter, publicProcedure } from "../trpc"; +import { throwIfActionForbiddenAsync } from "./board/board-access"; + +const queryCacheKeyInput = z.object({ + boardId: z.string().min(1), + key: z.string().min(1).max(4096), +}); + +const queryCacheSetInput = queryCacheKeyInput.extend({ + value: z.string().max(queryCacheMaxValueBytes * 2), +}); + +const createChannel = (input: z.infer, userId: string) => + createQueryCacheChannel({ + userId, + boardId: input.boardId, + key: input.key, + ttlMs: queryCacheMaxAgeMs, + maxValueBytes: queryCacheMaxValueBytes, + }); + +const validateBoardAccessAsync = async (ctx: Parameters[0], boardId: string) => { + await throwIfActionForbiddenAsync(ctx, eq(boards.id, boardId), "view"); +}; + +export const queryCacheRouter = createTRPCRouter({ + getItem: publicProcedure.input(queryCacheKeyInput).query(async ({ ctx, input }) => { + await validateBoardAccessAsync(ctx, input.boardId); + + const channel = createChannel(input, ctx.session?.user.id ?? "anonymous"); + return await channel.getAsync(); + }), + setItem: publicProcedure.input(queryCacheSetInput).mutation(async ({ ctx, input }) => { + await validateBoardAccessAsync(ctx, input.boardId); + + const channel = createChannel(input, ctx.session?.user.id ?? "anonymous"); + return { + stored: await channel.setAsync(input.value), + }; + }), + removeItem: publicProcedure.input(queryCacheKeyInput).mutation(async ({ ctx, input }) => { + await validateBoardAccessAsync(ctx, input.boardId); + + const channel = createChannel(input, ctx.session?.user.id ?? "anonymous"); + await channel.removeAsync(); + }), +}); diff --git a/packages/api/src/test/query-cache.spec.ts b/packages/api/src/test/query-cache.spec.ts new file mode 100644 index 000000000..aba9fbf42 --- /dev/null +++ b/packages/api/src/test/query-cache.spec.ts @@ -0,0 +1,187 @@ +import { afterEach, describe, expect, test, vi } from "vitest"; + +import type { Session } from "@homarr/auth"; +import { createId } from "@homarr/common"; +import type { Database } from "@homarr/db"; +import { boards, users } from "@homarr/db/schema"; +import { createDb } from "@homarr/db/test"; +import { isPersistableWidgetQueryKey, queryCacheMaxAgeMs, queryCacheMaxValueBytes } from "@homarr/api/query-cache"; + +import { queryCacheRouter } from "../router/query-cache"; + +const redisMock = vi.hoisted(() => { + const values = new Map(); + const calls: { + userId: string; + boardId: string; + key: string; + ttlMs: number; + maxValueBytes: number; + }[] = []; + + return { + values, + calls, + createQueryCacheChannel: vi.fn( + (options: { userId: string; boardId: string; key: string; ttlMs: number; maxValueBytes: number }) => { + calls.push(options); + const storageKey = `${options.userId}:${options.boardId}:${options.key}`; + + return { + getAsync: async () => { + const item = values.get(storageKey); + if (!item) return null; + if (Date.now() > item.expiresAt) { + values.delete(storageKey); + return null; + } + + return item.value; + }, + setAsync: async (value: string) => { + if (Buffer.byteLength(value, "utf8") > options.maxValueBytes) { + return false; + } + + values.set(storageKey, { value, expiresAt: Date.now() + options.ttlMs }); + return true; + }, + removeAsync: async () => { + values.delete(storageKey); + }, + }; + }, + ), + }; +}); + +vi.mock("@homarr/redis", () => ({ + createQueryCacheChannel: redisMock.createQueryCacheChannel, +})); + +vi.mock("@homarr/auth", () => ({ auth: () => ({}) as Session })); + +afterEach(() => { + vi.useRealTimers(); + redisMock.values.clear(); + redisMock.calls.length = 0; + redisMock.createQueryCacheChannel.mockClear(); +}); + +const createSession = (userId = createId()): Session => ({ + user: { + id: userId, + permissions: [], + colorScheme: "light", + }, + expires: new Date().toISOString(), +}); + +const insertUserAsync = async (db: Database, id: string) => { + await db.insert(users).values({ id }); +}; + +describe("isPersistableWidgetQueryKey", () => { + test.each([ + [[["widget", "calendar", "findAllEvents"], { type: "query" }], true], + [[["app", "byId"], { type: "query" }], true], + [[["app", "byIds"], { type: "query" }], true], + [[["docker", "getContainers"], { type: "query" }], true], + [[["integration", "byIds"], { type: "query" }], true], + [[["widget", "app", "ping"], { type: "query", input: { id: "abc" } }], false], + [[["app", "selectable"], { type: "query" }], false], + [[["board", "getBoardByName"], { type: "query" }], false], + [["widget"], false], + ])("matches persist filter for %j", (queryKey, expected) => { + expect(isPersistableWidgetQueryKey(queryKey)).toBe(expected); + }); +}); + +describe("queryCacheRouter", () => { + test("stores, reads, and removes data for a board viewer", async () => { + const db = createDb(); + const session = createSession(); + await insertUserAsync(db, session.user.id); + await db.insert(boards).values({ id: "board-1", name: "board", creatorId: session.user.id, isPublic: false }); + + const caller = queryCacheRouter.createCaller({ db, deviceType: undefined, session }); + + await expect(caller.setItem({ boardId: "board-1", key: "query-key", value: "cached-value" })).resolves.toEqual({ + stored: true, + }); + await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).resolves.toBe("cached-value"); + + await caller.removeItem({ boardId: "board-1", key: "query-key" }); + + await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).resolves.toBeNull(); + }); + + test("does not touch Redis when board access is denied", async () => { + const db = createDb(); + await insertUserAsync(db, "owner"); + await db.insert(boards).values({ id: "board-1", name: "board", creatorId: "owner", isPublic: false }); + + redisMock.createQueryCacheChannel.mockClear(); + const caller = queryCacheRouter.createCaller({ db, deviceType: undefined, session: createSession("other-user") }); + + await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).rejects.toThrow("Board not found"); + expect(redisMock.createQueryCacheChannel).not.toHaveBeenCalled(); + }); + + test("scopes anonymous public-board cache entries by anonymous user and board", async () => { + const db = createDb(); + await insertUserAsync(db, "owner"); + await db.insert(boards).values({ id: "board-1", name: "board", creatorId: "owner", isPublic: true }); + + const caller = queryCacheRouter.createCaller({ db, deviceType: undefined, session: null }); + + await caller.setItem({ boardId: "board-1", key: "query-key", value: "cached-value" }); + + expect(redisMock.calls.at(-1)).toMatchObject({ + userId: "anonymous", + boardId: "board-1", + key: "query-key", + ttlMs: queryCacheMaxAgeMs, + maxValueBytes: queryCacheMaxValueBytes, + }); + }); + + test("scopes signed-in cache entries by user and rejects oversized values", async () => { + const db = createDb(); + const session = createSession("user-1"); + await insertUserAsync(db, session.user.id); + await db.insert(boards).values({ id: "board-1", name: "board", creatorId: session.user.id, isPublic: false }); + + const caller = queryCacheRouter.createCaller({ db, deviceType: undefined, session }); + const value = "x".repeat(queryCacheMaxValueBytes + 1); + + await expect(caller.setItem({ boardId: "board-1", key: "query-key", value })).resolves.toEqual({ + stored: false, + }); + expect(redisMock.calls.at(-1)).toMatchObject({ + userId: "user-1", + boardId: "board-1", + ttlMs: queryCacheMaxAgeMs, + maxValueBytes: queryCacheMaxValueBytes, + }); + }); + + test("expires values through the Redis TTL path", async () => { + vi.useFakeTimers(); + vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z")); + + const db = createDb(); + const session = createSession("user-1"); + await insertUserAsync(db, session.user.id); + await db.insert(boards).values({ id: "board-1", name: "board", creatorId: session.user.id, isPublic: false }); + + const caller = queryCacheRouter.createCaller({ db, deviceType: undefined, session }); + + await caller.setItem({ boardId: "board-1", key: "query-key", value: "cached-value" }); + await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).resolves.toBe("cached-value"); + + await vi.advanceTimersByTimeAsync(queryCacheMaxAgeMs + 1); + + await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).resolves.toBeNull(); + }); +}); From 6c623a3a2de228f555fe450fc6e11542bd942bc6 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 29 May 2026 17:25:46 +0200 Subject: [PATCH 09/18] feat(redis): migrate query cache to Hash storage for bulk SSR reads Replace individual Redis keys (queryCache:sha256(...)) with a Hash per user+board (qc:{userId}:{boardId}). This enables HGETALL to read all cached entries in a single call for server-side hydration. Remove unused SHA256 hashKey function and createHash import. --- packages/redis/src/index.ts | 2 ++ packages/redis/src/lib/channel.ts | 43 +++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) diff --git a/packages/redis/src/index.ts b/packages/redis/src/index.ts index f8d8fd329..8e6e3db86 100644 --- a/packages/redis/src/index.ts +++ b/packages/redis/src/index.ts @@ -13,6 +13,8 @@ export { handshakeAsync, createSubPubChannel, createGetSetChannel, + createQueryCacheChannel, + getAllQueryCacheAsync, } from "./lib/channel"; export { createIntegrationHistoryChannel } from "./lib/channels/history-channel"; diff --git a/packages/redis/src/lib/channel.ts b/packages/redis/src/lib/channel.ts index 193f551e3..03025565e 100644 --- a/packages/redis/src/lib/channel.ts +++ b/packages/redis/src/lib/channel.ts @@ -125,6 +125,49 @@ export const createGetSetChannel = (name: string) => { }; }; +interface QueryCacheChannelOptions { + userId: string; + boardId: string; + key: string; + ttlMs: number; + maxValueBytes: number; +} + +const queryCacheHashKey = (userId: string, boardId: string) => `qc:${userId}:${boardId}`; + +export const createQueryCacheChannel = ({ userId, boardId, key, ttlMs, maxValueBytes }: QueryCacheChannelOptions) => { + const hkey = queryCacheHashKey(userId, boardId); + + return { + name: `${hkey}:${key}`, + getAsync: async () => { + return await getSetClient.hget(hkey, key); + }, + setAsync: async (value: string) => { + if (Buffer.byteLength(value, "utf8") > maxValueBytes) { + logger.warn("Query cache value exceeded maximum size", { + channel: hkey, + valueBytes: Buffer.byteLength(value, "utf8"), + maxValueBytes, + }); + return false; + } + + await getSetClient.hset(hkey, key, value); + await getSetClient.pexpire(hkey, ttlMs); + return true; + }, + removeAsync: async () => { + await getSetClient.hdel(hkey, key); + }, + }; +}; + +export const getAllQueryCacheAsync = async (userId: string, boardId: string): Promise> => { + const hkey = queryCacheHashKey(userId, boardId); + return await getSetClient.hgetall(hkey); +}; + /** * Creates a new cache channel. * @param name name of the channel From f7f6d1e382e39a28afc2e45baaf61159b6b22cc0 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 29 May 2026 17:25:53 +0200 Subject: [PATCH 10/18] feat(boards): wire board cache scope for query persistence Call setActiveQueryCacheBoardId when board context initializes so the client-side persister knows which board to scope cache reads/writes to. --- packages/boards/src/context.tsx | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/packages/boards/src/context.tsx b/packages/boards/src/context.tsx index a099f64c7..24642b58d 100644 --- a/packages/boards/src/context.tsx +++ b/packages/boards/src/context.tsx @@ -6,6 +6,7 @@ import { usePathname } from "next/navigation"; import type { RouterOutputs } from "@homarr/api"; import { clientApi } from "@homarr/api/client"; +import { getActiveQueryCacheBoardId, setActiveQueryCacheBoardId } from "@homarr/api/query-cache"; import { updateBoardName } from "./updater"; @@ -28,6 +29,8 @@ export const BoardProvider = ({ }, ); + setActiveQueryCacheBoardId(data.id); + // Update the board name so it can be used within updateBoard method updateBoardName(initialBoard.name); @@ -42,6 +45,16 @@ export const BoardProvider = ({ }; }, [pathname, utils, initialBoard.name]); + useEffect(() => { + setActiveQueryCacheBoardId(data.id); + + return () => { + if (getActiveQueryCacheBoardId() === data.id) { + setActiveQueryCacheBoardId(null); + } + }; + }, [data.id]); + return ( Date: Fri, 29 May 2026 17:26:05 +0200 Subject: [PATCH 11/18] refactor(widgets): stabilize widget components after useQuery migration Add WidgetEmptyState component for widgets that need a loading fallback. Disable refetch-on-mount/focus/reconnect and retry for integration widgets so cached data is preserved. Ensure hooks are never called conditionally. --- packages/widgets/src/anchor-note/component.tsx | 3 ++- packages/widgets/src/app/component.tsx | 7 ++++--- packages/widgets/src/app/ping/ping-indicator.tsx | 6 ++++-- packages/widgets/src/common/empty-state.tsx | 15 +++++++++++++++ .../health-monitoring/cluster/cluster-health.tsx | 3 ++- .../src/health-monitoring/system-health.tsx | 3 +++ .../src/immich/album-carousel/component.tsx | 3 ++- .../widgets/src/immich/server-stats/component.tsx | 3 ++- .../widgets/src/media-requests/list/component.tsx | 5 +++-- .../src/media-requests/stats/component.tsx | 3 ++- .../widgets/src/media-transcoding/component.tsx | 3 ++- .../src/minecraft/server-status/component.tsx | 3 ++- .../widgets/src/speedtest-tracker/component.tsx | 2 ++ packages/widgets/src/stocks/component.tsx | 3 ++- packages/widgets/src/system-disks/component.tsx | 3 ++- .../src/system-resources/chart/common-chart.tsx | 11 ++++++++--- packages/widgets/src/weather/component.tsx | 3 ++- 17 files changed, 59 insertions(+), 20 deletions(-) create mode 100644 packages/widgets/src/common/empty-state.tsx diff --git a/packages/widgets/src/anchor-note/component.tsx b/packages/widgets/src/anchor-note/component.tsx index 220c2983a..6a2718505 100644 --- a/packages/widgets/src/anchor-note/component.tsx +++ b/packages/widgets/src/anchor-note/component.tsx @@ -14,6 +14,7 @@ import { useTimeAgo } from "@homarr/common"; import type { AnchorNotePermission } from "@homarr/integrations"; import { useScopedI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../common/empty-state"; import type { WidgetComponentProps } from "../definition"; import "react-quill-new/dist/quill.snow.css"; @@ -264,7 +265,7 @@ const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteW ); }, [canEdit, draftContent, draftTitle, hasChanges, integrationId, note, noteId, refetch, t, updateNoteAsync]); - if (!note) return null; + if (!note) return ; return ( diff --git a/packages/widgets/src/app/component.tsx b/packages/widgets/src/app/component.tsx index b2654b6eb..05a306db3 100644 --- a/packages/widgets/src/app/component.tsx +++ b/packages/widgets/src/app/component.tsx @@ -3,7 +3,7 @@ import type { PropsWithChildren } from "react"; import { Fragment, Suspense } from "react"; import { Flex, rem, Stack, Text, Tooltip, UnstyledButton } from "@mantine/core"; -import { IconLoader } from "@tabler/icons-react"; +import { IconMinus } from "@tabler/icons-react"; import combineClasses from "clsx"; import { clientApi } from "@homarr/api/client"; @@ -13,6 +13,7 @@ import { useRegisterSpotlightContextResults } from "@homarr/spotlight"; import { useI18n } from "@homarr/translation/client"; import { MaskedOrNormalImage } from "@homarr/ui"; +import { WidgetEmptyState } from "../common/empty-state"; import type { WidgetComponentProps } from "../definition"; import classes from "./app.module.css"; import { PingDot } from "./ping/ping-dot"; @@ -55,7 +56,7 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget [app, options.openInNewTab], ); - if (!app) return null; + if (!app) return ; const isTiny = height < 100 || width < 100; const isColumnLayout = options.layout.startsWith("column"); @@ -131,7 +132,7 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget {options.pingEnabled && !settings.forceDisableStatus && !board.disableStatus && app.href ? ( - }> + }> ) : null} diff --git a/packages/widgets/src/app/ping/ping-indicator.tsx b/packages/widgets/src/app/ping/ping-indicator.tsx index 4ec836ca8..b8f88cdc8 100644 --- a/packages/widgets/src/app/ping/ping-indicator.tsx +++ b/packages/widgets/src/app/ping/ping-indicator.tsx @@ -1,6 +1,7 @@ -import { IconCheck, IconX } from "@tabler/icons-react"; +import { IconCheck, IconMinus, IconX } from "@tabler/icons-react"; import { clientApi } from "@homarr/api/client"; +import { useI18n } from "@homarr/translation/client"; import { PingDot } from "./ping-dot"; @@ -9,6 +10,7 @@ interface PingIndicatorProps { } export const PingIndicator = ({ appId }: PingIndicatorProps) => { + const t = useI18n(); const { data: pingResult } = clientApi.widget.app.ping.useQuery( { id: appId }, { refetchOnMount: false, refetchOnWindowFocus: false }, @@ -24,7 +26,7 @@ export const PingIndicator = ({ appId }: PingIndicatorProps) => { }, ); - if (!pingResult) return null; + if (!pingResult) return ; const isError = "error" in pingResult || pingResult.statusCode >= 500; diff --git a/packages/widgets/src/common/empty-state.tsx b/packages/widgets/src/common/empty-state.tsx new file mode 100644 index 000000000..f5747b35c --- /dev/null +++ b/packages/widgets/src/common/empty-state.tsx @@ -0,0 +1,15 @@ +import { Center, Text } from "@mantine/core"; + +import { useI18n } from "@homarr/translation/client"; + +export const WidgetEmptyState = () => { + const t = useI18n(); + + return ( +
+ + {t("widget.common.error.noData")} + +
+ ); +}; diff --git a/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx b/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx index 9f9d2a1bd..d8fa10614 100644 --- a/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx +++ b/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx @@ -5,6 +5,7 @@ import { clientApi } from "@homarr/api/client"; import type { Resource } from "@homarr/integrations/types"; import { useI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; import { formatUptime } from "../system-health"; import { ResourceAccordionItem } from "./resource-accordion-item"; @@ -56,7 +57,7 @@ export const ClusterHealthMonitoring = ({ }, ); - if (!healthData) return null; + if (!healthData) return ; const activeNodes = healthData.nodes.reduce(running, 0); const activeVMs = healthData.vms.reduce(running, 0); diff --git a/packages/widgets/src/health-monitoring/system-health.tsx b/packages/widgets/src/health-monitoring/system-health.tsx index c26f63254..9c5260ff0 100644 --- a/packages/widgets/src/health-monitoring/system-health.tsx +++ b/packages/widgets/src/health-monitoring/system-health.tsx @@ -37,6 +37,7 @@ import type { TranslationFunction } from "@homarr/translation"; import { useI18n } from "@homarr/translation/client"; import type { WidgetComponentProps } from "../definition"; +import { WidgetEmptyState } from "../common/empty-state"; import { CpuRing } from "./rings/cpu-ring"; import { CpuTempRing } from "./rings/cpu-temp-ring"; import { GpuRing } from "./rings/gpu-ring"; @@ -86,6 +87,8 @@ export const SystemHealthMonitoring = ({ const isTiny = width < 256; + if (healthData.length === 0) return ; + return ( {healthData.map(({ integrationId, integrationName, healthInfo, updatedAt }) => { diff --git a/packages/widgets/src/immich/album-carousel/component.tsx b/packages/widgets/src/immich/album-carousel/component.tsx index cbaa44e07..9c157bfaa 100644 --- a/packages/widgets/src/immich/album-carousel/component.tsx +++ b/packages/widgets/src/immich/album-carousel/component.tsx @@ -8,6 +8,7 @@ import { IconAlertCircle, IconCalendar } from "@tabler/icons-react"; import { clientApi } from "@homarr/api/client"; import { useI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; import classes from "./component.module.css"; @@ -29,7 +30,7 @@ export default function ImmichAlbumCarouselWidget({ return ; } - if (!album) return null; + if (!album) return ; if (album.assets.length === 0) { return ; diff --git a/packages/widgets/src/immich/server-stats/component.tsx b/packages/widgets/src/immich/server-stats/component.tsx index 22346d376..919b0caf0 100644 --- a/packages/widgets/src/immich/server-stats/component.tsx +++ b/packages/widgets/src/immich/server-stats/component.tsx @@ -8,6 +8,7 @@ import { clientApi } from "@homarr/api/client"; import { humanFileSize } from "@homarr/common"; import { useI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; import classes from "./component.module.css"; @@ -20,7 +21,7 @@ export default function ImmichServerStatsWidget({ integrationId: integrationIds[0] ?? "", }); - if (!stats) return null; + if (!stats) return ; return ( diff --git a/packages/widgets/src/media-requests/list/component.tsx b/packages/widgets/src/media-requests/list/component.tsx index 528f29fdd..4c60b1dcf 100644 --- a/packages/widgets/src/media-requests/list/component.tsx +++ b/packages/widgets/src/media-requests/list/component.tsx @@ -10,6 +10,7 @@ import type { MediaRequestStatus } from "@homarr/integrations/types"; import { mediaAvailabilityConfiguration, mediaRequestStatusConfiguration } from "@homarr/integrations/types"; import { useScopedI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; import { NoIntegrationDataError } from "../../errors/no-data-integration"; @@ -19,7 +20,7 @@ export default function MediaServerWidget({ options, width, }: WidgetComponentProps<"mediaRequests-requestList">) { - const { data: mediaRequests = [], isFetched } = clientApi.widget.mediaRequests.getLatestRequests.useQuery( + const { data: mediaRequests } = clientApi.widget.mediaRequests.getLatestRequests.useQuery( { integrationIds, }, @@ -58,7 +59,7 @@ export default function MediaServerWidget({ }, ); - if (!isFetched) return null; + if (!mediaRequests) return ; if (mediaRequests.length === 0) throw new NoIntegrationDataError(); return ( diff --git a/packages/widgets/src/media-requests/stats/component.tsx b/packages/widgets/src/media-requests/stats/component.tsx index 2119457c4..5a6f425b3 100644 --- a/packages/widgets/src/media-requests/stats/component.tsx +++ b/packages/widgets/src/media-requests/stats/component.tsx @@ -19,6 +19,7 @@ import { useRequiredBoard } from "@homarr/boards/context"; import type { RequestStats } from "@homarr/integrations/types"; import { useScopedI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; import { NoIntegrationDataError } from "../../errors/no-data-integration"; import classes from "./component.module.css"; @@ -45,7 +46,7 @@ export default function MediaServerWidget({ const board = useRequiredBoard(); - if (!requestStats) return null; + if (!requestStats) return ; if (requestStats.users.length === 0 && requestStats.stats.length === 0) throw new NoIntegrationDataError(); const data = [ diff --git a/packages/widgets/src/media-transcoding/component.tsx b/packages/widgets/src/media-transcoding/component.tsx index 5ab18cd83..494cfd968 100644 --- a/packages/widgets/src/media-transcoding/component.tsx +++ b/packages/widgets/src/media-transcoding/component.tsx @@ -9,6 +9,7 @@ import { useI18n } from "@homarr/translation/client"; import type { TablerIcon } from "@homarr/ui"; import { views } from "."; +import { WidgetEmptyState } from "../common/empty-state"; import type { WidgetComponentProps } from "../definition"; import { HealthCheckStatus } from "./health-check-status"; import { QueuePanel } from "./panels/queue.panel"; @@ -53,7 +54,7 @@ export default function MediaTranscodingWidget({ const [view, setView] = useState(options.defaultView); const t = useI18n("widget.mediaTranscoding"); - if (!transcodingData) return null; + if (!transcodingData) return ; const totalQueuePages = Math.ceil((transcodingData.data.queue.totalCount || 1) / queuePageSize); const isTiny = width < 256; diff --git a/packages/widgets/src/minecraft/server-status/component.tsx b/packages/widgets/src/minecraft/server-status/component.tsx index 630fb049f..c57cd5314 100644 --- a/packages/widgets/src/minecraft/server-status/component.tsx +++ b/packages/widgets/src/minecraft/server-status/component.tsx @@ -7,6 +7,7 @@ import { clientApi } from "@homarr/api/client"; import { formatNumber } from "@homarr/common"; import { useScopedI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; export default function MinecraftServerStatusWidget({ options }: WidgetComponentProps<"minecraftServerStatus">) { @@ -22,7 +23,7 @@ export default function MinecraftServerStatusWidget({ options }: WidgetComponent }); const tStatus = useScopedI18n("widget.minecraftServerStatus.status"); - if (!result) return null; + if (!result) return ; const { data } = result; const title = options.title.trim().length > 0 ? options.title : options.domain; diff --git a/packages/widgets/src/speedtest-tracker/component.tsx b/packages/widgets/src/speedtest-tracker/component.tsx index 4c9a0e22e..b55143084 100644 --- a/packages/widgets/src/speedtest-tracker/component.tsx +++ b/packages/widgets/src/speedtest-tracker/component.tsx @@ -8,6 +8,7 @@ import type { SpeedtestTrackerDashboardData } from "@homarr/integrations/types"; import { useScopedI18n } from "@homarr/translation/client"; import type { WidgetComponentProps } from "../definition"; +import { WidgetEmptyState } from "../common/empty-state"; import { AveragesSection } from "./averages"; import { mergeStats } from "./helpers"; import { LatestResultSection } from "./latest-result"; @@ -86,6 +87,7 @@ export default function SpeedtestTrackerWidget({ {t("noSectionsEnabled")} )} + {!noSectionsEnabled && !hasStatSection && !hasChart && } ); } diff --git a/packages/widgets/src/stocks/component.tsx b/packages/widgets/src/stocks/component.tsx index f5e64259b..918851ce8 100644 --- a/packages/widgets/src/stocks/component.tsx +++ b/packages/widgets/src/stocks/component.tsx @@ -7,6 +7,7 @@ import { IconTrendingDown, IconTrendingUp } from "@tabler/icons-react"; import { clientApi } from "@homarr/api/client"; import { useScopedI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../common/empty-state"; import type { WidgetComponentProps } from "../definition"; function round(value: number) { @@ -26,7 +27,7 @@ export default function StockPriceWidget({ options, width, height }: WidgetCompo const theme = useMantineTheme(); const { data: result } = clientApi.widget.stockPrice.getPriceHistory.useQuery(options); - if (!result) return null; + if (!result) return ; const { data } = result; const stockValuesChange = round(calculateChange(data.priceHistory.at(-1) ?? 0, data.previousClose)); diff --git a/packages/widgets/src/system-disks/component.tsx b/packages/widgets/src/system-disks/component.tsx index 99ee275b4..36b20e275 100644 --- a/packages/widgets/src/system-disks/component.tsx +++ b/packages/widgets/src/system-disks/component.tsx @@ -7,6 +7,7 @@ import { useRequiredBoard } from "@homarr/boards/context"; import { humanFileSize } from "@homarr/common"; import { useI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../common/empty-state"; import type { WidgetComponentProps } from "../definition"; import { NoIntegrationDataError } from "../errors/no-data-integration"; @@ -49,7 +50,7 @@ export default function SystemResources({ integrationIds, options }: WidgetCompo const lastItem = data.at(-1); - if (!lastItem) return null; + if (!lastItem) return ; const { fileSystem, smart } = lastItem.healthInfo; if (fileSystem.length === 0) { diff --git a/packages/widgets/src/system-resources/chart/common-chart.tsx b/packages/widgets/src/system-resources/chart/common-chart.tsx index 2c25c8218..f2f9f1d87 100644 --- a/packages/widgets/src/system-resources/chart/common-chart.tsx +++ b/packages/widgets/src/system-resources/chart/common-chart.tsx @@ -2,7 +2,7 @@ import type { ReactNode } from "react"; import type { AreaChartSeries } from "@mantine/charts"; import { AreaChart, LineChart } from "@mantine/charts"; -import { Card, Center, Group, Loader, Stack, Text, useComputedColorScheme, useMantineTheme } from "@mantine/core"; +import { Card, Center, Group, Stack, Text, useComputedColorScheme, useMantineTheme } from "@mantine/core"; import { useElementSize, useHover, useMergedRef } from "@mantine/hooks"; import type { TooltipProps, YAxisProps } from "recharts"; @@ -85,8 +85,13 @@ export const CommonChart = ({ )} {data.length <= 1 ? (
- - 100 ? "md" : "xs"} color={"rgba(94, 94, 94, 1)"} /> + + {showIcon && 100 ? 20 : 14} stroke={1.5} />} + {showText && ( + 100 ? "md" : "xs"} fw={"bold"} ta="center"> + {title} + + )}
) : ( diff --git a/packages/widgets/src/weather/component.tsx b/packages/widgets/src/weather/component.tsx index 60de018f4..cd25ff3c1 100644 --- a/packages/widgets/src/weather/component.tsx +++ b/packages/widgets/src/weather/component.tsx @@ -10,6 +10,7 @@ import { clientApi } from "@homarr/api/client"; import { metricToImperial } from "@homarr/common"; import { useScopedI18n } from "@homarr/translation/client"; +import { WidgetEmptyState } from "../common/empty-state"; import type { WidgetComponentProps } from "../definition"; import { WeatherDescription, WeatherIcon } from "./icon"; @@ -29,7 +30,7 @@ export default function WeatherWidget({ isEditMode, options }: WidgetComponentPr onData: (data) => utils.widget.weather.atLocation.setData(input, data), }); - if (!weather) return null; + if (!weather) return ; return ( Date: Fri, 29 May 2026 17:26:15 +0200 Subject: [PATCH 12/18] fix(widgets): fix downloads widget and add SSR prefetch Remove WidgetEmptyState guard from downloads (widget renders fine with empty data). Fix columnsSort filter logic from .some() to .every() so non-sortable columns are correctly excluded. Add server-side prefetch via tRPC caller so download data is available immediately on page load. --- packages/widgets/src/downloads/component.tsx | 1 - packages/widgets/src/downloads/index.ts | 2 +- packages/widgets/src/downloads/prefetch.ts | 29 ++++++++++++++++++++ packages/widgets/src/prefetch.ts | 2 ++ 4 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 packages/widgets/src/downloads/prefetch.ts diff --git a/packages/widgets/src/downloads/component.tsx b/packages/widgets/src/downloads/component.tsx index 54a602507..e84544f92 100644 --- a/packages/widgets/src/downloads/component.tsx +++ b/packages/widgets/src/downloads/component.tsx @@ -101,7 +101,6 @@ export default function DownloadClientsWidget({ ); const utils = clientApi.useUtils(); - //Translations const t = useScopedI18n("widget.downloads"); const tCommon = useScopedI18n("common"); diff --git a/packages/widgets/src/downloads/index.ts b/packages/widgets/src/downloads/index.ts index c00044aa9..36979083b 100644 --- a/packages/widgets/src/downloads/index.ts +++ b/packages/widgets/src/downloads/index.ts @@ -28,7 +28,7 @@ const columnsList = [ ] as const satisfies (keyof ExtendedDownloadClientItem)[]; const sortingExclusion = ["actions", "id", "state"] as const satisfies readonly (typeof columnsList)[number][]; const columnsSort = columnsList.filter((column) => - sortingExclusion.some((exclusion) => exclusion !== column), + sortingExclusion.every((exclusion) => exclusion !== column), ) as Exclude; export const { definition, componentLoader } = createWidgetDefinition("downloads", { diff --git a/packages/widgets/src/downloads/prefetch.ts b/packages/widgets/src/downloads/prefetch.ts new file mode 100644 index 000000000..4eb073c43 --- /dev/null +++ b/packages/widgets/src/downloads/prefetch.ts @@ -0,0 +1,29 @@ +import { api, trpc } from "@homarr/api/server"; +import { createLogger } from "@homarr/core/infrastructure/logs"; + +import type { Prefetch } from "../definition"; + +const logger = createLogger({ module: "downloadsWidgetPrefetch" }); + +const prefetchAllAsync: Prefetch<"downloads"> = async (queryClient, items) => { + await Promise.all( + items.map(async (item) => { + if (item.integrationIds.length === 0) return; + + const input = { + integrationIds: item.integrationIds, + limitPerIntegration: Number(item.options.limitPerIntegration) || 50, + }; + + try { + const data = await api.widget.downloads.getJobsAndStatuses(input); + queryClient.setQueryData(trpc.widget.downloads.getJobsAndStatuses.queryKey(input), data); + logger.info("Prefetched downloads widget data", { integrations: item.integrationIds.length }); + } catch (error) { + logger.warn("Failed to prefetch downloads widget data", { error }); + } + }), + ); +}; + +export default prefetchAllAsync; diff --git a/packages/widgets/src/prefetch.ts b/packages/widgets/src/prefetch.ts index 590237cc9..c0e3d03c4 100644 --- a/packages/widgets/src/prefetch.ts +++ b/packages/widgets/src/prefetch.ts @@ -9,6 +9,7 @@ import { createSettings } from "@homarr/settings/creator"; import { reduceWidgetOptionsWithDefaultValues } from "."; import prefetchForApps from "./app/prefetch"; import prefetchForBookmarks from "./bookmarks/prefetch"; +import prefetchForDownloads from "./downloads/prefetch"; import type { Prefetch, WidgetOptionsRecordOf } from "./definition"; import type { inferOptionsFromCreator } from "./options"; @@ -19,6 +20,7 @@ const prefetchCallbacks: Partial<{ }> = { bookmarks: prefetchForBookmarks, app: prefetchForApps, + downloads: prefetchForDownloads, }; export const prefetchForKindAsync = async ( From 87798a97892ac544dfae35edb55359f261ab66bf Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 29 May 2026 17:26:28 +0200 Subject: [PATCH 13/18] feat(nextjs): stream cached query data from Redis during SSR Add QueryCacheHydration async server component inside that reads all persisted queries from Redis via HGETALL and streams a HydrationBoundary to the client. Builds DehydratedState directly with original dataUpdatedAt timestamps so fresh prefetch data is never overwritten by stale cache. Make client persister write-only (getItem returns null) since reads are handled server-side. --- apps/nextjs/package.json | 1 + .../query-cache-persister.ts | 50 +++++++++++++++++++ .../app/[locale]/_client-providers/trpc.tsx | 4 ++ .../[locale]/boards/(content)/_creator.tsx | 46 +++++++++++++++++ 4 files changed, 101 insertions(+) create mode 100644 apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts diff --git a/apps/nextjs/package.json b/apps/nextjs/package.json index ff5864f13..65d768875 100644 --- a/apps/nextjs/package.json +++ b/apps/nextjs/package.json @@ -56,6 +56,7 @@ "@mantine/modals": "catalog:", "@mantine/tiptap": "catalog:", "@tabler/icons-react": "catalog:", + "@tanstack/query-persist-client-core": "catalog:", "@tanstack/react-query": "catalog:", "@tanstack/react-query-devtools": "catalog:", "@tanstack/react-query-next-experimental": "catalog:", diff --git a/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts b/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts new file mode 100644 index 000000000..faeadbb56 --- /dev/null +++ b/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts @@ -0,0 +1,50 @@ +import type { AsyncStorage, PersistedQuery } from "@tanstack/query-persist-client-core"; +import { experimental_createQueryPersister } from "@tanstack/query-persist-client-core"; +import { parse, stringify } from "superjson"; + +import { fetchApi } from "@homarr/api/client"; +import { + getActiveQueryCacheBoardId, + isPersistableWidgetQueryKey, + queryCacheMaxAgeMs, + queryCacheStoragePrefix, +} from "@homarr/api/query-cache"; + +const queryCacheStorage = { + async getItem(_key) { + return null; + }, + async setItem(key, value) { + const boardId = getActiveQueryCacheBoardId(); + if (!boardId) return; + + try { + await fetchApi.queryCache.setItem.mutate({ boardId, key, value }); + } catch { + // Query persistence is best-effort; failed writes should not affect widget rendering. + } + }, + async removeItem(key) { + const boardId = getActiveQueryCacheBoardId(); + if (!boardId) return; + + try { + await fetchApi.queryCache.removeItem.mutate({ boardId, key }); + } catch { + // Query persistence is best-effort; failed removals should not affect widget rendering. + } + }, +} satisfies AsyncStorage; + +export const createWidgetQueryPersister = () => + experimental_createQueryPersister({ + storage: typeof window === "undefined" ? undefined : queryCacheStorage, + maxAge: queryCacheMaxAgeMs, + prefix: queryCacheStoragePrefix, + refetchOnRestore: true, + serialize: (query) => stringify(query), + deserialize: (value) => parse(value), + filters: { + predicate: (query) => isPersistableWidgetQueryKey(query.queryKey), + }, + }); diff --git a/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx b/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx index 0e36cb4a1..7601dac6d 100644 --- a/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx +++ b/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx @@ -22,6 +22,8 @@ import { clientApi } from "@homarr/api/client"; import { createHeadersCallbackForSource, getTrpcUrl } from "@homarr/api/shared"; import { env } from "@homarr/common/env"; +import { createWidgetQueryPersister } from "./query-cache-persister"; + const getWebSocketProtocol = () => { // window is not defined on server side if (typeof window === "undefined") { @@ -49,11 +51,13 @@ const wsClient = createWSClient({ }); export function TRPCReactProvider(props: PropsWithChildren) { + const [queryPersister] = useState(() => createWidgetQueryPersister()); const [queryClient] = useState( () => new QueryClient({ defaultOptions: { queries: { + persister: queryPersister.persisterFn, staleTime: 5 * 1000, }, }, diff --git a/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx b/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx index 3314dee3c..73235701e 100644 --- a/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx +++ b/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx @@ -1,11 +1,15 @@ import type { Metadata } from "next"; +import { Suspense } from "react"; import { TRPCError } from "@trpc/server"; // Placed here because gridstack styles are used for board content import "~/styles/gridstack.scss"; +import type { DehydratedState } from "@tanstack/react-query"; import { dehydrate, HydrationBoundary } from "@tanstack/react-query"; +import { parse } from "superjson"; +import { queryCacheMaxAgeMs } from "@homarr/api/query-cache"; import { getQueryClient } from "@homarr/api/server"; import { IntegrationProvider } from "@homarr/auth/client"; import { auth } from "@homarr/auth/next"; @@ -14,6 +18,7 @@ import { isNullOrWhitespace } from "@homarr/common"; import { createLogger } from "@homarr/core/infrastructure/logs"; import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error"; import type { WidgetKind } from "@homarr/definitions"; +import { getAllQueryCacheAsync } from "@homarr/redis"; import { getI18n } from "@homarr/translation/server"; import { prefetchForKindAsync } from "@homarr/widgets/prefetch"; @@ -71,9 +76,14 @@ export const createBoardContentPage = >( ), ]); + const userId = session?.user.id ?? "anonymous"; + return ( + + + @@ -107,3 +117,39 @@ export const createBoardContentPage = >( }, }; }; + +interface PersistedEntry { + state: { data: unknown; dataUpdatedAt: number; status: string }; + queryKey: unknown[]; + queryHash: string; +} + +async function QueryCacheHydration({ userId, boardId }: { userId: string; boardId: string }) { + try { + const entries = await getAllQueryCacheAsync(userId, boardId); + const now = Date.now(); + const queries: DehydratedState["queries"] = []; + + for (const serialized of Object.values(entries)) { + try { + const persisted = parse(serialized); + if (now - persisted.state.dataUpdatedAt > queryCacheMaxAgeMs) continue; + if (persisted.state.status !== "success") continue; + + queries.push({ + state: persisted.state as DehydratedState["queries"][number]["state"], + queryKey: persisted.queryKey, + queryHash: persisted.queryHash, + }); + } catch { + // skip malformed entries + } + } + + if (queries.length === 0) return null; + + return ; + } catch { + return null; + } +} From 201a4617291a3f7e878440233c161da1fe35845c Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 29 May 2026 17:26:36 +0200 Subject: [PATCH 14/18] feat(ui): rewrite query refresh indicator with integration icons Filter out widget.app.ping from the indicator. Show colored status dots (green/orange/red) per query alongside integration icons with name tooltips. Use lookup maps and resolver functions instead of ternaries. Display relative timestamps for last data update. --- .../layout/header/query-refresh-indicator.tsx | 169 ++++++++++-------- 1 file changed, 98 insertions(+), 71 deletions(-) diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx index 0ed917fd6..932005267 100644 --- a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx +++ b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx @@ -1,65 +1,92 @@ "use client"; import { forwardRef, useEffect, useState } from "react"; -import { Box, Indicator, Menu, ScrollArea, Text, UnstyledButton } from "@mantine/core"; +import { Avatar, Box, Group, Indicator, Menu, ScrollArea, Text, Tooltip, UnstyledButton } from "@mantine/core"; import { useQueryClient } from "@tanstack/react-query"; import dayjs from "dayjs"; import { useEditMode } from "@homarr/boards/edit-mode"; +import type { IntegrationKind } from "@homarr/definitions"; +import { getIconUrl } from "@homarr/definitions"; + +interface IntegrationInfo { + id: string; + kind: IntegrationKind; + name: string; +} interface QueryStatusRow { id: string; - section: string; procedure: string; + integrationIcons: { kind: IntegrationKind; name: string }[]; status: "pending" | "error" | "success"; fetchStatus: "fetching" | "paused" | "idle"; dataUpdatedAt: number; - isStale: boolean; } -const trackedQueryPrefixes = new Set(["widget", "integration"]); +const hiddenProcedures = new Set(["widget.app.ping"]); -const isTrackedQuery = (queryKey: readonly unknown[]): boolean => { +const isTrackedWidgetQuery = (queryKey: readonly unknown[]): boolean => { const first = queryKey[0]; - return Array.isArray(first) && first.length >= 1 && trackedQueryPrefixes.has(first[0] as string); -}; + if (!Array.isArray(first) || first.length < 2 || first[0] !== "widget") return false; -const sectionLabels: Record = { - widget: "Widgets", - integration: "Integrations", + const path = first.join("."); + return !hiddenProcedures.has(path); }; const capitalize = (s: string) => s.charAt(0).toUpperCase() + s.slice(1); -const parseQueryKey = (queryKey: readonly unknown[]): { section: string; procedure: string } => { - const first = queryKey[0]; - if (!Array.isArray(first)) return { section: "Other", procedure: String(first) }; +const parseWidgetQueryKey = (queryKey: readonly unknown[]): { procedure: string; integrationIds: string[] } => { + const first = queryKey[0] as string[]; + const procedure = first.slice(1).map(capitalize).join(" — "); - const parts = first.filter((s): s is string => typeof s === "string"); - const sectionKey = parts[0] ?? "other"; - const section = sectionLabels[sectionKey] ?? capitalize(sectionKey); + const second = queryKey[1] as { input?: Record } | undefined; + const integrationIds = Array.isArray(second?.input?.integrationIds) + ? (second.input.integrationIds as string[]) + : []; - const remaining = parts.slice(1); - const procedure = remaining.length > 0 ? remaining.map(capitalize).join(" — ") : sectionKey; - - return { section, procedure }; + return { procedure, integrationIds }; }; -const statusColorMap: Record = { +const statusColors: Record = { fetching: "orange", - idle_success: "green", - idle_error: "red", - idle_pending: "gray", + success: "green", + error: "red", + pending: "gray", +}; + +const resolveRowColor = (fetchStatus: string, status: string) => { + if (fetchStatus === "fetching") return statusColors.fetching!; + return statusColors[status] ?? "gray"; +}; + +const resolveDotColor = (fetchingCount: number, errorCount: number) => { + if (fetchingCount > 0) return statusColors.fetching!; + if (errorCount > 0) return statusColors.error!; + return statusColors.success!; }; interface CacheSnapshot { rows: QueryStatusRow[]; - widgetFetchingCount: number; + fetchingCount: number; errorCount: number; - staleCount: number; } -const emptyCacheSnapshot: CacheSnapshot = { rows: [], widgetFetchingCount: 0, errorCount: 0, staleCount: 0 }; +const emptyCacheSnapshot: CacheSnapshot = { rows: [], fetchingCount: 0, errorCount: 0 }; + +function resolveIntegrationMap(queryClient: ReturnType): Map { + const cache = queryClient.getQueryCache(); + const integrationQuery = cache.find({ queryKey: [["integration", "all"]] }); + + const map = new Map(); + const data = integrationQuery?.state.data as IntegrationInfo[] | undefined; + if (!data) return map; + + for (const integration of data) { + map.set(integration.id, integration); + } + return map; +} function useQueryCacheStatus() { const queryClient = useQueryClient(); @@ -68,29 +95,32 @@ function useQueryCacheStatus() { useEffect(() => { const update = () => { const cache = queryClient.getQueryCache(); - const queries = cache.findAll({ type: "active" }).filter((q) => isTrackedQuery(q.queryKey)); + const queries = cache.findAll({ type: "active" }).filter((q) => isTrackedWidgetQuery(q.queryKey)); + const integrationMap = resolveIntegrationMap(queryClient); let fetching = 0; let errors = 0; - let stale = 0; const nextRows: QueryStatusRow[] = queries.map((q) => { if (q.state.fetchStatus === "fetching") fetching++; if (q.state.status === "error") errors++; - const isQueryStale = q.isStale(); - if (isQueryStale) stale++; - const { section, procedure } = parseQueryKey(q.queryKey); + const { procedure, integrationIds } = parseWidgetQueryKey(q.queryKey); + + const integrationIcons = integrationIds + .map((id) => integrationMap.get(id)) + .filter((info): info is IntegrationInfo => info !== undefined) + .map(({ kind, name }) => ({ kind, name })); + return { id: q.queryHash, - section, procedure, + integrationIcons, status: q.state.status, fetchStatus: q.state.fetchStatus, dataUpdatedAt: q.state.dataUpdatedAt, - isStale: isQueryStale, }; }); - setSnapshot({ rows: nextRows, widgetFetchingCount: fetching, errorCount: errors, staleCount: stale }); + setSnapshot({ rows: nextRows, fetchingCount: fetching, errorCount: errors }); }; update(); @@ -113,19 +143,6 @@ function useQueryCacheStatus() { return { ...snapshot, totalCount: snapshot.rows.length }; } -function groupBySection(rows: QueryStatusRow[]): Map { - const groups = new Map(); - for (const row of rows) { - const existing = groups.get(row.section); - if (existing) { - existing.push(row); - } else { - groups.set(row.section, [row]); - } - } - return groups; -} - const StatusDot = forwardRef( ({ color, processing, ...others }, ref) => ( @@ -138,29 +155,22 @@ const StatusDot = forwardRef { const [isEditMode] = useEditMode(); - const { rows, widgetFetchingCount, errorCount, totalCount } = useQueryCacheStatus(); + const { rows, fetchingCount, errorCount, totalCount } = useQueryCacheStatus(); if (isEditMode || totalCount === 0) return null; - const isFetching = widgetFetchingCount > 0; - const color = isFetching ? "orange" : errorCount > 0 ? "red" : "green"; - const grouped = groupBySection(rows); + const isFetching = fetchingCount > 0; + const dotColor = resolveDotColor(fetchingCount, errorCount); return ( - + - + - {Array.from(grouped).map(([section, sectionRows], i) => ( -
- {i > 0 && } - {section} - {sectionRows.map((row) => ( - - ))} -
+ {rows.map((row) => ( + ))}
@@ -168,22 +178,29 @@ export const QueryRefreshIndicator = () => { ); }; -const QueryMenuItem = ({ row }: { row: QueryStatusRow }) => { - const rowColor = statusColorMap[row.fetchStatus === "fetching" ? "fetching" : `idle_${row.status}`] ?? "gray"; +const SmallDot = ({ color }: { color: string }) => ( + +); - const updatedLabel = row.dataUpdatedAt > 0 ? dayjs(row.dataUpdatedAt).fromNow() : "never"; +const QueryMenuItem = ({ row }: { row: QueryStatusRow }) => { + const rowColor = resolveRowColor(row.fetchStatus, row.status); + const updatedLabel = row.dataUpdatedAt > 0 ? dayjs(row.dataUpdatedAt).fromNow() : "—"; return ( + + + {row.integrationIcons.length > 0 && } + } rightSection={ - + {updatedLabel} } @@ -195,3 +212,13 @@ const QueryMenuItem = ({ row }: { row: QueryStatusRow }) => { ); }; + +const IntegrationAvatars = ({ icons }: { icons: QueryStatusRow["integrationIcons"] }) => ( + + {icons.slice(0, 3).map((icon, index) => ( + + + + ))} + +); From 5899e1b44b6712007fdb3e7309ded9a6a32a3922 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Fri, 29 May 2026 17:26:44 +0200 Subject: [PATCH 15/18] chore(deps): add @tanstack/query-persist-client-core to workspace catalog --- pnpm-lock.yaml | 13 +++++++++++++ pnpm-workspace.yaml | 1 + 2 files changed, 14 insertions(+) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d09d3fd6c..ef18eedc7 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -123,6 +123,9 @@ catalogs: '@tabler/icons-react': specifier: ^3.44.0 version: 3.44.0 + '@tanstack/query-persist-client-core': + specifier: ^5.100.14 + version: 5.100.14 '@tanstack/react-query': specifier: ^5.100.13 version: 5.100.14 @@ -760,6 +763,9 @@ importers: '@tabler/icons-react': specifier: 'catalog:' version: 3.44.0(react@19.2.6) + '@tanstack/query-persist-client-core': + specifier: 'catalog:' + version: 5.100.14 '@tanstack/react-query': specifier: 'catalog:' version: 5.100.14(react@19.2.6) @@ -4881,6 +4887,9 @@ packages: '@tanstack/query-devtools@5.100.14': resolution: {integrity: sha512-g96SmSSQecYTYcyuAMRXr895GplJv01UGt7qttQWPOUyZ5EGz5tbRc589bMc2m5BsPFD6O0PCEAHdbDYNP6UBw==} + '@tanstack/query-persist-client-core@5.100.14': + resolution: {integrity: sha512-mn60cqoQO/xB6aHxp/hxlSj5mcdcTO4tjj4SXSz5MKzkaMZnvcEGySz3+cGQOT8McREN56fL41L0eR//v5RwNw==} + '@tanstack/react-query-devtools@5.100.14': resolution: {integrity: sha512-JkP5VDgKOw3t/QSA1OABRHEqx8BuNs5MfvZRooNqdvN57SzTuGq3fKR1a2IH5rqa5HDLUm+FOXUEnB9ueHiLzg==} peerDependencies: @@ -12169,6 +12178,10 @@ snapshots: '@tanstack/query-devtools@5.100.14': {} + '@tanstack/query-persist-client-core@5.100.14': + dependencies: + '@tanstack/query-core': 5.100.14 + '@tanstack/react-query-devtools@5.100.14(@tanstack/react-query@5.100.14(react@19.2.6))(react@19.2.6)': dependencies: '@tanstack/query-devtools': 5.100.14 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 46244a138..6f44e6863 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -43,6 +43,7 @@ catalog: "@semantic-release/release-notes-generator": ^14.1.1 "@t3-oss/env-nextjs": ^0.13.11 "@tabler/icons-react": ^3.44.0 + "@tanstack/query-persist-client-core": ^5.100.14 "@tanstack/react-query": ^5.100.13 "@tanstack/react-query-devtools": ^5.100.13 "@tanstack/react-query-next-experimental": ^5.100.13 From 4bfde12b659b6da8311985597030f746a018fc9b Mon Sep 17 00:00:00 2001 From: ajnart <49837342+ajnart@users.noreply.github.com> Date: Fri, 29 May 2026 17:55:03 +0000 Subject: [PATCH 16/18] style: auto-fix lint and format --- .../src/components/layout/header/query-refresh-indicator.tsx | 4 +--- packages/boards/src/context.tsx | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx index 932005267..6ac2e7f1e 100644 --- a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx +++ b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx @@ -41,9 +41,7 @@ const parseWidgetQueryKey = (queryKey: readonly unknown[]): { procedure: string; const procedure = first.slice(1).map(capitalize).join(" — "); const second = queryKey[1] as { input?: Record } | undefined; - const integrationIds = Array.isArray(second?.input?.integrationIds) - ? (second.input.integrationIds as string[]) - : []; + const integrationIds = Array.isArray(second?.input?.integrationIds) ? (second.input.integrationIds as string[]) : []; return { procedure, integrationIds }; }; diff --git a/packages/boards/src/context.tsx b/packages/boards/src/context.tsx index 24642b58d..c2ccc690a 100644 --- a/packages/boards/src/context.tsx +++ b/packages/boards/src/context.tsx @@ -86,7 +86,7 @@ export const getCurrentLayout = (board: RouterOutputs["board"]["getBoardByName"] // eslint-disable-next-line @typescript-eslint/no-non-null-assertion if (typeof window === "undefined") return board.layouts.at(0)!.id; - const sortedLayouts = board.layouts.sort((layoutA, layoutB) => layoutB.breakpoint - layoutA.breakpoint); + const sortedLayouts = board.layouts.toSorted((layoutA, layoutB) => layoutB.breakpoint - layoutA.breakpoint); // Fallback to smallest if none exists with breakpoint smaller than window width // eslint-disable-next-line @typescript-eslint/no-non-null-assertion From 9fc0e5f94cedc366e22dbec9f1a6a032ba2a1d89 Mon Sep 17 00:00:00 2001 From: Thomas Date: Fri, 29 May 2026 22:55:08 +0200 Subject: [PATCH 17/18] Delete .cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md --- .../widget_refresh_indicator_ffb2b58d.plan.md | 47 ------------------- 1 file changed, 47 deletions(-) delete mode 100644 .cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md diff --git a/.cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md b/.cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md deleted file mode 100644 index 0b970e630..000000000 --- a/.cursor/plans/widget_refresh_indicator_ffb2b58d.plan.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Widget Refresh Indicator -overview: "Add a board-header refresh indicator for widget/server-state queries using TanStack Query as the shared state source, then continue the PR #5768 pattern by removing widget-level blocking spinners where needed." -todos: - - id: switch-branch - content: After approval, switch the workspace to `agent/cebd0dad` and confirm the PR diff is present. - status: completed - - id: cache-hook - content: Create a TanStack Query cache-inspection hook that returns refresh counts and normalized query status rows. - status: completed - - id: header-ui - content: Add the hoverable orange/green header indicator immediately before the board edit button. - status: completed - - id: calendar-cleanup - content: Reconcile the calendar widget PR change with the new global indicator, removing redundant widget-local loading UI if appropriate. - status: completed - - id: verify - content: Run targeted typechecks and manually validate refresh, completion, hover details, and beep behavior. - status: completed -isProject: false ---- - -# Widget Refresh Indicator Plan - -## Findings -- PR [#5768](https://github.com/homarr-labs/homarr/pull/5768) is on `agent/cebd0dad` and currently only changes [packages/widgets/src/calendar/component.tsx](packages/widgets/src/calendar/component.tsx): `useSuspenseQuery` became `useQuery`, with a small widget-local loader. -- The current workspace is on `feat/add-integration-from-dashboard`, so implementation should first move to `agent/cebd0dad` after approval. -- Homarr already uses Jotai for small client UI state in [apps/nextjs/src/components/layout/header/burger.tsx](apps/nextjs/src/components/layout/header/burger.tsx), but there is no Zustand pattern. For this feature, TanStack Query itself should be the shared store. -- The client `QueryClient` lives in [apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx](apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx). TanStack Query v5 supports `useIsFetching()` for a global fetching count and `queryClient.getQueryCache().subscribe()` / `findAll()` for cache inspection. -- The board header actions are in [apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx](apps/nextjs/src/app/[locale]/boards/(content)/_header-actions.tsx); the indicator should be inserted immediately before ``, which places it to the left of the edit button. - -## Implementation Approach -- Add a small client hook/component, likely [apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx](apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx), that reads from `useQueryClient()` and subscribes to the query cache. -- Derive a normalized list from cached queries: query path/key, fetching status, `status`, `dataUpdatedAt`, stale state via the query object, error state, and integration IDs found in query inputs/data where present. -- Count active refreshes with `fetchStatus === "fetching"`, using a `useIsFetching()` value as a cheap re-render trigger and cache subscription for details. -- Render a Mantine `HeaderButton`/`ActionIcon` with a tiny `Indicator`: orange while one or more relevant queries are fetching, green briefly after a refresh batch completes, then idle/disabled when nothing is active. -- Use a Mantine `HoverCard` for the details: overall status, number of refreshing queries, last updated/stale state, and a compact list of current integration/widget query entries. -- Add a small Web Audio beep when the indicator transitions from fetching to complete. It should be best-effort and fail silently if the browser blocks audio before user interaction. -- Add translation keys only to [packages/translation/src/lang/en.json](packages/translation/src/lang/en.json); other locales fall back to English through the existing merge in [packages/translation/src/request.ts](packages/translation/src/request.ts). - -## Widget Migration Scope -- Keep PR #5768’s calendar behavior, but remove the widget-local loader if the header indicator fully replaces it. -- Do not attempt to convert all `useSuspenseQuery` widgets in the same pass unless the branch goal expands. The first version can show global activity for all query cache entries, while follow-up widget migrations replace blocking `useSuspenseQuery` with `useQuery` where each widget can render meaningful stale/empty content. - -## Verification -- Run a targeted typecheck such as `pnpm -F nextjs typecheck` and `pnpm -F widgets typecheck` after implementation. -- Skip lint cleanup unless explicitly requested, matching your preference to ignore linter errors. \ No newline at end of file From ef27d739bbf5f3740d4cd89cfb099c676b09f9c7 Mon Sep 17 00:00:00 2001 From: Thomas Date: Fri, 29 May 2026 23:41:40 +0200 Subject: [PATCH 18/18] remove green dot (#5822) --- .mise.toml | 3 + .../query-cache-persister.ts | 3 +- .../app/[locale]/_client-providers/trpc.tsx | 3 +- .../[locale]/boards/(content)/_creator.tsx | 3 - .../layout/header/query-refresh-indicator.tsx | 222 ------------------ .../src/components/layout/logo/board-logo.tsx | 18 +- packages/api/src/query-cache.ts | 3 +- packages/api/src/router/query-cache.ts | 4 +- packages/api/src/shared.ts | 4 +- packages/api/src/test/query-cache.spec.ts | 45 +++- .../widgets/src/anchor-note/component.tsx | 2 +- packages/widgets/src/app/component.tsx | 1 - packages/widgets/src/calendar/component.tsx | 2 +- packages/widgets/src/coolify/component.tsx | 5 +- .../src/dns-hole/controls/component.tsx | 2 +- .../src/dns-hole/summary/component.tsx | 2 +- packages/widgets/src/docker/component.tsx | 4 +- packages/widgets/src/downloads/component.tsx | 2 +- packages/widgets/src/firewall/component.tsx | 8 +- .../cluster/cluster-health.tsx | 2 +- .../src/health-monitoring/system-health.tsx | 2 +- .../src/immich/album-carousel/component.tsx | 2 +- .../src/immich/server-stats/component.tsx | 9 +- .../widgets/src/indexer-manager/component.tsx | 2 +- .../widgets/src/media-releases/component.tsx | 9 +- .../src/media-requests/list/component.tsx | 2 +- .../src/media-requests/stats/component.tsx | 2 +- .../widgets/src/media-server/component.tsx | 2 +- .../src/media-transcoding/component.tsx | 2 +- .../src/minecraft/server-status/component.tsx | 4 +- .../network-status/component.tsx | 2 +- .../network-controller/summary/component.tsx | 2 +- .../widgets/src/notifications/component.tsx | 2 +- packages/widgets/src/rssFeed/component.tsx | 2 +- .../src/smart-home/entity-state/component.tsx | 4 +- .../src/speedtest-tracker/component.tsx | 5 +- packages/widgets/src/stocks/component.tsx | 4 +- .../widgets/src/system-disks/component.tsx | 4 +- .../src/system-resources/component.tsx | 11 +- packages/widgets/src/timetable/component.tsx | 15 +- packages/widgets/src/tracearr/component.tsx | 5 +- packages/widgets/src/umami/umami-content.tsx | 21 +- .../src/umami/umami-events-content.tsx | 15 +- packages/widgets/src/umami/umami-top-list.tsx | 30 ++- packages/widgets/src/weather/component.tsx | 2 +- 45 files changed, 179 insertions(+), 319 deletions(-) create mode 100644 .mise.toml delete mode 100644 apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx diff --git a/.mise.toml b/.mise.toml new file mode 100644 index 000000000..103c85307 --- /dev/null +++ b/.mise.toml @@ -0,0 +1,3 @@ +[tools] +node = "24.16.0" +pnpm = "10.33.4" diff --git a/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts b/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts index faeadbb56..70d8581c7 100644 --- a/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts +++ b/apps/nextjs/src/app/[locale]/_client-providers/query-cache-persister.ts @@ -6,7 +6,6 @@ import { fetchApi } from "@homarr/api/client"; import { getActiveQueryCacheBoardId, isPersistableWidgetQueryKey, - queryCacheMaxAgeMs, queryCacheStoragePrefix, } from "@homarr/api/query-cache"; @@ -39,7 +38,7 @@ const queryCacheStorage = { export const createWidgetQueryPersister = () => experimental_createQueryPersister({ storage: typeof window === "undefined" ? undefined : queryCacheStorage, - maxAge: queryCacheMaxAgeMs, + maxAge: Number.POSITIVE_INFINITY, prefix: queryCacheStoragePrefix, refetchOnRestore: true, serialize: (query) => stringify(query), diff --git a/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx b/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx index 7601dac6d..76cf90695 100644 --- a/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx +++ b/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx @@ -19,6 +19,7 @@ import type { SuperJSONResult } from "superjson"; import type { AppRouter } from "@homarr/api"; import { clientApi } from "@homarr/api/client"; +import { queryCacheDefaultStaleTimeMs } from "@homarr/api/query-cache"; import { createHeadersCallbackForSource, getTrpcUrl } from "@homarr/api/shared"; import { env } from "@homarr/common/env"; @@ -58,7 +59,7 @@ export function TRPCReactProvider(props: PropsWithChildren) { defaultOptions: { queries: { persister: queryPersister.persisterFn, - staleTime: 5 * 1000, + staleTime: queryCacheDefaultStaleTimeMs, }, }, }), diff --git a/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx b/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx index 73235701e..27ed4b4fa 100644 --- a/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx +++ b/apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx @@ -9,7 +9,6 @@ import type { DehydratedState } from "@tanstack/react-query"; import { dehydrate, HydrationBoundary } from "@tanstack/react-query"; import { parse } from "superjson"; -import { queryCacheMaxAgeMs } from "@homarr/api/query-cache"; import { getQueryClient } from "@homarr/api/server"; import { IntegrationProvider } from "@homarr/auth/client"; import { auth } from "@homarr/auth/next"; @@ -127,13 +126,11 @@ interface PersistedEntry { async function QueryCacheHydration({ userId, boardId }: { userId: string; boardId: string }) { try { const entries = await getAllQueryCacheAsync(userId, boardId); - const now = Date.now(); const queries: DehydratedState["queries"] = []; for (const serialized of Object.values(entries)) { try { const persisted = parse(serialized); - if (now - persisted.state.dataUpdatedAt > queryCacheMaxAgeMs) continue; if (persisted.state.status !== "success") continue; queries.push({ diff --git a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx b/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx deleted file mode 100644 index 6ac2e7f1e..000000000 --- a/apps/nextjs/src/components/layout/header/query-refresh-indicator.tsx +++ /dev/null @@ -1,222 +0,0 @@ -"use client"; - -import { forwardRef, useEffect, useState } from "react"; -import { Avatar, Box, Group, Indicator, Menu, ScrollArea, Text, Tooltip, UnstyledButton } from "@mantine/core"; -import { useQueryClient } from "@tanstack/react-query"; -import dayjs from "dayjs"; - -import { useEditMode } from "@homarr/boards/edit-mode"; -import type { IntegrationKind } from "@homarr/definitions"; -import { getIconUrl } from "@homarr/definitions"; - -interface IntegrationInfo { - id: string; - kind: IntegrationKind; - name: string; -} - -interface QueryStatusRow { - id: string; - procedure: string; - integrationIcons: { kind: IntegrationKind; name: string }[]; - status: "pending" | "error" | "success"; - fetchStatus: "fetching" | "paused" | "idle"; - dataUpdatedAt: number; -} - -const hiddenProcedures = new Set(["widget.app.ping"]); - -const isTrackedWidgetQuery = (queryKey: readonly unknown[]): boolean => { - const first = queryKey[0]; - if (!Array.isArray(first) || first.length < 2 || first[0] !== "widget") return false; - - const path = first.join("."); - return !hiddenProcedures.has(path); -}; - -const capitalize = (s: string) => s.charAt(0).toUpperCase() + s.slice(1); - -const parseWidgetQueryKey = (queryKey: readonly unknown[]): { procedure: string; integrationIds: string[] } => { - const first = queryKey[0] as string[]; - const procedure = first.slice(1).map(capitalize).join(" — "); - - const second = queryKey[1] as { input?: Record } | undefined; - const integrationIds = Array.isArray(second?.input?.integrationIds) ? (second.input.integrationIds as string[]) : []; - - return { procedure, integrationIds }; -}; - -const statusColors: Record = { - fetching: "orange", - success: "green", - error: "red", - pending: "gray", -}; - -const resolveRowColor = (fetchStatus: string, status: string) => { - if (fetchStatus === "fetching") return statusColors.fetching!; - return statusColors[status] ?? "gray"; -}; - -const resolveDotColor = (fetchingCount: number, errorCount: number) => { - if (fetchingCount > 0) return statusColors.fetching!; - if (errorCount > 0) return statusColors.error!; - return statusColors.success!; -}; - -interface CacheSnapshot { - rows: QueryStatusRow[]; - fetchingCount: number; - errorCount: number; -} - -const emptyCacheSnapshot: CacheSnapshot = { rows: [], fetchingCount: 0, errorCount: 0 }; - -function resolveIntegrationMap(queryClient: ReturnType): Map { - const cache = queryClient.getQueryCache(); - const integrationQuery = cache.find({ queryKey: [["integration", "all"]] }); - - const map = new Map(); - const data = integrationQuery?.state.data as IntegrationInfo[] | undefined; - if (!data) return map; - - for (const integration of data) { - map.set(integration.id, integration); - } - return map; -} - -function useQueryCacheStatus() { - const queryClient = useQueryClient(); - const [snapshot, setSnapshot] = useState(emptyCacheSnapshot); - - useEffect(() => { - const update = () => { - const cache = queryClient.getQueryCache(); - const queries = cache.findAll({ type: "active" }).filter((q) => isTrackedWidgetQuery(q.queryKey)); - const integrationMap = resolveIntegrationMap(queryClient); - - let fetching = 0; - let errors = 0; - const nextRows: QueryStatusRow[] = queries.map((q) => { - if (q.state.fetchStatus === "fetching") fetching++; - if (q.state.status === "error") errors++; - const { procedure, integrationIds } = parseWidgetQueryKey(q.queryKey); - - const integrationIcons = integrationIds - .map((id) => integrationMap.get(id)) - .filter((info): info is IntegrationInfo => info !== undefined) - .map(({ kind, name }) => ({ kind, name })); - - return { - id: q.queryHash, - procedure, - integrationIcons, - status: q.state.status, - fetchStatus: q.state.fetchStatus, - dataUpdatedAt: q.state.dataUpdatedAt, - }; - }); - - setSnapshot({ rows: nextRows, fetchingCount: fetching, errorCount: errors }); - }; - - update(); - - let rafId: number | null = null; - const unsubscribe = queryClient.getQueryCache().subscribe(() => { - if (rafId !== null) return; - rafId = requestAnimationFrame(() => { - rafId = null; - update(); - }); - }); - - return () => { - unsubscribe(); - if (rafId !== null) cancelAnimationFrame(rafId); - }; - }, [queryClient]); - - return { ...snapshot, totalCount: snapshot.rows.length }; -} - -const StatusDot = forwardRef( - ({ color, processing, ...others }, ref) => ( - - - - - - ), -); - -export const QueryRefreshIndicator = () => { - const [isEditMode] = useEditMode(); - const { rows, fetchingCount, errorCount, totalCount } = useQueryCacheStatus(); - - if (isEditMode || totalCount === 0) return null; - - const isFetching = fetchingCount > 0; - const dotColor = resolveDotColor(fetchingCount, errorCount); - - return ( - - - - - - - {rows.map((row) => ( - - ))} - - - - ); -}; - -const SmallDot = ({ color }: { color: string }) => ( - -); - -const QueryMenuItem = ({ row }: { row: QueryStatusRow }) => { - const rowColor = resolveRowColor(row.fetchStatus, row.status); - const updatedLabel = row.dataUpdatedAt > 0 ? dayjs(row.dataUpdatedAt).fromNow() : "—"; - - return ( - - - {row.integrationIcons.length > 0 && } - - } - rightSection={ - - {updatedLabel} - - } - style={{ cursor: "default" }} - > - - {row.procedure} - - - ); -}; - -const IntegrationAvatars = ({ icons }: { icons: QueryStatusRow["integrationIcons"] }) => ( - - {icons.slice(0, 3).map((icon, index) => ( - - - - ))} - -); diff --git a/apps/nextjs/src/components/layout/logo/board-logo.tsx b/apps/nextjs/src/components/layout/logo/board-logo.tsx index 86bf94eeb..ad2f1ca2e 100644 --- a/apps/nextjs/src/components/layout/logo/board-logo.tsx +++ b/apps/nextjs/src/components/layout/logo/board-logo.tsx @@ -1,10 +1,7 @@ "use client"; -import { Group } from "@mantine/core"; - import { useRequiredBoard } from "@homarr/boards/context"; -import { QueryRefreshIndicator } from "../header/query-refresh-indicator"; import { homarrLogoPath, homarrPageTitle } from "./homarr-logo"; import type { LogoWithTitleProps } from "./logo"; import { Logo, LogoWithTitle } from "./logo"; @@ -36,14 +33,11 @@ export const BoardLogoWithTitle = ({ size, hideTitleOnMobile }: CommonLogoWithTi const board = useRequiredBoard(); const imageOptions = useImageOptions(); return ( - - - - + ); }; diff --git a/packages/api/src/query-cache.ts b/packages/api/src/query-cache.ts index d6e19f618..690059723 100644 --- a/packages/api/src/query-cache.ts +++ b/packages/api/src/query-cache.ts @@ -1,6 +1,7 @@ import type { QueryKey } from "@tanstack/react-query"; -export const queryCacheMaxAgeMs = 1000 * 60 * 60 * 24; +export const queryCacheRetentionMs = 1000 * 60 * 60 * 24; +export const queryCacheDefaultStaleTimeMs = 1000 * 60 * 5; export const queryCacheMaxValueBytes = 1024 * 1024; export const queryCacheStoragePrefix = "homarr-widget-query"; diff --git a/packages/api/src/router/query-cache.ts b/packages/api/src/router/query-cache.ts index d79de2711..6143501fc 100644 --- a/packages/api/src/router/query-cache.ts +++ b/packages/api/src/router/query-cache.ts @@ -4,7 +4,7 @@ import { eq } from "@homarr/db"; import { boards } from "@homarr/db/schema"; import { createQueryCacheChannel } from "@homarr/redis"; -import { queryCacheMaxAgeMs, queryCacheMaxValueBytes } from "../query-cache"; +import { queryCacheMaxValueBytes, queryCacheRetentionMs } from "../query-cache"; import { createTRPCRouter, publicProcedure } from "../trpc"; import { throwIfActionForbiddenAsync } from "./board/board-access"; @@ -22,7 +22,7 @@ const createChannel = (input: z.infer, userId: string userId, boardId: input.boardId, key: input.key, - ttlMs: queryCacheMaxAgeMs, + ttlMs: queryCacheRetentionMs, maxValueBytes: queryCacheMaxValueBytes, }); diff --git a/packages/api/src/shared.ts b/packages/api/src/shared.ts index 4ef9b7a4f..e05700f22 100644 --- a/packages/api/src/shared.ts +++ b/packages/api/src/shared.ts @@ -1,5 +1,7 @@ import { defaultShouldDehydrateQuery, QueryClient } from "@tanstack/react-query"; +import { queryCacheDefaultStaleTimeMs } from "./query-cache"; + /** * Creates a headers callback for a given source * It will set the x-trpc-source header and cookies if needed @@ -58,7 +60,7 @@ export const makeQueryClient = () => { return new QueryClient({ defaultOptions: { queries: { - staleTime: 5 * 1000, + staleTime: queryCacheDefaultStaleTimeMs, }, dehydrate: { shouldDehydrateQuery: (query) => defaultShouldDehydrateQuery(query) || query.state.status === "pending", diff --git a/packages/api/src/test/query-cache.spec.ts b/packages/api/src/test/query-cache.spec.ts index aba9fbf42..c765af031 100644 --- a/packages/api/src/test/query-cache.spec.ts +++ b/packages/api/src/test/query-cache.spec.ts @@ -1,11 +1,17 @@ import { afterEach, describe, expect, test, vi } from "vitest"; +import { QueryClient } from "@tanstack/react-query"; import type { Session } from "@homarr/auth"; import { createId } from "@homarr/common"; import type { Database } from "@homarr/db"; import { boards, users } from "@homarr/db/schema"; import { createDb } from "@homarr/db/test"; -import { isPersistableWidgetQueryKey, queryCacheMaxAgeMs, queryCacheMaxValueBytes } from "@homarr/api/query-cache"; +import { + isPersistableWidgetQueryKey, + queryCacheDefaultStaleTimeMs, + queryCacheMaxValueBytes, + queryCacheRetentionMs, +} from "@homarr/api/query-cache"; import { queryCacheRouter } from "../router/query-cache"; @@ -141,7 +147,7 @@ describe("queryCacheRouter", () => { userId: "anonymous", boardId: "board-1", key: "query-key", - ttlMs: queryCacheMaxAgeMs, + ttlMs: queryCacheRetentionMs, maxValueBytes: queryCacheMaxValueBytes, }); }); @@ -161,7 +167,7 @@ describe("queryCacheRouter", () => { expect(redisMock.calls.at(-1)).toMatchObject({ userId: "user-1", boardId: "board-1", - ttlMs: queryCacheMaxAgeMs, + ttlMs: queryCacheRetentionMs, maxValueBytes: queryCacheMaxValueBytes, }); }); @@ -180,8 +186,39 @@ describe("queryCacheRouter", () => { await caller.setItem({ boardId: "board-1", key: "query-key", value: "cached-value" }); await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).resolves.toBe("cached-value"); - await vi.advanceTimersByTimeAsync(queryCacheMaxAgeMs + 1); + await vi.advanceTimersByTimeAsync(queryCacheRetentionMs + 1); await expect(caller.getItem({ boardId: "board-1", key: "query-key" })).resolves.toBeNull(); }); }); + +describe("query cache stale handling", () => { + test("uses TanStack Query dataUpdatedAt and staleTime to decide when cached data refetches", async () => { + vi.useFakeTimers(); + vi.setSystemTime(new Date("2026-01-01T00:10:00.000Z")); + + const queryClient = new QueryClient({ + defaultOptions: { + queries: { + retry: false, + staleTime: queryCacheDefaultStaleTimeMs, + }, + }, + }); + const queryKey = [["widget", "example"], { input: { integrationIds: ["integration-1"] }, type: "query" }]; + const queryFn = vi.fn().mockResolvedValue("fresh"); + + queryClient.setQueryData(queryKey, "cached", { + updatedAt: Date.now() - queryCacheDefaultStaleTimeMs - 1, + }); + + await expect( + queryClient.fetchQuery({ + queryKey, + queryFn, + }), + ).resolves.toBe("fresh"); + + expect(queryFn).toHaveBeenCalledOnce(); + }); +}); diff --git a/packages/widgets/src/anchor-note/component.tsx b/packages/widgets/src/anchor-note/component.tsx index 6a2718505..99585b838 100644 --- a/packages/widgets/src/anchor-note/component.tsx +++ b/packages/widgets/src/anchor-note/component.tsx @@ -151,7 +151,7 @@ const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteW noteId, }, { - refetchOnMount: false, + staleTime: 15 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/app/component.tsx b/packages/widgets/src/app/component.tsx index 05a306db3..054a2da6b 100644 --- a/packages/widgets/src/app/component.tsx +++ b/packages/widgets/src/app/component.tsx @@ -28,7 +28,6 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget id: options.appId, }, { - refetchOnMount: false, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/calendar/component.tsx b/packages/widgets/src/calendar/component.tsx index b3c3160ea..ac3d8b37b 100644 --- a/packages/widgets/src/calendar/component.tsx +++ b/packages/widgets/src/calendar/component.tsx @@ -40,7 +40,7 @@ const FetchCalendar = ({ month, setMonth, isEditMode, integrationIds, options }: showUnmonitored: options.showUnmonitored, }; const { data } = clientApi.widget.calendar.findAllEvents.useQuery(input, { - refetchOnMount: false, + staleTime: 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/coolify/component.tsx b/packages/widgets/src/coolify/component.tsx index 3dde4bcfb..91b37ecd4 100644 --- a/packages/widgets/src/coolify/component.tsx +++ b/packages/widgets/src/coolify/component.tsx @@ -31,7 +31,10 @@ interface CoolifyContentProps { } function CoolifyContent({ integrationIds, options, width }: CoolifyContentProps) { - const { data: instancesData = [] } = clientApi.widget.coolify.getInstancesInfo.useQuery({ integrationIds }); + const { data: instancesData = [] } = clientApi.widget.coolify.getInstancesInfo.useQuery( + { integrationIds }, + { staleTime: 30 * 1000 }, + ); const utils = clientApi.useUtils(); clientApi.widget.coolify.subscribeInstancesInfo.useSubscription( diff --git a/packages/widgets/src/dns-hole/controls/component.tsx b/packages/widgets/src/dns-hole/controls/component.tsx index 460e86d04..afe397cfd 100644 --- a/packages/widgets/src/dns-hole/controls/component.tsx +++ b/packages/widgets/src/dns-hole/controls/component.tsx @@ -56,7 +56,7 @@ export default function DnsHoleControlsWidget({ integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/dns-hole/summary/component.tsx b/packages/widgets/src/dns-hole/summary/component.tsx index a72960d03..4a4c2879c 100644 --- a/packages/widgets/src/dns-hole/summary/component.tsx +++ b/packages/widgets/src/dns-hole/summary/component.tsx @@ -25,7 +25,7 @@ export default function DnsHoleSummaryWidget({ options, integrationIds }: Widget integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/docker/component.tsx b/packages/widgets/src/docker/component.tsx index 7e6b8ef44..677a5c533 100644 --- a/packages/widgets/src/docker/component.tsx +++ b/packages/widgets/src/docker/component.tsx @@ -204,7 +204,9 @@ export default function DockerWidget({ options, width, isEditMode }: WidgetCompo const isTiny = width <= 256; const utils = clientApi.useUtils(); - const { data } = clientApi.docker.getContainers.useQuery(); + const { data } = clientApi.docker.getContainers.useQuery(undefined, { + staleTime: 20 * 1000, + }); const containers = data?.containers ?? []; const timestamp = useMemo(() => data?.timestamp ?? new Date(), [data?.timestamp]); const relativeTime = useTimeAgo(timestamp); diff --git a/packages/widgets/src/downloads/component.tsx b/packages/widgets/src/downloads/component.tsx index e84544f92..bee31eb20 100644 --- a/packages/widgets/src/downloads/component.tsx +++ b/packages/widgets/src/downloads/component.tsx @@ -93,7 +93,7 @@ export default function DownloadClientsWidget({ limitPerIntegration: options.limitPerIntegration, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/firewall/component.tsx b/packages/widgets/src/firewall/component.tsx index 80f1812eb..7318cd3d3 100644 --- a/packages/widgets/src/firewall/component.tsx +++ b/packages/widgets/src/firewall/component.tsx @@ -189,7 +189,7 @@ export const useUpdatingCpuStatus = (integrationIds: string[]) => { integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, @@ -230,7 +230,7 @@ export const useUpdatingMemoryStatus = (integrationIds: string[]) => { integrationIds, }, { - refetchOnMount: false, + staleTime: 15 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, @@ -271,7 +271,7 @@ export const useUpdatingVersionStatus = (integrationIds: string[]) => { integrationIds, }, { - refetchOnMount: false, + staleTime: 60 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, @@ -311,7 +311,7 @@ export const useUpdatingInterfacesStatus = (integrationIds: string[]) => { integrationIds, }, { - refetchOnMount: false, + staleTime: 30 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx b/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx index d8fa10614..daa0b40ec 100644 --- a/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx +++ b/packages/widgets/src/health-monitoring/cluster/cluster-health.tsx @@ -40,7 +40,7 @@ export const ClusterHealthMonitoring = ({ integrationId, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/health-monitoring/system-health.tsx b/packages/widgets/src/health-monitoring/system-health.tsx index 9c5260ff0..1f0dd02e5 100644 --- a/packages/widgets/src/health-monitoring/system-health.tsx +++ b/packages/widgets/src/health-monitoring/system-health.tsx @@ -57,7 +57,7 @@ export const SystemHealthMonitoring = ({ integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/immich/album-carousel/component.tsx b/packages/widgets/src/immich/album-carousel/component.tsx index 9c157bfaa..94795991c 100644 --- a/packages/widgets/src/immich/album-carousel/component.tsx +++ b/packages/widgets/src/immich/album-carousel/component.tsx @@ -23,7 +23,7 @@ export default function ImmichAlbumCarouselWidget({ integrationId: integrationIds[0] ?? "", albumId: options.albumId ?? "", }, - { enabled: Boolean(options.albumId) }, + { enabled: Boolean(options.albumId), staleTime: 15 * 60 * 1000 }, ); if (!options.albumId) { diff --git a/packages/widgets/src/immich/server-stats/component.tsx b/packages/widgets/src/immich/server-stats/component.tsx index 919b0caf0..e3e1596ea 100644 --- a/packages/widgets/src/immich/server-stats/component.tsx +++ b/packages/widgets/src/immich/server-stats/component.tsx @@ -17,9 +17,12 @@ export default function ImmichServerStatsWidget({ options, }: WidgetComponentProps<"immich-serverStats">) { const t = useI18n(); - const { data: stats } = clientApi.widget.immich.getServerStats.useQuery({ - integrationId: integrationIds[0] ?? "", - }); + const { data: stats } = clientApi.widget.immich.getServerStats.useQuery( + { + integrationId: integrationIds[0] ?? "", + }, + { staleTime: 15 * 60 * 1000 }, + ); if (!stats) return ; diff --git a/packages/widgets/src/indexer-manager/component.tsx b/packages/widgets/src/indexer-manager/component.tsx index ce0e89403..51ddb1805 100644 --- a/packages/widgets/src/indexer-manager/component.tsx +++ b/packages/widgets/src/indexer-manager/component.tsx @@ -21,7 +21,7 @@ export default function IndexerManagerWidget({ const { data: indexersData = [] } = clientApi.widget.indexerManager.getIndexersStatus.useQuery( { integrationIds }, { - refetchOnMount: false, + staleTime: 5 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/media-releases/component.tsx b/packages/widgets/src/media-releases/component.tsx index 26fe367a9..61fc9216d 100644 --- a/packages/widgets/src/media-releases/component.tsx +++ b/packages/widgets/src/media-releases/component.tsx @@ -18,9 +18,12 @@ import { OverflowBadge } from "@homarr/ui"; import type { WidgetComponentProps } from "../definition"; export default function MediaReleasesWidget({ options, integrationIds }: WidgetComponentProps<"mediaReleases">) { - const { data: releases = [] } = clientApi.widget.mediaRelease.getMediaReleases.useQuery({ - integrationIds, - }); + const { data: releases = [] } = clientApi.widget.mediaRelease.getMediaReleases.useQuery( + { + integrationIds, + }, + { staleTime: 5 * 60 * 1000 }, + ); return ( diff --git a/packages/widgets/src/media-requests/list/component.tsx b/packages/widgets/src/media-requests/list/component.tsx index 4c60b1dcf..5c990a709 100644 --- a/packages/widgets/src/media-requests/list/component.tsx +++ b/packages/widgets/src/media-requests/list/component.tsx @@ -25,7 +25,7 @@ export default function MediaServerWidget({ integrationIds, }, { - refetchOnMount: false, + staleTime: 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, }, diff --git a/packages/widgets/src/media-requests/stats/component.tsx b/packages/widgets/src/media-requests/stats/component.tsx index 5a6f425b3..8824fed6a 100644 --- a/packages/widgets/src/media-requests/stats/component.tsx +++ b/packages/widgets/src/media-requests/stats/component.tsx @@ -38,7 +38,7 @@ export default function MediaServerWidget({ integrationIds, }, { - refetchOnMount: false, + staleTime: 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, }, diff --git a/packages/widgets/src/media-server/component.tsx b/packages/widgets/src/media-server/component.tsx index 138728e57..efa2c2415 100644 --- a/packages/widgets/src/media-server/component.tsx +++ b/packages/widgets/src/media-server/component.tsx @@ -29,7 +29,7 @@ export default function MediaServerWidget({ showOnlyPlaying: options.showOnlyPlaying, }, { - refetchOnMount: false, + staleTime: 5 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, }, diff --git a/packages/widgets/src/media-transcoding/component.tsx b/packages/widgets/src/media-transcoding/component.tsx index 494cfd968..8b0ba6591 100644 --- a/packages/widgets/src/media-transcoding/component.tsx +++ b/packages/widgets/src/media-transcoding/component.tsx @@ -39,7 +39,7 @@ export default function MediaTranscodingWidget({ page: queuePage, }; const { data: transcodingData } = clientApi.widget.mediaTranscoding.getDataAsync.useQuery(input, { - refetchOnMount: false, + staleTime: 5 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, }); diff --git a/packages/widgets/src/minecraft/server-status/component.tsx b/packages/widgets/src/minecraft/server-status/component.tsx index c57cd5314..ddf4d6e4b 100644 --- a/packages/widgets/src/minecraft/server-status/component.tsx +++ b/packages/widgets/src/minecraft/server-status/component.tsx @@ -11,7 +11,9 @@ import { WidgetEmptyState } from "../../common/empty-state"; import type { WidgetComponentProps } from "../../definition"; export default function MinecraftServerStatusWidget({ options }: WidgetComponentProps<"minecraftServerStatus">) { - const { data: result } = clientApi.widget.minecraft.getServerStatus.useQuery(options); + const { data: result } = clientApi.widget.minecraft.getServerStatus.useQuery(options, { + staleTime: 5 * 60 * 1000, + }); const utils = clientApi.useUtils(); clientApi.widget.minecraft.subscribeServerStatus.useSubscription(options, { onData(data) { diff --git a/packages/widgets/src/network-controller/network-status/component.tsx b/packages/widgets/src/network-controller/network-status/component.tsx index e0ce57dfb..846d1128f 100644 --- a/packages/widgets/src/network-controller/network-status/component.tsx +++ b/packages/widgets/src/network-controller/network-status/component.tsx @@ -26,7 +26,7 @@ export default function NetworkControllerNetworkStatusWidget({ integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/network-controller/summary/component.tsx b/packages/widgets/src/network-controller/summary/component.tsx index 040b53eca..21a4b6a93 100644 --- a/packages/widgets/src/network-controller/summary/component.tsx +++ b/packages/widgets/src/network-controller/summary/component.tsx @@ -25,7 +25,7 @@ export default function NetworkControllerSummaryWidget({ integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/notifications/component.tsx b/packages/widgets/src/notifications/component.tsx index 4334836b9..47aa829be 100644 --- a/packages/widgets/src/notifications/component.tsx +++ b/packages/widgets/src/notifications/component.tsx @@ -18,7 +18,7 @@ export default function NotificationsWidget({ options, integrationIds }: WidgetC integrationIds, }, { - refetchOnMount: false, + staleTime: 5 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/rssFeed/component.tsx b/packages/widgets/src/rssFeed/component.tsx index 49cf807ea..a2cf07ebb 100644 --- a/packages/widgets/src/rssFeed/component.tsx +++ b/packages/widgets/src/rssFeed/component.tsx @@ -13,7 +13,7 @@ import classes from "./component.module.scss"; const useLiveFeedEntries = (input: RouterInputs["widget"]["rssFeed"]["getFeeds"]) => { const { data: feedEntries = [] } = clientApi.widget.rssFeed.getFeeds.useQuery(input, { - refetchOnMount: false, + staleTime: 5 * 60 * 1000, refetchOnWindowFocus: false, refetchOnReconnect: false, retry: false, diff --git a/packages/widgets/src/smart-home/entity-state/component.tsx b/packages/widgets/src/smart-home/entity-state/component.tsx index f796f3261..2ad45b7a3 100644 --- a/packages/widgets/src/smart-home/entity-state/component.tsx +++ b/packages/widgets/src/smart-home/entity-state/component.tsx @@ -23,7 +23,9 @@ export default function SmartHomeEntityStateWidget({ entityId: options.entityId, integrationId, }; - const { data: entityState } = clientApi.widget.smartHome.entityState.useQuery(input); + const { data: entityState } = clientApi.widget.smartHome.entityState.useQuery(input, { + staleTime: 60 * 1000, + }); const utils = clientApi.useUtils(); diff --git a/packages/widgets/src/speedtest-tracker/component.tsx b/packages/widgets/src/speedtest-tracker/component.tsx index b55143084..dcde145a4 100644 --- a/packages/widgets/src/speedtest-tracker/component.tsx +++ b/packages/widgets/src/speedtest-tracker/component.tsx @@ -20,7 +20,10 @@ export default function SpeedtestTrackerWidget({ isEditMode, }: WidgetComponentProps<"speedtestTracker">) { const t = useScopedI18n("widget.speedtestTracker"); - const { data: dashboardData = [] } = clientApi.widget.speedtestTracker.getDashboard.useQuery({ integrationIds }); + const { data: dashboardData = [] } = clientApi.widget.speedtestTracker.getDashboard.useQuery( + { integrationIds }, + { staleTime: 10 * 60 * 1000 }, + ); const utils = clientApi.useUtils(); clientApi.widget.speedtestTracker.subscribeToDashboard.useSubscription( diff --git a/packages/widgets/src/stocks/component.tsx b/packages/widgets/src/stocks/component.tsx index 918851ce8..99078b4d2 100644 --- a/packages/widgets/src/stocks/component.tsx +++ b/packages/widgets/src/stocks/component.tsx @@ -25,7 +25,9 @@ function calculateChangePercentage(currentPrice: number, previousClose: number) export default function StockPriceWidget({ options, width, height }: WidgetComponentProps<"stockPrice">) { const t = useScopedI18n("widget.stockPrice"); const theme = useMantineTheme(); - const { data: result } = clientApi.widget.stockPrice.getPriceHistory.useQuery(options); + const { data: result } = clientApi.widget.stockPrice.getPriceHistory.useQuery(options, { + staleTime: 5 * 60 * 1000, + }); if (!result) return ; const { data } = result; diff --git a/packages/widgets/src/system-disks/component.tsx b/packages/widgets/src/system-disks/component.tsx index 36b20e275..5c6271c09 100644 --- a/packages/widgets/src/system-disks/component.tsx +++ b/packages/widgets/src/system-disks/component.tsx @@ -33,7 +33,9 @@ const getDisplayText = (item: { used: string; available: string; percentage: num export default function SystemResources({ integrationIds, options }: WidgetComponentProps<"systemDisks">) { const queryInput = { integrationIds }; - const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery(queryInput); + const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery(queryInput, { + staleTime: 5 * 1000, + }); const utils = clientApi.useUtils(); const board = useRequiredBoard(); diff --git a/packages/widgets/src/system-resources/component.tsx b/packages/widgets/src/system-resources/component.tsx index d2c5380ad..d9e5a8604 100644 --- a/packages/widgets/src/system-resources/component.tsx +++ b/packages/widgets/src/system-resources/component.tsx @@ -18,9 +18,14 @@ const MAX_QUEUE_SIZE = 15; export default function SystemResources({ integrationIds, options }: WidgetComponentProps<"systemResources">) { const { ref, width } = useElementSize(); - const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery({ - integrationIds, - }); + const { data = [] } = clientApi.widget.healthMonitoring.getSystemHealthStatus.useQuery( + { + integrationIds, + }, + { + staleTime: 5 * 1000, + }, + ); const memoryCapacityInBytes = (data[0]?.healthInfo.memAvailableInBytes ?? 0) + (data[0]?.healthInfo.memUsedInBytes ?? 0); diff --git a/packages/widgets/src/timetable/component.tsx b/packages/widgets/src/timetable/component.tsx index 2f1ad982b..539d7e6c7 100644 --- a/packages/widgets/src/timetable/component.tsx +++ b/packages/widgets/src/timetable/component.tsx @@ -26,11 +26,16 @@ interface TimetableWidgetInnerProps { } const TimetableWidgetInner = ({ station, integrationId }: TimetableWidgetInnerProps) => { - const { data: timetable } = clientApi.widget.timetable.getTimetable.useQuery({ - integrationId, - stationId: station.value, - limit: 10, - }); + const { data: timetable } = clientApi.widget.timetable.getTimetable.useQuery( + { + integrationId, + stationId: station.value, + limit: 10, + }, + { + staleTime: 60 * 1000, + }, + ); const t = useScopedI18n("widget.timetable"); return ( diff --git a/packages/widgets/src/tracearr/component.tsx b/packages/widgets/src/tracearr/component.tsx index 4a54779ee..0ff5e9132 100644 --- a/packages/widgets/src/tracearr/component.tsx +++ b/packages/widgets/src/tracearr/component.tsx @@ -35,7 +35,10 @@ interface TracearrContentProps { function TracearrContent({ integrationIds, options, width, isEditMode }: TracearrContentProps) { const t = useScopedI18n("widget.tracearr"); - const { data: dashboardData = [] } = clientApi.widget.tracearr.getDashboard.useQuery({ integrationIds }); + const { data: dashboardData = [] } = clientApi.widget.tracearr.getDashboard.useQuery( + { integrationIds }, + { staleTime: 5 * 1000 }, + ); const utils = clientApi.useUtils(); clientApi.widget.tracearr.subscribeToDashboard.useSubscription( diff --git a/packages/widgets/src/umami/umami-content.tsx b/packages/widgets/src/umami/umami-content.tsx index e6dd90a8f..2f8dea22c 100644 --- a/packages/widgets/src/umami/umami-content.tsx +++ b/packages/widgets/src/umami/umami-content.tsx @@ -40,15 +40,20 @@ export function UmamiContent({ const { colorScheme } = useMantineColorScheme(); const tickColor = colorScheme === "dark" ? "#c1c2c5" : "#495057"; - const { data: results = [] } = clientApi.widget.umami.getVisitorStats.useQuery({ - integrationIds, - websiteId, - timeFrame, - eventName, - }); + const { data: results = [] } = clientApi.widget.umami.getVisitorStats.useQuery( + { + integrationIds, + websiteId, + timeFrame, + eventName, + }, + { staleTime: 5 * 60 * 1000 }, + ); const activeVisitorsInput = { integrationId: integrationIds[0] ?? "", websiteId }; - const { data: activeVisitors = 0 } = clientApi.widget.umami.getActiveVisitors.useQuery(activeVisitorsInput); + const { data: activeVisitors = 0 } = clientApi.widget.umami.getActiveVisitors.useQuery(activeVisitorsInput, { + staleTime: 30 * 1000, + }); const utils = clientApi.useUtils(); clientApi.widget.umami.subscribeActiveVisitors.useSubscription(activeVisitorsInput, { onData(count) { @@ -58,7 +63,7 @@ export function UmamiContent({ const { data: multiEventSeries } = clientApi.widget.umami.getMultiEventTimeSeries.useQuery( { integrationId: integrationIds[0] ?? "", websiteId, timeFrame, eventNames: [...eventNames].toSorted() }, - { enabled: viewMode === "events" && eventNames.length > 0 }, + { enabled: viewMode === "events" && eventNames.length > 0, staleTime: 5 * 60 * 1000 }, ); const multiEventTotal = multiEventSeries diff --git a/packages/widgets/src/umami/umami-events-content.tsx b/packages/widgets/src/umami/umami-events-content.tsx index 6dfac617c..0351e906c 100644 --- a/packages/widgets/src/umami/umami-events-content.tsx +++ b/packages/widgets/src/umami/umami-events-content.tsx @@ -28,12 +28,15 @@ export function UmamiEventsContent({ const { colorScheme } = useMantineColorScheme(); const tickColor = colorScheme === "dark" ? "#c1c2c5" : "#495057"; - const { data: series = [] } = clientApi.widget.umami.getMultiEventTimeSeries.useQuery({ - integrationId: integrationIds[0] ?? "", - websiteId, - timeFrame, - eventNames: [...eventNames].toSorted(), - }); + const { data: series = [] } = clientApi.widget.umami.getMultiEventTimeSeries.useQuery( + { + integrationId: integrationIds[0] ?? "", + websiteId, + timeFrame, + eventNames: [...eventNames].toSorted(), + }, + { staleTime: 5 * 60 * 1000 }, + ); if (eventNames.length === 0) { return ( diff --git a/packages/widgets/src/umami/umami-top-list.tsx b/packages/widgets/src/umami/umami-top-list.tsx index 699df9b74..125115f0c 100644 --- a/packages/widgets/src/umami/umami-top-list.tsx +++ b/packages/widgets/src/umami/umami-top-list.tsx @@ -15,23 +15,29 @@ interface UmamiTopListProps { export function UmamiTopPagesContent({ integrationIds, websiteId, timeFrame, limit }: UmamiTopListProps) { const t = useScopedI18n("widget.umami"); - const { data = [] } = clientApi.widget.umami.getTopPages.useQuery({ - integrationId: integrationIds[0] ?? "", - websiteId, - timeFrame, - limit, - }); + const { data = [] } = clientApi.widget.umami.getTopPages.useQuery( + { + integrationId: integrationIds[0] ?? "", + websiteId, + timeFrame, + limit, + }, + { staleTime: 5 * 60 * 1000 }, + ); return ; } export function UmamiTopReferrersContent({ integrationIds, websiteId, timeFrame, limit }: UmamiTopListProps) { const t = useScopedI18n("widget.umami"); - const { data = [] } = clientApi.widget.umami.getTopReferrers.useQuery({ - integrationId: integrationIds[0] ?? "", - websiteId, - timeFrame, - limit, - }); + const { data = [] } = clientApi.widget.umami.getTopReferrers.useQuery( + { + integrationId: integrationIds[0] ?? "", + websiteId, + timeFrame, + limit, + }, + { staleTime: 5 * 60 * 1000 }, + ); return (