Files
faunosteo/apps/app/e2e/shell/editor-shell-layout.spec.ts
T
bchanot c893dec60b feat(editor): « Aller à » opens the finding dialog, spec races fixed
« Aller à » a finding shows its row and opens its dialog in view mode.
E2e helpers wait for the history to settle after a layer or section
pop; the layout walk waits out the write budget. Label rows for the
nine new keys.
2026-11-13 19:23:48 +01:00

459 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]
})
}
const REM = 16
/**
* The sheet is a modal at the right edge: at most 34 rem and no wider than the viewport,
* as tall as the window whatever the page's scroll (it is in the top layer).
*/
async function expectSheetWithin(page: Page, viewportWidth: number) {
const layer = page.locator('[data-place="citations"]')
const box = await layer.boundingBox()
expect(box!.width).toBeLessThanOrEqual(34 * REM + 0.5)
expect(box!.width).toBeLessThanOrEqual(viewportWidth)
const edges = await page.evaluate(() => {
const sheet = document.querySelector('[data-place="citations"]')!
const rect = sheet.getBoundingClientRect()
return { top: rect.top, bottom: rect.bottom, right: rect.right }
})
expect(edges.top, 'sheet top').toBeLessThanOrEqual(1)
expect(
Math.abs(edges.right - viewportWidth),
'sheet right edge',
).toBeLessThan(1)
const height = await page.evaluate(() => window.innerHeight)
expect(Math.abs(edges.bottom - height), 'sheet bottom').toBeLessThanOrEqual(1)
}
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 citations sheet', 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 sheet 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 sheet is at most 34 rem and the viewport wide, and the document never changes size, before, during and after', 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 expectSheetWithin(page, width)
await expectNoHorizontalOverflow(page, `the open sheet 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 citations sheet 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 open dialog and sheet', 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 open sheet 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'
if (el.closest('[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'
if (el.closest('[data-testid="annotation-properties"]')) 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 sheet open: Tab stays in the sheet; 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('citations sheet 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('the whole screen, never wider than it, as tall as the window through a height change and a rotation, 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 expectSheetWithin(page, size.width)
await expectNoHorizontalOverflow(
page,
`the sheet 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 dialog and the sheet 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)
})
})