Files
faunosteo/apps/app/e2e/shell/editor-shell-layout.spec.ts
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

463 lines
16 KiB
TypeScript

import { fr } from '@/i18n/fr'
import type { Page, TestInfo } from '@playwright/test'
import { stepUpAdmin } from '../support/admin'
import {
expect,
expectAccessible,
expectNoHorizontalOverflow,
test,
} from '../support/browser'
import { dropLateReplays, routeToSandbox } from '../support/sandbox'
import {
SECTIONS,
TABS,
closeCitations,
closeFinding,
draftPath,
expectNoDialog,
layersSettled,
draftTitle,
editorActor,
historyButton,
openEditor,
openCitations,
openFinding,
openTab,
openSection,
pickAnnotation,
place,
pointOf,
seedDraft,
selectTab,
shapeWith,
showCitations,
showDrawing,
} from '../support/editor'
import { signIn } from '../support/shell'
// V1-2.6 U1 H (AC10, AC11, AC17): the layout of the five-tab shell at every width, the
// keyboard order of the editor, and axe on every place, edit and narrow read-only.
const dict = fr
const isPhone = (info: TestInfo) => info.project.name === 'chromium-375'
const WIDTHS = [1024, 1180, 1279, 1280]
const NARROW_WIDTHS = [320, 375, 768]
const point = pointOf(
'anno-free',
'main',
{ cx: 120, cy: 120, r: 6 },
'Point libre',
)
async function open(page: Page) {
const actor = await editorActor('fr')
const seed = await seedDraft(actor, { shape: shapeWith(point) })
await openEditor(page, dict, actor, seed.sheetId)
return { ...seed, actor }
}
/**
* Samples the document's size on every frame until stopped (the click that opens or
* closes the panel is inside the window): the distinct sizes seen come back.
*/
async function watchDocumentSize(page: Page) {
await page.evaluate(() => {
const seen = new Set<string>()
const state = { live: true }
const tick = () => {
const root = document.documentElement
seen.add(`${root.scrollWidth}x${root.scrollHeight}`)
if (state.live) requestAnimationFrame(tick)
}
Object.assign(window, { sizes: seen, sampling: state })
tick()
})
return () =>
page.evaluate(() => {
const w = window as unknown as {
sizes: Set<string>
sampling: { live: boolean }
}
w.sampling.live = false
return [...w.sizes]
})
}
/**
* The references dialog lies inside the viewport whatever the page's scroll (it is in
* the top layer), and the focus is inside it.
*/
async function expectCitationsWithin(page: Page) {
const box = await page.evaluate(() => {
const panel = document.querySelector('[data-place="citations"]')!
const rect = panel
.closest('dialog > div:last-child')!
.getBoundingClientRect()
const focused = document.activeElement?.closest('dialog')
return {
left: rect.left,
top: rect.top,
right: rect.right,
bottom: rect.bottom,
width: window.innerWidth,
height: window.innerHeight,
focusInside: !!focused?.contains(panel),
}
})
// Sub-pixel layout rounding (375.00001…): the tolerance of 3a7ffa2.
expect(box.left, 'dialog left edge').toBeGreaterThanOrEqual(0)
expect(box.top, 'dialog top edge').toBeGreaterThanOrEqual(0)
expect(box.right, 'dialog right edge').toBeLessThanOrEqual(box.width + 0.5)
expect(box.bottom, 'dialog bottom edge').toBeLessThanOrEqual(box.height + 0.5)
expect(box.focusInside, 'focus inside the references dialog').toBe(true)
}
async function settle(page: Page) {
await page.evaluate(
() =>
new Promise((done) =>
requestAnimationFrame(() => requestAnimationFrame(done)),
),
)
}
test.describe('editor shell layout (H)', () => {
test.use({ locale: 'fr-FR', actionTimeout: 15_000 })
test.beforeEach(async ({ context }, info) => {
test.skip(isPhone(info), 'the widths are set by the tests themselves') // floor-guard: allow C16 editing needs >= 1024 px; phone read-only covered in editor-access
await routeToSandbox(context)
})
test.afterEach(async ({ context }) => {
await dropLateReplays(context)
})
test('no horizontal scroll from 1 024 to 1 280 px on the five tabs, the three sections and the open references dialog', async ({
page,
}) => {
test.setTimeout(150_000)
await open(page)
for (const width of WIDTHS) {
await page.setViewportSize({ width, height: 800 })
for (const tab of TABS) {
await selectTab(page, dict, tab)
await expectNoHorizontalOverflow(page, `${tab} at ${width} px`)
}
for (const section of SECTIONS) {
await openSection(page, dict, section)
await expectNoHorizontalOverflow(page, `${section} at ${width} px`)
}
await openCitations(page, dict, 'Constat A')
await expectNoHorizontalOverflow(page, `the references at ${width} px`)
await closeCitations(page, dict)
await closeFinding(page, dict)
// The walk is a script: about 20 history entries per width would pass the adapter's
// write budget (40 pushes in 10 s) over four widths. A person never does.
await page.waitForTimeout(4_000)
}
})
test('the open references dialog lies inside the viewport, focus inside, and the document never changes size', async ({
page,
}) => {
test.setTimeout(150_000)
await open(page)
for (const width of WIDTHS) {
await page.setViewportSize({ width, height: 800 })
await openFinding(page, dict, 'Constat A')
const stop = await watchDocumentSize(page)
await showCitations(page)
await expectCitationsWithin(page)
await expectNoHorizontalOverflow(page, `the references at ${width} px`)
await closeCitations(page, dict)
await closeFinding(page, dict)
const sizes = await stop()
expect(
sizes,
`document size at ${width} px, before/during/after`,
).toHaveLength(1)
}
})
test('read-only at 320, 375 and 768 px: the five tabs fit and pass axe', async ({
page,
requests,
}) => {
test.setTimeout(150_000)
const actor = await editorActor('fr')
requests.forbid(actor.account.email, actor.account.password)
const seed = await seedDraft(actor, { shape: shapeWith(point) })
await signIn(page, actor.account, dict)
await page.goto('/app/admin')
await stepUpAdmin(page, dict, actor.secret)
for (const width of NARROW_WIDTHS) {
await page.setViewportSize({ width, height: 800 })
await page.goto(draftPath(seed.sheetId))
await expect(
page.getByRole('heading', { level: 1, name: draftTitle(dict) }),
).toBeVisible()
for (const tab of TABS) {
await openTab(page, dict, tab)
await expectNoHorizontalOverflow(page, `${tab} at ${width} px`)
await expect(
page.getByRole('button', { name: dict['common.save'], exact: true }),
).toHaveCount(0)
if (width !== 320) await expectAccessible(page, `${tab} at ${width} px`)
}
for (const kind of ['undo', 'redo'] as const) {
await expect(historyButton(page, dict, kind)).toHaveAttribute(
'aria-disabled',
'true',
)
}
}
})
test('the canvas width is the same before the references dialog opens and after both layers close', async ({
page,
}) => {
test.setTimeout(150_000)
await open(page)
const measure = async () =>
(await page.getByTestId('annotation-canvas').boundingBox())?.width
for (const width of WIDTHS) {
await page.setViewportSize({ width, height: 800 })
await showDrawing(page, dict)
await pickAnnotation(page, dict, 'Point libre')
const before = await measure()
test.info().annotations.push({
type: 'canvas-width',
description: `${before}px at ${width}px`,
})
await openCitations(page, dict, 'Constat A')
await page.keyboard.press('Escape')
await expect(place(page, 'citations')).toHaveCount(0)
await page.keyboard.press('Escape')
await expectNoDialog(page)
await layersSettled(page)
await selectTab(page, dict, 'annotations')
await expect(place(page, 'citations')).toHaveCount(0)
await expect(page.getByTestId('annotation-canvas')).toBeVisible()
expect(await measure()).toBe(before)
}
})
test('axe from the top on the five tabs, each section and the two open dialogs', async ({
page,
}) => {
test.setTimeout(150_000)
await open(page)
for (const width of [1024, 1280]) {
await page.setViewportSize({ width, height: 800 })
const places: (readonly [string, () => Promise<void>])[] = [
...TABS.map((tab) => [tab, () => selectTab(page, dict, tab)] as const),
...SECTIONS.map(
(section) =>
[section, () => openSection(page, dict, section)] as const,
),
]
for (const [name, show] of places) {
await show()
await settle(page)
await page.evaluate(() => window.scrollTo(0, 0))
await expect(page.locator('dialog[open]')).toHaveCount(0)
await expectAccessible(page, `${name} at ${width} px`)
}
await openFinding(page, dict, 'Constat A')
await settle(page)
await expectAccessible(page, `the finding dialog at ${width} px`)
await showCitations(page)
await settle(page)
await expectAccessible(page, `the references dialog at ${width} px`)
await closeCitations(page, dict)
await closeFinding(page, dict)
}
})
for (const width of WIDTHS) {
test(`the history buttons stay reachable at the top of the page at ${width} px`, async ({
page,
}) => {
await open(page)
await page.setViewportSize({ width, height: 800 })
await page.evaluate(() => window.scrollTo(0, 0))
for (const kind of ['undo', 'redo'] as const) {
const hit = await historyButton(page, dict, kind).evaluate((button) => {
const box = button.getBoundingClientRect()
const at = document.elementFromPoint(
box.x + box.width / 2,
box.y + box.height / 2,
)
return { top: box.y, covered: !at || !button.contains(at) }
})
test.info().annotations.push({
type: 'history-button-top',
description: `${kind} y=${hit.top} at ${width}px covered=${hit.covered}`,
})
expect(hit.covered, `${kind} at ${width} px`).toBe(false)
}
})
}
})
type Kind =
| 'header'
| 'tab'
| 'undo'
| 'redo'
| 'panel'
| 'tools'
| 'canvas'
| 'side'
| 'other'
/** What the focused element is, in the words of the keyboard order of AC17. */
function focusKind(page: Page): Promise<Kind> {
return page.evaluate((undoName) => {
const el = document.activeElement
if (!el) return 'other'
const dialog = el.closest('dialog')
if (dialog?.querySelector('[data-place="citations"]')) return 'panel'
if (el.getAttribute('role') === 'tab') return 'tab'
if (el.closest('[data-testid="history-buttons"]')) {
return el.getAttribute('aria-label') === undoName ? 'undo' : 'redo'
}
if (el.closest('main header')) return 'header'
if (el.closest('[role="toolbar"]')) return 'tools'
if (el.closest('[data-testid="annotation-canvas"]')) return 'canvas'
if (el.closest('[data-testid="annotation-overview"]')) return 'side'
return 'other'
}, dict['editor.history.undo_title'])
}
/** Tabs forward from the page heading until `stop` is reached; the kinds met, without repeats. */
async function walk(page: Page, stop: Kind): Promise<Kind[]> {
await page.getByRole('heading', { level: 1, name: draftTitle(dict) }).focus()
const seen: Kind[] = []
for (let step = 0; step < 60; step++) {
await page.keyboard.press('Tab')
const kind = await focusKind(page)
if (kind !== 'other' && seen[seen.length - 1] !== kind) seen.push(kind)
if (kind === stop) break
}
return seen
}
test.describe('editor shell keyboard order (H)', () => {
test.use({ locale: 'fr-FR', actionTimeout: 15_000 })
test.beforeEach(async ({ context }, info) => {
test.skip(isPhone(info), 'keyboard order is checked at one width') // floor-guard: allow C16 editing needs >= 1024 px; phone read-only covered in editor-access
await routeToSandbox(context)
})
test.afterEach(async ({ context }) => {
await dropLateReplays(context)
})
// The header holds no focusable control after the title while the draft is clean: its
// buttons (« Abandonner », « Enregistrer ») are disabled, and « Références » left it.
test('tab list, Défaire, Refaire, then the tools, the canvas and the side column', async ({
page,
}) => {
await open(page)
await selectTab(page, dict, 'annotations')
await expect(page.getByTestId('annotation-canvas')).toBeVisible()
const order = await walk(page, 'side')
test.info().annotations.push({
type: 'keyboard-order',
description: order.join(' > '),
})
expect(order).toEqual(['tab', 'undo', 'redo', 'tools', 'canvas', 'side'])
})
test('with the references dialog open: Tab stays in it; closed, the order is the page again', async ({
page,
}) => {
await open(page)
await openCitations(page, dict, 'Constat A')
const met = new Set<Kind>()
for (let step = 0; step < 12; step++) {
await page.keyboard.press('Tab')
met.add(await focusKind(page))
}
// The page behind the dialogs is inert: the tab row, Défaire and Refaire are out of reach.
for (const kind of [
'tab',
'undo',
'redo',
'tools',
'canvas',
'side',
] as const) {
expect(met.has(kind), `Tab reached ${kind}`).toBe(false)
}
expect(met.has('panel')).toBe(true)
await page.keyboard.press('Escape')
await expect(place(page, 'citations')).toHaveCount(0)
await page.keyboard.press('Escape')
await expectNoDialog(page)
await layersSettled(page)
await selectTab(page, dict, 'annotations')
const after = await walk(page, 'side')
expect(after.slice(0, 3)).toEqual(['tab', 'undo', 'redo'])
expect(after).not.toContain('panel')
expect(after.at(-1)).toBe('side')
})
})
test.describe('references dialog at 375 px, read-only (O4-2)', () => {
test.use({ locale: 'fr-FR', actionTimeout: 15_000 })
test.beforeEach(async ({ context }, info) => {
test.skip(!isPhone(info), 'the phone sizes are set by the test itself')
await routeToSandbox(context)
})
test.afterEach(async ({ context }) => {
await dropLateReplays(context)
})
test('inside the screen through a height change and a rotation, focus inside, the drawing box unchanged @phone', async ({
page,
}) => {
test.setTimeout(150_000)
await open(page)
await openTab(page, dict, 'annotations')
const drawingBox = () => place(page, 'annotations.drawing').boundingBox()
await expect(place(page, 'annotations.drawing')).toBeVisible()
const drawing = await drawingBox()
await openCitations(page, dict, 'Constat A')
for (const size of [
{ width: 375, height: 667 },
{ width: 375, height: 560 },
{ width: 667, height: 375 },
]) {
await page.setViewportSize(size)
await page.evaluate(
() => new Promise((done) => requestAnimationFrame(() => done(null))),
)
await expectCitationsWithin(page)
await expectNoHorizontalOverflow(
page,
`the references at ${size.width} x ${size.height}`,
)
}
await page.setViewportSize({ width: 375, height: 667 })
await closeCitations(page, dict)
await closeFinding(page, dict)
await openTab(page, dict, 'annotations')
await expect(place(page, 'annotations.drawing')).toBeVisible()
expect(await drawingBox()).toEqual(drawing)
})
test('the document size does not change while the two dialogs open and close @phone', async ({
page,
}) => {
test.setTimeout(150_000)
await open(page)
await openFinding(page, dict, 'Constat A')
const stop = await watchDocumentSize(page)
await showCitations(page)
await closeCitations(page, dict)
await closeFinding(page, dict)
expect(await stop()).toHaveLength(1)
})
})