114 lines
4.2 KiB
TypeScript
114 lines
4.2 KiB
TypeScript
// @vitest-environment jsdom
|
|
import "@testing-library/jest-dom";
|
|
import { fireEvent, render, screen, waitFor } from "@testing-library/react";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
import { UI_PREFERENCES_STORAGE_KEY, UiPreferencesProvider, useUiPreferences } from "./UiPreferencesContext";
|
|
|
|
const originalLocalStorage = Object.getOwnPropertyDescriptor(window, "localStorage");
|
|
const originalGetAnimations = document.getAnimations;
|
|
|
|
function memoryStorage(): Storage {
|
|
const values = new Map<string, string>();
|
|
return {
|
|
get length() {
|
|
return values.size;
|
|
},
|
|
clear: () => values.clear(),
|
|
getItem: (key) => values.get(key) ?? null,
|
|
key: (index) => [...values.keys()][index] ?? null,
|
|
removeItem: (key) => values.delete(key),
|
|
setItem: (key, value) => values.set(key, value),
|
|
};
|
|
}
|
|
|
|
function PreferenceControls() {
|
|
const { preferences, preferencesReady, setAutoCollapseSidebar, setVisualEffectsEnabled } = useUiPreferences();
|
|
return (
|
|
<>
|
|
<output>ready:{String(preferencesReady)}</output>
|
|
<button onClick={() => setAutoCollapseSidebar(!preferences.autoCollapseSidebar)}>
|
|
auto:{String(preferences.autoCollapseSidebar)}
|
|
</button>
|
|
<button onClick={() => setVisualEffectsEnabled(!preferences.visualEffectsEnabled)}>
|
|
effects:{String(preferences.visualEffectsEnabled)}
|
|
</button>
|
|
</>
|
|
);
|
|
}
|
|
|
|
describe("UiPreferencesProvider", () => {
|
|
beforeEach(() => {
|
|
Object.defineProperty(window, "localStorage", { configurable: true, value: memoryStorage() });
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (originalLocalStorage) Object.defineProperty(window, "localStorage", originalLocalStorage);
|
|
else delete (window as Partial<Window>).localStorage;
|
|
document.getAnimations = originalGetAnimations;
|
|
delete document.documentElement.dataset.hgVisualEffects;
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("restores browser-local preferences and applies the visual-effects mode", async () => {
|
|
window.localStorage.setItem(
|
|
UI_PREFERENCES_STORAGE_KEY,
|
|
JSON.stringify({ autoCollapseSidebar: false, visualEffectsEnabled: false })
|
|
);
|
|
const cancel = vi.fn();
|
|
document.getAnimations = vi.fn(() => [{ cancel }] as unknown as Animation[]);
|
|
|
|
render(
|
|
<UiPreferencesProvider>
|
|
<PreferenceControls />
|
|
</UiPreferencesProvider>
|
|
);
|
|
|
|
await waitFor(() => expect(screen.getByRole("button", { name: "auto:false" })).toBeInTheDocument());
|
|
expect(screen.getByText("ready:true")).toBeInTheDocument();
|
|
expect(screen.getByRole("button", { name: "effects:false" })).toBeInTheDocument();
|
|
expect(document.documentElement).toHaveAttribute("data-hg-visual-effects", "off");
|
|
expect(cancel).toHaveBeenCalledOnce();
|
|
});
|
|
|
|
it("does not expose the default auto-collapse value as ready before stored preferences load", async () => {
|
|
window.localStorage.setItem(
|
|
UI_PREFERENCES_STORAGE_KEY,
|
|
JSON.stringify({ autoCollapseSidebar: false, visualEffectsEnabled: true })
|
|
);
|
|
const renderStates: Array<{ ready: boolean; autoCollapse: boolean }> = [];
|
|
|
|
function PreferenceLifecycleProbe() {
|
|
const { preferences, preferencesReady } = useUiPreferences();
|
|
renderStates.push({ ready: preferencesReady, autoCollapse: preferences.autoCollapseSidebar });
|
|
return null;
|
|
}
|
|
|
|
render(
|
|
<UiPreferencesProvider>
|
|
<PreferenceLifecycleProbe />
|
|
</UiPreferencesProvider>
|
|
);
|
|
|
|
await waitFor(() => expect(renderStates.at(-1)).toEqual({ ready: true, autoCollapse: false }));
|
|
expect(renderStates).not.toContainEqual({ ready: true, autoCollapse: true });
|
|
});
|
|
|
|
it("persists changes and enables or disables effects immediately", () => {
|
|
render(
|
|
<UiPreferencesProvider>
|
|
<PreferenceControls />
|
|
</UiPreferencesProvider>
|
|
);
|
|
|
|
fireEvent.click(screen.getByRole("button", { name: "auto:true" }));
|
|
fireEvent.click(screen.getByRole("button", { name: "effects:true" }));
|
|
|
|
expect(JSON.parse(window.localStorage.getItem(UI_PREFERENCES_STORAGE_KEY) ?? "{}")).toEqual({
|
|
autoCollapseSidebar: false,
|
|
visualEffectsEnabled: false,
|
|
});
|
|
expect(document.documentElement).toHaveAttribute("data-hg-visual-effects", "off");
|
|
});
|
|
});
|