Files
dbx/apps/desktop/src/composables/__tests__/useBackgroundImage.spec.ts
T

163 lines
7.9 KiB
TypeScript
Vendored

// @vitest-environment happy-dom
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { effectScope, reactive, type EffectScope } from "vue";
import { BACKGROUND_IMAGE_ACTIVE_CLASS, useBackgroundImage as createBackgroundImage } from "@/composables/useBackgroundImage";
import { useTheme } from "@/composables/useTheme";
import { defaultBackgroundImageSettings, type BackgroundImageSettings } from "@/lib/app/appBackgroundImage";
const readBackgroundImageMock = vi.hoisted(() => vi.fn());
vi.mock("@/lib/backend/api", () => ({
readBackgroundImage: readBackgroundImageMock,
}));
vi.mock("@/lib/backend/tauriRuntime", () => ({ isTauriRuntime: () => false }));
let scope: EffectScope;
function useBackgroundImage(settings: Parameters<typeof createBackgroundImage>[0]) {
return scope.run(() => createBackgroundImage(settings))!;
}
function settingsWith(overrides: Partial<BackgroundImageSettings>) {
const base = defaultBackgroundImageSettings();
return { editorSettings: reactive({ backgroundImage: { ...base, ...overrides } }) } as Parameters<typeof useBackgroundImage>[0];
}
describe("useBackgroundImage", () => {
beforeEach(() => {
scope = effectScope();
vi.resetModules();
readBackgroundImageMock.mockReset();
(globalThis as Record<string, unknown>).__TAURI_INTERNALS__ = {};
document.documentElement.className = "";
document.documentElement.removeAttribute("style");
});
afterEach(() => scope.stop());
it("reports no active background without a configured file", () => {
const bg = useBackgroundImage(settingsWith({}));
expect(bg.backgroundObjectUrl.value).toBeNull();
expect(bg.active.value).toBe(false);
expect(document.documentElement.classList.contains(BACKGROUND_IMAGE_ACTIVE_CLASS)).toBe(false);
});
it("loads the configured file into an object URL and toggles the global wallpaper class", async () => {
const createObjectURL = vi.fn(() => "blob:bg-1");
const revokeObjectURL = vi.fn();
Object.defineProperty(URL, "createObjectURL", { value: createObjectURL, configurable: true, writable: true });
Object.defineProperty(URL, "revokeObjectURL", { value: revokeObjectURL, configurable: true, writable: true });
readBackgroundImageMock.mockResolvedValue("aGVsbG8=");
const bg = useBackgroundImage(settingsWith({ filePath: "/data/background-image.png", fileName: "wall.png" }));
await vi.waitFor(() => expect(bg.backgroundObjectUrl.value).toBe("blob:bg-1"));
expect(bg.active.value).toBe(true);
expect(document.documentElement.classList.contains(BACKGROUND_IMAGE_ACTIVE_CLASS)).toBe(true);
});
it("falls back to no background when the file cannot be read", async () => {
readBackgroundImageMock.mockRejectedValue(new Error("gone"));
const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
const bg = useBackgroundImage(settingsWith({ filePath: "/data/background-image.png" }));
await vi.waitFor(() => expect(readBackgroundImageMock).toHaveBeenCalled());
await Promise.resolve();
expect(bg.backgroundObjectUrl.value).toBeNull();
expect(bg.active.value).toBe(false);
expect(document.documentElement.classList.contains(BACKGROUND_IMAGE_ACTIVE_CLASS)).toBe(false);
expect(warnSpy).toHaveBeenCalledTimes(1);
warnSpy.mockRestore();
});
it("tints custom palette surface colors from the custom color settings while active", async () => {
const theme = useTheme();
const originalMode = theme.themeMode.value;
const originalPalette = theme.themePalette.value;
const originalColors = { ...theme.customUiColors.value };
theme.setThemeMode("light");
theme.setCustomUiColors({ ...originalColors, background: "#123456", sidebar: "#654321" });
theme.setThemePalette("custom");
const createObjectURL = vi.fn(() => "blob:bg-custom");
Object.defineProperty(URL, "createObjectURL", { value: createObjectURL, configurable: true, writable: true });
readBackgroundImageMock.mockResolvedValue("aGVsbG8=");
try {
const bg = useBackgroundImage(settingsWith({ filePath: "/data/background-image.png", opacity: 0.5 }));
await vi.waitFor(() => expect(bg.active.value).toBe(true));
await vi.waitFor(() => {
expect(document.documentElement.style.getPropertyValue("--background")).toBe("rgb(18 52 86 / 0.5)");
expect(document.documentElement.style.getPropertyValue("--sidebar")).toBe("rgb(101 67 33 / 0.5)");
});
} finally {
theme.setCustomUiColors(originalColors);
theme.setThemeMode(originalMode);
theme.setThemePalette(originalPalette);
}
});
it("keeps an opaque companion for inverted text while the surfaces turn translucent", async () => {
const theme = useTheme();
const originalMode = theme.themeMode.value;
const originalPalette = theme.themePalette.value;
const originalColors = { ...theme.customUiColors.value };
theme.setThemeMode("light");
theme.setCustomUiColors({ ...originalColors, background: "#123456" });
theme.setThemePalette("custom");
const createObjectURL = vi.fn(() => "blob:bg-solid");
Object.defineProperty(URL, "createObjectURL", { value: createObjectURL, configurable: true, writable: true });
readBackgroundImageMock.mockResolvedValue("aGVsbG8=");
try {
const settings = settingsWith({ filePath: "/data/background-image.png", opacity: 0.3 });
const bg = useBackgroundImage(settings);
await vi.waitFor(() => expect(bg.active.value).toBe(true));
await vi.waitFor(() => {
// The surface itself goes translucent so the wallpaper shows through...
expect(document.documentElement.style.getPropertyValue("--background")).toBe("rgb(18 52 86 / 0.3)");
// ...but the color used as text on `bg-foreground` widgets stays opaque,
// otherwise tooltip/toast glyphs wash out (#8678).
expect(document.documentElement.style.getPropertyValue("--background-solid")).toBe("rgb(18 52 86)");
});
// No other surface grows a companion: only the inverted-text vars do.
expect(document.documentElement.style.getPropertyValue("--sidebar-solid")).toBe("");
settings.editorSettings.backgroundImage = { ...defaultBackgroundImageSettings() };
await vi.waitFor(() => expect(bg.active.value).toBe(false));
await vi.waitFor(() => {
expect(document.documentElement.style.getPropertyValue("--background-solid")).toBe("");
});
// Inactive: the custom palette's own inline value is restored untouched.
expect(document.documentElement.style.getPropertyValue("--background")).toBe("rgb(18 52 86)");
} finally {
theme.setCustomUiColors(originalColors);
theme.setThemeMode(originalMode);
theme.setThemePalette(originalPalette);
}
});
it("re-emits custom palette inline surface colors when the wallpaper is inactive", async () => {
const theme = useTheme();
const originalMode = theme.themeMode.value;
const originalPalette = theme.themePalette.value;
const originalColors = { ...theme.customUiColors.value };
theme.setThemeMode("light");
theme.setCustomUiColors({ ...originalColors, background: "#123456", sidebar: "#654321" });
theme.setThemePalette("custom");
try {
// applyCustomUiColors has just written these inline values for the custom palette.
document.documentElement.style.setProperty("--background", "rgb(18 52 86)");
document.documentElement.style.setProperty("--sidebar", "rgb(101 67 33)");
const bg = useBackgroundImage(settingsWith({}));
await vi.waitFor(() => {
expect(document.documentElement.style.getPropertyValue("--background")).toBe("rgb(18 52 86)");
expect(document.documentElement.style.getPropertyValue("--sidebar")).toBe("rgb(101 67 33)");
});
expect(bg.active.value).toBe(false);
} finally {
theme.setCustomUiColors(originalColors);
theme.setThemeMode(originalMode);
theme.setThemePalette(originalPalette);
}
});
});