AgentRules.org
RulesStacksClientsAuditorPrunerSelf-HealRFCsBenchmarkCLICI/CDAuthorsSubmit
This specification is maintained by the AgentRules Working Group. Have enhancements or want to claim maintainership?Submit Specification →
frontendcritical PriorityID: playwright-e2e-testing

Playwright Resilient E2E & Web-First Assertions Standard

Battle-tested End-to-End testing architecture with Playwright. Forbids arbitrary sleeps, manual timeouts, and brittle XPath selectors; mandates web-first auto-retrying assertions and accessible locators.

Prohibited Anti-Pattern: AI writes flaky tests with page.waitForTimeout(5000) and brittle XPath selectors that fail under network latency.

Export Ready-to-Drop Configuration

Select format below to copy code or download file directly.

---
description: Playwright Resilient E2E & Web-First Assertions Standard - Battle-tested End-to-End testing architecture with Playwright. Forbids arbitrary sleeps, manual timeouts, and brittle XPath selectors; mandates web-first auto-retrying assertions and accessible locators.
globs: e2e/**/*.ts, tests/**/*.spec.ts, **/*.e2e.ts
alwaysApply: true
verified_by: "agentrules.org"
license: "CC-BY-4.0"
source: "https://agentrules.org/rules/playwright-e2e-testing"
---

# Playwright Resilient E2E & Web-First Assertions Standard

> **Severity**: CRITICAL | **Category**: frontend
> **Anti-Pattern Warning**: AI writes flaky tests with page.waitForTimeout(5000) and brittle XPath selectors that fail under network latency.

## System Constraints
You are a test automation and quality assurance architect. When writing Playwright tests, NEVER use page.waitForTimeout() or sleep(). Always use user-facing accessible locators (getByRole, getByText, getByTestId) and auto-retrying expect() assertions.

## Strict Guidelines
- Never call page.waitForTimeout() under any circumstances; use auto-retrying web-first assertions like await expect(locator).toBeVisible().
- Prefer user-facing locators: page.getByRole('button', { name: '...' }), page.getByLabel(), and page.getByTestId(). Avoid CSS classes and absolute XPaths.
- Isolate test state: use fresh browser contexts or storageState fixtures; never rely on test execution order.
- Mock external third-party network APIs using page.route() to keep test suites deterministic, fast, and hermetic.

## Bad vs Good Implementations
### Auto-retrying Web-First Assertions vs Arbitrary page.waitForTimeout

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Brittle XPaths break on minor styling changes; waitForTimeout introduces arbitrary test latency and flaky CI failures.
```typescript
// ANTI-PATTERN: Brittle XPath selectors and hardcoded sleep
test("submits checkout form", async ({ page }) => {
  await page.goto("/checkout");
  await page.click("//div[2]/form/input[1]");
  await page.fill("//div[2]/form/input[1]", "[email protected]");
  await page.click("//button[@class='btn-primary-2024']");
  
  // FLAKY: Arbitrary sleep will fail in slow CI or waste time in fast runs
  await page.waitForTimeout(5000);
  const text = await page.innerText(".alert-success");
  assert(text.includes("Order Placed"));
});
```

#### Production Standard (Correct)
> **Standard**: Web-first assertions automatically wait for network and DOM stability without fragile manual sleeps.
```typescript
// PRODUCTION STANDARD: Accessible locators + auto-retrying assertions
import { test, expect } from "@playwright/test";

test("submits checkout form with accessible locators", async ({ page }) => {
  await page.goto("/checkout");
  
  await page.getByLabel("Email Address").fill("[email protected]");
  await page.getByRole("button", { name: /place order/i }).click();

  // Auto-retrying web-first assertion (polls DOM up to timeout, default 5s)
  await expect(page.getByRole("alert")).toContainText("Order Placed");
  await expect(page.getByTestId("order-confirmation-badge")).toBeVisible();
});
```

### Network Mocking for Hermetic E2E Execution

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Calling external services during E2E runs causes rate limits, unpredictable latency, and external side effects.
```typescript
// ANTI-PATTERN: Hitting live production payment gateway during CI run
test("processes subscription", async ({ page }) => {
  await page.goto("/pricing");
  await page.click("button:has-text('Subscribe')"); // Hits live Stripe!
});
```

#### Production Standard (Correct)
> **Standard**: page.route() provides deterministic test runs independent of third-party network outages.
```typescript
// PRODUCTION STANDARD: Mocking external API responses via page.route
test("processes subscription with mocked payment webhook", async ({ page }) => {
  await page.route("**/api/checkout/session", async (route) => {
    await route.fulfill({
      status: 200,
      contentType: "application/json",
      body: JSON.stringify({ status: "success", sessionId: "mock_sess_123" }),
    });
  });

  await page.goto("/pricing");
  await page.getByRole("button", { name: "Subscribe" }).click();
  await expect(page.getByText("Welcome to Pro!")).toBeVisible();
});
```
Recommended MCP Servers (mcp-serverlist.com)

Equip agent with system tools to verify code for this stack.

Playwright Browser MCP
Execute and debug Playwright test runs directly from AI agent context.
Recommended Agent Skills (askills.dev)

Ready-to-use executable skill functions tailored to this stack.

Playwright E2E Test Generator
Generate type-safe Playwright specs with web-first assertions.
Architectural Specification & Invariant Rationale

Architectural Invariant Design: Playwright Resilient E2E & Web-First Assertions Standard

Playwright Resilient E2E & Web-First Assertions Standard defines an industrial-grade behavioral standard for frontend engineering. Battle-tested End-to-End testing architecture with Playwright. Forbids arbitrary sleeps, manual timeouts, and brittle XPath selectors; mandates web-first auto-retrying assertions and accessible locators. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: AI writes flaky tests with page.waitForTimeout(5000) and brittle XPath selectors that fail under network latency. Without an explicit system instruction file, developers spend hours debugging silent failures.
Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure ModeAI Symptom (The Anti-Pattern)SeverityProduction Impact & Remedy
AI Hallucination & Deprecation DriftAI writes flaky tests with page.waitForTimeout(5000) and brittle XPath selectors that fail under network latency.Critical
Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production.
Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture InconsistencyAI assistants produce mixed paradigms across files, creating fragmented codebase conventions.Medium
Increases cognitive load during code reviews and leads to maintenance debt across engineering teams.
Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.
Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

1

Never call page.waitForTimeout() under any circumstances

Never call page.waitForTimeout() under any circumstances; use auto-retrying web-first assertions like await expect(locator).toBeVisible().

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
2

Prefer user-facing locators

Prefer user-facing locators: page.getByRole('button', { name: '...' }), page.getByLabel(), and page.getByTestId(). Avoid CSS classes and absolute XPaths.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
3

Isolate test state

Isolate test state: use fresh browser contexts or storageState fixtures; never rely on test execution order.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
4

Mock external third-party network APIs using page.route() to keep test suites deterministic, fast, and hermetic.

Mock external third-party network APIs using page.route() to keep test suites deterministic, fast, and hermetic.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
Technical Questions & Answers

Frequently Asked Technical Questions

Common questions developers face when configuring AI coding assistants for this stack:

Q:Why is Playwright Resilient E2E & Web-First Assertions Standard critical for AI coding assistants?

Battle-tested End-to-End testing architecture with Playwright. Forbids arbitrary sleeps, manual timeouts, and brittle XPath selectors; mandates web-first auto-retrying assertions and accessible locators. Without explicit behavioral boundaries, AI coding assistants (Cursor, Claude Code, Windsurf, Codex) rely on training data averages, which frequently produce deprecated, inefficient, or vulnerable code patterns.

Q:How does adopting this rule prevent AI hallucinations?

This rule explicitly declares what the AI must avoid (AI writes flaky tests with page.waitForTimeout(5000) and brittle XPath selectors that fail under network latency.) and prescribes verified positive examples. Grounding the LLM with negative and positive pairs eliminates guesswork.

Q:Which AI coding environments are supported?

This specification is multi-platform compatible: Cursor (.cursor/rules/*.mdc & .cursorrules), Anthropic Claude Code (CLAUDE.md), Windsurf (.windsurfrules), Codex / Cline (AGENTS.md), and GitHub Copilot (.github/copilot-instructions.md).

Q:Can I combine this rule with other technology stacks?

Yes. Use the Interactive Stack Builder or download an Agent Pack to merge this rule with other frontend, backend, database, security, and DevOps rules without syntax collision.

Open Specification · CC BY 4.0·Free for Personal, Team & Commercial In-Repo Use

Citation & Open Source Attribution Guidelines

This specification is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). You are completely free to adapt and share this rule in your workspace. If citing, including in public AI benchmark datasets, or redistributing, attribution to AgentRules.org is required.

Related FRONTEND Rules

View all rules →
frontend
119

SolidStart 1.0 Server Functions & Async Boundaries Production Standard

SolidStart 1.0 relies on the Vinxi bundler to split `server$` closures into independent HTTP POST RPC endpoints. Direct lexical closure over client signals within `server$` scopes or failure to demarcate async boundaries with `<Suspense>` causes silent serialization failures, client-bundle secret leaks, and SSR hydration mismatches. Enforcing strict parameter passing, runtime input validation, and Solid async primitives maintains security and fine-grained reactivity across network boundaries.

frontend
119

Astro 5 Actions & Content Layer Production Standard

Enforces strict type safety and architectural correctness for Astro 5 Server Actions and the zero-waterfall Content Layer API. Prevents runtime contract mismatches, hydration mismatches, and unhandled mutation exceptions across dynamic and prerendered boundaries. Failure to follow these patterns leads to silent data fetching waterfalls, build-time cache corruptions, and unhandled server action exceptions.

frontend
51

Nuxt 4 Nitro Server Engine & Shared Directory Production Standard

Nuxt 4 enforces strict boundary segregation between client UI in the app/ directory, backend endpoints in server/, and universal contracts in shared/. Violating cross-boundary isolation or maintaining module-scoped state in Nitro server handlers causes catastrophic cross-request data corruption and hydration mismatches under concurrent production traffic. Architects must enforce request-isolated H3 event contexts, universal serialization schemas, and strict path-alias boundaries.

1 Rule in Stack

Playwright