Files
faunosteo/apps/app/tests/unit/editor-escape.test.tsx
T
bchanot cd794f3c39 feat(editor): properties dialog over the column, transactional save
U2 Task 6 (A1, A2, A3, A9, A10, R-3, R-5, R-6, R-14, R-16).

- Dialog: `anchor` places the panel at the column's left and width,
  from its top, under a 22 % ink veil that ignores clicks; the visual
  viewport below 320 px; centred without an anchor box.
- Navigation: `annotation` layer (LAYERS, EditorView, history entry,
  leave guards, left-draft flag); Back closes, Forward reopens.
- AnnotationDialog: read body, « Modifier » form (CreationFields with
  « Couleur », missingFields, R-3 messages), one `update` on the
  current annotation by id, « Marquer comme relu », « Modifier la
  forme », « Supprimer »; read-only flip keeps the draft.
- The column always shows the overview, selected row marked; Enter on
  it, a second click or a double click, the strip's « Propriétés »
  open the dialog. « Aller à » focuses the row (R-5).
- Read-only twin: strip and read-only dialog at 1 024 px and wider,
  inline read body below. PropertiesPanel and AnnotationFields gone.
- Strip lead 256 px and a fixed status slot, so the commands fit at
  1 024 px and a status change moves nothing.
- e2e: `aside-content` exemption removed; scroll-to-top workarounds
  of editor-geometry, editor-zones and editor-journey removed.

