* feat(tui): make display.mouse_tracking pick which DEC modes to enable Previously the boolean flag was all-or-nothing across modes 1000+1002+1003+1006. Inside tmux, mode 1003 (any-motion) makes every mouse cross of the prompt row fire a clipboard probe that surfaces as "No image in clipboard" — sometimes dozens in a row. Disabling tracking entirely killed scroll-wheel scrolling too, since tmux's own scrollback is preempted by the alt-screen TUI. `display.mouse_tracking` (and `/mouse <preset>`) now accepts `off | wheel | buttons | all` in addition to the legacy booleans. `wheel` is 1000+1006: scroll wheel + click only, no drag, no hover — the tmux-friendly subset. `buttons` adds 1002 for drag-to-select. `all` (= legacy `true`) keeps the hover-driven UI (scrollbar paginate-on-hover, link mouseenter, etc.). * fix(tui): repaint + sync mouse mode when display.mouse_tracking changes Two interacting bugs left the TUI blank when `display.mouse_tracking` switched at runtime (config edit, /mouse <preset>): 1. AlternateScreen's effect re-runs on every `mouseTracking` change, tearing down and re-entering the alt screen. After re-entry, ink's frame buffers are reset by `resetFramesForAltScreen()` but nothing schedules the follow-up render — the alt screen sits blank until some other state change happens to trigger one. Add a `scheduleRender()` in `setAltScreenActive`'s active=true branch so the freshly-entered alt screen gets a full repaint immediately. 2. `setAltScreenActive` early-returns when `active` hasn't changed, which silently drops a `mouseTracking` change if the cleanup→setup pair somehow leaves `altScreenActive` already true. Call `setAltScreenMouseTracking` explicitly from the AlternateScreen effect so the in-memory mode and terminal DECSET sequence stay in sync regardless of how `setAltScreenActive` resolved (the call is a no-op when the mode is unchanged). * fix(tui): address copilot review #4341269705 - tui_gateway/server.py: drop the never-referenced _MOUSE_TRACKING_MODES frozenset (comment #3284802434). _MOUSE_TRACKING_ALIASES already centralizes the canonical preset set via its values; the separate constant added no behavior. - tests/test_tui_gateway_server.py: update the existing test_config_mouse_uses_documented_key_with_legacy_fallback to assert the new preset strings ('all'/'off' instead of 'on'/'off', display.mouse_tracking persisted as 'all' instead of True) and add test_config_mouse_accepts_preset_strings_and_aliases covering /mouse set with wheel/click/unknown (comment #3284802453). The on/off legacy config.set return shape was an implementation detail of the boolean flag, not a stable API — the slash command, gateway help text, and docs all advertise the preset values now. - ui-tui/packages/hermes-ink/src/ink/ink.tsx: schedule a render at the end of reenterAltScreen() (comment #3284802461). Mirrors the same fix in setAltScreenActive() from ece0a2f4c — without it, SIGCONT/resize self-heal/stdin-gap re-entry leaves the alt screen blank because every caller returns early after invoking us. * fix(tui): address copilot review #4341308478 round 2 - ui-tui/src/config/env.ts (comment #3284837577): the precedence comment was misleading. Actual behavior on origin/main is HERMES_TUI_MOUSE_TRACKING (explicit override) > Termux default > HERMES_TUI_DISABLE_MOUSE legacy kill-switch. This is preserved from main; the only change here was the wrong comment that claimed DISABLE_MOUSE kept kill-switch semantics. Rewrote the comment block to document the actual precedence ladder. - tui_gateway/server.py /mouse set (comment #3284837607): replaced 'str(value or "").strip().lower()' with the explicit None idiom already used for /indicator, so programmatic callers can pass 0 / False and have them route through _MOUSE_TRACKING_ALIASES → 'off' instead of collapsing to '' and triggering the toggle path. - ui-tui/packages/hermes-ink/src/ink/components/AlternateScreen.tsx (comment #3284837620): always prepend DISABLE_MOUSE_TRACKING before enableMouseTrackingFor(...) on mount. Otherwise selecting 'wheel'/'buttons' from a state where DEC 1003 was already asserted (crash, another app, debugger) would silently leave hover on. Also unconditionally DISABLE on unmount so a crash mid-mount can't leak DEC modes back to the host shell. * chore(release): map nat@nthrow.io to @nthrow for #26681 salvage * fix(tui): drop redundant setAltScreenMouseTracking in AlternateScreen Copilot review #4341356637 (comment #3284880417). The explicit setAltScreenMouseTracking(mouseTracking) after setAltScreenActive(true, mouseTracking) was defensive paranoia added in the previous fix commit that's not actually reachable in practice: - React's cleanup always runs before the next setup, so on any prop change (mouseTracking or writeRaw) the cleanup sets active=false first. Setup then sees active was false and applies the new mode via setAltScreenActive without early-returning. - On the impossible 'active stayed true' path, the writeRaw above has already sent DISABLE_MOUSE_TRACKING + enableMouseTrackingFor(newMode) to the terminal, so the in-memory mode would lag but the visible state is already correct. Removing the redundant call means a single DEC sequence per mount. If the 'active stayed true' path ever manifests in practice, the right fix is in setAltScreenActive (track mode regardless of the active early-return), not here. * fix(tui): always DISABLE before enableMouseTrackingFor in ink.tsx Copilot review #4341379994 (comments #3284900825, #3284900840, #3284900852). Three remaining call sites in ink.tsx still re-enabled mouse tracking without first sending DISABLE_MOUSE_TRACKING: - handleResize alt-screen recovery (line ~577) - reassertTerminalModes stdin-gap re-assertion (line ~1351) - reenterAltScreen SIGCONT/resize/stdin-gap self-heal (line ~1408) For 'wheel'/'buttons' presets, omitting DISABLE leaves any externally- asserted DEC 1003 (other apps, prior crash, tmux state) still active and the hover-free preset silently has hover on. DISABLE_MOUSE_TRACKING is idempotent and safe to send unconditionally — it resets all four modes. Matches the pattern already in setAltScreenMouseTracking and the AlternateScreen mount path. * fix(tui): always DISABLE before enableMouseTrackingFor in exitAlternateScreen Copilot review #4341452823 (comment #3284959762). exitAlternateScreen() was the last call site in ink.tsx still re-enabling mouse tracking without DISABLE first. Editors (vim/nvim/less) and tmux can leave DEC 1003 hover asserted across the handoff back; without DISABLE, 'wheel'/'buttons' presets silently kept hover on after the editor quit. Now all five enableMouseTrackingFor() call sites in ink.tsx prepend DISABLE_MOUSE_TRACKING — handleResize, reassertTerminalModes, reenterAltScreen, setAltScreenMouseTracking, exitAlternateScreen. * fix(tui): add defensive default to enableMouseTrackingFor switch Copilot review #4341485231 (comment #3284979323). TS exhaustive switch returns string per the type system, but a JS caller / corrupted config / hot-reload-in-dev could reach the function with an unknown value at runtime. Without a default, that path returns undefined which then concatenates as the literal string 'undefined' into the terminal byte stream — visibly garbling output. Treat unknown as 'off' (no DEC sequences) so the worst case is silent input loss rather than a wrecked screen. --------- Co-authored-by: Nat Thrower <nat@nthrow.io>
264 lines
8.1 KiB
TypeScript
264 lines
8.1 KiB
TypeScript
import type { MouseTrackingMode } from '@hermes/ink'
|
|
import { useEffect, useRef } from 'react'
|
|
|
|
import { resolveDetailsMode, resolveSections } from '../domain/details.js'
|
|
import type { GatewayClient } from '../gatewayClient.js'
|
|
import type {
|
|
ConfigFullResponse,
|
|
ConfigMtimeResponse,
|
|
ReloadMcpResponse
|
|
} from '../gatewayTypes.js'
|
|
import {
|
|
DEFAULT_VOICE_RECORD_KEY,
|
|
type ParsedVoiceRecordKey,
|
|
parseVoiceRecordKey
|
|
} from '../lib/platform.js'
|
|
import { asRpcResult } from '../lib/rpc.js'
|
|
|
|
import {
|
|
type BusyInputMode,
|
|
DEFAULT_INDICATOR_STYLE,
|
|
INDICATOR_STYLES,
|
|
type IndicatorStyle,
|
|
type StatusBarMode
|
|
} from './interfaces.js'
|
|
import { turnController } from './turnController.js'
|
|
import { patchUiState } from './uiStore.js'
|
|
|
|
const STATUSBAR_ALIAS: Record<string, StatusBarMode> = {
|
|
bottom: 'bottom',
|
|
off: 'off',
|
|
on: 'top',
|
|
top: 'top'
|
|
}
|
|
|
|
export const normalizeStatusBar = (raw: unknown): StatusBarMode =>
|
|
raw === false ? 'off' : typeof raw === 'string' ? (STATUSBAR_ALIAS[raw.trim().toLowerCase()] ?? 'top') : 'top'
|
|
|
|
const BUSY_MODES = new Set<BusyInputMode>(['interrupt', 'queue', 'steer'])
|
|
|
|
// TUI defaults to `queue` even though the framework default
|
|
// (`hermes_cli/config.py`) is `interrupt`. Rationale: in a full-screen
|
|
// TUI you're typically authoring the next prompt while the agent is
|
|
// still streaming, and an unintended interrupt loses work. Set
|
|
// `display.busy_input_mode: interrupt` (or `steer`) explicitly to
|
|
// opt out per-config; CLI / messaging adapters keep their `interrupt`
|
|
// default unchanged.
|
|
const TUI_BUSY_DEFAULT: BusyInputMode = 'queue'
|
|
|
|
export const normalizeBusyInputMode = (raw: unknown): BusyInputMode => {
|
|
if (typeof raw !== 'string') {
|
|
return TUI_BUSY_DEFAULT
|
|
}
|
|
|
|
const v = raw.trim().toLowerCase() as BusyInputMode
|
|
|
|
return BUSY_MODES.has(v) ? v : TUI_BUSY_DEFAULT
|
|
}
|
|
|
|
const INDICATOR_STYLE_SET: ReadonlySet<IndicatorStyle> = new Set(INDICATOR_STYLES)
|
|
|
|
export const normalizeIndicatorStyle = (raw: unknown): IndicatorStyle => {
|
|
if (typeof raw !== 'string') {
|
|
return DEFAULT_INDICATOR_STYLE
|
|
}
|
|
|
|
const v = raw.trim().toLowerCase() as IndicatorStyle
|
|
|
|
return INDICATOR_STYLE_SET.has(v) ? v : DEFAULT_INDICATOR_STYLE
|
|
}
|
|
|
|
const FALSEY_MOUSE = new Set(['0', 'false', 'no', 'off'])
|
|
const TRUTHY_MOUSE_ALL = new Set(['1', 'true', 'yes', 'on', 'all', 'full', 'any'])
|
|
const hasOwn = (obj: object, key: PropertyKey) => Object.prototype.hasOwnProperty.call(obj, key)
|
|
|
|
// `display.mouse_tracking` accepts boolean (`true` ⇒ all modes, `false` ⇒ off)
|
|
// for back-compat, plus the string presets `off|wheel|buttons|all` (aliases:
|
|
// `on`/`full`/`any`/`1`/`true`/... → `all`; `0`/`false`/`no`/`off` → `off`).
|
|
// `wheel` enables 1000+1006 — scroll wheel + click only, no drag or hover,
|
|
// which silences tmux's "No image in clipboard" spam over the prompt row.
|
|
// `buttons` adds 1002 so terminal-side text selection drags still register.
|
|
// Legacy `tui_mouse` is honored only if `mouse_tracking` is absent.
|
|
export const normalizeMouseTracking = (display: {
|
|
mouse_tracking?: unknown
|
|
tui_mouse?: unknown
|
|
}): MouseTrackingMode => {
|
|
const raw = hasOwn(display, 'mouse_tracking') ? display.mouse_tracking : display.tui_mouse
|
|
|
|
if (raw === false || raw === 0) {
|
|
return 'off'
|
|
}
|
|
|
|
if (raw === true || raw === undefined || raw === null) {
|
|
return 'all'
|
|
}
|
|
|
|
if (typeof raw === 'number') {
|
|
return 'all'
|
|
}
|
|
|
|
if (typeof raw !== 'string') {
|
|
return 'all'
|
|
}
|
|
|
|
const v = raw.trim().toLowerCase()
|
|
|
|
if (FALSEY_MOUSE.has(v)) {
|
|
return 'off'
|
|
}
|
|
|
|
if (TRUTHY_MOUSE_ALL.has(v)) {
|
|
return 'all'
|
|
}
|
|
|
|
if (v === 'wheel' || v === 'scroll') {
|
|
return 'wheel'
|
|
}
|
|
|
|
if (v === 'buttons' || v === 'button' || v === 'click') {
|
|
return 'buttons'
|
|
}
|
|
|
|
return 'all'
|
|
}
|
|
|
|
const MTIME_POLL_MS = 5000
|
|
|
|
const quietRpc = async <T extends Record<string, any> = Record<string, any>>(
|
|
gw: GatewayClient,
|
|
method: string,
|
|
params: Record<string, unknown> = {}
|
|
): Promise<null | T> => {
|
|
try {
|
|
return asRpcResult<T>(await gw.request<T>(method, params))
|
|
} catch {
|
|
return null
|
|
}
|
|
}
|
|
|
|
const _voiceRecordKeyFromConfig = (cfg: ConfigFullResponse | null): ParsedVoiceRecordKey => {
|
|
const raw = cfg?.config?.voice?.record_key
|
|
|
|
return raw ? parseVoiceRecordKey(raw) : DEFAULT_VOICE_RECORD_KEY
|
|
}
|
|
|
|
/** Fetch ``config.get full`` and fan the result through ``applyDisplay``.
|
|
*
|
|
* Extracted so the mtime-reload path can be exercised by the test
|
|
* suite without a React runtime (Copilot round-12 review on #19835).
|
|
* Both the initial hydration and the mtime poller use this shared
|
|
* helper, so a regression in the fetch/apply plumbing now fails the
|
|
* useConfigSync tests instead of only being visible at runtime. */
|
|
export async function hydrateFullConfig(
|
|
gw: GatewayClient,
|
|
setBell: (v: boolean) => void,
|
|
setVoiceRecordKey?: (v: ParsedVoiceRecordKey) => void
|
|
): Promise<ConfigFullResponse | null> {
|
|
const cfg = await quietRpc<ConfigFullResponse>(gw, 'config.get', { key: 'full' })
|
|
applyDisplay(cfg, setBell, setVoiceRecordKey)
|
|
|
|
return cfg
|
|
}
|
|
|
|
export const applyDisplay = (
|
|
cfg: ConfigFullResponse | null,
|
|
setBell: (v: boolean) => void,
|
|
setVoiceRecordKey?: (v: ParsedVoiceRecordKey) => void
|
|
) => {
|
|
const d = cfg?.config?.display ?? {}
|
|
|
|
setBell(!!d.bell_on_complete)
|
|
|
|
// Only push the voice record key when the RPC actually returned a
|
|
// config payload. ``quietRpc()`` collapses failures to ``null``; if we
|
|
// reset the cached shortcut on every null we would clobber a custom
|
|
// binding after one transient RPC error until the next config edit
|
|
// (Copilot round-8 review on #19835). The mtime-poll loop advances
|
|
// ``mtimeRef`` before this call, so staying silent on null preserves
|
|
// the last-good state and lets the next successful poll refresh it.
|
|
if (setVoiceRecordKey && cfg) {
|
|
setVoiceRecordKey(_voiceRecordKeyFromConfig(cfg))
|
|
}
|
|
|
|
patchUiState({
|
|
busyInputMode: normalizeBusyInputMode(d.busy_input_mode),
|
|
compact: !!d.tui_compact,
|
|
detailsMode: resolveDetailsMode(d),
|
|
detailsModeCommandOverride: false,
|
|
indicatorStyle: normalizeIndicatorStyle(d.tui_status_indicator),
|
|
inlineDiffs: d.inline_diffs !== false,
|
|
mouseTracking: normalizeMouseTracking(d),
|
|
sections: resolveSections(d.sections),
|
|
showCost: !!d.show_cost,
|
|
showReasoning: !!d.show_reasoning,
|
|
statusBar: normalizeStatusBar(d.tui_statusbar),
|
|
streaming: d.streaming !== false
|
|
})
|
|
}
|
|
|
|
export function useConfigSync({
|
|
gw,
|
|
setBellOnComplete,
|
|
setVoiceEnabled,
|
|
setVoiceRecordKey,
|
|
sid
|
|
}: UseConfigSyncOptions) {
|
|
const mtimeRef = useRef(0)
|
|
|
|
useEffect(() => {
|
|
if (!sid) {
|
|
return
|
|
}
|
|
|
|
// Keep startup cheap: voice.toggle status probes optional audio/STT deps and
|
|
// can run long enough to delay prompt.submit on the single stdio RPC pipe.
|
|
// Environment flags are enough to initialize the UI bit; the heavier status
|
|
// check still runs when the user opens /voice.
|
|
setVoiceEnabled(process.env.HERMES_VOICE === '1')
|
|
quietRpc<ConfigMtimeResponse>(gw, 'config.get', { key: 'mtime' }).then(r => {
|
|
mtimeRef.current = Number(r?.mtime ?? 0)
|
|
})
|
|
void hydrateFullConfig(gw, setBellOnComplete, setVoiceRecordKey)
|
|
}, [gw, setBellOnComplete, setVoiceEnabled, setVoiceRecordKey, sid])
|
|
|
|
useEffect(() => {
|
|
if (!sid) {
|
|
return
|
|
}
|
|
|
|
const id = setInterval(() => {
|
|
quietRpc<ConfigMtimeResponse>(gw, 'config.get', { key: 'mtime' }).then(r => {
|
|
const next = Number(r?.mtime ?? 0)
|
|
|
|
if (!mtimeRef.current) {
|
|
if (next) {
|
|
mtimeRef.current = next
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
if (!next || next === mtimeRef.current) {
|
|
return
|
|
}
|
|
|
|
mtimeRef.current = next
|
|
|
|
quietRpc<ReloadMcpResponse>(gw, 'reload.mcp', { session_id: sid, confirm: true }).then(
|
|
r => r && turnController.pushActivity('MCP reloaded after config change')
|
|
)
|
|
void hydrateFullConfig(gw, setBellOnComplete, setVoiceRecordKey)
|
|
})
|
|
}, MTIME_POLL_MS)
|
|
|
|
return () => clearInterval(id)
|
|
}, [gw, setBellOnComplete, setVoiceRecordKey, sid])
|
|
}
|
|
|
|
export interface UseConfigSyncOptions {
|
|
gw: GatewayClient
|
|
setBellOnComplete: (v: boolean) => void
|
|
setVoiceEnabled: (v: boolean) => void
|
|
setVoiceRecordKey?: (v: ParsedVoiceRecordKey) => void
|
|
sid: null | string
|
|
}
|