fix: address widget reload review findings

This commit is contained in:
Thomas Camlong committed 2026-08-23 09:00:33 +02:00
1 parent 357355283c
commit 65a96b6b14
10 files changed
+206 -29

No files matched your search

+5 -1
View File
@@ -4,6 +4,7 @@ import { Box, Center, Stack, Text, Title } from "@mantine/core";
import dayjs from "dayjs";
import advancedFormat from "dayjs/plugin/advancedFormat";
import { useWidgetLocalTimeZone } from "../common/widget-time-context";
import type { WidgetComponentProps } from "../definition";
import { AdvancedClockView } from "./advanced-view";
import { clockTimeFormatShowsSeconds, resolveClockTimeFormat } from "./format";
@@ -17,7 +18,10 @@ export default function ClockWidget({ options, width, height, displayMode }: Wid
const isAdvanced = displayMode === "advanced";
const showSeconds = clockTimeFormatShowsSeconds(options.customTimeFormat);
const time = useCurrentTime({ showSeconds });
const requestedTimeZone = options.useCustomTimezone ? options.timezone : getResolvedLocalTimeZone();
const initialLocalTimeZone = useWidgetLocalTimeZone();
const requestedTimeZone = options.useCustomTimezone
? options.timezone
: (initialLocalTimeZone ?? getResolvedLocalTimeZone());
const primaryTimeZoneInvalid = !isTimeZoneSupported(requestedTimeZone);
const primaryTimeZone = primaryTimeZoneInvalid ? "UTC" : requestedTimeZone;
const zonedTime = time === null ? null : dayjs(time).tz(primaryTimeZone);
@@ -6,9 +6,13 @@ import { renderToString } from "react-dom/server";
import { afterEach, describe, expect, test, vi } from "vitest";
import { useWidgetNow } from "./use-widget-now";
import { WidgetTimeProvider } from "./widget-time-context";
import { useWidgetLocalTimeZone, WidgetTimeProvider } from "./widget-time-context";
const TimeProbe = () => <time>{useWidgetNow("minute")?.toISOString() ?? "missing"}</time>;
const TimeProbe = () => (
<time>
{useWidgetNow("minute")?.toISOString() ?? "missing"}|{useWidgetLocalTimeZone() ?? "missing"}
</time>
);
afterEach(() => {
vi.useRealTimers();
@@ -16,12 +20,13 @@ afterEach(() => {
});
describe("WidgetTimeProvider", () => {
test("uses the same non-placeholder timestamp for server rendering and hydration", async () => {
test("hydrates with server time and timezone before switching to browser values", async () => {
vi.useFakeTimers();
const timestamp = new Date("2026-08-22T12:34:00.000Z").getTime();
vi.setSystemTime(timestamp);
const serverTimestamp = new Date("2026-08-22T12:34:00.000Z").getTime();
const clientTimestamp = serverTimestamp + 60_000;
vi.setSystemTime(serverTimestamp);
const content = (
<WidgetTimeProvider initialTimestamp={timestamp}>
<WidgetTimeProvider initialTimestamp={serverTimestamp} initialTimeZone="UTC">
<TimeProbe />
</WidgetTimeProvider>
);
@@ -29,11 +34,15 @@ describe("WidgetTimeProvider", () => {
const host = document.createElement("div");
host.innerHTML = html;
const consoleError = vi.spyOn(console, "error").mockImplementation(() => undefined);
vi.spyOn(Intl.DateTimeFormat.prototype, "resolvedOptions").mockReturnValue({
timeZone: "Europe/Paris",
} as Intl.ResolvedDateTimeFormatOptions);
vi.setSystemTime(clientTimestamp);
expect(host.textContent).toBe("2026-08-22T12:34:00.000Z");
expect(host.textContent).toBe("2026-08-22T12:34:00.000Z|UTC");
const root = hydrateRoot(host, content);
await act(async () => undefined);
expect(host.textContent).toBe("2026-08-22T12:34:00.000Z");
expect(host.textContent).toBe("2026-08-22T12:35:00.000Z|Europe/Paris");
expect(consoleError).not.toHaveBeenCalled();
await act(async () => root.unmount());
@@ -1,12 +1,46 @@
"use client";
import type { PropsWithChildren } from "react";
import { createContext, useContext } from "react";
import { createContext, useContext, useEffect, useMemo, useState } from "react";
const WidgetTimeContext = createContext<number | null>(null);
interface WidgetTimeContextValue {
initialTimestamp: number | null;
localTimeZone: string | null;
}
export const WidgetTimeProvider = ({ children, initialTimestamp }: PropsWithChildren<{ initialTimestamp: number }>) => (
<WidgetTimeContext.Provider value={initialTimestamp}>{children}</WidgetTimeContext.Provider>
);
const WidgetTimeContext = createContext<WidgetTimeContextValue>({ initialTimestamp: null, localTimeZone: null });
export const useWidgetInitialTimestamp = () => useContext(WidgetTimeContext);
interface WidgetTimeProviderProps {
initialTimestamp: number;
initialTimeZone: string;
}
export const WidgetTimeProvider = ({
children,
initialTimestamp,
initialTimeZone,
}: PropsWithChildren<WidgetTimeProviderProps>) => {
const [localTimeZone, setLocalTimeZone] = useState(() => getSupportedTimeZone(initialTimeZone));
useEffect(() => {
setLocalTimeZone(getResolvedLocalTimeZone());
}, []);
const value = useMemo(() => ({ initialTimestamp, localTimeZone }), [initialTimestamp, localTimeZone]);
return <WidgetTimeContext.Provider value={value}>{children}</WidgetTimeContext.Provider>;
};
export const useWidgetInitialTimestamp = () => useContext(WidgetTimeContext).initialTimestamp;
export const useWidgetLocalTimeZone = () => useContext(WidgetTimeContext).localTimeZone;
const getResolvedLocalTimeZone = () => getSupportedTimeZone(Intl.DateTimeFormat().resolvedOptions().timeZone);
const getSupportedTimeZone = (timeZone: string | undefined) => {
if (!timeZone) return "UTC";
try {
new Intl.DateTimeFormat("en", { timeZone }).format(0);
return timeZone;
} catch {
return "UTC";
}
};
+1 -1
View File
@@ -1,3 +1,3 @@
export { WidgetTimeProvider, useWidgetInitialTimestamp } from "./common/widget-time-context";
export { WidgetTimeProvider, useWidgetInitialTimestamp, useWidgetLocalTimeZone } from "./common/widget-time-context";
export { getNextWidgetTickDelay, useWidgetNow } from "./common/use-widget-now";
export type { WidgetClockPrecision } from "./common/use-widget-now";