remove green dot (#5822)

This commit is contained in:
Thomas authored and GitHub committed 2026-05-29 23:41:40 +02:00
1 parent 9fc0e5f94c
commit ef27d739bb
45 files changed
+179 -319

No files matched your search

+2 -1
View File
@@ -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";
+2 -2
View File
@@ -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<typeof queryCacheKeyInput>, userId: string
userId,
boardId: input.boardId,
key: input.key,
ttlMs: queryCacheMaxAgeMs,
ttlMs: queryCacheRetentionMs,
maxValueBytes: queryCacheMaxValueBytes,
});
+3 -1
View File
@@ -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",
+41 -4
View File
@@ -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();
});
});
@@ -151,7 +151,7 @@ const AnchorNoteWidgetContent = ({ options, integrationId, noteId }: AnchorNoteW
noteId,
},
{
refetchOnMount: false,
staleTime: 15 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
-1
View File
@@ -28,7 +28,6 @@ export default function AppWidget({ options, isEditMode, height, width }: Widget
id: options.appId,
},
{
refetchOnMount: false,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
+1 -1
View File
@@ -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,
+4 -1
View File
@@ -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(
@@ -56,7 +56,7 @@ export default function DnsHoleControlsWidget({
integrationIds,
},
{
refetchOnMount: false,
staleTime: 5 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
@@ -25,7 +25,7 @@ export default function DnsHoleSummaryWidget({ options, integrationIds }: Widget
integrationIds,
},
{
refetchOnMount: false,
staleTime: 5 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
+3 -1
View File
@@ -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);
+1 -1
View File
@@ -93,7 +93,7 @@ export default function DownloadClientsWidget({
limitPerIntegration: options.limitPerIntegration,
},
{
refetchOnMount: false,
staleTime: 5 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
+4 -4
View File
@@ -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,
@@ -40,7 +40,7 @@ export const ClusterHealthMonitoring = ({
integrationId,
},
{
refetchOnMount: false,
staleTime: 5 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
@@ -57,7 +57,7 @@ export const SystemHealthMonitoring = ({
integrationIds,
},
{
refetchOnMount: false,
staleTime: 5 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
@@ -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) {
@@ -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 <WidgetEmptyState />;
@@ -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,
@@ -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 (
<Stack p="xs" gap="sm">
@@ -25,7 +25,7 @@ export default function MediaServerWidget({
integrationIds,
},
{
refetchOnMount: false,
staleTime: 60 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
},
@@ -38,7 +38,7 @@ export default function MediaServerWidget({
integrationIds,
},
{
refetchOnMount: false,
staleTime: 60 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
},
@@ -29,7 +29,7 @@ export default function MediaServerWidget({
showOnlyPlaying: options.showOnlyPlaying,
},
{
refetchOnMount: false,
staleTime: 5 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
},
@@ -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,
});
@@ -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) {
@@ -26,7 +26,7 @@ export default function NetworkControllerNetworkStatusWidget({
integrationIds,
},
{
refetchOnMount: false,
staleTime: 5 * 60 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
@@ -25,7 +25,7 @@ export default function NetworkControllerSummaryWidget({
integrationIds,
},
{
refetchOnMount: false,
staleTime: 5 * 60 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
@@ -18,7 +18,7 @@ export default function NotificationsWidget({ options, integrationIds }: WidgetC
integrationIds,
},
{
refetchOnMount: false,
staleTime: 5 * 60 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
retry: false,
+1 -1
View File
@@ -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,
@@ -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();
@@ -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(
+3 -1
View File
@@ -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 <WidgetEmptyState />;
const { data } = result;
@@ -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();
@@ -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);
+10 -5
View File
@@ -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 (
+4 -1
View File
@@ -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(
+13 -8
View File
@@ -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
@@ -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 (
+18 -12
View File
@@ -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 <UmamiTopList items={data} heading={t("option.viewMode.option.topPages")} emptyLabel={t("topPages.direct")} />;
}
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 (
<UmamiTopList
items={data}
+1 -1
View File
@@ -20,7 +20,7 @@ export default function WeatherWidget({ isEditMode, options }: WidgetComponentPr
longitude: options.location.longitude,
};
const { data: weather } = clientApi.widget.weather.atLocation.useQuery(input, {
refetchOnMount: false,
staleTime: 60 * 1000,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
});