mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-08 11:38:55 +00:00
c9f932be65
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.
113 lines
3.7 KiB
TypeScript
113 lines
3.7 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { render, screen, fireEvent } from '@testing-library/react';
|
|
import { useForm } from 'react-hook-form';
|
|
import FormField from './FormField';
|
|
|
|
describe('FormField', () => {
|
|
it('label htmlFor matches input id (the WCAG 1.3.1 contract)', () => {
|
|
render(
|
|
<FormField label="Email">
|
|
<input type="email" />
|
|
</FormField>,
|
|
);
|
|
const label = screen.getByText('Email');
|
|
const input = screen.getByLabelText('Email');
|
|
// Programmatic label association — what screen readers use.
|
|
expect(input).toBeInTheDocument();
|
|
expect(label).toHaveAttribute('for', input.id);
|
|
// useId() gives a non-empty id by definition.
|
|
expect(input.id).toMatch(/^field-/);
|
|
});
|
|
|
|
it('two siblings get independent ids (no collision)', () => {
|
|
render(
|
|
<>
|
|
<FormField label="Name"><input /></FormField>
|
|
<FormField label="Description"><input /></FormField>
|
|
</>,
|
|
);
|
|
const a = screen.getByLabelText('Name');
|
|
const b = screen.getByLabelText('Description');
|
|
expect(a.id).not.toBe(b.id);
|
|
});
|
|
|
|
it('required surfaces the asterisk + aria-required on the child', () => {
|
|
render(
|
|
<FormField label="Email" required>
|
|
<input type="email" />
|
|
</FormField>,
|
|
);
|
|
expect(screen.getByText('*')).toBeInTheDocument();
|
|
expect(screen.getByLabelText(/Email/)).toHaveAttribute('aria-required', 'true');
|
|
});
|
|
|
|
it('description wires aria-describedby to the child', () => {
|
|
render(
|
|
<FormField label="Token" description="Paste the API key from /auth/keys">
|
|
<input />
|
|
</FormField>,
|
|
);
|
|
const input = screen.getByLabelText('Token');
|
|
const desc = screen.getByText(/Paste the API key/);
|
|
expect(input.getAttribute('aria-describedby')).toContain(desc.id);
|
|
});
|
|
|
|
it('error sets aria-invalid + role=alert + extends aria-describedby', () => {
|
|
render(
|
|
<FormField label="Email" error="Must be a valid email address">
|
|
<input type="email" />
|
|
</FormField>,
|
|
);
|
|
const input = screen.getByLabelText('Email');
|
|
expect(input).toHaveAttribute('aria-invalid', 'true');
|
|
const err = screen.getByRole('alert');
|
|
expect(err).toHaveTextContent('Must be a valid email address');
|
|
expect(input.getAttribute('aria-describedby')).toContain(err.id);
|
|
});
|
|
|
|
it('composes cleanly with react-hook-form register() — spread + clone preserves both', () => {
|
|
function Form({ onSubmit }: { onSubmit: (v: { name: string }) => void }) {
|
|
const { register, handleSubmit } = useForm<{ name: string }>();
|
|
return (
|
|
<form onSubmit={handleSubmit(onSubmit)}>
|
|
<FormField label="Name">
|
|
<input {...register('name')} />
|
|
</FormField>
|
|
<button type="submit">Save</button>
|
|
</form>
|
|
);
|
|
}
|
|
let captured = '';
|
|
render(<Form onSubmit={(v) => { captured = v.name; }} />);
|
|
const input = screen.getByLabelText('Name');
|
|
fireEvent.change(input, { target: { value: 'alice' } });
|
|
fireEvent.click(screen.getByText('Save'));
|
|
return new Promise<void>((resolve) => {
|
|
setTimeout(() => {
|
|
expect(captured).toBe('alice');
|
|
// Both RHF's name and FormField's id co-exist.
|
|
expect(input.getAttribute('name')).toBe('name');
|
|
expect(input.id).toMatch(/^field-/);
|
|
resolve();
|
|
}, 10);
|
|
});
|
|
});
|
|
|
|
it('throws clearly when child is not a single valid element', () => {
|
|
// Suppress React's error-boundary console spam for this assertion.
|
|
const orig = console.error;
|
|
console.error = () => {};
|
|
try {
|
|
expect(() =>
|
|
render(
|
|
<FormField label="Bad">
|
|
{'plain string is not valid'}
|
|
</FormField>,
|
|
),
|
|
).toThrow();
|
|
} finally {
|
|
console.error = orig;
|
|
}
|
|
});
|
|
});
|