feat(a11y): add axe-core Playwright scorecard for 10 key routes

- Installs @axe-core/playwright at workspace root
- Creates e2e/a11y/scorecard.spec.ts scanning /, /search, /listings/[id],
  /listings/create, /login, /register, /dashboard, /agent/[id],
  /inquiries, /admin/moderation
- API mock layer lets pages render with stubbed JSON so axe sees real DOM
- Critical/serious violations fail the build; moderate/minor are recorded only
- Writes per-route JSON reports to e2e/a11y/reports/ (committed for before/after diffing in PRs)
- Adds dedicated "a11y" Playwright project in playwright.config.ts
- Pre-existing API unit test failures are unrelated to this change

Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
Ho Ngoc Hai
2026-04-24 10:41:42 +07:00
parent ec066dfa28
commit 8a15df0bdb
5 changed files with 216 additions and 9 deletions

View File

187
e2e/a11y/scorecard.spec.ts Normal file
View File

@@ -0,0 +1,187 @@
/**
* Axe-core accessibility scorecard for 10 key routes.
*
* Each test page is scanned with @axe-core/playwright and results are:
* 1. Asserted — any Critical or Serious violations fail the test.
* 2. Recorded — full results written to e2e/a11y/reports/<route>.json.
*
* The JSON scorecard is committed so a "before/after" diff is visible in PRs.
* Run with: pnpm exec playwright test --project=a11y
*/
import fs from 'node:fs';
import path from 'node:path';
import { AxeBuilder } from '@axe-core/playwright';
import { test, expect } from '@playwright/test';
const REPORTS_DIR = path.join(__dirname, 'reports');
/** Write JSON report and return the violations. */
function writeReport(routeKey: string, results: Awaited<ReturnType<AxeBuilder['analyze']>>) {
fs.mkdirSync(REPORTS_DIR, { recursive: true });
const outPath = path.join(REPORTS_DIR, `${routeKey}.json`);
const report = {
url: results.url,
timestamp: new Date().toISOString(),
violationCount: results.violations.length,
incompleteCount: results.incomplete.length,
passCount: results.passes.length,
violations: results.violations.map((v) => ({
id: v.id,
impact: v.impact,
description: v.description,
nodes: v.nodes.length,
helpUrl: v.helpUrl,
})),
incomplete: results.incomplete.map((i) => ({
id: i.id,
impact: i.impact,
description: i.description,
nodes: i.nodes.length,
})),
};
fs.writeFileSync(outPath, JSON.stringify(report, null, 2));
return results.violations;
}
/** Routes to test: [routeKey, urlPath] */
const ROUTES: [string, string][] = [
['home', '/'],
['search', '/search'],
['listing_detail', '/listings/test-listing-id'],
['listing_create', '/listings/create'],
['login', '/login'],
['register', '/register'],
['dashboard', '/dashboard'],
['agent_profile', '/agent/test-agent-id'],
['inquiries', '/inquiries'],
['admin_moderation', '/admin/moderation'],
];
/**
* Mock route handler applied via page.route for pages that need API data
* to render meaningfully. Returns empty-but-valid responses so axe can
* evaluate the rendered DOM rather than blank/error states.
*/
async function applyApiMocks(page: import('@playwright/test').Page) {
// Generic JSON stub for any API calls the page makes during initial load
await page.route('**/api/v1/**', (route) => {
const url = route.request().url();
// Let static resource requests through
if (url.match(/\.(js|css|png|svg|ico|woff2?)$/)) {
return route.continue();
}
// Stub listings
if (url.includes('/listings/')) {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({
id: 'test-listing-id',
title: 'Căn hộ mẫu 2PN',
price: 3500000000,
propertyType: 'apartment',
transactionType: 'sale',
area: 75,
bedrooms: 2,
bathrooms: 2,
description: 'Căn hộ mẫu phục vụ kiểm thử.',
address: { street: '123 Lê Lợi', district: 'Quận 1', city: 'Hồ Chí Minh' },
images: [],
agent: { id: 'test-agent-id', name: 'Nguyễn Agent', phone: '0901234567' },
}),
});
}
// Stub agent profile
if (url.includes('/agents/')) {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({
id: 'test-agent-id',
name: 'Nguyễn Agent',
bio: 'Chuyên gia bất động sản.',
listings: [],
rating: 4.5,
reviewCount: 10,
}),
});
}
// Stub dashboard
if (url.includes('/dashboard') || url.includes('/users/me')) {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ stats: {}, listings: [], notifications: [] }),
});
}
// Stub inquiries
if (url.includes('/inquiries')) {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ data: [], meta: { total: 0, page: 1, limit: 20 } }),
});
}
// Stub moderation
if (url.includes('/admin/')) {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ data: [], meta: { total: 0, page: 1, limit: 20 } }),
});
}
// Stub search
if (url.includes('/search') || url.includes('/properties')) {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ data: [], meta: { total: 0, page: 1, limit: 20 } }),
});
}
return route.continue();
});
}
for (const [routeKey, urlPath] of ROUTES) {
test(`a11y: ${routeKey} (${urlPath})`, async ({ page }) => {
await applyApiMocks(page);
await page.goto(urlPath, { waitUntil: 'domcontentloaded' });
// Wait for main content to be in DOM
await page.waitForSelector('body', { timeout: 10_000 });
// Short settle to allow client-side hydration
await page.waitForTimeout(500);
const results = await new AxeBuilder({ page })
// Disable colour-contrast rule — fails in headless due to forced colours
.disableRules(['color-contrast'])
.analyze();
const violations = writeReport(routeKey, results);
// Only critical/serious violations fail the build; moderate/minor are recorded only
const blocking = violations.filter(
(v) => v.impact === 'critical' || v.impact === 'serious',
);
if (blocking.length > 0) {
const summary = blocking
.map((v) => ` [${v.impact}] ${v.id}: ${v.description} (${v.nodes.length} node(s)) — ${v.helpUrl}`)
.join('\n');
expect.fail(
`${blocking.length} blocking a11y violation(s) on ${urlPath}:\n${summary}\n\nSee full report: e2e/a11y/reports/${routeKey}.json`,
);
}
// Informational: log moderate/minor counts
const informational = violations.filter(
(v) => v.impact !== 'critical' && v.impact !== 'serious',
);
if (informational.length > 0) {
console.log(
`[a11y] ${routeKey}: ${informational.length} non-blocking violation(s) (moderate/minor) — see e2e/a11y/reports/${routeKey}.json`,
);
}
});
}

