Skip to content

test(e2e): only fail on critical and serious best-practice a11y findings #3980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
v-scharf merged 1 commit into from
Oct 22, 2026
Merged

test(e2e): only fail on critical and serious best-practice a11y findings #3980

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions tests/e2e/support/utils/accessibility.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,18 @@ import { Page, expect } from '@playwright/test'
import AxeBuilder from '@axe-core/playwright'
import { franc } from 'franc-min'

const a11yRuleTags = ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'best-practice']
const wcagRuleTags = ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa']
const a11yRuleTags = [...wcagRuleTags, 'best-practice']

type Violation = Awaited<ReturnType<AxeBuilder['analyze']>>['violations'][number]

// best-practice rules aren't required for WCAG conformance, only their critical and serious findings fail the check
function isRelevantViolation(violation: Violation): boolean {
if (violation.tags.some((tag) => wcagRuleTags.includes(tag))) {
return true
}
return ['critical', 'serious'].includes(violation.impact)
}

export async function checkA11yOrLocalization(
page: Page,
Expand Down Expand Up @@ -31,24 +42,25 @@ async function checkAccessibility(
await page.waitForTimeout(300)
}

function analyze() {
async function analyze(): Promise<Violation[]> {
// tooltips are transient and appended to <body>, they only show up when a previous step left focus or hover on a trigger
const builder = new AxeBuilder({ page }).withTags(a11yRuleTags).exclude('[role="tooltip"]')
if (includeSelector) {
builder.include(includeSelector)
}
return builder.analyze()
const results = await builder.analyze()
return results.violations.filter(isRelevantViolation)
}

let results = await analyze()
if (results.violations.length > 0) {
let violations = await analyze()
if (violations.length > 0) {
await page.waitForTimeout(500)
results = await analyze()
violations = await analyze()
}

if (results.violations.length > 0) {
if (violations.length > 0) {
console.error(`♿ Accessibility violations detected${context ? ` in ${context}` : ''}:`)
for (const violation of results.violations) {
for (const violation of violations) {
console.error(`\n[${violation.id}] ${violation.help}`)
console.error(` Impact: ${violation.impact}`)
console.error(` Description: ${violation.description}`)
Expand All @@ -62,7 +74,7 @@ async function checkAccessibility(
// soft assertion: the scenario continues and all violations are reported at the end
expect
.soft(
results.violations.map(
violations.map(
(violation) =>
`[${violation.id}] ${violation.help}: ${violation.nodes.map((node) => node.target.join(' ')).join(', ')}`
),
Expand Down
Loading