AI-native design editor. Open-source Figma alternative.
import { describe, expect, test } from 'bun:test'
import { reactive, ref } from 'vue'
import { createEditor } from '@open-pencil/core'
import { createDocumentChanges } from '@/app/document/io/changes'
import { createDocumentRecovery } from '@/app/document/recovery/controller'
import { createMemoryRecoveryStore } from '@/app/document/recovery/memory'
import type { RecoverySnapshotInput, RecoveryStore } from '@/app/document/recovery/types'
function deferredWriteStore() {
const memory = createMemoryRecoveryStore()
let release: (() => void) | null = null
const store: RecoveryStore = {
...memory,
async write(input: RecoverySnapshotInput) {
await new Promise<void>((resolve) => {
release = resolve
})
return memory.write(input)
}
}
return { store, release: () => release?.() }
}
function deferredRemoveStore() {
const memory = createMemoryRecoveryStore()
let release: (() => void) | null = null
const store: RecoveryStore = {
...memory,
async remove(id: string) {
await new Promise<void>((resolve) => {
release = resolve
})
await memory.remove(id)
}
}
return { store, release: () => release?.() }
}
/** Snapshots built by default hold the version they were built at, to show which one was kept. */
function setup(
buildFigFile?: () => Promise<Uint8Array>,
initialEnabled = true,
injectedStore?: RecoveryStore
) {
const state = reactive({ documentName: 'Agent draft' })
const version = ref(0)
const store = injectedStore ?? createMemoryRecoveryStore()
let writable = false
const enabled = ref(initialEnabled)
const recovery = createDocumentRecovery({
state,
version: () => version.value,
store,
recoveryId: 'recovery-1',
hasWritableSource: () => writable,
isEnabled: () => enabled.value,
buildFigFile: buildFigFile ?? (async () => new Uint8Array([version.value]))
})
return {
version,
store,
recovery,
setWritable: (value: boolean) => (writable = value),
setEnabled: (value: boolean) => (enabled.value = value)
}
}
describe('document recovery controller', () => {
test('persists source-less changes and skips untouched documents', async () => {
const { version, store, recovery } = setup()
await recovery.persistNow()
expect(await store.list()).toEqual([])
version.value = 1
await recovery.persistNow()
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(1)
recovery.disposeRecovery()
})
test('does not serialize or persist while disabled', async () => {
let builds = 0
const { version, store, recovery } = setup(async () => {
builds++
return new Uint8Array([1])
}, false)
version.value = 1
await recovery.persistNow()
expect(builds).toBe(0)
expect(await store.list()).toEqual([])
recovery.disposeRecovery()
})
test('removes the owned snapshot when disabled and resumes from the current version', async () => {
const { version, store, recovery, setEnabled } = setup()
version.value = 1
await recovery.persistNow()
expect(await store.list()).toHaveLength(1)
setEnabled(false)
await Promise.resolve()
await Promise.resolve()
expect(await store.list()).toEqual([])
version.value = 2
setEnabled(true)
await recovery.persistNow()
expect(await store.list()).toEqual([])
version.value = 3
await recovery.persistNow()
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(3)
recovery.disposeRecovery()
})
test('waits for disable cleanup before writing after re-enable', async () => {
const deferred = deferredRemoveStore()
const { version, store, recovery, setEnabled } = setup(undefined, true, deferred.store)
version.value = 1
await recovery.persistNow()
setEnabled(false)
setEnabled(true)
version.value = 2
const nextWrite = recovery.persistNow()
await Promise.resolve()
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(1)
deferred.release()
await nextWrite
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(2)
recovery.disposeRecovery()
})
test('does not persist documents with writable sources', async () => {
const { version, store, recovery, setWritable } = setup()
setWritable(true)
version.value = 1
await recovery.persistNow()
expect(await store.list()).toEqual([])
recovery.disposeRecovery()
})
test('recovery coalesces 100 changes during encoding to the latest version', async () => {
let release: (() => void) | null = null
let calls = 0
const { version, store, recovery } = setup(async () => {
calls++
if (calls === 1) {
await new Promise<void>((resolve) => {
release = resolve
})
}
return new Uint8Array([version.value])
})
version.value = 1
const pending = recovery.persistNow()
await Promise.resolve()
for (let next = 2; next <= 101; next++) {
version.value = next
void recovery.persistNow()
}
const releaseFirst = () => {
if (release) release()
}
releaseFirst()
await pending
expect(calls).toBe(2)
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(101)
recovery.disposeRecovery()
})
test('propagates persistence failures to close and reload callers', async () => {
const state = reactive({ documentName: 'Draft' })
const version = ref(0)
const store = createMemoryRecoveryStore()
const memoryWrite = store.write.bind(store)
let writeAttempts = 0
store.write = async (input) => {
writeAttempts++
if (writeAttempts === 1) throw new Error('recovery storage unavailable')
return memoryWrite(input)
}
const recovery = createDocumentRecovery({
state,
version: () => version.value,
store,
recoveryId: 'recovery-1',
hasWritableSource: () => false,
buildFigFile: () => new Uint8Array([version.value])
})
version.value = 1
await expect(recovery.persistNow()).rejects.toThrow('recovery storage unavailable')
await recovery.persistNow()
expect(writeAttempts).toBe(2)
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(1)
recovery.disposeRecovery()
})
test('successful save removes recovery data', async () => {
const { version, store, recovery } = setup()
version.value = 1
await recovery.persistNow()
expect(await store.list()).toHaveLength(1)
await recovery.markProtectedVersion(1)
expect(await store.list()).toEqual([])
recovery.disposeRecovery()
})
test('save waits for an active write before deleting its snapshot', async () => {
const deferred = deferredWriteStore()
const state = reactive({ documentName: 'Draft' })
const version = ref(0)
const recovery = createDocumentRecovery({
state,
version: () => version.value,
store: deferred.store,
recoveryId: 'recovery-1',
hasWritableSource: () => false,
buildFigFile: () => new Uint8Array([1])
})
version.value = 1
const write = recovery.persistNow()
await Promise.resolve()
const cleanup = recovery.markProtectedVersion(1)
deferred.release()
await Promise.all([write, cleanup])
expect(await deferred.store.list()).toEqual([])
recovery.disposeRecovery()
})
test('discard waits for an active write before deleting its snapshot', async () => {
const deferred = deferredWriteStore()
const state = reactive({ documentName: 'Draft' })
const version = ref(0)
const recovery = createDocumentRecovery({
state,
version: () => version.value,
store: deferred.store,
recoveryId: 'recovery-1',
hasWritableSource: () => false,
buildFigFile: () => new Uint8Array([1])
})
version.value = 1
const write = recovery.persistNow()
await Promise.resolve()
const discard = recovery.discardRecovery()
deferred.release()
await Promise.all([write, discard])
expect(await deferred.store.list()).toEqual([])
recovery.disposeRecovery()
})
test('adoption waits for an active write and removes the previous recovery id', async () => {
const deferred = deferredWriteStore()
const state = reactive({ documentName: 'Draft' })
const version = ref(0)
const recovery = createDocumentRecovery({
state,
version: () => version.value,
store: deferred.store,
recoveryId: 'previous',
hasWritableSource: () => false,
buildFigFile: () => new Uint8Array([1])
})
version.value = 1
const write = recovery.persistNow()
await Promise.resolve()
const adoption = recovery.adoptRecoverySnapshot('recovered')
deferred.release()
await Promise.all([write, adoption])
expect(recovery.getRecoveryId()).toBe('recovered')
expect(await deferred.store.read('previous')).toBeNull()
recovery.disposeRecovery()
})
test('preserves a snapshot newer than the saved version', async () => {
const { version, store, recovery } = setup()
version.value = 2
await recovery.persistNow()
await recovery.markProtectedVersion(1)
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(2)
recovery.disposeRecovery()
})
test('follows content edits, not render requests', async () => {
const editor = createEditor()
const changes = createDocumentChanges(editor)
const store = createMemoryRecoveryStore()
const recovery = createDocumentRecovery({
state: { documentName: 'Draft' },
version: changes.capture,
store,
recoveryId: 'recovery-1',
hasWritableSource: () => false,
buildFigFile: () => new Uint8Array([changes.capture()])
})
try {
for (let i = 0; i < 5; i++) editor.requestRender()
await recovery.persistNow()
expect(await store.list()).toEqual([])
editor.createShape('RECTANGLE', 0, 0, 100, 100)
await recovery.persistNow()
expect((await store.read('recovery-1'))?.figBytes[0]).toBe(changes.capture())
} finally {
recovery.disposeRecovery()
changes.dispose()
editor.dispose()
}
})
})