| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203 |
- """Shared logic for the /codex-runtime slash command (CLI and gateway call into this module)."""
- from __future__ import annotations
- import functools
- import logging
- from dataclasses import dataclass
- from typing import Optional
- logger = logging.getLogger(__name__)
- VALID_RUNTIMES = ("auto", "codex_app_server")
- # Human-friendly synonyms accepted by parse_args.
- _ARG_SYNONYMS = {
- "on": "codex_app_server", "codex": "codex_app_server", "enable": "codex_app_server",
- "off": "auto", "default": "auto", "disable": "auto", "hermes": "auto"}
- _HERMES_TOOLS_CALLBACK_NOTE = (
- "Hermes tool callback registered: codex can now use "
- "web_search, web_extract, vision_analyze, "
- "image_generate, skill_view, skills_list, text_to_speech, "
- "kanban_* (worker + orchestrator) via MCP.",
- " (delegate_task, memory, session_search, todo run "
- "only on the default Hermes runtime — they need the "
- "agent loop context.)")
- @dataclass
- class CodexRuntimeStatus:
- """Result of a /codex-runtime invocation; callers render it per surface (Rich panel / text)."""
- success: bool
- new_value: Optional[str] = None
- old_value: Optional[str] = None
- message: str = ""
- requires_new_session: bool = False
- def parse_args(arg_string: str) -> tuple[Optional[str], list[str]]:
- """Parse the slash-command argument string into ``(value, errors)``.
- No args → ``(None, [])`` (show current state); a runtime name or synonym → that runtime.
- """
- raw = (arg_string or "").strip().lower()
- if not raw:
- return None, []
- value = _ARG_SYNONYMS.get(raw, raw)
- if value in VALID_RUNTIMES:
- return value, []
- return None, [f"Unknown runtime {raw!r}. Use one of: auto, codex_app_server, on, off"]
- def get_current_runtime(config: dict) -> str:
- """Current ``model.openai_runtime``; 'auto' for unset / empty / unrecognized values."""
- if not isinstance(config, dict):
- return "auto"
- model_cfg = config.get("model") or {}
- if not isinstance(model_cfg, dict):
- return "auto"
- value = str(model_cfg.get("openai_runtime") or "").strip().lower()
- return value if value in VALID_RUNTIMES else "auto"
- def get_configured_codex_binary(config: dict) -> str:
- """``model.codex_bin`` (one argv element, never shell-parsed) or bare ``codex`` from PATH.
- Gateway/service/Kanban-worker processes often run with a minimal PATH that lacks the codex
- CLI (e.g. a desktop-bundled ``.../Codex.app/Contents/Resources/codex``), so users need a
- config-level override for every codex spawn site (#61360)."""
- model_cfg = config.get("model") if isinstance(config, dict) else None
- value = model_cfg.get("codex_bin") if isinstance(model_cfg, dict) else None
- return str(value or "").strip() or "codex"
- def set_runtime(config: dict, new_value: str) -> str:
- """Persist *new_value* into the config dict in place; returns the previous value."""
- if new_value not in VALID_RUNTIMES:
- raise ValueError(f"invalid runtime {new_value!r}; must be one of {VALID_RUNTIMES}")
- old = get_current_runtime(config)
- if not isinstance(config.get("model"), dict):
- config["model"] = {}
- config["model"]["openai_runtime"] = new_value
- return old
- def check_codex_binary_ok(codex_bin: str = "codex") -> tuple[bool, Optional[str]]:
- """Best-effort codex CLI install/version check → ``(ok, version_or_message)``."""
- try:
- from agent.transports.codex_app_server import check_codex_binary
- return check_codex_binary(codex_bin=codex_bin)
- except Exception as exc: # pragma: no cover
- return False, f"codex check failed: {exc}"
- def _migration_lines(config: dict) -> list[str]:
- """Run the ~/.codex/config.toml migration and describe it; failures are non-fatal."""
- lines: list[str] = []
- try:
- from hermes_cli.codex_runtime_plugin_migration import HERMES_TOOLS_MCP_SERVER_NAME, migrate
- mig_report = migrate(config)
- # The hermes-tools callback is internal plumbing — surfaced separately below.
- user_servers = [s for s in mig_report.migrated if s != HERMES_TOOLS_MCP_SERVER_NAME]
- if user_servers:
- lines.append(f"Migrated {len(user_servers)} MCP server(s): {', '.join(user_servers)}")
- if mig_report.migrated_plugins:
- lines.append(
- f"Migrated {len(mig_report.migrated_plugins)} native "
- f"Codex plugin(s): {', '.join(mig_report.migrated_plugins)}")
- elif mig_report.plugin_query_error:
- lines.append(f"Codex plugin discovery skipped: {mig_report.plugin_query_error}")
- if mig_report.wrote_permissions_default:
- lines.append(
- f"Default sandbox: {mig_report.wrote_permissions_default} "
- f"(no approval prompt on every write)")
- if HERMES_TOOLS_MCP_SERVER_NAME in mig_report.migrated:
- lines.extend(_HERMES_TOOLS_CALLBACK_NOTE)
- lines.append(f" (config: {mig_report.target_path})")
- for err in mig_report.errors:
- lines.append(f"⚠ MCP migration: {err}")
- except Exception as exc:
- lines.append(f"⚠ MCP migration skipped: {exc}")
- return lines
- def apply(
- config: dict, new_value: Optional[str], *, persist_callback=None) -> CodexRuntimeStatus:
- """Entry point for CLI and gateway. ``config`` is mutated in place when ``new_value`` is set
- (None = show current state); ``persist_callback(config)`` writes it, skipped when None."""
- current = get_current_runtime(config)
- codex_bin = get_configured_codex_binary(config)
- # Cached per apply() call: the enable path would otherwise spawn `codex --version` up to 3x.
- _check_binary_cached = functools.cache(check_codex_binary_ok)
- if new_value is None:
- ok, ver = _check_binary_cached(codex_bin)
- msg = (
- f"openai_runtime: {current}\n"
- f"codex CLI: {'OK ' + ver if ok else 'not available — ' + (ver or 'install with `npm i -g @openai/codex`')}"
- )
- return CodexRuntimeStatus(success=True, new_value=current, old_value=current, message=msg)
- # Re-enabling codex_app_server falls through to the migration: the config value is already
- # correct but the world state (managed block in ~/.codex/config.toml, hermes-tools MCP
- # callback, plugin discovery) may be stale — a common footgun when users pre-set
- # `openai_runtime: codex_app_server` by hand. The migration is idempotent so re-running is
- # cheap and safe. Re-setting `auto` returns immediately (disabling never touches ~/.codex/).
- reapplying_enable = new_value == current == "codex_app_server"
- if new_value == current and not reapplying_enable:
- return CodexRuntimeStatus(
- success=True, new_value=current, old_value=current,
- message=f"openai_runtime already set to {current}")
- # Switching ON: verify codex CLI before persisting — an opt-in toggle that silently fails on
- # the first turn is the worst possible UX.
- if new_value == "codex_app_server":
- ok, ver_or_msg = _check_binary_cached(codex_bin)
- if not ok:
- return CodexRuntimeStatus(
- success=False, new_value=None, old_value=current,
- message=(
- "Cannot enable codex_app_server runtime: "
- f"{ver_or_msg or 'codex CLI not available'}\n"
- "Install with: npm i -g @openai/codex"))
- if not reapplying_enable:
- set_runtime(config, new_value)
- if persist_callback is not None:
- try:
- persist_callback(config)
- except Exception as exc:
- logger.exception("failed to persist openai_runtime change")
- return CodexRuntimeStatus(
- success=False, new_value=new_value, old_value=current,
- message=f"updated config in memory but persist failed: {exc}")
- msg_lines = [
- f"openai_runtime already set to {current} — re-applying migration"
- if reapplying_enable
- else f"openai_runtime: {current} → {new_value}"]
- if new_value == "codex_app_server":
- ok, ver = _check_binary_cached(codex_bin)
- if ok:
- msg_lines.append(f"codex CLI: {ver}")
- # Migrate Hermes' MCP servers + Codex's curated plugins into ~/.codex/config.toml so the
- # spawned codex subprocess sees the same tool surface AND can call back into Hermes.
- msg_lines.extend(_migration_lines(config))
- msg_lines.append(
- "OpenAI/Codex turns now run through `codex app-server` "
- "(terminal/file ops/patching inside Codex; "
- "Hermes tools available via MCP callback).")
- msg_lines.append(
- "Effective on next session — current cached agent keeps "
- "the prior runtime to preserve prompt cache.")
- else:
- msg_lines.append("OpenAI/Codex turns will use the default Hermes runtime.")
- msg_lines.append("Effective on next session.")
- return CodexRuntimeStatus(
- success=True, new_value=new_value, old_value=current,
- message="\n".join(msg_lines), requires_new_session=True)
|