Files
Web_FreeCAD_Bitbybit/tests/propertyDirectionTransaction.test.ts
wangdequan d11566403d
Some checks failed
real-verification / chrome (push) Has been cancelled
real-verification / freecad-oracle (push) Has been cancelled
real-verification / wasm (push) Has been cancelled
feat: close ordered pairs and property codec batches
2026-08-17 04:58:46 -04:00

91 lines
5.4 KiB
TypeScript

import { test } from 'node:test'
import assert from 'node:assert/strict'
import { createWebCadFacade } from '../src/facade/mockFacade'
import { encodeFreecadPropertyStatus } from '../src/facade/propertyStatus'
import type { DocumentSnapshot, FacadeEvent, VectorValue } from '../src/facade/types'
const fixture = (): DocumentSnapshot => ({
id: 'property-direction-transaction',
label: 'PropertyDirection Transaction',
version: 1,
dirty: false,
readOnly: false,
units: 'mm',
tree: [
{ id: 'DirectionProbe', label: 'Direction probe', type: 'feature', state: 'valid' },
{ id: 'ImmutableDirectionProbe', label: 'Immutable direction probe', type: 'feature', state: 'valid' },
],
objects: [
{
id: 'DirectionProbe',
typeId: 'Part::Mirroring',
properties: [{ name: 'Normal', label: 'Normal', group: 'Plane', scope: 'data', type: 'App::PropertyDirection', value: { x: 0, y: 0, z: 1 }, recompute: true }],
},
{
id: 'ImmutableDirectionProbe',
typeId: 'Part::Mirroring',
properties: [{ name: 'Normal', label: 'Immutable normal', group: 'Plane', scope: 'data', type: 'App::PropertyDirection', value: { x: 0, y: 1, z: 0 }, nativeStatus: encodeFreecadPropertyStatus(['Immutable']), readOnly: true, recompute: true }],
},
],
dependencies: [],
recompute: { generation: 0, status: 'idle', objectStates: { DirectionProbe: 'up-to-date', ImmutableDirectionProbe: 'up-to-date' }, dirtyObjects: [], order: [], errors: [] },
})
const valueOf = (facade: ReturnType<typeof createWebCadFacade>, objectId = 'DirectionProbe') => facade.app.document.getObject(objectId)?.properties.find((property) => property.name === 'Normal')?.value as VectorValue
test('App::PropertyDirection transaction closes undo, redo, stale, cancel, failure and resource ownership', async () => {
const facade = createWebCadFacade({ initialDocument: fixture(), runtimeMode: 'mock' })
const events: FacadeEvent[] = []
facade.subscribe((event) => {
if (event.type === 'property.before-change' || event.type === 'property.changed' || event.type === 'transaction.committed') events.push(event)
})
const resourcesBefore = facade.geometry.capabilities()
const requested: VectorValue = { x: 0.25, y: -0.5, z: 1.5 }
facade.app.document.setProperty({ objectId: 'DirectionProbe', propertyName: 'Normal', value: requested, expectedDocumentVersion: 1 })
requested.x = 99
assert.deepEqual(valueOf(facade), { x: 0.25, y: -0.5, z: 1.5 })
const exposed = valueOf(facade)
exposed.y = 99
assert.deepEqual(valueOf(facade), { x: 0.25, y: -0.5, z: 1.5 })
assert.equal(facade.app.document.getActive().version, 2)
assert.equal(facade.app.document.getActive().dirty, true)
assert.equal(facade.app.document.getActive().recompute?.objectStates.DirectionProbe, 'touched')
assert.deepEqual(events.map((event) => event.type), ['property.before-change', 'property.changed', 'transaction.committed'])
assert.equal(new Set(events.map((event) => 'transactionId' in event ? event.transactionId : '')).size, 1)
const committed = events[2]
assert.equal(committed.type, 'transaction.committed')
if (committed.type === 'transaction.committed') assert.deepEqual({ operation: committed.operation, beforeVersion: committed.beforeVersion, afterVersion: committed.afterVersion }, { operation: 'property.set', beforeVersion: 1, afterVersion: 2 })
facade.history.undo()
assert.deepEqual(valueOf(facade), { x: 0, y: 0, z: 1 })
assert.equal(facade.app.document.getActive().version, 1)
assert.equal(facade.history.canUndo(), false)
assert.equal(facade.history.canRedo(), true)
facade.history.redo()
assert.deepEqual(valueOf(facade), { x: 0.25, y: -0.5, z: 1.5 })
assert.equal(facade.app.document.getActive().version, 2)
assert.equal(facade.history.canUndo(), true)
assert.equal(facade.history.canRedo(), false)
const stableState = JSON.stringify(facade.app.document.getActive())
const stableEvents = events.length
assert.throws(() => facade.app.document.setProperty({ objectId: 'DirectionProbe', propertyName: 'Normal', value: { x: 0, y: 0, z: 0 }, expectedDocumentVersion: 1 }), /Stale document version: expected 1, current 2/)
const cancelled = new AbortController()
cancelled.abort()
assert.throws(() => facade.app.document.setProperty({ objectId: 'DirectionProbe', propertyName: 'Normal', value: { x: 0, y: 0, z: 0 }, expectedDocumentVersion: 2, signal: cancelled.signal }), (error: unknown) => error instanceof DOMException && error.name === 'AbortError')
assert.throws(() => facade.app.document.setProperty({ objectId: 'DirectionProbe', propertyName: 'Normal', value: { x: 0, y: Number.POSITIVE_INFINITY, z: 1 } }), /components must be finite/)
assert.throws(() => facade.app.document.setProperty({ objectId: 'ImmutableDirectionProbe', propertyName: 'Normal', value: { x: 0, y: 0, z: 1 } }), /Immutable normal is read-only/)
assert.equal(JSON.stringify(facade.app.document.getActive()), stableState)
assert.equal(events.length, stableEvents)
assert.equal(facade.history.canUndo(), true)
assert.equal(facade.history.canRedo(), false)
const resourcesAfter = facade.geometry.capabilities()
assert.deepEqual(
{ shapeCount: resourcesAfter.shapeCount, kernelReferenceCount: resourcesAfter.kernelReferenceCount, releasedShapeCount: resourcesAfter.releasedShapeCount },
{ shapeCount: resourcesBefore.shapeCount, kernelReferenceCount: resourcesBefore.kernelReferenceCount, releasedShapeCount: resourcesBefore.releasedShapeCount },
)
await facade.project.dispose()
})