Files
faunosteo/apps/app/tests/unit/editor-preview.test.ts
T

241 lines
7.5 KiB
TypeScript

/**
* Lot C: the editable preview handle. A text or drawing is kept (for a rebuild after a trap
* or a generation change) only once the core accepted it.
*/
import { beforeAll, describe, expect, it } from 'vitest'
import type { CoreRuntime } from '@faunosteo/core-wasm'
import { CataloguePreview } from '@/catalogue/preview'
import { setCoreRuntime } from '@/core/runtime'
import { cleanSvg } from '@/editor/core/cleaning'
import { applyEdit } from '@/editor/core/editOps'
import { emptySheetDocument } from '@/core/sheetDocumentOps'
import { testCoreRuntime } from '../helpers/core'
const SVG =
'<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 10 10"><rect width="4" height="4"/></svg>'
let runtime: CoreRuntime
beforeAll(async () => {
runtime = await testCoreRuntime()
setCoreRuntime(runtime)
})
function baseText(): string {
const empty = emptySheetDocument({
speciesId: 'equine',
name: { fr: 'Fiche', en: 'Sheet' },
})
if (!empty.ok) throw new Error(empty.kind)
return JSON.stringify(empty.value)
}
function renamed(text: string, name: string): string {
const document = JSON.parse(text)
document.name = { fr: name, en: name }
return JSON.stringify(document)
}
function withDetail(text: string, viewId: string, assetId: string): string {
const edited = applyEdit(text, {
op: 'insert',
element: {
kind: 'view',
value: {
kind: 'detail',
id: viewId,
name: { fr: 'D', en: 'D' },
svg_asset_id: assetId,
view_box: null,
parent_view_id: 'view-main',
},
},
})
if (!edited.ok) throw new Error(edited.kind)
return edited.value
}
function drawing(assetId: string, extra = '') {
const cleaned = cleanSvg(new TextEncoder().encode(SVG + extra))
if (!cleaned.ok || !cleaned.value.stored || !cleaned.value.sha256)
throw new Error('uncleanable')
const bytes = new TextEncoder().encode(cleaned.value.stored)
return { assetId, sha256: cleaned.value.sha256, bytes }
}
function draft(text = baseText()) {
return new CataloguePreview(runtime, { status: 'draft', document: text }, [])
}
function stateOf(preview: CataloguePreview) {
const state = preview.state()
if (!state.ok) throw new Error(state.kind)
return state.value
}
/** The next call finds a handle of an older generation and rebuilds from the kept input. */
function forceRebuild() {
runtime.generation += 1
}
describe('CataloguePreview editing', () => {
it('rebuilds with the replaced text and the added drawing', () => {
const asset = '11111111-1111-4111-8111-111111111111'
const preview = draft()
const text = withDetail(
renamed(baseText(), 'Nouveau'),
'view-aaaaaaaaaa',
asset,
)
expect(preview.replaceDocument(text).ok).toBe(true)
expect(preview.addDrawing(drawing(asset)).ok).toBe(true)
forceRebuild()
const state = stateOf(preview)
expect(state.document.name.fr).toBe('Nouveau')
expect(state.drawings).toMatchObject([{ asset_id: asset, state: 'ok' }])
expect(preview.canvas('view-aaaaaaaaaa').ok).toBe(true)
preview.free()
})
it('does not keep a refused text', () => {
const preview = draft()
const before = preview.document
const outcome = preview.replaceDocument('{"not":"a document"}')
expect(outcome).toMatchObject({ ok: false, reason: 'core' })
expect(preview.document).toBe(before)
forceRebuild()
expect(stateOf(preview).document.name.fr).toBe('Fiche')
preview.free()
})
it('refuses a bad drawing alone and keeps the good one', () => {
const good = '22222222-2222-4222-8222-222222222222'
const bad = '33333333-3333-4333-8333-333333333333'
const preview = draft(withDetail(baseText(), 'view-bbbbbbbbbb', good))
expect(preview.addDrawing(drawing(good)).ok).toBe(true)
const wrong = { ...drawing(bad), sha256: 'a'.repeat(64) }
expect(preview.addDrawing(wrong)).toMatchObject({
ok: false,
kind: 'drawing_hash_mismatch',
})
forceRebuild()
expect(stateOf(preview).drawings).toMatchObject([
{ asset_id: good, state: 'ok' },
])
preview.free()
})
it('replaces a re-added drawing and caps the count at 16', () => {
const preview = draft()
for (let i = 0; i < 16; i += 1) {
expect(preview.addDrawing(drawing(`id-${i}`)).ok).toBe(true)
}
expect(preview.addDrawing(drawing('id-16'))).toMatchObject({
ok: false,
kind: 'caps',
})
expect(preview.addDrawing(drawing('id-0', '\n')).ok).toBe(true)
forceRebuild()
expect(preview.state().ok).toBe(true)
preview.free()
})
})
describe('replaceDocument accept hook', () => {
it('rolls back and keeps everything when accept refuses', () => {
const preview = draft()
const before = stateOf(preview)
const outcome = preview.replaceDocument(
renamed(preview.document, 'Refusé'),
() => ({
accepted: false,
refusal: 'nope',
}),
)
expect(outcome).toEqual({ ok: false, reason: 'refused', refusal: 'nope' })
expect(stateOf(preview)).toEqual(before)
forceRebuild()
expect(stateOf(preview)).toEqual(before)
preview.free()
})
it('keeps the candidate when accept agrees, and hands it the candidate state', () => {
const preview = draft()
const seen: string[] = []
const outcome = preview.replaceDocument(
renamed(preview.document, 'Gardé'),
(state) => {
seen.push(state.document.name.fr)
return { accepted: true }
},
)
expect(outcome.ok).toBe(true)
expect(seen).toEqual(['Gardé'])
forceRebuild()
expect(stateOf(preview).document.name.fr).toBe('Gardé')
preview.free()
})
it('rolls back when state fails without a trap', () => {
const preview = draft()
const before = stateOf(preview)
const handle = (
preview as unknown as { handle: { call(op: string, i: string): string } }
).handle
const real = handle.call.bind(handle)
let failed = false
handle.call = (op, input) => {
if (op === 'preview.state' && !failed) {
failed = true
return '{"ok":false,"kind":"invalid_shape"}'
}
return real(op, input)
}
const outcome = preview.replaceDocument(renamed(preview.document, 'Perdu'))
expect(outcome).toMatchObject({
ok: false,
reason: 'core',
failure: { kind: 'invalid_shape' },
})
expect(stateOf(preview)).toEqual(before)
forceRebuild()
expect(stateOf(preview)).toEqual(before)
preview.free()
})
it('rolls back when accept throws, and rethrows', () => {
const preview = draft()
const before = stateOf(preview)
expect(() =>
preview.replaceDocument(renamed(preview.document, 'Boom'), () => {
throw new Error('boom')
}),
).toThrow('boom')
expect(stateOf(preview)).toEqual(before)
forceRebuild()
expect(stateOf(preview)).toEqual(before)
preview.free()
})
it('rolls back on a non-trap internal failure of state', () => {
const preview = draft()
const before = stateOf(preview)
const handle = (
preview as unknown as { handle: { call(op: string, i: string): string } }
).handle
const real = handle.call.bind(handle)
let failed = false
handle.call = (op, input) => {
if (op === 'preview.state' && !failed) {
failed = true
return '{"ok":false,"kind":"internal"}'
}
return real(op, input)
}
const outcome = preview.replaceDocument(renamed(preview.document, 'Perdu'))
expect(outcome).toMatchObject({ ok: false, failure: { kind: 'internal' } })
expect(stateOf(preview)).toEqual(before)
preview.free()
})
})