hermes-agent/hermes_cli/update_cmd_config.py

"""Post-``hermes update`` config-schema migration for the active profile and every sibling.
Names are re-imported by ``update_cmd`` (``hermes_cli.update_cmd.<name>`` resolves/monkeypatches);
origin helpers are imported lazily."""

import logging
import sys
from pathlib import Path

from hermes_cli.update_cmd_common import _best_effort

# Log-record parity with the origin module.
logger = logging.getLogger("hermes_cli.update_cmd")


def _run_config_check_fresh() -> tuple:
    """``(current_ver, latest_ver)`` of the active profile's config against the running code."""
    from hermes_cli.config import check_config_version
    return check_config_version(raise_on_parse_error=True)


def _run_migrate_config_fresh(*, interactive: bool = False, quiet: bool = False) -> dict:
    """Run config migration; returns the results dict."""
    from hermes_cli.config import migrate_config
    return migrate_config(interactive=interactive, quiet=quiet)


def _migrate_sibling_profile_configs() -> list[tuple[str, int, int]]:
    """Migrate every SIBLING profile's config.yaml (the shared checkout serves all profiles). Per
    sibling (active skipped): scope via the context-local HERMES_HOME override (never ``os.environ``)
    and run the NON-INTERACTIVE quiet migration — prompt-requiring settings wait for that profile's
    own session. Returns ``[(name, from_version, to_version), ...]``; never raises.

    91277 Phase 2 (fleet-wide config migration; #20438/#54926/#79048): the shared checkout serves every
    profile, but ``hermes update`` historically migrated only the active profile's config — siblings drifted
    versions until their gateway hit a config the new code couldn't read.
    """
    from hermes_cli.update_cmd import _run_config_check_fresh, _run_migrate_config_fresh
    migrated: list[tuple[str, int, int]] = []
    with _best_effort('Sibling profile enumeration failed: %s'):
        from hermes_constants import (
            get_process_hermes_home, reset_hermes_home_override, set_hermes_home_override)
        from hermes_cli.profiles import _get_profiles_root, _PROFILE_ID_RE
        active_home = get_process_hermes_home()
        root = _get_profiles_root()
        if not root.is_dir():
            return migrated
        for entry in sorted(root.iterdir()):
            if not entry.is_dir() or not _PROFILE_ID_RE.match(entry.name):
                continue
            try:
                if entry.resolve() == Path(active_home).resolve():
                    continue
            except OSError:
                continue
            if not (entry / "config.yaml").is_file():
                continue  # profile never configured — nothing to migrate
            token = set_hermes_home_override(entry)
            try:
                current_ver, latest_ver = _run_config_check_fresh()
                if current_ver >= latest_ver:
                    continue
                _run_migrate_config_fresh(interactive=False, quiet=True)
                after_ver, _ = _run_config_check_fresh()
                if after_ver > current_ver:
                    migrated.append((entry.name, current_ver, after_ver))
            except Exception as exc:
                logger.debug("Config migration for profile %s failed: %s", entry.name, exc)
            finally:
                reset_hermes_home_override(token)
    return migrated