Removed assertions mapped:
  editor-annotations-tab.test.tsx:
  - selectFromList waited for `annotation-properties` -> waits for the strip's « Propriétés » (selection without dialog, A1)
  - refused place: issues block `annotation-geometry-issues` in the panel -> the strip notice alert (present, then gone)
  - keyboard creation / C26 confirmation: `annotation-properties` after create -> strip « Propriétés » (new element selected)
  - Désélectionner from the panel -> « Désélectionner » in the strip (all 7 tests); « panel closes » -> strip has no « Propriétés »
  - undo after deselect (typed name) -> handle key series then deselect then undo
  - commits a valid typed value once without blur (name field) -> a pending handle key series committed once by the strip deselect
  - a refused typed value: the panel closes (two tests: strip deselect, tap deselect) -> removed: no field outside the dialog; the dialog's draft writes nothing before « Enregistrer » (new dialog tests)
  - not offered while a replace tracing runs: panel's Désélectionner absent -> strip offers neither « Désélectionner » nor « Propriétés » during the tracing
  - tap: isDeselected read `annotation-properties` -> strip « Propriétés » absent; link select -> strip title data-selection
  - tap: undo after tap deselect (typed name) -> handle series; typed value committed on blur -> handle series committed on blur
  - strip geometry issues: list read in the panel -> list read in the properties dialog's issues block
  - a new commit replaces the message (typed name) -> « Marquer comme relu » in the dialog
  editor-escape.test.tsx:
  - `panel()` = `annotation-properties` -> the strip's « Propriétés » or the phone twin's inline read body
  - Escape from a panel button (« Marquer comme relu ») -> from the selected row in the side column: focus on the row
  - after A then B from the panel (via « Toutes les annotations ») -> select A, select B, Escape from a button of the side column: focus on B's row
  - a text field (panel « Nom (FR) ») -> the overview « Filtrer par nom »
  - redraw via the panel's « Remplacer par un polygone » -> the strip's command
  - modal / delete dialog opened by the panel's « Supprimer » -> « Supprimer » of the properties dialog
  - read-only width: hidden `annotation-properties` -> hidden strip « Propriétés » of the kept edit body
  editor-history-buttons.test.tsx (typed text and the press, 8 tests): the annotation's committed « Nom (FR) » field of the panel -> the sheet's committed « Nom (FR) » on Général (same TextField commit-on-blur path; annotation fields are now a dialog draft)
  editor-focus-request.test.tsx: « Aller à » focuses `data-properties-heading` inside `annotation-properties` -> focuses the annotation's row, marked aria-current, no dialog (R-5)
  editor-sections.test.tsx: « Aller à » with nothing in progress focused the properties heading -> focuses the row (R-5); creation kept: no `annotation-properties` -> no strip « Propriétés »
  editor-overview.test.tsx (edit and read-only): row opens `annotation-properties`, « Toutes les annotations » returns -> row selects, stays marked aria-current, no dialog; strip « Désélectionner » returns focus to the row; filter kept across select and « Désélectionner »
  editor-citations-guards.test.tsx: LAYERS_TOP_DOWN gains 'annotation' at the bottom
  editor-keep-alive.test.tsx: `annotation-properties` visible after the round trip -> the strip's « Propriétés » visible (selection kept)
  editor-no-loss.test.tsx: ids `ro-annotation-name-fr` and `annotation-name-fr` (both panels' fields) -> the twin's inline read body (no ids), then the dialog edit form's `annotation-edit-fr`, kept through a flip to 800 px, no duplicate id; « Aller à » visible `annotation-properties` -> visible `annotation-read` (inline twin), none at 1 280
  editor-point-edit.test.tsx / editor-zone-edit.test.tsx: `select()` waited for `annotation-properties` and returned it -> waits for the strip's « Propriétés » and returns the strip (its « Désélectionner » and « Remplacer par un polygone » moved there)
  - move mode Escape: `annotation-properties` still there -> the strip's « Propriétés » back after the mode
  - « Toutes les annotations » asks first during a started move -> Enter on the selected row asks first (no dialog), and the strip offers neither « Propriétés » nor « Désélectionner » during the mode
  - Escape from the handle / slider: `annotation-properties` gone -> the strip's « Propriétés » gone
  - I-3 touch tap: `annotation-properties` gone -> the strip's « Propriétés » gone
  e2e (sandbox):
  - support/layout.ts: `aside-content` exemption removed (ShiftExemption type, the loose compare); every `swaps`/`SWAPS` argument removed (editor-annotations, editor-zones, editor-geometry)
  - support/editor.ts pickAnnotation: clicked « Toutes les annotations » first when the panel showed -> the overview is always shown: clicks the row, then scrolls back to the top (the page no longer shortens)
  - editor-annotations: `annotation-properties` visible after a creation -> strip with « Propriétés »; review toggle and « Supprimer » of the panel -> the properties dialog's; a jitter click on the selected point now opens the dialog (A1), closed by Escape before the drag; handle names exact (the marked row shares the prefix); trace close moved out of expectNoShift (creation panel until Task 7, shortcut + TODO)
  - editor-deselect: `annotation-properties` -> the strip with « Propriétés » or the twin's inline read body; Escape in a field: panel « Nom (FR) » -> overview filter; delete dialog from the panel -> from the properties dialog (Escape closes it, then the dialog); « a typed value is applied by the click that deselects » (name field, refused blank) -> a pending point-handle key series applied by the deselecting click and by « Désélectionner » (refused value: no field outside the dialog); « the selected one stays » -> a second click, double click and jitter open the dialog, Escape closes it, selection kept
  - editor-geometry: `annotation-geometry-issues` in the panel -> read in the properties dialog, then the strip notice; after the refusal the error count unchanged; scroll-to-top workaround removed
  - editor-zones: panel « Désélectionner » -> strip; scroll-to-top after pickAnnotation removed (helper does it)
  - editor-structures: panel « Supprimer » -> properties dialog « Supprimer », confirmation over it
  - editor-journey: `#annotation-name-fr` committed field + `#annotation-laterality` -> the dialog's edit form, one « Enregistrer »; scroll-to-top removed
  - editor-shell / editor-shell-journeys: « Aller à » focus on `data-properties-heading` -> the annotation's row (aria-current), no dialog (R-5)
  - editor-shell-layout: focus kind `annotation-properties` -> removed (the overview is the side)
2026-11-17 22:01:57 +01:00

391 lines
13 KiB
TypeScript

/** R1 (A5, A6): the Escape priority across the whole editor workspace. */
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import {
act,
cleanup,
fireEvent,
render,
screen,
waitFor,
within,
} from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import type { Annotation } from '@faunosteo/core-wasm/types'
import ModalDialog from '@/components/ui/ModalDialog'
import { useLocaleStore } from '@/state/localeStore'
import { drawnText, edit, insert, point } from '../helpers/editorFixtures'
import { pressAt, resetStore, serverHas, store } from '../helpers/editorHarness'
import { openFinding } from '../helpers/findingDialog'
import { mountDraft, setWidth } from '../helpers/editorRoute'
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(),
}))
beforeEach(() => {
useLocaleStore.setState({ locale: 'fr' })
const identity = { a: 1, b: 0, c: 0, d: 1, e: 0, f: 0 }
Object.defineProperty(window.SVGElement.prototype, 'getScreenCTM', {
configurable: true,
value: () => ({ ...identity, inverse: () => identity }),
})
})
afterEach(() => {
cleanup()
resetStore()
setWidth(1024)
})
const TWO = () =>
insert(
insert(drawnText(), point('anno-a', 50, 50, 5)),
point('anno-b', 20, 20, 3),
)
const ZONE = () =>
insert(drawnText(), {
kind: 'annotation',
value: {
...(point('zone-a', 0, 0, 1).value as Annotation),
kind: 'zone',
geometry: { type: 'path', d: 'M 20 20 L 80 20 L 50 80 Z' },
} as Annotation,
})
/** TWO plus a finding node that cites one reference: the citations panel has a trigger. */
const WITH_NODE = () => {
const name = (n: string) => ({ fr: n, en: n })
let text = insert(TWO(), {
kind: 'reference',
value: {
id: 'ref-a',
type: 'book',
citation: 'Alpha',
url: null,
doi: null,
},
})
text = insert(text, {
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: 'fnode-a',
name: name('Node A'),
description: {},
reference_ids: ['ref-a'],
requires_vet_referral: false,
review_status: 'to_confirm',
children: [],
},
},
})
}
const shown = (selector: string) =>
[...document.querySelectorAll<HTMLElement>(selector)].find(
(element) => !element.closest('[hidden]'),
)
/**
* The visible selection (U2 Task 6: the properties left the side panel): the strip's
* « Propriétés », or the phone twin's inline read body.
*/
const panel = () =>
shown('[data-properties-button]') ?? shown('[data-testid="annotation-read"]')
/** The shown body's right column: the overview (A3). */
const aside = () => shown('[data-annotation-aside]')!
const rowOf = (id: string) =>
shown(`[data-focus-key='{"kind":"annotation","id":"${id}"}']`)
const live = () => document.querySelector('[aria-live="polite"]')!
const escape = (target: Element | Window = document.body) =>
fireEvent.keyDown(target, { key: 'Escape' })
async function mount(text = TWO(), width?: number) {
serverHas(text, 3)
const user = userEvent.setup()
mountDraft({ width })
await screen.findByRole('heading', { level: 1, name: 'Brouillon, version 4' })
await waitFor(() =>
expect(shown('[data-testid$="canvas-drawing"] svg')).toBeDefined(),
)
return user
}
/** Selects through the overview row (the visible body's). */
async function select(user: ReturnType<typeof userEvent.setup>, id = 'anno-a') {
await waitFor(() => expect(rowOf(id)).toBeDefined())
await user.click(rowOf(id)!)
await waitFor(() => expect(panel()).toBeDefined())
}
const canvasBox = () =>
shown('[data-place="annotations.drawing"] [role="group"][tabindex="0"]')!
const citations = () => screen.queryByTestId('editor-citations-panel')
/** Constats, the node selected, its « 1 référence » trigger pressed. */
async function openCitations(user: ReturnType<typeof userEvent.setup>) {
await user.click(screen.getByRole('tab', { name: 'Constats' }))
await openFinding(user, /Node A/)
await user.click(screen.getByRole('button', { name: '1 référence' }))
expect(citations()).not.toBeNull()
}
const inStrip = (name: string) =>
within(shown('[data-testid="edit-strip"]')!).getByRole('button', { name })
/** « Propriétés », then a button of the properties dialog. */
async function inDialog(
user: ReturnType<typeof userEvent.setup>,
name: string,
) {
await user.click(inStrip('Propriétés'))
const dialog = await screen.findByRole('dialog')
return within(dialog).getByRole('button', { name })
}
describe('Escape deselects', () => {
it('from the canvas box: deselected, the focus stays, announced', async () => {
const user = await mount()
await select(user)
canvasBox().focus()
escape(canvasBox())
expect(panel()).toBeUndefined()
expect(document.activeElement).toBe(canvasBox())
await waitFor(() =>
expect(live()).toHaveTextContent('Aucune annotation sélectionnée.'),
)
})
it('from a button of the side column: deselected, the focus on the row', async () => {
const user = await mount()
await select(user)
rowOf('anno-a')!.focus()
escape(document.activeElement!)
expect(panel()).toBeUndefined()
expect(document.activeElement).toBe(rowOf('anno-a'))
})
it("after A then B, from the panel: the focus on B's row", async () => {
const user = await mount()
await select(user, 'anno-a')
await select(user, 'anno-b')
within(aside()).getAllByRole('button')[0]!.focus()
escape(document.activeElement!)
expect(document.activeElement).toBe(rowOf('anno-b'))
})
it('from body and from the history button of the tab row', async () => {
const user = await mount()
await select(user)
escape(document.body)
expect(panel()).toBeUndefined()
await select(user)
act(
() =>
void store
.getState()
.commit({ op: 'remove', key: { kind: 'annotation', id: 'anno-b' } }),
)
const undo = screen.getByRole('button', { name: /Défaire/ })
await waitFor(() => expect(undo).toBeEnabled())
undo.focus()
escape(undo)
expect(panel()).toBeUndefined()
expect(document.activeElement).toBe(undo)
})
})
describe('Escape leaves alone', () => {
it('a text field', async () => {
const user = await mount()
await select(user)
const field = within(aside()).getByLabelText('Filtrer par nom')
field.focus()
escape(field)
expect(panel()).toBeDefined()
})
it('a target outside the workspace', async () => {
const user = await mount()
await select(user)
const outside = document.createElement('button')
document.body.append(outside)
outside.focus()
escape(outside)
outside.remove()
expect(panel()).toBeDefined()
})
it('nothing selected, or the selected annotation deleted: no announcement', async () => {
const user = await mount()
escape(document.body)
expect(live()).toBeEmptyDOMElement()
await select(user)
act(
() =>
void store
.getState()
.commit({ op: 'remove', key: { kind: 'annotation', id: 'anno-a' } }),
)
const before = store.getState().documentText
escape(document.body)
expect(live()).toBeEmptyDOMElement()
expect(store.getState().documentText).toBe(before)
})
it('a new zone tracing: the strip tracing commands keep their Escape (Task 7 asks)', async () => {
const user = await mount(ZONE())
await user.click(screen.getByRole('button', { name: 'Zone' }))
pressAt(canvasBox(), 20, 20)
const bar = await screen.findByTestId('tracing-commands')
bar.focus()
escape(bar)
expect(screen.queryByTestId('tracing-commands')).not.toBeNull()
})
// U2 Task 5 (R-12, board 32 row 4): « Remplacer par un polygone » is a redraw, which
// Escape cancels at once from anywhere in the workspace, the strip's commands included
// (before Task 5 only the canvas box did). The selection stays.
it('a redraw: Escape on the strip commands or on the canvas box cancels the tracing only', async () => {
const user = await mount(ZONE())
await select(user, 'zone-a')
await user.click(inStrip('Remplacer par un polygone'))
const bar = await screen.findByTestId('tracing-commands')
bar.focus()
escape(bar)
await waitFor(() =>
expect(screen.queryByTestId('tracing-commands')).toBeNull(),
)
expect(panel()).toBeDefined()
await user.click(inStrip('Remplacer par un polygone'))
await screen.findByTestId('tracing-commands')
canvasBox().focus()
escape(canvasBox())
await waitFor(() =>
expect(screen.queryByTestId('tracing-commands')).toBeNull(),
)
expect(panel()).toBeDefined()
})
it('a modal dialog open: only its own handling (wiring proof)', async () => {
const user = await mount()
await select(user)
await user.click(await inDialog(user, 'Supprimer'))
const dialog = document.querySelectorAll('dialog[open]')[1]!
expect(dialog).not.toBeNull()
escape(dialog)
expect(panel()).toBeDefined()
})
})
describe('Escape with the focus on the page', () => {
it('a delete dialog open: the selection is kept', async () => {
const user = await mount()
await select(user)
await user.click(await inDialog(user, 'Supprimer'))
expect(document.querySelector('dialog[open]')).not.toBeNull()
document.body.focus()
escape(document.body)
expect(panel()).toBeDefined()
})
it('the citations sheet open: Escape closes it only, the annotation selection is kept', async () => {
const user = await mount(WITH_NODE())
await select(user)
await openCitations(user)
const trigger = screen.getByRole('button', { name: '1 référence' })
expect(trigger).toHaveAttribute('aria-haspopup', 'dialog')
await user.keyboard('{Escape}')
await waitFor(() => expect(citations()).toBeNull())
await waitFor(() => expect(trigger).toHaveFocus())
// the finding dialog under the sheet is still there: a second Escape closes it
expect(document.querySelector('dialog[open]')).not.toBeNull()
await user.keyboard('{Escape}')
await waitFor(() =>
expect(document.querySelector('dialog[open]')).toBeNull(),
)
await user.click(screen.getByRole('tab', { name: 'Annotations' }))
expect(panel()).toBeDefined()
})
it('a dialog outside the workspace open: the selection is kept', async () => {
const user = await mount()
await select(user)
render(
<ModalDialog onClose={() => undefined} label="Outside">
<p>Outside</p>
</ModalDialog>,
)
escape(document.body)
expect(panel()).toBeDefined()
})
it('« Plus » open, Escape in the twin filter: the menu and the field stay', async () => {
const user = await mount(TWO(), 500)
const more = screen.getByRole('button', { name: 'Plus' })
await user.click(more)
const filter = within(
shown('[data-testid="annotation-overview"]')!,
).getByRole('searchbox', { name: 'Filtrer par nom' })
filter.focus()
escape(filter)
expect(more).toHaveAttribute('aria-expanded', 'true')
expect(document.activeElement).toBe(filter)
})
})
describe('Escape and the other layers', () => {
it('closes « Plus » first (small tier), the twin selection kept', async () => {
const user = await mount(TWO(), 500)
await select(user)
const more = screen.getByRole('button', { name: 'Plus' })
await user.click(more)
expect(more).toHaveAttribute('aria-expanded', 'true')
canvasBox().focus()
escape(canvasBox())
expect(more).toHaveAttribute('aria-expanded', 'false')
expect(document.activeElement).toBe(more)
expect(panel()).toBeDefined()
})
it('read-only width: only the visible twin deselects, the hidden body keeps its own', async () => {
const user = await mount()
await select(user)
setWidth(500)
act(() => void window.dispatchEvent(new Event('resize')))
await waitFor(() =>
expect(shown('[data-testid="catalogue-canvas"]')).toBeDefined(),
)
await select(user)
escape(document.body)
expect(panel()).toBeUndefined()
const hidden = [
...document.querySelectorAll('[data-properties-button]'),
].filter((element) => element.closest('[hidden]'))
expect(hidden).toHaveLength(1)
})
})