Files
hermes-agent/tests/tools/test_web_keyless_rescue.py
T
Teknium d1eefe6acc feat: keyed web backends get a one-shot keyless rescue on failure — never sticky
When the chosen/keyed backend fails a web_search or web_extract call
(bad key, upstream outage, 5xx, raised exception), that single call
retries on the keyless free-tier ring instead of erroring. The next
call attempts the chosen backend again — no sticky failover, no state.
Resolves the keyed half of #78984/#32159 (keyless half landed in the
ring PR).

- tools/web_tools.py: _rescue_eligible (keyed ring vendors + non-ring
  backends eligible; keyless-mode calls excluded — they already walked
  the ring), _rescue_search/_rescue_extract (search annotates
  rescued_from + backend_error naming the original failure and the
  retry-next-call semantics; extract rescues only whole-batch failures,
  partial failures pass through untouched; rescue failure preserves the
  ORIGINAL backend error with the rescue note appended)
- both dispatchers wrap the provider call: failure-results AND raised
  exceptions rescue; ineligible paths re-raise unchanged
- web.keyless_rescue config key (default true; implicitly off when
  keyless_fallback is off); docs updated

Live E2E: keyed Tavily with an invalid key 401'd and the call was
served by the real ring with the rescue annotation; a second call
re-attempted Tavily first (statelessness proven); whole-batch extract
rescue returned real page content. 13 new tests; 67 green across the
keyless suites.
2026-08-20 02:04:32 -07:00

248 lines
9.4 KiB
Python

