feat(editor): references dialog over the finding, view mode

A modal Dialog replaces the citations side sheet; families open it too
(isCitable). The finding dialog shows only « Références citées » and
« X références », also at zero; its edit form no longer carries
reference_ids. A dirty form refusing « Aller à » or « Tout afficher »
closes the clean references dialog first.
This commit is contained in:
bchanot committed 2026-11-15 16:13:57 +01:00
1 parent ff21b0315e
commit abc781df52
29 files changed
+432 -858

No files matched your search

@@ -9,13 +9,13 @@ import {
within,
} from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import type { ElementKey } from '@faunosteo/core-wasm/types'
import type { Location, NavigateFunction } from 'react-router-dom'
import { ENTRY_KEY, type HistoryEntry } from '@/editor/history/entry'
import {
forgetSessionTag,
resolveSessionTag,
} from '@/editor/history/sessionTag'
import { useCitationDraft } from '@/editor/findings/citationDraft'
import { useAuthStore } from '@/state/authStore'
import { useLocaleStore } from '@/state/localeStore'
import { edit, insert } from '../helpers/editorFixtures'
@@ -830,16 +830,33 @@ function citingText(ids = ['ref-a']): string {
const nodeIds = () =>
doc().finding_zones[0].categories[0].children[0].reference_ids
const cite = (user: User, label: string) =>
user.selectOptions(inDialog().getByLabelText('Citer une référence'), label)
const save = (user: User) =>
user.click(inDialog().getByRole('button', { name: 'Enregistrer' }))
const panelOpen = () => screen.queryByTestId('editor-citations-panel')
const nodeKey: ElementKey = {
kind: 'finding',
zone_id: 'zone-a',
path: ['fcat-a', 'fnode-a'],
}
describe('citing references lives in the edit form (owner item 1)', () => {
it('the view has no cite control and no remove; the trigger opens the sheet', async () => {
/** Node A cites `ids` from now on: a change made outside the finding's edit form. */
function citeElsewhere(ids: string[]) {
act(() => {
const node = doc().finding_zones[0].categories[0].children[0]
store.getState().commit({
op: 'update',
key: nodeKey,
element: { kind: 'finding_node', value: { ...node, reference_ids: ids } },
})
})
}
describe('the finding dialog holds no citation control (Rev 5, owner item 1)', () => {
it('the view shows « Références citées » and « X références » only', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
expect(inDialog().getByText('Références citées')).toBeVisible()
expect(inDialog().queryByText('Alpha')).toBeNull()
expect(inDialog().queryByLabelText('Citer une référence')).toBeNull()
expect(inDialog().queryByRole('button', { name: /^Retirer/ })).toBeNull()
expect(
@@ -847,7 +864,7 @@ describe('citing references lives in the edit form (owner item 1)', () => {
).toBeVisible()
})
it('a family view lists its citations read-only', async () => {
it('a family view lists nothing inline; its « X références » opens the dialog', async () => {
let text = insert(sheetText(), reference('ref-a', 'Alpha'))
const key = { kind: 'finding', zone_id: 'zone-a', path: ['fcat-a'] }
const cat = JSON.parse(text).finding_zones[0].categories[0]
@@ -858,148 +875,48 @@ describe('citing references lives in the edit form (owner item 1)', () => {
text = edit(text, { op: 'update', key, element } as never)
const user = await mount(1280, text)
await openFinding(user, /Cat A/)
expect(inDialog().getByText('Alpha')).toBeVisible()
expect(inDialog().queryByRole('button', { name: /^Retirer/ })).toBeNull()
expect(inDialog().queryByLabelText('Citer une référence')).toBeNull()
expect(inDialog().queryByText('Alpha')).toBeNull()
await user.click(inDialog().getByRole('button', { name: '1 référence' }))
await waitFor(() => expect(panelOpen()).not.toBeNull())
expect(within(panelOpen()!).getByText('Alpha')).toBeVisible()
})
it('the form stages a cite and a remove, written only by « Enregistrer »', async () => {
it('a zone has no « Références citées »', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Zone A/)
expect(inDialog().queryByText('Références citées')).toBeNull()
})
it('the edit form shows the header and the button only, at zero too', async () => {
const user = await mount(1280, citingText([]))
await openFinding(user, /Node A/)
await modify(user)
const before = entries()
await cite(user, 'Beta')
await user.click(inDialog().getByRole('button', { name: 'Retirer Alpha' }))
expect(nodeIds()).toEqual(['ref-a'])
expect(entries()).toBe(before)
expect(inDialog().getByText('Références citées')).toBeVisible()
expect(
inDialog().getByRole('button', { name: '1 référence' }),
inDialog().getByRole('button', { name: '0 référence' }),
).toBeVisible()
await save(user)
expect(nodeIds()).toEqual(['ref-b'])
expect(entries()).toBe(before + 1)
expect(inDialog().queryByLabelText('Citer une référence')).toBeNull()
expect(inDialog().queryByRole('button', { name: /^Retirer/ })).toBeNull()
})
it('one undo restores the names and the citations together', async () => {
it('a save keeps a citations change made elsewhere while the form was open', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
await user.clear(nameField())
await user.type(nameField(), 'Renommé')
await cite(user, 'Beta')
await save(user)
expect(doc().finding_zones[0].categories[0].children[0].name.fr).toBe(
'Renommé',
)
expect(nodeIds()).toEqual(['ref-a', 'ref-b'])
act(() => void store.getState().undoStep())
expect(doc().finding_zones[0].categories[0].children[0].name.fr).toBe(
'Node A',
)
expect(nodeIds()).toEqual(['ref-a'])
})
it('a cite then its remove is pristine: « Enregistrer » writes nothing', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
citeElsewhere(['ref-a', 'ref-b'])
const before = entries()
await cite(user, 'Beta')
await user.click(inDialog().getByRole('button', { name: 'Retirer Beta' }))
await save(user)
expect(entries()).toBe(before)
})
it('« Annuler » with only a citation change asks, « Abandonner » writes nothing', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
const before = entries()
await cite(user, 'Beta')
await user.click(inDialog().getByRole('button', { name: 'Annuler' }))
expect(inDialog().getByText('Abandonner les modifications ?')).toBeVisible()
await user.click(inDialog().getByRole('button', { name: 'Abandonner' }))
expect(entries()).toBe(before)
expect(nodeIds()).toEqual(['ref-a'])
})
it('the sheet opened from the form lists the draft and cannot remove', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
await cite(user, 'Beta')
await user.click(inDialog().getByRole('button', { name: '2 références' }))
await waitFor(() => expect(panelOpen()).not.toBeNull())
const sheet = within(panelOpen()!)
expect(sheet.getByText(/2 références citées/)).toBeVisible()
expect(sheet.queryByRole('button', { name: /^Retirer/ })).toBeNull()
expect(nodeIds()).toEqual(['ref-a'])
})
it('the published draft returns to null on « Abandonner » and on save', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
await cite(user, 'Beta')
expect(useCitationDraft.getState().draft?.ids).toEqual(['ref-a', 'ref-b'])
await user.click(inDialog().getByRole('button', { name: 'Annuler' }))
await user.click(inDialog().getByRole('button', { name: 'Abandonner' }))
expect(useCitationDraft.getState().draft).toBeNull()
await modify(user)
await cite(user, 'Beta')
await save(user)
expect(useCitationDraft.getState().draft).toBeNull()
})
it('a Retirer-only change counts and lists the draft, the document stays', async () => {
const user = await mount(1280, citingText(['ref-a', 'ref-b']))
await openFinding(user, /Node A/)
await modify(user)
await user.click(inDialog().getByRole('button', { name: 'Retirer Alpha' }))
await user.click(inDialog().getByRole('button', { name: '1 référence' }))
await waitFor(() => expect(panelOpen()).not.toBeNull())
const sheet = within(panelOpen()!)
expect(sheet.getByText(/1 référence citée/)).toBeVisible()
expect(sheet.getByText(/Beta/)).toBeVisible()
expect(sheet.queryByText(/Alpha/)).toBeNull()
const node = doc().finding_zones[0].categories[0].children[0]
expect(node.name.fr).toBe('Renommé')
expect(nodeIds()).toEqual(['ref-a', 'ref-b'])
})
it('a read-only flip keeps a citation-only draft, never dropped silently', async () => {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
await cite(user, 'Beta')
act(() => {
setWidth(900)
window.dispatchEvent(new Event('resize'))
})
expect(findingDialog()).not.toBeNull()
expect(
inDialog().getByRole('button', { name: '2 références' }),
).toBeVisible()
expect(inDialog().queryByLabelText('Citer une référence')).toBeNull()
expect(
inDialog().getByRole('button', { name: 'Enregistrer' }),
).toBeDisabled()
expect(nodeIds()).toEqual(['ref-a'])
act(() => {
setWidth(1280)
window.dispatchEvent(new Event('resize'))
})
expect(
inDialog().getByRole('button', { name: '2 références' }),
).toBeVisible()
expect(entries()).toBe(before + 1)
})
})
describe('the citations sheet over a dirty edit form (final review rev 4, item 1)', () => {
describe('the references dialog over a dirty edit form', () => {
const question = 'Abandonner les modifications ?'
const dialogs = () => [...document.querySelectorAll('dialog[open]')]
const refForm = () =>
dialogs().find((d) => d.querySelector('#reference-form-citation')) as
| HTMLElement
| undefined
let api: NavigationStub
beforeEach(() => {
api = new NavigationStub()
@@ -1012,13 +929,13 @@ describe('the citations sheet over a dirty edit form (final review rev 4, item 1
Reflect.deleteProperty(window, 'navigation')
})
/** Node A in edit with Beta cited in the draft, its sheet open over the form. */
async function sheetOverDirtyForm() {
/** Node A in edit with its name changed, its references dialog open over the form. */
async function dialogOverDirtyForm() {
const user = await mount(1280, citingText())
await openFinding(user, /Node A/)
await modify(user)
await cite(user, 'Beta')
await user.click(inDialog().getByRole('button', { name: '2 références' }))
await user.type(nameField(), ' x')
await user.click(inDialog().getByRole('button', { name: '1 référence' }))
await waitFor(() => expect(panelOpen()).not.toBeNull())
await waitFor(() =>
expect(written()?.view.finding).toMatchObject({ citations: true }),
@@ -1026,13 +943,10 @@ describe('the citations sheet over a dirty edit form (final review rev 4, item 1
return user
}
const draftKept = () =>
expect(
inDialog().getByRole('button', { name: '2 références' }),
).toBeVisible()
const draftKept = () => expect(nameField()).toHaveValue('Node A x')
it('a Back closes the clean sheet and asks nothing', async () => {
await sheetOverDirtyForm()
it('a Back closes the clean references dialog and asks nothing', async () => {
await dialogOverDirtyForm()
await back()
await waitFor(() => expect(panelOpen()).toBeNull())
expect(screen.queryByText(question)).toBeNull()
@@ -1040,22 +954,8 @@ describe('the citations sheet over a dirty edit form (final review rev 4, item 1
draftKept()
})
it('a Back from a clean reference dialog over the sheet closes it only', async () => {
const user = await sheetOverDirtyForm()
const sheet = within(panelOpen()!)
const head = sheet.getByRole('button', { name: /^Alpha/ })
if (head.getAttribute('aria-expanded') === 'false') await user.click(head)
const tile = within(head.closest('li')!)
await user.click(tile.getByRole('button', { name: 'Modifier' }))
await waitFor(() => expect(refForm()).toBeDefined())
await back()
await waitFor(() => expect(refForm()).toBeUndefined())
expect(panelOpen()).not.toBeNull()
expect(screen.queryByText(question)).toBeNull()
})
it('a jump of two entries inside the editor closes the sheet, then the form asks', async () => {
await sheetOverDirtyForm()
it('a jump of two entries inside the editor closes the dialog, then the form asks', async () => {
await dialogOverDirtyForm()
await act(async () => navigate(-2))
await waitFor(() => expect(panelOpen()).toBeNull())
expect(inDialog().getByText(question)).toBeVisible()
@@ -1066,103 +966,8 @@ describe('the citations sheet over a dirty edit form (final review rev 4, item 1
draftKept()
})
it('after the cascade keeps the form, one Back reopens the sheet (docs, limit 5)', async () => {
const user = await sheetOverDirtyForm()
const sheet = within(panelOpen()!)
const head = sheet.getByRole('button', { name: /^Alpha/ })
if (head.getAttribute('aria-expanded') === 'false') await user.click(head)
const tile = within(head.closest('li')!)
await user.click(tile.getByRole('button', { name: 'Modifier' }))
await waitFor(() => expect(refForm()).toBeDefined())
await user.type(within(refForm()!).getByLabelText('Citation'), ' x')
const url = new URL('/app/admin/sheets', window.location.origin).href
const event = Object.assign(new Event('navigate', { cancelable: true }), {
navigationType: 'traverse',
destination: { url, key: 'list', sameDocument: true },
})
act(() => {
api.dispatchEvent(event)
})
await user.click(
within(refForm()!).getByRole('button', { name: 'Abandonner' }),
)
await waitFor(() => expect(panelOpen()).toBeNull())
// The reference dialog plays its exit, then leaves: only the finding dialog stays.
await waitFor(() => expect(dialogs()).toHaveLength(1))
await user.click(
inDialog().getByRole('button', { name: 'Continuer la saisie' }),
)
await back()
await waitFor(() => expect(panelOpen()).not.toBeNull())
expect(screen.queryByText(question)).toBeNull()
expect(api.traverseTo).not.toHaveBeenCalled()
draftKept()
})
/** The reference Alpha's edit dialog opened from the sheet; `dirty` types in it. */
async function referenceOverSheet(user: User, dirty: boolean) {
const sheet = within(panelOpen()!)
const head = sheet.getByRole('button', { name: /^Alpha/ })
if (head.getAttribute('aria-expanded') === 'false') await user.click(head)
const tile = within(head.closest('li')!)
await user.click(tile.getByRole('button', { name: 'Modifier' }))
await waitFor(() => expect(refForm()).toBeDefined())
if (dirty)
await user.type(within(refForm()!).getByLabelText('Citation'), ' x')
}
it('a jump of three entries asks the dirty reference only, nothing stays pending under it', async () => {
const user = await sheetOverDirtyForm()
await referenceOverSheet(user, true)
await act(async () => navigate(-3))
await waitFor(() => expect(screen.queryAllByText(question)).toHaveLength(1))
expect(refForm()!.contains(screen.getByText(question))).toBe(true)
await user.click(
within(refForm()!).getByRole('button', { name: 'Abandonner' }),
)
await waitFor(() => expect(refForm()).toBeUndefined())
// The refused jump is dropped: the sheet stays, and no question comes up unasked.
expect(panelOpen()).not.toBeNull()
expect(screen.queryByText(question)).toBeNull()
draftKept()
})
it('a clean reference over the sheet over a dirty form: a Back asks the form in view', async () => {
const user = await sheetOverDirtyForm()
await referenceOverSheet(user, false)
await act(async () => navigate(-3))
await waitFor(() => expect(panelOpen()).toBeNull())
await waitFor(() => expect(refForm()).toBeUndefined())
expect(inDialog().getByText(question)).toBeVisible()
await waitFor(() =>
expect(findingDialog()!.contains(document.activeElement)).toBe(true),
)
draftKept()
})
it('a clean reference over the sheet over a dirty form: a leave out asks the form in view', async () => {
const user = await sheetOverDirtyForm()
await referenceOverSheet(user, false)
const url = new URL('/app/admin/sheets', window.location.origin).href
const event = Object.assign(new Event('navigate', { cancelable: true }), {
navigationType: 'traverse',
destination: { url, key: 'list', sameDocument: true },
})
act(() => {
api.dispatchEvent(event)
})
expect(event.defaultPrevented).toBe(true)
await waitFor(() => expect(panelOpen()).toBeNull())
await waitFor(() => expect(refForm()).toBeUndefined())
expect(inDialog().getByText(question)).toBeVisible()
await waitFor(() =>
expect(findingDialog()!.contains(document.activeElement)).toBe(true),
)
draftKept()
})
it('a jump out of the editor closes the sheet, then the form asks in view', async () => {
await sheetOverDirtyForm()
it('a jump out of the editor closes the dialog, then the form asks in view', async () => {
await dialogOverDirtyForm()
const url = new URL('/app/admin/sheets', window.location.origin).href
const event = Object.assign(new Event('navigate', { cancelable: true }), {
navigationType: 'traverse',
@@ -1179,4 +984,38 @@ describe('the citations sheet over a dirty edit form (final review rev 4, item 1
)
draftKept()
})
it('« Tout afficher » refused by the form: the dialog closes first, the question in view', async () => {
const user = await dialogOverDirtyForm()
await user.click(
within(panelOpen()!).getByRole('button', {
name: "Tout afficher dans l'onglet Références",
}),
)
await waitFor(() => expect(panelOpen()).toBeNull())
expect(inDialog().getByText(question)).toBeVisible()
await waitFor(() =>
expect(document.activeElement).toBe(
inDialog().getByRole('button', { name: 'Continuer la saisie' }),
),
)
expect(written()?.view.tab).toBe('findings')
expect(written()?.view.finding).toMatchObject({ citations: false })
draftKept()
})
it('« Aller à » refused by the form: the dialog closes first, the question in view', async () => {
const user = await dialogOverDirtyForm()
const sheet = within(panelOpen()!)
await user.click(sheet.getByRole('button', { name: /^Alpha/ }))
await user.click(sheet.getAllByRole('button', { name: /^Aller à / })[0])
await waitFor(() => expect(panelOpen()).toBeNull())
expect(inDialog().getByText(question)).toBeVisible()
await waitFor(() =>
expect(document.activeElement).toBe(
inDialog().getByRole('button', { name: 'Continuer la saisie' }),
),
)
draftKept()
})
})
+22 -57
View File
@@ -1,6 +1,7 @@
/** Lot I: the Constats tree. */
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import {
act,
cleanup,
render,
screen,
@@ -590,7 +591,7 @@ describe('Constats tab', () => {
)
})
it('edits descriptions (blank side omitted), the vet flag and the citations in one save', async () => {
it('edits descriptions (blank side omitted) and the vet flag in one save, citations kept', async () => {
let text = treeText()
text = insert(text, {
kind: 'reference',
@@ -628,66 +629,29 @@ describe('Constats tab', () => {
await user.clear(inFindingDialog().getByLabelText('Description (FR)'))
await save()
expect(node().description).toEqual({})
// the view cites nothing: « Citer une référence » is the edit form's
// Neither mode cites: the references dialog holds the citations (Rev 5).
expect(inFindingDialog().queryByLabelText('Citer une référence')).toBeNull()
await startEdit(user)
await user.selectOptions(
inFindingDialog().getByLabelText('Citer une référence'),
'ref-a',
)
expect(node().reference_ids).toEqual([])
expect(inFindingDialog().queryByLabelText('Citer une référence')).toBeNull()
act(() => {
store.getState().commit({
op: 'update',
key: { kind: 'finding', zone_id: 'zone-a', path: ['fcat-a', 'node-a'] },
element: {
kind: 'finding_node',
value: { ...node(), reference_ids: ['ref-a'] },
},
})
})
await user.type(inFindingDialog().getByLabelText('Description (FR)'), 'B')
await save()
expect(node().description).toEqual({ fr: 'B' })
expect(node().reference_ids).toEqual(['ref-a'])
expect(
inFindingDialog().getByRole('button', { name: '1 référence' }),
).toBeInTheDocument()
})
it('a family cites and removes in its edit form, one save writes both', async () => {
let text = treeText()
text = insert(text, {
kind: 'reference',
value: {
id: 'ref-a',
type: 'book',
citation: 'Alpha',
url: null,
doi: null,
},
})
await openReady({ text })
const user = userEvent.setup()
render(<FindingsHost />)
await user.click(items()[1])
const family = () => doc().finding_zones[0].categories[0]
await startEdit(user)
await user.selectOptions(
inFindingDialog().getByLabelText('Citer une référence'),
'ref-a',
)
expect(
inFindingDialog().getByRole('button', { name: /Retirer Alpha/ }),
).toBeInTheDocument()
await user.click(
inFindingDialog().getByRole('button', { name: /Retirer Alpha/ }),
)
expect(
inFindingDialog().getByText('Aucune référence citée.'),
).toBeInTheDocument()
await user.selectOptions(
inFindingDialog().getByLabelText('Citer une référence'),
'ref-a',
)
expect(family().reference_ids).toEqual([])
await user.click(
inFindingDialog().getByRole('button', { name: 'Enregistrer' }),
)
expect(family().reference_ids).toEqual(['ref-a'])
expect(
inFindingDialog().queryByRole('button', { name: /Retirer/ }),
).toBeNull()
})
it('the trigger shows exactly for the keys open_citations accepts', async () => {
let text = insert(treeText(), {
kind: 'reference',
@@ -733,7 +697,7 @@ describe('Constats tab', () => {
}
expect(truth).toEqual([
['zone', false],
['category', false],
['category', true],
['node', true],
['node', true],
['zone', false],
@@ -742,7 +706,7 @@ describe('Constats tab', () => {
expect(all.filter((item) => item.kind === 'node')).toHaveLength(2)
})
it('the trigger reads « expanded » while the sheet of its finding is open', async () => {
it('the trigger reads « expanded » while the references dialog of its finding is open', async () => {
let text = insert(treeText(), {
kind: 'reference',
value: { id: 'ref-a', type: 'book', citation: 'A', url: null, doi: null },
@@ -771,9 +735,10 @@ describe('Constats tab', () => {
expect(trigger()).toHaveAttribute('aria-controls', 'editor-citations-panel')
await user.click(trigger())
expect(trigger()).toHaveAttribute('aria-expanded', 'true')
await user.click(
screen.getByRole('button', { name: 'Fermer les références' }),
)
const citations = screen
.getByTestId('editor-citations-panel')
.closest('dialog')!
await user.click(within(citations).getByRole('button', { name: 'Fermer' }))
await waitFor(() =>
expect(trigger()).toHaveAttribute('aria-expanded', 'false'),
)
@@ -57,12 +57,18 @@ describe('sanitizeView', () => {
expect(layerCount(sanitizeView(sheet)!)).toBe(2)
})
it('a sheet needs a finding node, a layer needs the Constats tab', () => {
it('citations need a family or a node, a layer needs the Constats tab', () => {
const family = { kind: 'finding', zone_id: 'z', path: ['f'] }
const zone = { kind: 'zone', id: 'z' }
const raw = { tab: 'findings', section: 'drawing' }
const asked = { ...raw, finding: { key: family, citations: true } }
expect(sanitizeView(asked)?.finding).toEqual({
key: family,
citations: true,
})
const ofZone = { ...raw, finding: { key: zone, citations: true } }
expect(sanitizeView(ofZone)?.finding).toEqual({
key: zone,
citations: false,
})
const elsewhere = {
@@ -108,9 +114,12 @@ describe('sanitizeView', () => {
).toBeNull()
})
it('the finding filter names a finding node and lives on the References tab only', () => {
it('the finding filter names a family or a node and lives on the References tab only', () => {
const filtered = view('references', { referenceFilter: node })
expect(sanitizeView(filtered)?.referenceFilter).toEqual(node)
const family = { kind: 'finding' as const, zone_id: 'z', path: ['f'] }
const byFamily = view('references', { referenceFilter: family })
expect(sanitizeView(byFamily)?.referenceFilter).toEqual(family)
expect(sanitizeView(filtered, false)?.referenceFilter).toEqual(node)
expect(
sanitizeView({ ...view('general'), referenceFilter: node })
@@ -128,16 +128,14 @@ describe('navigationReducer', () => {
})
})
it('open_citations opens for a finding node only', () => {
it('open_citations opens for a family or a finding node only', () => {
const base = initialNavigation('findings')
const opened = run(base, { type: 'open_citations', citedBy: node })
expect(citationsOfView(opened)).toBe(node)
expect(opened.finding).toEqual({ key: node, citations: true })
for (const refused of [
finding,
view,
{ kind: 'zone', id: 'z1' } as const,
]) {
for (const citable of [node, finding]) {
const opened = run(base, { type: 'open_citations', citedBy: citable })
expect(citationsOfView(opened)).toBe(citable)
expect(opened.finding).toEqual({ key: citable, citations: true })
}
for (const refused of [view, { kind: 'zone', id: 'z1' } as const]) {
const state = run(base, { type: 'open_citations', citedBy: refused })
expect(state).toBe(base)
}
@@ -559,96 +559,3 @@ describe('final review: the creation dialog fades out as a creation (M-9)', () =
expect(titles).not.toContain('Modifier la référence')
})
})
/** The Navigation API as the leave guard reads it: `navigate` events and `traverseTo`. */
class NavigationStub extends EventTarget {
traverseTo = vi.fn((key: string) => {
void key
return { committed: Promise.resolve(), finished: Promise.resolve() }
})
}
describe('a jump with the reference over the sheet of a dirty finding (criterion 23)', () => {
let api: NavigationStub
beforeEach(() => {
api = new NavigationStub()
Object.defineProperty(window, 'navigation', {
value: api,
configurable: true,
})
})
afterEach(() => {
Reflect.deleteProperty(window, 'navigation')
})
const sheet = () =>
[...dialogs()].find((d) => d.querySelector('[data-place="citations"]'))
const question = 'Abandonner les modifications ?'
/** The reference dialog: the finding's edit form is a draft form too. */
const refForm = () =>
[...dialogs()].find((d) => d.querySelector('#reference-form-citation')) as
| HTMLElement
| undefined
const inForm = () => within(refForm()!)
function jump() {
const url = new URL('/app/admin/sheets', window.location.origin).href
const event = Object.assign(new Event('navigate', { cancelable: true }), {
navigationType: 'traverse',
destination: { url, key: 'list', sameDocument: true },
})
act(() => {
api.dispatchEvent(event)
})
return event
}
/** Node A in edit with a typed name, its sheet open, Barone in edit with a typed citation. */
async function stacked(user: User) {
await user.click(screen.getByRole('tab', { name: 'Constats' }))
await openFinding(user, /Node A/)
const finding = within(findingDialog()!)
await user.click(finding.getByRole('button', { name: 'Modifier' }))
await user.type(finding.getByLabelText('Nom (FR)'), ' bis')
await user.click(finding.getByRole('button', { name: '2 références' }))
await waitFor(() => expect(sheet()).toBeDefined())
const inSheet = within(sheet() as HTMLElement)
const head = inSheet.getByRole('button', { name: /^Barone/ })
if (head.getAttribute('aria-expanded') === 'false') await user.click(head)
const tile = head.closest('li')!
await user.click(within(tile).getByRole('button', { name: 'Modifier' }))
await waitFor(() => expect(refForm()).toBeDefined())
await user.type(inForm().getByLabelText('Citation'), ' x')
}
it('the finding asks next with the sheet closed, focused; the jump goes after it', async () => {
const user = await mount()
await stacked(user)
expect(jump().defaultPrevented).toBe(true)
expect(inForm().getByText(question)).toBeVisible()
await user.click(inForm().getByRole('button', { name: 'Abandonner' }))
await waitFor(() => expect(refForm()).toBeUndefined())
await waitFor(() => expect(sheet()).toBeUndefined())
const finding = within(findingDialog()!)
expect(finding.getByText(question)).toBeVisible()
const keep = finding.getByRole('button', { name: 'Continuer la saisie' })
await waitFor(() => expect(keep).toHaveFocus())
expect(api.traverseTo).not.toHaveBeenCalled()
await user.click(finding.getByRole('button', { name: 'Abandonner' }))
expect(api.traverseTo).toHaveBeenCalledWith('list')
})
it('« Continuer la saisie » there keeps the finding draft and drops the jump', async () => {
const user = await mount()
await stacked(user)
jump()
await user.click(inForm().getByRole('button', { name: 'Abandonner' }))
await waitFor(() => expect(sheet()).toBeUndefined())
const finding = within(findingDialog()!)
await user.click(
finding.getByRole('button', { name: 'Continuer la saisie' }),
)
expect(finding.getByLabelText('Nom (FR)')).toHaveValue('Node A bis')
expect(api.traverseTo).not.toHaveBeenCalled()
})
})
@@ -1,4 +1,4 @@
/** R2.4: the citations panel of one finding (board 25): contents, « Retirer », motion, closes, focus. */
/** R2.4, Rev 5: the references dialog of one finding: contents, view mode, closes, focus. */
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import {
act,
@@ -109,12 +109,15 @@ const ready = () =>
screen.findByRole('heading', { level: 1, name: 'Brouillon, version 4' })
const panel = () => screen.getByTestId('editor-citations-panel')
const hasPanel = () => screen.queryByTestId('editor-citations-panel') !== null
const layer = () => panel().closest('[data-place="citations"]')!
const citationsDialog = () => panel().closest('dialog')!
const tiles = () => [...panel().querySelectorAll('ul > li')]
const trigger = (name = '2 références') =>
inFindingDialog().getByRole('button', { name })
const heading = () =>
within(panel()).getByRole('heading', { name: 'Références citées' })
within(citationsDialog()).getByRole('heading', {
name: 'Références du constat',
})
const backdrop = () => within(citationsDialog()).getByTestId('dialog-backdrop')
const doc = () => JSON.parse(store.getState().documentText)
const nodeA = () =>
doc().finding_zones[0].categories[0].children[0] as {
@@ -148,7 +151,7 @@ async function select(user: User, label: RegExp) {
await openFinding(user, label)
}
/** The sheet of Node A, open over its dialog: its first control (✕) holds the focus. */
/** The references dialog of Node A, over its dialog: its first control (✕) holds the focus. */
async function openFromFinding(user: User, name = '2 références') {
await select(user, /Node A/)
await user.click(trigger(name))
@@ -161,10 +164,10 @@ const link = () =>
})
const closeButton = () =>
within(panel()).getByRole('button', { name: 'Fermer les références' })
within(citationsDialog()).getByRole('button', { name: 'Fermer' })
describe('opening', () => {
it('has no header button; only a finding opens it, its heading takes the focus after the slide', async () => {
it('has no header button; « X références » opens a modal dialog over the finding, ✕ focused', async () => {
const user = await mount()
expect(screen.queryByRole('button', { name: 'Références' })).toBeNull()
expect(hasPanel()).toBe(false)
@@ -173,23 +176,37 @@ describe('opening', () => {
expect(trigger()).toHaveAttribute('aria-controls', 'editor-citations-panel')
await user.click(trigger())
expect(trigger()).toHaveAttribute('aria-expanded', 'true')
expect(document.activeElement).not.toBe(heading())
await focusIs(closeButton)
expect(panel()).toHaveAttribute('aria-labelledby', 'editor-citations-title')
expect(heading()).toHaveAttribute('id', 'editor-citations-title')
expect(citationsDialog()).toHaveAttribute(
'aria-labelledby',
'editor-citations-title',
)
expect(citationsDialog()).toHaveAttribute('data-layer')
expect(panel()).toHaveAttribute('data-place', 'citations')
expect(document.querySelectorAll('dialog[open]')).toHaveLength(2)
expect(findingDialog()).not.toBe(citationsDialog())
})
it('a family lists its citations read-only: no trigger, no Retirer, no panel', async () => {
it('a family opens the same dialog with its citations', async () => {
const user = await mount()
await select(user, /Cat A/)
const detail = screen.getByRole('tabpanel', { name: 'Constats' })
expect(
within(detail).queryByRole('button', { name: /références?$/ }),
).toBeNull()
expect(within(detail).getByText('Barone, Ostéologie')).toBeVisible()
expect(
within(detail).queryByRole('button', { name: /^Retirer/ }),
).toBeNull()
expect(hasPanel()).toBe(false)
expect(inFindingDialog().queryByText('Barone, Ostéologie')).toBeNull()
await user.click(trigger())
await focusIs(closeButton)
expect(panel()).toHaveTextContent('Zone A › Cat A')
expect(tiles()).toHaveLength(2)
expect(tiles()[0].textContent).toContain('Barone')
expect(tiles()[1].textContent).toContain('Denoix')
})
it('« 0 référence » is offered at zero and opens the empty dialog', async () => {
const user = await mount(1280, nodeText([]))
await select(user, /Node A/)
await user.click(trigger('0 référence'))
await focusIs(closeButton)
expect(tiles()).toHaveLength(0)
expect(panel()).toHaveTextContent('Ce constat ne cite aucune référence.')
})
it('shows the path, the count, and only the references of the finding as tiles', async () => {
@@ -205,7 +222,7 @@ describe('opening', () => {
expect(panel()).not.toHaveTextContent('Denoix')
})
it('an open tile marks the current finding and offers Modifier only', async () => {
it('view mode: an open tile marks the current finding, « Aller à » only, no edit control', async () => {
const user = await mount()
await openFromFinding(user)
await user.click(within(panel()).getByRole('button', { name: /^Barone/ }))
@@ -214,34 +231,23 @@ describe('opening', () => {
expect(
within(tile).getAllByRole('button', { name: /^Aller à / }),
).toHaveLength(2)
expect(within(tile).getByRole('button', { name: 'Modifier' })).toBeVisible()
for (const absent of [
'Modifier',
'Retirer de ce constat',
'Supprimer',
'Monter',
'Descendre',
]) {
expect(within(panel()).queryByRole('button', { name: absent })).toBeNull()
expect(
within(citationsDialog()).queryByRole('button', { name: absent }),
).toBeNull()
}
expect(within(citationsDialog()).queryByRole('searchbox')).toBeNull()
expect(within(citationsDialog()).queryByRole('textbox')).toBeNull()
expect(within(citationsDialog()).queryByRole('combobox')).toBeNull()
})
it('has no search, no add control; « Modifier » opens the reference dialog over the sheet', async () => {
const user = await mount()
await openFromFinding(user)
expect(within(panel()).queryByRole('searchbox')).toBeNull()
expect(
within(panel()).queryByRole('button', { name: /Ajouter/ }),
).toBeNull()
await user.click(within(panel()).getByRole('button', { name: /^Barone/ }))
await user.click(within(panel()).getByRole('button', { name: 'Modifier' }))
expect(document.querySelectorAll('dialog[open]')).toHaveLength(3)
expect(
screen.getByRole('dialog', { name: 'Modifier la référence' }),
).toBeVisible()
expect(panel().querySelector('[id$="-citation"]')).toBeNull()
})
it('ids stay unique with the Références tab mounted and the panel open (P14)', async () => {
it('ids stay unique with the Références tab mounted and the dialog open (P14)', async () => {
const user = await mount()
await user.click(screen.getByRole('tab', { name: 'Références' }))
await user.click(screen.getByRole('button', { name: /^Barone/ }))
@@ -267,26 +273,12 @@ describe('opening', () => {
})
})
describe('motion', () => {
const slid = () => (layer() as HTMLElement).style.transform
it('slides in from the right and fades the scrim, the page behind inert', async () => {
const user = await mount()
await select(user, /Node A/)
await user.click(trigger())
expect(slid()).toMatch(/translateX\(/)
expect(screen.getByTestId('references-scrim')).toBeInTheDocument()
expect(panel().closest('header')).toBeNull()
await focusIs(closeButton)
await waitFor(() => expect(slid()).not.toMatch(/translateX\([1-9]/))
})
it('reduced motion: no slide, the same lifecycle', async () => {
describe('reduced motion', () => {
it('the same lifecycle: open, close, the trigger takes the focus back', async () => {
setReducedMotion(true)
const user = await mount()
await select(user, /Node A/)
await user.click(trigger())
expect(slid()).not.toMatch(/translateX\(/)
await focusIs(closeButton)
await user.click(closeButton())
await closed()
@@ -302,7 +294,7 @@ const MODES = [
describe.each(MODES)('closing, %s', (_label, reduced) => {
beforeEach(() => setReducedMotion(reduced))
it('✕, Escape and the scrim each close it after the exit: the trigger holds the focus', async () => {
it('✕, Escape and the backdrop each close it after the exit: the trigger holds the focus', async () => {
const user = await mount()
await openFromFinding(user)
await user.click(closeButton())
@@ -315,7 +307,7 @@ describe.each(MODES)('closing, %s', (_label, reduced) => {
await focusIs(() => trigger())
await user.click(trigger())
await focusIs(closeButton)
fireEvent.click(screen.getByTestId('references-scrim'))
fireEvent.click(backdrop())
await closed()
await focusIs(() => trigger())
expect(trigger()).toHaveAttribute('aria-expanded', 'false')
@@ -350,14 +342,14 @@ describe.each(MODES)('closing, %s', (_label, reduced) => {
await focusIs(() =>
within(tabPanel).getByRole('heading', { name: 'Références' }),
)
// Filtered by the finding the sheet belonged to: its two citations (R2F-6).
// Filtered by the finding the dialog belonged to: its two citations (R2F-6).
expect(within(tabPanel).getAllByRole('listitem')).toHaveLength(2)
expect(
within(tabPanel).getByText('Références du constat : Node A'),
).toBeVisible()
})
it('« Aller à » a citer from a panel tile closes the sheet and opens that finding in its dialog', async () => {
it('« Aller à » a citer from a tile closes the dialog and opens that finding in its dialog', async () => {
const user = await mount()
await openFromFinding(user)
await user.click(within(panel()).getByRole('button', { name: /^Barone/ }))
@@ -387,7 +379,7 @@ describe.each(MODES)('closing, %s', (_label, reduced) => {
expect(document.activeElement).not.toBe(document.body)
})
it('below 640 px the sheet opens from « Plus » > Constats and closes on its own', async () => {
it('below 640 px the dialog opens from « Plus » > Constats and closes on its own', async () => {
const user = await mount(375)
await user.click(screen.getByRole('button', { name: 'Plus' }))
await user.click(screen.getByRole('button', { name: 'Constats' }))
@@ -401,7 +393,7 @@ describe.each(MODES)('closing, %s', (_label, reduced) => {
})
describe('the exit', () => {
it('a sheet playing its exit is inert, its trigger reads « expanded » until it is gone', async () => {
it('a dialog playing its exit is inert, its trigger reads « expanded » until it is gone', async () => {
const user = await mount()
await openFromFinding(user)
expect(trigger()).toHaveAttribute('aria-expanded', 'true')
@@ -416,14 +408,14 @@ describe('the exit', () => {
const user = await mount()
await openFromFinding(user)
await user.click(closeButton())
fireEvent.keyDown(layer(), { key: 'Escape' })
fireEvent.click(screen.getByTestId('references-scrim'))
fireEvent.keyDown(citationsDialog(), { key: 'Escape' })
fireEvent.click(backdrop())
await closed()
expect(findingDialog()).not.toBeNull()
await focusIs(() => trigger())
})
it('Ctrl+Z is ignored while the sheet is open: Défaire is unreachable under a dialog', async () => {
it('Ctrl+Z is ignored while the dialog is open: Défaire is unreachable under a dialog', async () => {
const user = await mount()
act(() => void commitMove(40))
await openFromFinding(user)
@@ -434,7 +426,7 @@ describe('the exit', () => {
})
})
describe('the library and the history around the panel', () => {
describe('the library and the history around the dialog', () => {
it('« Tout afficher » clears the search of the tab and keeps its sort, open tiles kept (P4)', async () => {
const user = await mount()
await user.click(screen.getByRole('tab', { name: 'Références' }))
@@ -489,7 +481,7 @@ describe('the library and the history around the panel', () => {
})
})
describe('the sheet cannot remove a citation (the edit form does)', () => {
describe('the view mode cannot remove a citation', () => {
it('no tile offers « Retirer de ce constat »', async () => {
const user = await mount()
await openFromFinding(user)
@@ -538,7 +530,7 @@ function cite(ids: string[]) {
}
describe('the panel review fixes', () => {
it('the sheet is a modal dialog named by its title (M4: no announcement needed)', async () => {
it('the dialog is modal and named by its title (M4: no announcement needed)', async () => {
const user = await mount()
await openFromFinding(user)
const dialog = panel().closest('dialog')!