Files
faunosteo/apps/app/tests/unit/editor-focus-request.test.tsx
T
bchanot 8db6f4287f feat(editor): contextual citations panel of a finding (board 25)
The panel opens only from a finding's « {n} références » trigger: 34 rem
at most, never wider than the room, a scrim, slide in 180 ms and out
140 ms (motion/react; none under reduced motion, callbacks still fire).
It lists the finding's references as tiles with « Modifier », « Retirer
de ce constat » (one « Défaire » restores it and the review status) and
« Aller à »; dangling ids read « Référence introuvable »; zero left
reads « Ce constat ne cite plus aucune référence. ». « Tout afficher
dans l'onglet Références » resets search and sort, keeps open tiles and
edits. Every close (✕, Escape outside fields, scrim, tab, « Aller à »,
« Tout afficher », element gone) records one pending move applied
after the exit, page inert until then; focus back to the trigger, else
the active tab button. A refused draft cancels a user close; a forced
close drops it and announces « Saisie non appliquée : {field} ». Places
keeps a permanent dvh min-height; the panel fits the visible viewport
at every scroll position, document size unchanged.

Gates: typecheck, lint, test:run (app 1488), build, e2e:ui 251;
e2e:shell 16 specs on db:sandbox (admin and editor-equine excluded):
117 passed / 107 skipped / 0 failed, rerun after the fix rounds: 118
passed / 108 skipped / 0 failed; layout spec 13 passed after round 2;
full-row guard: no pre-existing row changed in any table. Known limit:
landscape 667 x 375 at scroll 0 leaves ~13 px of panel (the trigger is
below the fold there).

## R-24 (removed or rewritten assertions)

| file | old | new |
|---|---|---|
| editor-references-panel.test.tsx (whole file) | R2.1 interim-panel tests, synchronous closes | rewritten: 39 tests (opening, motion, close matrix in both modes, exit, Retirer, P22'', library + history) |
| same, opening | heading `Références` focused right after the click | heading `Références citées` focused after the enter (`waitFor`), `aria-expanded` only after click |
| same | chip `references-filter-chip` « Citées par « Node A » (2) » | REMOVED (REVUE: path line + count line « 2 références citées par ce constat ») |
| same | `listitem` cards « Citée 2 fois » | tiles (`ul > li`) with the same counts, in the finding's order |
| same | field id `#panel-reference-0-ref-a-citation` present at once | tile opened + « Modifier » first (tiles since R2.2) |
| same | « Tout afficher (3) », sync | « Tout afficher dans l'onglet Références », after exit, heading focus asserted |
| same | Escape / ✕ / scrim / tab / vanish: sync null panel | all `await closed()` + `document.activeElement` checks, `describe.each` normal / reduced motion |
| same | « makes the tab panels inert while open, header usable » | split: inert page + inert panel until the exit ends then lifted; « Défaire / Refaire usable »; the `Enregistrer` enabled check dropped (covered by the focus-moved-off test) |
| same | Ctrl+Z test on an always-open field | open tile + Modifier first |
| same | read-only: no Supprimer, no textbox | open tile: no Modifier, no Retirer, no textbox |
| same | P6 under « Plus »: sync | in the close matrix, awaited |
| editor-escape.test.tsx (2 tests) | `expect(citations()).toBeNull()` right after Escape | `await waitFor(...)`; trigger `aria-expanded` false after exit |
| editor-keep-alive.test.tsx | « Escape in a citations panel field commits the text before the panel closes » | REPLACED by « Escape in a field of a panel tile neither closes nor commits » (A5, P27) |
| same | scrim click closes the panel after committing, sync, id on a closed tile | tile opened in edit first, close awaited, commit asserted before the exit |
| editor-focus-request.test.tsx | `ReferenceLibrary` with `resetSignal`; `ownedBy(ref,'citations')` undefined | `ReferencesTab` (+ `reloadSheet`); the `'citations'` assertion removed with the type |
| editor-references-tab / -view.test.tsx | `ReferenceLibrary`, `resetSignal` | `ReferencesTab`, `libraryReset` (+ `reloadSheet`) |
| e2e support `openCitations` | waited for the panel visible | also waits for the heading focus (slide over) |

