AI_Assistant/pcbjam
Watch
1
0
Fork
You've already forked pcbjam
 0
Code Issues Pull requests Projects Releases 7 Packages Wiki Activity Actions

feat(wasm-dom): Phase 7 plumbing — KiCad DOM-flavor build + test pipeline

Browse source 
WX_PORT=dom flows host → docker container → build scripts:
build-kicad-target.sh selects wxwidgets-dom + kicad-<app>-dom trees;
docker/build.sh passes the env through, copies outputs to output-dom/
incl. wx-dom.js, and post-processes there; build-wxuniversal-wasm.sh
honors WX_PORT and accepts --no-clean again (the kicad pipeline calls it
with that flag — Phase 1's stricter parser had broken the canvas docker
path). setup-kicad-wasm.sh syncs DOM bundles into tests/apps-dom/kicad
and injects the wx-dom.js script tag into the kicad pages;
playwright-kicad.config.ts serves apps-dom under WX_PORT=dom.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Viktor Vaczi 2026-06-11 00:19:53 +02:00
commit 74c392f88f
5 changed files with 84 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docker/build.sh
View file

@ -178,23 +178,34 @@ compile_app() {
echo ""
echo "=== Building ${app} (${index}/${total}) ==="
# WX_PORT=dom builds against the DOM wxWidgets into separate build and
# output trees (kicad-<app>-dom, output-dom/).
local out_dir="output"
local kicad_build="kicad-${app}"
if [[ "${WX_PORT:-}" == "dom" ]]; then
out_dir="output-dom"
kicad_build="kicad-${app}-dom"
fi
# Run build inside the container.
# -e EMSDK=/emsdk: `docker compose exec` bypasses the entrypoint that sources
# emsdk_env.sh, so the build shell would lack emcc/embuilder on PATH. Setting
# EMSDK lets scripts/common/env.sh source /emsdk/emsdk_env.sh and activate the toolchain.
docker compose -f docker/docker-compose.yml exec -e EMSDK=/emsdk kicad-wasm-builder \
docker compose -f docker/docker-compose.yml exec -e EMSDK=/emsdk -e WX_PORT="${WX_PORT:-}" \
kicad-wasm-builder \
"/workspace/scripts/kicad/build-${app}.sh" "${ARGS[@]}"
# Copy output to host-accessible directory.
# ${app}.wasm.debug.wasm contains DWARF debug info (when built with -gseparate-dwarf).
kw_stage copy-output
echo "Copying ${app} build output to ./output/..."
echo "Copying ${app} build output to ./${out_dir}/..."
docker compose -f docker/docker-compose.yml exec kicad-wasm-builder \
bash -c "mkdir -p /workspace/output && \
cp /workspace/build-wasm/kicad-${app}/${subdir}/${app}.{js,wasm,wasm.debug.wasm,wasm.map,worker.js} /workspace/output/ 2>/dev/null || \
cp /workspace/build-wasm/kicad-${app}/${subdir}/${app}.{js,wasm} /workspace/output/; \
cp /workspace/build-wasm/kicad-${app}/resources/images.tar.gz /workspace/output/ 2>/dev/null || true; \
cp /workspace/build-wasm/wxwidgets/build/wasm/wx.js /workspace/output/ 2>/dev/null || true"
bash -c "mkdir -p /workspace/${out_dir} && \
cp /workspace/build-wasm/${kicad_build}/${subdir}/${app}.{js,wasm,wasm.debug.wasm,wasm.map,worker.js} /workspace/${out_dir}/ 2>/dev/null || \
cp /workspace/build-wasm/${kicad_build}/${subdir}/${app}.{js,wasm} /workspace/${out_dir}/; \
cp /workspace/build-wasm/${kicad_build}/resources/images.tar.gz /workspace/${out_dir}/ 2>/dev/null || true; \
cp /workspace/build-wasm/wxwidgets/build/wasm/wx.js /workspace/${out_dir}/ 2>/dev/null || true; \
if [ -n \"${WX_PORT:-}\" ]; then cp /workspace/build-wasm/wxwidgets/build/wasm/wx-dom.js /workspace/${out_dir}/ 2>/dev/null || true; fi"
# The container runs as root, so files in the bind-mounted ./output land
# root-owned on the host. macOS Docker Desktop remaps ownership to the host
@ -213,15 +224,15 @@ postprocess_app() {
# Inject dynCall shims (fixes "dynCall_* is not defined" errors in Emscripten 4.x)
kw_stage dyncall-shims
./scripts/common/inject-dyncall-shims.sh "output/${app}.js"
./scripts/common/inject-dyncall-shims.sh "${out_dir}/${app}.js"
# Apply wasm-emscripten-finalize on host (skipped in Docker due to memory limits)
kw_stage finalize
./scripts/common/apply-finalize.sh "output/${app}.wasm" "output/${app}.wasm"
./scripts/common/apply-finalize.sh "${out_dir}/${app}.wasm" "${out_dir}/${app}.wasm"
# Apply asyncify transformation on host
kw_stage asyncify
./scripts/common/apply-asyncify.sh "output/${app}.wasm" "output/${app}.wasm"
./scripts/common/apply-asyncify.sh "${out_dir}/${app}.wasm" "${out_dir}/${app}.wasm"
}
# --- Pipelined driver state (KICAD_PIPELINE=1) ---

10
scripts/build-wxuniversal-wasm.sh
View file

@ -31,13 +31,17 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
WX_SOURCE="$PROJECT_ROOT/wxwidgets"
# Parse arguments: --clean and/or --dom, in any order
# Parse arguments: --clean, --no-clean (default; kept for the kicad
# pipeline's explicit call) and/or --dom, in any order. WX_PORT=dom env is
# equivalent to --dom so the flavor can flow through the docker pipeline.
CLEAN_BUILD=0
DOM_BUILD=0
[ "${WX_PORT:-}" = "dom" ] && DOM_BUILD=1
for arg in "$@"; do
case "$arg" in
--clean) CLEAN_BUILD=1 ;;
--dom) DOM_BUILD=1 ;;
--clean) CLEAN_BUILD=1 ;;
--no-clean) CLEAN_BUILD=0 ;;
--dom) DOM_BUILD=1 ;;
*) echo "Unknown argument: $arg"; exit 1 ;;
esac
done