def _restore_snapshot_safety_nets(pre_update_snapshot_id) -> None:
    """Post-migration safety nets (never break an otherwise-good update): restore cron jobs
    emptied by migrations/the desktop scheduler and protected model settings (model.provider /
    model.default / moa:) rewritten by Desktop repair cycles — for the active profile (from
    *pre_update_snapshot_id*) and every sibling profile (against ITS OWN snapshot)."""
    def _cron_line(r):
        return (
            f"cron/jobs.json lost jobs during this update — restored {r['job_count']} job(s) "
            f"from pre-update snapshot {r['snapshot_id']}.")

    def _cfg_line(r):
        return (
            f"config.yaml user model settings were rewritten during this update — restored "
            f"{', '.join(r['keys'])} from pre-update snapshot {r['snapshot_id']}.")

    with _best_effort("Cron jobs auto-restore check failed: %s"):
        # Safety net: config-version migrations have been observed to leave cron/jobs.json valid-but-empty,
        # silently dropping every scheduled job (issue #34600). The desktop scheduler can also overwrite
        # with its own small set, causing partial loss (issue #52144). If the live file now has fewer jobs
        # than the pre-update snapshot, restore it and warn loudly.
        from hermes_cli.backup import restore_cron_jobs_if_emptied
        cron_restore = restore_cron_jobs_if_emptied(pre_update_snapshot_id)
        if cron_restore:
            print()
            print(f"  ⚠️  {_cron_line(cron_restore)}")
    with _best_effort("Config model-settings auto-restore check failed: %s"):
        from hermes_cli.backup import restore_config_model_settings_if_rewritten
        cfg_restore = restore_config_model_settings_if_rewritten(pre_update_snapshot_id)
        if cfg_restore:
            print()
            print(f"  ⚠️  {_cfg_line(cfg_restore)}")
    with _best_effort('Sibling cron auto-restore check failed: %s'):
        from hermes_cli.backup import restore_cron_jobs_all_profiles
        for _restored in restore_cron_jobs_all_profiles(_LAST_SIBLING_SNAPSHOTS):
            print()
            print(f"  ⚠️  Profile '{_restored['profile']}': {_cron_line(_restored)}")
    with _best_effort('Sibling config auto-restore check failed: %s'):
        from hermes_cli.backup import restore_config_model_settings_all_profiles
        for _cfg_restored in restore_config_model_settings_all_profiles(_LAST_SIBLING_SNAPSHOTS):
            print()
            print(f"  ⚠️  Profile '{_cfg_restored['profile']}': {_cfg_line(_cfg_restored)}")


def _ask_configure_new_options(*, assume_yes: bool, gateway_mode: bool) -> str:
    """The yes/no answer for "configure new options now?": "y" under --yes, the messenger's reply in
    gateway mode, "auto" (safe migrations only) when non-interactive, else ``input()``."""
    from hermes_cli.update_cmd import _gateway_prompt
    if assume_yes:
        print("  ℹ --yes: auto-applying config migration (skipping API-key prompts).")
        return "y"
    if gateway_mode:
        return _gateway_prompt("Would you like to configure new options now? [Y/n]", "n").strip().lower()
    if not (sys.stdin.isatty() and sys.stdout.isatty()):
        print("  ℹ Non-interactive session — applying safe config migrations.")
        return "auto"
    try:
        return input("Would you like to configure them now? [Y/n]: ").strip().lower()
    except EOFError:
        return "n"
    except UnicodeDecodeError:
        # Non-UTF-8 locales / embedded terminals can make input() raise this.
        print(
            "  ⚠ Could not read input (encoding issue). Skipping. "
            "Run 'hermes config migrate' manually to configure.")
        return "n"


