Files
faunosteo/apps/app/tests/unit/editor-escape.test.tsx
T

298 lines
9.7 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, insert, point } from '../helpers/editorFixtures'
import { resetStore, serverHas, store } from '../helpers/editorHarness'
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,
})
const shown = (selector: string) =>
[...document.querySelectorAll<HTMLElement>(selector)].find(
(element) => !element.closest('[hidden]'),
)
const panel = () => shown('[data-testid="annotation-properties"]')
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 inPanel = (name: string) => within(panel()!).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 panel: deselected, the focus on the row', async () => {
const user = await mount()
await select(user)
inPanel('Marquer comme relu').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 user.click(inPanel('Toutes les annotations'))
await select(user, 'anno-b')
inPanel('Marquer comme relu').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(panel()!).getByLabelText('Nom (FR)')
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 tracing: the TracingBar keeps its Escape, the canvas box cancels the tracing only', async () => {
const user = await mount(ZONE())
await select(user, 'zone-a')
await user.click(inPanel('Remplacer par un polygone'))
const bar = await screen.findByTestId('tracing-bar')
bar.focus()
escape(bar)
expect(screen.queryByTestId('tracing-bar')).not.toBeNull()
canvasBox().focus()
escape(canvasBox())
await waitFor(() => expect(screen.queryByTestId('tracing-bar')).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(inPanel('Supprimer'))
const dialog = document.querySelector('dialog')!
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(inPanel('Supprimer'))
expect(document.querySelector('dialog[open]')).not.toBeNull()
document.body.focus()
escape(document.body)
expect(panel()).toBeDefined()
})
it('the references panel open: it closes, the selection is kept', async () => {
const user = await mount()
await select(user)
const toggle = screen.getByRole('button', { name: 'Références' })
await user.click(toggle)
expect(toggle).toHaveAttribute('aria-expanded', 'true')
escape(document.body)
expect(toggle).toHaveAttribute('aria-expanded', 'false')
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 the references panel from the tab row, the selection kept', async () => {
const user = await mount()
await select(user)
await user.click(screen.getByRole('button', { name: 'Références' }))
const tab = screen.getByRole('tab', { name: 'Annotations' })
escape(tab)
expect(screen.getByRole('button', { name: 'Références' })).toHaveAttribute(
'aria-expanded',
'false',
)
expect(panel()).toBeDefined()
})
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-testid="annotation-properties"]'),
].filter((element) => element.closest('[hidden]'))
expect(hidden).toHaveLength(1)
})
})