87b98193d8
Sweep of docs/ and every README against the code, after several features landed since the last one. Mechanical checks, which find what reading does not: SUMMARY covers every page and no more; every relative link resolves (docs/src/providers.md pointed a directory above the book, twice); every #anchor matches a real heading; every provider crate's Settings field is documented in both its README and its book page; the feature table matches Cargo.toml, which it did not -- `rss` was missing and "seven provider features" is now eight. Prose that predated recent work: the root README's client-config sample knew only `spectrum` and still claimed every option has a flag; its spectrum and web-client sections predated the colors, segments, shadows, pane tabs, register and seek; cbd-web/README.md likewise; intro.md's provider tree was missing /rss; clients.md omitted volume and mute from what the update stream carries; rssdy/README.md did not mention that only audio enclosures become episodes. The audit also found a defect the docs were right about: `Seek` was never added to `minimum_role`, so it fell through to the owner-only default while auth.md and architecture/roles-auth.md both promise a queue-owner may control playback. With auth configured a queue-owner could play, skip and change the volume, but got PermissionDenied on `,`/`.`. Seek now sits with the other playback verbs. The test meant to prevent that -- "a new RPC must be added to exactly one list" -- compared the role lists against a hardcoded 24, so a 25th method kept the suite green. It now reads the method names out of crabidy.proto and compares sets: a count copied out of a file is not a check against it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| Cargo.toml | ||
| README.md | ||
| Trunk.toml | ||
| index.html | ||
| style.css | ||
README.md
cbd-web — the browser client
A Leptos client-side WASM app with the same
functionality as cbd-tui, served by crabidy-server itself.
How it works
- Transport: gRPC-web (
tonic-web-wasm-client) over the same generated client and proto types the TUI uses (crabidy-core). No second API surface — feature parity is structural. The server wraps its existing gRPC service intonic-web, so the browser and the TUI hit identical/crabidy.v1.CrabidyService/…paths, and the same role auth layer gates both. - Serving: the built bundle (
cbd-web/dist) is embedded intocrabidy-serverat compile time behind the default-onweb-uifeature and served as the fallback route on port 50051. gRPC and static assets share one origin, so there is no CORS story. - Local-first: pure client-side rendering, every asset in the
bundle (no CDN, no external fonts), library listings cached in memory
like the TUI, credentials and theme in
localStorage, and the update stream reconnects with backoff when the server disappears. There is no CRDT layer — this is a remote control for one live server state, not an offline-editing app (a deliberate departure from theweb_client_example_workspacetemplate that informed the toolchain).
Functionality
Everything the TUI does: browse the library (j/k/h/l, click), marks
and visual mode (s, v/V) in both panes, the one-slot register (y
yanks, d/c/C fill it as they remove, p/P paste), create/rename/
delete nodes (%/e/d), bookmark and capture (w/W, with live progress
lines and skipped-track marking), the full queue and playback controls,
seeking (,/. for 15 seconds, </> for a whole track, or a click on the
progress bar), volume, shuffle/repeat, and a ? help overlay listing the
keys. Keys mirror the TUI; every key also has a clickable control. The /
live filter is the one thing that is TUI-only so far.
Two layout details earn their own note:
library/queuetabs in the top bar switch panes and show which one the keys go to — whatTabdoes, reachable by thumb.- Below 700px the panes cannot sit side by side, so only the focused pane is rendered. It is not collapsed to a strip: a strip's truncated rows still take taps, which sent them to the wrong pane.
A light/dark theme follows the OS and can be toggled (persisted). The accent color is the crab orange-red.
When the server requires credentials, a login form collects the role
(owner / queue-owner / queue-appender) and password; they are
stored in localStorage and sent as the gRPC-web authorization
header on every request.
Building
The WASM toolchain (trunk, wasm-bindgen, the wasm32-unknown-unknown
target) is provided by devenv. From the repo root:
devenv shell -- build-web # release bundle → cbd-web/dist
cargo build -p crabidy-server # embeds cbd-web/dist
build-web clears RUSTFLAGS first: the native toolchain sets the
mold linker, which rust-lld (the wasm linker) cannot parse.
Building crabidy-server without a cbd-web/dist present is fine — it
embeds a placeholder page telling you to run build-web. To drop the web
client (and the tonic-web layer) entirely, build the server without its
web-ui cargo feature — e.g. --no-default-features --features all-providers,opus,spectrum; see docs/src/build-features.md.
Dev loop
Run a server, then a live-reloading trunk server that proxies gRPC-web to it:
cargo run -p crabidy-server # or `cbd`
devenv shell -- serve-web # trunk serve on http://127.0.0.1:8080
Trunk.toml proxies /crabidy.v1.CrabidyService to 127.0.0.1:50051,
so the app behaves as if served from the server.
Tests
The DOM-free logic (pane/selection state machines, the keymap, capture
progress formatting) lives in src/state.rs and src/keymap.rs and is
unit-tested on the native target:
cargo test -p cbd-web
Components in src/app.rs stay thin over that logic. The server-side
serving and the gRPC-web + auth routing are tested in crabidy-server
(src/web.rs, tests/web_server.rs).