plan: preflight insomnia cli ownership
This commit is contained in:
parent
4c7088d757
commit
2deb93c7ce
|
|
@ -7,7 +7,7 @@ kind: task
|
|||
priority: P2
|
||||
labels: [cli, tui, pod, architecture]
|
||||
created_at: 2026-05-31T11:19:56Z
|
||||
updated_at: 2026-05-31T11:19:56Z
|
||||
updated_at: 2026-05-31T12:42:22Z
|
||||
assignee: null
|
||||
legacy_ticket: null
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,4 +4,99 @@
|
|||
|
||||
Created by tickets.sh create.
|
||||
|
||||
---
|
||||
|
||||
<!-- event: plan author: hare at: 2026-05-31T12:42:22Z -->
|
||||
|
||||
## Plan
|
||||
|
||||
Read-only investigator: `insomnia-cli-owner-investigator-20260531`
|
||||
Classification: implementation-ready
|
||||
|
||||
Conclusion:
|
||||
- Proceed with this ticket as one implementation ticket, but implement in ordered internal phases: move `PodRuntimeCommand` to `client`, make `tui` library-callable, move product CLI/binary ownership to `insomnia`, then update packaging/docs.
|
||||
|
||||
Current code/dependency map:
|
||||
- `crates/tui` currently owns the product binary target:
|
||||
- `crates/tui/Cargo.toml` has `[[bin]] name = "insomnia" path = "src/main.rs"`.
|
||||
- `crates/tui/src/main.rs` owns top-level CLI parsing, `insomnia pod ...` dispatch, `insomnia memory lint`, and TUI launch.
|
||||
- `crates/insomnia` currently has no binary and mostly owns `PodRuntimeCommand` only.
|
||||
- `crates/pod` is already library-only and exposes `pod::entrypoint::run_cli_from`.
|
||||
- `client`, `pod`, and tests depend on `insomnia` only for `PodRuntimeCommand`, creating the wrong dependency direction for the desired architecture.
|
||||
- `package.nix` builds `-p tui` even though the installed command is `insomnia`.
|
||||
|
||||
Recommended architecture:
|
||||
```text
|
||||
insomnia -> tui
|
||||
insomnia -> pod
|
||||
insomnia -> client
|
||||
tui -> client
|
||||
pod -> client
|
||||
client -> no insomnia
|
||||
pod -> no insomnia
|
||||
tui -> no insomnia
|
||||
```
|
||||
|
||||
Implementation plan:
|
||||
1. Move `PodRuntimeCommand` from `insomnia` to `client`.
|
||||
- Prefer `client::runtime_command` with `pub use` from `client`.
|
||||
- Update `client`, `pod`, and tests to use `client::PodRuntimeCommand`.
|
||||
- Remove `insomnia` dependency from lower crates.
|
||||
2. Make `tui` a library implementation crate.
|
||||
- Add `crates/tui/src/lib.rs`.
|
||||
- Move TUI module declarations and TUI launch code behind public library API.
|
||||
- Expose narrow API such as `LaunchOptions`, `LaunchMode`, `launch(...)`.
|
||||
- Keep terminal setup/teardown in `tui` because it owns terminal behavior.
|
||||
- Remove product CLI parsing and `pod`/`memory lint` dispatch from `tui`.
|
||||
3. Make `insomnia` own product CLI/binary.
|
||||
- Add `crates/insomnia/src/main.rs`.
|
||||
- Move top-level CLI parser/dispatch from `tui` to `insomnia`.
|
||||
- Route `pod` to `pod::entrypoint::run_cli_from("insomnia pod", args)`.
|
||||
- Route `memory lint` from `insomnia`, not `tui`.
|
||||
- Route normal TUI modes to `tui::launch(...)` with a typed runtime command.
|
||||
4. Update packaging/docs.
|
||||
- Remove `[[bin]] name = "insomnia"` from `tui`.
|
||||
- Make `package.nix` build `-p insomnia`.
|
||||
- Update active docs/dev commands from `cargo run -p tui -- ...` to `cargo run -p insomnia -- ...`.
|
||||
|
||||
Important constraints:
|
||||
- Do not introduce `pod -> insomnia` or `tui -> insomnia`.
|
||||
- Do not keep compatibility for `cargo run -p tui -- ...`.
|
||||
- Do not reintroduce `insomnia-pod`, `INSOMNIA_POD_COMMAND`, or the separate `INSOMNIA_POD_RUNTIME_COMMAND`; that dev override is tracked by `dev-pod-runtime-command-env`.
|
||||
- Do not change Pod protocol/profile/manifest semantics.
|
||||
- Avoid broad TUI refactoring beyond making the crate library-callable.
|
||||
|
||||
Critical risks:
|
||||
- `tui/src/main.rs` is large and mixes CLI, terminal lifecycle, event loop, key handling, and tests. Keep changes mechanical and avoid unrelated module cleanup.
|
||||
- Parser tests should move to `insomnia`; TUI behavior tests should remain with `tui`.
|
||||
- `memory_lint` is headless product CLI code and should not remain routed through TUI.
|
||||
- `--help` behavior needs explicit handling because the old parser mostly ignored unknown flags.
|
||||
|
||||
Validation:
|
||||
- `cargo fmt --check`
|
||||
- `cargo check -p client -p pod -p tui -p insomnia`
|
||||
- `cargo test -p client`
|
||||
- `cargo test -p pod`
|
||||
- `cargo test -p tui`
|
||||
- `cargo test -p insomnia`
|
||||
- CLI smoke:
|
||||
- `cargo run -p insomnia -- --help`
|
||||
- `cargo run -p insomnia -- pod --help`
|
||||
- `cargo run -p insomnia -- memory lint --help`
|
||||
- `cargo run -p insomnia -- --session not-a-uuid`
|
||||
- Dependency ownership checks:
|
||||
- `cargo tree -p client -e no-dev --depth 1`
|
||||
- `cargo tree -p pod -e no-dev --depth 1`
|
||||
- `cargo tree -p tui -e no-dev --depth 1`
|
||||
- `cargo tree -p insomnia -e no-dev --depth 1`
|
||||
- If packaging changed:
|
||||
- `nix build .#insomnia`
|
||||
- `./result/bin/insomnia pod --help`
|
||||
- `test -x ./result/bin/insomnia`
|
||||
- `test ! -e ./result/bin/insomnia-pod`
|
||||
- `./tickets.sh doctor`
|
||||
- `git diff --check`
|
||||
- `rg "cargo run -p tui" docs README.md crates package.nix flake.nix`
|
||||
|
||||
|
||||
---
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user