fix(sessions): orphan cleanup was reading the wrong tmux clock
Adversarial review of the previous commit found ten defects. The critical one
would have destroyed exactly the work this feature exists to protect.
CRITICAL — `#{session_activity}` is a CLIENT clock, not an output clock.
It advances on attach and on keypresses, and never moves for a detached session
however much its shell is printing. Measured on tmux 3.6a: a detached session
running `while true; do echo tick; sleep 1; done` still reported
session_activity == session_created after 6 s, while `#{window_activity}` tracked
the output exactly. So "idle for 7 days" was really "nobody has typed for 7 days",
and `Clean up idle 7d+` would have killed long-running unattended sessions that
were busy working — the walk-away case the whole app is built around.
Measured against this host's 69 sessions: the old clock condemned 36, the new one
condemns 33, so three sessions doing real work were one click from deletion.
Now reads window_activity, with a test that fails if the format string regresses.
HIGH — no timeout on any tmux call. maxBuffer bounds a flood but nothing bounded
the wait, and a synchronous exec cannot be interrupted by the event loop, so a
tmux server stopped mid-syscall hung the whole server permanently. All five calls
(including the three that predate this feature) now carry one.
HIGH — listSessions and capturePane were synchronous on a POLLED path. Measured
73 ms and 58 ms per call on this host; every home screen on every device refreshes
on a 5 s timer, and each of those was 73 ms with the event loop stopped, i.e.
73 ms in which no PTY byte reached any terminal anywhere. Both are async now, so
the manager's listOrphans/captureOrphan/killOrphansIdleSince are too. The server
is a byte-shuttle first: nothing polled may block it.
HIGH — GET /orphan-sessions had no rate limiter although, unlike every other read
route, it spawns a subprocess. It shares the preview bucket now.
HIGH — the cleanup confirmation counted CARDS, and the grid is capped at 24 while
the cleanup matches across every session the server enumerates. On this host it
would have said "24" and ended 33 shells. New GET /orphan-sessions/count-idle
answers the real question, and the dialog states that number, or refuses to
proceed if it cannot be determined.
MEDIUM — fetchOrphanSessions collapsed every failure into [], so one 429 or 500
read as "all recovered sessions are gone", tearing down every mounted xterm and
rebuilding it on the next success. It returns null for failure now, and the
refresh leaves the section untouched.
MEDIUM — the preview latch was "card was created", not "preview succeeded", so a
card that lost its single request stayed blank forever. Latches on success.
MEDIUM — overlapping refreshes. refresh() is entered from a 5 s timer, from
killOrphan and from cleanup, with awaits inside and no guard, so a slow poll could
resurrect cards for sessions already killed or re-mount them into a root that
setVisible(false) had just cleared. A generation counter, bumped on teardown and
checked after every await, invalidates stale runs.
MEDIUM — renderPreview could write to a disposed xterm (it throws "Object has
been disposed"). PreviewCard carries an explicit `disposed` flag set by a new
disposeCard() helper, so no caller can dispose a terminal and forget the flag.
Deliberately NOT el.isConnected: a card not yet appended is alive, and two
existing preview-grid tests correctly caught that conflation.
LOW — kill and cleanup discarded their results, so a refusal (403 behind a proxy
whose Origin differs, 404 on a lost race) looked like a dead button. Both report.
Tests: 2209 unit, 27 e2e, 8 orphan integration. Verified live against all 69 real
sessions with none harmed; the window_activity fix confirmed on an isolated tmux
socket (-L) so the developer's sessions were never involved.
This commit is contained in:
@@ -9,18 +9,38 @@
|
||||
* treated as "false"/no-op).
|
||||
*/
|
||||
|
||||
import { execFileSync } from 'node:child_process'
|
||||
import { execFile, execFileSync } from 'node:child_process'
|
||||
import { promisify } from 'node:util'
|
||||
import { SESSION_ID_RE } from '../protocol.js'
|
||||
|
||||
const execFileAsync = promisify(execFile)
|
||||
|
||||
/** Upper bound on one `capture-pane` payload. A pane is one screen, so this is
|
||||
* generous; it exists so a wedged tmux can never hand us unbounded output. */
|
||||
const CAPTURE_MAX_BUFFER = 512 * 1024
|
||||
|
||||
/** Tab-separated, machine-readable. tmux reports the two clocks in unix SECONDS. */
|
||||
/** Every tmux call is bounded. maxBuffer caps a flood but nothing caps the WAIT,
|
||||
* and a tmux server stopped mid-syscall (SIGSTOP, a hung filesystem) would
|
||||
* otherwise block forever — fatally so for the synchronous calls, which the event
|
||||
* loop cannot interrupt. */
|
||||
const TMUX_TIMEOUT_MS = 3000
|
||||
|
||||
/**
|
||||
* Tab-separated, machine-readable. tmux reports both clocks in unix SECONDS.
|
||||
*
|
||||
* The activity clock is `window_activity`, NOT `session_activity`. That is not a
|
||||
* detail: `session_activity` tracks CLIENT activity — it advances on attach and on
|
||||
* keypresses — and never moves for a detached session no matter how much its shell
|
||||
* is printing. Measured on tmux 3.6a with a detached session in a `while true; do
|
||||
* echo tick; sleep 1; done` loop: after 6s, session_activity was still equal to
|
||||
* session_created while window_activity had advanced. Using session_activity as the
|
||||
* liveness signal would make the idle-cleanup kill precisely the long-running,
|
||||
* unattended, actively-working sessions this whole feature exists to protect.
|
||||
*/
|
||||
const LIST_FORMAT = [
|
||||
'#{session_name}',
|
||||
'#{session_created}',
|
||||
'#{session_activity}',
|
||||
'#{window_activity}',
|
||||
'#{session_attached}',
|
||||
'#{window_width}',
|
||||
'#{window_height}',
|
||||
@@ -46,7 +66,7 @@ export interface TmuxSessionSummary {
|
||||
/** Is the tmux binary available on PATH? */
|
||||
export function tmuxAvailable(): boolean {
|
||||
try {
|
||||
execFileSync('tmux', ['-V'], { stdio: 'ignore' })
|
||||
execFileSync('tmux', ['-V'], { stdio: 'ignore', timeout: TMUX_TIMEOUT_MS })
|
||||
return true
|
||||
} catch {
|
||||
return false
|
||||
@@ -61,7 +81,10 @@ export function tmuxName(sessionId: string): string {
|
||||
/** Does a tmux session with this name already exist (e.g. after a restart)? */
|
||||
export function hasSession(name: string): boolean {
|
||||
try {
|
||||
execFileSync('tmux', ['has-session', '-t', name], { stdio: 'ignore' })
|
||||
execFileSync('tmux', ['has-session', '-t', name], {
|
||||
stdio: 'ignore',
|
||||
timeout: TMUX_TIMEOUT_MS,
|
||||
})
|
||||
return true
|
||||
} catch {
|
||||
return false
|
||||
@@ -71,7 +94,10 @@ export function hasSession(name: string): boolean {
|
||||
/** Kill a tmux session (ends the shell). No-op if it's already gone. */
|
||||
export function killSession(name: string): void {
|
||||
try {
|
||||
execFileSync('tmux', ['kill-session', '-t', name], { stdio: 'ignore' })
|
||||
execFileSync('tmux', ['kill-session', '-t', name], {
|
||||
stdio: 'ignore',
|
||||
timeout: TMUX_TIMEOUT_MS,
|
||||
})
|
||||
} catch {
|
||||
// already gone — fine
|
||||
}
|
||||
@@ -133,16 +159,24 @@ export function parseSessionList(stdout: string): TmuxSessionSummary[] {
|
||||
return rows.sort((a, b) => b.lastActivityAtMs - a.lastActivityAtMs)
|
||||
}
|
||||
|
||||
/** Every `web_*` tmux session on the host, most recently active first. Never
|
||||
* throws; [] when tmux is missing or no tmux server is running. */
|
||||
export function listSessions(): TmuxSessionSummary[] {
|
||||
/**
|
||||
* Every `web_*` tmux session on the host, most recently active first. Never
|
||||
* throws; [] when tmux is missing or no tmux server is running.
|
||||
*
|
||||
* ASYNC on purpose. This is polled — every device's home screen refreshes on a
|
||||
* timer — and the spawn costs ~73 ms on a host with 69 sessions. Done
|
||||
* synchronously that is 73 ms with the event loop stopped, i.e. 73 ms during which
|
||||
* no PTY byte reaches any terminal on any device. The server is a byte-shuttle
|
||||
* first; nothing on a polling path may block it.
|
||||
*/
|
||||
export async function listSessions(): Promise<TmuxSessionSummary[]> {
|
||||
try {
|
||||
const out = execFileSync('tmux', ['list-sessions', '-F', LIST_FORMAT], {
|
||||
const { stdout } = await execFileAsync('tmux', ['list-sessions', '-F', LIST_FORMAT], {
|
||||
encoding: 'utf8',
|
||||
stdio: ['ignore', 'pipe', 'ignore'],
|
||||
maxBuffer: CAPTURE_MAX_BUFFER,
|
||||
timeout: TMUX_TIMEOUT_MS,
|
||||
})
|
||||
return parseSessionList(out)
|
||||
return parseSessionList(stdout)
|
||||
} catch {
|
||||
return []
|
||||
}
|
||||
@@ -156,13 +190,14 @@ export function listSessions(): TmuxSessionSummary[] {
|
||||
* `attach-session`: attaching would make tmux resize the window to the new
|
||||
* client's dimensions and SIGWINCH whatever is running inside it.
|
||||
*/
|
||||
export function capturePane(name: string): string | null {
|
||||
export async function capturePane(name: string): Promise<string | null> {
|
||||
try {
|
||||
return execFileSync('tmux', ['capture-pane', '-p', '-e', '-t', name], {
|
||||
const { stdout } = await execFileAsync('tmux', ['capture-pane', '-p', '-e', '-t', name], {
|
||||
encoding: 'utf8',
|
||||
stdio: ['ignore', 'pipe', 'ignore'],
|
||||
maxBuffer: CAPTURE_MAX_BUFFER,
|
||||
timeout: TMUX_TIMEOUT_MS,
|
||||
})
|
||||
return stdout
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user