@adhdev/daemon-core 0.9.82-rc.17 → 0.9.82-rc.170

package/src/providers/spec/driver.ts

@@ -0,0 +1,502 @@
+/**
+ * SpecDriver — the single fixed script that turns a CliSpec + a
+ * TerminalAdapter into the dashboard-facing wire protocol.
+ *
+ * Wire (dashboard ↔ daemon):
+ *
+ *   dashboard → daemon:
+ *     { kind: 'send_message',       text }
+ *     { kind: 'click_control',      control_id, payload? }
+ *     { kind: 'click_modal_button', index }
+ *     { kind: 'attach_image',       blob, mime }
+ *     { kind: 'resize',             cols, rows }
+ *     { kind: 'cancel' }
+ *     { kind: 'shutdown' }
+ *
+ *   daemon → dashboard:
+ *     { kind: 'pty_data',           chunk }
+ *     { kind: 'state_changed',
+ *           state: { id, label, title },
+ *           modal: null | { title, buttons: [{ index, label }] },
+ *           controls: [{ id, label, action_type }] }
+ *     { kind: 'notification',       id, title, body }
+ *     { kind: 'delegate',           id, task }
+ *     { kind: 'spec_trace',         entries: [...] }
+ *     { kind: 'exit',               exit_code }
+ *
+ * Hot reload: spec.json is watched. A reload re-evaluates and emits a
+ * fresh state_changed; no PTY restart is required.
+ *
+ * Delegate timers: after_duration_ms is enforced here (the evaluator
+ * is stateless). A timer is armed when a delegate's when_state is
+ * entered and cancelled when it changes.
+ */
+'use strict';
+
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { TerminalAdapter, type TerminalAdapterOpts } from './adapter.js';
+import type { PtyTransportFactory } from '../../cli-adapters/pty-transport.js';
+import { evaluate, type SpecEvaluation, type TraceEntry } from './evaluator.js';
+import { loadSpec } from './loader.js';
+import type { CliSpec, Control, DelegateTrigger } from './types.js';
+
+export type DashboardEvent =
+    | { kind: 'pty_data'; chunk: string }
+    | { kind: 'state_changed'; state: { id: string; label: string; title: string | null };
+        modal: { title: string | null; buttons: { index: number; label: string }[] } | null;
+        controls: { id: string; label: string; action_type: string }[] }
+    | { kind: 'notification'; id: string; title: string; body: string }
+    | { kind: 'delegate'; id: string; task: string }
+    | { kind: 'spec_trace'; entries: TraceEntry[] }
+    | { kind: 'exit'; exit_code: number }
+    | { kind: 'spec_error'; errors: string[] };
+
+export type DashboardCommand =
+    | { kind: 'send_message'; text: string }
+    | { kind: 'pty_write'; data: string }
+    | { kind: 'click_control'; control_id: string; payload?: unknown }
+    | { kind: 'click_modal_button'; index: number }
+    | { kind: 'attach_image'; blob: string; mime: string }
+    | { kind: 'resize'; cols: number; rows: number }
+    | { kind: 'cancel' }
+    | { kind: 'shutdown' };
+
+export interface SpecDriverOpts {
+    specPath: string;
+    workingDir: string;
+    extraEnv?: Record<string, string>;
+    cols?: number;
+    rows?: number;
+    /** Set false to skip the spec.json fs.watch. */
+    hotReload?: boolean;
+    /** Set true to forward trace entries on every state_changed. */
+    emitTrace?: boolean;
+    /** Inject the daemon's PTY transport (typically SessionHostPtyTransportFactory). */
+    transportFactory?: PtyTransportFactory;
+    /**
+     * Extra CLI args appended to spec.spawn_args. Used by the daemon to
+     * pass per-launch arguments like `--session-id <uuid>` so the agent
+     * uses the daemon's providerSessionId instead of generating its own.
+     */
+    extraCliArgs?: string[];
+}
+
+/** How long after start() to ignore "idle" readings before treating one
+ *  as a real prompt-ready signal. Most TUIs paint a banner + tool list +
+ *  status line on startup that can briefly score as "no state matches →
+ *  default idle"; firing a send_keys into that buffer gets the input
+ *  wiped when the banner clears. 2s covers the slow agents (hermes,
+ *  agy) without delaying snappy ones (claude/codex) by much. */
+const STARTUP_GRACE_MS = 2500;
+
+/** Min time to stay in busy after the evaluator last reports it. Most TUIs
+ *  flicker their busy spinner on and off as layout reflows (claude streams
+ *  body text in the same region where the spinner lives, so the spinner
+ *  disappears mid-response and the footer-only frames score as idle). The
+ *  hold turns short idle gaps inside a single turn into "still busy", at
+ *  the cost of looking busy for a couple seconds after a turn actually
+ *  ends. Pick something long enough to cover the longest claude streaming
+ *  gap we've observed (~5s between spinner refreshes) without dragging
+ *  the post-turn idle indication noticeably. */
+const BUSY_HOLD_MS = 6000;
+
+export class SpecDriver {
+    private spec!: CliSpec;
+    private adapter!: TerminalAdapter;
+    private listeners = new Set<(ev: DashboardEvent) => void>();
+    private currentStateId: string | null = null;
+    /** Have we ever seen the spec's idle state *after* the startup grace
+     *  window? Until we do, the agent's startup banner may still be
+     *  painting and any send_message we forward to the PTY will be wiped
+     *  when the banner clears the screen. Queue + drain on first valid
+     *  idle. */
+    private idleSeenOnce = false;
+    private startedAtMs = 0;
+    private pendingSends: string[] = [];
+    private currentEval: SpecEvaluation | null = null;
+    private pickerInProgress: { control_id: string; phase: 'waiting'; spec: Control } | null = null;
+    private delegateTimers = new Map<string, ReturnType<typeof setTimeout>>();
+    /** Timestamp of the last time the evaluator returned busy. Used to debounce
+     *  the busy → idle transition (see reevaluate). */
+    private lastBusyAt = 0;
+    /** The exact busy state object we last saw — held alongside lastBusyAt so
+     *  the hold can re-emit the same { id: 'busy', label, title } payload the
+     *  dashboard already learned about. currentEval can't fill this role
+     *  because the evaluator already moved past busy by the time the hold
+     *  kicks in. */
+    private lastBusyState: SpecEvaluation['state'] | null = null;
+    /** Timer that re-runs evaluate() once the hold window expires. Needed
+     *  because the PTY stops emitting once the agent finishes; without an
+     *  explicit wake-up there's nothing to trigger the busy → idle
+     *  downshift. */
+    private busyExpiryTimer: ReturnType<typeof setTimeout> | null = null;
+    private specWatcher: fs.FSWatcher | null = null;
+
+    constructor(private readonly opts: SpecDriverOpts) {
+        this.loadSpecOrThrow();
+        this.adapter = new TerminalAdapter(
+            this.buildAdapterOpts(),
+            {
+                init: () => this.emitInitialState(),
+                on_pty_data: (chunk) => this.emit({ kind: 'pty_data', chunk }),
+                on_screen_changed: () => this.reevaluate(),
+                on_exit: ({ exitCode }) => this.handleExit(exitCode),
+            },
+        );
+        if (this.opts.hotReload !== false) this.armSpecWatcher();
+    }
+
+    /** Subscribe to outbound events. Returns an unsubscribe fn. */
+    subscribe(listener: (ev: DashboardEvent) => void): () => void {
+        this.listeners.add(listener);
+        return () => { this.listeners.delete(listener); };
+    }
+
+    start(): void {
+        this.startedAtMs = Date.now();
+        this.adapter.start();
+        // Make sure we always re-evaluate once the startup grace has
+        // expired. Without an explicit wake-up the PTY can go quiet
+        // immediately after the banner paints (agy: the screen stays at
+        // the input prompt forever), there's no on_screen_changed event
+        // to trigger reevaluate, and any send_message we queued during
+        // the grace window would never drain.
+        const graceMs = this.spec.debounce?.startup_grace_ms ?? STARTUP_GRACE_MS;
+        setTimeout(() => this.reevaluate(), graceMs + 100);
+    }
+
+    dispatch(cmd: DashboardCommand): void {
+        switch (cmd.kind) {
+            case 'send_message': this.handleSendMessage(cmd.text); return;
+            case 'pty_write': this.adapter.send_keys(cmd.data); return;
+            case 'click_control': this.handleClickControl(cmd.control_id, cmd.payload); return;
+            case 'click_modal_button': this.handleClickModalButton(cmd.index); return;
+            case 'attach_image': this.handleAttachImage(cmd.blob, cmd.mime); return;
+            case 'resize': this.adapter.resize(cmd.cols, cmd.rows); return;
+            case 'cancel': this.adapter.send_keys('\x03'); return;
+            case 'shutdown': this.shutdown(); return;
+        }
+    }
+
+    snapshot(): string {
+        return this.adapter.snapshot();
+    }
+
+    shutdown(): void {
+        for (const t of this.delegateTimers.values()) clearTimeout(t);
+        this.delegateTimers.clear();
+        this.specWatcher?.close();
+        this.adapter.kill();
+    }
+
+    // ────────────────────────────────────────────────────────────────────
+    // Loading & adapter wiring
+    // ────────────────────────────────────────────────────────────────────
+
+    private loadSpecOrThrow(): void {
+        const res = loadSpec(this.opts.specPath);
+        if (!res.ok) throw new Error(`spec invalid: ${res.errors.join('; ')}`);
+        this.spec = res.spec;
+    }
+
+    private buildAdapterOpts(): TerminalAdapterOpts {
+        const baseArgs = this.spec.spawn_args ?? [];
+        const extra = this.opts.extraCliArgs ?? [];
+        return {
+            binary: this.spec.binary,
+            args: [...baseArgs, ...extra],
+            cwd: this.opts.workingDir,
+            env: { ...(this.spec.env ?? {}), ...(this.opts.extraEnv ?? {}) },
+            cols: this.opts.cols ?? 100,
+            rows: this.opts.rows ?? 30,
+            transportFactory: this.opts.transportFactory,
+        };
+    }
+
+    private armSpecWatcher(): void {
+        try {
+            this.specWatcher = fs.watch(this.opts.specPath, { persistent: false }, () => {
+                // Re-read; if it parses, replace and re-evaluate. Errors are
+                // surfaced to the dashboard so the spec author sees them live.
+                const res = loadSpec(this.opts.specPath);
+                if (!res.ok) { this.emit({ kind: 'spec_error', errors: res.errors }); return; }
+                this.spec = res.spec;
+                this.reevaluate(/*forceEmit*/ true);
+            });
+        } catch { /* watch is best-effort */ }
+    }
+
+    // ────────────────────────────────────────────────────────────────────
+    // Evaluation pipeline
+    // ────────────────────────────────────────────────────────────────────
+
+    private emitInitialState(): void {
+        // Start with an empty-screen evaluation so the dashboard immediately
+        // knows about the default state.
+        this.reevaluate(true);
+    }
+
+    /** Re-arm the timer that wakes the driver up after BUSY_HOLD_MS so it
+     *  can decide whether to downshift to idle. Always uses the most recent
+     *  hold value so a spec hot-reload that shortens the hold takes effect
+     *  on the next busy entry. Safe to call repeatedly; only the last call
+     *  fires. */
+    private scheduleBusyExpiry(holdMs: number): void {
+        if (this.busyExpiryTimer) clearTimeout(this.busyExpiryTimer);
+        this.busyExpiryTimer = setTimeout(() => {
+            this.busyExpiryTimer = null;
+            this.reevaluate();
+        }, Math.max(holdMs + 50, 100));
+    }
+
+    private reevaluate(forceEmit = false): void {
+        const screen = this.adapter.snapshot();
+        const ev = evaluate(this.spec, screen);
+
+        // Busy hold: many TUIs flicker between busy and idle every frame
+        // (claude in particular — its token counter appears and disappears
+        // as the layout reflows). Once we see busy, hold that state for
+        // BUSY_HOLD_MS before allowing a downshift to idle. Any state
+        // *other* than idle clears the hold immediately (approval is
+        // strictly more interesting than busy, so it shouldn't be held
+        // back). The hold lives on the driver, not the evaluator, so the
+        // spec author doesn't have to think about debouncing.
+        let evState = ev.state;
+        const busyHoldMs = this.spec.debounce?.busy_hold_ms ?? BUSY_HOLD_MS;
+        if (this.currentStateId === 'busy' && evState.id === 'idle') {
+            const ageMs = Date.now() - this.lastBusyAt;
+            if (ageMs < busyHoldMs) {
+                // Pin to the last seen busy state directly — currentEval can
+                // already be idle at this point (it tracks the previous tick,
+                // which during the flicker is just as likely to be idle as
+                // busy), so we can't rely on it to recover the busy label.
+                evState = this.lastBusyState ?? evState;
+            }
+        }
+        if (evState.id === 'busy') {
+            this.lastBusyAt = Date.now();
+            this.lastBusyState = evState;
+            // Schedule a re-evaluation when the hold window expires. PTYs
+            // typically stop emitting once the agent stops printing (the
+            // footer settles), so without an explicit timer the driver
+            // never wakes up to downshift to idle and the dashboard sees
+            // status stuck at generating long after the turn ended.
+            this.scheduleBusyExpiry(busyHoldMs);
+        }
+
+        const changed = forceEmit
+            || evState.id !== this.currentStateId
+            || !shallowSameModal(ev, this.currentEval)
+            || !shallowSameControls(ev, this.currentEval);
+
+        // Picker state tracking — if a picker is waiting for its
+        // wait_for cue and now sees it, complete the picker flow.
+        if (this.pickerInProgress) this.tryAdvancePicker(screen);
+
+        this.currentEval = ev;
+        // First time we ever see idle (or any non-busy non-startup state),
+        // flush any queued send_message calls that arrived before the
+        // agent finished painting its banner. Subsequent idle/busy
+        // toggles don't retrigger.
+        // Wait at least the spec's startup_grace_ms after start() so we
+        // don't treat a transient "matches no state, default idle"
+        // reading during the banner paint as a real idle. After that,
+        // the first non-busy observation is a real prompt-ready signal
+        // and we drain any queued send_message calls.
+        const graceMs = this.spec.debounce?.startup_grace_ms ?? STARTUP_GRACE_MS;
+        const sinceStart = Date.now() - this.startedAtMs;
+        if (!this.idleSeenOnce && evState.id !== 'busy' && sinceStart >= graceMs) {
+            this.idleSeenOnce = true;
+            const queued = this.pendingSends.splice(0);
+            for (const text of queued) {
+                setTimeout(() => this.actuallySendMessage(text), 50);
+            }
+        }
+        if (changed) {
+            this.currentStateId = evState.id;
+            this.emit({
+                kind: 'state_changed',
+                state: evState,
+                modal: ev.modal ? { title: ev.modal.title, buttons: ev.modal.buttons.map(b => ({ index: b.index, label: b.label })) } : null,
+                controls: ev.controls.map(c => ({ id: c.id, label: c.label, action_type: c.actionType })),
+            });
+            for (const n of ev.notifications) this.emit({ kind: 'notification', id: n.id, title: n.title, body: n.body });
+            this.armOrCancelDelegateTimers(evState.id);
+            if (this.opts.emitTrace) this.emit({ kind: 'spec_trace', entries: ev.trace });
+        }
+    }
+
+    private armOrCancelDelegateTimers(currentStateId: string): void {
+        for (const d of this.spec.delegate ?? []) {
+            const armed = this.delegateTimers.has(d.id);
+            const shouldFire = d.when_state === currentStateId;
+            if (shouldFire && !armed) {
+                const delay = d.after_duration_ms ?? 0;
+                const t = setTimeout(() => { this.fireDelegate(d); this.delegateTimers.delete(d.id); }, delay);
+                this.delegateTimers.set(d.id, t);
+            } else if (!shouldFire && armed) {
+                clearTimeout(this.delegateTimers.get(d.id)!);
+                this.delegateTimers.delete(d.id);
+            }
+        }
+    }
+
+    private fireDelegate(d: DelegateTrigger): void {
+        const ev = this.currentEval;
+        const task = (d.task_template)
+            .replace(/\{node\}/g, os.hostname())
+            .replace(/\{state\.label\}/g, ev?.state.label ?? '')
+            .replace(/\{state\.title\}/g, ev?.state.title ?? '')
+            .replace(/\{duration_ms\}/g, String(d.after_duration_ms ?? 0));
+        this.emit({ kind: 'delegate', id: d.id, task });
+    }
+
+    // ────────────────────────────────────────────────────────────────────
+    // Dashboard commands
+    // ────────────────────────────────────────────────────────────────────
+
+    private handleSendMessage(text: string): void {
+        if (!this.idleSeenOnce) {
+            // Agent is still drawing its startup banner. Queue and drain
+            // when we see idle so we don't fire keystrokes into a buffer
+            // that's about to be cleared.
+            this.pendingSends.push(text);
+            return;
+        }
+        this.actuallySendMessage(text);
+    }
+
+    private actuallySendMessage(text: string): void {
+        const sm = this.spec.send_message;
+        const perChar = sm.delay_ms_per_char ?? 0;
+        const beforeSubmit = sm.delay_ms_before_submit ?? 0;
+        if (perChar === 0) {
+            this.adapter.send_keys(text);
+            if (beforeSubmit > 0) setTimeout(() => this.adapter.send_keys(sm.submit_key), beforeSubmit);
+            else this.adapter.send_keys(sm.submit_key);
+            return;
+        }
+        let i = 0;
+        const iv = setInterval(() => {
+            if (i >= text.length) {
+                clearInterval(iv);
+                setTimeout(() => this.adapter.send_keys(sm.submit_key), beforeSubmit);
+                return;
+            }
+            this.adapter.send_keys(text[i]);
+            i += 1;
+        }, perChar);
+    }
+
+    private handleClickControl(controlId: string, payload?: unknown): void {
+        const ctl = (this.spec.control_bar ?? []).find(c => c.id === controlId);
+        if (!ctl) return;
+        // Reject controls that aren't currently visible.
+        const ev = this.currentEval;
+        if (ctl.visible_when_state && ev && !ctl.visible_when_state.includes(ev.state.id)) return;
+
+        const a = ctl.action;
+        switch (a.type) {
+            case 'send_keys':
+                this.adapter.send_keys(a.keys);
+                return;
+            case 'open_picker':
+                this.adapter.send_keys(a.trigger_keys);
+                this.pickerInProgress = { control_id: ctl.id, phase: 'waiting', spec: ctl };
+                return;
+            case 'attach_image': {
+                const p = typeof payload === 'object' && payload && (payload as any).path;
+                if (typeof p === 'string') {
+                    const keys = a.keys_template.replace(/\{path\}/g, p);
+                    this.adapter.send_keys(keys);
+                }
+                return;
+            }
+        }
+    }
+
+    private handleClickModalButton(index: number): void {
+        const m = this.currentEval?.modal;
+        if (!m) return;
+        const btn = m.buttons.find(b => b.index === index);
+        if (!btn) return;
+        this.adapter.send_keys(btn.key);
+    }
+
+    private handleAttachImage(blob: string, mime: string): void {
+        // tempfile_then_keys: write decoded bytes to a temp file, then
+        // fire the attach_image control_bar entry with that path.
+        const ctl = (this.spec.control_bar ?? []).find(c => c.action.type === 'attach_image');
+        if (!ctl || ctl.action.type !== 'attach_image') return;
+        const ext = guessExt(mime);
+        const tmp = path.join(os.tmpdir(), `adhdev-attach-${Date.now()}${ext}`);
+        try {
+            fs.writeFileSync(tmp, Buffer.from(blob, 'base64'));
+        } catch { return; }
+        const keys = ctl.action.keys_template.replace(/\{path\}/g, tmp);
+        this.adapter.send_keys(keys);
+    }
+
+    private tryAdvancePicker(screen: string): void {
+        const picker = this.pickerInProgress;
+        if (!picker) return;
+        const action = picker.spec.action;
+        if (action.type !== 'open_picker') return;
+        const hay = sectionTextFromSnapshot(this.spec, screen, action.wait_for.section) ?? screen;
+        const re = new RegExp(action.wait_for.regex, action.wait_for.flags ?? 'i');
+        if (!re.test(hay)) return;
+        // Cue arrived — the dashboard now sees the picker modal via
+        // state_changed. We do NOT auto-submit; the dashboard must call
+        // click_modal_button(index). After the modal closes the picker
+        // tracking naturally clears the next time the screen settles.
+        this.pickerInProgress = null;
+    }
+
+    private handleExit(exitCode: number): void {
+        this.emit({ kind: 'exit', exit_code: exitCode });
+        this.shutdown();
+    }
+
+    private emit(ev: DashboardEvent): void {
+        for (const l of this.listeners) {
+            try { l(ev); } catch { /* listener side */ }
+        }
+    }
+}
+
+function shallowSameModal(a: SpecEvaluation, b: SpecEvaluation | null): boolean {
+    if (!b) return false;
+    if (!a.modal && !b.modal) return true;
+    if (!a.modal || !b.modal) return false;
+    if (a.modal.title !== b.modal.title) return false;
+    if (a.modal.buttons.length !== b.modal.buttons.length) return false;
+    for (let i = 0; i < a.modal.buttons.length; i += 1) {
+        if (a.modal.buttons[i].label !== b.modal.buttons[i].label) return false;
+    }
+    return true;
+}
+
+function shallowSameControls(a: SpecEvaluation, b: SpecEvaluation | null): boolean {
+    if (!b) return false;
+    if (a.controls.length !== b.controls.length) return false;
+    for (let i = 0; i < a.controls.length; i += 1) {
+        if (a.controls[i].id !== b.controls[i].id) return false;
+    }
+    return true;
+}
+
+function sectionTextFromSnapshot(spec: CliSpec, screen: string, sectionId: string | undefined): string | null {
+    if (!sectionId) return null;
+    const ev = evaluate(spec, screen);
+    return ev.sections.find(s => s.id === sectionId)?.text ?? null;
+}
+
+function guessExt(mime: string): string {
+    if (/png/i.test(mime)) return '.png';
+    if (/jpe?g/i.test(mime)) return '.jpg';
+    if (/gif/i.test(mime)) return '.gif';
+    if (/webp/i.test(mime)) return '.webp';
+    return '.bin';
+}