678058c940
CI / Select checks (push) Has been cancelled
CI / Format and repository checks (push) Has been cancelled
CI / Compile RISC-V (manual) (push) Has been cancelled
Docker / image (push) Has been cancelled
Generated files / Regenerate and commit (push) Has been cancelled
Kernel rig / Select the rig areas (push) Has been cancelled
Lists / Design format changes merge cleanly (push) Has been cancelled
Lists / Lists are sorted one item per line (push) Has been cancelled
Packaging lint / lint (push) Has been cancelled
Pages / build (push) Has been cancelled
CI / Dependency advisories (push) Has been cancelled
CI / Quick compile (push) Has been cancelled
CI / Native Linux Clippy (push) Has been cancelled
CI / Build tests (push) Has been cancelled
CI / Native Linux tests (push) Has been cancelled
CI / GPU path tests (1/4) (push) Has been cancelled
CI / GPU path tests (2/4) (push) Has been cancelled
CI / GPU path tests (3/4) (push) Has been cancelled
CI / GPU path tests (4/4) (push) Has been cancelled
CI / Action matrix (1/16) (push) Has been cancelled
CI / Action matrix (10/16) (push) Has been cancelled
CI / Action matrix (11/16) (push) Has been cancelled
CI / Action matrix (12/16) (push) Has been cancelled
CI / Action matrix (13/16) (push) Has been cancelled
CI / Action matrix (14/16) (push) Has been cancelled
CI / Action matrix (15/16) (push) Has been cancelled
CI / Action matrix (16/16) (push) Has been cancelled
CI / Action matrix (2/16) (push) Has been cancelled
CI / Action matrix (3/16) (push) Has been cancelled
CI / Action matrix (4/16) (push) Has been cancelled
CI / Action matrix (5/16) (push) Has been cancelled
CI / Action matrix (6/16) (push) Has been cancelled
CI / Action matrix (7/16) (push) Has been cancelled
CI / Action matrix (8/16) (push) Has been cancelled
CI / Action matrix (9/16) (push) Has been cancelled
CI / Action matrix determinism (push) Has been cancelled
CI / Property tests (many cases) (push) Has been cancelled
CI / Doc tests (push) Has been cancelled
CI / Reference tests (push) Has been cancelled
CI / Windows D3D12 FXC shaders (push) Has been cancelled
CI / Windows app startup (push) Has been cancelled
CI / ci (push) Has been cancelled
CI / Compile WebAssembly (push) Has been cancelled
CI / Nightly alert (push) Has been cancelled
Kernel rig / Build the CLI (push) Has been cancelled
Kernel rig / Kernel rig (${{ matrix.shard }}) (push) Has been cancelled
Kernel rig / kernel-rig (push) Has been cancelled
Pages / deploy (push) Has been cancelled
3.0 KiB
3.0 KiB
name, description
| name | description |
|---|---|
| makecad-performance | Use when a makeCAD change is slow, blocks the window, runs long work, or must build for the browser. Covers keeping the window thread free, measuring a speed-up, the wasm build and what may be JavaScript or Python. |
Performance, threads and wasm
Do not block the window
- Work that can take long (a feature computation, a save, a file load, reading a picture) runs beside the window and is applied when done. Existing examples:
crates/ui-egui/src/save_job.rs,crates/ui-egui/src/file_load.rs, and the agent path indocs/control-protocol.md("Slow commands and the window"). - With the preference "Keep the window responsive while agents run commands" (
agent_off_thread) on, a design change that takes longer than about 150 ms is evaluated ahead on a copy of the design, then run for real reusing that result. A person's edit made meanwhile goes first; Stop drops the computation and nothing is applied. Keep that contract when you add a long-running command. file.exportandfile.save_meshchange nothing in the design: they run on a copy and nothing waits behind them.- Test it:
crates/ui-egui/src/apply_off_thread_tests.rsdrives a long feature through the harness; never depend on wall-clock timing in a test.
Measure before you claim a speed-up
- Profile first. Time with
solidcraft-clifrommainand from your branch, alternating runs, after the load is low. On a shared machine checkcut -d' ' -f1 /proc/loadavgand wait while it is over 24; build withnice. - Report medians with the range, the machine, and the cases. The pattern to follow is
docs/perf.md: what was slow, why, the result, and proof that nothing changed (same bodies, volumes, areas and triangle counts). - A speed-up never skips work on a mesh's box: decide with the exact bounds (
Body::exact_bounds, grown by the record's tolerance asapartincrates/kernel/src/ops.rsdoes). A mesh is for display, export, previews and mesh bodies. - Do not rewrite kernel code for speed: the kernel is being replaced, and kernel work is paused. Report a slow case with its file under the
kernel-perflabel (CONTRIBUTING.md, "Where help is wanted most"). - Pull requests run only the tests for what they touch; geometry-heavy tests run in the merge queue. Use
cargo xtask testwith theciprofile locally (skills/makecad-tests/SKILL.md).
The browser build
- Everything below the apps must build for
wasm32-unknown-unknown:cargo xtask wasmchecks every library crate and the web app, and is part ofcargo xtask ci. Do not add a dependency that cannot. - Application code is Rust only. The browser requires two pieces of JavaScript: the service worker
apps/solidcraft-web/sw.jsand the small inline scripts inapps/solidcraft-web/index.html. Keep them minimal;cargo xtask web-offline-testcovers the service worker. - Python 3.11+ is allowed only for asset authoring, lint and review tools (
assets/AGENTS.md), never as an application dependency. - Design notes for the browser runtime:
docs/web-runtime.md,docs/browser-api.md.