File size: 31,732 Bytes
24678b9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 | """Browser session lifecycle: inactivity janitor, orphan reaper, per-session teardown, atexit cleanup.
Split out of ``tools/browser_tool.py``. Facade-owned state is read through ``_bt`` (``tools.browser_tool``, resolved per call) β no import cycle.
"""
import contextlib
import os
import shutil
import signal
import subprocess
import threading
import time
from datetime import datetime, timezone
from pathlib import Path
from typing import Any, Dict, Optional, Tuple
from hermes_constants import get_hermes_home, reset_hermes_home_override, set_hermes_home_override
from tools.browser_tool_origin import origin as _bt
from tools import browser_tool_cdp as _cdp
from tools import browser_tool_cloud as _cloud
from tools import browser_tool_session as _session
from tools import browser_tool_install as _install
from tools import browser_tool_real_profile as _real_profile
def _session_expiry_timestamp(session_info: Dict[str, Any]) -> Optional[float]:
"""Provider-authoritative session expiry as epoch seconds; None when absent or
malformed (cloud providers may omit ``expires_at``; local browsers never have one)."""
value = session_info.get("expires_at")
if isinstance(value, (int, float)) and not isinstance(value, bool):
return float(value)
if not isinstance(value, str) or not value.strip():
return None
normalized = value.strip()
if normalized.endswith(("Z", "z")):
normalized = f"{normalized[:-1]}+00:00"
try:
parsed = datetime.fromisoformat(normalized)
except ValueError:
_bt.logger.warning("Ignoring invalid cloud browser session expiry timestamp")
return None
if parsed.tzinfo is None:
parsed = parsed.replace(tzinfo=timezone.utc)
return parsed.timestamp()
def _session_has_expired(
session_info: Dict[str, Any], *, now: Optional[float] = None
) -> bool:
"""Whether a cached browser session crossed its provider deadline."""
expires_at = _session_expiry_timestamp(session_info)
if expires_at is None:
return False
return (time.time() if now is None else now) >= expires_at
def _best_effort(label: str, fn) -> None:
"""Run ``fn()``; log (debug) and swallow any exception β teardown must never abort."""
try:
fn()
except Exception as e:
_bt.logger.debug("%s failed: %s", label, e)
def _stop_all_lightpanda() -> None:
from tools.browser_lightpanda import stop_all_lightpanda
stop_all_lightpanda()
def _emergency_cleanup_all_sessions():
"""atexit: close this process's sessions, then sweep orphans left by crashed
hermes processes β every clean exit reaps accumulated orphans, not only
processes that used the browser tool."""
if _bt._cleanup_done:
return
_bt._cleanup_done = True
# Own sessions first so their owner_pid files are gone before the reaper scans.
# Real-profile Chrome is launched directly (not by agent-browser), so the
# session cleanup never reaps it.
_best_effort("Real-profile chrome cleanup on exit", _real_profile._terminate_real_profile_chrome)
if _bt._active_sessions:
_bt.logger.info("Emergency cleanup: closing %s active session(s)...", len(_bt._active_sessions))
try:
cleanup_all_browsers()
except Exception as e:
_bt.logger.error("Emergency cleanup error: %s", e)
finally:
with _bt._cleanup_lock:
_bt._active_sessions.clear()
_bt._session_last_activity.clear()
_bt._session_owner_homes.clear()
_bt._cleanup_failures.clear()
_bt._recording_sessions.clear()
# Lightpanda servers we spawned that fell out of ``_active_sessions``.
_best_effort("Lightpanda cleanup on exit", _stop_all_lightpanda)
# Safe even if we never used the browser β owner_pid liveness protects daemons
# owned by other live hermes processes.
_best_effort("Orphan reap on exit", _reap_orphaned_browser_sessions)
@contextlib.contextmanager
def _session_owner_scope(task_id: str):
"""Run under the Hermes home + secret scope owning ``task_id``'s session (no-op if unrecorded).
The janitor thread is process-global, so each teardown must re-enter its OWN
profile's scope rather than inherit the spawning profile's; never falls
through to ``os.environ``.
"""
owner_home = _bt._session_owner_homes.get(task_id)
if owner_home is None:
yield
return
from agent.secret_scope import build_profile_secret_scope, reset_secret_scope, set_secret_scope
from hermes_cli.env_loader import hydrate_profile_secret_sources
home_token = set_hermes_home_override(owner_home)
try:
hydrate_profile_secret_sources(Path(owner_home))
secret_token = set_secret_scope(build_profile_secret_scope(Path(owner_home)))
try:
yield
finally:
reset_secret_scope(secret_token)
finally:
reset_hermes_home_override(home_token)
def _forget_session_tracking(task_id: str, *, activity: bool = True, session: bool = False) -> None:
"""Drop the janitor's bookkeeping (and optionally the session entry) for ``task_id``."""
with _bt._cleanup_lock:
if session:
_bt._active_sessions.pop(task_id, None)
if activity:
_bt._session_last_activity.pop(task_id, None)
_bt._session_owner_homes.pop(task_id, None)
_bt._cleanup_failures.pop(task_id, None)
def _cleanup_inactive_browser_sessions():
"""Close sessions inactive longer than the timeout (cleanup thread).
Each teardown runs under its owner profile's scope. A session whose cleanup
keeps failing is force-reaped after MAX_INACTIVITY_CLEANUP_FAILURES attempts;
only a successful cleanup clears its failure count.
See #100738, #86402.
"""
current_time = time.time()
with _bt._cleanup_lock:
sessions_to_cleanup = [task_id for task_id, last_time in list(_bt._session_last_activity.items())
if current_time - last_time > _bt.BROWSER_SESSION_INACTIVITY_TIMEOUT]
for task_id in sessions_to_cleanup:
elapsed = int(current_time - _bt._session_last_activity.get(task_id, current_time))
_bt.logger.info("Cleaning up inactive session for task: %s (inactive for %ss)", task_id, elapsed)
try:
with _session_owner_scope(task_id):
cleanup_browser(task_id)
_forget_session_tracking(task_id)
except Exception as e:
with _bt._cleanup_lock:
failures = _bt._cleanup_failures[task_id] = _bt._cleanup_failures.get(task_id, 0) + 1
if failures < _bt.MAX_INACTIVITY_CLEANUP_FAILURES:
_bt.logger.warning("Error cleaning up inactive session %s (attempt %d/%d): %s",
task_id, failures, _bt.MAX_INACTIVITY_CLEANUP_FAILURES, e)
continue
_bt.logger.error("Browser cleanup failed %d times for inactive session %s; "
"force-reaping: %s", failures, task_id, e)
try:
with _session_owner_scope(task_id):
_force_reap_browser_session(task_id)
except Exception as reap_exc:
_bt.logger.error("Force-reap of browser session %s failed: %s", task_id, reap_exc)
finally:
_forget_session_tracking(task_id, activity=False)
def _write_owner_pid(socket_dir: str, session_name: str) -> None:
"""Record this hermes PID in ``<socket_dir>/<session>.owner_pid`` so the orphan
reaper can tell live-owner daemons from crashed-owner ones. Best-effort: an
OSError falls back to the legacy ``tracked_names`` heuristic."""
try:
path = os.path.join(socket_dir, f"{session_name}.owner_pid")
with open(path, "w", encoding="utf-8") as f:
f.write(str(os.getpid()))
except OSError as exc:
_bt.logger.debug("Could not write owner_pid file for %s: %s", session_name, exc)
def _verify_reapable_browser_daemon(daemon_pid: int, socket_dir: str,
session_name: str) -> bool:
"""Confirm a live PID is genuinely *this* session's agent-browser daemon (fail-closed).
The ``.pid`` file sits in a world-writable temp dir: a planted or recycled PID
would turn the tree-kill into an arbitrary-process DoS. Both must pass:
(1) identity β ``agent-browser`` in name/cmdline; (2) binding β the socket dir in
the cmdline or ``AGENT_BROWSER_SOCKET_DIR`` in its environ (the real spoof defense).
"""
def refuse(reason: str, *args) -> bool:
_bt.logger.warning("Refusing to reap browser daemon PID %d (session %s): " + reason,
daemon_pid, session_name, *args)
return False
try:
import psutil
except ImportError: # psutil is a hard dep; defensive only
return refuse("psutil unavailable for identity verification")
try:
proc = psutil.Process(daemon_pid)
name = (proc.name() or "").lower()
cmdline = " ".join(proc.cmdline() or []).lower()
except psutil.NoSuchProcess:
return False # vanished between the liveness check and now
except (psutil.AccessDenied, OSError) as exc:
return refuse("could not read process identity (%s)", exc)
if "agent-browser" not in name and "agent-browser" not in cmdline:
return refuse("not an agent-browser process (name=%r)", name)
socket_dir_l = socket_dir.lower()
socket_base_l = os.path.basename(socket_dir).lower()
bound = socket_dir_l in cmdline or (socket_base_l and socket_base_l in cmdline)
if not bound:
try:
env_dir = (proc.environ() or {}).get("AGENT_BROWSER_SOCKET_DIR", "")
bound = bool(env_dir) and os.path.normpath(env_dir) == os.path.normpath(socket_dir)
except (psutil.AccessDenied, psutil.NoSuchProcess, OSError):
bound = False # environ() can be denied even same-user; cmdline already failed β fail closed
if not bound:
return refuse("not bound to session socket dir %s (possible recycled PID or planted pid file)", socket_dir)
return True
def _socket_dir_idle_seconds(socket_dir: str) -> Optional[float]:
"""Seconds since anything in ``socket_dir`` was last written; None if unknown (fail safe).
Every command rewrites ``_stdout_<cmd>`` there β a restart-proof activity marker β and
rewriting doesn't touch the dir mtime, so entries are scanned too."""
try:
latest = os.path.getmtime(socket_dir)
except OSError:
return None
try:
with os.scandir(socket_dir) as entries:
for entry in entries:
try:
latest = max(latest, entry.stat().st_mtime)
except OSError:
continue
except OSError:
pass # dir mtime alone is still a usable lower bound
return max(0.0, time.time() - latest)
def _read_pid_file(path: str) -> Optional[int]:
"""Integer PID from ``path``; None when missing or corrupt."""
try:
return int(Path(path).read_text(encoding="utf-8").strip())
except (ValueError, OSError):
return None
def _owner_pid_alive(socket_dir: str, session_name: str) -> Tuple[Optional[int], Optional[bool]]:
"""Read ``<session>.owner_pid`` and report ``(pid, alive)``; ``(None, None)`` when missing/corrupt."""
owner_pid = _read_pid_file(os.path.join(socket_dir, f"{session_name}.owner_pid"))
if owner_pid is None:
return None, None
# ``os.kill(pid, 0)`` is NOT a no-op on Windows; use the cross-platform check.
from gateway.status import _pid_exists
return owner_pid, _pid_exists(owner_pid)
def _terminate_verified_daemon(daemon_pid: int, session_name: str, log) -> bool:
"""Tree-kill ``daemon_pid`` if it has a start-time fingerprint (so a PID swapped
between check and kill is refused); False (logged via ``log``) when no fingerprint.
Raises on OS errors."""
from gateway.status import get_process_start_time
from tools.process_registry import ProcessRegistry
daemon_start = get_process_start_time(daemon_pid)
if daemon_start is None:
log("Refusing to reap browser daemon PID %d (session %s): no start-time fingerprint available",
daemon_pid, session_name)
return False
ProcessRegistry._terminate_host_pid(daemon_pid, daemon_start)
return True
def _reap_socket_dir(socket_dir: str, session_name: str, tracked_names: set) -> bool:
"""Reap one ``agent-browser-<session>`` dir if orphaned; True when a daemon was killed.
A live ``owner_pid`` means another hermes process owns it β leave it UNLESS untracked
here and idle past ``BROWSER_ORPHAN_GRACE_SECONDS`` (owner-alive alone made leaked
daemons immortal); no owner_pid (legacy) falls back to this process's tracking. A
pidless dir is only stale after the grace period (deleting it immediately races the
creator's first stdout open). The PID is identity-verified before any tree-kill.
"""
owner_pid, owner_alive = _owner_pid_alive(socket_dir, session_name)
if owner_alive is True:
if session_name in tracked_names:
return False
idle_s = _socket_dir_idle_seconds(socket_dir)
if idle_s is None or idle_s < _bt.BROWSER_ORPHAN_GRACE_SECONDS:
return False # unknown age or within grace β fail safe
_bt.logger.warning(
"Browser session %s has a live owner (PID %s) but is untracked "
"and idle for %ds (grace %ds) β treating as leaked and reaping",
session_name, owner_pid, int(idle_s),
_bt.BROWSER_ORPHAN_GRACE_SECONDS)
elif owner_alive is None and session_name in tracked_names:
return False
pid_file = os.path.join(socket_dir, f"{session_name}.pid")
if not os.path.isfile(pid_file):
idle_s = _socket_dir_idle_seconds(socket_dir)
if idle_s is None or idle_s < _bt.BROWSER_ORPHAN_GRACE_SECONDS:
return False
shutil.rmtree(socket_dir, ignore_errors=True)
return False
daemon_pid = _read_pid_file(pid_file)
from gateway.status import _pid_exists
if daemon_pid is None or not _pid_exists(daemon_pid):
shutil.rmtree(socket_dir, ignore_errors=True)
return False
if not _verify_reapable_browser_daemon(daemon_pid, socket_dir, session_name):
return False # leave process and dir for a later sweep once the imposter PID is gone
# Tree-kill so Chromium children (renderer, GPU, ...) go too.
reaped = False
try:
if not _terminate_verified_daemon(daemon_pid, session_name, _bt.logger.warning):
return False
_bt.logger.info("Reaped orphaned browser daemon PID %d (session %s)", daemon_pid, session_name)
reaped = True
except (ProcessLookupError, PermissionError, OSError):
pass
shutil.rmtree(socket_dir, ignore_errors=True)
return reaped
def _reap_orphaned_browser_sessions():
"""Kill agent-browser daemons whose owning hermes process is gone (an unclean exit loses
``_active_sessions`` but node + Chromium keep running). Scans the tmp dir for
``agent-browser-*`` socket dirs; safe from any context."""
import glob
# Lightpanda servers keep their own records (no socket dir); sweep them with the
# same owner-liveness rule BEFORE the daemon scan, which may return early.
def _reap_lp():
from tools.browser_lightpanda import reap_orphaned_lightpanda
reap_orphaned_lightpanda()
_best_effort("Lightpanda orphan reap", _reap_lp)
tmpdir = _bt._socket_safe_tmpdir()
socket_dirs = []
# The shared real-profile attach daemon is named, not ``<prefix>_<hex>``; list it explicitly.
for prefix in ("agent-browser-h_*", "agent-browser-cdp_*", "agent-browser-hermes_*",
f"agent-browser-{_bt._REAL_PROFILE_SESSION}"):
socket_dirs += glob.glob(os.path.join(tmpdir, prefix))
if not socket_dirs:
return
with _bt._cleanup_lock:
tracked_names = {info.get("session_name") for info in _bt._active_sessions.values() if info.get("session_name")}
# Browsing on the shared real-profile daemon runs through per-task ``rp_*`` sessions
# (``--cdp``), so its own dir never shows activity; the idle escape hatch would misfire
# under a live user. Owner liveness alone gates it β a dead owner still gets reaped.
tracked_names.add(_bt._REAL_PROFILE_SESSION)
reaped = 0
for socket_dir in socket_dirs:
session_name = os.path.basename(socket_dir).removeprefix("agent-browser-")
if session_name and _reap_socket_dir(socket_dir, session_name, tracked_names):
reaped += 1
if reaped:
_bt.logger.info("Reaped %d orphaned browser session(s) from previous run(s)", reaped)
def _browser_cleanup_thread_worker():
"""Every 30s: close sessions idle past BROWSER_SESSION_INACTIVITY_TIMEOUT; reap
orphans on startup AND every BROWSER_ORPHAN_REAP_INTERVAL seconds."""
reap_every_cycles = max(1, round(_bt.BROWSER_ORPHAN_REAP_INTERVAL / 30))
cycle = 0
while _bt._cleanup_running:
if cycle % reap_every_cycles == 0: # cycle 0 is the startup reap
try:
_reap_orphaned_browser_sessions()
except Exception as e:
_bt.logger.warning("Orphan reap error: %s", e)
cycle += 1
try:
_cleanup_inactive_browser_sessions()
except Exception as e:
_bt.logger.warning("Cleanup thread error: %s", e)
for _ in range(30): # 1s granularity so stop is quick
if not _bt._cleanup_running:
break
time.sleep(1)
def _start_browser_cleanup_thread():
"""Start the background cleanup thread if not already running."""
with _bt._cleanup_lock:
if _bt._cleanup_thread is None or not _bt._cleanup_thread.is_alive():
_bt._cleanup_running = True
_bt._cleanup_thread = threading.Thread(target=_browser_cleanup_thread_worker, daemon=True,
name="browser-cleanup")
_bt._cleanup_thread.start()
_bt.logger.info("Started inactivity cleanup thread (timeout: %ss)", _bt.BROWSER_SESSION_INACTIVITY_TIMEOUT)
def _stop_browser_cleanup_thread():
"""Stop the background cleanup thread."""
_bt._cleanup_running = False
if _bt._cleanup_thread is not None:
# A second Ctrl+C during the timed join lands here as KeyboardInterrupt; the janitor is a
# daemon thread, so letting it propagate only prints "Exception ignored in atexit callback".
try:
_bt._cleanup_thread.join(timeout=5)
except (SystemExit, KeyboardInterrupt):
pass
def _update_session_activity(task_id: str):
"""Touch the activity timestamp and record the owning Hermes home on first sight (the
janitor tears down under the owner's scope). Does NOT reset ``_cleanup_failures``.
See #86402.
"""
with _bt._cleanup_lock:
_bt._session_last_activity[task_id] = time.time()
_bt._session_owner_homes.setdefault(task_id, str(get_hermes_home()))
def _kill_process_tree(proc: "subprocess.Popen") -> None:
"""Best-effort kill of *proc* and every descendant; never raises.
``Popen.kill()`` only signals the direct child; npm/npx helpers and the detached
daemon grandchild keep a capture pipe open so ``communicate()`` never sees EOF, so
the whole tree must go (no grace: the caller already burned its timeout). Delegates
to :func:`agent.deadline.kill_process_tree`, falling back to the legacy kill.
``Popen.kill()`` only signals the direct child PID. npm/npx routinely fork further processes
(registry-fetch helpers, npm's own lifecycle runner, agent-browser's own detached daemon grandchild)
that can survive a plain ``kill()`` of the top-level PID and keep a ``capture_output``-style pipe open,
hanging the caller's ``communicate()`` past the nominal timeout β the same orphaned-pipe hazard already
hit in production on POSIX (see ``tools/process_registry.py``'s ``_reader_loop``, issue 68915: a
backgrounded grandchild inheriting a pipe's write end kept it from ever reaching EOF). That hazard is
cross-platform, not Windows-specific; what *is* Windows-specific is the lack of a remedy other than
killing the tree β anonymous pipes there don't support overlapped I/O, so there's no ``select()``-style
non-blocking read to poll around a stuck grandchild the way POSIX can. Killing the whole process
group/tree the child was launched into reaches those descendants on both platforms. See #68915.
"""
try:
from agent.deadline import kill_process_tree as _deadline_kill_tree
_deadline_kill_tree(proc.pid)
except Exception:
_legacy_kill_process_tree(proc)
def _legacy_kill_process_tree(proc: "subprocess.Popen") -> None:
"""Local tree-kill (SIGTERM then SIGKILL to the process group) β fallback when
agent.deadline is unavailable; tests pin this signal sequence."""
if os.name == "nt":
try:
subprocess.run(["taskkill", "/PID", str(proc.pid), "/T", "/F"],
check=False, capture_output=True, stdin=subprocess.DEVNULL)
except Exception:
pass
return
# POSIX-only below (the nt guard returned), but resolve killpg/SIGKILL via
# getattr so a future refactor dropping that guard degrades to plain kill().
killpg = getattr(os, "killpg", None)
if killpg is None: # windows-footgun: ok - non-POSIX fallback
try:
proc.kill()
except Exception:
pass
return
try:
pgid = os.getpgid(proc.pid)
except (ProcessLookupError, OSError):
return
for sig in (signal.SIGTERM, getattr(signal, "SIGKILL", signal.SIGTERM)):
try:
killpg(pgid, sig)
except (ProcessLookupError, PermissionError, OSError):
return
def _pid_exists(pid: int) -> bool:
"""Best-effort 'is this PID alive' (cross-platform via gateway.status; zombies count as dead)."""
if pid <= 0:
return False
from gateway.status import _pid_exists as _gateway_pid_exists
return _gateway_pid_exists(pid)
def _unlink_older_than(directory: Path, pattern: str, max_age_hours: float, label: str) -> None:
"""Delete ``directory/pattern`` files older than ``max_age_hours``; never raises."""
try:
cutoff = time.time() - (max_age_hours * 3600)
for f in directory.glob(pattern):
try:
if f.stat().st_mtime < cutoff:
f.unlink()
except Exception as e:
_bt.logger.debug("Failed to clean old %s %s: %s", label, f, e)
except Exception as e:
_bt.logger.debug("%s cleanup error (non-critical): %s", label.capitalize(), e)
def _cleanup_old_screenshots(screenshots_dir, max_age_hours=24):
"""Prune old browser screenshots; throttled to once per hour per directory."""
key = str(screenshots_dir)
now = time.time()
if now - _bt._last_screenshot_cleanup_by_dir.get(key, 0.0) < 3600:
return
_bt._last_screenshot_cleanup_by_dir[key] = now
_unlink_older_than(screenshots_dir, "browser_screenshot_*.png", max_age_hours, "screenshot")
def _cleanup_old_recordings(max_age_hours=72):
"""Prune old browser recordings."""
try:
recordings_dir = get_hermes_home() / "browser_recordings"
except Exception as e:
_bt.logger.debug("Recording cleanup error (non-critical): %s", e)
return
if recordings_dir.exists():
_unlink_older_than(recordings_dir, "session_*.webm", max_age_hours, "recording")
def _drop_last_active_binding(task_id: str) -> None:
"""Drop stale last-active ownership after cleaning ``task_id``: a bare task always, a
sidecar only if it was still the recorded owner (a later click must not resurrect a
cleaned sidecar while a primary-session binding is preserved)."""
bare_task_id = _bt._bare_task_id_for_session_key(task_id)
if bare_task_id == task_id or _bt._last_active_session_key.get(bare_task_id) == task_id:
_bt._last_active_session_key.pop(bare_task_id, None)
def cleanup_browser(task_id: Optional[str] = None) -> None:
"""Clean up browser session(s) for a task: a bare task id reaps BOTH the primary
session and any hybrid local sidecar; a ``::local`` key reaps only that one."""
if task_id is None:
task_id = "default"
session_keys = [task_id]
sidecar_key = f"{task_id}{_bt._LOCAL_SUFFIX}"
with _bt._cleanup_lock:
if not _bt._is_local_sidecar_key(task_id) and sidecar_key in _bt._active_sessions:
session_keys.append(sidecar_key)
for session_key in session_keys:
_cleanup_single_browser_session(session_key)
_drop_last_active_binding(task_id)
def _kill_verified_daemon(socket_dir: str, session_name: str) -> bool:
"""Tree-kill the daemon in ``<socket_dir>/<session>.pid`` if verifiably ours; True when
a kill was issued. Never raises."""
pid_file = os.path.join(socket_dir, f"{session_name}.pid")
if not os.path.isfile(pid_file):
return False
try:
daemon_pid = int(Path(pid_file).read_text(encoding="utf-8").strip())
if not _verify_reapable_browser_daemon(daemon_pid, socket_dir, session_name):
_bt.logger.debug("Skipped daemon kill for %s: pid %s failed identity verification", session_name, daemon_pid)
return False
if not _terminate_verified_daemon(daemon_pid, session_name, lambda *_a: _bt.logger.debug(
"Skipped daemon kill for %s: no start-time fingerprint for pid %s", session_name, daemon_pid)):
return False
_bt.logger.debug("Killed daemon pid %s for %s", daemon_pid, session_name)
return True
except (ProcessLookupError, ValueError, PermissionError, OSError):
_bt.logger.debug("Could not kill daemon pid for %s (already dead or inaccessible)", session_name)
return False
def _release_session_resources(task_id: str, session_info: Dict[str, Any]) -> None:
"""Untrack ``task_id``, close its cloud provider session, kill its daemon β the
unconditional tail of a teardown, and the whole of the janitor's force-reap path.
The unconditional tail of ``_cleanup_single_browser_session``; also the whole of the janitor's
force-reap path (#100738), which skips the polite agent-browser/Camofox ``close`` that kept failing but
must still release the cloud session and the local Chromium.
"""
bb_session_id = session_info.get("bb_session_id", "unknown")
_forget_session_tracking(task_id, session=True)
if bb_session_id: # cloud only β local sidecars have bb_session_id=None
provider = _cloud._get_cloud_provider()
if provider is not None:
try:
provider.close_session(bb_session_id)
except Exception as e:
_bt.logger.warning("Could not close cloud browser session: %s", e)
session_name = session_info.get("session_name", "")
if session_name:
socket_dir = os.path.join(_bt._socket_safe_tmpdir(), f"agent-browser-{session_name}")
if os.path.exists(socket_dir):
_kill_verified_daemon(socket_dir, session_name)
shutil.rmtree(socket_dir, ignore_errors=True)
def _force_reap_browser_session(task_id: str) -> None:
"""Janitor last resort: skip the failing ``close`` round-trips, release resources directly.
Janitor last resort after repeated cleanup failures (#100738).
"""
_cdp._stop_cdp_supervisor(task_id)
with _bt._cleanup_lock:
session_info = _bt._active_sessions.get(task_id)
_bt._session_last_activity.pop(task_id, None)
_bt._recording_sessions.discard(task_id)
if session_info:
_release_session_resources(task_id, session_info)
_drop_last_active_binding(task_id)
def _cleanup_single_browser_session(task_id: str) -> None:
"""Reap a single browser session by its exact session key."""
_cdp._stop_cdp_supervisor(task_id) # close our WebSocket BEFORE the backend tears down the endpoint
# Camofox: managed persistence keeps the profile (cookies) across tasks; skip the full
# close then β the inactivity reaper still frees idle resources.
if _bt._is_camofox_mode():
def _camofox_cleanup():
from tools.browser_camofox import camofox_close, camofox_soft_cleanup
if not camofox_soft_cleanup(task_id):
camofox_close(task_id)
_best_effort(f"Camofox cleanup for task {task_id}", _camofox_cleanup)
_bt.logger.debug("cleanup_browser called for task_id: %s", task_id)
_bt.logger.debug("Active sessions: %s", list(_bt._active_sessions.keys()))
# Look up but don't remove yet β _run_browser_command needs the entry for ``close``.
with _bt._cleanup_lock:
session_info = _bt._active_sessions.get(task_id)
if not session_info:
_bt.logger.debug("No active session found for task_id: %s", task_id)
return
_bt.logger.debug("Found session for task %s: bb_session_id=%s", task_id, session_info.get("bb_session_id", "unknown"))
_bt._maybe_stop_recording(task_id) # saves the file before close
# Lightpanda sessions have no daemon to ``close``; an expired cloud CDP URL cannot
# accept one and would make _get_session_info() renew the session mid-cleanup.
if (session_info.get("features") or {}).get("lightpanda"):
try:
from tools.browser_lightpanda import stop_lightpanda
stop_lightpanda(session_info.get("session_name", ""))
except Exception as e:
_bt.logger.warning("lightpanda stop failed for task %s: %s", task_id, e)
elif _session_has_expired(session_info):
_bt.logger.debug("Skipping agent-browser close for expired session %s", task_id)
else:
try:
_session._run_browser_command(task_id, "close", [], timeout=10)
_bt.logger.debug("agent-browser close command completed for task %s", task_id)
except Exception as e:
_bt.logger.warning("agent-browser close failed for task %s: %s", task_id, e)
_release_session_resources(task_id, session_info)
_bt.logger.debug("Removed task %s from active sessions", task_id)
def cleanup_all_browsers() -> None:
"""Clean up all active browser sessions (shutdown) and reset cached lookups."""
with _bt._cleanup_lock:
task_ids = list(_bt._active_sessions.keys())
for task_id in task_ids:
cleanup_browser(task_id)
try: # tear down CDP supervisors so background threads exit
from tools.browser_supervisor import SUPERVISOR_REGISTRY # type: ignore[import-not-found]
SUPERVISOR_REGISTRY.stop_all()
except Exception:
pass
_install._discover_homebrew_node_dirs.cache_clear()
# Each resolved flag flips BEFORE its cache is nulled so a concurrent reader never
# sees ``resolved=True`` with ``cache=None``.
for flag, cache in (
("_agent_browser_resolved", "_cached_agent_browser"),
("_command_timeout_resolved", "_cached_command_timeout"),
("_snapshot_threshold_resolved", "_cached_snapshot_threshold"),
("_chromium_autoinstall_attempted", "_cached_chromium_installed"),
("_browser_engine_resolved", "_cached_browser_engine"),
):
setattr(_bt, flag, False)
setattr(_bt, cache, None)
|