fix(gateway): close residual memory-leak sites under heavy scheduled workload

Long-lived gateways under heavy cron/build workloads grow steadily (~18 MB/hr
post-phantom-dispatch-fix) and eventually need a restart-or-OOM. Four retention
sites, all confirmed live on current main:

1. _evict_cached_agent() (/model, /reasoning, codex-runtime, /undo, etc.) popped
   the cache entry without releasing the agent's OpenAI client, httpx transport,
   SSL context, or conversation history. Only /new cleaned up first. Now releases
   clients on a daemon thread, matching _enforce_agent_cache_cap.

2. _release_evicted_agent_soft() now clears _session_messages after
   release_clients() — tool outputs (file reads, terminal output, search results)
   can be tens of MB per 100+-tool-call session; the list is rebuilt from
   persisted session JSON on resume, so dropping it on soft eviction is safe.

3. The session-expiry watcher (permanent finalization) now drops the session's
   per-session control dicts (_session_model_overrides, _session_reasoning_overrides,
   _pending_approvals, _update_prompt_pending, _pending_model_notes). These leaked
   one entry per session per gateway lifetime. NOTE: this is the session-finalize
   path, NOT idle agent-cache eviction — an idle-evicted session is still alive and
   rebuilds its agent from these overrides, so pruning them there would silently
   reset a user's /model choice.

4. _tool_defs_cache is now bounded (_TOOL_DEFS_CACHE_MAX=8) with oldest-first
   eviction instead of growing unboundedly across the distinct toolset/config
   fingerprints a gateway sees over its lifetime.

Salvaged from #25318 by Michael Steuer (@mssteuer); fix 3 redirected from the
idle-sweep to the session-finalize lifecycle, magic number 8 lifted to a named
constant, test ported.

Fixes #19251
Co-authored-by: Michael Steuer <michael@make.software>
This commit is contained in:
Michael Steuer
2026-06-08 06:32:42 -07:00
committed by Teknium
parent 400e6e43ca
commit 3d029a53ec
3 changed files with 73 additions and 3 deletions
@@ -87,6 +87,27 @@ class TestQuietModeCacheIsolation:
f"baseline={baseline}, final={len(final)}."
)
def test_cache_bounded_by_eviction(self):
"""The cache evicts the oldest entry when it reaches the cap,
keeping the cache bounded instead of growing unbounded over a
long-lived Gateway's lifetime (#19251)."""
cap = model_tools._TOOL_DEFS_CACHE_MAX
# Fill cache to the cap with distinct keys by varying enabled_toolsets.
for i in range(cap):
model_tools.get_tool_definitions(
enabled_toolsets=[f"fake_toolset_{i}"], quiet_mode=True,
)
assert len(model_tools._tool_defs_cache) == cap
# Adding one more must evict the oldest, not clear everything and
# not grow past the cap.
model_tools.get_tool_definitions(
enabled_toolsets=["fake_toolset_overflow"], quiet_mode=True,
)
assert len(model_tools._tool_defs_cache) == cap, (
"Eviction should keep the cache at the cap, not clear it or grow"
)
def test_non_quiet_mode_does_not_use_cache(self):
"""Sanity: quiet_mode=False (TUI path) skips the cache entirely \u2014
explains why the bug only hit Gateway."""