fix: keep watcher save state visible (#2037)

This commit is contained in:
Carlos Florêncio
2026-07-29 14:05:38 +01:00
committed by GitHub
parent c96b893174
commit 1f19dbe6d5
11 changed files with 557 additions and 10 deletions
@@ -1,9 +1,11 @@
import { cleanup, fireEvent, render, screen, waitFor } from "@testing-library/react";
import { useState } from "react";
import { afterEach, describe, expect, it, vi } from "vitest";
import { SettingsSaveProvider } from "@/components/settings/settings-save-provider";
import { useWatcherEnabledDrafts } from "./use-watcher-enabled-drafts";
const watch = { id: "watch-1", enabled: true };
const saveChangesLabel = "Save changes";
afterEach(cleanup);
@@ -23,6 +25,61 @@ function Harness({ save }: { save: (enabled: boolean) => Promise<void> }) {
);
}
function ReconciliationHarness({ save }: { save: (enabled: boolean) => Promise<void> }) {
const [items, setItems] = useState([watch]);
const drafts = useWatcherEnabledDrafts({
id: "test-watches",
items,
saveEnabled: (_watch, enabled) => save(enabled),
});
return (
<>
<button onClick={() => drafts.toggleEnabled(drafts.items[0])}>
{drafts.items[0].enabled ? "Disable" : "Enable"}
</button>
<button
data-testid="authoritative-paused"
onClick={() => setItems([{ ...watch, enabled: false }])}
/>
<button
data-testid="authoritative-active"
onClick={() => setItems([{ ...watch, enabled: true }])}
/>
</>
);
}
function InFlightReconciliationHarness({
onSaveReady,
}: {
onSaveReady: (resolve: () => void) => void;
}) {
const [items, setItems] = useState([watch]);
const drafts = useWatcherEnabledDrafts({
id: "test-watches",
items,
saveEnabled: (_watch, _enabled) =>
new Promise<void>((resolve) => {
onSaveReady(resolve);
}),
});
return (
<>
<button onClick={() => drafts.toggleEnabled(drafts.items[0])}>
{drafts.items[0].enabled ? "Disable" : "Enable"}
</button>
<button
data-testid="authoritative-paused"
onClick={() => setItems([{ ...watch, enabled: false }])}
/>
<button
data-testid="authoritative-active"
onClick={() => setItems([{ ...watch, enabled: true }])}
/>
</>
);
}
describe("useWatcherEnabledDrafts", () => {
it("returns to a clean state when a watcher is toggled twice", () => {
const save = vi.fn().mockResolvedValue(undefined);
@@ -35,7 +92,7 @@ describe("useWatcherEnabledDrafts", () => {
fireEvent.click(screen.getByRole("button", { name: "Disable" }));
fireEvent.click(screen.getByRole("button", { name: "Enable" }));
expect(screen.queryByRole("button", { name: "Save changes" })).toBeNull();
expect(screen.queryByRole("button", { name: saveChangesLabel })).toBeNull();
expect(save).not.toHaveBeenCalled();
});
@@ -62,13 +119,68 @@ describe("useWatcherEnabledDrafts", () => {
fireEvent.click(screen.getByRole("button", { name: "Disable" }));
expect(save).not.toHaveBeenCalled();
fireEvent.click(screen.getByRole("button", { name: "Save changes" }));
fireEvent.click(screen.getByRole("button", { name: saveChangesLabel }));
await waitFor(() => expect(screen.getByText("Couldn't save")).toBeTruthy());
expect(screen.getByRole("button", { name: "Retry save" })).toBeTruthy();
fireEvent.click(screen.getByRole("button", { name: "Retry save" }));
await waitFor(() => expect(save).toHaveBeenCalledTimes(2));
await waitFor(() => expect(screen.queryByRole("button", { name: "Save changes" })).toBeNull());
await waitFor(() =>
expect(screen.queryByRole("button", { name: saveChangesLabel })).toBeNull(),
);
});
it("keeps a saved watcher state visible while the authoritative list is stale", async () => {
const save = vi.fn().mockResolvedValue(undefined);
render(
<SettingsSaveProvider>
<Harness save={save} />
</SettingsSaveProvider>,
);
fireEvent.click(screen.getByRole("button", { name: "Disable" }));
fireEvent.click(screen.getByRole("button", { name: saveChangesLabel }));
await waitFor(() => expect(save).toHaveBeenCalledWith(false));
expect(screen.getByRole("button", { name: "Enable" })).toBeTruthy();
expect(screen.queryByRole("button", { name: saveChangesLabel })).toBeNull();
});
it("reconciles the saved baseline when authoritative items catch up", async () => {
const save = vi.fn().mockResolvedValue(undefined);
render(
<SettingsSaveProvider>
<ReconciliationHarness save={save} />
</SettingsSaveProvider>,
);
fireEvent.click(screen.getByRole("button", { name: "Disable" }));
fireEvent.click(screen.getByRole("button", { name: saveChangesLabel }));
await waitFor(() => expect(screen.getByRole("button", { name: "Enable" })).toBeTruthy());
fireEvent.click(screen.getByTestId("authoritative-paused"));
await waitFor(() => expect(screen.getByRole("button", { name: "Enable" })).toBeTruthy());
fireEvent.click(screen.getByTestId("authoritative-active"));
await waitFor(() => expect(screen.getByRole("button", { name: "Disable" })).toBeTruthy());
});
it("reconciles when authoritative data catches up before save resolves", async () => {
let resolveSave = () => {};
render(
<SettingsSaveProvider>
<InFlightReconciliationHarness onSaveReady={(resolve) => (resolveSave = resolve)} />
</SettingsSaveProvider>,
);
fireEvent.click(screen.getByRole("button", { name: "Disable" }));
fireEvent.click(screen.getByRole("button", { name: saveChangesLabel }));
fireEvent.click(screen.getByTestId("authoritative-paused"));
resolveSave();
await waitFor(() => expect(screen.getByRole("button", { name: "Enable" })).toBeTruthy());
fireEvent.click(screen.getByTestId("authoritative-active"));
await waitFor(() => expect(screen.getByRole("button", { name: "Disable" })).toBeTruthy());
});
});
@@ -1,6 +1,6 @@
"use client";
import { useCallback, useMemo, useState } from "react";
import { useCallback, useEffect, useMemo, useState } from "react";
import { useSettingsSaveContributor } from "@/components/settings/settings-save-provider";
type EnabledItem = { id: string; enabled: boolean };
@@ -17,17 +17,39 @@ export function useWatcherEnabledDrafts<T extends EnabledItem>({
saveEnabled,
}: WatcherEnabledDraftOptions<T>) {
const [drafts, setDrafts] = useState<Record<string, boolean>>({});
const [saved, setSaved] = useState<Record<string, boolean>>({});
useEffect(() => {
setSaved((current) => {
let changed = false;
const next = { ...current };
for (const [id, enabled] of Object.entries(current)) {
const item = items.find((candidate) => candidate.id === id);
if (!item || item.enabled === enabled) {
delete next[id];
changed = true;
}
}
return changed ? next : current;
});
}, [items, saved]);
const changes = useMemo(
() =>
items
.filter((item) => drafts[item.id] !== undefined && drafts[item.id] !== item.enabled)
.filter(
(item) =>
drafts[item.id] !== undefined && drafts[item.id] !== (saved[item.id] ?? item.enabled),
)
.map((item) => ({ item, enabled: drafts[item.id] }))
.sort((left, right) => left.item.id.localeCompare(right.item.id)),
[drafts, items],
[drafts, items, saved],
);
const draftItems = useMemo(
() => items.map((item) => ({ ...item, enabled: drafts[item.id] ?? item.enabled })),
[drafts, items],
() =>
items.map((item) => ({
...item,
enabled: drafts[item.id] ?? saved[item.id] ?? item.enabled,
})),
[drafts, items, saved],
);
const dirtyIds = useMemo(() => new Set(changes.map(({ item }) => item.id)), [changes]);
@@ -42,6 +64,7 @@ export function useWatcherEnabledDrafts<T extends EnabledItem>({
const results = await Promise.allSettled(
changes.map(async ({ item, enabled }) => {
await saveEnabled(item, enabled);
setSaved((current) => ({ ...current, [item.id]: enabled }));
setDrafts((current) => {
if (current[item.id] !== enabled) return current;
const next = { ...current };