Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
002c128ac8 | ||
|
|
581ec29492 | ||
|
|
90b7953b17 | ||
|
|
26e7992c8d | ||
|
|
60515dd8c6 | ||
|
|
b3c73fd2cb | ||
|
|
7d06bec21e | ||
|
|
6af8abccd3 |
@@ -66,6 +66,10 @@ See `docs/INSTALL.md` for end-user install instructions.
|
||||
collisions, what blocks a kill, what `--force` retains, and what reclaim
|
||||
touches. Read it before changing anything that creates or removes one.
|
||||
|
||||
`docs/SIDEBAR.md` is the contract for session cards in the web and TUI
|
||||
sidebars — line layout, activity colours, duration format, state precedence.
|
||||
Read it before changing sidebar rendering.
|
||||
|
||||
`nix run .#dev` (or `just dev`) brings up the whole local stack under
|
||||
process-compose: a debug daemon on 127.0.0.1:7071, then Vite on :5173 once the
|
||||
daemon answers `/api/info`. The SPA proxies `/api/*` back to the daemon, so only
|
||||
|
||||
@@ -73,6 +73,9 @@ async fn run(config_override: Option<PathBuf>) -> Result<(), Box<dyn Error>> {
|
||||
// One store instance shared with the API handlers: forced kills (#81)
|
||||
// record here, `GET /api/worktrees` (#80) reads back from here.
|
||||
.with_retained_store((*retained).clone());
|
||||
// Spawned sessions learn where to report back (#103). Derived from the
|
||||
// configured bind address; set before any spawn can happen.
|
||||
manager.set_daemon_url(format!("http://{}", config.bind_addr));
|
||||
|
||||
let recovered = manager.recover().await?;
|
||||
tracing::info!(recovered, "adopted existing tmux sessions");
|
||||
|
||||
@@ -131,6 +131,11 @@ struct Inner {
|
||||
/// Retained-worktree store (#78). `None` when not wired (tests); a forced
|
||||
/// kill (#81) without one fails rather than destroying unrecorded work.
|
||||
retained: Option<crate::retained_store::RetainedStore>,
|
||||
/// The daemon's own HTTP base URL (#103), exported to spawned sessions as
|
||||
/// `MAESTRO_URL`. `None` when unknown — those sessions simply don't get
|
||||
/// the variable. A mutex because the runner sets it after construction,
|
||||
/// possibly while clones are already serving.
|
||||
daemon_url: std::sync::Mutex<Option<String>>,
|
||||
sessions: Mutex<HashMap<Uuid, SessionRecord>>,
|
||||
events: broadcast::Sender<CatalogEvent>,
|
||||
}
|
||||
@@ -170,6 +175,7 @@ impl SessionManager {
|
||||
replay_bytes,
|
||||
spawn_history: None,
|
||||
retained: None,
|
||||
daemon_url: std::sync::Mutex::new(None),
|
||||
sessions: Mutex::new(HashMap::new()),
|
||||
events,
|
||||
}),
|
||||
@@ -202,6 +208,14 @@ impl SessionManager {
|
||||
self
|
||||
}
|
||||
|
||||
/// Set the daemon's own HTTP base URL (#103), exported to every session
|
||||
/// spawned afterwards as `MAESTRO_URL`. Unlike the `with_*` builders this
|
||||
/// is a plain setter: the daemon runner learns its bound address after
|
||||
/// construction, and clones may already exist by then.
|
||||
pub fn set_daemon_url(&self, url: String) {
|
||||
*self.inner.daemon_url.lock().expect("daemon_url mutex") = Some(url);
|
||||
}
|
||||
|
||||
/// Recent working dirs for the spawn form's picker (#24), newest-first and
|
||||
/// deduped by dir. Empty when no history is wired or it's disabled.
|
||||
pub fn recent_dirs(&self) -> Vec<RecentDir> {
|
||||
@@ -304,7 +318,7 @@ impl SessionManager {
|
||||
return Err(e.into());
|
||||
}
|
||||
};
|
||||
let session_env = match sanitize_env(&req.env) {
|
||||
let mut session_env = match sanitize_env(&req.env) {
|
||||
Ok(env) => env,
|
||||
Err(e) => {
|
||||
let _ = std::fs::remove_file(&fifo_path);
|
||||
@@ -312,6 +326,19 @@ impl SessionManager {
|
||||
return Err(e);
|
||||
}
|
||||
};
|
||||
// Identity + reporting target for the in-session hook (#106). Ours
|
||||
// win over whatever the request carried, so a client cannot spoof
|
||||
// another session's identity (#103).
|
||||
session_env.insert("MAESTRO_SESSION_ID".into(), id.to_string());
|
||||
if let Some(url) = self
|
||||
.inner
|
||||
.daemon_url
|
||||
.lock()
|
||||
.expect("daemon_url mutex")
|
||||
.clone()
|
||||
{
|
||||
session_env.insert("MAESTRO_URL".into(), url);
|
||||
}
|
||||
let spawned = {
|
||||
let tmux = self.inner.tmux.clone();
|
||||
let cwd = effective_cwd.clone();
|
||||
@@ -570,6 +597,9 @@ impl SessionManager {
|
||||
status: SessionStatus::Running,
|
||||
created_at: Utc::now(),
|
||||
// Activity is unknown on adoption; the watcher fills it in.
|
||||
// #104: the restart also resets the activity clock to now —
|
||||
// accepted, since the daemon cannot know how long a
|
||||
// recovered session had already been sitting idle.
|
||||
foreground: None,
|
||||
activity: ActivityState::Idle,
|
||||
last_activity_at: Utc::now(),
|
||||
@@ -830,6 +860,12 @@ async fn run_activity_pass(inner: &Arc<Inner>) {
|
||||
{
|
||||
None
|
||||
} else {
|
||||
// #104: stamp only when the state itself changed — never on
|
||||
// foreground/cwd-only diffs, and never every tick, or the
|
||||
// sidebar's duration would reset continuously and read zero.
|
||||
if rec.session.activity != activity {
|
||||
rec.session.activity_since = Utc::now();
|
||||
}
|
||||
rec.session.activity = activity;
|
||||
rec.session.foreground = foreground;
|
||||
rec.session.current_cwd = current_cwd;
|
||||
|
||||
@@ -264,6 +264,25 @@ impl Tmux {
|
||||
check(out)
|
||||
}
|
||||
|
||||
/// `tmux show-environment -t maestro-<id>`, parsed into KEY=VALUE pairs.
|
||||
/// Test-facing view of what a spawned session actually inherits.
|
||||
pub fn show_environment(&self, id: Uuid) -> Result<BTreeMap<String, String>, TmuxError> {
|
||||
let name = session_name(id);
|
||||
let out = self
|
||||
.cmd()
|
||||
.args(["show-environment", "-t", &name])
|
||||
.output()?;
|
||||
check(out.clone())?;
|
||||
let stdout = String::from_utf8_lossy(&out.stdout);
|
||||
let mut env = BTreeMap::new();
|
||||
for line in stdout.lines() {
|
||||
if let Some((k, v)) = line.split_once('=') {
|
||||
env.insert(k.to_string(), v.to_string());
|
||||
}
|
||||
}
|
||||
Ok(env)
|
||||
}
|
||||
|
||||
/// `tmux kill-server`. Best-effort cleanup used mostly by tests.
|
||||
pub fn kill_server(&self) -> Result<(), TmuxError> {
|
||||
let out = self.cmd().arg("kill-server").output()?;
|
||||
|
||||
@@ -30,6 +30,24 @@ impl Fx {
|
||||
Self::with_sidecar_dir(|tmp| tmp.join("sidecars"))
|
||||
}
|
||||
|
||||
/// Variant whose manager knows the daemon's own base URL (#103), the way
|
||||
/// the production runner wires it from `[daemon].bind_addr`.
|
||||
fn with_daemon_url(url: &str) -> Self {
|
||||
let fx = Self::new();
|
||||
fx.manager.set_daemon_url(url.to_string());
|
||||
fx
|
||||
}
|
||||
|
||||
/// The env map of the (single, expected) spawn call.
|
||||
fn spawned_env(&self) -> BTreeMap<String, String> {
|
||||
let calls = self.fake.calls();
|
||||
let Some(Call::NewSessionPiped { env, .. }) = calls.first() else {
|
||||
panic!("expected a spawn call, got {calls:?}");
|
||||
};
|
||||
assert_eq!(calls.len(), 1, "expected exactly one spawn: {calls:?}");
|
||||
env.clone()
|
||||
}
|
||||
|
||||
fn with_sidecar_dir(pick: impl Fn(&std::path::Path) -> PathBuf) -> Self {
|
||||
let tmp = TempDir::new().expect("tempdir");
|
||||
let fake = Arc::new(FakePanes::new());
|
||||
@@ -261,16 +279,23 @@ async fn requested_env_reaches_tmux() {
|
||||
|
||||
fx.manager.create(req).await.expect("create");
|
||||
|
||||
let spawned = match fx.fake.calls().first() {
|
||||
Some(Call::NewSessionPiped { env, .. }) => env.clone(),
|
||||
other => panic!("expected a spawn call, got {other:?}"),
|
||||
};
|
||||
let id = spawned
|
||||
.get("MAESTRO_SESSION_ID")
|
||||
.expect("spawn must export MAESTRO_SESSION_ID (#103)")
|
||||
.clone();
|
||||
// The daemon-owned variable rides alongside whatever was requested.
|
||||
let want: BTreeMap<String, String> = [
|
||||
("EMPTY".to_string(), String::new()),
|
||||
("FOO".to_string(), "bar".to_string()),
|
||||
("MAESTRO_SESSION_ID".to_string(), id),
|
||||
]
|
||||
.into_iter()
|
||||
.collect();
|
||||
match fx.fake.calls().first() {
|
||||
Some(Call::NewSessionPiped { env, .. }) => assert_eq!(env, &want),
|
||||
other => panic!("expected a spawn call, got {other:?}"),
|
||||
}
|
||||
assert_eq!(&spawned, &want);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
@@ -338,6 +363,9 @@ async fn activity_pass_emits_updated_only_when_something_changed() {
|
||||
// Still inside `activity::ACTIVE_WINDOW` (3s) since the spawn, so the
|
||||
// change here is `foreground`, not the activity state.
|
||||
assert_eq!(updated.activity, ActivityState::Active);
|
||||
// A foreground/cwd-only change is not a state transition (#104): the
|
||||
// sidebar's duration must keep counting from the original stamp.
|
||||
assert_eq!(updated.activity_since, session.activity_since);
|
||||
|
||||
// Drain anything already queued, then confirm a steady pane stays quiet.
|
||||
// Stays well inside the 3s window, so no Active -> Idle transition either.
|
||||
@@ -349,6 +377,70 @@ async fn activity_pass_emits_updated_only_when_something_changed() {
|
||||
);
|
||||
}
|
||||
|
||||
/// The sidebar's duration (#104) is time in the *current* state, so
|
||||
/// `activity_since` is stamped exactly when the decided state differs from
|
||||
/// the stored one — once per transition. Stamping it every tick would make
|
||||
/// the duration permanently read zero.
|
||||
#[tokio::test]
|
||||
async fn activity_transition_stamps_activity_since_once_per_transition() {
|
||||
let fx = Fx::new();
|
||||
let session = fx
|
||||
.manager
|
||||
.create(fx.request("sleep 300"))
|
||||
.await
|
||||
.expect("create");
|
||||
fx.fake.set_pane_info(
|
||||
session.id,
|
||||
PaneInfo {
|
||||
// Nothing reads from this pid: `awaiting_input` is deterministically
|
||||
// false, so past `ACTIVE_WINDOW` the session decides as Idle.
|
||||
pane_pid: i32::MAX,
|
||||
command: "sleep".into(),
|
||||
tty: "/dev/null".into(),
|
||||
current_path: String::new(),
|
||||
},
|
||||
);
|
||||
let mut events = fx.manager.events();
|
||||
fx.manager.start_liveness_watcher(Duration::from_millis(25));
|
||||
|
||||
let idle = wait_for_activity(&fx.manager, session.id, ActivityState::Idle).await;
|
||||
assert!(
|
||||
idle.activity_since >= session.activity_since + chrono::Duration::seconds(2),
|
||||
"the Active -> Idle transition must stamp a fresh activity_since \
|
||||
(spawn stamp {:?}, transition stamp {:?})",
|
||||
session.activity_since,
|
||||
idle.activity_since
|
||||
);
|
||||
|
||||
// Steady Idle across many more ticks must not re-stamp — no further
|
||||
// SessionUpdated at all, or the sidebar clock would keep resetting.
|
||||
while events.try_recv().is_ok() {}
|
||||
tokio::time::sleep(Duration::from_millis(300)).await;
|
||||
assert!(
|
||||
matches!(events.try_recv(), Err(TryRecvError::Empty)),
|
||||
"a steady state must not re-emit (and re-stamp) on every tick"
|
||||
);
|
||||
}
|
||||
|
||||
async fn wait_for_activity(
|
||||
manager: &SessionManager,
|
||||
id: uuid::Uuid,
|
||||
want: ActivityState,
|
||||
) -> maestro_protocol::Session {
|
||||
let deadline = tokio::time::Instant::now() + Duration::from_secs(6);
|
||||
loop {
|
||||
if tokio::time::Instant::now() >= deadline {
|
||||
panic!("timed out waiting for {id} to become {want:?}");
|
||||
}
|
||||
if let Some(s) = manager.snapshot().await.into_iter().find(|s| s.id == id) {
|
||||
if s.activity == want {
|
||||
return s;
|
||||
}
|
||||
}
|
||||
tokio::time::sleep(Duration::from_millis(20)).await;
|
||||
}
|
||||
}
|
||||
|
||||
async fn wait_for_updated(
|
||||
events: &mut tokio::sync::broadcast::Receiver<CatalogEvent>,
|
||||
) -> maestro_protocol::Session {
|
||||
@@ -396,3 +488,70 @@ fn attaching_spawn_history_after_cloning_panics() {
|
||||
7,
|
||||
));
|
||||
}
|
||||
|
||||
/// Every tmux-spawned session learns who it is (#103): its own UUID under
|
||||
/// `MAESTRO_SESSION_ID`, so the reporting hook in #106 can name the session
|
||||
/// it is running inside.
|
||||
#[tokio::test]
|
||||
async fn spawn_exports_maestro_session_id() {
|
||||
let fx = Fx::new();
|
||||
let s = fx.manager.create(fx.request("bash")).await.expect("create");
|
||||
|
||||
let env = fx.spawned_env();
|
||||
assert_eq!(
|
||||
env.get("MAESTRO_SESSION_ID").map(String::as_str),
|
||||
Some(&s.id.to_string()[..]),
|
||||
"MAESTRO_SESSION_ID must be the session's UUID, got {env:?}"
|
||||
);
|
||||
}
|
||||
|
||||
/// The hook also needs to know where to report to: `MAESTRO_URL` carries the
|
||||
/// daemon's base URL derived from `[daemon].bind_addr` (#103).
|
||||
#[tokio::test]
|
||||
async fn spawn_exports_maestro_url_when_the_daemon_is_wired() {
|
||||
let fx = Fx::with_daemon_url("http://127.0.0.1:7070");
|
||||
fx.manager.create(fx.request("bash")).await.expect("create");
|
||||
|
||||
let env = fx.spawned_env();
|
||||
assert_eq!(
|
||||
env.get("MAESTRO_URL").map(String::as_str),
|
||||
Some("http://127.0.0.1:7070"),
|
||||
"MAESTRO_URL must be the daemon's base URL, got {env:?}"
|
||||
);
|
||||
}
|
||||
|
||||
/// Without a wired URL (tests, or a caller that never set one) only the
|
||||
/// session id is injected — an empty or bogus `MAESTRO_URL` would send the
|
||||
/// #106 hook's reports nowhere useful.
|
||||
#[tokio::test]
|
||||
async fn spawn_omits_maestro_url_when_not_wired() {
|
||||
let fx = Fx::new();
|
||||
fx.manager.create(fx.request("bash")).await.expect("create");
|
||||
|
||||
let env = fx.spawned_env();
|
||||
assert!(
|
||||
!env.contains_key("MAESTRO_URL"),
|
||||
"MAESTRO_URL must be absent when no daemon URL is known, got {env:?}"
|
||||
);
|
||||
}
|
||||
|
||||
/// The daemon-owned variables win over anything the spawner sent: a client
|
||||
/// cannot spoof another session's identity.
|
||||
#[tokio::test]
|
||||
async fn spawn_overrides_client_supplied_maestro_variables() {
|
||||
let fx = Fx::with_daemon_url("http://127.0.0.1:7070");
|
||||
let mut req = fx.request("bash");
|
||||
req.env.insert(
|
||||
"MAESTRO_SESSION_ID".into(),
|
||||
"00000000-0000-0000-0000-000000000000".into(),
|
||||
);
|
||||
req.env.insert("MAESTRO_URL".into(), "http://evil:1".into());
|
||||
let s = fx.manager.create(req).await.expect("create");
|
||||
|
||||
let env = fx.spawned_env();
|
||||
assert_eq!(env.get("MAESTRO_SESSION_ID"), Some(&s.id.to_string()));
|
||||
assert_eq!(
|
||||
env.get("MAESTRO_URL"),
|
||||
Some(&"http://127.0.0.1:7070".to_string())
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1004,3 +1004,44 @@ async fn worktree_base_repo_records_the_main_checkout_not_the_request() {
|
||||
);
|
||||
assert_ne!(wt.base_repo, inner_worktree, "the worktree is not the repo");
|
||||
}
|
||||
|
||||
/// #103: every tmux-spawned session carries the daemon's identity variables in
|
||||
/// its environment — its UUID under `MAESTRO_SESSION_ID` and the daemon's base
|
||||
/// URL under `MAESTRO_URL` — so the in-session reporting hook (#106) can find
|
||||
/// both without any out-of-band channel.
|
||||
#[tokio::test]
|
||||
async fn spawned_sessions_export_maestro_session_id_and_url() {
|
||||
let fx = DaemonFixture::new();
|
||||
fx.manager
|
||||
.set_daemon_url("http://127.0.0.1:7071".to_string());
|
||||
let cwd = TempDir::new().unwrap();
|
||||
|
||||
let s = fx
|
||||
.manager
|
||||
.create(CreateSessionRequest {
|
||||
cwd: cwd.path().to_path_buf(),
|
||||
command: "sleep 30".into(),
|
||||
env: HashMap::new(),
|
||||
metadata: HashMap::new(),
|
||||
worktree: None,
|
||||
})
|
||||
.await
|
||||
.expect("create");
|
||||
|
||||
let env = fx
|
||||
.tmux
|
||||
.tmux
|
||||
.show_environment(s.id)
|
||||
.expect("show-environment");
|
||||
assert_eq!(
|
||||
env.get("MAESTRO_SESSION_ID"),
|
||||
Some(&s.id.to_string()),
|
||||
"session env: {env:?}"
|
||||
);
|
||||
assert_eq!(
|
||||
env.get("MAESTRO_URL"),
|
||||
Some(&"http://127.0.0.1:7071".to_string())
|
||||
);
|
||||
|
||||
fx.manager.kill(s.id, false).await.expect("kill");
|
||||
}
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
# SIDEBAR.md — the session card contract
|
||||
|
||||
One rule for how a session is rendered as a card in the sidebar, so the web
|
||||
sidebar (#107) and the TUI sidebar (#108) describe a session the same way.
|
||||
Read this before changing either. Both clients implement exactly what is
|
||||
written here; if it needs to change, change it here first.
|
||||
|
||||
A card has **line 1** always and **line 2** only when line 2 has something to
|
||||
say.
|
||||
|
||||
## Line 1 — name + actions
|
||||
|
||||
- Left: the session name — `metadata.name` if present, else the command line
|
||||
(same fallback both clients already use).
|
||||
- Right: two actions anchored to the top-right corner: **spawn similar**
|
||||
(`⧉`) and **kill** (`✕`). In the TUI these are keyboard affordances shown on
|
||||
the highlighted row; in the web they are buttons. The glyphs are shared so
|
||||
muscle memory transfers.
|
||||
- Actions reserve their fixed width; the name truncates with `…` before it can
|
||||
ever reach them. **Overlap between the name and the actions is a defect** —
|
||||
that overlap is what started this milestone.
|
||||
|
||||
Line 1 carries no badges. The `⚠ blocked work` badge (#83) and the `exited`
|
||||
badge move off this row into line 2.
|
||||
|
||||
## Line 2 — meta line (adaptive)
|
||||
|
||||
Rendered only when at least one of these holds:
|
||||
|
||||
1. The session has been held in its current activity state longer than
|
||||
**30 seconds** (`activity_since` from #102). A freshly-active session
|
||||
stays one line.
|
||||
2. Its worktree holds blocked work: `blocked_work` is `Some` and not clear
|
||||
(`InTheWay::is_clear()`), rendered in `formatInTheWay`'s phrasing on web
|
||||
and as `⚠ <summary>` on the TUI.
|
||||
3. It has exited: `status == Dead`.
|
||||
4. An agent-reported state (#105) of `Error` is in force (see Precedence).
|
||||
|
||||
Otherwise line 2 is absent — never an empty placeholder row.
|
||||
|
||||
When present, line 2 reads left to right:
|
||||
|
||||
```
|
||||
<dot> <duration> [<blocked work> | exited]
|
||||
```
|
||||
|
||||
`<dot>` is a single filled glyph (`●` on both clients) carrying the activity
|
||||
state's colour, and `<duration>` follows in the same colour. There is no state
|
||||
word and no second badge: the dot exists so the state is still legible when a
|
||||
row is dimmed or the terminal renders the duration in the default fg.
|
||||
|
||||
## Colour per activity state
|
||||
|
||||
The state word is never spelled out — the colour carries it.
|
||||
|
||||
| Activity state | Web token | ratatui colour |
|
||||
| ---------------- | --------- | ----------------- |
|
||||
| `Active` | `--live` | `Color::Green` |
|
||||
| `Idle` | `--muted` | `Color::DarkGray` |
|
||||
| `AwaitingInput` | `--warn` | `Color::Yellow` |
|
||||
| `Error` | `--danger`| `Color::Red` |
|
||||
|
||||
Web tokens resolve per theme automatically (`styles.css` defines dark, light,
|
||||
and `prefers-color-scheme` variants for each). The TUI uses the plain ratatui
|
||||
named colours above; do not introduce RGB values or a new palette module for
|
||||
this.
|
||||
|
||||
The duration text inherits its state's colour; the blocked-work and exited
|
||||
fragments use the muted colour (`--faint` / default style), since the ⚠ glyph
|
||||
already signals severity.
|
||||
|
||||
## Duration format
|
||||
|
||||
Time spent in the **current activity state**, sourced from `activity_since`
|
||||
(#102) — *not* time since spawn, and *not* time since last PTY output
|
||||
(`last_activity_at`). Both clients compute it identically:
|
||||
|
||||
- `< 60s` → whole seconds, floored: `30s`
|
||||
- `< 60m` → whole minutes, floored: `4m`
|
||||
- `≥ 60m` → whole hours, floored: `2h`
|
||||
|
||||
No days unit, no seconds inside minutes, no rounding up. Floor everywhere so
|
||||
the counter never shows a duration the state hasn't actually reached yet.
|
||||
Clock granularity: re-render at least once every 30s while visible so the
|
||||
cutover points land within one tick.
|
||||
|
||||
## Precedence
|
||||
|
||||
An agent-reported `ActivityState` (#105) overrides the daemon's inference for
|
||||
the TTL the report carries; when the TTL expires, inference resumes. Clients
|
||||
never blend the two: whichever source is in force supplies both the colour and
|
||||
the clock for `activity_since`.
|
||||
|
||||
If a client receives an `ActivityState` variant it does not know, it must not
|
||||
fail rendering: treat it as `Idle` (neutral/dim, line-2 rules apply as usual)
|
||||
until the daemon sends a variant it does know. Rust clients deserialize
|
||||
activity leniently for the same reason.
|
||||
Reference in New Issue
Block a user