Files
next-ai-draw-io/tests/e2e/lib/fixtures.ts
Dayuan Jiang c7a85d398f test: add Vitest and Playwright testing infrastructure (#512)
* test: add Vitest and Playwright testing infrastructure

- Add Vitest for unit tests (39 tests)
  - cached-responses.test.ts
  - ai-providers.test.ts
  - chat-helpers.test.ts
  - utils.test.ts
- Add Playwright for E2E tests (3 smoke tests)
  - Homepage load
  - Japanese locale
  - Settings dialog
- Add CI workflow (.github/workflows/test.yml)
- Add vitest.config.mts and playwright.config.ts
- Update .gitignore for test artifacts

* test: add more E2E tests for UI components

- Chat panel tests (interactive elements, iframe)
- Settings tests (dark mode, language, draw.io theme)
- Save dialog tests (buttons exist)
- History dialog tests
- Model config tests
- Keyboard interaction tests
- Upload area tests

Total: 15 E2E tests, all passing

* test: fix E2E test issues from review

Fixes based on Gemini and Codex review:
- Remove brittle nth(1) selector in keyboard tests
- Remove waitForTimeout(500) race condition
- Remove if(isVisible) silent skip patterns
- Add proper assertions instead of no-op checks
- Remove expect(count >= 0) that always passes
- Remove unused hasProviderUI variable

All 14 E2E tests and 39 unit tests pass.

* style: auto-format with Biome

* fix: resolve lint errors for CI

* test(e2e): add diagram generation tests with mocked AI responses

- Add tests for generate, edit, and append diagram operations
- Use SSE mocked responses matching AI SDK UI message stream format
- Generate mxCell XML directly in tests for deterministic assertions
- Tests verify tool card rendering and 'Complete' badge state

* test: add comprehensive E2E tests for all major features

- Error handling tests (API errors, rate limits, network timeout, truncated XML)
- Multi-turn conversation tests (sequential requests, history preservation)
- File upload tests (upload button, file preview, sending with message)
- Theme switching tests (dark mode toggle, persistence, system preference)
- Language switching tests (EN/JA/ZH, persistence, locale URLs)
- Iframe interaction tests (draw.io loading, toolbar, diagram rendering)
- Copy/paste tests (chat input, XML input, special characters)
- History restore tests (new chat, persistence, browser navigation)

* refactor: extract shared test helpers and improve error assertions

- Create tests/e2e/lib/helpers.ts with shared SSE mock functions
- Add proper error UI assertions to error-handling.spec.ts
- Remove waitForTimeout calls in favor of real assertions
- Update 6 test files to use shared helpers

* docs: add testing section to CONTRIBUTING.md

* fix: improve test infrastructure based on PR review

- Fix double build in CI: remove redundant build from playwright webServer
- Export chat helpers from shared module for proper unit testing
- Replace waitForTimeout with explicit waits in E2E tests
- Add data-testid attributes to settings and new chat buttons
- Add list reporter for CI to show failures in logs
- Add Playwright browser caching to speed up CI
- Add vitest coverage configuration
- Fix conditional test assertions to use test.skip() instead of silent pass
- Remove unused variables flagged by linter

* fix: improve E2E test assertions and remove silent skips

- Replace silent test.skip() with explicit conditional skips
- Add actual persistence assertion after page reload
- Use data-testid selector for new chat button test

* refactor: add shared fixtures and test.step() patterns

- Add tests/e2e/lib/fixtures.ts with shared test helpers
- Add tests/e2e/fixtures/diagrams.ts with XML test data
- Add expectBeforeAndAfterReload() helper for persistence tests
- Add test.step() for better test reporting in complex tests
- Consolidate mock helpers into fixtures module
- Reduce code duplication across 17 test files

* fix: make persistence tests more reliable

- Remove expectBeforeAndAfterReload from mocked API tests
- Add explicit test.step() for before/after reload checks
- Add retry config for flaky clipboard tests
- Add sleep after reload for language persistence test

* test: remove flaky XML paste test

* docs: run both unit and e2e tests before PR

* chore: add type check and unit test git hooks

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-01-05 01:37:32 +09:00

209 lines
5.9 KiB
TypeScript

/**
* Playwright test fixtures for E2E tests
* Uses test.extend to provide common setup and helpers
*/
import { test as base, expect, type Page, type Route } from "@playwright/test"
import { createMockSSEResponse, createTextOnlyResponse } from "./helpers"
/**
* Extended test with common fixtures
*/
export const test = base.extend<{
/** Page with iframe already loaded */
appPage: Page
}>({
appPage: async ({ page }, use) => {
await page.goto("/", { waitUntil: "networkidle" })
await page
.locator("iframe")
.waitFor({ state: "visible", timeout: 30000 })
await use(page)
},
})
export { expect }
// ============================================
// Locator helpers
// ============================================
/** Get the chat input textarea */
export function getChatInput(page: Page) {
return page.locator('textarea[aria-label="Chat input"]')
}
/** Get the draw.io iframe */
export function getIframe(page: Page) {
return page.locator("iframe")
}
/** Get the iframe's frame locator for internal queries */
export function getIframeContent(page: Page) {
return page.frameLocator("iframe")
}
/** Get the settings button */
export function getSettingsButton(page: Page) {
return page.locator('[data-testid="settings-button"]')
}
// ============================================
// Action helpers
// ============================================
/** Send a message in the chat input */
export async function sendMessage(page: Page, message: string) {
const chatInput = getChatInput(page)
await expect(chatInput).toBeVisible({ timeout: 10000 })
await chatInput.fill(message)
await chatInput.press("ControlOrMeta+Enter")
}
/** Wait for diagram generation to complete */
export async function waitForComplete(page: Page, timeout = 15000) {
await expect(page.locator('text="Complete"')).toBeVisible({ timeout })
}
/** Wait for N "Complete" badges */
export async function waitForCompleteCount(
page: Page,
count: number,
timeout = 15000,
) {
await expect(page.locator('text="Complete"')).toHaveCount(count, {
timeout,
})
}
/** Wait for a specific text to appear */
export async function waitForText(page: Page, text: string, timeout = 15000) {
await expect(page.locator(`text="${text}"`)).toBeVisible({ timeout })
}
/** Open settings dialog */
export async function openSettings(page: Page) {
await getSettingsButton(page).click()
await expect(page.locator('[role="dialog"]')).toBeVisible({ timeout: 5000 })
}
// ============================================
// Mock helpers
// ============================================
interface MockResponse {
xml: string
text: string
toolName?: string
}
/**
* Create a multi-turn mock handler
* Each request gets the next response in the array
*/
export function createMultiTurnMock(responses: MockResponse[]) {
let requestCount = 0
return async (route: Route) => {
const response =
responses[requestCount] || responses[responses.length - 1]
requestCount++
await route.fulfill({
status: 200,
contentType: "text/event-stream",
body: createMockSSEResponse(
response.xml,
response.text,
response.toolName,
),
})
}
}
/**
* Create a mock that returns text-only responses
*/
export function createTextOnlyMock(responses: string[]) {
let requestCount = 0
return async (route: Route) => {
const text = responses[requestCount] || responses[responses.length - 1]
requestCount++
await route.fulfill({
status: 200,
contentType: "text/event-stream",
body: createTextOnlyResponse(text),
})
}
}
/**
* Create a mock that alternates between text and diagram responses
*/
export function createMixedMock(
responses: Array<
| { type: "text"; text: string }
| { type: "diagram"; xml: string; text: string }
>,
) {
let requestCount = 0
return async (route: Route) => {
const response =
responses[requestCount] || responses[responses.length - 1]
requestCount++
if (response.type === "text") {
await route.fulfill({
status: 200,
contentType: "text/event-stream",
body: createTextOnlyResponse(response.text),
})
} else {
await route.fulfill({
status: 200,
contentType: "text/event-stream",
body: createMockSSEResponse(response.xml, response.text),
})
}
}
}
/**
* Create a mock that returns an error
*/
export function createErrorMock(status: number, error: string) {
return async (route: Route) => {
await route.fulfill({
status,
contentType: "application/json",
body: JSON.stringify({ error }),
})
}
}
// ============================================
// Persistence helpers
// ============================================
/**
* Test that state persists across page reload.
* Runs assertions before reload, reloads page, then runs assertions again.
* Keep assertions narrow and explicit - test one specific thing.
*
* @param page - Playwright page
* @param description - What persistence is being tested (for debugging)
* @param assertion - Async function with expect() calls
*/
export async function expectBeforeAndAfterReload(
page: Page,
description: string,
assertion: () => Promise<void>,
) {
await test.step(`verify ${description} before reload`, assertion)
await page.reload({ waitUntil: "networkidle" })
await getIframe(page).waitFor({ state: "visible", timeout: 30000 })
await test.step(`verify ${description} after reload`, assertion)
}
/** Simple sleep helper */
export function sleep(ms: number): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, ms))
}