hermes-agent/tests/hermes_state/test_state_db_stats.py
ethernet 890bbbda1f Merge remote-tracking branch 'origin/main' into ethie/pm-clean
# Conflicts:
#	apps/desktop/e2e/archived-hidden-session-recoverable.spec.ts
#	apps/desktop/e2e/bot-chat-message-agent-friendly-name.spec.ts
#	apps/desktop/e2e/bot-mailbox-unreadable-ticket.spec.ts
#	apps/desktop/e2e/bot-mode-roster-localized.spec.ts
#	apps/desktop/e2e/bot-mode-row-click-mirrors-registry.spec.ts
#	apps/desktop/e2e/bot-mode-tab-shows-bot-name.spec.ts
#	apps/desktop/e2e/bot-roster-group-row-organisation.spec.ts
#	apps/desktop/e2e/bot-roster-ignores-infra-dirs.spec.ts
#	apps/desktop/e2e/bot-roster-timestamp-meta.spec.ts
#	apps/desktop/e2e/bot-roster-user-sections.spec.ts
#	apps/desktop/e2e/bot-routines-pane-narrow.spec.ts
#	apps/desktop/e2e/bot-row-open-recent-session.spec.ts
#	apps/desktop/e2e/bot-tile-ignores-ambient-composer-model.spec.ts
#	apps/desktop/e2e/group-composer-auto-grow.spec.ts
#	apps/desktop/e2e/group-create-gate-remote-roster.spec.ts
#	apps/desktop/e2e/group-prompt-renamed-primary-handle.spec.ts
#	apps/desktop/e2e/hosted-room-backend-continuity.spec.ts
#	apps/desktop/e2e/hosted-room-legacy-store-migration.spec.ts
#	apps/desktop/e2e/settings-scope-chips-bot-title.spec.ts
#	apps/desktop/e2e/worktree-branch-status.spec.ts
#	apps/desktop/electron/backend-probes.test.ts
#	apps/desktop/electron/connection-apply.test.ts
#	apps/desktop/electron/desktop-electron-pin.test.ts
#	apps/desktop/electron/desktop-uninstall.test.ts
#	apps/desktop/electron/gateway-file-download-transport.test.ts
#	apps/desktop/electron/gateway-stop-before-update.test.ts
#	apps/desktop/electron/github-api-auth.test.ts
#	apps/desktop/electron/registry-primary-profile-scope.test.ts
#	apps/desktop/electron/update-api-check.test.ts
#	apps/desktop/electron/update-handoff-marker.test.ts
#	apps/desktop/electron/venv-blocker-scan.test.ts
#	apps/desktop/scripts/after-extract.test.mjs
#	apps/desktop/scripts/local-pack-publish.test.mjs
#	apps/desktop/scripts/tasks-scroll.test.mjs
#	apps/desktop/src/app/settings/model-settings.test.tsx
#	apps/desktop/src/app/updates-overlay.blockers.test.tsx
#	apps/desktop/src/components/desktop-install-overlay.test.tsx
#	apps/desktop/src/lib/update-copy.test.ts
#	scripts/ci/check_os_marker_fakes.py
#	tests-js/desktop-mac-usage-descriptions.test.ts
#	tests-js/node-engine-alignment.test.ts
#	tests/agent/lsp/test_install_and_lint_fixes.py
#	tests/agent/test_command_token_source.py
#	tests/agent/test_compression_boundary_hook.py
#	tests/agent/test_create_openai_client_ssl_verify.py
#	tests/agent/test_custom_provider_ca_probes.py
#	tests/agent/test_endpoint_blackhole.py
#	tests/agent/test_estimator_parity.py
#	tests/agent/test_in_place_compaction.py
#	tests/agent/test_moa_loop_mode.py
#	tests/agent/test_model_metadata.py
#	tests/agent/test_skill_session_platform_gate.py
#	tests/agent/test_skill_utils.py
#	tests/agent/test_ssl_ca_guard.py
#	tests/computer_use/test_doctor.py
#	tests/cron/test_codex_execution_paths.py
#	tests/cron/test_cron_bot_chat_delivery.py
#	tests/cron/test_cron_script.py
#	tests/cron/test_media_delivery_parity.py
#	tests/cron/test_misfire_catchup.py
#	tests/cron/test_parallel_pool.py
#	tests/cron/test_recurring_eagain_redispatch.py
#	tests/gateway/test_choice_picker.py
#	tests/gateway/test_control_socket_windows_live.py
#	tests/gateway/test_dingtalk.py
#	tests/gateway/test_feishu.py
#	tests/gateway/test_feishu_onboard.py
#	tests/gateway/test_gateway_shutdown.py
#	tests/gateway/test_matrix.py
#	tests/gateway/test_model_command_custom_providers.py
#	tests/gateway/test_reasoning_command.py
#	tests/gateway/test_runtime_footer.py
#	tests/gateway/test_session.py
#	tests/gateway/test_session_hygiene.py
#	tests/gateway/test_status.py
#	tests/gateway/test_teams.py
#	tests/gateway/test_turn_lease.py
#	tests/gateway/test_whatsapp_connect.py
#	tests/hermes_cli/test_approvals_command.py
#	tests/hermes_cli/test_auth_store_lock_concurrent.py
#	tests/hermes_cli/test_backup.py
#	tests/hermes_cli/test_banner_git_state.py
#	tests/hermes_cli/test_certifi_repair.py
#	tests/hermes_cli/test_cmd_update.py
#	tests/hermes_cli/test_compat_manifest_targets.py
#	tests/hermes_cli/test_computer_use_cli.py
#	tests/hermes_cli/test_cpr_local_leak.py
#	tests/hermes_cli/test_dashboard_auth_gate.py
#	tests/hermes_cli/test_dashboard_procs_kill_grace.py
#	tests/hermes_cli/test_desktop_lifecycle_windows_live.py
#	tests/hermes_cli/test_doctor.py
#	tests/hermes_cli/test_doctor_command_install.py
#	tests/hermes_cli/test_fleet_config_migration_windows_live.py
#	tests/hermes_cli/test_gateway.py
#	tests/hermes_cli/test_gateway_platform_gating.py
#	tests/hermes_cli/test_gateway_restart_loop.py
#	tests/hermes_cli/test_gateway_task_probe.py
#	tests/hermes_cli/test_gateway_wsl.py
#	tests/hermes_cli/test_gui_command.py
#	tests/hermes_cli/test_install_cua_driver.py
#	tests/hermes_cli/test_kanban_db.py
#	tests/hermes_cli/test_lazy_command_exports.py
#	tests/hermes_cli/test_lazy_refresh_venv_repair.py
#	tests/hermes_cli/test_linux_desktop_entry.py
#	tests/hermes_cli/test_local_runtime.py
#	tests/hermes_cli/test_local_runtime_updates.py
#	tests/hermes_cli/test_managed_uv.py
#	tests/hermes_cli/test_mcp_reload_confirm_gate.py
#	tests/hermes_cli/test_nous_subscription.py
#	tests/hermes_cli/test_npm_engine.py
#	tests/hermes_cli/test_personality_none.py
#	tests/hermes_cli/test_pet_toggle.py
#	tests/hermes_cli/test_plan_reconciliation_windows_live.py
#	tests/hermes_cli/test_plugin_event_bus.py
#	tests/hermes_cli/test_plugin_manifest_v2.py
#	tests/hermes_cli/test_plugin_packs.py
#	tests/hermes_cli/test_plugins_cmd.py
#	tests/hermes_cli/test_plugins_cmd_enable_disable_nested.py
#	tests/hermes_cli/test_process_identity.py
#	tests/hermes_cli/test_profiles.py
#	tests/hermes_cli/test_profiles_sidebar_cache.py
#	tests/hermes_cli/test_pty_bridge.py
#	tests/hermes_cli/test_resolve_turn_limit.py
#	tests/hermes_cli/test_serve_runtime_inventory.py
#	tests/hermes_cli/test_session_vacuum_config.py
#	tests/hermes_cli/test_set_config_value.py
#	tests/hermes_cli/test_signal_handler_kanban_worker.py
#	tests/hermes_cli/test_slash_confirm_windows.py
#	tests/hermes_cli/test_stale_pid_guard.py
#	tests/hermes_cli/test_startup_fast_guards.py
#	tests/hermes_cli/test_status.py
#	tests/hermes_cli/test_telegram_managed_bot.py
#	tests/hermes_cli/test_tools_config.py
#	tests/hermes_cli/test_update_apply_shallow_count.py
#	tests/hermes_cli/test_update_autostash.py
#	tests/hermes_cli/test_update_concurrent_quarantine.py
#	tests/hermes_cli/test_update_fetch_failure_classifier.py
#	tests/hermes_cli/test_update_fleet_probe_resume_token.py
#	tests/hermes_cli/test_update_handoff_backend_reap.py
#	tests/hermes_cli/test_update_handoff_desktop_rebuild.py
#	tests/hermes_cli/test_update_head_moved_gate.py
#	tests/hermes_cli/test_update_host_obligation.py
#	tests/hermes_cli/test_update_import_guard.py
#	tests/hermes_cli/test_update_interrupted_recovery.py
#	tests/hermes_cli/test_update_inventory.py
#	tests/hermes_cli/test_update_launchd_unloaded_gateway.py
#	tests/hermes_cli/test_update_missing_configured_deps.py
#	tests/hermes_cli/test_update_modified_notice.py
#	tests/hermes_cli/test_update_multiplex_migration_hook.py
#	tests/hermes_cli/test_update_no_gateway_restart.py
#	tests/hermes_cli/test_update_orphan_backend_reap.py
#	tests/hermes_cli/test_update_parked_branch_guard.py
#	tests/hermes_cli/test_update_post_pull_syntax_guard.py
#	tests/hermes_cli/test_update_receipt.py
#	tests/hermes_cli/test_update_self_lock.py
#	tests/hermes_cli/test_update_shim_fail_closed.py
#	tests/hermes_cli/test_update_shim_self_lock.py
#	tests/hermes_cli/test_update_sqlite_remediation.py
#	tests/hermes_cli/test_update_stale_dashboard.py
#	tests/hermes_cli/test_update_stale_virtualenv.py
#	tests/hermes_cli/test_update_venv_health.py
#	tests/hermes_cli/test_update_venv_ownership_preflight.py
#	tests/hermes_cli/test_update_wedged_gateway.py
#	tests/hermes_cli/test_update_yes_flag.py
#	tests/hermes_cli/test_update_zip_two_phase.py
#	tests/hermes_cli/test_urllib_security.py
#	tests/hermes_cli/test_ux_messages_auth_config.py
#	tests/hermes_cli/test_ux_messages_startup.py
#	tests/hermes_cli/test_venv_holder_classifier.py
#	tests/hermes_cli/test_verify_console_scripts.py
#	tests/hermes_cli/test_verify_core_dependencies.py
#	tests/hermes_cli/test_web_server.py
#	tests/hermes_cli/test_web_server_console_ws.py
#	tests/hermes_cli/test_web_server_ws_ping.py
#	tests/hermes_cli/test_web_ui_build.py
#	tests/hermes_state/test_fts_rebuild_admission.py
#	tests/hermes_state/test_hermes_state.py
#	tests/plugins/memory/test_memory_lazy_install.py
#	tests/plugins/test_google_meet_plugin.py
#	tests/plugins/test_langfuse_plugin.py
#	tests/plugins/test_security_guidance_plugin.py
#	tests/plugins/test_transform_llm_output_hook.py
#	tests/scripts/desktop_update/test_desktop_update_windows_gateway_flag.py
#	tests/scripts/desktop_update/test_desktop_update_windows_python_handoff.py
#	tests/scripts/desktop_update/test_desktop_update_windows_timestamp.py
#	tests/scripts/install/test_install_clone_throttle_fallback.py
#	tests/scripts/install/test_install_lockfile_churn.py
#	tests/scripts/install/test_install_no_initial_commit.py
#	tests/scripts/install/test_install_sh_browser_install.py
#	tests/scripts/install/test_install_sh_node_prerelease.py
#	tests/scripts/install/test_install_sh_symlink_stomp.py
#	tests/scripts/install/test_install_sh_uv_lock_config.py
#	tests/scripts/install/test_install_unmerged_index.py
#	tests/scripts/test_contributor_map.py
#	tests/scripts/test_run_tests_parallel.py
#	tests/skills/test_competitor_news_monitor_skill.py
#	tests/skills/test_document_to_action_items_skill.py
#	tests/skills/test_google_workspace_setup.py
#	tests/skills/test_google_workspace_setup_deps.py
#	tests/skills/test_grounded_citations_skill.py
#	tests/skills/test_ip_as_logo_skill.py
#	tests/skills/test_live_dashboard_skill.py
#	tests/skills/test_mcp_oauth_remote_gateway_skill.py
#	tests/skills/test_office_document_skills.py
#	tests/skills/test_openclaw_migration.py
#	tests/skills/test_product_price_monitor_skill.py
#	tests/skills/test_scrollcraft_skill.py
#	tests/skills/test_setup_wizard_generator_skill.py
#	tests/skills/test_weekly_review_planning_skill.py
#	tests/test_engines_satisfiable.py
#	tests/test_fast_safe_load.py
#	tests/test_hermes_bootstrap.py
#	tests/test_hermes_constants.py
#	tests/test_hermes_logging.py
#	tests/test_managed_runtime_resolution.py
#	tests/test_model_tools_async_bridge.py
#	tests/test_packaging_build_guard.py
#	tests/test_packaging_metadata.py
#	tests/test_yaml_indent_consistency.py
#	tests/tools/test_approval_timeout_overflow.py
#	tests/tools/test_base_environment.py
#	tests/tools/test_bot_mode_dm.py
#	tests/tools/test_browser_chromium_check.py
#	tests/tools/test_browser_hardening.py
#	tests/tools/test_browser_homebrew_paths.py
#	tests/tools/test_browser_npx_warmup.py
#	tests/tools/test_browser_orphan_reaper.py
#	tests/tools/test_browser_real_profile.py
#	tests/tools/test_browser_use_cli.py
#	tests/tools/test_clipboard.py
#	tests/tools/test_code_execution.py
#	tests/tools/test_code_execution_modes.py
#	tests/tools/test_code_execution_windows_env.py
#	tests/tools/test_computer_use.py
#	tests/tools/test_delegate_liveness_timeout.py
#	tests/tools/test_execute_code_approval_cluster.py
#	tests/tools/test_execution_flag_detection.py
#	tests/tools/test_fal_common.py
#	tests/tools/test_file_operations.py
#	tests/tools/test_file_tools.py
#	tests/tools/test_file_tools_cwd_resolution.py
#	tests/tools/test_file_tools_live.py
#	tests/tools/test_lazy_deps.py
#	tests/tools/test_lazy_deps_durable_target.py
#	tests/tools/test_lazy_deps_managed.py
#	tests/tools/test_local_env_blocklist.py
#	tests/tools/test_local_tempdir.py
#	tests/tools/test_macos_protected_search.py
#	tests/tools/test_mcp_npx_cached_bin.py
#	tests/tools/test_oneshot_completion_linger.py
#	tests/tools/test_process_registry.py
#	tests/tools/test_read_file_schema_gating.py
#	tests/tools/test_skill_improvements.py
#	tests/tools/test_skills_sync.py
#	tests/tools/test_termux_api_detection.py
#	tests/tools/test_tirith_security.py
#	tests/tools/test_transcription_tools.py
#	tests/tools/test_tts_streaming.py
#	tests/tools/test_wake_word.py
#	tests/tui_gateway/test_compute_host_borrowed_lease.py
#	tests/tui_gateway/test_compute_host_turn_protocol.py
#	tests/tui_gateway/test_isolated_orphan_activity.py
#	tests/tui_gateway/test_protocol.py
#	tests/tui_gateway/test_slash_worker_profile_home.py
#	tests/tui_gateway/test_subprocess_encoding.py
#	tests/tui_gateway/test_tui_gateway_server.py
#	ui-tui/src/__tests__/terminalParity.test.ts
#	ui-tui/src/__tests__/termuxComposerLayout.test.ts
#	ui-tui/src/__tests__/textInputFastEcho.test.ts
2026-09-23 07:02:44 -04:00