15
scripts/kicad/build-kicad-target.sh
View file

@ -73,10 +73,19 @@ source "${SCRIPT_DIR}/../common/functions.sh"
source "${SCRIPT_DIR}/../common/stages.sh"
KICAD_DIR="${PROJECT_ROOT}/kicad"
KICAD_BUILD="${BUILD_ROOT}/kicad-${APP_NAME}"
KICAD_STAMP="${BUILD_ROOT}/stamps/kicad-${APP_NAME}.stamp"
WASM_LAYER="${PROJECT_ROOT}/wasm"
WX_BUILD="${BUILD_ROOT}/wxwidgets-universal"
# WX_PORT=dom links against the DOM (non-universal) wxWidgets build and
# keeps its KiCad build tree separate from the canvas one.
if [ "${WX_PORT:-}" = "dom" ]; then
KICAD_BUILD="${BUILD_ROOT}/kicad-${APP_NAME}-dom"
KICAD_STAMP="${BUILD_ROOT}/stamps/kicad-${APP_NAME}-dom.stamp"
WX_BUILD="${BUILD_ROOT}/wxwidgets-dom"
else
KICAD_BUILD="${BUILD_ROOT}/kicad-${APP_NAME}"
KICAD_STAMP="${BUILD_ROOT}/stamps/kicad-${APP_NAME}.stamp"
WX_BUILD="${BUILD_ROOT}/wxwidgets-universal"
fi
# Parse arguments - incremental build by default (optimized for development)
NO_CLEAN=1

6
tests/playwright-kicad.config.ts
View file

@ -74,6 +74,10 @@ const PCBNEW_FAMILY_SPECS = [
'**/load-pcb-probe.spec.ts',
];
// WX_PORT=dom runs against the DOM-port bundles (setup-kicad-wasm.sh syncs
// them into tests/apps-dom/kicad).
const appsDir = process.env.WX_PORT === 'dom' ? 'apps-dom' : 'apps';
export default defineConfig({
globalSetup: './global-setup.ts',
testDir: './kicad',
@ -158,7 +162,7 @@ export default defineConfig({
],
webServer: {
command: `npx serve apps -p ${port} -c ../serve.json`,
command: `npx serve ${appsDir} -p ${port} -c ../serve.json`,
port: port,
reuseExistingServer: !process.env.CI,
},

46
tests/scripts/setup-kicad-wasm.sh
View file

@ -10,8 +10,18 @@ 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"
# WX_PORT=dom serves the DOM-flavor bundles (built by docker/build.sh with
# WX_PORT=dom into output-dom/) from tests/apps-dom/kicad.
if [ "${WX_PORT:-}" = "dom" ]; then
KICAD_TEST="$PROJECT_ROOT/tests/apps-dom/kicad"
OUTPUT_DIR="$PROJECT_ROOT/output-dom"
KICAD_BUILD_SUFFIX="-dom"
else
KICAD_TEST="$PROJECT_ROOT/tests/apps/kicad"
OUTPUT_DIR="$PROJECT_ROOT/output"
KICAD_BUILD_SUFFIX=""
fi
mkdir -p "$KICAD_TEST"
@ -62,15 +72,15 @@ copy_app() {
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 \
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}${KICAD_BUILD_SUFFIX}/${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
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}${KICAD_BUILD_SUFFIX}/${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
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}${KICAD_BUILD_SUFFIX}/${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
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}${KICAD_BUILD_SUFFIX}/${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
kicad-wasm-builder:/workspace/build-wasm/kicad-${app}${KICAD_BUILD_SUFFIX}/resources/images.tar.gz "$KICAD_TEST/" 2>/dev/null || true
return 0
fi
@ -104,5 +114,27 @@ else
fi
fi
if [ "${WX_PORT:-}" = "dom" ]; then
# DOM port: the control-layer shim loads after wx.js.
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
# The checked-in kicad pages load wx.js via a <script> tag; the DOM
# flavor needs wx-dom.js right after it. Sync the pages and inject the
# tag (idempotent).
for page in "$PROJECT_ROOT"/tests/apps/kicad/*.html; do
[ -f "$page" ] || continue
dest="$KICAD_TEST/$(basename "$page")"
cp "$page" "$dest"
if ! grep -q 'wx-dom.js' "$dest"; then
perl -i -pe 's{(<script src="wx.js"></script>)}{$1\n <script src="wx-dom.js"></script>}' "$dest"
fi
done
echo " + kicad pages with wx-dom.js injected"
fi
echo "KiCad WASM files synced to $KICAD_TEST"
ls -lh "$KICAD_TEST"