def _check_and_apply_config_migration(
    *, assume_yes: bool = False, gateway_mode: bool = False, pre_update_snapshot_id: str | None = None
) -> None:
    """Check/apply config migrations. Runs on EVERY completion path
    (post-pull, venv-repair, Node-deps repair on ``commit_count == 0``) so an interrupted update
    that already pulled code doesn't strand an old config version.

    See #91360.
    """
    from hermes_cli.update_cmd import (
        _migrate_sibling_profile_configs, _run_config_check_fresh, _run_migrate_config_fresh)
    print()
    print("→ Checking configuration for new options...")
    # A config-check failure must not break an otherwise-successful update; it still fails
    # when the pulled tree is internally inconsistent, hence the try.
    try:
        from hermes_cli.config import get_missing_env_vars, get_missing_config_fields
        # Log, point at the manual command, and return. See #91360.
        missing_env = get_missing_env_vars(required_only=True)
        missing_config = get_missing_config_fields()
        current_ver, latest_ver = _run_config_check_fresh()
    except Exception as exc:
        logger.debug("Config check during update failed: %s", exc)
        print("  ⚠️  Could not check config version.")
        print("     Run 'hermes config migrate' to check manually.")
        return

    has_new_options = bool(missing_env or missing_config)
    version_bump_only = not has_new_options and current_ver < latest_ver
    needs_migration = has_new_options or current_ver < latest_ver

    if version_bump_only:
        # Only the format version changed (defaults merge transparently); prompting
        # would look like a no-op on yes — apply silently and say what happened.
        print()
        print(f"  ℹ Updating config format (v{current_ver} → v{latest_ver})…")
        try:
            _mig_results = _run_migrate_config_fresh(interactive=False, quiet=True)
            print("  ✓ Config format updated (no new settings to configure)")
            # quiet=True also mutes steps that RESET/REMOVE a setting; re-surface them so an
            # unattended update never silently changes config (config_added holds only mutations here).
            # In this branch missing_config is empty, so config_added can only contain migration-step
            # mutations, not missing-key listings. See #81946, #86656.
            for _note in _mig_results.get("config_added") or []:
                print(f"  ℹ {_note}")
            for _warn in _mig_results.get("warnings") or []:
                print(f"  ⚠️  {_warn}")
        except Exception as _mig_err:
            print(f"  ⚠️  Config format update failed: {_mig_err}")
            print("     Run 'hermes config migrate' to retry.")
    elif needs_migration:
        print()
        # Show WHAT changed, not just a count, for an informed yes/no.
        if missing_env:
            print(f"  ⚠️  {len(missing_env)} new required setting(s) need configuration")
            _print_items(missing_env, "New settings", "name")
        if missing_config:
            print(f"  ℹ️  {len(missing_config)} new config option(s) available")
            _print_items(missing_config, "New options", "key")

        print()
        response = _ask_configure_new_options(assume_yes=assume_yes, gateway_mode=gateway_mode)
        if response in {"", "y", "yes", "auto"}:
            print()
            # Gateway/--yes/non-interactive can't prompt for API keys; still run the
            # non-interactive pass so defaults and version bumps land before the gateway restarts.
            unattended = gateway_mode or assume_yes or response == "auto"
            results = _run_migrate_config_fresh(interactive=not unattended, quiet=False)
            if results["env_added"] or results["config_added"]:
                print()
                print("✓ Configuration updated!")
            if unattended and missing_env:
                print("  ℹ API keys require manual entry: hermes config migrate")
        else:
            print()
            print("Skipped. Run 'hermes config migrate' later to configure.")
    else:
        print("  ✓ Configuration is up to date")

    # The migration above touched only the active profile; run the same NON-INTERACTIVE
    # migration per sibling home via the context-local HERMES_HOME override (never os.environ).
    with _best_effort('Sibling config migration failed: %s'):
        for _name, _from_ver, _to_ver in _migrate_sibling_profile_configs():
            print(f"  ✓ Profile '{_name}': config format updated (v{_from_ver} → v{_to_ver})")

    _restore_snapshot_safety_nets(pre_update_snapshot_id)


# {profile: snapshot_id} from this run's pre-update backup, consumed by the per-profile
# safety nets. Module-level because snapshot and restore run far apart in _cmd_update_impl.
_LAST_SIBLING_SNAPSHOTS: dict = {}


def _print_items(items, label, key, fallback_key=None):
    if not items:
        return
    print(f"  {label}:")
    shown = items[:8]
    for it in shown:
        # Defensive: some callers/mocks pass bare name strings.
        if isinstance(it, dict):
            name = it.get(key) or (fallback_key and it.get(fallback_key)) or "?"
            desc = (it.get("description") or "").strip()
        else:
            name, desc = str(it), ""
        print(f"      • {name} — {desc}" if desc else f"      • {name}")
    if len(items) > len(shown):
        print(f"      … and {len(items) - len(shown)} more")