refactor(update): hand-compact comments/docstrings in update_cmd.py, update_cmd_fleet.py, update_cmd_zip.py (AST-identical); rewrite stale module docstring

This commit is contained in:
Teknium
2026-09-02 16:45:44 -07:00
parent d46eb1f964
commit 1aa9285312
3 changed files with 471 additions and 992 deletions
+176 -433
View File
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+68 -140
View File
@@ -1,9 +1,7 @@
"""ZIP-download fallback update path for ``hermes update`` (Windows with broken git): two-phase stage/commit directory swap, dirty-tree guard.
"""ZIP-download fallback for ``hermes update`` (Windows with broken git): two-phase stage/commit swap, dirty-tree guard.
Split out of ``hermes_cli/update_cmd.py``; every moved name is re-imported there, so
``hermes_cli.update_cmd.<name>`` keeps resolving (and monkeypatching) as before.
Origin-internal helpers are imported lazily inside each function (no import cycle;
test patches on ``hermes_cli.update_cmd.<name>`` stay effective).
Split out of ``update_cmd.py``; every name is re-imported there so ``hermes_cli.update_cmd.<name>`` keeps
resolving/monkeypatching. Origin helpers are imported lazily per function (no cycle; test patches stay effective).
"""
import logging
@@ -22,32 +20,21 @@ logger = logging.getLogger("hermes_cli.update_cmd")
def _atomic_replace_dir(src: str, dst: str) -> None:
"""Replace directory *dst* with *src* without leaving *dst* half-deleted.
Naive ``rmtree(dst); copytree(src, dst)`` has a destructive window: a
copy that fails partway (common on the Windows ZIP path, which only runs
because file I/O is already flaky) leaves the old tree gone and nothing
in its place (#49145: ``ui-tui/`` vanished and broke the TUI).
Now a thin alias over the two-phase helpers below (#76104); retained as
part of the ``hermes_cli.main`` re-export surface and the #49145 guard.
"""Replace *dst* with *src* without a half-deleted window: naive ``rmtree; copytree`` loses the old
tree when the copy fails partway (likely here, since the ZIP path only runs when file I/O is flaky).
Thin alias over the two-phase helpers; retained for the ``hermes_cli.main`` re-export surface.
"""
_commit_staged_replacements([(_stage_replacement(src, dst), dst)])
def _stage_replacement(src: str, dst: str) -> str:
"""Copy *src* to a sibling staging path for *dst*; return the staging path.
Phase 1 of the two-phase replace. Handles both directories and plain
files. Touches nothing live, so a failure here leaves the whole install
untouched.
"""Phase 1: copy *src* (dir or file) to a sibling staging path for *dst*; return it.
Touches nothing live, so a failure here leaves the install untouched.
"""
staging = f"{dst}.hermes-update-staging"
backup = f"{dst}.hermes-update-old"
# A previous run may have died between "move dst aside" and "move staging
# in", leaving the backup as the ONLY copy. Restore it BEFORE clearing
# leftovers: deleting it and then failing to stage (disk exhaustion is
# likely here) would leave a hole with nothing to roll back to.
# A prior run may have died mid-swap leaving the backup as the ONLY copy. Restore it BEFORE
# clearing leftovers, else deleting it then failing to stage (disk exhaustion) leaves a hole.
if not os.path.exists(dst) and os.path.exists(backup):
os.rename(backup, dst)
for leftover in (staging, backup):
@@ -63,11 +50,8 @@ def _stage_replacement(src: str, dst: str) -> str:
def _discard_staged(staged) -> None:
"""Remove staging paths for entries that were never committed.
Otherwise a phase-1 failure (typically disk exhaustion) orphans one
staging copy per processed entry — up to a full second tree — and the
advised "re-run `hermes update`" retry fails harder with less free space.
"""Remove staging paths for never-committed entries; otherwise a phase-1 failure (disk exhaustion)
orphans up to a full second tree and the advised retry fails harder with less free space.
"""
for staging, _dst in staged:
try:
@@ -82,20 +66,11 @@ def _discard_staged(staged) -> None:
def _commit_staged_replacements(staged) -> None:
"""Phase 2: swap every staged entry into place, rolling back all on failure.
``_atomic_replace_dir`` made each *individual* swap safe, but the ZIP
update loops over ~90 top-level entries and nothing made the loop atomic
*as a whole*: a partway failure left a mixed-version tree — every file
valid, the combination unbootable (#76104; also #76091, #63717).
Covers plain files too: the repo root holds 20 first-party modules, so a
files-only failure reproduces the same bug class. Every swap is an
``os.rename`` onto a just-moved-aside path — atomic on POSIX and NTFS —
so a file swap can't leave a half-written module the way ``copy2`` onto
a live path can.
Stage-all-then-swap-all shrinks the failure window from "a full tree
copy" to "N renames" and makes it recoverable: a failed swap restores
every entry already swapped, so the tree lands wholly new or wholly old.
Per-entry safety wasn't enough: a partway failure over ~90 entries left a mixed-version tree (every
file valid, combination unbootable). Covers plain files too (repo root holds 20 first-party modules).
Each swap is an ``os.rename`` onto a just-moved-aside path — atomic on POSIX and NTFS, unlike
``copy2`` onto a live path. Stage-all-then-swap-all shrinks the failure window to N renames and a
failed swap restores every entry already swapped, so the tree lands wholly new or wholly old.
"""
swapped: list[tuple[str, str]] = [] # (dst, backup) in swap order; "" = absent
try:
@@ -118,9 +93,7 @@ def _commit_staged_replacements(staged) -> None:
if backup and os.path.exists(backup):
os.rename(backup, dst)
except OSError as exc:
# Keep restoring the rest — a silent failure here is the one
# thing that turns a recoverable rollback into a mixed tree,
# so say so rather than swallowing it.
# Keep restoring the rest; a silent failure here turns a recoverable rollback into a mixed tree.
logger.warning("rollback failed for %s: %s", dst, exc)
raise
# All swaps succeeded — drop the backups (best-effort, never fatal).
@@ -137,13 +110,10 @@ def _zip_overlay_block_reason(
) -> Optional[str]:
"""Why overlaying a ZIP onto ``root`` would destroy work, or None if safe.
The ZIP path swaps every top-level entry (minus a tiny preserve set) and
deletes the backups, so uncommitted edits and untracked files are gone.
Fails closed when git status cannot run (#87304).
``ignore_staging_artifacts`` is for the pre-swap re-check: phase 1 leaves
``*.hermes-update-staging`` siblings that git reports as untracked; they
are our own artifacts, and without the filter the re-check always refuses.
The swap replaces every top-level entry (minus a tiny preserve set) and deletes backups, so uncommitted
edits and untracked files are gone. Fails closed when git status cannot run. ``ignore_staging_artifacts``
is for the pre-swap re-check: phase 1 leaves our own ``*.hermes-update-staging`` siblings that git
reports as untracked; without the filter the re-check always refuses.
"""
if not (root / ".git").exists():
return None
@@ -151,12 +121,9 @@ def _zip_overlay_block_reason(
if sys.platform == "win32":
git_cmd = ["git", "-c", "windows.appendAtomically=false"]
result = subprocess.run(
# -uall: a user-level ``status.showUntrackedFiles = no`` must not
# blind this guard. --ignored=matching: gitignored files are still
# USER DATA the overlay would delete (#87392); ``matching`` reports an
# ignored dir as one ``dir/`` line (cheaper, same verdict below).
# NOTE: ``--ignored=all`` is NOT a valid git mode — exits 128 and
# would fail-close every ZIP update.
# -uall: a user-level ``status.showUntrackedFiles = no`` must not blind this guard. --ignored=matching:
# gitignored files are still USER DATA the overlay would delete; ``matching`` reports an ignored dir
# as one ``dir/`` line. ``--ignored=all`` is NOT a valid git mode (exits 128, would fail-close every update).
git_cmd + ["status", "--porcelain", "--untracked-files=all", "--ignored=matching"],
cwd=root,
capture_output=True,
@@ -169,10 +136,8 @@ def _zip_overlay_block_reason(
suffix = f" ({detail[0]})" if detail else ""
return f"could not check the working tree{suffix}"
lines = [line for line in (result.stdout or "").splitlines() if line.strip()]
# --ignored=all reports the ZIP path's own preserved entries (venv,
# node_modules are gitignored on every normal install). The swap never
# touches those top-level entries, so they must not turn into a false
# dirty-tree refusal. Everything else — including ignored files — blocks.
# Preserved entries (venv, node_modules are gitignored on every normal install) are never touched by the
# swap, so they must not cause a false refusal. Everything else — including ignored files — blocks.
lines = [line for line in lines if not _is_zip_preserved_entry_status_line(line)]
if ignore_staging_artifacts:
lines = [
@@ -186,20 +151,16 @@ def _zip_overlay_block_reason(
_ZIP_STAGING_ARTIFACT_SUFFIXES = (".hermes-update-staging", ".hermes-update-old")
# Single source of truth for the top-level entries the ZIP swap preserves —
# consumed by both the dirty-tree filter below and _update_via_zip's swap loop.
# Single source of truth for entries the ZIP swap preserves — used by the dirty-tree filter and the swap loop.
_ZIP_PRESERVED_TOP_LEVEL = {"venv", "node_modules", ".git", ".env"}
def _is_zip_preserved_entry_status_line(line: str) -> bool:
"""True when every path on a porcelain status line sits under a top-level
entry the ZIP swap preserves.
"""True when every path on a porcelain status line sits under a preserved top-level entry.
The ``" -> "`` split applies ONLY to rename/copy codes (R/C): porcelain
v1 doesn't quote plain filenames with spaces, so an ignored file named
``venv -> node_modules`` on a ``!!``/``??`` line is ONE path — splitting
would fail-open into the destructive swap. Requiring EVERY path preserved
keeps renames out of a preserved dir (``R venv/x -> src/x``) blocking.
The ``" -> "`` split applies ONLY to R/C codes: porcelain v1 doesn't quote plain names with spaces, so
``venv -> node_modules`` on a ``!!``/``??`` line is ONE path and splitting would fail-open. Requiring
EVERY path preserved keeps renames out of a preserved dir (``R venv/x -> src/x``) blocking.
"""
status, payload = (line[:2], line[3:]) if len(line) >= 3 else ("", line)
is_rename = any(code in "RC" for code in status)
@@ -223,7 +184,7 @@ def _is_zip_staging_artifact_status_line(line: str) -> bool:
def _abort_zip_update_if_dirty_tree() -> None:
"""Refuse to overlay a ZIP onto a dirty git checkout (#87304)."""
"""Refuse to overlay a ZIP onto a dirty git checkout."""
from hermes_cli.update_cmd import _m
reason = _zip_overlay_block_reason(_m().PROJECT_ROOT)
if reason is None:
@@ -240,9 +201,7 @@ def _abort_zip_update_if_dirty_tree() -> None:
def _download_and_swap_zip(branch: str, zip_url: str) -> None:
"""Download the source ZIP for *branch* and two-phase swap it into the checkout.
Exits the process (``sys.exit(1)``) on any failure; the two-phase replace
guarantees the install is either fully updated or fully rolled back.
``sys.exit(1)`` on any failure; the install ends fully updated or fully rolled back.
"""
from hermes_cli.update_cmd import _m
@@ -259,8 +218,7 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
print("→ Extracting...")
import stat as _stat
with zipfile.ZipFile(zip_path, "r") as zf:
# Reject zip-slip (path traversal) AND symlink members: a
# hermes-agent source ZIP never legitimately contains symlinks,
# Reject zip-slip AND symlink members: a source ZIP never legitimately contains symlinks,
# and a compromised mirror could use them to plant files anywhere.
tmp_dir_real = os.path.realpath(tmp_dir)
for member in zf.infolist():
@@ -272,8 +230,7 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
raise ValueError(
f"Zip-slip detected: {member.filename} escapes extraction directory"
)
# Unix mode lives in the upper 16 bits of external_attr;
# mask to the file-type bits.
# Unix mode lives in the upper 16 bits of external_attr; mask to the file-type bits.
mode = (member.external_attr >> 16) & 0o170000
if _stat.S_ISLNK(mode):
raise ValueError(
@@ -293,12 +250,9 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
preserve = _ZIP_PRESERVED_TOP_LEVEL
entries = [i for i in os.listdir(extracted) if i not in preserve]
# Two-phase replace (#76104): phase 1 stages every entry (dirs AND
# top-level files — the repo root holds 20 first-party modules) beside
# its target; phase 2 swaps all in with same-filesystem renames and
# rolls back on any failure. One-at-a-time replacement left `agent/`
# new and `tools/` stale on interruption: all files valid, tree
# unbootable. Staging costs one extra tree copy — check space up front.
# Two-phase replace: stage every entry (dirs AND top-level files) beside its target, then swap all
# in with same-filesystem renames, rolling back on failure — one-at-a-time replacement left a
# mixed, unbootable tree on interruption. Staging costs one extra tree copy: check space up front.
need = sum(
os.path.getsize(os.path.join(dirpath, f))
for entry in entries
@@ -309,9 +263,8 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
for e in entries
if os.path.isfile(os.path.join(extracted, e))
)
# Swaps are renames, so only the staging copy is new: require it plus
# 20% headroom, not 2x — which would block updates on exactly the
# space-constrained machines most likely to hit this path.
# Swaps are renames, so only the staging copy is new: require it plus 20% headroom, not 2x,
# which would block updates on exactly the space-constrained machines that hit this path.
required = int(need * 1.2)
free = shutil.disk_usage(str(_m().PROJECT_ROOT)).free
if free < required:
@@ -327,10 +280,8 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
src = os.path.join(extracted, item)
dst = os.path.join(str(_m().PROJECT_ROOT), item)
staged.append((_stage_replacement(src, dst), dst))
# #70337/#87331: the source ZIP lacks apps/desktop/release/
# (the BUILT desktop app); swapping `apps` without it deletes
# the build and breaks the shortcut. Graft the live release
# dir into the staged copy BEFORE the swap.
# The source ZIP lacks apps/desktop/release/ (the BUILT desktop app); swapping `apps` without
# it deletes the build and breaks the shortcut. Graft the live release dir in BEFORE the swap.
if item == "apps":
live_release = os.path.join(dst, "desktop", "release")
staged_release = os.path.join(
@@ -342,15 +293,13 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
os.makedirs(os.path.dirname(staged_release), exist_ok=True)
shutil.copytree(live_release, staged_release)
except Exception:
# Nothing is live yet; drop the partial staging copies so a retry
# starts from the same free space this attempt did.
# Nothing is live yet; drop partial staging copies so a retry starts from the same free space.
_discard_staged(staged)
raise
try:
# Re-check right before the swap (#87304 TOCTOU): download +
# extract + staging can take minutes, and work created meanwhile
# would be destroyed. Our own staging siblings are filtered out.
# TOCTOU re-check right before the swap: download + extract + staging can take minutes and
# work created meanwhile would be destroyed. Our own staging siblings are filtered out.
recheck_reason = _zip_overlay_block_reason(
_m().PROJECT_ROOT, ignore_staging_artifacts=True
)
@@ -365,11 +314,9 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
_m().sys.exit(1)
_commit_staged_replacements(staged)
except Exception:
# Rollback restored the swapped entries, but staging copies for
# the rest (possibly most of a tree) remain. Drop them, or the
# retry's up-front free-space check (which runs BEFORE per-entry
# leftover cleanup) fails on our litter. Safe post-rollback:
# _discard_staged skips paths that no longer exist.
# Rollback restored swapped entries but staging copies for the rest remain; drop them or the
# retry's up-front free-space check (runs BEFORE per-entry leftover cleanup) fails on our litter.
# Safe post-rollback: _discard_staged skips paths that no longer exist.
_discard_staged(staged)
raise
update_count = len(staged)
@@ -378,9 +325,7 @@ def _download_and_swap_zip(branch: str, zip_url: str) -> None:
except Exception as e:
print(f"✗ ZIP update failed: {e}")
# The two-phase replace either commits every entry or rolls them all
# back, so a failure here does not leave a mixed-version tree — don't
# scare the user toward a reinstall they don't need.
# Two-phase replace commits all or rolls all back, so no mixed tree here — don't push a needless reinstall.
print(" Your existing install was left in place.")
print(
" Re-run `hermes update` to retry; if the agent won't start, "
@@ -412,9 +357,8 @@ def _reinstall_python_deps_after_zip(active_tool_dependencies) -> None:
if not uv_bin:
uv_bin = _ensure_uv_for_termux(pip_cmd)
if uv_bin:
# Same third-party UV-env isolation as the main update path (#83914):
# a user-level UV_PYTHON_INSTALL_DIR / UV_PYTHON from unrelated
# software must not steer which interpreter uv resolves here.
# Same UV-env isolation as the main update path: a user-level UV_PYTHON_INSTALL_DIR / UV_PYTHON
# from unrelated software must not steer which interpreter uv resolves here.
from hermes_cli.managed_uv import managed_python_env
uv_env = managed_python_env()
@@ -425,9 +369,8 @@ def _reinstall_python_deps_after_zip(active_tool_dependencies) -> None:
try:
_m()._install_python_dependencies_with_optional_fallback([uv_bin, "pip"], env=uv_env)
except _shim_quarantine_error_type() as _sqe:
# #87331: this runs inside the ZIP-fallback error handler, so the
# boundary except clause in cmd_update cannot catch it — refuse
# here with the same defer-via-marker contract.
# Runs inside the ZIP-fallback error handler, so cmd_update's boundary except cannot catch
# it — refuse here with the same defer-via-marker contract.
_refuse_update_for_contended_shims(_sqe)
else:
# sys.executable -m pip avoids PEP 668 'externally-managed-environment' errors.
@@ -442,19 +385,13 @@ def _reinstall_python_deps_after_zip(active_tool_dependencies) -> None:
env=install_env,
)
# ZIP path parity: heal the active memory provider's bridge packages
# after the dependency reinstall, same as the git-pull path (#53272,
# #70636).
# Parity with git-pull path: heal the active memory provider's bridge packages after the reinstall.
_m()._refresh_active_memory_provider_dependencies()
def _update_via_zip(args, *, had_desktop_app_before_update: bool = False) -> bool:
"""Update Hermes Agent by downloading a ZIP archive.
Used on Windows when git file I/O is broken (antivirus, NTFS filter
drivers causing 'Invalid argument' errors on file creation).
Returns ``False`` when a Desktop rebuild ran and failed; ``True`` otherwise.
"""Update via ZIP archive; used on Windows when git file I/O is broken (antivirus / NTFS filter
drivers causing 'Invalid argument'). Returns ``False`` when a Desktop rebuild ran and failed.
"""
from hermes_cli.update_cmd import (
_finish_dashboard_update_cleanup,
@@ -472,12 +409,10 @@ def _update_via_zip(args, *, had_desktop_app_before_update: bool = False) -> boo
)
active_tool_dependencies = _m()._capture_active_tool_dependencies()
# Snapshot the pre-update version before files are replaced so the
# completion line can report the transition (prime-agent#630 port).
# Snapshot the pre-update version before files are replaced so the completion line can report it.
pre_update_version = _read_project_version()
# The static GitHub archive is fine for "main" but would silently ignore
# --branch — the exact silent-divergence bug --branch was added to
# The static archive would silently ignore --branch — the exact silent-divergence bug it exists to
# prevent. Refuse rather than lie.
branch = _m()._resolve_update_branch(args)
if branch != "main":
@@ -501,21 +436,17 @@ def _update_via_zip(args, *, had_desktop_app_before_update: bool = False) -> boo
_sweep_bytecode_after_update(branch)
# Reinstall Python deps: prefer .[all]; if one extra breaks, keep base
# deps and retry the remaining extras individually so working
# capabilities aren't silently stripped. Self-lock deferral (#86735): the
# code swap is committed; defer only the dependency sync when this
# process holds a native extension the sync must rewrite.
# Prefer .[all]; if one extra breaks, keep base deps and retry remaining extras individually so
# capabilities aren't silently stripped. Self-lock deferral: the code swap is committed; defer only
# the dependency sync when this process holds a native extension the sync must rewrite.
_m()._abort_dependency_sync_if_self_locked()
print("→ Updating Python dependencies...")
_reinstall_python_deps_after_zip(active_tool_dependencies)
# Verify the tree actually imports (catches the parse-OK-but-skewed tree
# an interrupted copy leaves). Placed *after* the dependency reinstall so
# a genuinely-new third-party requirement isn't misreported as a partial
# copy. No SHA to roll back to here — surface a concrete recovery step
# instead of reporting success over a bricked install.
# Verify the tree imports (catches the parse-OK-but-skewed tree an interrupted copy leaves). Runs
# *after* the dep reinstall so a genuinely-new third-party requirement isn't misreported as a partial
# copy. No SHA to roll back to — surface a concrete recovery step instead of success over a bricked install.
import_ok, failing_module, import_error = _validate_critical_modules_import(
_m().PROJECT_ROOT
)
@@ -539,16 +470,14 @@ def _update_via_zip(args, *, had_desktop_app_before_update: bool = False) -> boo
print("→ Syncing bundled skills...")
_print_bundled_skills_sync_report()
# Seed the model-catalog disk cache from the freshly-unpacked checkout
# (same rationale as the git-pull path in _cmd_update_impl). Non-fatal.
# Seed the model-catalog disk cache from the fresh checkout (same rationale as _cmd_update_impl). Non-fatal.
with _best_effort('Model catalog seed during zip update failed: %s'):
from hermes_cli.model_catalog import seed_cache_from_checkout
if seed_cache_from_checkout(_m().PROJECT_ROOT):
print(" ✓ Model catalog cache refreshed from checkout")
# Post-update state.db integrity guard (#68474, #97994): root home AND
# every sibling profile, each auto-restored from its own snapshot.
# state.db integrity guard: root home AND every sibling profile, each auto-restored from its own snapshot.
with _best_effort('Post-update state.db integrity check (zip path) failed: %s'):
_verify_and_restore_state_dbs_post_update()
@@ -561,8 +490,7 @@ def _update_via_zip(args, *, had_desktop_app_before_update: bool = False) -> boo
_print_curator_first_run_notice()
with _best_effort('Curator recent-run notice failed: %s'):
_print_curator_recent_run_notice()
# Don't stop a working dashboard when the Node refresh failed — see the
# git-update path for rationale (#30271).
# Don't stop a working dashboard when the Node refresh failed — see the git-update path for rationale.
_finish_dashboard_update_cleanup(node_failures)
with _best_effort('Update receipt finalize (zip path) failed: %s'):
from hermes_cli.update_receipt import finalize_update_receipt