321 lines
15 KiB
TypeScript
Vendored
321 lines
15 KiB
TypeScript
Vendored
// @vitest-environment happy-dom
|
||
|
||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||
import { CODE_SNAPSHOT_CSS, materializeSnapshotCloneLineNumbers, renderCodeSnapshotHtml, savePngDataUrlToFile, snapshotElementToPng } from "@/lib/codeSnapshot/codeSnapshot";
|
||
import { LEGACY_WEBVIEW_CLASS } from "@/lib/ui/legacyWebView";
|
||
|
||
const { createCodeHighlighter, highlightCode, toPng, isTauriRuntime, save, writeFile } = vi.hoisted(() => {
|
||
const highlightCode = vi.fn((content: string, _lang: string) => `<span class="line">${content}</span>`);
|
||
return {
|
||
createCodeHighlighter: vi.fn(async () => highlightCode),
|
||
highlightCode,
|
||
toPng: vi.fn(),
|
||
isTauriRuntime: vi.fn(),
|
||
save: vi.fn(),
|
||
writeFile: vi.fn(),
|
||
};
|
||
});
|
||
|
||
vi.mock("@/lib/ai/aiCodeHighlighter", () => ({
|
||
createAiShikiBlockCodeHighlighter: createCodeHighlighter,
|
||
}));
|
||
|
||
vi.mock("dom-to-image-more", () => ({
|
||
default: { toPng },
|
||
}));
|
||
|
||
vi.mock("@/lib/backend/tauriRuntime", () => ({
|
||
isTauriRuntime,
|
||
}));
|
||
|
||
vi.mock("@tauri-apps/plugin-dialog", () => ({ save }));
|
||
vi.mock("@tauri-apps/plugin-fs", () => ({ writeFile }));
|
||
|
||
beforeEach(() => {
|
||
createCodeHighlighter.mockResolvedValue(highlightCode);
|
||
highlightCode.mockClear();
|
||
highlightCode.mockImplementation((content: string) => `<span class="line">${content}</span>`);
|
||
});
|
||
|
||
describe("renderCodeSnapshotHtml", () => {
|
||
it("falls back to safe text when the code highlighter cannot initialize", async () => {
|
||
createCodeHighlighter.mockRejectedValueOnce(new SyntaxError("Invalid regular expression: invalid group specifier name"));
|
||
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT <初始化失败>", lang: "sql" }, { appearance: "light" });
|
||
|
||
expect(html).toContain('<code><span class="line">SELECT <初始化失败></span></code>');
|
||
});
|
||
|
||
it("falls back to safe line-preserving text when legacy WebKit cannot compile highlighting regexes", async () => {
|
||
highlightCode.mockImplementationOnce(() => {
|
||
throw new SyntaxError("Invalid regular expression: invalid group specifier name");
|
||
});
|
||
|
||
const html = await renderCodeSnapshotHtml({ code: `SELECT '<用户>&" 😀'\r\n-- 第二行\n`, lang: "sql" }, { appearance: "light" });
|
||
|
||
expect(html).toContain('<code><span class="line">SELECT '<用户>&" 😀'</span><span class="line">-- 第二行</span><span class="line"></span></code>');
|
||
expect(html).not.toContain("<用户>");
|
||
expect(html.match(/class="line"/g)).toHaveLength(3);
|
||
});
|
||
|
||
it("renders large fallback selections with one highlighter attempt", async () => {
|
||
const code = Array.from({ length: 5_000 }, (_, index) => `SELECT ${index}`).join("\n");
|
||
highlightCode.mockImplementationOnce(() => {
|
||
throw new SyntaxError("Invalid regular expression: invalid group specifier name");
|
||
});
|
||
|
||
const html = await renderCodeSnapshotHtml({ code, lang: "sql" }, { appearance: "dark" });
|
||
|
||
expect(highlightCode).toHaveBeenCalledOnce();
|
||
expect(html.match(/class="line"/g)).toHaveLength(5_000);
|
||
});
|
||
|
||
it("renders a self-contained snapshot with embedded styles", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql" }, { appearance: "dark" });
|
||
|
||
expect(html).toContain("<style>");
|
||
expect(html).toContain(CODE_SNAPSHOT_CSS);
|
||
expect(html).toContain('class="dbx-code-snapshot"');
|
||
expect(html).toContain('data-snapshot-appearance="dark"');
|
||
expect(html).toContain('class="dbx-code-snapshot__pre dbx-code-snapshot__pre--numbered"');
|
||
expect(html).toContain(".dbx-code-snapshot *");
|
||
expect(html).toContain("border: 0");
|
||
expect(html).toContain("outline: 0");
|
||
expect(html).toContain(".dbx-code-snapshot__line-number");
|
||
});
|
||
|
||
it("renders macOS traffic lights and an optional title by default", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql", title: "Query example" }, { appearance: "dark" });
|
||
|
||
expect(html).toContain('class="dbx-code-snapshot__bar"');
|
||
expect(html).toContain("#ff5f57");
|
||
expect(html).toContain("#febc2e");
|
||
expect(html).toContain("#28c840");
|
||
expect(html).toContain("Query example");
|
||
});
|
||
|
||
it("hides the bar when traffic lights are disabled and no title is set", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql" }, { appearance: "light", showTrafficLights: false });
|
||
|
||
expect(html).not.toContain('class="dbx-code-snapshot__bar"');
|
||
});
|
||
|
||
it("keeps the title bar but hides traffic lights when window controls are disabled", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql", title: "Query example" }, { appearance: "dark", showTrafficLights: false });
|
||
|
||
expect(html).toContain('class="dbx-code-snapshot__bar"');
|
||
expect(html).toContain("Query example");
|
||
expect(html).not.toContain('class="dbx-code-snapshot__dot"');
|
||
});
|
||
|
||
it("hides line numbers when disabled", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql" }, { appearance: "light", showLineNumbers: false });
|
||
|
||
expect(html).toContain('class="dbx-code-snapshot__pre"');
|
||
expect(html).not.toContain('class="dbx-code-snapshot__pre dbx-code-snapshot__pre--numbered"');
|
||
});
|
||
|
||
it("gives SQL table names their own color, distinct from quoted fields", async () => {
|
||
// Mirror shiki's classic structure: one .line span per source line.
|
||
highlightCode.mockImplementation((content: string) =>
|
||
content
|
||
.split(/\r\n|\r|\n/)
|
||
.map((line) => `<span class="line">${line}</span>`)
|
||
.join(""),
|
||
);
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT `id`, `title`\nFROM `tb_book`;", lang: "sql" }, { appearance: "light" });
|
||
|
||
expect(html).toContain('data-sql-token="table"');
|
||
expect(html).toContain("color:#116329");
|
||
// Only the table name is marked; the selected fields keep the identifier color.
|
||
expect(html.match(/data-sql-token="table"/g)).toHaveLength(1);
|
||
expect(html).toMatch(/data-sql-token="table"[^>]*>`?tb_book`</);
|
||
expect(html).not.toMatch(/data-sql-token="table"[^>]*>`?id</);
|
||
});
|
||
|
||
it("marks every table across FROM lists, aliases and JOIN clauses", async () => {
|
||
highlightCode.mockImplementation((content: string) =>
|
||
content
|
||
.split(/\r\n|\r|\n/)
|
||
.map((line) => `<span class="line">${line}</span>`)
|
||
.join(""),
|
||
);
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT *\nFROM users u, orders o\nJOIN items i ON i.order_id = u.id", lang: "sql" }, { appearance: "dark" });
|
||
|
||
expect(html).toContain("color:#7ee787");
|
||
for (const table of ["users", "orders", "items"]) {
|
||
expect(html).toMatch(new RegExp(`data-sql-token="table"[^>]*>${table}</span>`));
|
||
}
|
||
// Fields referenced in the projection and join condition stay unmarked.
|
||
expect(html.match(/data-sql-token="table"/g)).toHaveLength(3);
|
||
});
|
||
|
||
it("maps table offsets correctly across CRLF line breaks", async () => {
|
||
highlightCode.mockImplementation((content: string) =>
|
||
content
|
||
.split(/\r\n|\r|\n/)
|
||
.map((line) => `<span class="line">${line}</span>`)
|
||
.join(""),
|
||
);
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT `id`\r\nFROM `tb_book`", lang: "sql" }, { appearance: "light" });
|
||
|
||
expect(html).toMatch(/data-sql-token="table"[^>]*>`?tb_book`</);
|
||
expect(html).not.toMatch(/data-sql-token="table"[^>]*>`?id</);
|
||
});
|
||
|
||
it("skips table-name marking for non-SQL languages", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "from app import models", lang: "python" }, { appearance: "light" });
|
||
|
||
expect(html).not.toContain('data-sql-token="table"');
|
||
});
|
||
|
||
it("escapes the snapshot title", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql", title: `<script>alert(1)</script>` }, { appearance: "dark" });
|
||
|
||
expect(html).toContain("<script>");
|
||
expect(html).not.toContain("<script>alert(1)</script>");
|
||
});
|
||
|
||
it("applies the appearance-specific background and line-number color", async () => {
|
||
const dark = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql" }, { appearance: "dark" });
|
||
const light = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql" }, { appearance: "light" });
|
||
|
||
expect(dark).toContain("background:#0d1117");
|
||
expect(dark).toContain("--dbx-snapshot-line-number:#484f58");
|
||
expect(dark).toContain("color:#e1e4e8");
|
||
expect(light).toContain("background:#ffffff");
|
||
expect(light).toContain("--dbx-snapshot-line-number:#d0d7de");
|
||
expect(light).toContain("color:#24292f");
|
||
});
|
||
|
||
it("applies custom padding and font size", async () => {
|
||
const html = await renderCodeSnapshotHtml({ code: "SELECT 1", lang: "sql" }, { appearance: "dark", padding: 24, fontSize: 15 });
|
||
|
||
expect(html).toContain("font-size:15px");
|
||
expect(html).toContain("padding:0 24px 24px");
|
||
});
|
||
|
||
it("materializes real line-number nodes in the export clone", () => {
|
||
document.body.innerHTML = '<div class="dbx-code-snapshot"><pre class="dbx-code-snapshot__pre dbx-code-snapshot__pre--numbered"><code><span class="line">SELECT 1</span><span class="line">FROM dual</span></code></pre></div>';
|
||
const root = document.body.firstElementChild as HTMLElement;
|
||
|
||
materializeSnapshotCloneLineNumbers(root);
|
||
|
||
const pre = root.querySelector(".dbx-code-snapshot__pre") as HTMLElement;
|
||
const lines = Array.from(root.querySelectorAll<HTMLElement>("code > .line"));
|
||
expect(pre.classList.contains("dbx-code-snapshot__pre--numbered")).toBe(false);
|
||
expect(lines).toHaveLength(2);
|
||
expect(lines[0]?.querySelector(".dbx-code-snapshot__line-number")?.textContent).toBe("1");
|
||
expect(lines[1]?.querySelector(".dbx-code-snapshot__line-number")?.textContent).toBe("2");
|
||
expect(lines[0]?.querySelector(".dbx-code-snapshot__line-content")?.textContent).toBe("SELECT 1");
|
||
expect(lines[1]?.querySelector(".dbx-code-snapshot__line-content")?.textContent).toBe("FROM dual");
|
||
});
|
||
|
||
it("exports at a capped device-pixel ratio for crisp high-DPI snapshots", async () => {
|
||
toPng.mockResolvedValue("data:image/png;base64,test");
|
||
vi.stubGlobal("window", { devicePixelRatio: 3 });
|
||
try {
|
||
await snapshotElementToPng({ offsetWidth: 320, offsetHeight: 160, scrollWidth: 640, scrollHeight: 240 } as HTMLElement);
|
||
|
||
const options = toPng.mock.calls.at(-1)?.[1];
|
||
expect(toPng).toHaveBeenLastCalledWith(
|
||
expect.anything(),
|
||
expect.objectContaining({
|
||
width: 640,
|
||
height: 240,
|
||
scale: 2,
|
||
style: {
|
||
width: "640px",
|
||
height: "240px",
|
||
},
|
||
}),
|
||
);
|
||
expect(options?.adjustPseudoElement).toBeUndefined();
|
||
expect(options?.onclone).toBeUndefined();
|
||
|
||
vi.stubGlobal("window", { devicePixelRatio: 0 });
|
||
await snapshotElementToPng({ offsetWidth: 320, offsetHeight: 160, scrollWidth: 320, scrollHeight: 160 } as HTMLElement);
|
||
expect(toPng).toHaveBeenLastCalledWith(expect.anything(), expect.objectContaining({ scale: 1 }));
|
||
} finally {
|
||
vi.unstubAllGlobals();
|
||
}
|
||
});
|
||
|
||
it("enables the legacy WebView export fallback only when the runtime is marked legacy", async () => {
|
||
toPng.mockResolvedValue("data:image/png;base64,test");
|
||
document.documentElement.classList.add(LEGACY_WEBVIEW_CLASS);
|
||
try {
|
||
await snapshotElementToPng({ offsetWidth: 320, offsetHeight: 160, scrollWidth: 320, scrollHeight: 160 } as HTMLElement);
|
||
|
||
const options = toPng.mock.calls.at(-1)?.[1];
|
||
expect(typeof options?.adjustPseudoElement).toBe("function");
|
||
expect(typeof options?.onclone).toBe("function");
|
||
expect(options.adjustPseudoElement?.(document.createElement("span"), ":after", {} as CSSStyleDeclaration)).toBeUndefined();
|
||
|
||
const clone = document.createElement("div");
|
||
clone.innerHTML = '<div class="dbx-code-snapshot"><pre class="dbx-code-snapshot__pre dbx-code-snapshot__pre--numbered" style="--dbx-snapshot-line-number:#d0d7de"><code><span class="line">SELECT 1</span><span class="line">FROM dual</span></code></pre></div>';
|
||
options.onclone?.(clone);
|
||
|
||
const line = clone.querySelector<HTMLElement>(".dbx-code-snapshot__line-number");
|
||
expect(line?.textContent).toBe("1");
|
||
expect(line?.getAttribute("style")).toContain("display: inline-block");
|
||
expect(line?.getAttribute("style")).toContain("margin-right: 1.4em");
|
||
expect(line?.getAttribute("style")).toContain("color: #d0d7de");
|
||
} finally {
|
||
document.documentElement.classList.remove(LEGACY_WEBVIEW_CLASS);
|
||
}
|
||
});
|
||
|
||
it("reduces the export scale when a wide snapshot reaches the canvas edge limit", async () => {
|
||
toPng.mockResolvedValue("data:image/png;base64,test");
|
||
vi.stubGlobal("window", { devicePixelRatio: 2 });
|
||
try {
|
||
await snapshotElementToPng({ offsetWidth: 10_000, offsetHeight: 100, scrollWidth: 10_000, scrollHeight: 100 } as HTMLElement);
|
||
|
||
expect(toPng).toHaveBeenLastCalledWith(expect.anything(), expect.objectContaining({ scale: 16_384 / 10_000 }));
|
||
} finally {
|
||
vi.unstubAllGlobals();
|
||
}
|
||
});
|
||
|
||
it("reduces the export scale when a tall snapshot reaches the canvas edge limit", async () => {
|
||
toPng.mockResolvedValue("data:image/png;base64,test");
|
||
vi.stubGlobal("window", { devicePixelRatio: 2 });
|
||
try {
|
||
await snapshotElementToPng({ offsetWidth: 100, offsetHeight: 10_000, scrollWidth: 100, scrollHeight: 10_000 } as HTMLElement);
|
||
|
||
expect(toPng).toHaveBeenLastCalledWith(expect.anything(), expect.objectContaining({ scale: 16_384 / 10_000 }));
|
||
} finally {
|
||
vi.unstubAllGlobals();
|
||
}
|
||
});
|
||
|
||
it("reduces the export scale when a dense snapshot reaches the total pixel limit", async () => {
|
||
toPng.mockResolvedValue("data:image/png;base64,test");
|
||
vi.stubGlobal("window", { devicePixelRatio: 2 });
|
||
try {
|
||
await snapshotElementToPng({ offsetWidth: 6_000, offsetHeight: 6_000, scrollWidth: 6_000, scrollHeight: 6_000 } as HTMLElement);
|
||
|
||
expect(toPng).toHaveBeenLastCalledWith(expect.anything(), expect.objectContaining({ scale: Math.sqrt((64 * 1024 * 1024) / (6_000 * 6_000)) }));
|
||
} finally {
|
||
vi.unstubAllGlobals();
|
||
}
|
||
});
|
||
|
||
it("rejects snapshots that exceed the safe rendering budget at 1x", async () => {
|
||
toPng.mockClear();
|
||
|
||
await expect(snapshotElementToPng({ offsetWidth: 20_000, offsetHeight: 100, scrollWidth: 20_000, scrollHeight: 100 } as HTMLElement)).rejects.toThrow("Snapshot is too large to export safely (20000 × 100px)");
|
||
expect(toPng).not.toHaveBeenCalled();
|
||
});
|
||
|
||
it("propagates a failed native save instead of reporting a browser download", async () => {
|
||
isTauriRuntime.mockReturnValue(true);
|
||
save.mockResolvedValue("C:\\Users\\example\\snapshot.png");
|
||
writeFile.mockRejectedValue(new Error("disk full"));
|
||
|
||
await expect(savePngDataUrlToFile("data:image/png;base64,AA==", "snapshot.png")).rejects.toThrow("disk full");
|
||
expect(writeFile).toHaveBeenCalledOnce();
|
||
});
|
||
});
|