mirror of
https://github.com/stablyai/orca.git
synced 2026-10-02 00:02:05 +00:00
* feat(agents): pi session resume support
* fix(pi): require persisted session files for resume
* test(sleeping-agent): use non-resumable sentinel in malformed-record fixture
The 'drops malformed sleeping agent resume records' test used agent:'pi' as
its example of an unknown/non-resumable agent, expecting the record to be
dropped. This PR added 'pi' to RESUMABLE_TUI_AGENTS, making that fixture
valid and retained, so the toBeUndefined assertion broke. Switch the
malformed-case fixture to a genuinely non-resumable sentinel
('definitely-not-an-agent') so the drop-malformed path is still exercised;
no other assertions changed.
* Add durable resume identity for Pi sessions without fabricating turn sta
Pi's `session_start` hook now carries the session file needed to resume
a sleeping pane, but until now Orca either discarded it or treated it
as a fake status transition. Thread a `providerSessionOnly` envelope
through the hook listener, relay, main-process server, and renderer
store so resume identity (and its session-file-scoped equality/claim
key) can be persisted and replayed without emitting prompt telemetry
or a visible working/done row.
* Add durable resume identity for completed Pi sessions
Pi's agent_end hook marks a turn done, but the underlying TUI session
stays alive and resumable. Previously a `done` status wiped sleeping
records and launch config as if the session ended, so hibernation,
manual worktree sleep, and quit-capture all lost Pi's resume identity.
- Track a "live recovery" record for done-but-still-resumable Pi
sessions, exempting it from the usual done-state cleanup paths in
agent-status.ts and agent-hibernation-planner.ts
- Gate providerSessionOnly rows and sleeping-agent schema records on
actual resumability (getAgentResumeArgv) instead of trusting the
presence of a provider session
- Wait for Pi to persist its session file before advertising resume
metadata, and treat `/reload` as a non-terminal event so it doesn't
clobber visible status
- Extend SSH relay envelopes to carry providerSessionOnly so remote
hosts get the same behavior
* Add explicit periodic/quit mode to sleeping-agent session capture
Split captureAllSleepingAgentSessions into 'periodic' and 'quit' modes
so a background checkpoint can no longer downgrade a confirmed-quit
record or promote a completed Pi session without an authoritative
transcript path. Updates all call sites and tests accordingly.
* Use normalizeAgentStatusPayload for default pi status
Remove unnecessary JSON.stringify wrapper and call the appropriate normalization function directly.
---------
Co-authored-by: Jinjing <6427696+AmethystLiang@users.noreply.github.com>
255 lines
8.4 KiB
TypeScript
255 lines
8.4 KiB
TypeScript
import type { AgentHookSource } from './agent-hook-relay'
|
|
import type { AgentStatusState } from './agent-status-types'
|
|
import type { TuiAgent } from './types'
|
|
|
|
export const RESUMABLE_TUI_AGENTS = [
|
|
'claude',
|
|
'codex',
|
|
'gemini',
|
|
'antigravity',
|
|
'opencode',
|
|
'pi',
|
|
'mimo-code',
|
|
'droid',
|
|
'grok',
|
|
'devin'
|
|
] as const satisfies readonly TuiAgent[]
|
|
|
|
export type ResumableTuiAgent = (typeof RESUMABLE_TUI_AGENTS)[number]
|
|
|
|
export type AgentProviderSessionKey = 'session_id' | 'conversation_id'
|
|
|
|
export type AgentProviderSessionMetadata = {
|
|
key: AgentProviderSessionKey
|
|
id: string
|
|
/** Authoritative on-disk transcript/rollout path reported by the agent's hook
|
|
* (Claude/Codex `transcript_path`), when available. Native chat reads this
|
|
* directly because recent Claude Code versions name the transcript file with a
|
|
* UUID that differs from the hook `session_id`, so reconstructing the path from
|
|
* `id` alone fails. Claude/Codex still resume by id; Pi uses its reported
|
|
* `session_file` as the authoritative `--session` resume locator. */
|
|
transcriptPath?: string
|
|
}
|
|
|
|
export type SleepingAgentLaunchConfig = {
|
|
agentCommand?: string
|
|
agentArgs: string
|
|
agentEnv: Record<string, string>
|
|
}
|
|
|
|
export type SleepingAgentSessionRecord = {
|
|
paneKey: string
|
|
tabId?: string
|
|
worktreeId: string
|
|
agent: ResumableTuiAgent
|
|
providerSession: AgentProviderSessionMetadata
|
|
prompt: string
|
|
state: AgentStatusState
|
|
capturedAt: number
|
|
updatedAt: number
|
|
terminalTitle?: string
|
|
lastAssistantMessage?: string
|
|
interrupted?: boolean
|
|
connectionId?: string | null
|
|
launchConfig?: SleepingAgentLaunchConfig
|
|
/** How the record was captured. Worktree-sleep records (legacy records have
|
|
* no origin) are consumed by worktree activation, which opens a fresh tab.
|
|
* Quit/live records describe panes that still exist in the restored session,
|
|
* so only the pane's own cold-restore path may consume them — activation
|
|
* launching a tab too would duplicate a warm-reattached session (#5232). */
|
|
origin?: 'worktree-sleep' | 'quit' | 'live'
|
|
}
|
|
|
|
const RESUMABLE_TUI_AGENT_SET: ReadonlySet<string> = new Set(RESUMABLE_TUI_AGENTS)
|
|
const PROVIDER_SESSION_ID_MAX_LENGTH = 512
|
|
|
|
export function hasUnsafeProviderSessionIdChars(value: string): boolean {
|
|
for (let i = 0; i < value.length; i += 1) {
|
|
const code = value.charCodeAt(i)
|
|
if (code <= 0x1f || code === 0x7f) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
function normalizeSessionId(value: unknown): string | null {
|
|
if (typeof value !== 'string') {
|
|
return null
|
|
}
|
|
const trimmed = value.trim()
|
|
if (
|
|
trimmed.length === 0 ||
|
|
trimmed.length > PROVIDER_SESSION_ID_MAX_LENGTH ||
|
|
trimmed.startsWith('-') ||
|
|
hasUnsafeProviderSessionIdChars(trimmed)
|
|
) {
|
|
return null
|
|
}
|
|
return trimmed
|
|
}
|
|
|
|
function readSessionId(record: Record<string, unknown>, keys: readonly string[]): string | null {
|
|
for (const key of keys) {
|
|
const normalized = normalizeSessionId(record[key])
|
|
if (normalized) {
|
|
return normalized
|
|
}
|
|
}
|
|
return null
|
|
}
|
|
|
|
/** The agent hook's authoritative transcript/rollout path, when present. Used by
|
|
* native chat to read the exact file rather than reconstructing it from the
|
|
* session id (which recent Claude Code no longer matches to the file name). */
|
|
function readTranscriptPathFromKeys(
|
|
record: Record<string, unknown>,
|
|
keys: readonly string[]
|
|
): string | undefined {
|
|
for (const key of keys) {
|
|
const raw = record[key]
|
|
if (typeof raw !== 'string') {
|
|
continue
|
|
}
|
|
const trimmed = raw.trim()
|
|
if (trimmed && !hasUnsafeProviderSessionIdChars(trimmed)) {
|
|
return trimmed
|
|
}
|
|
}
|
|
return undefined
|
|
}
|
|
|
|
function withTranscriptPath(
|
|
metadata: AgentProviderSessionMetadata,
|
|
payload: Record<string, unknown>,
|
|
keys: readonly string[] = ['transcript_path', 'transcriptPath']
|
|
): AgentProviderSessionMetadata {
|
|
const transcriptPath = readTranscriptPathFromKeys(payload, keys)
|
|
return transcriptPath ? { ...metadata, transcriptPath } : metadata
|
|
}
|
|
|
|
export function isResumableTuiAgent(value: unknown): value is ResumableTuiAgent {
|
|
return typeof value === 'string' && RESUMABLE_TUI_AGENT_SET.has(value)
|
|
}
|
|
|
|
export function normalizeAgentProviderSession(raw: unknown): AgentProviderSessionMetadata | null {
|
|
if (typeof raw !== 'object' || raw === null) {
|
|
return null
|
|
}
|
|
const record = raw as Record<string, unknown>
|
|
const key = record.key
|
|
if (key !== 'session_id' && key !== 'conversation_id') {
|
|
return null
|
|
}
|
|
const id = normalizeSessionId(record.id)
|
|
if (!id) {
|
|
return null
|
|
}
|
|
// Why: persisted/relay metadata crosses a trust boundary too; apply the same
|
|
// control-character rejection used for hook-reported transcript paths.
|
|
const transcriptPath = readTranscriptPathFromKeys(record, ['transcriptPath'])
|
|
return transcriptPath ? { key, id, transcriptPath } : { key, id }
|
|
}
|
|
|
|
/** Compare the provider-owned values that identify the CLI resume target.
|
|
* Pi's file path is identity; other agents resume by their provider id. */
|
|
export function agentProviderSessionsEqual(
|
|
agent: string | undefined,
|
|
left: AgentProviderSessionMetadata | undefined,
|
|
right: AgentProviderSessionMetadata | undefined
|
|
): boolean {
|
|
if (left === undefined || right === undefined) {
|
|
return left === right
|
|
}
|
|
return (
|
|
left.key === right.key &&
|
|
left.id === right.id &&
|
|
(agent !== 'pi' || left.transcriptPath === right.transcriptPath)
|
|
)
|
|
}
|
|
|
|
export function extractAgentProviderSession(
|
|
source: AgentHookSource,
|
|
payload: Record<string, unknown>
|
|
): AgentProviderSessionMetadata | null {
|
|
switch (source) {
|
|
// Native-chat agents: also capture the hook's authoritative transcript_path,
|
|
// since recent Claude Code names the transcript file with a UUID that differs
|
|
// from the hook session_id (so the id-based glob no longer finds it).
|
|
case 'claude':
|
|
case 'codex': {
|
|
const id = readSessionId(payload, ['session_id'])
|
|
return id ? withTranscriptPath({ key: 'session_id', id }, payload) : null
|
|
}
|
|
case 'gemini':
|
|
case 'droid':
|
|
// Why: Kimi Code posts a Claude-shaped `session_id` (e.g. session_<uuid>).
|
|
case 'kimi': {
|
|
const id = readSessionId(payload, ['session_id'])
|
|
return id ? { key: 'session_id', id } : null
|
|
}
|
|
case 'antigravity': {
|
|
const id = readSessionId(payload, ['conversationId'])
|
|
return id ? { key: 'conversation_id', id } : null
|
|
}
|
|
case 'opencode':
|
|
case 'mimo-code': {
|
|
const id = readSessionId(payload, ['sessionID'])
|
|
return id ? { key: 'session_id', id } : null
|
|
}
|
|
case 'pi': {
|
|
const id = readSessionId(payload, ['session_id'])
|
|
const providerSession = id
|
|
? withTranscriptPath({ key: 'session_id', id }, payload, ['session_file'])
|
|
: null
|
|
return providerSession?.transcriptPath ? providerSession : null
|
|
}
|
|
case 'grok': {
|
|
const id = readSessionId(payload, ['sessionId', 'session_id'])
|
|
return id ? { key: 'session_id', id } : null
|
|
}
|
|
case 'devin': {
|
|
const id = readSessionId(payload, ['session_id', 'sessionId'])
|
|
return id ? { key: 'session_id', id } : null
|
|
}
|
|
case 'amp':
|
|
case 'cursor':
|
|
case 'omp':
|
|
case 'command-code':
|
|
case 'copilot':
|
|
case 'hermes':
|
|
return null
|
|
}
|
|
}
|
|
|
|
export function getAgentResumeArgv(
|
|
agent: ResumableTuiAgent,
|
|
providerSession: AgentProviderSessionMetadata
|
|
): string[] | null {
|
|
const id = providerSession.id
|
|
switch (agent) {
|
|
case 'claude':
|
|
return providerSession.key === 'session_id' ? ['claude', '--resume', id] : null
|
|
case 'codex':
|
|
return providerSession.key === 'session_id' ? ['codex', 'resume', id] : null
|
|
case 'gemini':
|
|
return providerSession.key === 'session_id' ? ['gemini', '--resume', id] : null
|
|
case 'antigravity':
|
|
return providerSession.key === 'conversation_id' ? ['agy', '--conversation', id] : null
|
|
case 'opencode':
|
|
return providerSession.key === 'session_id' ? ['opencode', '--session', id] : null
|
|
case 'pi':
|
|
return providerSession.key === 'session_id' && providerSession.transcriptPath
|
|
? ['pi', '--session', providerSession.transcriptPath]
|
|
: null
|
|
case 'mimo-code':
|
|
return providerSession.key === 'session_id' ? ['mimo', '--session', id] : null
|
|
case 'droid':
|
|
return providerSession.key === 'session_id' ? ['droid', '--resume', id] : null
|
|
case 'grok':
|
|
return providerSession.key === 'session_id' ? ['grok', '--resume', id] : null
|
|
case 'devin':
|
|
return providerSession.key === 'session_id' ? ['devin', '--resume', id] : null
|
|
}
|
|
}
|