Brummel
66dff88528
Iteration 2 of cycle 0026 (graph render redesign). `aura graph` no longer emits ASCII: it now prints one self-contained `.html` to stdout — the ported prototype pin-graph viewer (drill / inline-expand / styled tooltips / breadcrumb) driven by the deterministic model serializer that shipped in iteration 1, with layout and SVG done in-browser by Graphviz compiled to WebAssembly. Closes the redesign opened by spec 0026; unblocked by cycle 0027 (input ports are now named, so the viewer labels every input pin from the model's real names instead of inventing "a"/"b"). What ships: - crates/aura-cli/assets/: the ported graph-viewer.js (prototype genDot/chrome verbatim + a normalizeModel adapter mapping aura's real model tuple shape — ins = [kind, firing, name], index node keys, `comp` refs, `src_<role>` — into the viewer's native shape), plus the vendored Graphviz-WASM (@viz-js/viz@3.7.0) and svg-pan-zoom@3.6.1 blobs and a refresh-assets.sh provenance script. - crates/aura-cli/src/render.rs: render_html(&Composite) -> String, a read-only (C9) assembly — model_to_json + include_str! of the inlined assets, no eval, no build, no serde (C14). The `["graph"]` arm calls it. - Retired: the ascii-dag adapter (graph.rs), the `ascii-dag` dependency, the `--compiled`/`--macd` graph flag plumbing, render_compiled, the color/terminal plumbing, and the 12 ascii-dag-asserting tests + the now-orphaned helpers. The cli_run integration test now pins the HTML page envelope. - crates/aura-core/src/node.rs: the two last ascii-dag prose justifications re-grounded (single-line label rule kept, re-justified generically; the param-generic rule re-justified on C23, not on a renderer limitation). - docs/design/INDEX.md: the cycle-0026 C9 realization note (both iterations). Vendoring decision (spec deferred it to the plan): the WASM/JS blobs are checked in, not fetched at build time. include_str! needs them at compile time, and a build-time unpkg fetch would make the build non-hermetic/non-offline and let the shipped artifact drift with the registry — against C1 (determinism) and C8 (frozen artifacts). ~1.4 MB is the price of a hermetic, frozen render asset. Three adaptations beyond the plan, each verified: (1) render.rs imports `aura_engine::Composite` (the path model_to_json takes), not aura_core; (2) macd_blueprint is now test-only — removing the `--macd` arm left it used solely by the param-space test, so it took `#[cfg(test)]` rather than removal or an `#[allow]` suppression (the production `aura run --macd` path is intact, verified emitting JSON); (3) the `grep ascii-dag` over crates/ matches only the new contract test, which names the term deliberately to document the retirement — no stale justification prose remains. Invariants held (verified independently, not on agent report): C9 (render path read-only), C10 (viewer is a render asset, no logic/DSL), C4 (four-colour palette = the four scalar base types), C14 (no serde). The iteration-1 model byte golden is unchanged and green. cargo build --workspace: 0 errors. cargo test --workspace: 157 passed, 0 failed (incl. the two new HTML tests + the unchanged model_golden). cargo clippy --workspace --all-targets -- -D warnings: clean. ascii-dag absent from `cargo tree -p aura-cli`. closes #51
113 lines
5.1 KiB
Rust
113 lines
5.1 KiB
Rust
//! Self-contained HTML graph viewer assembly (C9: read-only render path).
|
|
//!
|
|
//! `render_html` walks the blueprint into the deterministic JSON model
|
|
//! (`aura_engine::model_to_json`) and inlines it, the vendored Graphviz-WASM, the
|
|
//! pan-zoom helper, and the ported viewer JS into one standalone `.html`. The
|
|
//! emitted page fetches nothing at view time. No `eval`/build is on this path
|
|
//! (C9); the model is hand-rolled JSON (C14, owned by `model_to_json`).
|
|
|
|
use aura_engine::Composite;
|
|
|
|
/// The prototype's `<head>` shell + body skeleton (header, stage, tooltip, error
|
|
/// pane), verbatim from `docs/design/prototypes/graph-render/index.html` lines
|
|
/// 1-38 — minus the two `<script src="./…">` tags, since `render_html` inlines
|
|
/// the assets instead.
|
|
const SHELL_HEAD: &str = r#"<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>aura graph</title>
|
|
<style>
|
|
html, body { margin: 0; height: 100%; background: #16161a; color: #cdd6f4;
|
|
font-family: ui-monospace, monospace; }
|
|
header { padding: 8px 14px; border-bottom: 1px solid #313244; font-size: 13px;
|
|
display: flex; gap: 16px; align-items: baseline; flex-wrap: nowrap;
|
|
white-space: nowrap; overflow: hidden; }
|
|
header b { color: #f5e0dc; } .sub { color: #6c7086; }
|
|
#crumb a { color: #89b4fa; cursor: pointer; text-decoration: none; }
|
|
#crumb a:hover { text-decoration: underline; }
|
|
#crumb .sep { color: #6c7086; }
|
|
#status { color: #6c7086; margin-left: auto; }
|
|
#stage { width: 100%; height: calc(100% - 44px); }
|
|
#stage svg { width: 100%; height: 100%; cursor: default; }
|
|
#stage svg text { cursor: inherit; user-select: none; -webkit-user-select: none; }
|
|
#stage svg a { cursor: inherit; }
|
|
#err { padding: 14px; color: #f38ba8; white-space: pre-wrap; }
|
|
#tip { position: fixed; display: none; pointer-events: none; z-index: 10;
|
|
background: #1e1e2e; border: 1px solid #585b70; border-radius: 6px; padding: 6px 9px;
|
|
font-family: ui-monospace, monospace; font-size: 12px; color: #cdd6f4;
|
|
max-width: 420px; box-shadow: 0 6px 18px rgba(0,0,0,.55); line-height: 1.5; }
|
|
#tip b { color: #f5e0dc; } #tip code { color: #89b4fa; } #tip .dim { color: #7f849c; }
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<b>aura graph</b>
|
|
<span id="crumb"></span>
|
|
<span class="sub">hover · [+] expand · body drill</span>
|
|
</header>
|
|
<div id="stage"></div>
|
|
<div id="tip"></div>
|
|
<pre id="err"></pre>
|
|
"#;
|
|
|
|
const VIZ_JS: &str = include_str!("../assets/viz-standalone.js");
|
|
const PANZOOM_JS: &str = include_str!("../assets/svg-pan-zoom.min.js");
|
|
const VIEWER_JS: &str = include_str!("../assets/graph-viewer.js");
|
|
|
|
/// Assemble the self-contained interactive graph viewer page for `root`.
|
|
///
|
|
/// Order is load-bearing: the Graphviz-WASM and pan-zoom globals (`Viz`,
|
|
/// `svgPanZoom`) and the model (`window.AURA_MODEL`) must be defined before the
|
|
/// viewer script runs.
|
|
pub fn render_html(root: &Composite) -> String {
|
|
let model = aura_engine::model_to_json(root);
|
|
let mut html = String::with_capacity(
|
|
SHELL_HEAD.len() + VIZ_JS.len() + PANZOOM_JS.len() + VIEWER_JS.len() + model.len() + 256,
|
|
);
|
|
html.push_str(SHELL_HEAD);
|
|
html.push_str("<script>");
|
|
html.push_str(VIZ_JS);
|
|
html.push_str("</script>\n<script>");
|
|
html.push_str(PANZOOM_JS);
|
|
html.push_str("</script>\n<script>window.AURA_MODEL = ");
|
|
html.push_str(&model);
|
|
html.push_str(";</script>\n<script>");
|
|
html.push_str(VIEWER_JS);
|
|
html.push_str("</script>\n</body>\n</html>\n");
|
|
html
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::sample_blueprint;
|
|
|
|
/// `aura graph`'s page is self-contained (no remote fetch), embeds the
|
|
/// deterministic model as the viewer's data source, carries the Graphviz-WASM
|
|
/// bootstrap, and keeps the C4 four-colour palette. Structural, not pixel:
|
|
/// the DOT/SVG are Graphviz-version-dependent and are exercised by hand
|
|
/// against the prototype (spec Testing strategy).
|
|
#[test]
|
|
fn render_html_is_self_contained_and_embeds_the_model() {
|
|
let html = render_html(&sample_blueprint());
|
|
// a complete HTML document
|
|
assert!(html.starts_with("<!doctype html>"), "not an HTML doc");
|
|
assert!(html.trim_end().ends_with("</html>"), "HTML doc not closed");
|
|
// self-contained: every asset is inlined, no remote <script src>
|
|
assert!(!html.contains("<script src"), "assets must be inlined, found a remote script tag");
|
|
// the deterministic model is injected as the viewer's data source
|
|
assert!(html.contains("window.AURA_MODEL = {\"root\":"), "model JSON not injected");
|
|
// a known node from the sample harness round-trips via the model
|
|
assert!(html.contains("\"type\":\"Exposure\""), "sample model content missing");
|
|
// the vendored Graphviz-WASM is present (its bootstrap global)
|
|
assert!(html.contains("Viz.instance"), "viewer bootstrap (Viz.instance) missing");
|
|
// C4: the four-scalar palette, no fifth colour
|
|
assert!(
|
|
html.contains("i64: \"#f9e2af\"") && html.contains("timestamp: \"#cba6f7\""),
|
|
"C4 four-colour palette missing"
|
|
);
|
|
}
|
|
}
|