Skip to content

Enterprise agent platform for building, deploying, and operating AI teammates.

feat(usage): meter Brave web searches (toby) (#3832)

OliverBryantd91669a333e4
diff --git a/src/xagent/core/tools/core/brave_web_search.py b/src/xagent/core/tools/core/brave_web_search.py
index 1e50643fb..9b6ade4b6 100644
--- a/src/xagent/core/tools/core/brave_web_search.py
+++ b/src/xagent/core/tools/core/brave_web_search.py
@@ -20,6 +20,7 @@ from typing import Any, Dict, List, Optional
import httpx
from ....config import get_brave_search_country, get_brave_search_endpoint
+from .media_usage import record_web_search_usage
from .web_content import WebContentFetcher
from .web_search_guard import run_guarded_search
@@ -178,6 +179,9 @@ class BraveWebSearchCore:
) from None
self._raise_for_status(response.status_code)
+ # Brave billed this request as soon as it answered 2xx, so record it
+ # before the body is read or any result page is fetched.
+ record_web_search_usage("brave")
try:
data = response.json()
diff --git a/src/xagent/core/tools/core/media_usage.py b/src/xagent/core/tools/core/media_usage.py
index 26ef1287b..3684d9e43 100644
--- a/src/xagent/core/tools/core/media_usage.py
+++ b/src/xagent/core/tools/core/media_usage.py
@@ -260,6 +260,7 @@ WEB_SEARCH_MODEL_IDS: dict[str, str] = {
"tavily": "platform/web-search-tavily",
"exa": "platform/web-search-exa",
"google": "platform/web-search-google",
+ "brave": "platform/web-search-brave",
}
diff --git a/tests/core/tools/core/test_brave_web_search.py b/tests/core/tools/core/test_brave_web_search.py
index d9cc86285..8fff804fe 100644
--- a/tests/core/tools/core/test_brave_web_search.py
+++ b/tests/core/tools/core/test_brave_web_search.py
@@ -72,6 +72,7 @@ CTX_BODY = {
@pytest.mark.asyncio
async def test_web_endpoint_request_and_mapping(transport, monkeypatch):
monkeypatch.delenv("XAGENT_BRAVE_SEARCH_ENDPOINT", raising=False)
+ monkeypatch.delenv("XAGENT_BRAVE_SEARCH_COUNTRY", raising=False)
requests = transport(lambda r: httpx.Response(200, json=WEB_BODY))
results = await BraveWebSearchCore(api_key=API_KEY).search(QUERY, max_results=50)
@@ -117,6 +118,8 @@ async def test_web_endpoint_include_content_fetches_pages(transport, monkeypatch
@pytest.mark.asyncio
async def test_llm_context_endpoint_request_and_mapping(transport, monkeypatch):
monkeypatch.setenv("XAGENT_BRAVE_SEARCH_ENDPOINT", "llm_context")
+ # The exact-body assertion below must not depend on the ambient environment.
+ monkeypatch.delenv("XAGENT_BRAVE_SEARCH_COUNTRY", raising=False)
requests = transport(lambda r: httpx.Response(200, json=CTX_BODY))
results = await BraveWebSearchCore(api_key=API_KEY).search(
@@ -436,3 +439,112 @@ async def test_brave_redaction_failure_sends_nothing(transport, monkeypatch, aud
await BraveWebSearchCore(api_key=API_KEY).search(PII_QUERY)
assert requests == []
assert audit[-1].failure_kind == "redaction_error"
+
+
+# --- Metering: one usage row per request Brave answered with 2xx ---------------
+
+
+def _usage_rows(manager) -> list[dict[str, Any]]:
+ return list(manager.get_usage().details)
+
+
[email protected]("endpoint", ["web", "llm_context"])
+async def test_a_brave_answer_records_one_platform_row(
+ transport, monkeypatch, endpoint
+):
+ from xagent.core.model.chat.token_context import TokenContextManager
+
+ monkeypatch.setenv("XAGENT_BRAVE_SEARCH_ENDPOINT", endpoint)
+ transport(
+ lambda r: httpx.Response(200, json=WEB_BODY if endpoint == "web" else CTX_BODY)
+ )
+ with TokenContextManager() as manager:
+ await BraveWebSearchCore(api_key=API_KEY).search(QUERY)
+ rows = _usage_rows(manager)
+
+ assert len(rows) == 1
+ assert rows[0]["call_type"] == "web_search"
+ assert rows[0]["unit"] == "requests"
+ assert rows[0]["quantity"] == 1.0
+ assert rows[0]["model_id"] == "platform/web-search-brave"
+
+
[email protected]("endpoint", ["web", "llm_context"])
[email protected]("status", [401, 403, 429, 500])
+async def test_a_failed_brave_request_records_nothing(
+ transport, monkeypatch, endpoint, status
+):
+ from xagent.core.model.chat.token_context import TokenContextManager
+
+ monkeypatch.setenv("XAGENT_BRAVE_SEARCH_ENDPOINT", endpoint)
+ transport(lambda r: httpx.Response(status, json={}))
+ with TokenContextManager() as manager:
+ with pytest.raises(ValueError):
+ await BraveWebSearchCore(api_key=API_KEY).search(QUERY)
+ assert _usage_rows(manager) == []
+
+
+async def test_a_brave_network_error_records_nothing(transport):
+ from xagent.core.model.chat.token_context import TokenContextManager
+
+ def boom(request: httpx.Request) -> httpx.Response:
+ raise httpx.ConnectError("down", request=request)
+
+ transport(boom)
+ with TokenContextManager() as manager:
+ with pytest.raises(ValueError):
+ await BraveWebSearchCore(api_key=API_KEY).search(QUERY)
+ assert _usage_rows(manager) == []
+
+
+async def test_refused_before_sending_records_nothing(transport, monkeypatch):
+ from xagent.core.model.chat.token_context import TokenContextManager
+
+ requests = transport(lambda r: httpx.Response(200, json=WEB_BODY))
+ monkeypatch.delenv("BRAVE_SEARCH_API_KEY", raising=False)
+ with TokenContextManager() as manager:
+ with pytest.raises(ValueError):
+ await BraveWebSearchCore(api_key="").search(QUERY)
+ with pytest.raises(ValueError):
+ await BraveWebSearchCore(api_key=API_KEY).search("w " * 80)
+ assert _usage_rows(manager) == []
+ assert requests == []
+
+
+async def test_a_2xx_with_an_unreadable_body_is_still_recorded(transport):
+ from xagent.core.model.chat.token_context import TokenContextManager
+
+ transport(lambda r: httpx.Response(200, content=b"not json"))
+ with TokenContextManager() as manager:
+ with pytest.raises(ValueError):
+ await BraveWebSearchCore(api_key=API_KEY).search(QUERY)
+ assert len(_usage_rows(manager)) == 1
+
+
+async def test_recorded_before_result_pages_are_fetched(transport, monkeypatch):
+ from xagent.core.model.chat.token_context import TokenContextManager
+
+ transport(lambda r: httpx.Response(200, json=WEB_BODY))
+
+ class FailingFetcher:
+ def __init__(self, proxy_url=None):
+ pass
+
+ async def fetch_text(self, url: str) -> str:
+ raise RuntimeError("page fetch failed")
+
+ monkeypatch.setattr(mod, "WebContentFetcher", FailingFetcher)
+ with TokenContextManager() as manager:
+ try:
+ await BraveWebSearchCore(api_key=API_KEY).search(
+ QUERY, include_content=True
+ )
+ except Exception:
+ pass
+ assert len(_usage_rows(manager)) == 1