mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 15:51:30 +00:00
feat(frontend): Phase 5 Accessibility + Forms — close FE-H3 + UX-H4 primitive + FE-M1 primitive + axe-core gate
Closes the Phase 5 batch from cowork/frontend-design-audit.html: ships
the joint UX-H4 + FE-M1 lever (FormField primitive + react-hook-form +
zod schemas) and the FE-H3 fix (Headless UI Dialog focus trap on the 3
inline-managed modals), with an axe-core regression test + CI guard to
prevent UX-H4 regressions.
═════════════════════════ AUDIT VERIFICATION ═════════════════════════
Confirmed live against the repo before implementing:
• Q1 labels / htmlFor / input-id = 139 / 6 / 0
(audit said 138 / 6 / 0 — labels +1, otherwise accurate)
• Q2 no form library installed
(no react-hook-form, formik, @tanstack/react-form, final-form)
• Q3 3 inline-managed dialog sites confirmed:
SCEPAdminPage.tsx:272, AgentsPage.tsx:314, ESTAdminPage.tsx:281
• Q4 audit's top-6 list was OFF — actual top form-heaviest pages
by useState count are: OIDCProviderDetailPage 21, AgentGroupsPage
18, CertificatesPage 17, CertificateDetailPage 14, BreakglassPage
13, ProfilesPage 13 — NOT the audit-suggested OnboardingWizard 5
(now split in Phase 4) / OIDCProvidersPage 8 / IssuersPage 11 /
ProfilesPage 13 / TargetsPage 9 / ApprovalsPage 5. Audit's
intuition skipped the higher-useState pages.
• Q5 jest-dom imported in src/test/setup.ts — axe-core landed
cleanly
═════════════════════════════ CLOSURES ═══════════════════════════════
UX-H4 (label/input binding) — FormField primitive shipped
• web/src/components/FormField.tsx wraps a <label> + an input child
and auto-generates a stable id via React 18's useId(); cloneElement
threads that id onto BOTH the <label htmlFor> AND the child's id
prop so the WCAG 1.3.1 binding holds by construction. Supports
`required` (asterisk + aria-required), `description` (wires
aria-describedby), `error` (aria-invalid + role=alert + extends
aria-describedby). 7 tests pin the contract.
FE-M1 (no form library) — react-hook-form + @hookform/resolvers + zod
• Added react-hook-form 7.75, @hookform/resolvers 5.2, zod 4.4 as
runtime deps; @axe-core/react, jest-axe, @types/jest-axe as devDeps
• Representative migration of CreateTeamModalInline (inside
onboarding/CertificateStep — operator's first-run experience)
from 3-useState + manual handlers to useForm + zodResolver +
FormField. Schema at pages/onboarding/team.schema.ts.
• Per the audit's "top-6 only, primitive is the lever" rule, the
other 5 audit-suggested pages migrate organically as feature
work touches them — documented as Phase 5 follow-up. The
FormField primitive is the leverage point; per-page migrations
are mechanical applications.
FE-H3 (no focus trap on modal pages)
• New ModalDialog primitive at web/src/components/ModalDialog.tsx —
Headless UI Dialog wrapper for arbitrary-content modals
(complements ConfirmDialog which is confirm-only). Auto-emits
role=dialog + aria-modal + aria-labelledby + ESC-to-close +
backdrop-click-to-close + focus trap.
• All 3 inline-managed modal sites migrated:
• SCEPAdminPage ConfirmReloadModal
• ESTAdminPage ConfirmReloadModal (data-testid preserved)
• AgentsPage RetireAgentModal (3-mode: confirm / blocked / error
— title + footer change per mode; body slot stays the same)
• 37/37 existing modal-page tests stay green — no behavior change
visible to the test suite, only the focus-trap + ESC handling.
UX-H4 regression gate
• web/src/test/a11y.test.tsx runs axe-core (not jest-axe — its
`toHaveNoViolations` matcher uses jest's expect API which can't
plug into Vitest's expect.extend; fails with "expectAssertion.call
is not a function"). Direct axe.run + assert violations.length===0
gives the same gate with a readable failure message.
• Scope: primitives, not page sweeps. Primitives carry the risk
surface; pages compose them. 5 tests covering FormField (with +
without description/error), Skeleton (all 4 variants),
ModalDialog, Breadcrumbs. ~400ms total.
• Skeleton.table's empty <th> cells are decorative shimmers inside
a role=status + aria-busy=true tree — axe-core's
`empty-table-header` rule doesn't model aria-busy gating, so it
is suppressed for the Skeleton variant scan with a clear comment.
• scripts/ci-guards/no-unbound-label.sh — fails CI if a new <label>
without htmlFor lands. Baseline-driven (132 today) so the existing
backlog doesn't block CI; every migration to FormField drops the
baseline. `--strict` mode rejects any unbound label once the
backlog clears.
═══════════════════════════ VERIFICATION ═════════════════════════════
• npx tsc --noEmit — exits 0
• New tests: FormField 7/7, ModalDialog 6/6, a11y 5/5 = 18/18 new
• Component suite: 14 files / 150/150 green
• Page suite (representative subset run): 16 files in first run
(timeout truncated final summary) + 10 files / 48/48 in second
run — all green
• OnboardingWizard 4/4 (the migrated CreateTeamModalInline test
case is the second one — `+ New team opens the inline modal,
calls createTeam, invalidates the cache, and auto-selects the
new team`)
• SCEPAdminPage 20/20, ESTAdminPage 14/14, AgentsPage 3/3 — all
37 modal-page tests stay green after ModalDialog migration
• npm run build ✓ in 3.27s
• CI guard: bash scripts/ci-guards/no-unbound-label.sh — passes at
baseline 132 (current unbound count matches; failure mode is
only on increase). --strict path will fail until backlog clears.
═══════════════════════════ RESIDUAL RISK ════════════════════════════
• RHF migration risk: zod resolver's input/output type mismatch
bit me once during this work (description: z.string().optional()
gave Input: string|undefined vs Output: string after .default()).
Both sides typed as string + defaultValues providing empty string
fixes it; documented in team.schema.ts. Pattern applies to every
future Zod schema with optional-but-empty-string fields.
• The audit's "top-6" page list is stale (Phase 4 split
OnboardingWizard; useState ranks shifted). Future RHF migrations
should re-derive the priority list against live useState counts,
not the audit's stamped names.
• DataTable per-row React.memo (PERF-M1 follow-up from Phase 4)
remains deferred — orthogonal to Phase 5 scope.
This commit is contained in:
@@ -0,0 +1 @@
|
||||
132
|
||||
Executable
+94
@@ -0,0 +1,94 @@
|
||||
#!/usr/bin/env bash
|
||||
# Phase 5 closure (UX-H4 regression gate): fail the build when a new
|
||||
# <label> element ships in production tsx without htmlFor= or a wrapping
|
||||
# <FormField> primitive (which auto-emits htmlFor via useId()).
|
||||
#
|
||||
# Pre-Phase-5: 139 <label> tags, 6 with htmlFor, 0 inputs with id —
|
||||
# WCAG 1.3.1 fails on ~99% of form fields. The FormField primitive
|
||||
# (web/src/components/FormField.tsx) closes new label/input pairs by
|
||||
# construction; this guard prevents reintroducing unbound labels in
|
||||
# untouched parts of the codebase.
|
||||
#
|
||||
# Grace period: during the Phase 5 migration we expect ~133 existing
|
||||
# unbound labels to stay in place until each owning page migrates
|
||||
# through. They live in the allowlist file alongside this script
|
||||
# (no-unbound-label-exceptions.txt). Each migration deletes the
|
||||
# corresponding line; when the allowlist is empty, this guard becomes
|
||||
# strictly enforcing and the allowlist file should be removed.
|
||||
#
|
||||
# Algorithm:
|
||||
# 1. Count current unbound labels (labels NOT preceded by htmlFor= on
|
||||
# the same line OR within the wrapping JSX block).
|
||||
# 2. Compare against the allowlist's recorded count. If today's count
|
||||
# is HIGHER than the allowlist baseline, a new unbound label was
|
||||
# added — fail with the diff.
|
||||
# 3. If today's count is LOWER, congratulate and remind to update
|
||||
# the baseline.
|
||||
#
|
||||
# Strict mode: pass `--strict` to fail on any unbound label, ignoring
|
||||
# the allowlist. Use once the allowlist is empty.
|
||||
set -euo pipefail
|
||||
|
||||
# Resolve script dir BEFORE cd so baseline path stays valid.
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
BASELINE_FILE="$SCRIPT_DIR/no-unbound-label-baseline.txt"
|
||||
|
||||
cd "$SCRIPT_DIR/../../web"
|
||||
|
||||
STRICT=0
|
||||
[[ "${1:-}" == "--strict" ]] && STRICT=1
|
||||
|
||||
# Count <label tags WITHOUT htmlFor= on the same line in production
|
||||
# tsx (excludes tests + node_modules + dist).
|
||||
COUNT_UNBOUND=$(
|
||||
grep -rohE '<label[^>]*>' src \
|
||||
--include='*.tsx' \
|
||||
--exclude='*.test.*' \
|
||||
--exclude-dir='__tests__' \
|
||||
--exclude-dir='node_modules' \
|
||||
--exclude-dir='dist' \
|
||||
2>/dev/null \
|
||||
| grep -vcE 'htmlFor='
|
||||
) || true
|
||||
|
||||
BASELINE=0
|
||||
if [[ -f "$BASELINE_FILE" ]]; then
|
||||
BASELINE=$(cat "$BASELINE_FILE" | tr -d '[:space:]')
|
||||
fi
|
||||
|
||||
echo "Unbound <label> tags in web/src — current: $COUNT_UNBOUND, baseline: $BASELINE"
|
||||
|
||||
if [[ $STRICT -eq 1 ]]; then
|
||||
if [[ $COUNT_UNBOUND -gt 0 ]]; then
|
||||
echo "FAIL (--strict): $COUNT_UNBOUND unbound <label> tag(s) remain. Migrate to <FormField> or add htmlFor=."
|
||||
exit 1
|
||||
fi
|
||||
echo "PASS (--strict): zero unbound <label> tags."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [[ $COUNT_UNBOUND -gt $BASELINE ]]; then
|
||||
echo ""
|
||||
echo "FAIL: A new unbound <label> tag was added ($COUNT_UNBOUND > baseline $BASELINE)."
|
||||
echo ""
|
||||
echo "Wrap the new label in <FormField label='…'>{<input … />}</FormField> — the"
|
||||
echo "primitive at web/src/components/FormField.tsx auto-pairs label htmlFor with"
|
||||
echo "the child input's id via React's useId() so WCAG 1.3.1 holds by construction."
|
||||
echo ""
|
||||
echo "If a raw <label> is genuinely needed (rare: e.g. wrapping a Headless UI"
|
||||
echo "Switch where Headless UI handles the binding internally), add htmlFor=…"
|
||||
echo "explicitly. Then update the baseline:"
|
||||
echo ""
|
||||
echo " echo $COUNT_UNBOUND > $BASELINE_FILE"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ $COUNT_UNBOUND -lt $BASELINE ]]; then
|
||||
echo ""
|
||||
echo "PASS — and you're under baseline! Drop the baseline to lock in progress:"
|
||||
echo " echo $COUNT_UNBOUND > $BASELINE_FILE"
|
||||
echo ""
|
||||
fi
|
||||
|
||||
exit 0
|
||||
Reference in New Issue
Block a user