Files
SnapOtter/tests/e2e-docs/sidebar.spec.ts
T
SnapOtterandGitHub e113684ddb test(docs): make search and nav e2e tests hydration-aware (#551)
The docs e2e suite clicked navbar and sidebar controls before Vue hydrated the
multi-locale bundle, so the clicks were swallowed. That raced the Pagefind
search open (filed as #551), the appearance toggle, and the homepage and
sidebar navigation tests. The old search tests also matched an input
placeholder the config overrides, so they failed against a working build.

Add a waitForHydration helper (gates on #app.__vue_app__, set inside Vue's
app.mount()) and an openDocsSearch helper, and route the affected tests through
them. Search itself was never broken; this change is test-only. Docs e2e suite
is green (43/43).

Closes #551
2026-07-18 11:22:38 +08:00

80 lines
3.1 KiB
TypeScript

import { expect, test } from "@playwright/test";
import { waitForHydration } from "./helpers";
test.describe("Docs Sidebar - Guide Section", () => {
test.beforeEach(async ({ page }) => {
await page.goto("/guide/getting-started");
// Sidebar links route client-side; wait for hydration so the click lands
// (otherwise it's swallowed pre-hydration, the #551 race).
await waitForHydration(page);
});
test("sidebar renders all guide links", async ({ page }) => {
const sidebar = page.locator(".VPSidebar, aside");
const guideLinks = [
"Getting started",
"Architecture",
"Configuration",
"SAML SSO",
"SCIM Provisioning",
"Users, Roles & Permissions",
"Database",
"Deployment",
"Docker tags",
"Developer guide",
"Translation guide",
"Contributing",
];
for (const linkText of guideLinks) {
await expect(sidebar.getByText(linkText, { exact: true }).first()).toBeVisible();
}
});
test("sidebar renders API reference links", async ({ page }) => {
const sidebar = page.locator(".VPSidebar, aside");
await expect(sidebar.getByText("REST API", { exact: true })).toBeVisible();
await expect(sidebar.getByText("Image engine", { exact: true })).toBeVisible();
await expect(sidebar.getByText("AI engine", { exact: true })).toBeVisible();
});
test("clicking Architecture navigates correctly", async ({ page }) => {
await page.locator(".VPSidebar a, aside a").filter({ hasText: "Architecture" }).click();
await expect(page).toHaveURL(/\/guide\/architecture/);
await expect(page.getByRole("heading", { name: /Architecture/ }).first()).toBeVisible();
});
test("clicking Configuration navigates correctly", async ({ page }) => {
await page.locator(".VPSidebar a, aside a").filter({ hasText: "Configuration" }).click();
await expect(page).toHaveURL(/\/guide\/configuration/);
});
test("clicking Deployment navigates correctly", async ({ page }) => {
await page.locator(".VPSidebar a, aside a").filter({ hasText: "Deployment" }).first().click();
await expect(page).toHaveURL(/\/guide\/deployment/);
});
});
test.describe("Docs Sidebar - API Reference Section", () => {
test("clicking REST API navigates correctly", async ({ page }) => {
await page.goto("/guide/getting-started");
await waitForHydration(page);
await page.locator(".VPSidebar a, aside a").filter({ hasText: "REST API" }).click();
await expect(page).toHaveURL(/\/api\/rest/);
await expect(page.getByText("REST API Reference")).toBeVisible();
});
test("clicking Image engine navigates correctly", async ({ page }) => {
await page.goto("/api/rest");
await waitForHydration(page);
await page.locator(".VPSidebar a, aside a").filter({ hasText: "Image engine" }).click();
await expect(page).toHaveURL(/\/api\/image-engine/);
});
test("clicking AI engine navigates correctly", async ({ page }) => {
await page.goto("/api/rest");
await waitForHydration(page);
await page.locator(".VPSidebar a, aside a").filter({ hasText: "AI engine" }).click();
await expect(page).toHaveURL(/\/api\/ai/);
});
});