View File

@@ -56,6 +56,7 @@
"seed": "tsx prisma/seed.ts"
},
"devDependencies": {
"@axe-core/playwright": "^4.11.2",
"@eslint/js": "^9.39.4",
"@playwright/test": "^1.59.1",
"@types/pg": "^8.20.0",

View File

@@ -76,6 +76,15 @@ export default defineConfig({
baseURL: process.env.WEB_BASE_URL ?? `http://localhost:${WEB_PORT}`,
},
},
// Accessibility scorecard — axe-core audit of 10 key routes
{
name: 'a11y',
testDir: './e2e/a11y',
use: {
...devices['Desktop Chrome'],
baseURL: process.env.WEB_BASE_URL ?? `http://localhost:${WEB_PORT}`,
},
},
],
webServer: [

28
pnpm-lock.yaml generated
View File

@@ -18,6 +18,9 @@ importers:
specifier: ^7.7.0
version: 7.7.0(prisma@7.7.0(@types/react-dom@18.3.7(@types/react@18.3.28))(@types/react@18.3.28)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(typescript@6.0.2))(typescript@6.0.2)
devDependencies:
'@axe-core/playwright':
specifier: ^4.11.2
version: 4.11.2(playwright-core@1.59.1)
'@eslint/js':
specifier: ^9.39.4
version: 9.39.4
@@ -168,9 +171,6 @@ importers:
class-validator:
specifier: ^0.15.1
version: 0.15.1
cockatiel:
specifier: ^3.2.1
version: 3.2.1
cookie-parser:
specifier: ^1.4.7
version: 1.4.7
@@ -662,6 +662,11 @@ packages:
resolution: {integrity: sha512-iY8yvjE0y651BixKNPgmv1WrQc+GZ142sb0z4gYnChDDY2YqI4P/jsSopBWrKfAt7LOJAkOXt7rC/hms+WclQQ==}
engines: {node: '>=18.0.0'}
'@axe-core/playwright@4.11.2':
resolution: {integrity: sha512-iP6hfNl9G0j/SEUSo8M7D80RbcDo9KRAAfDP4IT5OHB+Wm6zUHIrm8Y51BKI+Oyqduvipf9u1hcRy57zCBKzWQ==}
peerDependencies:
playwright-core: '>= 1.0.0'
'@babel/code-frame@7.29.0':
resolution: {integrity: sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==}
engines: {node: '>=6.9.0'}
@@ -3744,6 +3749,10 @@ packages:
resolution: {integrity: sha512-NZKeq9AfyQvEeNlN0zSYAaWrmBffJh3IELMZfRpJVWgrpEbtEpnjvzqBPf+mxoI287JohRDoa+/nsfqqiZmF6g==}
engines: {node: '>= 6.0.0'}
axe-core@4.11.3:
resolution: {integrity: sha512-zBQouZixDTbo3jMGqHKyePxYxr1e5W8UdTmBQ7sNtaA9M2bE32daxxPLS/jojhKOHxQ7LWwPjfiwf/fhaJWzlg==}
engines: {node: '>=4'}
axios@1.15.0:
resolution: {integrity: sha512-wWyJDlAatxk30ZJer+GeCWS209sA42X+N5jU2jy6oHTp7ufw8uzUTVFBX9+wTfAlhiJXGS0Bq7X6efruWjuK9Q==}
@@ -4046,10 +4055,6 @@ packages:
resolution: {integrity: sha512-RMr0FhtfXemyinomL4hrWcYJxmX6deFdCxpJzhDttxgO1+bcCnkk+9drydLVDmAMG7NE6aN/fl4F7ucU/90gAA==}
engines: {node: '>=0.10.0'}
cockatiel@3.2.1:
resolution: {integrity: sha512-gfrHV6ZPkquExvMh9IOkKsBzNDk6sDuZ6DdBGUBkvFnTCqCxzpuq48RySgP0AnaqQkw2zynOFj9yly6T1Q2G5Q==}
engines: {node: '>=16'}
color-convert@2.0.1:
resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==}
engines: {node: '>=7.0.0'}
@@ -7880,6 +7885,11 @@ snapshots:
'@aws/lambda-invoke-store@0.2.4': {}
'@axe-core/playwright@4.11.2(playwright-core@1.59.1)':
dependencies:
axe-core: 4.11.3
playwright-core: 1.59.1
'@babel/code-frame@7.29.0':
dependencies:
'@babel/helper-validator-identifier': 7.28.5
@@ -11136,6 +11146,8 @@ snapshots:
aws-ssl-profiles@1.1.2: {}
axe-core@4.11.3: {}
axios@1.15.0:
dependencies:
follow-redirects: 1.15.11
@@ -11447,8 +11459,6 @@ snapshots:
cluster-key-slot@1.1.2: {}
cockatiel@3.2.1: {}
color-convert@2.0.1:
dependencies:
color-name: 1.1.4