Purpose
Patterns for browser-based UI verification using Playwright. Reliable, maintainable, fast E2E tests.
Selector Priority
| Priority | Selector | Example | Why |
|---|---|---|---|
| 1 | Role | getByRole('button', { name: 'Submit' }) |
Accessible, semantic |
| 2 | Label | getByLabel('Email') |
Accessible, user-facing |
| 3 | Test ID | getByTestId('submit-btn') |
Stable, explicit |
| 4 | Text | getByText('Sign in') |
Readable but fragile |
| 5 | CSS | page.locator('.btn-primary') |
Last resort |
NEVER: XPath, auto-generated IDs, DOM structure selectors.
Page Object Model
export class LoginPage {
constructor(private page: Page) {}
get emailInput() { return this.page.getByLabel('Email'); }
get passwordInput() { return this.page.getByLabel('Password'); }
get submitButton() { return this.page.getByRole('button', { name: 'Sign in' }); }
async login(email: string, password: string) {
await this.emailInput.fill(email);
await this.passwordInput.fill(password);
await this.submitButton.click();
}
}
Visual Regression
test('dashboard renders correctly', async ({ page }) => {
await page.goto('/dashboard');
await page.waitForLoadState('networkidle');
await expect(page).toHaveScreenshot('dashboard.png', { maxDiffPixelRatio: 0.01 });
});
Network Interception
test('handles API errors', async ({ page }) => {
await page.route('**/api/users', route =>
route.fulfill({ status: 500, body: 'Server Error' })
);
await page.goto('/users');
await expect(page.getByText('Something went wrong')).toBeVisible();
});
Anti-Flakiness
- Wait for state, not time — never
page.waitForTimeout() - Isolate tests — fresh context per test
- Web-first assertions —
expect(locator).toBeVisible()auto-retries - Mock external APIs
- CI retries:
retries: 2in config
Critical Rules
- NEVER use
page.waitForTimeout()— wait for specific conditions - ALWAYS use Page Object Model for pages with 3+ interactions
- Selectors MUST follow priority: role > label > testid > text > CSS
- Visual regression MUST set
maxDiffPixelRatio - E2E tests MUST NOT depend on seed data
- ALWAYS use
--trace on-first-retryin CI