3ddf06867f
hermes update now runs the autostart reconcile when it refreshes the launcher scripts, and hermes doctor reports a Startup entry that duplicates the Scheduled Task (removing it under --fix), so installs made before the install-time fix converge too. Co-authored-by: David Metcalfe <80915+DavidMetcalfe@users.noreply.github.com>
607 lines
32 KiB
Python
607 lines
32 KiB
Python
"""Host-platform checks for hermes doctor: interpreter, SQLite, certificates, macOS TCC, gateway supervision, command install.
|
|
Split out of ``hermes_cli/doctor.py``, which re-exports every name so ``hermes_cli.doctor.<name>`` keeps resolving (and monkeypatching)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import shutil
|
|
import ssl
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
from hermes_cli.colors import Colors, color
|
|
from hermes_cli.config import is_nix_install_method, recommended_update_command_for_method
|
|
from hermes_cli.doctor_report import (
|
|
Finding, _fail_and_issue, _section, check_bool, check_fail, check_info, check_ok, check_warn, doctor_check,
|
|
warn_on_error,
|
|
)
|
|
from hermes_constants import is_termux as _is_termux
|
|
|
|
|
|
def _python_repair_hint() -> str:
|
|
from hermes_cli.config import detect_install_method
|
|
from hermes_cli.doctor import PROJECT_ROOT
|
|
|
|
method = detect_install_method(PROJECT_ROOT)
|
|
if is_nix_install_method(method):
|
|
return recommended_update_command_for_method(method)
|
|
if method in ("docker", "apt"):
|
|
command = recommended_update_command_for_method(method)
|
|
return f"Run `{command}`" + (", then recreate the Hermes container" if method == "docker" else "")
|
|
return "Run `hermes pm repair`, then restart Hermes"
|
|
|
|
|
|
def _system_package_install_cmd(pkg: str) -> str:
|
|
return f"{'pkg' if _is_termux() else 'brew' if sys.platform == 'darwin' else 'sudo apt'} install {pkg}"
|
|
|
|
|
|
def _sqlite_upgrade_hint(install_method: str | None = None) -> str:
|
|
"""Return an actionable SQLite upgrade hint for this install layout."""
|
|
from hermes_cli.doctor import PROJECT_ROOT
|
|
from hermes_cli.config import detect_install_method
|
|
method = install_method or detect_install_method(PROJECT_ROOT)
|
|
cmd = recommended_update_command_for_method(method)
|
|
action = cmd if is_nix_install_method(method) else { # nix: prose guidance, not a shell command
|
|
"docker": f"run `{cmd}`, then recreate all Hermes containers", "apt": f"run `{cmd}`"}.get(method, "run `hermes update`")
|
|
return f"({action}; fixed versions: 3.51.3+ / 3.50.7 / 3.44.6 — see https://sqlite.org/wal.html#walresetbug)"
|
|
|
|
|
|
def _hermes_database_paths(hermes_home: Path) -> list[tuple[str, Path]]:
|
|
"""(display name, path) pairs for Hermes-managed SQLite databases: backup.py's per-profile store list + per-board kanban.db."""
|
|
from hermes_cli.backup import _QUICK_STATE_FILES
|
|
entries = [(name, hermes_home / name) for name in _QUICK_STATE_FILES if name.endswith(".db")]
|
|
for board_db in sorted((hermes_home / "kanban" / "boards").glob("*/kanban.db")):
|
|
entries.append((str(board_db.relative_to(hermes_home)), board_db))
|
|
return entries
|
|
|
|
|
|
_SQLITE_HEADER_MAGIC = b"SQLite format 3\x00"
|
|
|
|
|
|
def _unreadable_reason(db_path: Path) -> str:
|
|
"""Explain why a database file could not be read, without opening it.
|
|
|
|
``read_header_bytes_preopen`` collapses every ``OSError`` into ``None``, but doctor must say *which*
|
|
problem it hit. ``stat()``/``access()`` answer from directory metadata alone — no descriptor, no lock loss.
|
|
"""
|
|
try:
|
|
db_path.stat()
|
|
except OSError as exc:
|
|
return str(exc)
|
|
return "file could not be read" if os.access(db_path, os.R_OK) else f"permission denied: {db_path}"
|
|
|
|
|
|
def _read_journal_mode(db_path: Path) -> tuple[str | None, str | None]:
|
|
"""Return (journal mode, error) from header byte 18 (2=WAL, 1=rollback) without opening the database.
|
|
|
|
Opening through SQLite — even read-only — creates -wal/-shm sidecars, which a diagnostic must not do.
|
|
``read_header_bytes_preopen`` rather than a bare ``open()``: closing *any* descriptor cancels this
|
|
process's POSIX advisory locks (see ``hermes_cli.sqlite_safe_read``), and the dashboard console runs
|
|
``run_doctor`` in-process with live ``SessionDB`` connections — the helper refuses then (unreadable).
|
|
"""
|
|
from hermes_cli.sqlite_safe_read import has_live_connection, read_header_bytes_preopen
|
|
header = read_header_bytes_preopen(db_path, length=20)
|
|
if header is None:
|
|
return None, "database is open in this process" if has_live_connection(db_path) else _unreadable_reason(db_path)
|
|
if len(header) == 0:
|
|
return None, "file is empty"
|
|
if len(header) < 20 or not header.startswith(_SQLITE_HEADER_MAGIC):
|
|
return None, "file is not a database"
|
|
mode = {2: "wal", 1: "rollback"}.get(header[18])
|
|
return (mode, None) if mode else (None, f"unrecognized file-format version {header[18]}")
|
|
|
|
|
|
def _format_db_size(db_path: Path) -> str:
|
|
from hermes_cli.sizefmt import format_bytes as _format_size
|
|
try:
|
|
return _format_size(db_path.stat().st_size)
|
|
except OSError:
|
|
return "size unknown"
|
|
|
|
|
|
def _report_database_holders(name: str, db_path: Path) -> None:
|
|
"""Name the processes holding ``db_path`` (or a WAL sidecar) so the operator knows what to stop before the
|
|
offline journal-mode conversion; a partial or unavailable scan is reported as "cannot prove quiet", never as
|
|
an all-clear (the scan is the same fail-closed authority repair/VACUUM/checkpoint admission uses)."""
|
|
from hermes_state_holders import describe_holder_pid, foreign_state_db_holders
|
|
unknown: list[str] = []
|
|
by_pid: dict[int, set[str]] = {}
|
|
for pid, target in foreign_state_db_holders(db_path):
|
|
if pid <= 0 or target.startswith("uninspectable"):
|
|
unknown.append(target)
|
|
else:
|
|
by_pid.setdefault(pid, set()).add(Path(target.removesuffix(" (deleted)")).name)
|
|
for pid in sorted(by_pid):
|
|
check_info(f"{name} is held by {describe_holder_pid(pid)}: {', '.join(sorted(by_pid[pid]))}")
|
|
if unknown:
|
|
check_warn(f"{name}: cannot prove the database is quiet",
|
|
f"(holder scan incomplete: {unknown[0][:120]}" + (f"; +{len(unknown) - 1} more" if len(unknown) > 1 else "") + ")")
|
|
elif not by_pid:
|
|
check_info(f"{name}: no other process holds it right now — the offline conversion can run")
|
|
|
|
|
|
def _report_database_journal_modes(hermes_home: Path | None = None, version_info: tuple[int, ...] | None = None) -> None:
|
|
"""List each database's journal mode; warn on WAL under a vulnerable SQLite, and on a configured
|
|
``database.journal_mode: delete`` that never took effect."""
|
|
from hermes_cli.doctor import HERMES_HOME
|
|
from hermes_state_wal import (
|
|
_path_on_cross_vm_fs, _wal_reset_repair_hint, is_sqlite_wal_reset_vulnerable, resolve_journal_mode,
|
|
)
|
|
vulnerable = is_sqlite_wal_reset_vulnerable(version_info)
|
|
configured = resolve_journal_mode()
|
|
try:
|
|
databases = _hermes_database_paths(hermes_home if hermes_home is not None else HERMES_HOME)
|
|
except Exception as exc:
|
|
check_warn(f"Could not list Hermes databases: {exc}")
|
|
return
|
|
exposed = []
|
|
for name, path in databases:
|
|
if not path.is_file():
|
|
continue
|
|
mode, error = _read_journal_mode(path)
|
|
size = _format_db_size(path)
|
|
if error is None and mode == "wal" and configured == "delete":
|
|
# The operator configured `delete` because WAL is unsafe on their filesystem, but the runtime never
|
|
# live-downgrades an existing WAL database (#68545: a downgrade under open connections corrupts it)
|
|
# and says so only once per process in the gateway log (#85608). Doctor is the surface they check;
|
|
# a plain "WAL journal mode" line here reads as protected. Outranks the sibling WAL messages: the
|
|
# cross-VM hint's remedy ("set journal_mode: delete") is already applied.
|
|
if vulnerable:
|
|
exposed.append(name)
|
|
check_warn(f"{name} is in WAL mode ({size}) despite database.journal_mode=delete",
|
|
"(the setting never applied: an existing WAL database is never live-downgraded"
|
|
+ ("; also exposed to the WAL-reset bug" if vulnerable else "")
|
|
+ ". Stop every Hermes process for this profile, then run "
|
|
f"`hermes sessions set-journal-mode delete{'' if name == 'state.db' else f' --db {path}'}`)")
|
|
_report_database_holders(name, path)
|
|
elif error is not None:
|
|
if vulnerable:
|
|
check_warn(f"{name}: journal mode could not be read", f"({error}; cannot rule out WAL exposure)")
|
|
else:
|
|
check_info(f"{name}: journal mode could not be read ({error})")
|
|
elif mode == "wal" and _path_on_cross_vm_fs(str(path)):
|
|
# #110848: WAL shared-memory is not coherent across a virtiofs/9p bind mount; startup only refuses WAL
|
|
# for FRESH databases, so an existing WAL file here keeps corrupting until the operator converts it.
|
|
# Checked before the WAL-reset exposure: active cross-VM corruption outranks a latent bug class.
|
|
if vulnerable:
|
|
exposed.append(name)
|
|
check_warn(f"{name} is in WAL mode on a cross-VM filesystem (virtiofs/9p, {size})",
|
|
"(WAL can silently corrupt across the VM boundary; stop every Hermes process and run "
|
|
f"`hermes sessions set-journal-mode delete{'' if name == 'state.db' else f' --db {path}'}`, then "
|
|
"set `database.journal_mode: delete` — or move the database onto a native/named volume)")
|
|
elif mode == "wal" and vulnerable:
|
|
exposed.append(name)
|
|
check_warn(f"{name} is in WAL mode ({size})", "(exposed to the WAL-reset bug until SQLite is upgraded)")
|
|
elif mode == "wal":
|
|
check_info(f"{name}: WAL journal mode ({size})")
|
|
else:
|
|
check_info(f"{name}: rollback journal mode ({size}{', not exposed' if vulnerable else ''})")
|
|
if exposed:
|
|
check_info(f"To clear the exposure: {_wal_reset_repair_hint()}")
|
|
|
|
|
|
def _check_s6_supervision(issues: list[str]) -> None:
|
|
"""Under our s6 /init, report static services and the ONE host gateway slot; no-op elsewhere.
|
|
Counterpart to :func:`_check_gateway_service_linger` (systemd-on-host)."""
|
|
try:
|
|
from hermes_cli.service_manager import S6ServiceManager, detect_service_manager
|
|
except Exception:
|
|
return
|
|
if detect_service_manager() != "s6":
|
|
return
|
|
_section("s6 Supervision")
|
|
mgr = S6ServiceManager()
|
|
for static in ("main-hermes", "dashboard"): # s6-rc symlinks under /run/service/, same s6-svstat probe
|
|
up = mgr.is_running(static)
|
|
(check_ok if up else check_info)(f"{static}: up" if up else f"{static}: down (expected if not enabled via env)")
|
|
_report_host_gateway_slot(mgr, issues)
|
|
|
|
|
|
def _report_host_gateway_slot(mgr, issues: list[str]) -> None:
|
|
"""Multiplex-only: ONE gateway process serves N profiles, so report THAT process and its
|
|
roster. The old ``Per-profile gateways: up/total`` line described a topology we no longer
|
|
run — it counted supervision slots and never said which profiles were actually served."""
|
|
from gateway.host_topology import host_gateway_topology
|
|
slots = sorted(mgr.list_profile_gateways())
|
|
topology = host_gateway_topology()
|
|
if topology is None:
|
|
if not slots:
|
|
return check_info("No gateway registered yet — run `hermes gateway install`")
|
|
up = [p for p in slots if mgr.is_running(f"gateway-{p}")]
|
|
issues.append("No host gateway owns the gateway role — start the ONE host multiplexer: "
|
|
"hermes --profile default gateway start")
|
|
return check_warn(f"No host gateway owns the gateway role ({len(up)}/{len(slots)} supervision "
|
|
f"slots up: {', '.join(slots)})", "(nothing is serving these profiles)")
|
|
check_ok(f"Host gateway: {topology.describe()}")
|
|
legacy_up = sorted(p for p in slots if p != "default" and mgr.is_running(f"gateway-{p}"))
|
|
if legacy_up:
|
|
check_warn(f"LEGACY per-profile gateway slots still supervised: {', '.join(legacy_up)}",
|
|
"(multiplex-only: the host gateway already serves every profile from one process)")
|
|
issues.append("Fold the legacy per-profile gateways into the host gateway: "
|
|
"hermes --profile default gateway migrate --multiplex")
|
|
|
|
|
|
def check_certificates(should_fix: bool = False, issues: "list | None" = None) -> None:
|
|
"""Verify the actual TLS policy is usable before the first HTTPS call tracebacks.
|
|
|
|
The policy is ``agent.ssl_verify``: the platform verifier (truststore) is
|
|
installed process-wide and every stack builds SSL contexts through it. There
|
|
is no certifi bundle to validate anymore; the check is that the platform
|
|
store is in force and a default context constructs.
|
|
"""
|
|
try:
|
|
from agent.ssl_verify import install_truststore
|
|
except Exception as e:
|
|
return check_warn("TLS trust check skipped", str(e))
|
|
if issues is None:
|
|
issues = []
|
|
platform_store = install_truststore()
|
|
if not platform_store:
|
|
check_warn("TLS platform trust store unavailable",
|
|
"OpenSSL default trust paths are in use; certificates trusted only by the OS store (a corporate root) will not verify")
|
|
try:
|
|
ssl.create_default_context()
|
|
except Exception as e:
|
|
_fail_and_issue("TLS default SSL context cannot be constructed", str(e),
|
|
_python_repair_hint() + "; if TLS still fails, repair Python through the installation owner.", issues)
|
|
return
|
|
if platform_store:
|
|
check_ok("TLS platform trust store configured; default SSL context available")
|
|
else:
|
|
check_ok("TLS default SSL context available (OpenSSL trust paths)")
|
|
|
|
|
|
def _check_gateway_service_linger(issues: list[str]) -> None:
|
|
"""Warn when a systemd user gateway service will stop after logout (skipped under s6: no linger concept).
|
|
|
|
Multiplex-only: the HOST gateway runs under the default profile's unit, so a doctor run from a
|
|
SERVED profile must still check it — gating on the active profile's own unit silently skipped
|
|
the check for every profile that does not own a service of its own.
|
|
"""
|
|
try:
|
|
from hermes_cli.gateway import (
|
|
_SERVICE_BASE, get_systemd_linger_status, get_systemd_unit_path, is_linux,
|
|
user_systemd_unit_dir)
|
|
from hermes_cli.service_manager import detect_service_manager
|
|
except Exception as e:
|
|
return check_warn("Gateway service linger", f"(could not import gateway helpers: {e})")
|
|
if not is_linux() or detect_service_manager() == "s6":
|
|
return
|
|
host_unit = user_systemd_unit_dir() / f"{_SERVICE_BASE}.service"
|
|
if not (get_systemd_unit_path().exists() or host_unit.exists()):
|
|
return
|
|
_section("Gateway Service")
|
|
linger_enabled, linger_detail = get_systemd_linger_status()
|
|
if linger_enabled is None:
|
|
return check_warn("Could not verify systemd linger", f"({linger_detail})")
|
|
if not check_bool(linger_enabled, ("Systemd linger enabled", "(gateway service survives logout)"),
|
|
("Systemd linger disabled", "(gateway may stop after logout)")):
|
|
check_info("Run: sudo loginctl enable-linger $USER")
|
|
issues.append("Enable linger for the gateway user service: sudo loginctl enable-linger $USER")
|
|
|
|
|
|
_TCC_CDHASH_DETAIL = (
|
|
"the desktop bundle's designated requirement is cdhash-pinned (pre-#73681 build) — rebuilds invalidate "
|
|
"all permission grants. Run `hermes update` to get the stable identifier-pinned signing identity, "
|
|
"then re-grant permissions once.")
|
|
_TCC_STABLE_DETAIL = {
|
|
True: "(certificate-anchored DR; grants survive rebuilds)",
|
|
False: "(identifier-pinned DR; grants survive rebuilds — for the strongest anchor, see `hermes desktop --setup-tcc-identity`)",
|
|
}
|
|
|
|
|
|
def check_macos_tcc_grants() -> None:
|
|
"""Check macOS TCC grant persistence for a locally-built desktop bundle; silent on non-macOS / no bundle.
|
|
|
|
TCC keys grants to the app's designated requirement (DR). A cdhash-pinned ad-hoc DR changes on every
|
|
rebuild, so grants silently stop matching while the Settings toggle stays ON; identifier-pinned builds
|
|
survive rebuilds, but grants made to older binaries stay stale until re-granted once. TCC.db needs Full
|
|
Disk Access, so the DR string is the only readable signal (a proxy for the signing class, not DR wording).
|
|
|
|
See #86385.
|
|
"""
|
|
app = _desktop_app_bundle() if sys.platform == "darwin" else None
|
|
if app is None:
|
|
return
|
|
dr = _macos_desktop_dr(app)
|
|
if not dr:
|
|
return check_warn("macOS TCC grant check", "(could not read code-signing requirement of the desktop bundle)")
|
|
if "cdhash" in dr.lower():
|
|
return check_warn("macOS TCC grants will reset after every update", _TCC_CDHASH_DETAIL)
|
|
# --setup-tcc-identity or notarized build (certificate-anchored) is the strongest anchor.
|
|
check_ok("macOS TCC signing identity is stable", _TCC_STABLE_DETAIL["certificate" in dr.lower()])
|
|
check_info("If macOS still re-prompts for permissions (toggle shows ON): the stored grant is stale — run "
|
|
"`tccutil reset ScreenCapture com.nousresearch.hermes` (repeat per affected service), toggle it ON in "
|
|
"System Settings, then fully quit & relaunch Hermes once.")
|
|
|
|
|
|
def _desktop_app_bundle() -> Path | None:
|
|
"""Locate the locally-built desktop bundle (``apps/desktop/release/mac-<arch>/Hermes.app``), newest first.
|
|
|
|
The only layout whose ad-hoc re-signed bundle can invalidate TCC grants. ``/Applications/Hermes.app`` is
|
|
deliberately not probed: it is the separately-signed, certificate-anchored Hermes-Setup launcher.
|
|
"""
|
|
release_dir = Path(__file__).resolve().parents[1] / "apps" / "desktop" / "release"
|
|
candidates = [p for p in release_dir.glob("mac*/Hermes.app") if p.is_dir()]
|
|
return max(candidates, key=lambda p: p.stat().st_mtime) if candidates else None
|
|
|
|
|
|
def _macos_desktop_dr(app: Path) -> str | None:
|
|
"""Return the bundle's designated requirement string, or None on failure (a hanging codesign must never abort doctor)."""
|
|
codesign = shutil.which("codesign")
|
|
try:
|
|
proc = subprocess.run([codesign, "-d", "--requirements", "-", str(app)], capture_output=True, text=True, encoding="utf-8", errors="replace", timeout=15) if codesign else None
|
|
except (FileNotFoundError, subprocess.TimeoutExpired):
|
|
return None
|
|
return None if proc is None or proc.returncode != 0 else (proc.stdout or "") + (proc.stderr or "")
|
|
|
|
|
|
def check_macos_tcc_anchor(should_fix: bool = False) -> None:
|
|
"""Report (and with --fix install) the dylib-complete TCC anchor; silent on non-macOS / non-uv interpreters.
|
|
Never raises. Install is gated by the module's pre-install boot probe, so ``--fix`` cannot brick the CLI.
|
|
|
|
See #95596.
|
|
"""
|
|
with warn_on_error("macOS TCC anchor check failed"):
|
|
from hermes_cli import macos_tcc_anchor as tcc
|
|
status, detail = tcc.tcc_anchor_state()
|
|
if status == "skip":
|
|
return
|
|
if status == "active":
|
|
return check_ok("macOS TCC anchor active", f"({detail})")
|
|
anchored = tcc.ensure_tcc_anchor() if should_fix else None
|
|
if anchored is not None:
|
|
return check_ok("macOS TCC anchor installed", f"({anchored})")
|
|
check_warn("macOS TCC anchor missing" if status == "missing" else "macOS TCC anchor stale", f"({detail})")
|
|
|
|
|
|
def check_macos_full_disk_access() -> None:
|
|
"""One-grant guidance: Full Disk Access silences every per-folder TCC prompt. Silent on non-macOS.
|
|
|
|
Probe: listdir of ``~/Library/Application Support/com.apple.TCC`` — FDA-gated, and probing it does NOT
|
|
trigger a prompt (the TCC dir just returns EPERM). A missing dir / other error is indeterminate: stay silent.
|
|
|
|
macOS TCC prompts per-category (Desktop, then Downloads, then Documents, ...), so first-run agents
|
|
drip-feed permission dialogs as they touch each folder. ONE Full Disk Access grant covers all of them,
|
|
permanently — and with the stable signing identities now in place (#73681/#95091/#95131), it survives
|
|
updates too. This check probes whether the terminal context already has FDA and, when it doesn't, prints
|
|
the exact one-switch setup with the System Settings deep link.
|
|
"""
|
|
if sys.platform != "darwin":
|
|
return
|
|
try:
|
|
os.listdir(Path.home() / "Library" / "Application Support" / "com.apple.TCC")
|
|
except PermissionError:
|
|
check_info("One switch silences all macOS folder prompts: grant your terminal app Full Disk Access and Hermes "
|
|
"will never trip per-folder dialogs (Desktop/Downloads/Documents/...) again. Open: System Settings → "
|
|
"Privacy & Security → Full Disk Access — or run:\n"
|
|
" open \"x-apple.systempreferences:com.apple.preference.security?Privacy_AllFiles\"\n"
|
|
" then enable your terminal (and Hermes.app if you use Desktop), and restart them once. "
|
|
"With Hermes' stable signing identities the grant survives every update.")
|
|
except OSError:
|
|
pass # missing dir / other error: indeterminate, stay silent
|
|
else:
|
|
check_ok("macOS Full Disk Access granted", "(no per-folder permission prompts will occur)")
|
|
|
|
|
|
@doctor_check("Security advisory check failed: {e}")
|
|
def _check_security_advisories(should_fix: bool, f: Finding) -> None:
|
|
"""Compromised-package advisories, funnelled into manual issues; a bug here must never block the rest of doctor."""
|
|
from hermes_cli.security_advisories import detect_compromised, filter_unacked, full_remediation_text, get_acked_ids
|
|
all_hits = detect_compromised()
|
|
fresh_hits = filter_unacked(all_hits)
|
|
if not fresh_hits:
|
|
return check_ok("No active security advisories")
|
|
for hit in fresh_hits:
|
|
# Fail row + remediation text indented under it as one section; also into the summary action list.
|
|
_fail_and_issue(f"{hit.advisory.title}", f"({hit.package}=={hit.installed_version})",
|
|
f"Resolve security advisory {hit.advisory.id}: uninstall {hit.package}=={hit.installed_version} "
|
|
f"and rotate credentials, then run `hermes doctor --ack {hit.advisory.id}`.", f.manual_issues)
|
|
for line in full_remediation_text(hit):
|
|
print(f" {color(line, Colors.YELLOW)}" if line else "")
|
|
acked_ids = get_acked_ids() # acked-but-still-installed stays visible
|
|
for h in all_hits:
|
|
if h.advisory.id in acked_ids:
|
|
check_warn(f"{h.package}=={h.installed_version} still installed (advisory {h.advisory.id} acknowledged)")
|
|
|
|
|
|
def _staged_venv_dir() -> "Path | None":
|
|
"""pm's provisioned runtime venv, or None when nothing is staged.
|
|
|
|
``pm.packages.Venv().venv_dir()`` is pm's public authority for where
|
|
the runtime venv lives, including an external selected generation or
|
|
the original source/payload environment before first sync. A resolved
|
|
path without a venv marker is not a provisioned venv — pm also returns
|
|
the intended location before first sync, and
|
|
doctor must not read an empty directory as staged dependencies.
|
|
"""
|
|
try:
|
|
import pm # noqa: F401 — imports pm.packages, registering the definitions
|
|
from pm.packages import Venv
|
|
|
|
venv_dir = Venv().venv_dir()
|
|
except Exception:
|
|
return None
|
|
if venv_dir is not None and (Path(venv_dir) / "pyvenv.cfg").is_file():
|
|
return Path(venv_dir)
|
|
return None
|
|
|
|
|
|
@doctor_check()
|
|
def _check_python_environment(should_fix: bool, f: Finding) -> None:
|
|
"""Interpreter, linked SQLite, venv, macOS TCC anchors/FDA/grants, version-file drift."""
|
|
v, label = sys.version_info, f"Python {'.'.join(map(str, sys.version_info[:3]))}"
|
|
if v < (3, 8):
|
|
_fail_and_issue(label, "(3.10+ required)", "Upgrade Python to 3.10+", f.issues)
|
|
elif check_bool(v >= (3, 10), label, (label, "(3.10+ recommended)")) and v < (3, 11):
|
|
check_warn("Python 3.11+ recommended for RL Training tools (tinker requires >= 3.11)")
|
|
# Linked SQLite: version + source id matter independently of the Python minor (uv's
|
|
# python-build-standalone can keep a vulnerable SQLite across upgrades).
|
|
with warn_on_error("SQLite version probe failed: {e}", ""):
|
|
import sqlite3
|
|
from hermes_state_wal import is_sqlite_wal_reset_vulnerable, sqlite_source_id
|
|
src = sqlite_source_id()
|
|
# Warn-only: Hermes already refuses WAL on fresh DBs and runtime repair is best-effort.
|
|
check_bool(not is_sqlite_wal_reset_vulnerable(), f"SQLite {sqlite3.sqlite_version}",
|
|
(f"SQLite {sqlite3.sqlite_version} (WAL-reset bug)", _sqlite_upgrade_hint()))
|
|
if src:
|
|
check_info(f"SQLite source id: {(src[:48] + '…') if len(src) > 48 else src}")
|
|
_report_database_journal_modes()
|
|
# PM launchers run base Python with the selected dependency tree on
|
|
# sys.path. Neither sys.prefix nor a stale PYTHONPATH proves activation.
|
|
staged = _staged_venv_dir()
|
|
if staged is not None:
|
|
from pm.environments import site_packages
|
|
|
|
selected_site = site_packages(staged).resolve()
|
|
running_here = selected_site.is_dir() and any(Path(entry).resolve() == selected_site for entry in sys.path)
|
|
check_ok(f"Runtime venv staged ({staged})",
|
|
"(active in this process)" if running_here else "(this process runs outside it)")
|
|
else:
|
|
check_bool(sys.prefix != sys.base_prefix, "Virtual environment active",
|
|
("Not in virtual environment", "(recommended)"))
|
|
# macOS TCC interpreter anchor (#95596): dylib-complete re-land of the mechanism reverted in #95563.
|
|
# Silent on non-macOS.
|
|
check_macos_tcc_anchor(should_fix=should_fix)
|
|
# macOS Full Disk Access (issue #52010 follow-up): one grant silences every per-folder prompt
|
|
# permanently. Silent on non-macOS.
|
|
check_macos_full_disk_access()
|
|
|
|
# macOS TCC grant persistence (issue #86385): a locally-built desktop bundle whose DR is cdhash-pinned
|
|
# loses every permission grant on each rebuild; a post-#73681 identifier-pinned DR survives, but grants
|
|
# made to older binaries stay stale (toggle shows ON while macOS re-prompts).
|
|
check_macos_tcc_grants()
|
|
|
|
|
|
@doctor_check()
|
|
def _check_certificates(should_fix: bool, f: Finding) -> None:
|
|
check_certificates(should_fix=should_fix, issues=f.manual_issues)
|
|
|
|
|
|
# (import name, display name, optional)
|
|
_PACKAGES = (
|
|
("openai", "OpenAI SDK", False), ("rich", "Rich (terminal UI)", False), ("dotenv", "python-dotenv", False),
|
|
("ruamel.yaml", "ruamel.yaml", False), ("httpx", "HTTPX", False),
|
|
("croniter", "Croniter (cron expressions)", True), ("telegram", "python-telegram-bot", True), ("discord", "discord.py", True),
|
|
)
|
|
|
|
|
|
@doctor_check()
|
|
def _check_required_packages(should_fix: bool, f: Finding) -> None:
|
|
for module, name, optional in _PACKAGES:
|
|
try:
|
|
__import__(module)
|
|
check_ok(name, "(optional)" if optional else "")
|
|
except ImportError:
|
|
if optional:
|
|
check_warn(name, "(optional, not installed)")
|
|
else:
|
|
_fail_and_issue(name, "(missing)", f"Repair {name}: {_python_repair_hint()}", f.issues)
|
|
|
|
|
|
def _check_windows_gateway_autostart(should_fix: bool, f: Finding) -> None:
|
|
"""Windows: the gateway must start at logon from ONE mechanism — a Scheduled Task and a
|
|
Startup-folder entry side by side launch it twice (#80569)."""
|
|
if sys.platform != "win32":
|
|
return
|
|
from hermes_cli import gateway_windows
|
|
redundant = gateway_windows.redundant_autostart_entries()
|
|
if not redundant:
|
|
return
|
|
_section("Windows Gateway Autostart")
|
|
if not should_fix:
|
|
for path in redundant:
|
|
check_warn("Redundant gateway login item", f"({path})")
|
|
f.issues.append("Remove duplicate Windows gateway autostart entries: hermes doctor --fix")
|
|
return
|
|
done, warnings = gateway_windows.reconcile_autostart_launchers()
|
|
for message in done:
|
|
check_ok(message)
|
|
for message in warnings:
|
|
check_warn(message)
|
|
if done and not warnings:
|
|
f.fixed += 1
|
|
if warnings:
|
|
f.manual_issues.extend(warnings)
|
|
|
|
|
|
@doctor_check()
|
|
def _check_gateway_supervision(should_fix: bool, f: Finding) -> None:
|
|
_check_gateway_service_linger(f.issues)
|
|
_check_s6_supervision(f.issues)
|
|
_check_windows_gateway_autostart(should_fix, f)
|
|
|
|
|
|
@doctor_check()
|
|
def _check_command_installation(should_fix: bool, f: Finding) -> None:
|
|
"""Check the install-owned launch contract without replacing custom commands."""
|
|
from hermes_cli.doctor import PROJECT_ROOT
|
|
if sys.platform == "win32":
|
|
return
|
|
_section("Command Installation")
|
|
from hermes_cli.config import detect_install_method
|
|
|
|
method = detect_install_method(PROJECT_ROOT)
|
|
if is_nix_install_method(method) or method in ("docker", "apt"):
|
|
command = shutil.which("hermes")
|
|
if command:
|
|
check_ok(f"Hermes command managed by {method} ({command})")
|
|
else:
|
|
check_warn(f"Hermes command not on PATH ({method}-managed)")
|
|
f.manual_issues.append(_python_repair_hint())
|
|
return
|
|
from hermes_cli._launchers import resolve_store_python
|
|
from pm.environments import base_venv, selected_venv
|
|
|
|
try:
|
|
selected = selected_venv(PROJECT_ROOT)
|
|
except (OSError, ValueError, RuntimeError) as exc:
|
|
check_fail("Cannot resolve selected dependencies", str(exc))
|
|
return f.manual_issues.append(_python_repair_hint())
|
|
pm_launcher = selected != base_venv(PROJECT_ROOT) or resolve_store_python(PROJECT_ROOT) is not None
|
|
venv_bin = PROJECT_ROOT / "hermes" if pm_launcher else selected / "bin" / "hermes"
|
|
if not venv_bin.is_file():
|
|
check_warn("Hermes entry point not found", f"({venv_bin})")
|
|
return f.manual_issues.append("Repair or reinstall the Hermes launcher through the installation owner")
|
|
check_ok(f"Hermes entry point exists ({venv_bin})")
|
|
# Expected command link directory (mirrors install.sh logic).
|
|
prefix = os.environ.get("PREFIX", "")
|
|
termux = prefix and (os.environ.get("TERMUX_VERSION") or "com.termux/files/usr" in prefix)
|
|
link_dir, display = (Path(prefix) / "bin", "$PREFIX/bin") if termux else (Path.home() / ".local" / "bin", "~/.local/bin")
|
|
link = link_dir / "hermes"
|
|
if link.is_symlink():
|
|
target, expected = link.resolve(), venv_bin.resolve()
|
|
if target == expected:
|
|
return check_ok(f"{display}/hermes → correct target")
|
|
check_warn(f"{display}/hermes points to wrong target", f"(→ {target}, expected → {expected})")
|
|
owned_targets = {(PROJECT_ROOT / name / "bin" / "hermes").resolve() for name in ("venv", ".venv")}
|
|
if target not in owned_targets:
|
|
return f.manual_issues.append(f"Review {display}/hermes manually; its target is user-managed and was not changed")
|
|
if not should_fix:
|
|
return f.issues.append(f"Broken symlink at {display}/hermes — run 'hermes doctor --fix'")
|
|
verb = "Fixed"
|
|
elif link.exists(): # regular file (wrapper script), not a symlink
|
|
return check_ok(f"{display}/hermes exists (non-symlink)")
|
|
else:
|
|
check_fail(f"{display}/hermes not found", "(hermes command may not work outside the venv)")
|
|
if not should_fix:
|
|
return f.issues.append(f"Missing {display}/hermes symlink — run 'hermes doctor --fix'")
|
|
link_dir.mkdir(parents=True, exist_ok=True)
|
|
verb = "Created"
|
|
if pm_launcher:
|
|
from hermes_cli._launchers import stage_launcher
|
|
|
|
if stage_launcher("hermes", PROJECT_ROOT, link_dir) is None:
|
|
check_fail("Could not publish Hermes launcher")
|
|
return f.manual_issues.append("Repair the PM store interpreter through the installation owner, then rerun 'hermes doctor --fix'")
|
|
check_ok(f"{verb} PM launcher: {display}/hermes")
|
|
else:
|
|
if link.is_symlink():
|
|
link.unlink()
|
|
link.symlink_to(venv_bin)
|
|
check_ok(f"{verb} symlink: {display}/hermes → {venv_bin}")
|
|
f.fixed += 1
|
|
if verb == "Created" and str(link_dir) not in os.environ.get("PATH", "").split(os.pathsep):
|
|
check_warn(f"{display} is not on your PATH", "(add it to your shell config: export PATH=\"$HOME/.local/bin:$PATH\")")
|
|
f.manual_issues.append(f"Add {display} to your PATH")
|