| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191 |
- """Structured logging with steady-state silence for the LSP layer.
- LSP fires on every write_file/patch, so the level model keeps ``agent.log`` greppable
- (``rg 'lsp\\['``) without noise: DEBUG for steady-state events with no novel signal (clean,
- skipped, repeat "no project root" / "server unavailable"); INFO for once-per-session
- transitions (first ``active for <root>``, first ``no project root`` per file) and every
- diagnostic event; WARNING for action-required failures (first ``server unavailable`` per
- (server_id, binary), every timeout / unexpected error). Dedup uses module-level sets bounded
- by the distinct pairs touched in one process, each capped at ``_ANNOUNCE_CAP`` keys: past it the
- bucket resets and the first-seen line re-fires once, so per-file keys can't grow for the life of
- a gateway process (#62950).
- """
- from __future__ import annotations
- import logging
- import os
- import threading
- from typing import List, Optional, Tuple
- # Dedicated logger name so the documented grep recipe survives any
- # ``logging.getLogger(__name__)`` rename of internal modules.
- event_log = logging.getLogger("hermes.lint.lsp")
- _announce_lock = threading.Lock()
- _ANNOUNCE_CAP = 512
- _announced_active: set = set() # keys: (server_id, workspace_root)
- _announced_unavailable: set = set() # keys: (server_id, binary_path_or_name)
- _announced_no_root: set = set() # keys: (server_id, file_path)
- _announced_skipped: set = set() # keys: (server_id, workspace_root)
- _announced_excluded: set = set() # keys: (server_id, workspace_root)
- _announced_untrusted: set = set() # keys: (server_id, workspace_root)
- _ALL_BUCKETS = (_announced_active, _announced_unavailable, _announced_no_root, _announced_skipped, _announced_excluded,
- _announced_untrusted)
- def _short_path(file_path: str) -> str:
- """Render *file_path* relative to cwd when it's inside it, else absolute (no ``../..`` chains)."""
- if not file_path:
- return file_path
- try:
- rel = os.path.relpath(file_path)
- except (ValueError, OSError):
- # Different drive (ValueError) or the process cwd was removed (OSError from getcwd):
- # a log-line shortener must never turn a delivered diagnostic into a swallowed error.
- return file_path
- return file_path if rel.startswith(".." + os.sep) or rel == ".." else rel
- def _emit(server_id: str, level: int, message: str) -> None:
- event_log.log(level, "lsp[%s] %s", server_id, message)
- def _emit_once(bucket: set, key: tuple, server_id: str, level: int, first: str, repeat: str) -> None:
- """Log *first* at *level* the first time *key* is seen, *repeat* at DEBUG thereafter."""
- with _announce_lock:
- is_first = key not in bucket
- if is_first and len(bucket) >= _ANNOUNCE_CAP:
- bucket.clear()
- bucket.add(key)
- _emit(server_id, level if is_first else logging.DEBUG, first if is_first else repeat)
- # ---- Public event helpers — call these from the LSP layer ----
- def log_clean(server_id: str, file_path: str) -> None:
- """No diagnostics emitted for *file_path*. DEBUG."""
- _emit(server_id, logging.DEBUG, f"clean ({_short_path(file_path)})")
- def log_disabled(server_id: str, file_path: str, reason: str) -> None:
- """LSP intentionally skipped for this file (feature off, ext unmapped, ...). DEBUG."""
- _emit(server_id, logging.DEBUG, f"skipped: {reason} ({_short_path(file_path)})")
- def log_active(server_id: str, workspace_root: str) -> None:
- """A client started for (server_id, workspace_root). INFO once per pair, DEBUG thereafter."""
- _emit_once(_announced_active, (server_id, workspace_root), server_id, logging.INFO,
- f"active for {workspace_root}", f"reused client for {workspace_root}")
- def log_diagnostics(server_id: str, file_path: str, count: int) -> None:
- """Diagnostics arrived for a file. INFO every time — rare per edit and what users grep for."""
- _emit(server_id, logging.INFO, f"{count} diags ({_short_path(file_path)})")
- def log_no_project_root(server_id: str, file_path: str) -> None:
- """File had no recognised project marker. INFO once per file, DEBUG thereafter."""
- msg = f"no project root for {_short_path(file_path)}"
- _emit_once(_announced_no_root, (server_id, file_path), server_id, logging.INFO, msg, msg)
- def log_server_unavailable(server_id: str, binary_or_pkg: str) -> None:
- """Server binary unresolved. WARNING once per (server_id, binary), DEBUG thereafter."""
- _emit_once(
- _announced_unavailable, (server_id, binary_or_pkg), server_id, logging.WARNING,
- f"server unavailable: {binary_or_pkg} not found "
- "(install via `hermes lsp install <id>` or set lsp.servers.<id>.command)",
- f"server still unavailable: {binary_or_pkg}",
- )
- def log_timeout(server_id: str, file_path: str, kind: str = "diagnostics") -> None:
- """A request to the server timed out. WARNING every time."""
- _emit(server_id, logging.WARNING, f"{kind} timed out for {_short_path(file_path)}")
- def log_server_error(server_id: str, file_path: str, exc: BaseException) -> None:
- """An unexpected exception bubbled out of the LSP layer. WARNING."""
- _emit(server_id, logging.WARNING, f"unexpected error for {_short_path(file_path)}: {type(exc).__name__}: {exc}")
- def log_spawn_failed(server_id: str, workspace_root: str, exc: BaseException) -> None:
- """The LSP server failed to spawn or initialize. WARNING."""
- _emit(server_id, logging.WARNING, f"spawn/initialize failed for {workspace_root}: {type(exc).__name__}: {exc}")
- def log_skipped_broken(server_id: str, workspace_root: str, file_path: str, retry_in: Optional[float] = None) -> None:
- """A request was skipped because ``(server_id, root)`` is marked broken. INFO once per root, then DEBUG:
- at default log levels a skipped file and a clean file otherwise look identical (``log_clean`` is DEBUG).
- ``retry_in`` (seconds, from ``lsp.broken_retry_seconds``) names when the pair gets another try."""
- until = f"retry in {retry_in:.0f}s" if retry_in is not None else "no diagnostics for this root until restart"
- _emit_once(_announced_skipped, (server_id, workspace_root), server_id, logging.INFO,
- f"skipping {_short_path(file_path)}: {workspace_root} marked broken after an earlier failure ({until})",
- f"skipping {_short_path(file_path)}: {workspace_root} marked broken")
- def log_root_excluded(server_id: str, workspace_root: str, file_path: str, *, invalid: bool = False) -> None:
- """``workspace_root`` matches ``lsp.exclude_roots`` (or the key is malformed and every root is skipped).
- INFO once per root — a deliberate gate must still be visible, or an excluded file looks like a clean one —
- DEBUG thereafter."""
- why = "lsp.exclude_roots is not a list (fix the key)" if invalid else "matches lsp.exclude_roots"
- _emit_once(_announced_excluded, (server_id, workspace_root), server_id, logging.INFO,
- f"skipping {_short_path(file_path)}: {workspace_root} {why}",
- f"skipping {_short_path(file_path)}: {workspace_root} excluded")
- def log_untrusted_skipped(server_id: str, workspace_root: str, file_path: str) -> None:
- """``server_id`` is not safe in an untrusted workspace and ``workspace_root`` is not trusted.
- INFO once per root (a deliberate gate must not look like a clean file), DEBUG thereafter."""
- _emit_once(_announced_untrusted, (server_id, workspace_root), server_id, logging.INFO,
- f"skipped: untrusted workspace {workspace_root} ({_short_path(file_path)}); "
- "add it to lsp.trusted_workspaces to run this server there",
- f"skipped: untrusted workspace {workspace_root}")
- def log_reaped(keys: list[tuple[str, str]], idle_timeout: float) -> None:
- """Idle clients were reaped. INFO, one line per sweep.
- Also forgets the ``log_active`` announcement for those keys so a respawn
- re-announces at INFO instead of a misleading DEBUG "reused client".
- """
- with _announce_lock:
- _announced_active.difference_update(keys)
- summary = ", ".join(f"{sid} ({root})" for sid, root in keys)
- _emit("reaper", logging.INFO, f"reaped {len(keys)} idle client(s) after {idle_timeout:.0f}s: {summary}")
- def log_released(keys: list[tuple[str, str]], reason: str) -> None:
- """Clients were shut down because their workspace went away (worktree released or root deleted).
- INFO, one line per event; forgets the ``log_active`` announcement like :func:`log_reaped`."""
- with _announce_lock:
- _announced_active.difference_update(keys)
- summary = ", ".join(f"{sid} ({root})" for sid, root in keys)
- _emit("reaper", logging.INFO, f"released {len(keys)} client(s) ({reason}): {summary}")
- def reset_announce_caches() -> None:
- """Test-only: clear the dedup caches. Production code never calls this."""
- with _announce_lock:
- for bucket in _ALL_BUCKETS:
- bucket.clear()
- __all__ = [
- "event_log",
- "log_active",
- "log_clean",
- "log_diagnostics",
- "log_disabled",
- "log_no_project_root",
- "log_reaped",
- "log_root_excluded",
- "log_server_error",
- "log_server_unavailable",
- "log_skipped_broken",
- "log_spawn_failed",
- "log_timeout",
- "log_untrusted_skipped",
- "reset_announce_caches",
- ]
|