Files
faunosteo/apps/app/tests/unit/editor-navigation.test.ts
T
bchanot 18085cecf8 feat(editor): finding dialog and citations side sheet in the history
Constats opens each element in one modal dialog (view, edit with a
local draft, creation) driven by the editor view layer of the browser
history. The citations panel becomes a modal side sheet stacked over
it; its geometry, exit machinery and page inertness are removed.
Back and Forward restore the layers, a dirty form asks first.
2026-11-13 18:51:35 +01:00

256 lines
8.6 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import type { ElementKey } from '@faunosteo/core-wasm/types'
import {
citationsOfView,
initialNavigation,
navigationReducer,
targetOfKey,
viewOf,
type EditorTarget,
type NavigationState,
} from '../../src/editor/navigation'
const view: ElementKey = { kind: 'view', id: 'v1' }
const finding: ElementKey = { kind: 'finding', zone_id: 'z1', path: ['a'] }
const node: ElementKey = { kind: 'finding', zone_id: 'z1', path: ['a', 'b'] }
function run(
state: NavigationState,
...actions: Parameters<typeof navigationReducer>[1][]
) {
return actions.reduce(navigationReducer, state)
}
describe('targetOfKey', () => {
const tab = (t: string, section: string | null, key: ElementKey) => ({
place: 'tab',
tab: t,
section,
key,
})
const cases: [ElementKey, EditorTarget][] = [
[
{ kind: 'sheet' },
tab('general', null, { kind: 'sheet' }) as EditorTarget,
],
[
{ kind: 'zone', id: 'z' },
tab('findings', null, { kind: 'zone', id: 'z' }) as EditorTarget,
],
[finding, tab('findings', null, finding) as EditorTarget],
[
{ kind: 'annotation', id: 'a' },
tab('annotations', 'drawing', {
kind: 'annotation',
id: 'a',
}) as EditorTarget,
],
[view, tab('annotations', 'views', view) as EditorTarget],
[
{ kind: 'category', id: 'c' },
tab('annotations', 'categories', {
kind: 'category',
id: 'c',
}) as EditorTarget,
],
[
{ kind: 'region', code: 'r' },
tab('annotations', 'regions', {
kind: 'region',
code: 'r',
}) as EditorTarget,
],
[
{ kind: 'reference', id: 'x' },
tab('references', null, { kind: 'reference', id: 'x' }) as EditorTarget,
],
]
it.each(cases)('maps %j', (key, expected) => {
expect(targetOfKey(key)).toEqual(expected)
})
})
describe('navigationReducer', () => {
it('starts on the given tab with the drawing section', () => {
const state = initialNavigation('annotations')
expect(state.visitedTabs).toEqual(['annotations'])
expect(state.visitedSections).toEqual(['drawing'])
expect(initialNavigation('general').visitedSections).toEqual([])
expect(state.finding).toBeNull()
expect(state.libraryReset).toBe(0)
})
it('go_to sets the place and increments the serial', () => {
const first = run(initialNavigation('general'), {
type: 'go_to',
target: targetOfKey(view),
})
expect(first).toMatchObject({ tab: 'annotations', section: 'views' })
expect(first.focus).toEqual({ target: targetOfKey(view), serial: 1 })
const again = run(first, { type: 'go_to', target: targetOfKey(finding) })
expect(again.tab).toBe('findings')
expect(again.section).toBe('views')
expect(again.focus?.serial).toBe(2)
})
it('go_to a reference shows the Références tab with its element', () => {
const key: ElementKey = { kind: 'reference', id: 'x' }
const state = run(initialNavigation('general'), {
type: 'go_to',
target: targetOfKey(key),
})
expect(state).toMatchObject({ tab: 'references', finding: null })
expect(state.visitedTabs).toEqual(['general', 'references'])
expect(state.focus?.target).toEqual(targetOfKey(key))
})
it('go_to a tab closes the finding layers', () => {
const state = run(
initialNavigation('general'),
{ type: 'open_citations', citedBy: node },
{ type: 'go_to', target: targetOfKey(finding) },
)
expect(state.finding).toBeNull()
})
it('select_tab closes the layers and keeps the section, no request', () => {
const state = run(
initialNavigation('annotations'),
{ type: 'open_section', section: 'regions' },
{ type: 'open_citations', citedBy: node },
{ type: 'select_tab', tab: 'findings' },
)
expect(state).toMatchObject({
tab: 'findings',
section: 'regions',
finding: null,
focus: undefined,
})
})
it('open_citations opens for 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,
]) {
const state = run(base, { type: 'open_citations', citedBy: refused })
expect(state).toBe(base)
}
})
it('show_all_references closes the layers, shows the tab and bumps the reset', () => {
const state = run(
initialNavigation('findings'),
{ type: 'open_citations', citedBy: node },
{ type: 'show_all_references' },
)
expect(state).toMatchObject({
tab: 'references',
finding: null,
libraryReset: 1,
focus: undefined,
})
expect(state.visitedTabs).toEqual(['findings', 'references'])
expect(run(state, { type: 'show_all_references' }).libraryReset).toBe(2)
})
it('a plain go_to a reference leaves the library reset alone', () => {
const state = run(initialNavigation('findings'), {
type: 'go_to',
target: targetOfKey({ kind: 'reference', id: 'x' }),
})
expect(state.libraryReset).toBe(0)
})
it('opens a section and goes back to the drawing', () => {
const state = run(initialNavigation('annotations'), {
type: 'open_section',
section: 'views',
})
expect(state.section).toBe('views')
const back = run(state, { type: 'back_to_drawing' })
expect(back.section).toBe('drawing')
expect(back.visitedSections).toEqual(['drawing', 'views'])
})
it('open and close citations keep tab and section', () => {
const opened = run(
initialNavigation('annotations'),
{ type: 'open_section', section: 'views' },
{ type: 'open_citations', citedBy: node },
)
expect(opened).toMatchObject({ tab: 'annotations', section: 'views' })
expect(citationsOfView(opened)).toBe(node)
const closed = run(opened, { type: 'close_citations' })
expect(closed).toMatchObject({ tab: 'annotations', section: 'views' })
expect(citationsOfView(closed)).toBeNull()
// the sheet closes alone: the finding dialog under it stays
expect(closed.finding).toEqual({ key: node, citations: false })
})
it('open_finding shows the dialog of a key on Constats, close_finding takes both layers', () => {
const opened = run(initialNavigation('general'), {
type: 'open_finding',
key: finding,
})
expect(opened).toMatchObject({ tab: 'findings' })
expect(opened.finding).toEqual({ key: finding, citations: false })
const sheet = run(opened, { type: 'open_citations', citedBy: node })
expect(sheet.finding).toEqual({ key: node, citations: true })
expect(run(sheet, { type: 'close_finding' }).finding).toBeNull()
})
it('create_finding holds the kind and the parent, a creation has no sheet', () => {
const state = run(initialNavigation('findings'), {
type: 'create_finding',
kind: 'node',
parent: finding,
})
expect(state.finding).toEqual({ create: { kind: 'node', parent: finding } })
expect(citationsOfView(state)).toBeNull()
expect(run(state, { type: 'close_citations' })).toBe(state)
})
it('restore_view puts back the layers of the view it is given', () => {
const base = initialNavigation('findings')
const restored = run(base, {
type: 'restore_view',
view: { ...viewOf(base), finding: { key: node, citations: true } },
})
expect(citationsOfView(restored)).toBe(node)
expect(restored.focus).toBeUndefined()
})
it('focus_consumed clears only its serial and serials are not reused', () => {
const asked = run(initialNavigation('general'), {
type: 'go_to',
target: targetOfKey(view),
})
expect(
run(asked, { type: 'focus_consumed', serial: 9 }).focus,
).toBeDefined()
const cleared = run(asked, { type: 'focus_consumed', serial: 1 })
expect(cleared.focus).toBeUndefined()
const next = run(cleared, { type: 'go_to', target: targetOfKey(view) })
expect(next.focus?.serial).toBe(2)
})
it('visited lists only grow and record places as they are shown', () => {
const state = run(
initialNavigation('general'),
{ type: 'select_tab', tab: 'annotations' },
{ type: 'open_section', section: 'categories' },
{ type: 'select_tab', tab: 'findings' },
{ type: 'select_tab', tab: 'general' },
{ type: 'back_to_drawing' },
)
expect(state.visitedTabs).toEqual(['general', 'annotations', 'findings'])
expect(state.visitedSections).toEqual(['drawing', 'categories'])
})
})