Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.
Python ai-agentsai-toolsbrowser-agentbrowser-automationbrowser-usecdpcloud-browsercomputer-useheadless-browserllmmcpplaywrightpythonremote-browserstealth-browserweb-automationweb-scraping
fix(openrouter): validate client and response inputs
MagMuellerf356f2ed3e21
diff --git a/browser_use/llm/openrouter/chat.py b/browser_use/llm/openrouter/chat.pyindex f71fa4e06..eaa68190c 100644--- a/browser_use/llm/openrouter/chat.py+++ b/browser_use/llm/openrouter/chat.py@@ -1,10 +1,11 @@+import osfrom collections.abc import Mappingfrom dataclasses import dataclassfrom typing import Any, TypeVar, overloadimport httpxfrom openai import APIConnectionError, APIStatusError, AsyncOpenAI, RateLimitError-from openai.types.chat.chat_completion import ChatCompletion+from openai.types.chat.chat_completion import ChatCompletion, Choicefrom openai.types.shared_params.response_format_json_schema import (JSONSchema,ResponseFormatJSONSchema,@@ -57,17 +58,23 @@ class ChatOpenRouter(BaseChatModel):def _get_client_params(self) -> dict[str, Any]:"""Prepare client parameters dictionary."""+ api_key = self.api_key or os.getenv('OPENROUTER_API_KEY')+ if not api_key:+ raise ModelProviderError(+ message='Missing OpenRouter API key. Set OPENROUTER_API_KEY or pass api_key.',+ status_code=401,+ model=self.name,+ )+# Define base client paramsbase_params = {- 'api_key': self.api_key,+ 'api_key': api_key,'base_url': self.base_url,'timeout': self.timeout,'max_retries': self.max_retries,'default_headers': self.default_headers,'default_query': self.default_query,'_strict_response_validation': self._strict_response_validation,- 'top_p': self.top_p,- 'seed': self.seed,}# Create client_params dict with non-None values@@ -91,6 +98,15 @@ class ChatOpenRouter(BaseChatModel):self._client = AsyncOpenAI(**client_params)return self._client+ def _get_first_choice(self, response: ChatCompletion) -> Choice:+ if response.choices:+ return response.choices[0]+ raise ModelProviderError(+ message='Invalid OpenRouter response: missing or empty `choices`.',+ status_code=502,+ model=self.name,+ )+@propertydef name(self) -> str:return str(self.model)@@ -154,9 +170,10 @@ class ChatOpenRouter(BaseChatModel):**(self.extra_body or {}),)+ choice = self._get_first_choice(response)usage = self._get_usage(response)return ChatInvokeCompletion(- completion=response.choices[0].message.content or '',+ completion=choice.message.content or '',usage=usage,)@@ -185,7 +202,8 @@ class ChatOpenRouter(BaseChatModel):**(self.extra_body or {}),)- if response.choices[0].message.content is None:+ choice = self._get_first_choice(response)+ if choice.message.content is None:raise ModelProviderError(message='Failed to parse structured output from model response',status_code=500,@@ -193,13 +211,16 @@ class ChatOpenRouter(BaseChatModel):)usage = self._get_usage(response)- parsed = output_format.model_validate_json(response.choices[0].message.content)+ parsed = output_format.model_validate_json(choice.message.content)return ChatInvokeCompletion(completion=parsed,usage=usage,)+ except ModelProviderError:+ raise+except RateLimitError as e:raise ModelRateLimitError(message=e.message, model=self.name) from ediff --git a/tests/ci/models/test_llm_openrouter.py b/tests/ci/models/test_llm_openrouter.pynew file mode 100644index 000000000..160321c16--- /dev/null+++ b/tests/ci/models/test_llm_openrouter.py@@ -0,0 +1,71 @@+"""Regression tests for OpenRouter client setup and response handling."""++from unittest.mock import AsyncMock, patch++import pytest+from openai.types.chat import ChatCompletion, ChatCompletionMessage+from openai.types.chat.chat_completion import Choice+from pydantic import BaseModel++from browser_use.llm.exceptions import ModelProviderError+from browser_use.llm.messages import UserMessage+from browser_use.llm.openrouter.chat import ChatOpenRouter+++class Answer(BaseModel):+ answer: str+++def _completion(*, content: str | None = 'ok', choices: bool = True) -> ChatCompletion:+ return ChatCompletion(+ id='chatcmpl-test',+ choices=[Choice(finish_reason='stop', index=0, message=ChatCompletionMessage(role='assistant', content=content))]+ if choices+ else [],+ created=0,+ model='openai/gpt-4o',+ object='chat.completion',+ )+++def test_request_params_are_not_client_params():+ llm = ChatOpenRouter(model='openai/gpt-4o', api_key='test-key', top_p=0.9, seed=42)++ client = llm.get_client()++ assert client.api_key == 'test-key'+ assert 'top_p' not in llm._get_client_params()+ assert 'seed' not in llm._get_client_params()+++def test_provider_key_does_not_fall_back_to_openai_key(monkeypatch: pytest.MonkeyPatch):+ monkeypatch.setenv('OPENAI_API_KEY', 'wrong-provider-key')+ monkeypatch.setenv('OPENROUTER_API_KEY', 'openrouter-key')+ assert ChatOpenRouter(model='openai/gpt-4o').get_client().api_key == 'openrouter-key'++ monkeypatch.delenv('OPENROUTER_API_KEY')+ with pytest.raises(ModelProviderError, match='Missing OpenRouter API key') as exc_info:+ ChatOpenRouter(model='openai/gpt-4o').get_client()+ assert exc_info.value.status_code == 401+++async def test_empty_choices_raise_provider_error():+ llm = ChatOpenRouter(model='openai/gpt-4o', api_key='test-key')+ create = AsyncMock(return_value=_completion(choices=False))++ with patch.object(type(llm.get_client().chat.completions), 'create', create):+ with pytest.raises(ModelProviderError, match='missing or empty `choices`') as exc_info:+ await llm.ainvoke([UserMessage(content='question')])++ assert exc_info.value.status_code == 502+++async def test_structured_provider_error_keeps_status_code():+ llm = ChatOpenRouter(model='openai/gpt-4o', api_key='test-key')+ create = AsyncMock(return_value=_completion(content=None))++ with patch.object(type(llm.get_client().chat.completions), 'create', create):+ with pytest.raises(ModelProviderError, match='Failed to parse structured output') as exc_info:+ await llm.ainvoke([UserMessage(content='question')], Answer)++ assert exc_info.value.status_code == 500