With servo-embed, weft-servo-shell and weft-app-shell did not compile against the selected Servo revision: the keyboard event shape, key and mouse action variants, frame readback, shutdown, URL type and window handle APIs had changed. The frame path never called WebView::paint; the software path rebuilt its softbuffer surface every frame and read pixels without painting, and the EGL path presented nothing. weft-app-shell printed READY right after creating its WebView, before any frame, and its feature-disabled build printed READY and parked. Servo also disables CSS Grid by default, which the system UI uses. Both hosts now build against the selected API. Each frame is painted with WebView::paint and presented: the software path reads the painted frame back, presents the context and copies it into a persistent softbuffer surface; the EGL path presents its window context. Nothing is presented before Servo's first repaint request. Shutdown drops the WebView and Servo, whose drop completes the shutdown, and exits the event loop. Both hosts enable layout_grid_enabled. weft-app-shell prints READY on the first frame presented after the document has loaded and Servo reports its rendering settled: on load completion it requests WebView::take_screenshot, which completes only once every frame has fired load, render-blocking resources, images and web fonts are done and the rendering is up to date. Feature-disabled builds of both hosts exit with an error instead of reporting readiness. weft-appd does not consume the app shell's READY yet. tests/frame/check_frame.py runs weft-compositor nested on Xvfb with the winit backend, starts a host showing tests/frame/reference.html and checks the presented pixels (four colour quadrants and text). For the app host the page must be on screen within two seconds of READY; --slow-style delays a render-blocking stylesheet that reveals the page, so premature readiness fails. Validation (Ubuntu 24.04, Mesa 25.2.8 llvmpipe, software path): - check_frame.py --host system, --host app and --host app --slow-style 3: 5 of 5 runs pass each - negative fixtures fail: page with red and green swapped; a fake host printing READY without rendering; a local build printing READY on its first presented frame (--slow-style 4, 3 of 3) - cargo clippy -D warnings with and without servo-embed; cargo fmt --check - unverified: EGL path, DRM, resize, output scale, idle wakeup, input
3.9 KiB
Building WEFT OS
Prerequisites
Linux (x86_64 or aarch64). Building on Windows is supported for workspace validation only; runtime components require Linux kernel interfaces.
System packages (openSUSE):
sudo zypper install -y \
libwayland-devel libxkbcommon-devel \
libglvnd-devel libgbm-devel libdrm-devel \
libinput-devel seatd-devel libudev-devel systemd-devel \
pkg-config clang cmake python3
Rust toolchain: pinned in rust-toolchain.toml. Run rustup show to confirm the active toolchain matches.
Workspace crates (non-Servo)
cargo build --workspace \
--exclude weft-servo-shell \
--exclude weft-app-shell
These crates do not require Servo and build in under two minutes.
weft-compositor, weft-servo-shell, weft-app-shell (Linux)
cargo build -p weft-compositor
cargo build -p weft-servo-shell
cargo build -p weft-app-shell
Without --features servo-embed, the servo-shell and app-shell binaries compile for type and lint checks but exit with an error at startup; they never report readiness. This is the default and the CI baseline.
Servo embedding (optional, slow)
cargo build -p weft-servo-shell --features servo-embed
cargo build -p weft-app-shell --features servo-embed
This fetches and compiles the Servo and Stylo forks at the revisions recorded in Cargo.lock (see crates/weft-servo-shell/SERVO_PIN.md). Expect 30–60 minutes on a clean build. Servo's dependencies include SpiderMonkey (C++), which requires clang and python3.
Frame check
tests/frame/check_frame.py runs weft-compositor nested on Xvfb with the
winit backend, starts a Servo host showing tests/frame/reference.html, and
checks the presented pixels. It needs Xvfb, xwd, ImageMagick's convert
and a Mesa OpenGL driver (llvmpipe is sufficient).
cargo build -p weft-compositor
cargo build -p weft-servo-shell -p weft-app-shell \
--features weft-servo-shell/servo-embed,weft-app-shell/servo-embed
python3 tests/frame/check_frame.py --host system
python3 tests/frame/check_frame.py --host app
python3 tests/frame/check_frame.py --host app --slow-style 3
--host app also requires the page on screen within two seconds of
weft-app-shell printing READY; --slow-style delays a stylesheet that
reveals the page so premature readiness becomes visible.
Logs and the last capture are written to target/frame-check.
Demo apps (wasm32-wasip2)
Each demo is a standalone crate in examples/. Pre-built app.wasm binaries are committed. To rebuild:
rustup target add wasm32-wasip2
cd examples/org.weft.demo.counter
cargo build --release
# output: target/wasm32-wasip2/release/app.wasm
weft-runtime with Wasmtime
cargo build -p weft-runtime --features wasmtime-runtime,net-fetch
Without --features wasmtime-runtime, the runtime prints READY and exits (stub mode, used in CI on platforms without Linux system dependencies).
Signing packages
weft-pack generate-key ./keys
weft-pack sign ./examples/org.weft.demo.counter --key ./keys/weft-sign.key
weft-pack verify ./examples/org.weft.demo.counter --key ./keys/weft-sign.pub
NixOS VM (requires Nix with flakes)
Build the VM image:
bash infra/vm/build.sh
Run with QEMU:
bash infra/vm/run.sh
See infra/nixos/weft-packages.nix for the package derivations. Its outputHashes hold one hash per git source in Cargo.lock (the Servo and Stylo forks); every package vendors them, so they must match the pinned revisions for any Nix package to build. The Nix shell packages do not yet enable servo-embed.
CI
Three jobs run on every push to main and on pull requests:
cross-platform— fmt, clippy, tests on Ubuntu and Windows (excludes Wayland crates)linux-only— clippy and tests forweft-compositor,weft-servo-shell,weft-app-shellservo-embed-linux—cargo check --features servo-embedfor servo-shell and app-shell