"""Codex app-server JSON-RPC client. Speaks the protocol documented in codex-rs/app-server/README.md (codex 0.125+). Transport is newline-delimited JSON-RPC 2.0 over stdio: spawn `codex app-server`, do an `initialize` handshake, then drive `thread/start` + `turn/start` and consume streaming `item/*` notifications until `turn/completed`. This module is the wire-level speaker only. Higher-level concerns (event projection into Hermes' display, approval bridging, transcript projection into AIAgent.messages, plugin migration) live in sibling modules. Status: optional opt-in runtime gated behind `model.openai_runtime == "codex_app_server"`. Hermes' default tool dispatch is unchanged when this runtime is not selected. """ from __future__ import annotations import json import os import queue import subprocess import threading import time from dataclasses import dataclass, field from typing import Any, Callable, Optional # Default minimum codex version we test against. The PR sets this from the # `codex --version` parsed at install time; bumping is a one-line change here. MIN_CODEX_VERSION = (0, 125, 0) @dataclass class CodexAppServerError(RuntimeError): """Raised on JSON-RPC errors from the app-server.""" code: int message: str data: Optional[Any] = None def __str__(self) -> str: # pragma: no cover - trivial return f"codex app-server error {self.code}: {self.message}" @dataclass class _Pending: queue: queue.Queue method: str sent_at: float = field(default_factory=time.time) class CodexAppServerClient: """Minimal JSON-RPC 2.0 client for `codex app-server` over stdio. Threading model: - Spawning thread (caller) drives request/response pairs synchronously. - One reader thread parses stdout, dispatches replies to the right pending future, and routes notifications + server-initiated requests to bounded queues that the caller drains on their own cadence. - One reader thread captures stderr for diagnostics; codex emits tracing logs there at RUST_LOG-controlled levels. Intentionally NOT async. AIAgent.run_conversation() is synchronous and runs on the main thread; layering asyncio just to drive a stdio child creates surprising interrupt semantics. We use blocking queues with timeouts and rely on `turn/interrupt` for cancellation. """ def __init__( self, codex_bin: str = "codex", codex_home: Optional[str] = None, extra_args: Optional[list[str]] = None, env: Optional[dict[str, str]] = None, ) -> None: self._codex_bin = codex_bin cmd = [codex_bin, "app-server"] + list(extra_args or []) spawn_env = os.environ.copy() if env: spawn_env.update(env) if codex_home: spawn_env["CODEX_HOME"] = codex_home # Codex emits tracing to stderr; default WARN keeps it quiet for users. spawn_env.setdefault("RUST_LOG", "warn") self._proc = subprocess.Popen( cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, bufsize=0, env=spawn_env, ) self._next_id = 1 self._pending: dict[int, _Pending] = {} self._pending_lock = threading.Lock() self._notifications: queue.Queue = queue.Queue() self._server_requests: queue.Queue = queue.Queue() self._stderr_lines: list[str] = [] self._stderr_lock = threading.Lock() self._closed = False self._initialized = False self._reader = threading.Thread(target=self._read_stdout, daemon=True) self._reader.start() self._stderr_reader = threading.Thread(target=self._read_stderr, daemon=True) self._stderr_reader.start() # ---------- lifecycle ---------- def initialize( self, client_name: str = "hermes", client_title: str = "Hermes Agent", client_version: str = "0.1", capabilities: Optional[dict] = None, timeout: float = 10.0, ) -> dict: """Send `initialize` + `initialized` handshake. Returns the server's InitializeResponse (userAgent, codexHome, platformFamily, platformOs).""" if self._initialized: raise RuntimeError("already initialized") params = { "clientInfo": { "name": client_name, "title": client_title, "version": client_version, }, "capabilities": capabilities or {}, } result = self.request("initialize", params, timeout=timeout) self.notify("initialized") self._initialized = True return result def close(self, timeout: float = 3.0) -> None: """Close stdin and wait for the subprocess to exit, escalating to kill.""" if self._closed: return self._closed = True try: if self._proc.stdin and not self._proc.stdin.closed: self._proc.stdin.close() except Exception: pass try: self._proc.terminate() self._proc.wait(timeout=timeout) except subprocess.TimeoutExpired: try: self._proc.kill() self._proc.wait(timeout=1.0) except Exception: pass def __enter__(self) -> "CodexAppServerClient": return self def __exit__(self, *exc: Any) -> None: self.close() # ---------- send/receive ---------- def request( self, method: str, params: Optional[dict] = None, timeout: float = 30.0, ) -> dict: """Send a JSON-RPC request and block on the response. Returns `result`, raises CodexAppServerError on `error`.""" rid = self._take_id() q: queue.Queue = queue.Queue(maxsize=1) with self._pending_lock: self._pending[rid] = _Pending(queue=q, method=method) self._send({"id": rid, "method": method, "params": params or {}}) try: msg = q.get(timeout=timeout) except queue.Empty: with self._pending_lock: self._pending.pop(rid, None) raise TimeoutError( f"codex app-server method {method!r} timed out after {timeout}s" ) if "error" in msg: err = msg["error"] raise CodexAppServerError( code=err.get("code", -1), message=err.get("message", ""), data=err.get("data"), ) return msg.get("result", {}) def notify(self, method: str, params: Optional[dict] = None) -> None: """Send a JSON-RPC notification (no id, no response expected).""" self._send({"method": method, "params": params or {}}) def respond(self, request_id: Any, result: dict) -> None: """Reply to a server-initiated request (e.g. approval prompts).""" self._send({"id": request_id, "result": result}) def respond_error( self, request_id: Any, code: int, message: str, data: Optional[Any] = None ) -> None: """Reply to a server-initiated request with an error.""" err: dict[str, Any] = {"code": code, "message": message} if data is not None: err["data"] = data self._send({"id": request_id, "error": err}) def take_notification(self, timeout: float = 0.0) -> Optional[dict]: """Pop the next streaming notification, or return None on timeout. timeout=0.0 means non-blocking. Use small positive timeouts inside the AIAgent turn loop to interleave reads with interrupt checks.""" try: if timeout <= 0: return self._notifications.get_nowait() return self._notifications.get(timeout=timeout) except queue.Empty: return None def take_server_request(self, timeout: float = 0.0) -> Optional[dict]: """Pop the next server-initiated request (e.g. exec/applyPatch approval).""" try: if timeout <= 0: return self._server_requests.get_nowait() return self._server_requests.get(timeout=timeout) except queue.Empty: return None # ---------- diagnostics ---------- def stderr_tail(self, n: int = 20) -> list[str]: """Return last n lines of codex's stderr (for error reports).""" with self._stderr_lock: return list(self._stderr_lines[-n:]) def is_alive(self) -> bool: return self._proc.poll() is None # ---------- internals ---------- def _take_id(self) -> int: # JSON-RPC ids only need to be unique per-connection. A simple # monotonically increasing int is the common choice and matches what # codex's own clients use. rid = self._next_id self._next_id += 1 return rid def _send(self, obj: dict) -> None: if self._closed: raise RuntimeError("codex app-server client is closed") if self._proc.stdin is None: raise RuntimeError("codex app-server stdin not available") try: self._proc.stdin.write((json.dumps(obj) + "\n").encode("utf-8")) self._proc.stdin.flush() except (BrokenPipeError, ValueError) as exc: raise RuntimeError( f"codex app-server stdin closed unexpectedly: {exc}" ) from exc def _read_stdout(self) -> None: if self._proc.stdout is None: return try: for line in iter(self._proc.stdout.readline, b""): if not line: break line = line.strip() if not line: continue try: msg = json.loads(line) except json.JSONDecodeError: # Non-JSON output is unexpected on stdout; tracing belongs # on stderr. Surface it via stderr buffer for diagnostics. with self._stderr_lock: self._stderr_lines.append( f" {line[:200]!r}" ) continue self._dispatch(msg) except Exception as exc: with self._stderr_lock: self._stderr_lines.append(f" {exc}") def _dispatch(self, msg: dict) -> None: # Reply (has id + result/error, no method) if "id" in msg and ("result" in msg or "error" in msg): with self._pending_lock: pending = self._pending.pop(msg["id"], None) if pending is not None: try: pending.queue.put_nowait(msg) except queue.Full: # pragma: no cover - defensive pass return # Server-initiated request (has id + method) if "id" in msg and "method" in msg: self._server_requests.put(msg) return # Notification (no id) if "method" in msg: self._notifications.put(msg) def _read_stderr(self) -> None: if self._proc.stderr is None: return try: for line in iter(self._proc.stderr.readline, b""): if not line: break with self._stderr_lock: self._stderr_lines.append( line.decode("utf-8", "replace").rstrip() ) # Bound memory: keep last 500 lines. if len(self._stderr_lines) > 500: self._stderr_lines = self._stderr_lines[-500:] except Exception: # pragma: no cover pass def parse_codex_version(output: str) -> Optional[tuple[int, int, int]]: """Parse `codex --version` output. Returns (major, minor, patch) or None.""" # Output format: "codex-cli 0.130.0" possibly followed by metadata. import re match = re.search(r"(\d+)\.(\d+)\.(\d+)", output or "") if not match: return None return (int(match.group(1)), int(match.group(2)), int(match.group(3))) def check_codex_binary( codex_bin: str = "codex", min_version: tuple[int, int, int] = MIN_CODEX_VERSION ) -> tuple[bool, str]: """Verify codex CLI is installed and meets minimum version. Returns (ok, message). Used by setup wizard and runtime startup.""" try: proc = subprocess.run( [codex_bin, "--version"], capture_output=True, text=True, timeout=10, ) except FileNotFoundError: return False, ( f"codex CLI not found at {codex_bin!r}. Install with: " f"npm i -g @openai/codex" ) except subprocess.TimeoutExpired: return False, "codex --version timed out" if proc.returncode != 0: return False, f"codex --version exited {proc.returncode}: {proc.stderr.strip()}" version = parse_codex_version(proc.stdout) if version is None: return False, f"could not parse codex version from: {proc.stdout!r}" if version < min_version: return False, ( f"codex {'.'.join(map(str, version))} is older than required " f"{'.'.join(map(str, min_version))}. Run: npm i -g @openai/codex" ) return True, ".".join(map(str, version))