The agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond.
docs: add ECC2 codebase analysis research report
Toast (gastown)925d830c53b1
diff --git a/research/ecc2-codebase-analysis.md b/research/ecc2-codebase-analysis.mdnew file mode 100644index 000000000..21a24a9e5--- /dev/null+++ b/research/ecc2-codebase-analysis.md@@ -0,0 +1,170 @@+# ECC2 Codebase Research Report++**Date:** 2026-03-26+**Subject:** `ecc-tui` v0.1.0 — Agentic IDE Control Plane+**Total Lines:** 4,417 across 15 `.rs` files++## 1. Architecture Overview++ECC2 is a Rust TUI application that orchestrates AI coding agent sessions. It uses:+- **ratatui 0.29** + **crossterm 0.28** for terminal UI+- **rusqlite 0.32** (bundled) for local state persistence+- **tokio 1** (full) for async runtime+- **clap 4** (derive) for CLI++### Module Breakdown++| Module | Lines | Purpose |+|--------|------:|---------|+| `session/` | 1,974 | Session lifecycle, persistence, runtime, output |+| `tui/` | 1,613 | Dashboard, app loop, custom widgets |+| `observability/` | 409 | Tool call risk scoring and logging |+| `config/` | 144 | Configuration (TOML file) |+| `main.rs` | 142 | CLI entry point |+| `worktree/` | 99 | Git worktree management |+| `comms/` | 36 | Inter-agent messaging (send only) |++### Key Architectural Patterns++- **DbWriter thread** in `session/runtime.rs` — dedicated OS thread for SQLite writes from async context via `mpsc::unbounded_channel` with oneshot acknowledgements. Clean solution to the "SQLite from async" problem.+- **Session state machine** with enforced transitions: `Pending → {Running, Failed, Stopped}`, `Running → {Idle, Completed, Failed, Stopped}`, etc.+- **Ring buffer** for session output — `OUTPUT_BUFFER_LIMIT = 1000` lines per session with automatic eviction.+- **Risk scoring** on tool calls — 4-axis analysis (base tool risk, file sensitivity, blast radius, irreversibility) producing composite 0.0–1.0 scores with suggested actions (Allow/Review/RequireConfirmation/Block).++## 2. Code Quality Metrics++| Metric | Value |+|--------|-------|+| Total lines | 4,417 |+| Test functions | 29 |+| `unwrap()` calls | 3 |+| `unsafe` blocks | 0 |+| TODO/FIXME comments | 0 |+| Max file size | 1,273 lines (`dashboard.rs`) |++**Assessment:** The codebase is clean. Only 3 `unwrap()` calls (2 in tests, 1 in config `default()`), zero `unsafe`, and all modules use proper `anyhow::Result` error propagation. The `dashboard.rs` file at 1,273 lines exceeds the 800-line target but is manageable.++## 3. Identified Gaps++### 3.1 Comms Module — Send Without Receive++`comms/mod.rs` (36 lines) has `send()` but no `receive()`, `poll()`, `inbox()`, or `subscribe()`. The `messages` table exists in SQLite, but nothing reads from it. The inter-agent messaging story is half-built.++**Impact:** Agents cannot coordinate. The `TaskHandoff`, `Query`, `Response`, and `Conflict` message types are defined but unusable.++### 3.2 New Session Dialog — Stub++`dashboard.rs:495` — `new_session()` logs `"New session dialog requested"` but does nothing. Users must use the CLI (`ecc start --task "..."`) to create sessions; the TUI dashboard cannot.++### 3.3 Single Agent Support++`session/manager.rs` — `agent_program()` only supports `"claude"`. The CLI accepts `--agent` but anything other than `"claude"` fails. No codex, opencode, or custom agent support.++### 3.4 Config — File-Only++`Config::load()` reads `~/.claude/ecc2.toml` only. No environment variable overrides. No CLI flags for config. No `ECC_DB_PATH`, `ECC_WORKTREE_ROOT`, etc.++### 3.5 Unused Dependency: `git2`++`git2 = "0.20"` is declared in `Cargo.toml` but the `worktree` module shells out to `git` CLI instead. The dependency adds ~30s to clean builds and increases binary size.++### 3.6 No Metrics Aggregation++`SessionMetrics` tracks tokens, cost, duration, tool_calls, files_changed per session. But there's no aggregate view: total cost across sessions, average duration, top tools by usage, etc. The Metrics pane in the dashboard shows per-session detail only.++### 3.7 Daemon — No Health Reporting++`session/daemon.rs` runs an infinite loop checking session timeouts. No health endpoint, no log rotation, no PID file, no signal handling for graceful shutdown. `Ctrl+C` during daemon mode kills the process uncleanly.++## 4. Test Coverage Analysis++29 test functions across 12 test modules:++| Module | Tests | Coverage Focus |+|--------|------:|----------------|+| `config/mod.rs` | 5 | Defaults, deserialization, legacy fallback |+| `session/mod.rs` | 6 | State machine transitions |+| `session/store.rs` | 10 | CRUD, migration, message ops |+| `session/output.rs` | 4 | Ring buffer, broadcast |+| `observability/mod.rs` | 4 | Risk scoring, tool assessment |++**Missing test coverage:**+- `dashboard.rs` — 0 tests (1,273 lines, the largest module)+- `manager.rs` — 0 tests (680 lines, session lifecycle)+- `runtime.rs` — 0 tests (process output capture)+- `daemon.rs` — 0 tests (background monitoring)+- `comms/mod.rs` — 0 tests++The untested modules are the ones doing I/O (spawning processes, writing to SQLite, reading from stdout). These need integration tests with mockable boundaries.++## 5. Security Observations++- **No secrets in code.** Config reads from TOML file, no hardcoded credentials.+- **Process spawning** uses `tokio::process::Command` with explicit `Stdio::piped()` — no shell injection vectors.+- **Risk scoring** is a strong feature — catches `rm -rf`, `git push --force origin main`, file access to `.env`/secrets.+- **No input sanitization on session task strings.** The task string is passed directly to `claude --print`. If the task contains shell metacharacters, it could be exploited depending on how `Command` handles argument quoting. Currently safe (arguments are not shell-interpreted), but worth auditing.++## 6. Dependency Health++| Crate | Version | Latest | Notes |+|-------|---------|--------|-------|+| ratatui | 0.29 | 0.29 | Current |+| crossterm | 0.28 | 0.28 | Current |+| tokio | 1 | 1.x | Current |+| rusqlite | 0.32 | 0.32 | Current |+| git2 | 0.20 | 0.20 | **Unused — remove** |+| serde | 1 | 1 | Current |+| clap | 4 | 4 | Current |+| chrono | 0.4 | 0.4 | Current |+| uuid | 1 | 1 | Current |++All dependencies are current. `git2` should be removed.++## 7. Recommendations (Prioritized)++### P0 — Quick Wins++1. **Remove `git2` from `Cargo.toml`** — unused dependency, reduces build time and binary size.+2. **Add environment variable support to `Config::load()`** — `ECC_DB_PATH`, `ECC_WORKTREE_ROOT`, `ECC_DEFAULT_AGENT`. Standard practice for CLI tools.++### P1 — Feature Completions++3. **Implement `comms::receive()` / `comms::poll()`** — read unread messages from the `messages` table, optionally with a `broadcast` channel for real-time delivery. Wire it into the dashboard.+4. **Build the new-session dialog in the TUI** — modal form with task input, agent selector, worktree toggle. Should call `session::manager::create_session()`.+5. **Add aggregate metrics** — total cost, average session duration, tool call frequency, cost per session. Show in the Metrics pane.++### P2 — Robustness++6. **Add integration tests for `manager.rs` and `runtime.rs`** — these modules do process spawning and I/O. Test with mock agents (`/bin/echo`, `/bin/false`).+7. **Add daemon health reporting** — PID file, structured logging, graceful shutdown via signal handler.+8. **Break up `dashboard.rs`** — extract SessionsPane, OutputPane, MetricsPane, LogPane into separate files under `tui/panes/`.++### P3 — Extensibility++9. **Multi-agent support** — make `agent_program()` pluggable. Add `codex`, `opencode`, `custom` agent types.+10. **Config validation** — validate risk thresholds sum correctly, budget values are positive, paths exist.++## 8. Comparison with Ratatui 0.29 Best Practices++The codebase follows ratatui conventions well:+- Uses `TableState` for stateful selection (correct pattern)+- Custom `Widget` trait implementation for `TokenMeter` (idiomatic)+- `tick()` method for periodic state sync (standard)+- `broadcast::channel` for real-time output events (appropriate)++**Minor deviations:**+- The `Dashboard` struct directly holds `StateStore` (SQLite connection). Ratatui best practice is to keep the state store behind an `Arc<Mutex<>>` to allow background updates. Currently the TUI owns the DB exclusively, which blocks adding a background metrics refresh task.+- No `Clear` widget usage when rendering the help overlay — could cause rendering artifacts on some terminals.++## 9. Risk Assessment++| Risk | Likelihood | Impact | Mitigation |+|------|-----------|--------|------------|+| Dashboard file exceeds 1500 lines | High | Medium | Extract panes into modules |+| SQLite lock contention | Low | High | DbWriter pattern already handles this |+| No agent diversity | Medium | Medium | Pluggable agent support |+| Stale `git2` dependency | Low | Low | Remove from Cargo.toml |++---++**Bottom line:** ECC2 is a well-structured Rust project with clean error handling, good separation of concerns, and strong security features (risk scoring). The main gaps are incomplete features (comms, new-session dialog, single agent) rather than architectural problems. The codebase is ready for feature work on top of the solid foundation.