Files
hermes-agent/tests/tui_gateway/test_background_thread_profile_scope.py
T
teknium1 8b181940b4 fix(multiplex): background threads and teardown paths carry the turn's profile scope
The profile scope (HERMES_HOME override, secret scope, terminal policy) is a
contextvar bundle bound per turn. A bare threading.Thread / Timer / gRPC
callback starts with an empty context and resolves the LAUNCH profile:

- agent/title_generator.py: the auto-title thread read
  auxiliary.title_generation (model, language, provider key) from the default
  profile's config and billed the default's key for a secondary's session.
  Spawn via agent.memory_provider.spawn_context_thread (copy_context).
- tui_gateway/session_lifecycle.py: every teardown caller is a bare Timer
  (ws-orphan reap), the idle-reaper thread, atexit _shutdown_sessions, the
  session.close pool RPC, superseded_by_resume or compute_host flush - none
  carries a scope, yet on_session_end / commit_memory_session / agent.close ->
  shutdown_memory_provider read the provider's config + credentials at call
  time. Under multiplex they failed closed (tail never committed, #110622
  class); on the Desktop backend a secondary's transcript went to the launch
  profile's memory tenant. _finalize_session and _teardown_session now bind
  _session_profile_runtime_scope(session) around those blocks, which covers
  every spawn site through the single chokepoint.
- plugins/platforms/google_chat/adapter.py: Pub/Sub callbacks run on the gRPC
  SubscriberClient's threads and run_coroutine_threadsafe copies THAT empty
  context onto the loop task, so _dispatch_message and everything under it
  (attachment cache, per-user OAuth token store via _acquire_user_chat_api ->
  _load_per_user_chat_api, TTS keys, delivery ledger, bot-id cache) resolved
  the launch profile. connect() captures its scope; _on_pubsub_message and
  _submit_on_loop run under a per-callback copy of it.

spawn_context_thread gains a kwargs passthrough for the title thread's
callbacks.
2026-09-15 03:47:15 -07:00

100 lines
4.1 KiB
Python

"""Background threads started from a profile-scoped turn carry that profile's scope.
Under multiplex the HERMES_HOME override and secret scope are contextvars bound per turn; a bare
``threading.Thread`` / ``Timer`` starts with an EMPTY context and resolves the LAUNCH profile's config
and credentials (or fails closed on secrets). Two production spawn paths are exercised here through
their real entry points: the auto-title thread and the ws-orphan reap Timer → session teardown.
"""
import threading
from pathlib import Path
from unittest.mock import MagicMock
import pytest
from agent.secret_scope import (
UnscopedSecretError, build_profile_secret_scope, get_secret, reset_secret_scope, set_multiplex_active,
set_secret_scope,
)
from hermes_constants import get_hermes_home, reset_hermes_home_override, set_hermes_home_override
@pytest.fixture
def served_home(tmp_path, monkeypatch):
a = tmp_path / ".hermes"
b = a / "profiles" / "b"
b.mkdir(parents=True)
(a / ".env").write_text("TITLE_KEY=a-key\n", encoding="utf-8")
(b / ".env").write_text("TITLE_KEY=b-key\n", encoding="utf-8")
monkeypatch.setenv("HERMES_HOME", str(a))
monkeypatch.setenv("TITLE_KEY", "a-key")
set_multiplex_active(True)
try:
yield a, b
finally:
set_multiplex_active(False)
def _observe_scope(seen: dict, done: threading.Event) -> None:
seen["home"] = str(get_hermes_home())
try:
seen["key"] = get_secret("TITLE_KEY")
except UnscopedSecretError as exc:
seen["key"] = exc
done.set()
def test_auto_title_thread_runs_in_the_turns_profile_scope(served_home, monkeypatch):
"""``maybe_auto_title`` fires ``auto_title_session`` on a thread; it must see the turn's profile."""
import agent.title_generator as tg
a, b = served_home
seen, done = {}, threading.Event()
monkeypatch.setattr(tg, "auto_title_session", lambda *args, **kwargs: _observe_scope(seen, done))
monkeypatch.setattr(tg, "apply_instant_title", lambda *args, **kwargs: None)
db = MagicMock()
db.get_session_title.return_value = None
home_token = set_hermes_home_override(str(b))
secret_token = set_secret_scope(build_profile_secret_scope(b))
try:
tg.maybe_auto_title(db, "sess-1", "hello there", [{"role": "user", "content": "hello there"}])
finally:
reset_secret_scope(secret_token)
reset_hermes_home_override(home_token)
assert done.wait(timeout=10), "auto-title thread never ran"
assert seen == {"home": str(b), "key": "b-key"}
def test_ws_orphan_reap_tears_down_under_the_sessions_profile(served_home, monkeypatch):
"""The reap Timer (empty context) → ``_teardown_popped_session``: memory commit + ``agent.close`` run
under ``session['profile_home']``, so the provider reads B's config/credentials, not the launch's."""
import tui_gateway.server as server
a, b = served_home
seen_commit, seen_close = {}, {}
done = threading.Event()
agent = MagicMock()
agent._session_messages = None
agent.session_id = "sess-b"
agent.commit_memory_session = lambda history: _observe_scope(seen_commit, threading.Event())
agent.close = lambda: _observe_scope(seen_close, done)
sid = "ws-b"
session = {
"agent": agent, "history": [{"role": "user", "content": "x"}], "history_lock": threading.Lock(),
"session_key": "sess-b", "profile_home": str(b), "transport": server._detached_ws_transport,
"last_active": 0.0,
}
monkeypatch.setattr(server, "_WS_ORPHAN_REAP_GRACE_S", 0.01)
monkeypatch.setattr(server, "_ws_session_is_orphaned", lambda s: s is session)
with server._sessions_lock:
server._sessions[sid] = session
try:
server._schedule_ws_orphan_reap(sid)
assert done.wait(timeout=10), "reap timer never tore the session down"
finally:
with server._sessions_lock:
server._sessions.pop(sid, None)
assert seen_commit == {"home": str(b), "key": "b-key"}
assert seen_close == {"home": str(b), "key": "b-key"}
assert Path(get_hermes_home()) == a # the test thread's own context is untouched