New unit coverage: editor-citations-exit.test.tsx (hook, fake timers), editor-findings (aria-expanded per finding),
`useDecisionsOpen` gate, panel file (Retirer + status + one undo, P20 chain, zero state, dangling id, P4 reset, P6 after undo,
P22'' four paths, reduced motion, inert/exit, second close, tab replace, focus-moved-off).

## i18n (FR / EN)

Added: `editor.references.panel_title` Références citées / Cited references; `panel_count_one|other` « {count} référence citée par
ce constat » / « {count} références citées par ce constat » and « {count} reference cited by this finding » / « … references … »;
`panel_show_all` Tout afficher dans l'onglet Références / Show all in the References tab; `panel_empty` Ce constat ne cite plus
aucune référence. / This finding no longer cites any reference.; `remove_citation` Retirer de ce constat / Remove from this finding;
`this_finding` ce constat / this finding; `missing` Référence introuvable / Reference not found; `draft_dropped`
Saisie non appliquée : {field} / Entry not applied: {field}.
Changed: none. Removed: `editor.references.cited_by` (« Citées par « {name} » ({count}) » / « Cited by « {name} » ({count}) »),
`editor.references.show_all` (« Tout afficher ({count}) » / « Show all ({count}) »). R10 grep over src, tests and e2e including
editor-equine: no reader left. `editor-equine` has no panel reference: « updated, not run » (nothing to update). The three
provisional FR labels are exactly as listed in the brief; `…` = the refused field's label.
2026-11-12 22:27:32 +01:00

470 lines
14 KiB
TypeScript

