feat: close ordered pairs and property codec batches

scripts/run-freecad-property-file-roundtrip.ts

@@ -0,0 +1,123 @@
+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-file-roundtrip.py')
+const outputDirectory = resolve(root, '.cache/freecad/property-file-roundtrip')
+const nativePath = resolve(outputDirectory, 'native-initial.FCStd')
+const webPath = resolve(outputDirectory, 'web-edited.FCStd')
+const resavedPath = resolve(outputDirectory, 'native-resaved.FCStd')
+const alternateAssetPath = resolve(outputDirectory, 'alternate.obj')
+const reportPath = resolve(root, 'config/freecad-property-file-roundtrip.json')
+const initial = '.cache/freecad/FreeCAD/data/tests/mesh.obj'
+const target = '.cache/freecad/property-file-roundtrip/alternate.obj'
+if (!existsSync(executable)) throw new Error(`FreeCAD PropertyFile roundtrip executable is missing: ${executable}`)
+if (!existsSync(resolve(root, initial))) throw new Error(`FreeCAD PropertyFile initial asset is missing: ${initial}`)
+await mkdir(outputDirectory, { recursive: true })
+await writeFile(alternateAssetPath, '# PropertyFile roundtrip triangle\nv 0 0 0\nv 4 0 0\nv 0 3 0\nf 1 2 3\n')
+
+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_FILE_ROUNDTRIP_MODE: mode,
+      FREECAD_PROPERTY_FILE_ROUNDTRIP_PATH: path,
+      FREECAD_PROPERTY_FILE_ROUNDTRIP_RESAVED_PATH: resaved,
+      FREECAD_PROPERTY_FILE_ROUNDTRIP_INITIAL: initial,
+      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_FILE_ROUNDTRIP_RESULT='
+  const line = output.split(/\r?\n/).find((candidate) => candidate.includes(marker))
+  if (execution.error || execution.status !== 0 || !line) throw new Error(`FreeCAD PropertyFile ${mode} probe failed with status ${execution.status}: ${execution.error?.message || output.trim()}`)
+  return JSON.parse(line.slice(line.indexOf(marker) + marker.length))
+}
+
+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 === 'FileProbe')?.properties.find((candidate) => candidate.name === 'FileName')
+const editedBytes = facade.project.fcstd.rewriteFile(nativeBytes, { objectName: 'FileProbe', propertyName: 'FileName', 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 === 'FileProbe' ? object.properties.filter((candidate) => candidate.name !== 'FileName') : object.properties }))
+const semanticObjectsPreserved = isDeepStrictEqual(withoutEditedProperty(inspectedBefore), withoutEditedProperty(inspectedAfter))
+const editedDocumentXml = new TextDecoder().decode(editedFiles['Document.xml'])
+const targetMarkedTouched = /<Object(?=[^>]*name="FileProbe")(?=[^>]*Touched="1")[^>]*\/>/.test(editedDocumentXml)
+const decodedAfter = property(inspectedAfter) ? decodeFcstdPropertyValue(property(inspectedAfter)!) : undefined
+const webOutputMatches = decodedAfter?.decoded === true && decodedAfter.value === target
+const nativeAfter = runNative('verify', webPath, resavedPath)
+const resavedBytes = new Uint8Array(await readFile(resavedPath))
+const nativeSnapshots = [nativeAfter.result.reopened, nativeAfter.result.resaved]
+const nativeOutputMatches = nativeSnapshots.every((snapshot: any) => snapshot.object.value === target)
+const objectSetPreserved = nativeSnapshots.every((snapshot: any) => isDeepStrictEqual(native.result.objectSet, snapshot.objectSet))
+const nativeMeshChanged = !isDeepStrictEqual(native.result.object.mesh, nativeAfter.result.reopened.object.mesh)
+const nativeMeshStable = isDeepStrictEqual(nativeAfter.result.reopened.object.mesh, nativeAfter.result.resaved.object.mesh)
+const asset = async (path: string) => {
+  const bytes = await readFile(resolve(root, path))
+  return { path, bytes: bytes.byteLength, sha256: createHash('sha256').update(bytes).digest('hex') }
+}
+const assets = { initial: await asset(initial), target: await asset(target) }
+const zeroUnknownDrift = opaqueEntriesPreserved && semanticObjectsPreserved && targetMarkedTouched && webOutputMatches && nativeOutputMatches && objectSetPreserved && nativeMeshChanged && nativeMeshStable
+const report = {
+  schemaVersion: 1,
+  status: zeroUnknownDrift ? 'pass' : 'fail',
+  baselineId: 'freecad-1.1.1-property-file-roundtrip',
+  freecadVersion: native.freecadVersion,
+  gitCommit: native.gitCommit,
+  propertyType: 'App::PropertyFile',
+  assets,
+  archives: {
+    nativeInitial: { path: '.cache/freecad/property-file-roundtrip/native-initial.FCStd', bytes: nativeBytes.byteLength, sha256: createHash('sha256').update(nativeBytes).digest('hex') },
+    webEdited: { path: '.cache/freecad/property-file-roundtrip/web-edited.FCStd', bytes: editedBytes.byteLength, sha256: createHash('sha256').update(editedBytes).digest('hex') },
+    nativeResaved: { path: '.cache/freecad/property-file-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,
+    webOutputMatches,
+    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,
+    objectSetPreserved,
+    nativeMeshChanged,
+    nativeMeshStable,
+    externalResourceBoundary: 'project-relative-path; asset bytes remain external to FCStd',
+    unknownSemanticDrift: !zeroUnknownDrift,
+    zeroUnknownDrift,
+  },
+}
+await writeFile(reportPath, `${JSON.stringify(report, null, 2)}\n`)
+console.log(JSON.stringify({ status: report.status, output: 'config/freecad-property-file-roundtrip.json', values: report.classification, mesh: { initial: report.nativeInitial.object.mesh, reopened: report.nativeAfter.reopened.object.mesh }, opaqueEntriesPreserved }, null, 2))