feat(editor): drawing guard before navigations drop a started move (R-12)
The move mode lives in the work store with its document stamp. guardDrawing ends an unstarted mode at once and asks « Abandonner le déplacement ? » (DrawingGuardDialog, at workspace level) once work is started, before a tab, a section, « Aller à », Back and a history jump out of the editor; the leave guard and sign-out count started work. An undo from the header, Ctrl+Z or the message only cancels a pending mode or preview (R-13), and a document change drops a stale mode, keeping a started one to be said. ConfirmDialog takes an optional body. Strings for Task 4 added.
This commit is contained in:
1 parent
8cd1bda6c2
commit
2882821661
18 files changed
+465
-37
No files matched your search
@@ -1,8 +1,14 @@
|
||||
/** U2 Task 2: the annotation work store and its stale stamp (R-13). */
|
||||
import { afterEach, describe, expect, it } from 'vitest'
|
||||
import { vi } from 'vitest'
|
||||
import { answerDrawing, guardDrawing } from '@/editor/annotations/drawingGuard'
|
||||
import {
|
||||
cancelPending,
|
||||
dropStale,
|
||||
guardWork,
|
||||
resetWork,
|
||||
setModePreview,
|
||||
startMove,
|
||||
useAnnotationWork,
|
||||
type Preview,
|
||||
} from '@/editor/annotations/workStore'
|
||||
@@ -44,9 +50,89 @@ describe('dropStale (R-13)', () => {
|
||||
|
||||
it('a new session (another sheet, the editor closed) resets the work', () => {
|
||||
useAnnotationWork.setState({
|
||||
mode: { kind: 'move', annotationId: 'a', started: true },
|
||||
mode: { kind: 'move', annotationId: 'a', started: true, base: 'one' },
|
||||
})
|
||||
useEditorStore.setState({ session: useEditorStore.getState().session + 1 })
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
})
|
||||
})
|
||||
|
||||
const STORED = { type: 'circle' as const, cx: 1, cy: 2, r: 3 }
|
||||
const MOVED = { type: 'circle' as const, cx: 5, cy: 2, r: 3 }
|
||||
|
||||
describe('the move mode in the work store (R-12, R-13)', () => {
|
||||
it('is started once its preview differs from the stored shape', () => {
|
||||
startMove('a', 'one')
|
||||
expect(guardWork(useAnnotationWork.getState())).toBeNull()
|
||||
setModePreview(STORED, STORED)
|
||||
expect(useAnnotationWork.getState().mode?.started).toBe(false)
|
||||
setModePreview(MOVED, STORED)
|
||||
const work = useAnnotationWork.getState()
|
||||
expect(work.mode?.started).toBe(true)
|
||||
expect(work.preview).toMatchObject({ source: 'move', base: 'one' })
|
||||
expect(guardWork(work)).toBe('move')
|
||||
})
|
||||
|
||||
it('an undo only cancels what is pending (cancelPending)', () => {
|
||||
expect(cancelPending()).toBe(false)
|
||||
startMove('a', 'one')
|
||||
setModePreview(MOVED, STORED)
|
||||
expect(cancelPending()).toBe(true)
|
||||
expect(useAnnotationWork.getState()).toMatchObject({
|
||||
mode: null,
|
||||
preview: null,
|
||||
})
|
||||
useAnnotationWork.setState({
|
||||
preview: { ...preview('one'), source: 'keys' },
|
||||
})
|
||||
expect(cancelPending()).toBe(true)
|
||||
expect(useAnnotationWork.getState().preview).toBeNull()
|
||||
})
|
||||
|
||||
it('a document change drops the mode; a started one is kept to be said', () => {
|
||||
startMove('a', 'one')
|
||||
dropStale('two')
|
||||
expect(useAnnotationWork.getState()).toMatchObject({
|
||||
mode: null,
|
||||
dropped: null,
|
||||
})
|
||||
startMove('a', 'two')
|
||||
setModePreview(MOVED, STORED)
|
||||
dropStale('two')
|
||||
expect(useAnnotationWork.getState().mode).not.toBeNull()
|
||||
dropStale('three')
|
||||
expect(useAnnotationWork.getState()).toMatchObject({
|
||||
mode: null,
|
||||
preview: null,
|
||||
dropped: 'move',
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('the drawing guard (R-12)', () => {
|
||||
it('an unstarted mode ends at once and the move goes on', () => {
|
||||
startMove('a', 'one')
|
||||
const proceed = vi.fn()
|
||||
expect(guardDrawing(proceed)).toBe(true)
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
expect(useAnnotationWork.getState().question).toBeNull()
|
||||
expect(proceed).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('a started mode asks; « Continuer » keeps it, « Abandonner » drops it and moves', () => {
|
||||
startMove('a', 'one')
|
||||
setModePreview(MOVED, STORED)
|
||||
const proceed = vi.fn()
|
||||
expect(guardDrawing(proceed)).toBe(false)
|
||||
expect(useAnnotationWork.getState().question?.work).toBe('move')
|
||||
answerDrawing(false)
|
||||
const kept = useAnnotationWork.getState()
|
||||
expect(kept.question).toBeNull()
|
||||
expect(kept.preview?.geometry).toEqual(MOVED)
|
||||
expect(proceed).not.toHaveBeenCalled()
|
||||
guardDrawing(proceed)
|
||||
answerDrawing(true)
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
expect(proceed).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
})
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
renderHook,
|
||||
screen,
|
||||
waitFor,
|
||||
within,
|
||||
} from '@testing-library/react'
|
||||
import userEvent from '@testing-library/user-event'
|
||||
import type { ElementKey } from '@faunosteo/core-wasm/types'
|
||||
@@ -26,6 +27,13 @@ import useEditorHistory from '@/editor/history/useEditorHistory'
|
||||
import { defaultView, targetOfKey } from '@/editor/navigation'
|
||||
import { useEditorNavigation } from '@/editor/useEditorNavigation'
|
||||
import { useLocaleStore } from '@/state/localeStore'
|
||||
import DrawingGuardDialog from '@/components/editor/annotations/DrawingGuardDialog'
|
||||
import {
|
||||
resetWork,
|
||||
setModePreview,
|
||||
startMove,
|
||||
useAnnotationWork,
|
||||
} from '@/editor/annotations/workStore'
|
||||
|
||||
afterEach(cleanup)
|
||||
|
||||
@@ -66,6 +74,7 @@ function Page({ guard }: { guard?: () => { allowed: boolean } }) {
|
||||
<button onClick={() => nav.announce('one')}>say one</button>
|
||||
<button onClick={() => nav.announce('two')}>say two</button>
|
||||
<p data-testid="live">{nav.live}</p>
|
||||
<DrawingGuardDialog />
|
||||
</>
|
||||
)
|
||||
}
|
||||
@@ -372,3 +381,81 @@ describe('final review: queued landings (M-6)', () => {
|
||||
expect(focused).not.toContain(references)
|
||||
})
|
||||
})
|
||||
|
||||
describe('the drawing guard (R-12): a move mode and the navigations', () => {
|
||||
const STORED = { type: 'circle' as const, cx: 1, cy: 2, r: 3 }
|
||||
afterEach(resetWork)
|
||||
const tabShown = () => screen.getByRole('tab', { selected: true })
|
||||
const started = () => {
|
||||
startMove('a', 'doc')
|
||||
setModePreview({ ...STORED, cx: 9 }, STORED)
|
||||
}
|
||||
|
||||
it('with no step taken, a tab ends the mode at once, without a question', async () => {
|
||||
useLocaleStore.setState({ locale: 'fr' })
|
||||
const user = userEvent.setup()
|
||||
mount()
|
||||
startMove('a', 'doc')
|
||||
await user.click(screen.getByRole('tab', { name: 'Constats' }))
|
||||
expect(tabShown()).toHaveTextContent('Constats')
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
expect(screen.queryByRole('dialog')).toBeNull()
|
||||
})
|
||||
|
||||
it('after one step a tab asks; « Continuer » keeps the mode and its position', async () => {
|
||||
useLocaleStore.setState({ locale: 'fr' })
|
||||
const user = userEvent.setup()
|
||||
mount()
|
||||
started()
|
||||
await user.click(screen.getByRole('tab', { name: 'Constats' }))
|
||||
const dialog = screen.getByRole('dialog', {
|
||||
name: 'Abandonner le déplacement ?',
|
||||
})
|
||||
expect(tabShown()).toHaveTextContent('Général')
|
||||
await user.click(within(dialog).getByRole('button', { name: 'Continuer' }))
|
||||
expect(tabShown()).toHaveTextContent('Général')
|
||||
expect(useAnnotationWork.getState().preview?.geometry).toMatchObject({
|
||||
cx: 9,
|
||||
})
|
||||
await user.click(screen.getByRole('tab', { name: 'Constats' }))
|
||||
await user.click(screen.getByRole('button', { name: 'Abandonner' }))
|
||||
expect(tabShown()).toHaveTextContent('Constats')
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
})
|
||||
|
||||
it('« Aller à » asks the same way', async () => {
|
||||
useLocaleStore.setState({ locale: 'fr' })
|
||||
const user = userEvent.setup()
|
||||
mount()
|
||||
started()
|
||||
await user.click(screen.getByRole('button', { name: 'go to' }))
|
||||
expect(
|
||||
screen.getByRole('dialog', { name: 'Abandonner le déplacement ?' }),
|
||||
).toBeInTheDocument()
|
||||
expect(tabShown()).toHaveTextContent('Général')
|
||||
})
|
||||
|
||||
it('a Back asks and keeps the view; an unstarted mode lets it go and ends', async () => {
|
||||
useLocaleStore.setState({ locale: 'fr' })
|
||||
const user = userEvent.setup()
|
||||
mount()
|
||||
await user.click(screen.getByRole('tab', { name: 'Constats' }))
|
||||
started()
|
||||
act(() => navigate(-1))
|
||||
expect(tabShown()).toHaveTextContent('Constats')
|
||||
expect(
|
||||
screen.getByRole('dialog', { name: 'Abandonner le déplacement ?' }),
|
||||
).toBeInTheDocument()
|
||||
await user.click(screen.getByRole('button', { name: 'Abandonner' }))
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
// As after a layer's question, the Back is not replayed: the user goes Back again.
|
||||
expect(tabShown()).toHaveTextContent('Constats')
|
||||
await waitFor(() =>
|
||||
expect(document.querySelector('dialog[open]')).toBeNull(),
|
||||
)
|
||||
startMove('a', 'doc')
|
||||
act(() => navigate(-1))
|
||||
expect(tabShown()).toHaveTextContent('Général')
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
})
|
||||
})
|
||||
@@ -10,6 +10,11 @@ import {
|
||||
store,
|
||||
} from '../helpers/editorHarness'
|
||||
import { mountDraft, setWidth } from '../helpers/editorRoute'
|
||||
import {
|
||||
setModePreview,
|
||||
startMove,
|
||||
useAnnotationWork,
|
||||
} from '@/editor/annotations/workStore'
|
||||
|
||||
vi.mock('@/lib/supabase', () => ({ getSupabaseClient: () => ({}) }))
|
||||
vi.mock('@faunosteo/supabase', async (orig) => ({
|
||||
@@ -83,3 +88,47 @@ describe('editor-wide undo', () => {
|
||||
expect(store.getState().unsaved).toBe(true)
|
||||
})
|
||||
})
|
||||
|
||||
describe('undo with something pending (R-13)', () => {
|
||||
it('Ctrl+Z only cancels a move mode; the next one undoes', async () => {
|
||||
mountDraft()
|
||||
await ready()
|
||||
act(() => void commitMove(40))
|
||||
const stored = store.getState().previewState!.document.annotations[0]
|
||||
act(() => {
|
||||
startMove(stored.id, store.getState().documentText)
|
||||
setModePreview(
|
||||
{ type: 'circle', cx: 90, cy: 50, r: 10 },
|
||||
stored.geometry!,
|
||||
)
|
||||
})
|
||||
ctrlZ(document.body)
|
||||
expect(useAnnotationWork.getState().mode).toBeNull()
|
||||
expect(cx()).toMatchObject({ cx: 40 })
|
||||
ctrlZ(document.body)
|
||||
expect(cx()).toMatchObject({ cx: 50 })
|
||||
})
|
||||
|
||||
it('the header « Défaire » only cancels a pending size preview', async () => {
|
||||
mountDraft()
|
||||
await ready()
|
||||
act(() => void commitMove(40))
|
||||
const stored = store.getState().previewState!.document.annotations[0]
|
||||
act(() =>
|
||||
useAnnotationWork.setState({
|
||||
preview: {
|
||||
annotationId: stored.id,
|
||||
geometry: { type: 'circle', cx: 40, cy: 50, r: 20 },
|
||||
base: store.getState().documentText,
|
||||
source: 'size',
|
||||
},
|
||||
}),
|
||||
)
|
||||
const user = userEvent.setup()
|
||||
await user.click(screen.getByRole('button', { name: /Défaire/ }))
|
||||
expect(useAnnotationWork.getState().preview).toBeNull()
|
||||
expect(cx()).toMatchObject({ cx: 40 })
|
||||
await user.click(screen.getByRole('button', { name: /Défaire/ }))
|
||||
expect(cx()).toMatchObject({ cx: 50 })
|
||||
})
|
||||
})
|
||||
Reference in new issue
Block a user