mirror of
https://github.com/stablyai/orca.git
synced 2026-09-27 16:02:35 +00:00
* feat(agents): add first-class ZCode harness Add ZCode (Z.ai's `zcode` CLI) as a supervised Orca agent: managed lifecycle hooks on local, SSH and Windows hosts; status, question and approval reporting; synthetic status titles; session resume; orchestration worker launch options; and desktop + mobile agent-picker registration. Written against the newly open-sourced `zai-org/ZCode` (agent CLI 0.16.9), not against a remembered screen: - ZCode's hook runner writes a Claude-compatible stdin alias set, so it routes through the existing Claude-compatible vendor path while keeping its own identity in the sidebar. - `PermissionRequest` fires only once the approval card is on screen and racing the user's answer, so it is proof the pane is blocked, not an auto-approval. - ZCode's clarification tool is literally `AskUserQuestion` with Claude's questions/options shape, so Orca's question card renders it unchanged. - ZCode's `hooks.enabled` defaults to false, which is why configured hooks were reported as never firing; the installer sets it. - ZCode renames its own process to `zcode-cli`, so the expected foreground process cannot be the launch command or dispatch refuses the pane. - ZCode emits no OSC title in any state and repaints its ASCII banner forever, so readiness comes from Orca's synthetic hook title and launch drafts wait on the composer box rather than on a quiet render window. Three files crossed their max-lines limit, so each is split along a real seam: command-line entrypoint parsing out of agent process recognition, skill classification out of skill root discovery, and registry coverage out of the remote hook installer tests. Refs #10564 * fix(zcode): drop the session-option catalog and pin the orchestration contract ZCode's CLI exposes no `--model` flag at all, and the session-option launch path refuses to apply any option until a model id is chosen. A catalog therefore could not deliver `--mode` per worker, and would have accepted `--model` only to drop it silently. Take opencode's position instead: no catalog, so `worker-start --model` is refused with a clear message and ZCode launches with the model from its own config. `--mode` stays reachable through agent args, which is also how the yolo default is applied. Add a contract test covering the parts that make ZCode a usable worker: dispatchable foreground process, stdin prompt delivery, the prompt staying out of the launch command, and the composer-gated draft paste. * refactor(zcode): reuse shared helpers and cut the harness down No behaviour change; every ZCode test still passes. - Use installer-utils' own `hookDefinitionHasManagedCommand` instead of re-walking a hook definition by hand, which also drops a local string reader. - Share one `readZCodeEventMap` instead of keeping the same narrowing in both hook-settings and hook-config-json. - Collapse five identical error returns into one `zcodeHookError` builder, and return early from the status branches instead of assigning through `let`. - Split the event-to-status decision out of `normalizeZCodeEvent` into a pure `readZCodeTurn`, so the normalizer reads as decide-then-build and stops computing the tool name for events that never look at it. - Take a script file name in `readManagedZCodeHookEvents` like its siblings, which removes a `Parameters<typeof …>` indirection at the call site. - Drop the unused `ZCodeHookEvent` export and inline a single-use path helper. - Correct a stale comment: ZCode's loader is a strict `JSON.parse`, so the in-place edit preserves key order and indentation, not comments. * fix(zcode): address review — keep unmanaged event keys, correct comment, de-dupe README - `removeZCodeManagedHooks` deleted any event key whose list ended up empty, so an unrelated `"Notification": []` the user wrote was removed as collateral whenever a managed hook elsewhere made the write happen. Only touch an event Orca actually owned something in; covered by a new regression test. - The `isNewTurnEvent` comment claimed UserPromptSubmit was ZCode's only turn boundary while the expression below it also returned true for SessionStart. Say what the code does: SessionStart lands the idle boundary, UserPromptSubmit is the turn boundary (the Codex/Claude shape). - ZCode appeared twice in the README's single agent-badge block; keep the local-icon entry the link checker validates and drop the favicon duplicate. * docs(zcode): call out that the desktop bundle's CLI cannot open a session From live testing on #22464: pointing `zcode` at the desktop app's bundled `glm/zcode.cjs` installs Orca's hooks fine but then fails with `Cannot find package '@zcode/tui'`, so the pane never opens a session. The symptom reads as a broken harness when the CLI simply has no TUI. Say which build to use and how to check before reporting a problem. Reported-by: JWu527
276 lines
13 KiB
TypeScript
276 lines
13 KiB
TypeScript
import type { DraftPasteReadySignal } from './tui-agent-config'
|
||
|
||
// Why: agents enable bracketed paste (DECSET 2004) before their composer is
|
||
// actually mounted/focused. These markers let the scanner detect the real
|
||
// "input is ready" moment per agent instead of guessing from output silence.
|
||
const DECSET_BRACKETED_PASTE = '\x1b[?2004h'
|
||
const CODEX_COMPOSER_PROMPT = '›'
|
||
// Why: opencode emits the DECTCEM show-cursor only once the composer row is
|
||
// mounted and the text cursor is placed in it — a "composer ready" signal,
|
||
// analogous to Codex's prompt glyph. It fires ~2s after bracketed paste is
|
||
// enabled, so gating on it (instead of a quiet window) stops the paste from
|
||
// racing the composer mount under slow/noisy startup. mimo-code uses the same
|
||
// signal by parity; the quiet-window fallback covers any agent that differs.
|
||
const DECTCEM_SHOW_CURSOR = '\x1b[?25h'
|
||
// Why: grok's composer prompt glyph (U+276F), rendered once the input box
|
||
// mounts. It is also the default glyph of popular shell prompts (starship,
|
||
// pure), so it is anchored on the alternate-screen switch below — the shell
|
||
// prompt that precedes the launch command is always in the normal buffer.
|
||
// grok swaps it for `> ` on legacy Windows consoles, which is too generic to
|
||
// match; those fall back to the quiet window and the caller's hard timeout.
|
||
const GROK_COMPOSER_PROMPT = '❯'
|
||
// Why: ZCode's composer box top-left corner (U+256D), painted once the input box mounts.
|
||
// It is locale-independent — ZCode translates the placeholder and the mode label in the
|
||
// box title, but not the frame — and its modal dialogs draw SQUARE corners, so this glyph
|
||
// means the composer specifically. Anchored on the alternate-screen switch for the same
|
||
// reason as grok: a powerline shell prompt can also draw `╭`.
|
||
const ZCODE_COMPOSER_BOX_CORNER = '╭'
|
||
const DECSET_ALT_SCREEN = '\x1b[?1049h'
|
||
const DECRST_ALT_SCREEN = '\x1b[?1049l'
|
||
|
||
type DraftPasteReadySignalSpec = {
|
||
/** Bytes that must precede `marker` for it to count; null when there is no marker. */
|
||
markerAnchor: string | null
|
||
/** Bytes that revoke `markerAnchor` again, for anchors that describe a mode the agent can leave. */
|
||
markerAnchorEnd: string | null
|
||
/** Composer-ready marker, or null for signals that only use the quiet window. */
|
||
marker: string | null
|
||
/** Bytes that arm the quiet-window fallback, or null when the signal has none. */
|
||
quietAnchor: string | null
|
||
}
|
||
|
||
const DRAFT_PASTE_READY_SIGNALS: Record<DraftPasteReadySignal, DraftPasteReadySignalSpec> = {
|
||
'codex-composer-prompt': {
|
||
markerAnchor: DECSET_BRACKETED_PASTE,
|
||
markerAnchorEnd: null,
|
||
marker: CODEX_COMPOSER_PROMPT,
|
||
quietAnchor: null
|
||
},
|
||
'render-cursor-after-bracketed-paste': {
|
||
markerAnchor: DECSET_BRACKETED_PASTE,
|
||
markerAnchorEnd: null,
|
||
marker: DECTCEM_SHOW_CURSOR,
|
||
quietAnchor: null
|
||
},
|
||
'grok-composer-prompt': {
|
||
markerAnchor: DECSET_ALT_SCREEN,
|
||
// Why: leaving the alternate screen hands the terminal back to the shell, whose
|
||
// prompt may be `❯`. Without revoking the anchor, a grok that entered the alt
|
||
// screen and then died — or a pager run from the user's shell rc before grok even
|
||
// launched — would leave the glyph armed forever and paste into the shell.
|
||
markerAnchorEnd: DECRST_ALT_SCREEN,
|
||
marker: GROK_COMPOSER_PROMPT,
|
||
// Why: the quiet window stays on DECSET 2004, independent of the alt-screen
|
||
// marker anchor. grok can be configured to render inline (`--no-alt-screen`,
|
||
// `[ui] screen_mode = "minimal"`), where 1049h never arrives — anchoring the
|
||
// fallback there too would leave the draft with no delivery path at all, and
|
||
// the main-process caller drops the draft when readiness never resolves.
|
||
quietAnchor: DECSET_BRACKETED_PASTE
|
||
},
|
||
'zcode-composer-prompt': {
|
||
markerAnchor: DECSET_ALT_SCREEN,
|
||
markerAnchorEnd: DECRST_ALT_SCREEN,
|
||
marker: ZCODE_COMPOSER_BOX_CORNER,
|
||
// Why: ZCode animates its ASCII banner forever, so the quiet window never settles on
|
||
// its own — but keep it armed as the floor for a build that renders inline and never
|
||
// switches to the alternate screen, where the marker anchor would never arm.
|
||
quietAnchor: DECSET_BRACKETED_PASTE
|
||
},
|
||
'render-quiet-after-bracketed-paste': {
|
||
markerAnchor: null,
|
||
markerAnchorEnd: null,
|
||
marker: null,
|
||
quietAnchor: DECSET_BRACKETED_PASTE
|
||
}
|
||
}
|
||
|
||
/** Longest anchor sequence minus one — the carry needed to rejoin one split across chunks. */
|
||
const ANCHOR_CARRY_CHARS = 7
|
||
|
||
export type DraftPasteReadyScanResult = {
|
||
/** The agent-specific ready signal fired — caller should deliver the paste now. */
|
||
ready: boolean
|
||
/** Caller should (re)arm the quiet-window fallback timer for this chunk. */
|
||
armQuietTimer: boolean
|
||
}
|
||
|
||
/**
|
||
* Pure, incremental scanner shared by the renderer and main-process draft-paste
|
||
* readiness waiters so the two delivery paths (desktop-local vs runtime/SSH/
|
||
* remote) cannot drift. It only parses the PTY byte stream; timers, the PTY
|
||
* subscription, and resolution stay with each caller because their transports
|
||
* and return types differ.
|
||
*
|
||
* Per agent signal:
|
||
* - `codex-composer-prompt`: ready when the `›` glyph renders after DECSET
|
||
* 2004, or when DECSET follows a glyph rendered while Codex owns the
|
||
* alternate screen; never arms the quiet window.
|
||
* - `render-cursor-after-bracketed-paste`: ready when DECTCEM show-cursor
|
||
* (`\x1b[?25h`) renders after DECSET 2004. Like Codex it does NOT arm the
|
||
* quiet window: opencode stays silent for ~1.5-2s between enabling
|
||
* bracketed paste and mounting its composer, so a quiet window would fire
|
||
* during that gap and pre-empt the marker. opencode re-emits show-cursor on
|
||
* every render frame once mounted, so the marker is effectively guaranteed;
|
||
* the caller's hard timeout is the backstop if it never appears.
|
||
* - `grok-composer-prompt`: ready when grok's `❯` glyph renders after the
|
||
* alternate-screen switch (`\x1b[?1049h`). grok shimmers its startup logo
|
||
* until the session opens, so the quiet window alone never settles and the
|
||
* draft waited out the full hard timeout (~8s). The glyph is anchored on the
|
||
* alt-screen switch rather than DECSET 2004 because the shell that runs the
|
||
* launch command emits 2004 too and its own prompt may be `❯` (starship,
|
||
* pure) — anchoring there could paste into the shell. This is the only
|
||
* signal with both a marker and a quiet window, and they use DIFFERENT
|
||
* anchors: grok can render inline (`--no-alt-screen`, `[ui] screen_mode =
|
||
* "minimal"`) and on legacy Windows consoles draws `> ` instead of `❯`, so
|
||
* the marker is best-effort and the 2004-anchored quiet window is the floor
|
||
* that keeps those launches on the pre-existing delivery path. The alt-screen
|
||
* anchor is revoked on `\x1b[?1049l`: leaving it hands the terminal back to
|
||
* the shell, so a glyph after that is the shell's prompt, not grok's composer.
|
||
* - `zcode-composer-prompt`: ready when ZCode's composer box corner (`╭`) renders
|
||
* after the alternate-screen switch. ZCode repaints its animated ASCII banner
|
||
* indefinitely — the captured transcript is still repainting 30s after the composer
|
||
* mounted — so the quiet window alone never settles and a launch draft would wait out
|
||
* the whole hard timeout, exactly as grok did. Same alt-screen anchoring and
|
||
* revocation as grok, because a powerline shell prompt can draw `╭` too.
|
||
* - `render-quiet-after-bracketed-paste` (default): no signal marker; arms the
|
||
* quiet window once DECSET 2004 is seen.
|
||
*
|
||
* A 512-byte ring (`recent` / `postAnchorRecent`) covers escape sequences
|
||
* split across chunk boundaries without retaining terminal scrollback.
|
||
*/
|
||
export function createDraftPasteReadyScanner(readySignal: DraftPasteReadySignal): {
|
||
observe: (data: string) => DraftPasteReadyScanResult
|
||
} {
|
||
let recent = ''
|
||
let postAnchorRecent = ''
|
||
let anchorCarry = ''
|
||
let codexCarry = ''
|
||
let sawMarkerAnchor = false
|
||
let sawQuietAnchor = false
|
||
let codexAltScreen = false
|
||
let sawCodexPromptInAltScreen = false
|
||
|
||
const {
|
||
markerAnchor,
|
||
markerAnchorEnd,
|
||
marker: signalMarker,
|
||
quietAnchor
|
||
} = DRAFT_PASTE_READY_SIGNALS[readySignal]
|
||
|
||
/**
|
||
* Why: an anchor the agent can leave (the alternate screen) has to be tracked in
|
||
* stream ORDER, not as "seen once". Walk the chunk segment by segment so a marker
|
||
* only counts while the anchor is actually held, and re-entering re-arms it.
|
||
* Only reachable for signals that define `markerAnchorEnd`.
|
||
*/
|
||
const scanRevocableAnchorSegments = (window: string, anchor: string, end: string): boolean => {
|
||
let cursor = 0
|
||
while (cursor < window.length) {
|
||
if (!sawMarkerAnchor) {
|
||
const enterIndex = window.indexOf(anchor, cursor)
|
||
if (enterIndex === -1) {
|
||
return false
|
||
}
|
||
sawMarkerAnchor = true
|
||
postAnchorRecent = ''
|
||
cursor = enterIndex + anchor.length
|
||
continue
|
||
}
|
||
const leaveIndex = window.indexOf(end, cursor)
|
||
const segment = leaveIndex === -1 ? window.slice(cursor) : window.slice(cursor, leaveIndex)
|
||
if ((postAnchorRecent + segment).includes(signalMarker ?? '')) {
|
||
return true
|
||
}
|
||
if (leaveIndex === -1) {
|
||
postAnchorRecent = (postAnchorRecent + segment).slice(-512)
|
||
return false
|
||
}
|
||
sawMarkerAnchor = false
|
||
postAnchorRecent = ''
|
||
cursor = leaveIndex + end.length
|
||
}
|
||
return false
|
||
}
|
||
|
||
const scanCodexPreAnchorPrompt = (data: string): void => {
|
||
const window = codexCarry + data
|
||
codexCarry = window.slice(-ANCHOR_CARRY_CHARS)
|
||
let cursor = 0
|
||
while (cursor < window.length) {
|
||
const enterIndex = window.indexOf(DECSET_ALT_SCREEN, cursor)
|
||
const leaveIndex = window.indexOf(DECRST_ALT_SCREEN, cursor)
|
||
const promptIndex = window.indexOf(CODEX_COMPOSER_PROMPT, cursor)
|
||
const nextIndex = Math.min(
|
||
...[enterIndex, leaveIndex, promptIndex].filter((index) => index !== -1)
|
||
)
|
||
if (!Number.isFinite(nextIndex)) {
|
||
return
|
||
}
|
||
if (nextIndex === enterIndex) {
|
||
codexAltScreen = true
|
||
sawCodexPromptInAltScreen = false
|
||
cursor = nextIndex + DECSET_ALT_SCREEN.length
|
||
} else if (nextIndex === leaveIndex) {
|
||
codexAltScreen = false
|
||
sawCodexPromptInAltScreen = false
|
||
cursor = nextIndex + DECRST_ALT_SCREEN.length
|
||
} else {
|
||
if (codexAltScreen) {
|
||
sawCodexPromptInAltScreen = true
|
||
}
|
||
cursor = nextIndex + CODEX_COMPOSER_PROMPT.length
|
||
}
|
||
}
|
||
}
|
||
|
||
return {
|
||
observe(data: string): DraftPasteReadyScanResult {
|
||
const combined = recent + data
|
||
recent = combined.slice(-512)
|
||
if (!sawQuietAnchor && quietAnchor !== null && combined.includes(quietAnchor)) {
|
||
sawQuietAnchor = true
|
||
}
|
||
if (readySignal === 'codex-composer-prompt' && !sawMarkerAnchor) {
|
||
scanCodexPreAnchorPrompt(data)
|
||
}
|
||
if (signalMarker !== null && markerAnchor !== null) {
|
||
if (markerAnchorEnd !== null) {
|
||
// Why: carry only the bytes an anchor could straddle, so already-scanned
|
||
// output is never re-walked into a second enter/leave transition.
|
||
const window = anchorCarry + data
|
||
anchorCarry = window.slice(-ANCHOR_CARRY_CHARS)
|
||
if (scanRevocableAnchorSegments(window, markerAnchor, markerAnchorEnd)) {
|
||
return { ready: true, armQuietTimer: false }
|
||
}
|
||
} else if (!sawMarkerAnchor) {
|
||
const anchorIndex = combined.indexOf(markerAnchor)
|
||
if (anchorIndex !== -1) {
|
||
sawMarkerAnchor = true
|
||
if (readySignal === 'codex-composer-prompt' && sawCodexPromptInAltScreen) {
|
||
return { ready: true, armQuietTimer: false }
|
||
}
|
||
const postAnchorChunk = combined.slice(anchorIndex + markerAnchor.length)
|
||
if (postAnchorChunk.includes(signalMarker)) {
|
||
return { ready: true, armQuietTimer: false }
|
||
}
|
||
postAnchorRecent = postAnchorChunk.slice(-512)
|
||
}
|
||
} else {
|
||
if (data.includes(signalMarker) || (postAnchorRecent + data).includes(signalMarker)) {
|
||
return { ready: true, armQuietTimer: false }
|
||
}
|
||
postAnchorRecent = (postAnchorRecent + data).slice(-512)
|
||
}
|
||
}
|
||
// Why: the Codex glyph and opencode show-cursor signals must NOT arm the
|
||
// quiet window (they carry no quiet anchor). opencode goes silent for
|
||
// ~1.5-2s between enabling bracketed paste and mounting its composer, so a
|
||
// quiet window would fire during that gap — before the composer exists —
|
||
// and pre-empt the marker. Those signals wait for their marker, bounded
|
||
// only by the caller's hard timeout (and its best-effort
|
||
// process-ownership paste after that).
|
||
return { ready: false, armQuietTimer: sawQuietAnchor }
|
||
}
|
||
}
|
||
}
|