pcbjam/tests/scripts/setup-kicad-wasm.sh
Viktor Vaczi db9d6ee04b feat(wasm): occ-split — lazy occ_service worker; kicad_editor drops OCC (−31%)
Move OpenCASCADE out of the merged editor image into occ_service: a separate
emscripten module (-sASYNCIFY=0, MODULARIZE, in-container -Oz finalize, 2N+8
pre-warmed pthread pool) booted lazily in a dedicated Web Worker on the first
STEP export or STEP/IGES model parse. kicad_editor.wasm ~190 MB -> 130 MB;
sessions that never touch OCC never fetch its 57 MB. STEP export works in the
browser for the first time: the unchanged desktop dialog runs EXPORTER_STEP,
whose wasm shadow suspends into globalThis.occService and the export bytes go
straight to a browser download (never entering the editor heap). STEP/IGES 3D
models parse in the worker via the oce shadow (S3D WriteCache/ReadCache wire).

- wasm/occ-service/: service CMake target (hooked from the kicad fork's
  top-level CMakeLists, wasm/editor pattern), embind entry
  (occExport/occLoadModel), wxConfig pre-js.
- wasm/stubs/{exporter_step,oce_plugin}_stub.cpp: EM_ASYNC_JS worker bridges
  (callee-shadowing; no caller #ifdefs).
- web/standalone: provider installed whenever the kicad_editor bundle boots
  (cross-face safe); ONE shared worker-boot source occ-worker.js (vite ?raw;
  the e2e stub reads the same file) — blob worker with locateFile absolutized
  against the glue URL; export download-name guard.
- deps: OCC builds with RapidJSON so its glTF/GLB writer exists — pinned to
  the vcpkg master snapshot 2025-02-26 (24b5e7a8b27f), the same code official
  KiCad consumes via vcpkg.json's opencascade[rapidjson]; rapidjson's latest
  tag (v1.1.0, 2016) is ill-formed under modern clang.
- tests: occ-export dialog e2e (lazy-fetch boundary + STEP download bytes),
  occ-probe incl. a 9-format matrix (step/stpz/brep/xao/ply/stl/glb/u3d/pdf),
  3d-viewer-models hard-asserts the worker parse; occ provider stub installed
  ambiently by the kicad fixtures.

Validated against desktop kicad-cli 10.0.4: geometric exact equality (bbox
delta 0 um, volume delta 0.0000%) for STEP/GLB/STL/BREP/STPZ across three
boards and option sweeps — with desktop OCC 7.9 vs wasm OCC 7.8; PLY/XAO/PDF
structurally equal; U3D same-size (quantizer float LSBs differ). Full kicad
e2e green on Firefox and Chromium; standalone verified end to end (lazy fetch
only on the Export click; export.step 60,628 B ISO-10303-21; loadModel 700 KB
STEP -> 569 KB scenegraph cache).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-03 12:39:58 +02:00

135 lines
5.4 KiB
Shell
Executable file

#!/bin/bash
# Copies KiCad WASM build output to test directory
#
# Priority: Use local output/ directory (populated by docker/build.sh)
# Fallback: Copy from Docker volume directly
#
# Copies whichever apps are present (pcbnew, eeschema, calculator).
set -e
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
KICAD_TEST="$PROJECT_ROOT/tests/apps/kicad"
OUTPUT_DIR="$PROJECT_ROOT/output"
mkdir -p "$KICAD_TEST"
# Smart copy: skip when the destination already exists and is byte-identical to
# the source (cmp -s is portable across macOS/Linux). Makes this a real sync —
# re-running does not rewrite unchanged multi-hundred-MB .wasm files.
smart_cp() {
local src="$1" destdir="$2"
[ -f "$src" ] || return 0
local dst="$destdir/$(basename "$src")"
if [ -f "$dst" ] && cmp -s "$src" "$dst"; then
echo " = $(basename "$src") (up-to-date)"
return 0
fi
cp "$src" "$dst"
echo " + $(basename "$src")"
}
# Map an app name to its inner CMake build subdirectory. Most apps share their
# subdir name with the app name; pcb_calculator emits OUTPUT_NAME=calculator
# but lives under the pcb_calculator/ subtree of the build dir, and pl_editor's
# source lives under pagelayout_editor/.
kicad_subdir_for() {
case "$1" in
calculator) echo "pcb_calculator" ;;
pl_editor) echo "pagelayout_editor" ;;
*) echo "$1" ;;
esac
}
# Copy one app's artifacts (js, wasm, optional debug/map/worker). Returns 0
# if the app was present, 1 if neither output/ nor the docker volume has it.
copy_app() {
local app="$1"
local subdir
subdir=$(kicad_subdir_for "$app")
if [ -f "$OUTPUT_DIR/${app}.js" ] && [ -f "$OUTPUT_DIR/${app}.wasm" ]; then
echo "Syncing ${app} WASM files from output directory..."
smart_cp "$OUTPUT_DIR/${app}.js" "$KICAD_TEST"
smart_cp "$OUTPUT_DIR/${app}.wasm" "$KICAD_TEST"
smart_cp "$OUTPUT_DIR/${app}.wasm.map" "$KICAD_TEST"
smart_cp "$OUTPUT_DIR/${app}.worker.js" "$KICAD_TEST"
smart_cp "$OUTPUT_DIR/images.tar.gz" "$KICAD_TEST"
return 0
fi
echo "Output ${app} not found locally, trying Docker volume..."
if docker compose -f "$PROJECT_ROOT/docker/docker-compose.yml" cp \
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}/${subdir}/${app}.js "$KICAD_TEST/" 2>/dev/null \
&& docker compose -f "$PROJECT_ROOT/docker/docker-compose.yml" cp \
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}/${subdir}/${app}.wasm "$KICAD_TEST/" 2>/dev/null; then
docker compose -f "$PROJECT_ROOT/docker/docker-compose.yml" cp \
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}/${subdir}/${app}.wasm.map "$KICAD_TEST/" 2>/dev/null || true
docker compose -f "$PROJECT_ROOT/docker/docker-compose.yml" cp \
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}/${subdir}/${app}.worker.js "$KICAD_TEST/" 2>/dev/null || true
docker compose -f "$PROJECT_ROOT/docker/docker-compose.yml" cp \
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}/resources/images.tar.gz "$KICAD_TEST/" 2>/dev/null || true
return 0
fi
echo " (no ${app} artifacts found — skipping)"
return 1
}
found_any=0
# The four editors (pcbnew / eeschema / footprint_editor / symbol_editor) are ALL
# served by the ONE merged kicad_editor bundle: their harness HTMLs load
# kicad_editor.js and select the frame at runtime via --frame (editor-unification
# Part 2).
copy_app kicad_editor && found_any=1
copy_app calculator && found_any=1
copy_app pl_editor && found_any=1
copy_app gerbview && found_any=1
# OCC 3D service (lazy worker module; pcbnew's STEP export + model parsing)
copy_app occ_service || true
if [ "$found_any" -eq 0 ]; then
echo "Error: no kicad_editor/calculator/pl_editor/gerbview artifacts found in output/ or docker volume" >&2
exit 1
fi
# wxWidgets WASM JavaScript glue code (defines JS functions called from WASM)
echo "Syncing wxWidgets WASM glue code..."
if [ -f "$OUTPUT_DIR/wx.js" ]; then
smart_cp "$OUTPUT_DIR/wx.js" "$KICAD_TEST"
else
if docker compose -f "$PROJECT_ROOT/docker/docker-compose.yml" cp \
kicad-wasm-builder:/workspace/wxwidgets/build/wasm/wx.js "$KICAD_TEST/" 2>/dev/null; then
:
else
smart_cp "$PROJECT_ROOT/wxwidgets/build/wasm/wx.js" "$KICAD_TEST"
fi
fi
# The control-layer shim loads after wx.js (the checked-in kicad pages
# reference both via <script> tags).
if [ -f "$OUTPUT_DIR/wx-dom.js" ]; then
smart_cp "$OUTPUT_DIR/wx-dom.js" "$KICAD_TEST"
else
smart_cp "$PROJECT_ROOT/wxwidgets/build/wasm/wx-dom.js" "$KICAD_TEST"
fi
# Demo board for the gerbview print test (tests/apps/kicad/gerbview-print.html).
# Provisioned (not committed; gitignored) from the canonical demo board, same
# pattern as the wasm artifacts above. gerbview-print.html fetches the subset of
# layers it needs from ./board/, so copying the whole set is harmless.
BOARD_SRC="$PROJECT_ROOT/site/public/gerber-demo/board"
if [ -d "$BOARD_SRC" ]; then
echo "Provisioning gerbview demo board..."
mkdir -p "$KICAD_TEST/board"
for f in "$BOARD_SRC"/tinytapeout-demo-*; do
smart_cp "$f" "$KICAD_TEST/board"
done
else
echo " (demo board source $BOARD_SRC not found — skipping)"
fi
echo "KiCad WASM files synced to $KICAD_TEST"
ls -lh "$KICAD_TEST"