mirror of
https://github.com/lightpanda-io/browser.git
synced 2026-09-14 23:15:14 -04:00
Adrià Arrufat
585cfb06dd
Debug and release builds each compiled their own copy of every C dependency and of the Rust staticlib, because build.zig threaded the top-level optimize mode into all of them. Under dev_fast the deps also picked up the bundled-CRT target query, so even the same mode could not share objects with a plain build. Dependencies now build in ReleaseFast for the requested target, the way the prebuilt V8 archive already works. Debug and release builds share one set of cached dependency objects, and debug binaries run TLS, HTML parsing, regex and sqlite optimized. -Ddebug_deps restores the old behaviour for stepping into a dependency. The Rust staticlib can only be shared by dropping the Debug-only memstats feature: its single export, html5ever_get_memory_usage, was declared on the Zig side but never called, and it pulled a jemalloc build into every cold debug build. The Makefile override that existed for jemalloc's nested make goes with it.
36 lines
1.5 KiB
Markdown
36 lines
1.5 KiB
Markdown
# AGENTS.md
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to open a pull request (CLA, dev setup, pre-PR checks).
|
|
|
|
## Build and tests
|
|
|
|
Run `make download-v8` once first: it fetches the prebuilt V8 archive into `.lp-cache/`, which `build.zig` picks up automatically. Without it every build compiles V8 from source (10+ minutes).
|
|
|
|
The C and Rust dependencies are built in ReleaseFast whatever `-Doptimize` is, so debug and release builds share them. Pass `ZIGFLAGS=-Ddebug_deps` to step into a dependency with a debugger.
|
|
|
|
```bash
|
|
make test # Run all tests
|
|
make test F="server" # Filter by substring
|
|
TEST_FILTER="WebApi: #selector_all" make test # Filter main + subtest (separator: #)
|
|
TEST_VERBOSE=true make test
|
|
TEST_FAIL_FIRST=true make test
|
|
METRICS=true make test # Capture allocation/duration metrics as JSON
|
|
```
|
|
|
|
The custom test runner (`src/test_runner.zig`) detects memory leaks in debug builds. **A test that allocates without freeing fails** — not just lints.
|
|
|
|
## Formatting
|
|
|
|
```bash
|
|
zig fmt --check ./*.zig ./**/*.zig # Exact command CI runs
|
|
```
|
|
|
|
`zig build` depends on the fmt step, so a local build catches drift too.
|
|
|
|
## Conventions
|
|
|
|
Mirror the patterns in neighboring files. In particular:
|
|
|
|
- `@import` alias case follows the imported file's basename (`const Frame = @import("Frame.zig")`, `const ast = @import("ast.zig")`).
|
|
- Prefer struct-init type inference (`.{ ... }`) where the expected type is known from the function signature or variable annotation.
|