"""One-shot keyless rescue: keyed/configured backend fails → THIS call rides
the keyless ring; the NEXT call attempts the chosen backend again.
Covers:
- eligibility: keyed ring vendors and non-ring backends are eligible;
keyless-mode ring calls are not (they already walked the ring); config
gates (keyless_rescue / keyless_fallback) turn it off
- search dispatcher: failure-result and raised-exception paths both rescue,
result annotated with rescued_from + backend_error
- statelessness: the very next dispatch calls the chosen backend again
- extract dispatcher: whole-batch failure rescues; partial failure passes
through untouched
- rescue failure: original backend error survives, rescue note appended
"""
import json
from unittest.mock import patch
import pytest
import tools.web_tools as web_tools
from plugins.web import keyless_mcp
from plugins.web.tavily.provider import TavilyWebSearchProvider
class _KeyedBoomProvider:
"""Minimal keyed provider double that always fails."""
name = "tavily"
display_name = "Tavily"
def supports_search(self):
return True
def supports_extract(self):
return True
def is_available(self):
return True
def search(self, query, limit=5):
return {"success": False, "error": "HTTP 500 upstream exploded"}
def extract(self, urls, **kwargs):
return [
{"url": u, "title": "", "content": "", "error": "HTTP 500 upstream exploded"}
for u in urls
]
class _RaisingProvider(_KeyedBoomProvider):
def search(self, query, limit=5):
raise RuntimeError("connection reset by peer")
@pytest.fixture(autouse=True)
def _keyed_tavily_env(monkeypatch):
"""Simulate a keyed Tavily setup with rescue enabled."""
monkeypatch.setattr(
"agent.web_search_provider.get_provider_env",
lambda name: "tvly-real" if name == "TAVILY_API_KEY" else "",
)
monkeypatch.setattr(web_tools, "_load_web_config", lambda: {"backend": "tavily"})
monkeypatch.setattr(
"agent.web_search_registry._keyless_tier_enabled", lambda: True
)
yield
def _ring_ok(vendor="exa"):
return {"success": True, "data": {"web": [{"url": f"https://{vendor}.example"}]}}
class TestEligibility:
def test_keyed_ring_vendor_is_eligible(self):
assert web_tools._rescue_eligible(_KeyedBoomProvider()) is True
def test_keyless_mode_ring_vendor_not_eligible(self, monkeypatch):
# No key: the tavily call already rode the ring; no double-walk.
monkeypatch.setattr(
"agent.web_search_provider.get_provider_env", lambda name: ""
)
assert web_tools._rescue_eligible(TavilyWebSearchProvider()) is False
def test_non_ring_backend_is_eligible(self):
class _SearxProvider(_KeyedBoomProvider):
name = "searxng"
assert web_tools._rescue_eligible(_SearxProvider()) is True
def test_config_gate_disables(self, monkeypatch):
monkeypatch.setattr(
web_tools, "_load_web_config",
lambda: {"backend": "tavily", "keyless_rescue": False},
)
assert web_tools._rescue_eligible(_KeyedBoomProvider()) is False
def test_keyless_fallback_off_disables(self, monkeypatch):
monkeypatch.setattr(
"agent.web_search_registry._keyless_tier_enabled", lambda: False
)
assert web_tools._rescue_eligible(_KeyedBoomProvider()) is False
class TestSearchRescue:
def _dispatch(self, monkeypatch, provider):
monkeypatch.setattr(web_tools, "_ensure_web_plugins_loaded", lambda: None)
monkeypatch.setattr(
"agent.web_search_registry.get_provider", lambda name: provider
)
return json.loads(web_tools.web_search_tool("q", limit=2))
def test_failure_result_rescued_and_annotated(self, monkeypatch):
with patch.object(
keyless_mcp, "search_with_failover", return_value=_ring_ok()
) as ring:
out = self._dispatch(monkeypatch, _KeyedBoomProvider())
assert out["success"] is True
assert out["data"]["rescued_from"] == "tavily"
assert "HTTP 500" in out["data"]["backend_error"]
assert "next call" in out["data"]["backend_error"].lower()
ring.assert_called_once()
def test_raised_exception_rescued(self, monkeypatch):
with patch.object(
keyless_mcp, "search_with_failover", return_value=_ring_ok()
):
out = self._dispatch(monkeypatch, _RaisingProvider())
assert out["success"] is True
assert "connection reset" in out["data"]["backend_error"]
def test_stateless_next_call_uses_chosen_backend(self, monkeypatch):
calls = {"backend": 0}
class _Counting(_KeyedBoomProvider):
def search(self, query, limit=5):
calls["backend"] += 1
return {"success": False, "error": "HTTP 500 upstream exploded"}
provider = _Counting()
with patch.object(
keyless_mcp, "search_with_failover", return_value=_ring_ok()
) as ring:
self._dispatch(monkeypatch, provider)
self._dispatch(monkeypatch, provider)
# The chosen backend was attempted on BOTH calls (no sticky failover),
# and each failure triggered its own one-shot rescue.
assert calls["backend"] == 2
assert ring.call_count == 2
def test_rescue_failure_keeps_original_error(self, monkeypatch):
with patch.object(
keyless_mcp, "search_with_failover",
return_value={"success": False, "error": "all throttled"},
):
out = self._dispatch(monkeypatch, _KeyedBoomProvider())
assert out["success"] is False
assert "HTTP 500 upstream exploded" in out["error"]
assert "keyless rescue also failed" in out["error"]
def test_no_rescue_when_disabled(self, monkeypatch):
monkeypatch.setattr(
web_tools, "_load_web_config",
lambda: {"backend": "tavily", "keyless_rescue": False},
)
with patch.object(keyless_mcp, "search_with_failover") as ring:
out = self._dispatch(monkeypatch, _KeyedBoomProvider())
assert out["success"] is False
ring.assert_not_called()
class TestExtractRescue:
async def _dispatch(self, monkeypatch, provider, urls):
monkeypatch.setattr(web_tools, "_ensure_web_plugins_loaded", lambda: None)
monkeypatch.setattr(
"agent.web_search_registry.get_provider", lambda name: provider
)
async def _allow_all(url, **kwargs):
return True
monkeypatch.setattr(web_tools, "async_is_safe_url", _allow_all)
raw = await web_tools.web_extract_tool(list(urls))
data = json.loads(raw)
return data["results"] if isinstance(data, dict) and "results" in data else data
@pytest.mark.asyncio
async def test_whole_batch_failure_rescued(self, monkeypatch):
good = [
{"url": "https://a", "title": "A", "content": "x" * 50,
"raw_content": "x" * 50, "metadata": {"sourceURL": "https://a"}},
{"url": "https://b", "title": "B", "content": "y" * 50,
"raw_content": "y" * 50, "metadata": {"sourceURL": "https://b"}},
]
with patch.object(
keyless_mcp, "extract_with_failover", return_value=good
) as ring:
results = await self._dispatch(
monkeypatch, _KeyedBoomProvider(), ["https://a", "https://b"]
)
assert all(not r.get("error") for r in results)
assert results[0]["content"].startswith("x")
ring.assert_called_once()
def test_rescue_extract_annotates_results(self, monkeypatch):
good = [
{"url": "https://a", "title": "A", "content": "x",
"raw_content": "x", "metadata": {"sourceURL": "https://a"}},
]
failed = [{"url": "https://a", "title": "", "content": "", "error": "HTTP 500"}]
with patch.object(
keyless_mcp, "extract_with_failover", return_value=good
):
out = web_tools._rescue_extract("tavily", ["https://a"], failed)
assert out[0]["metadata"]["rescued_from"] == "tavily"
assert "HTTP 500" in out[0]["metadata"]["backend_error"]
@pytest.mark.asyncio
async def test_partial_failure_not_rescued(self, monkeypatch):
class _Partial(_KeyedBoomProvider):
def extract(self, urls, **kwargs):
return [
{"url": urls[0], "title": "A", "content": "fine",
"raw_content": "fine", "metadata": {}},
{"url": urls[1], "title": "", "content": "", "error": "404"},
]
with patch.object(keyless_mcp, "extract_with_failover") as ring:
results = await self._dispatch(
monkeypatch, _Partial(), ["https://a", "https://b"]
)
assert results[1].get("error")
ring.assert_not_called()
@pytest.mark.asyncio
async def test_rescue_failure_keeps_original_errors(self, monkeypatch):
still_bad = [
{"url": "https://a", "title": "", "content": "", "error": "ring dead"},
{"url": "https://b", "title": "", "content": "", "error": "ring dead"},
]
with patch.object(
keyless_mcp, "extract_with_failover", return_value=still_bad
):
results = await self._dispatch(
monkeypatch, _KeyedBoomProvider(), ["https://a", "https://b"]
)
assert all("HTTP 500" in r.get("error", "") for r in results)