feat(console): add demo GIFs, VHS correctness tests, and fix KeyEventKind double-dispatch#105
Open
YuanYuYuan wants to merge 12 commits intomainfrom
Open
feat(console): add demo GIFs, VHS correctness tests, and fix KeyEventKind double-dispatch#105YuanYuYuan wants to merge 12 commits intomainfrom
YuanYuYuan wants to merge 12 commits intomainfrom
Conversation
YuanYuYuan
changed the title
|
YuanYuYuan
changed the title
YuanYuYuan
changed the title
Adds automated demo recording infrastructure using VHS (terminal GIF recorder). Records four demos showcasing ros-z-console features: startup/discovery, panel navigation, filter mode, and help overlay. The generate.nu script handles the full lifecycle: building binaries, starting a Zenoh router + z_pubsub for realistic data, running VHS tapes with warmup and retry logic, and cleanup. Key design decisions for reliability on this system: - Warmup loop (up to 10 attempts) absorbs chromium cold-start latency - Per-tape retry loop (up to 10 attempts, 3s gaps) mirrors warmup - After each successful tape: kill leaked ttyd + chromium processes and wait 5s, preventing RAM exhaustion from VHS process leaks - SIGKILL on ttyd/chromium ensures immediate port/resource release
…atch crossterm 0.29 + ttyd (used by VHS) reports both Press and Release events for keypresses. Without filtering, pressing ? would: 1. Press event (in show_help branch) → show_help = false 2. Release event (in normal branch) → show_help = true This prevented the help overlay from being dismissed with ?. Adding a key.kind != KeyEventKind::Release guard fixes this for all keys.
Tape fixes: - Add Env DIRENV_DISABLE "1" to all tapes to prevent direnv from re-evaluating flake.nix (which is modified) and blocking TUI startup - Increase Escape sleep in 04-filter.tape from 200ms to 600ms to avoid capturing blank frame during alt-screen re-render Test runner fixes: - Increase tape retry count from 5 to 10 for chromium warm-up latency - Add --force to save latest.json to allow overwriting on reruns - Replace navigation_changes_display (unreliable with 1 topic) with initial_is_tui size check (>100 KB confirms TUI loaded, not direnv) - Remove r_key_triggers check: status bar text change has negligible PNG size impact; keep rate_shown_after which reliably detects the rate value appearing in the topic list after measurement completes
…to img/ demos/ at the repo root was misplaced — it is a utility script collection, not a project artifact. Moving it under scripts/ aligns it with the other Nushell utilities (generate.nu alongside test-pure-rust.nu, etc.). book/src/demos/ renamed to book/src/img/ which is the conventional name for image assets in mdbook projects. - demos/ -> scripts/demos/ (generate.nu + tapes/) - book/src/demos/ -> book/src/img/ - Update all internal path references and .gitignore
Split the TUI demos out of the main console.md chapter into a dedicated console-demos.md subchapter. The main chapter now links to it rather than embedding GIFs inline. Expanded demo coverage with four new VHS tapes: - 05-topic-detail: publishers, subscribers, and QoS profiles for a topic - 06-services: services panel with AddTwoInts service - 07-nodes: nodes panel showing per-node topic/service associations - 08-measurement: quick rate check (r) and Measure panel time-series chart Updated generate.nu to start talker, listener, and z_srvcli server as separate background processes, providing richer graph data for all panels.
… panel
Two bugs in render/nodes.rs caused by get_node_names() returning the
denormalized root namespace "/":
1. Double-slash display: format!("{}/{}", namespace, name) with
namespace="/" produced "//Sub" instead of "/Sub". Fixed by
special-casing root namespace in display formatting.
2. Empty node detail: node_key was built from the denormalized namespace
"/", but the graph HashMap stores entries under the normalized key
"" (empty string). Lookups always failed, producing "(No topics or
services)". Fixed by normalizing "/" → "" before the HashMap lookup.
…emos Updated 01-04 GIFs reflect the corrected node panel behavior. New GIFs cover the remaining typical workflows: - 05-topic-detail: publishers, subscribers, type hash, QoS - 06-services: services panel with AddTwoInts service detail - 07-nodes: nodes panel showing /Pub→/chatter, /add_two_ints_server→/add_two_ints - 08-measurement: quick rate check (r) and Measure panel time-series chart
Both utilities are generic and useful beyond the console: - `ros_z::dynamic::formatter`: converts DynamicMessage → JSON / pretty text - `ros_z::dynamic::DynamicTopicSubscriber`: async channel bridge over ZSub Console now imports from ros_z::dynamic instead of local core modules.
YuanYuYuan
force-pushed
the
dev/ros-z-console
branch
from
32d1834 to
d7025c8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
scripts/demos/) with 8 annotated tapes covering all major workflows: startup, topics, topic detail, services, nodes, rate measurement, filter mode, and help overlayconsole-demos.md) to keep the main console chapter concisetests/run-vhs-tests.nu+ 6 tapes) that launches zenohd and ros-z examples for realistic data, then asserts expected TUI state via screenshot size analysisKeyEventKind::Releaseevents to prevent help overlay double-dispatch (crossterm 0.29 + ttyd sends both Press and Release; without the filter,?would dismiss then immediately re-open the overlay)//Sub→/Sub) and empty node detail ("No topics or services") caused by namespace normalisation mismatch between display code and graph HashMap keysros_z::dynamic::formatter(DynamicMessage → JSON / pretty text) andros_z::dynamic::DynamicTopicSubscriber(async flume channel bridge over ZSub)Changes
crates/ros-z-console/src/main.rs— filter release events in the TUI event loopcrates/ros-z-console/src/app/render/nodes.rs— fix namespace normalisation for display and HashMap lookupcrates/ros-z/src/dynamic/formatter.rs— moved from console; JSON and pretty-text formatters for DynamicMessagecrates/ros-z/src/dynamic/subscriber.rs— moved from console; async DynamicTopicSubscriber wrapping ZSub with a flume channelscripts/demos/— VHS tapes + Nushell runner for generating documentation GIFs (starts zenohd, talker, listener, z_srvcli)book/src/img/*.gif— committed demo GIFs for mdbook (01–08)book/src/chapters/console-demos.md— new subchapter with annotated walkthroughsbook/src/chapters/console.md— trimmed TUI section, links to demos subchaptertests/run-vhs-tests.nu+tests/tapes/— 6 correctness tests covering panel navigation, filter mode, help overlay, rate measurementflake.nix— addvhsandttydto dev shell.gitignore— add.venv-mcp/