Skip to content

Make OpenAPI tool async #2872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −17
Open

Make OpenAPI tool async #2872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ dependencies = [
"google-cloud-storage>=2.18.0, <3.0.0", # For GCS Artifact service
"google-genai>=1.21.1, <2.0.0", # Google GenAI SDK
"graphviz>=0.20.2, <1.0.0", # Graphviz for graph rendering
"httpx>=0.27.0, <1.0.0", # HTTP client library
"mcp>=1.8.0, <2.0.0;python_version>='3.10'", # For MCP Toolset
"opentelemetry-api>=1.31.0, <2.0.0", # OpenTelemetry
"opentelemetry-exporter-gcp-trace>=1.9.0, <2.0.0",
Expand Down
8 changes: 4 additions & 4 deletions src/google/adk/tools/openapi_tool/auth/auth_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
from fastapi.openapi.models import OAuth2
from fastapi.openapi.models import OpenIdConnect
from fastapi.openapi.models import Schema
import httpx
from pydantic import BaseModel
from pydantic import ValidationError
import requests

from ....auth.auth_credential import AuthCredential
from ....auth.auth_credential import AuthCredentialTypes
Expand Down Expand Up @@ -287,14 +287,14 @@ def openid_url_to_scheme_credential(
Raises:
ValueError: If the OpenID URL is invalid, fetching fails, or required
fields are missing.
requests.exceptions.RequestException: If there's an error during the
httpx.HTTPStatusError or httpx.RequestError: If there's an error during the
HTTP request.
"""
try:
response = requests.get(openid_url, timeout=10)
response = httpx.get(openid_url, timeout=10)
response.raise_for_status()
config_dict = response.json()
except requests.exceptions.RequestException as e:
except httpx.RequestError as e:
raise ValueError(
f"Failed to fetch OpenID configuration from {openid_url}: {e}"
) from e
Expand Down
15 changes: 10 additions & 5 deletions src/google/adk/tools/openapi_tool/openapi_spec_parser/rest_api_tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

from fastapi.openapi.models import Operation
from google.genai.types import FunctionDeclaration
import requests
import httpx
from typing_extensions import override

from ....auth.auth_credential import AuthCredential
Expand Down Expand Up @@ -240,7 +240,7 @@ def _prepare_request_params(

Returns:
A dictionary containing the request parameters for the API call. This
initializes a requests.request() call.
initializes an httpx.AsyncClient.request() call.

Example:
self._prepare_request_params({"input_id": "test-id"})
Expand Down Expand Up @@ -395,13 +395,13 @@ async def call(

# Got all parameters. Call the API.
request_params = self._prepare_request_params(api_params, api_args)
response = requests.request(**request_params)
response = await _request(**request_params)

# Parse API response
try:
response.raise_for_status() # Raise HTTPError for bad responses
response.raise_for_status() # Raise HTTPStatusError for bad responses
return response.json() # Try to decode JSON
except requests.exceptions.HTTPError:
except httpx.HTTPStatusError:
error_details = response.content.decode("utf-8")
return {
"error": (
Expand All @@ -427,3 +427,8 @@ def __repr__(self):
f' auth_scheme="{self.auth_scheme}",'
f' auth_credential="{self.auth_credential}")'
)


async def _request(**request_params) -> httpx.Response:
async with httpx.AsyncClient() as client:
return await client.request(**request_params)
Comment on lines +432 to +434
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The _request helper function can be simplified. For making a single request, using the top-level httpx.request() function is more concise. It handles the client creation and cleanup internally, just like using async with httpx.AsyncClient(), but with less code.

Suggested change
async def _request(**request_params) -> httpx.Response:
async with httpx.AsyncClient() as client:
return await client.request(**request_params)
async def _request(**request_params) -> httpx.Response:
# `httpx.request` is more concise for a single request.
return await httpx.request(**request_params)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this, because httpx.request is synchronous

14 changes: 8 additions & 6 deletions tests/unittests/tools/openapi_tool/auth/test_auth_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
from google.adk.tools.openapi_tool.auth.auth_helpers import service_account_dict_to_scheme_credential
from google.adk.tools.openapi_tool.auth.auth_helpers import service_account_scheme_credential
from google.adk.tools.openapi_tool.auth.auth_helpers import token_to_scheme_credential
import httpx
import pytest
import requests


def test_token_to_scheme_credential_api_key_header():
Expand Down Expand Up @@ -272,7 +272,7 @@ def test_openid_dict_to_scheme_credential_missing_credential_fields():
openid_dict_to_scheme_credential(config_dict, scopes, credential_dict)


@patch("requests.get")
@patch("httpx.get")
def test_openid_url_to_scheme_credential(mock_get):
mock_response = {
"authorization_endpoint": "auth_url",
Expand Down Expand Up @@ -303,7 +303,7 @@ def test_openid_url_to_scheme_credential(mock_get):
mock_get.assert_called_once_with("openid_url", timeout=10)


@patch("requests.get")
@patch("httpx.get")
def test_openid_url_to_scheme_credential_no_openid_url(mock_get):
mock_response = {
"authorization_endpoint": "auth_url",
Expand All @@ -326,9 +326,11 @@ def test_openid_url_to_scheme_credential_no_openid_url(mock_get):
assert scheme.openIdConnectUrl == "openid_url"


@patch("requests.get")
@patch("httpx.get")
def test_openid_url_to_scheme_credential_request_exception(mock_get):
mock_get.side_effect = requests.exceptions.RequestException("Test Error")
mock_get.side_effect = httpx.HTTPStatusError(
"Test Error", request=None, response=None
)
credential_dict = {"client_id": "client_id", "client_secret": "client_secret"}

with pytest.raises(
Expand All @@ -337,7 +339,7 @@ def test_openid_url_to_scheme_credential_request_exception(mock_get):
openid_url_to_scheme_credential("openid_url", [], credential_dict)


@patch("requests.get")
@patch("httpx.get")
def test_openid_url_to_scheme_credential_invalid_json(mock_get):
mock_get.return_value.json.side_effect = ValueError("Invalid JSON")
mock_get.return_value.raise_for_status.return_value = None
Expand Down
5 changes: 3 additions & 2 deletions tests/unittests/tools/openapi_tool/openapi_spec_parser/test_rest_api_tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from google.adk.tools.tool_context import ToolContext
from google.genai.types import FunctionDeclaration
from google.genai.types import Schema
import httpx
import pytest


Expand Down Expand Up @@ -193,7 +194,7 @@ def test_get_declaration(
assert isinstance(declaration.parameters, Schema)

@patch(
"google.adk.tools.openapi_tool.openapi_spec_parser.rest_api_tool.requests.request"
"google.adk.tools.openapi_tool.openapi_spec_parser.rest_api_tool._request"
)
@pytest.mark.asyncio
async def test_call_success(
Expand Down Expand Up @@ -225,7 +226,7 @@ async def test_call_success(
assert result == {"result": "success"}

@patch(
"google.adk.tools.openapi_tool.openapi_spec_parser.rest_api_tool.requests.request"
"google.adk.tools.openapi_tool.openapi_spec_parser.rest_api_tool._request"
)
@pytest.mark.asyncio
async def test_call_auth_pending(
Expand Down