Files
Web_FreeCAD_Bitbybit/scripts/run-freecad-property-linklisthidden-roundtrip.ts
wangdequan 7bd7ff5055
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 hidden link property evidence
2026-08-17 17:31:34 -04:00

109 lines
9.2 KiB
TypeScript

import { createHash } from 'node:crypto'
import { existsSync } from 'node:fs'
import { mkdir, readFile, writeFile } from 'node:fs/promises'
import { spawnSync } from 'node:child_process'
import { resolve } from 'node:path'
import { isDeepStrictEqual } from 'node:util'
import { unzipSync } from 'fflate'
import { createWebCadFacade } from '../src/facade/mockFacade'
import { decodeFcstdPropertyValue } from '../src/facade/fcstd'
const root = resolve(new URL('..', import.meta.url).pathname)
const executable = process.env.FREECAD_CMD || resolve(root, '.cache/freecad/install-desktop/bin/FreeCADCmd')
const sysroot = resolve(root, '.cache/freecad/sysroot')
const scriptPath = resolve(root, 'scripts/freecad-property-linklisthidden-roundtrip.py')
const outputDirectory = resolve(root, '.cache/freecad/property-linklisthidden-roundtrip')
const nativePath = resolve(outputDirectory, 'native-initial.FCStd')
const webPath = resolve(outputDirectory, 'web-edited.FCStd')
const resavedPath = resolve(outputDirectory, 'native-resaved.FCStd')
const reportPath = resolve(root, 'config/freecad-property-linklisthidden-roundtrip.json')
if (!existsSync(executable)) throw new Error(`FreeCAD PropertyLinkListHidden roundtrip executable is missing: ${executable}`)
await mkdir(outputDirectory, { recursive: true })
const runNative = (mode: 'create' | 'verify', path: string, resaved = '') => {
const execution = spawnSync(executable, ['--python-path', resolve(sysroot, 'usr/lib/python3/dist-packages'), scriptPath], {
cwd: root,
encoding: 'utf8',
timeout: 120_000,
maxBuffer: 32 * 1024 * 1024,
env: {
...process.env,
FREECAD_PROPERTY_LINKLISTHIDDEN_ROUNDTRIP_MODE: mode,
FREECAD_PROPERTY_LINKLISTHIDDEN_ROUNDTRIP_PATH: path,
FREECAD_PROPERTY_LINKLISTHIDDEN_ROUNDTRIP_RESAVED_PATH: resaved,
PYTHONPATH: `${resolve(sysroot, 'usr/lib/python3/dist-packages')}${process.env.PYTHONPATH ? `:${process.env.PYTHONPATH}` : ''}`,
LD_LIBRARY_PATH: `${resolve(sysroot, 'usr/lib/x86_64-linux-gnu')}${process.env.LD_LIBRARY_PATH ? `:${process.env.LD_LIBRARY_PATH}` : ''}`,
},
})
const output = `${execution.stdout || ''}\n${execution.stderr || ''}`
const marker = 'FREECAD_PROPERTY_LINKLISTHIDDEN_ROUNDTRIP_RESULT='
const line = output.split(/\r?\n/).find((candidate) => candidate.includes(marker))
if (execution.error || execution.status !== 0 || !line) throw new Error(`FreeCAD PropertyLinkListHidden ${mode} probe failed with status ${execution.status}: ${execution.error?.message || output.trim()}`)
return JSON.parse(line.slice(line.indexOf(marker) + marker.length))
}
const initial = ['ExportA', 'ExportB']
const target = ['ExportB', 'ExportA', 'ExportB']
const native = runNative('create', nativePath)
const nativeBytes = new Uint8Array(await readFile(nativePath))
const facade = createWebCadFacade({ runtimeMode: 'mock' })
const inspectedBefore = facade.project.fcstd.inspect(nativeBytes)
const property = (inspection: typeof inspectedBefore) => inspection.objects.find((object) => object.name === 'SketchProbe')?.properties.find((candidate) => candidate.name === 'Exports')
const editedBytes = facade.project.fcstd.rewriteLinkListHidden(nativeBytes, { objectName: 'SketchProbe', propertyName: 'Exports', value: target, expectedValue: initial })
const inspectedAfter = facade.project.fcstd.inspect(editedBytes)
await facade.project.dispose()
await writeFile(webPath, editedBytes)
const initialFiles = unzipSync(nativeBytes)
const editedFiles = unzipSync(editedBytes)
const opaquePaths = Object.keys(initialFiles).filter((path) => path.toLowerCase() !== 'document.xml')
const opaqueEntriesPreserved = opaquePaths.every((path) => Buffer.from(initialFiles[path]).equals(Buffer.from(editedFiles[path] ?? new Uint8Array())))
const withoutEditedProperty = (inspection: typeof inspectedBefore) => inspection.objects.map((object) => ({ ...object, properties: object.name === 'SketchProbe' ? object.properties.filter((candidate) => candidate.name !== 'Exports') : object.properties }))
const semanticObjectsPreserved = isDeepStrictEqual(withoutEditedProperty(inspectedBefore), withoutEditedProperty(inspectedAfter))
const editedDocumentXml = new TextDecoder().decode(editedFiles['Document.xml'])
const initialDocumentXml = new TextDecoder().decode(initialFiles['Document.xml'])
const dependencyTargets = (xml: string, objectName: string): string[] => {
const escapedName = objectName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
const match = xml.match(new RegExp(`<ObjectDeps(?=[^>]*Name="${escapedName}")[^>]*>([\\s\\S]*?)<\\/ObjectDeps>`))
return match ? [...match[1].matchAll(/<Dep\s+Name="([^"]+)"\s*\/>/g)].map((entry) => entry[1]) : []
}
const initialDependencyTargets = dependencyTargets(initialDocumentXml, 'SketchProbe')
const webDependencyTargets = dependencyTargets(editedDocumentXml, 'SketchProbe')
const targetMarkedTouched = /<Object(?=[^>]*name="SketchProbe")(?=[^>]*Touched="1")[^>]*\/>/.test(editedDocumentXml)
const hiddenDependencyMetadataPreserved = isDeepStrictEqual(initialDependencyTargets, initial) && isDeepStrictEqual(webDependencyTargets, initial)
const decodedAfter = property(inspectedAfter) ? decodeFcstdPropertyValue(property(inspectedAfter)!) : undefined
const webOutputMatches = decodedAfter?.decoded === true && isDeepStrictEqual(decodedAfter.value, target)
const nativeAfter = runNative('verify', webPath, resavedPath)
const resavedBytes = new Uint8Array(await readFile(resavedPath))
const resavedFiles = unzipSync(resavedBytes)
const nativeResavedDependencyTargets = dependencyTargets(new TextDecoder().decode(resavedFiles['Document.xml']), 'SketchProbe')
const snapshots = [native.result, nativeAfter.result.reopened, nativeAfter.result.resaved]
const nativeOutputMatches = isDeepStrictEqual(native.result.object.value, initial) && [nativeAfter.result.reopened, nativeAfter.result.resaved].every((snapshot: any) => isDeepStrictEqual(snapshot.object.value, target))
const objectSetPreserved = snapshots.every((snapshot: any) => isDeepStrictEqual(snapshot.objectSet, native.result.objectSet))
const hiddenLinksPreserved = snapshots.every((snapshot: any) => isDeepStrictEqual(snapshot.object.outList, []) && isDeepStrictEqual(snapshot.targets.ExportA.inList, []) && isDeepStrictEqual(snapshot.targets.ExportB.inList, []))
const shapeStructure = (shape: any) => { const { brepSha256: _brepSha256, ...structure } = shape; return structure }
const targetShapeStructurePreserved = snapshots.every((snapshot: any) => isDeepStrictEqual(shapeStructure(snapshot.targets.ExportA.shape), shapeStructure(native.result.targets.ExportA.shape)) && isDeepStrictEqual(shapeStructure(snapshot.targets.ExportB.shape), shapeStructure(native.result.targets.ExportB.shape)))
const ownerShapePreserved = snapshots.every((snapshot: any) => isDeepStrictEqual(snapshot.object.shape, native.result.object.shape))
const nativeDependencyMetadataNormalized = isDeepStrictEqual(nativeResavedDependencyTargets, target)
const zeroUnknownDrift = opaqueEntriesPreserved && semanticObjectsPreserved && targetMarkedTouched && hiddenDependencyMetadataPreserved && nativeDependencyMetadataNormalized && webOutputMatches && nativeOutputMatches && objectSetPreserved && hiddenLinksPreserved && targetShapeStructurePreserved && ownerShapePreserved
const report = {
schemaVersion: 1,
status: zeroUnknownDrift ? 'pass' : 'fail',
baselineId: 'freecad-1.1.1-property-linklisthidden-roundtrip',
freecadVersion: native.freecadVersion,
gitCommit: native.gitCommit,
propertyType: 'App::PropertyLinkListHidden',
archives: {
nativeInitial: { path: '.cache/freecad/property-linklisthidden-roundtrip/native-initial.FCStd', bytes: nativeBytes.byteLength, sha256: createHash('sha256').update(nativeBytes).digest('hex') },
webEdited: { path: '.cache/freecad/property-linklisthidden-roundtrip/web-edited.FCStd', bytes: editedBytes.byteLength, sha256: createHash('sha256').update(editedBytes).digest('hex') },
nativeResaved: { path: '.cache/freecad/property-linklisthidden-roundtrip/native-resaved.FCStd', bytes: resavedBytes.byteLength, sha256: createHash('sha256').update(resavedBytes).digest('hex') },
},
nativeInitial: native.result,
web: { before: property(inspectedBefore), after: property(inspectedAfter), targetMarkedTouched, initialDependencyTargets, webDependencyTargets, hiddenDependencyMetadataPreserved, webOutputMatches, objectSetPreserved, semanticObjectsPreserved, opaquePathsPreserved: opaquePaths.length, opaqueEntriesPreserved },
nativeAfter: nativeAfter.result,
classification: { requestedValue: target, webValue: decodedAfter?.value, reopenedValue: nativeAfter.result.reopened.object.value, resavedValue: nativeAfter.result.resaved.object.value, nativeOutputMatches, hiddenLinksPreserved, nativeResavedDependencyTargets, nativeDependencyMetadataNormalized, targetShapeStructurePreserved, ownerShapePreserved, nativeTargetBrepHashes: snapshots.map((snapshot: any) => ({ ExportA: snapshot.targets.ExportA.shape.brepSha256, ExportB: snapshot.targets.ExportB.shape.brepSha256 })), unknownSemanticDrift: !zeroUnknownDrift, zeroUnknownDrift },
}
await writeFile(reportPath, `${JSON.stringify(report, null, 2)}\n`)
console.log(JSON.stringify({ status: report.status, output: 'config/freecad-property-linklisthidden-roundtrip.json', values: report.classification, opaqueEntriesPreserved, semanticObjectsPreserved }, null, 2))