wait.ts · Source

wait.tstests/e2e/utils/wait.tsraw ← utils2,435 B← Back to the app
1/**
2 * AI Software Factory — E2E wait helpers.
3 *
4 * Thin, intent-named wrappers around Playwright waits. Prefer the built-in
5 * `expect(locator).toBeVisible()` auto-asserting waits where possible; use
6 * these when you need: text-content locators, network-idle settling, or a
7 * custom polling condition.
8 */
9import { expect, type Page, type Locator } from "@playwright/test";
10 
11/**
12 * Wait until an element matching `[data-testid]` containing the given text is
13 * visible. Returns the locator so the caller can act on it.
14 */
15export async function waitForSelectorByText(
16  page: Page,
17  testId: string,
18  text: string | RegExp,
19  timeoutMs = 15_000,
20): Promise<Locator> {
21  const locator = page
22    .getByTestId(testId)
23    .filter({ hasText: text });
24  await expect(locator.first()).toBeVisible({ timeout: timeoutMs });
25  return locator.first();
26}
27 
28/**
29 * Wait for the page to reach a network-idle state (no in-flight requests for
30 * `quietMs`). Playwright's built-in "networkidle" load state is what this
31 * wraps; it is flaky when the page keeps a WebSocket open (realtime), so for
32 * realtime assertions prefer explicit event waits (locator visibility /
33 * count / a value you poll with waitForCondition) over network idle.
34 */
35export async function waitForNetworkIdle(
36  page: Page,
37  _quietMs = 500,
38  timeoutMs = 15_000,
39): Promise<void> {
40  await page
41    .waitForLoadState("networkidle", { timeout: timeoutMs })
42    .catch((err) => {
43      throw new Error(
44        `waitForNetworkIdle: not idle within ${timeoutMs}ms ` +
45          `(a live WebSocket keeps the socket busy — wait on an explicit UI ` +
46          `state instead). Cause: ${String(err)}`,
47      );
48    });
49}
50 
51/**
52 * Poll `fn` until it returns truthy or the timeout elapses.
53 */
54export async function waitForCondition<T>(
55  page: Page,
56  fn: () => Promise<T> | T,
57  opts: { timeoutMs?: number; intervalMs?: number; message?: string } = {},
58): Promise<T> {
59  const timeoutMs = opts.timeoutMs ?? 15_000;
60  const intervalMs = opts.intervalMs ?? 250;
61  const deadline = Date.now() + timeoutMs;
62  // eslint-disable-next-line no-constant-condition
63  while (true) {
64    const result = await fn();
65    if (result) return result;
66    if (Date.now() >= deadline) {
67      throw new Error(
68        `waitForCondition: timed out after ${timeoutMs}ms` +
69          (opts.message ? ` — ${opts.message}` : ""),
70      );
71    }
72    await page.waitForTimeout(intervalMs);
73  }
74}
75