/** « Aller à … »: each request reaches the place its target names, once, and never lands on body. */
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { useState } from 'react'
import {
cleanup,
render,
screen,
waitFor,
within,
} from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import type {
AnatomicalSheetDocument,
ElementKey,
} from '@faunosteo/core-wasm/types'
import FindingsTab from '@/components/editor/tabs/FindingsTab'
import RegionsSection from '@/components/editor/annotations/sections/RegionsSection'
import EditorTabBody from '@/components/editor/EditorTabBody'
import EditorTabs from '@/components/editor/EditorTabs'
import ReferencesTab from '@/components/editor/tabs/ReferencesTab'
import AnnotationsTab from '@/components/editor/tabs/AnnotationsTab'
import {
FocusConsumedContext,
isTextField,
ownedBy,
type FocusRequest,
} from '@/editor/focusRequest'
import { targetOfKey, type EditorTarget } from '@/editor/navigation'
import { useEditorNavigation } from '@/editor/useEditorNavigation'
import { issueTarget } from '@/editor/verification'
import { useLocaleStore } from '@/state/localeStore'
import { edit, insert, point } from '../helpers/editorFixtures'
import {
baseText,
openReady,
resetStore,
store,
} from '../helpers/editorHarness'
vi.mock('@/lib/supabase', () => ({ getSupabaseClient: () => ({}) }))
vi.mock('@faunosteo/supabase', async (orig) => ({
...(await orig<typeof import('@faunosteo/supabase')>()),
getSheetVersion: vi.fn(),
downloadSheetDrawing: vi.fn(),
saveSheetDraft: vi.fn(),
getOfficialSheetAdmin: vi.fn(),
submitSheetReview: vi.fn(),
}))
const base = { readOnly: false, navigate: vi.fn(), reloadSheet: vi.fn() }
const section = {
section: 'drawing' as const,
visited: ['drawing'] as const,
onOpenSection: vi.fn(),
onBack: vi.fn(),
}
const request = (key: ElementKey, serial = 1): FocusRequest => ({
target: targetOfKey(key),
serial,
})
const doc = (): AnatomicalSheetDocument =>
JSON.parse(store.getState().documentText)
const name = (n: string) => ({ fr: n, en: n })
beforeEach(() => useLocaleStore.setState({ locale: 'fr' }))
afterEach(() => {
cleanup()
resetStore()
})
function findingsText(): string {
let text = insert(baseText(), {
kind: 'zone',
value: { id: 'zone-a', name: name('Zone A'), categories: [] },
})
text = edit(text, {
op: 'insert',
parent: { kind: 'zone', id: 'zone-a' },
element: {
kind: 'finding_category',
value: {
id: 'fcat-a',
kind: 'dysfunction',
name: name('Cat A'),
description: {},
reference_ids: [],
review_status: 'to_confirm',
children: [],
},
},
})
return edit(text, {
op: 'insert',
parent: { kind: 'finding', zone_id: 'zone-a', path: ['fcat-a'] },
element: {
kind: 'finding_node',
value: {
id: 'node-a',
name: name('Nœud A'),
description: {},
requires_vet_referral: false,
reference_ids: [],
review_status: 'to_confirm',
children: [],
},
},
})
}
describe('focus requests', () => {
it('Constats: expands to the finding, selects it and shows its detail', async () => {
await openReady({ text: findingsText() })
const key: ElementKey = {
kind: 'finding',
zone_id: 'zone-a',
path: ['fcat-a', 'node-a'],
}
render(<FindingsTab {...base} focus={request(key)} />)
const item = await screen.findByRole('treeitem', { name: /Nœud A/ })
expect(item.getAttribute('aria-selected')).toBe('true')
await waitFor(() => expect(document.activeElement).toBe(item))
})
it('Annotations: selects the annotation and focuses the properties heading', async () => {
const text = insert(baseText(), point('anno-b', 20, 20, 3))
await openReady({ text })
render(
<AnnotationsTab
{...base}
{...section}
focus={request({ kind: 'annotation', id: 'anno-b' })}
/>,
)
// anno-b and anno-a share a name: the circle's centre tells which one is selected.
const properties = await screen.findByTestId('annotation-properties')
expect(within(properties).getByLabelText('Centre x')).toHaveValue('20')
await waitFor(() =>
expect(document.activeElement).toHaveAttribute('data-properties-heading'),
)
expect(properties).toContainElement(document.activeElement as HTMLElement)
})
it('Références and Régions: focus the named row', async () => {
let text = insert(baseText(), {
kind: 'reference',
value: {
id: 'ref-a',
type: 'book',
citation: 'Alpha',
url: null,
doi: null,
},
})
text = insert(text, {
kind: 'region',
value: {
code: 'C',
name: name('Cervicales'),
count: 7,
count_range: null,
},
})
await openReady({ text })
render(
<ReferencesTab
{...base}
focus={request({ kind: 'reference', id: 'ref-a' })}
/>,
)
expect(document.activeElement?.getAttribute('data-focus-key')).toContain(
'ref-a',
)
cleanup()
render(
<RegionsSection
{...base}
focus={request({ kind: 'region', code: 'C' })}
/>,
)
expect(document.activeElement?.getAttribute('data-focus-key')).toContain(
'"C"',
)
})
it('consumes a serial once', async () => {
const text = insert(baseText(), {
kind: 'reference',
value: {
id: 'ref-a',
type: 'book',
citation: 'Alpha',
url: null,
doi: null,
},
})
await openReady({ text })
const focus = request({ kind: 'reference', id: 'ref-a' })
const view = render(<ReferencesTab {...base} focus={focus} />)
;(document.activeElement as HTMLElement).blur()
view.rerender(<ReferencesTab {...base} focus={focus} />)
expect(document.activeElement?.getAttribute('data-focus-key')).toBeNull()
})
it('reports found, or none when the place holds no such element', async () => {
await openReady({ text: findingsText() })
const consumed = vi.fn()
const gone: ElementKey = { kind: 'zone', id: 'zone-gone' }
render(
<FocusConsumedContext value={consumed}>
<FindingsTab {...base} focus={request(gone, 4)} />
</FocusConsumedContext>,
)
await waitFor(() => expect(consumed).toHaveBeenCalledWith(4, 'none'))
})
})
describe('ownedBy', () => {
it('passes a request only to the place its target names', () => {
const view = request({ kind: 'view', id: 'view-main' })
expect(ownedBy(view, 'annotations.views')).toBe(view)
expect(ownedBy(view, 'annotations.drawing')).toBeUndefined()
expect(ownedBy(view, 'general')).toBeUndefined()
const ref = request({ kind: 'reference', id: 'ref-a' })
expect(ownedBy(ref, 'references')).toBe(ref)
expect(ownedBy(ref, 'findings')).toBeUndefined()
expect(ownedBy(undefined, 'general')).toBeUndefined()
})
})
describe('issueTarget', () => {
it('resolves nested finding paths, regions and references', async () => {
await openReady({ text: findingsText() })
const d = doc()
const path = 'finding_zones[0].categories[0].children[0].reference_ids[1]'
expect(issueTarget(d, path, 'fr')).toMatchObject({
target: {
place: 'tab',
tab: 'findings',
key: { kind: 'finding', zone_id: 'zone-a', path: ['fcat-a', 'node-a'] },
},
name: 'Nœud A',
})
expect(issueTarget(d, 'finding_zones[0]', 'fr')?.target).toMatchObject({
key: { kind: 'zone', id: 'zone-a' },
})
expect(
issueTarget(d, 'vertebral_config.regions[3].count_range', 'fr'),
).toMatchObject({
target: { tab: 'annotations', section: 'regions', key: null },
})
expect(issueTarget(d, 'nothing', 'fr')).toBeNull()
})
})
/** The workspace's wiring in miniature: the hook, the tab row, the shown body. */
function Probe({ go, tier }: { go: EditorTarget; tier: 'wide' | 'small' }) {
const nav = useEditorNavigation('verification')
const { state } = nav
return (
<FocusConsumedContext value={nav.consumed}>
<EditorTabs active={state.tab} tier={tier} onSelect={nav.selectTab} />
<button onClick={() => nav.navigate(go)}>go</button>
<EditorTabBody
tab={state.tab}
visited={state.visitedTabs}
{...base}
navigate={nav.navigate}
openCitations={nav.openCitations}
focus={state.focus}
annotations={{
section: state.section,
visited: state.visitedSections,
onOpenSection: nav.openSection,
onBack: nav.backToDrawing,
}}
/>
</FocusConsumedContext>
)
}
function ShowAllProbe() {
const nav = useEditorNavigation('findings')
return (
<>
<EditorTabs active={nav.state.tab} tier="wide" onSelect={nav.selectTab} />
<button onClick={nav.showAllReferences}>show all</button>
</>
)
}
describe('« Tout afficher » landing', () => {
it('falls back to the tab button when the tab heading is absent', async () => {
await openReady()
const user = userEvent.setup()
render(<ShowAllProbe />)
await user.click(screen.getByText('show all'))
await waitFor(() =>
expect(document.activeElement).toBe(
screen.getByRole('tab', { name: 'Références' }),
),
)
})
})
describe('a request that finds nothing', () => {
const missing: EditorTarget = {
place: 'tab',
tab: 'findings',
section: null,
key: { kind: 'zone', id: 'zone-gone' },
}
it('lands on the tab button, never on body', async () => {
await openReady({ text: findingsText() })
const user = userEvent.setup()
render(<Probe go={missing} tier="wide" />)
await user.click(screen.getByText('go'))
await waitFor(() =>
expect(document.activeElement).toBe(
screen.getByRole('tab', { name: 'Constats' }),
),
)
})
it('below 640 px lands on « Plus » while the tab sits in its closed list', async () => {
await openReady({ text: findingsText() })
const user = userEvent.setup()
render(<Probe go={missing} tier="small" />)
await user.click(screen.getByText('go'))
await waitFor(() =>
expect(document.activeElement).toBe(
screen.getByRole('button', { name: 'Plus' }),
),
)
})
it('Vérification « Aller à » a reference: the tab shows, its row holds the focus', async () => {
const text = insert(baseText(), {
kind: 'reference',
value: {
id: 'ref-a',
type: 'book',
citation: 'Alpha',
url: null,
doi: null,
},
})
await openReady({ text })
const user = userEvent.setup()
const key: ElementKey = { kind: 'reference', id: 'ref-a' }
render(<Probe go={targetOfKey(key)} tier="wide" />)
await user.click(screen.getByText('go'))
await waitFor(() =>
expect(document.activeElement?.getAttribute('data-focus-key')).toContain(
'ref-a',
),
)
expect(screen.getByRole('tab', { name: 'Références' })).toHaveAttribute(
'aria-selected',
'true',
)
})
it('a reference path that names no element lands on the tab heading', async () => {
await openReady()
const user = userEvent.setup()
const alone: EditorTarget = {
place: 'tab',
tab: 'references',
section: null,
key: null,
}
render(<Probe go={alone} tier="wide" />)
await user.click(screen.getByText('go'))
await waitFor(() =>
expect(document.activeElement).toBe(
screen.getByRole('heading', { name: 'Références' }),
),
)
})
it('a found element keeps the focus it took', async () => {
await openReady({ text: findingsText() })
const user = userEvent.setup()
const key: ElementKey = { kind: 'zone', id: 'zone-a' }
render(<Probe go={targetOfKey(key)} tier="wide" />)
await user.click(screen.getByText('go'))
await waitFor(() =>
expect(document.activeElement).toBe(
screen.getByRole('treeitem', { name: /Zone A/ }),
),
)
})
})
/** The route's contract: one place mounted at a time, the request cleared once consumed. */
function Harness() {
const [shown, setShown] = useState<'references' | 'regions'>('references')
const [focus, setFocus] = useState<FocusRequest | undefined>(
request({ kind: 'reference', id: 'ref-a' }),
)
const clear = (serial: number) =>
setFocus((prev) => (prev?.serial === serial ? undefined : prev))
return (
<FocusConsumedContext value={clear}>
<button
onClick={() =>
setShown(shown === 'references' ? 'regions' : 'references')
}
>
switch
</button>
{shown === 'references' ? (
<ReferencesTab {...base} focus={focus} />
) : (
<RegionsSection {...base} focus={focus} />
)}
</FocusConsumedContext>
)
}
describe('a consumed request', () => {
it('is not replayed when the place is left and reopened', async () => {
const text = insert(baseText(), {
kind: 'reference',
value: {
id: 'ref-a',
type: 'book',
citation: 'Alpha',
url: null,
doi: null,
},
})
await openReady({ text })
const user = userEvent.setup()
render(<Harness />)
expect(document.activeElement?.getAttribute('data-focus-key')).toContain(
'ref-a',
)
await user.click(screen.getByText('switch'))
await user.click(screen.getByText('switch'))
expect(document.activeElement?.getAttribute('data-focus-key')).toBeNull()
})
})
describe('isTextField', () => {
const input = (type: string) => {
const element = document.createElement('input')
element.type = type
return element
}
it('is true for what takes typed text', () => {
for (const type of ['text', 'search', 'email']) {
expect(isTextField(input(type))).toBe(true)
}
expect(isTextField(document.createElement('textarea'))).toBe(true)
expect(isTextField(document.createElement('select'))).toBe(true)
})
it('is false for a checkbox, a radio, a range, a button input', () => {
for (const type of ['checkbox', 'radio', 'range', 'button', 'file']) {
expect(isTextField(input(type))).toBe(false)
}
const off = document.createElement('div')
off.setAttribute('contenteditable', 'false')
expect(isTextField(off)).toBe(false)
})
})