251 lines
8.6 KiB
Python

"""Tests for state.db health/stats collection (hermes doctor section).
Covers:
- ``hermes_state_dbfile.collect_state_db_stats``: read-only, best-effort stats
(page_count, freelist, WAL size, journal mode, row counts, FTS presence,
pending v23 FTS-rebuild bookkeeping).
- ``hermes_state_dbfile.count_db_holders``: best-effort probe for how many processes
hold the DB file open (/proc on Linux, libproc on macOS; None elsewhere/on error).
- ``hermes_cli.doctor_state._render_state_db_stats``: formatting/threshold helper
the doctor state.db section prints from.
"""
import json
import sqlite3
import pytest
from hermes_state import SessionDB
from hermes_state_dbfile import collect_state_db_stats, count_db_holders
@pytest.fixture()
def populated_db(tmp_path):
"""A real state.db built through SessionDB's public API, then closed."""
db_path = tmp_path / "state.db"
db = SessionDB(db_path=db_path)
db.create_session("sess-alpha", "cli")
db.create_session("sess-beta", "cli")
db.append_message("sess-alpha", "user", "hello world one")
db.append_message("sess-alpha", "assistant", "hi back")
db.append_message("sess-beta", "user", "second session message")
db.close()
return db_path
# ── collect_state_db_stats ──────────────────────────────────────────────
def test_collect_stats_sane_values(populated_db):
stats = collect_state_db_stats(populated_db)
assert isinstance(stats, dict)
assert stats["page_count"] and stats["page_count"] > 0
assert stats["page_size"] and stats["page_size"] > 0
assert stats["logical_size_bytes"] == stats["page_count"] * stats["page_size"]
assert isinstance(stats["freelist_count"], int) and stats["freelist_count"] >= 0
assert isinstance(stats["wal_size_bytes"], int) and stats["wal_size_bytes"] >= 0
assert isinstance(stats["journal_mode"], str) and stats["journal_mode"]
assert stats["messages"] >= 3
assert stats["sessions"] >= 2
fts = stats["fts_tables"]
assert set(fts) == {"messages_fts", "messages_fts_trigram", "messages_fts_cjk"}
for name, present in fts.items():
assert isinstance(present, bool), name
# Layout marker is absent (None) on legacy DBs, an int once stamped.
assert stats["fts_storage_version"] is None or isinstance(
stats["fts_storage_version"], int
)
# No rebuild pending on a fresh DB.
assert stats["fts_rebuild_pending"] in (False, None)
def test_collect_stats_is_read_only(populated_db):
before_bytes = populated_db.read_bytes()
before_mtime = populated_db.stat().st_mtime_ns
collect_state_db_stats(populated_db)
assert populated_db.read_bytes() == before_bytes
assert populated_db.stat().st_mtime_ns == before_mtime
# No stray -wal/-shm growth from the probe either: a subsequent normal
# open must still work.
db = SessionDB(db_path=populated_db)
assert db.get_session("sess-alpha") is not None
db.close()
def test_collect_and_render_stale_fts_holder_deferral(populated_db):
conn = sqlite3.connect(str(populated_db))
conn.execute(
"INSERT INTO state_meta (key, value) VALUES (?, ?)",
(
"fts_rebuild_deferral",
json.dumps({"attempts": 4, "holder_pids": [4242], "first_seen": 1.0}),
),
)
conn.commit()
conn.close()
stats = collect_state_db_stats(populated_db)
assert stats["fts_rebuild_deferral"]["attempts"] == 4
assert stats["fts_rebuild_deferral"]["holder_pids"] == [4242]
from hermes_cli.doctor_state import _render_state_db_stats
rendered = _render_state_db_stats(stats)
warnings = [
" ".join((text, detail))
for kind, text, detail in rendered
if kind == "warn"
]
assert any("4242" in warning and "optimize-storage" in warning for warning in warnings)
def test_collect_stats_missing_file_never_raises(tmp_path):
stats = collect_state_db_stats(tmp_path / "nope" / "state.db")
assert isinstance(stats, dict)
assert stats["page_count"] is None
assert stats["messages"] is None
assert stats["logical_size_bytes"] is None
def test_collect_stats_rebuild_pending_flag(populated_db):
# Simulate the v23 deferred-rebuild bookkeeping directly in state_meta.
conn = sqlite3.connect(str(populated_db))
conn.execute(
"INSERT OR REPLACE INTO state_meta(key, value) VALUES ('fts_rebuild_high_water', '100')"
)
conn.execute(
"INSERT OR REPLACE INTO state_meta(key, value) VALUES ('fts_rebuild_progress', '40')"
)
conn.commit()
conn.close()
stats = collect_state_db_stats(populated_db)
assert stats["fts_rebuild_pending"] is True
assert stats["fts_rebuild_high_water"] == 100
assert stats["fts_rebuild_progress"] == 40
# ── count_db_holders ────────────────────────────────────────────────────
def _assert_sees_own_open_connection(db_path):
conn = sqlite3.connect(str(db_path))
try:
holders = count_db_holders(db_path)
assert isinstance(holders, int)
assert holders >= 1
finally:
conn.close()
@pytest.mark.platforms("linux")
def test_count_db_holders_sees_open_connection_linux(populated_db):
_assert_sees_own_open_connection(populated_db)
@pytest.mark.platforms("macos")
def test_count_db_holders_sees_open_connection_macos(populated_db):
# #109641: the doctor's holder count was Linux-only, so `hermes doctor` on the platform with
# every reporter in the deleted-WAL cluster printed no holder row at all.
_assert_sees_own_open_connection(populated_db)
def test_count_db_holders_missing_path_no_raise(tmp_path):
holders = count_db_holders(tmp_path / "absent.db")
assert holders is None or isinstance(holders, int)
# ── doctor rendering helper ─────────────────────────────────────────────
def _base_stats(**overrides):
stats = {
"page_count": 100,
"page_size": 4096,
"freelist_count": 2,
"logical_size_bytes": 100 * 4096,
"wal_size_bytes": 1024,
"journal_mode": "wal",
"messages": 42,
"sessions": 7,
"fts_tables": {
"messages_fts": True,
"messages_fts_trigram": True,
"messages_fts_cjk": False,
},
"fts_storage_version": 1,
"fts_rebuild_pending": False,
"fts_rebuild_high_water": None,
"fts_rebuild_progress": None,
}
stats.update(overrides)
return stats
def test_render_healthy_stats_no_warnings():
from hermes_cli.doctor_state import _render_state_db_stats
lines = _render_state_db_stats(_base_stats(), holders=2)
kinds = [k for k, *_ in lines]
assert "warn" not in kinds
joined = " | ".join(text for _, text, *_ in lines)
assert "42" in joined # messages
assert "7" in joined # sessions
assert "wal" in joined.lower()
assert "2" in joined # holders
def test_render_warns_on_large_db():
from hermes_cli.doctor_state import STATE_DB_SIZE_WARN_BYTES, _render_state_db_stats
big = STATE_DB_SIZE_WARN_BYTES + 1
lines = _render_state_db_stats(
_base_stats(logical_size_bytes=big, page_count=big // 4096, page_size=4096),
holders=None,
)
warns = [t for k, t, *rest in lines if k == "warn"] + [
" ".join(rest) for k, t, *rest in lines if k == "warn"
]
assert warns
def test_render_large_db_with_pending_rebuild_suggests_optimize():
from hermes_cli.doctor_state import STATE_DB_SIZE_WARN_BYTES, _render_state_db_stats
big = STATE_DB_SIZE_WARN_BYTES + 1
lines = _render_state_db_stats(
_base_stats(logical_size_bytes=big, fts_rebuild_pending=True),
holders=None,
)
blob = " ".join(" ".join(str(p) for p in line) for line in lines)
assert "optimize-storage" in blob
def test_render_large_db_legacy_trigram_suggests_optimize():
from hermes_cli.doctor_state import STATE_DB_SIZE_WARN_BYTES, _render_state_db_stats
big = STATE_DB_SIZE_WARN_BYTES + 1
lines = _render_state_db_stats(
_base_stats(logical_size_bytes=big, fts_storage_version=None),
holders=None,
)
blob = " ".join(" ".join(str(p) for p in line) for line in lines)
assert "optimize-storage" in blob
def test_render_handles_all_none_stats():
from hermes_cli.doctor_state import _render_state_db_stats
empty = {k: None for k in _base_stats()}
empty["fts_tables"] = None
lines = _render_state_db_stats(empty, holders=None)
assert isinstance(lines, list) # must not raise