From c5e14c84bf2343dea186c88dfe568d6a3f5e02b1 Mon Sep 17 00:00:00 2001 From: Harshil <181649964+Harshil-1603@users.noreply.github.com> Date: Tue, 17 Nov 2026 21:57:21 +0530 Subject: [PATCH] fix(client): preserve REST endpoint query parameters --- src/a2a/client/transports/http_helpers.py | 19 ++++ src/a2a/client/transports/rest.py | 17 ++-- src/a2a/compat/v0_3/rest_transport.py | 13 ++- .../transports/test_rest_endpoint_queries.py | 92 +++++++++++++++++++ 4 files changed, 131 insertions(+), 10 deletions(-) create mode 100644 tests/client/transports/test_rest_endpoint_queries.py diff --git a/src/a2a/client/transports/http_helpers.py b/src/a2a/client/transports/http_helpers.py index 17e882b24..702c5ffd4 100644 --- a/src/a2a/client/transports/http_helpers.py +++ b/src/a2a/client/transports/http_helpers.py @@ -4,6 +4,9 @@ from collections.abc import AsyncGenerator, Callable, Iterator from contextlib import contextmanager from typing import TYPE_CHECKING, Any, NoReturn +from urllib.parse import urlsplit, urlunsplit + +import httpx from a2a.client.client import ClientCallContext from a2a.client.errors import A2AClientError, A2AClientTimeoutError @@ -57,6 +60,22 @@ def get_http_args(context: ClientCallContext | None) -> dict[str, Any]: return http_kwargs +def get_http_url(base_url: str, path: str) -> str: + """Appends an operation path without moving URL queries into the path.""" + parts = urlsplit(base_url) + return urlunsplit(parts._replace(path=parts.path.rstrip('/') + path)) + + +def get_http_params( + base_url: str, params: dict[str, Any] | None = None +) -> dict[str, Any] | str | None: + """Merges endpoint parameters with operation parameters taking precedence.""" + query = urlsplit(base_url).query + if not query: + return params + return str(httpx.QueryParams(query).merge(params or {})) + + async def send_http_request( httpx_client: AsyncClient, request: Request, diff --git a/src/a2a/client/transports/rest.py b/src/a2a/client/transports/rest.py index 9d2b6ec2b..f82e74c2c 100644 --- a/src/a2a/client/transports/rest.py +++ b/src/a2a/client/transports/rest.py @@ -14,6 +14,8 @@ from a2a.client.transports.base import ClientTransport from a2a.client.transports.http_helpers import ( get_http_args, + get_http_params, + get_http_url, handle_http_exceptions, send_http_request, send_http_stream_request, @@ -109,7 +111,7 @@ def __init__( is_shared_httpx: bool = False, ): """Initializes the RestTransport.""" - self.url = url.removesuffix('/') + self.url = get_http_url(url, '') self.httpx_client = httpx_client self.agent_card = agent_card self.is_shared_httpx = is_shared_httpx @@ -308,8 +310,8 @@ async def delete_task_push_notification_config( ) http_request: Request = self.httpx_client.build_request( 'DELETE', - f'{self.url}{path}', - params=params, + get_http_url(self.url, path), + params=get_http_params(self.url, params), **get_http_args(context), ) if self.httpx_client.is_closed: @@ -409,10 +411,13 @@ async def _send_stream_request( path = self._get_path(target, tenant) http_kwargs = get_http_args(context) + if params := get_http_params(self.url): + http_kwargs['params'] = params + async for sse_data in send_http_stream_request( self.httpx_client, method, - f'{self.url}{path}', + get_http_url(self.url, path), self._handle_http_error, self._handle_sse_error, json=json, @@ -455,9 +460,9 @@ async def _execute_request( # noqa: PLR0913 request = self.httpx_client.build_request( method, - f'{self.url}{path}', + get_http_url(self.url, path), json=json, - params=params, + params=get_http_params(self.url, params), **http_kwargs, ) return await self._send_request(request) diff --git a/src/a2a/compat/v0_3/rest_transport.py b/src/a2a/compat/v0_3/rest_transport.py index d48b83a5f..1769da8c6 100644 --- a/src/a2a/compat/v0_3/rest_transport.py +++ b/src/a2a/compat/v0_3/rest_transport.py @@ -16,6 +16,8 @@ from a2a.client.transports.base import ClientTransport from a2a.client.transports.http_helpers import ( get_http_args, + get_http_params, + get_http_url, send_http_request, send_http_stream_request, ) @@ -86,7 +88,7 @@ def __init__( is_shared_httpx: bool = False, ): """Initializes the CompatRestTransport.""" - self.url = url.removesuffix('/') + self.url = get_http_url(url, '') self.httpx_client = httpx_client self.agent_card = agent_card self.is_shared_httpx = is_shared_httpx @@ -429,10 +431,13 @@ async def _send_stream_request( http_kwargs['headers'][VERSION_HEADER.lower()] = PROTOCOL_VERSION_0_3 add_legacy_extension_header(http_kwargs['headers']) + if params := get_http_params(self.url): + http_kwargs['params'] = params + async for sse_data in send_http_stream_request( self.httpx_client, method, - f'{self.url}{path}', + get_http_url(self.url, path), self._handle_http_error, json=json, **http_kwargs, @@ -466,9 +471,9 @@ async def _execute_request( request = self.httpx_client.build_request( method, - f'{self.url}{path}', + get_http_url(self.url, path), json=json, - params=params, + params=get_http_params(self.url, params), **http_kwargs, ) return await self._send_request(request) diff --git a/tests/client/transports/test_rest_endpoint_queries.py b/tests/client/transports/test_rest_endpoint_queries.py new file mode 100644 index 000000000..60c8ce77c --- /dev/null +++ b/tests/client/transports/test_rest_endpoint_queries.py @@ -0,0 +1,92 @@ +import pytest + +from a2a.client.transports.rest import RestTransport +from a2a.compat.v0_3.rest_transport import CompatRestTransport +from a2a.helpers.proto_helpers import new_text_message +from a2a.types.a2a_pb2 import ( + AgentCard, + DeleteTaskPushNotificationConfigRequest, + GetTaskRequest, + SendMessageRequest, + SubscribeToTaskRequest, +) +from a2a.utils._httpx_compat import Request, Response + + +pytestmark = pytest.mark.httpx2 + + +@pytest.mark.asyncio +@pytest.mark.parametrize('http_library', ['httpx', 'httpx2']) +@pytest.mark.parametrize('legacy', [False, True], ids=['v1', 'v0_3']) +@pytest.mark.parametrize( + 'endpoint', + [ + 'http://agent/api', + 'http://agent/api/', + 'http://agent/api/?api-version=v1&tag=a&tag=b&blank=&historyLength=99&resource=a/', + ], +) +async def test_rest_endpoint_queries( + http_library: str, legacy: bool, endpoint: str +) -> None: + http = pytest.importorskip(http_library) + prefix = '/api/v1' if legacy else '/api' + expected_paths = [ + f'{prefix}/message:send', + f'{prefix}/tasks/task1', + f'{prefix}/message:stream', + f'{prefix}/tasks/task1:subscribe', + f'{prefix}/tasks/task1/pushNotificationConfigs/config1', + ] + seen: list[str] = [] + + def handle(request: Request) -> Response: + seen.append(request.url.path) + assert request.url.path == expected_paths[len(seen) - 1] + if '?' in endpoint: + assert request.url.params['api-version'] == 'v1' + assert request.url.params.get_list('tag') == ['a', 'b'] + assert request.url.params['blank'] == '' + assert request.url.params['resource'] == 'a/' + if request.url.path.endswith('/tasks/task1'): + assert request.url.params['historyLength'] == '2' + return http.Response(200, json={'id': 'task1'}) + if request.method == 'DELETE': + return http.Response(200, json={}) + if len(seen) > 2: + return http.Response( + 200, + headers={'content-type': 'text/event-stream'}, + content='data: {"task":{"id":"task1"}}\n\n', + ) + return http.Response(200, json={'task': {'id': 'task1'}}) + + async with http.AsyncClient(transport=http.MockTransport(handle)) as client: + transport = (CompatRestTransport if legacy else RestTransport)( + client, AgentCard(), endpoint, is_shared_httpx=True + ) + message = SendMessageRequest(message=new_text_message(text='hello')) + assert (await transport.send_message(message)).task.id == 'task1' + assert ( + await transport.get_task( + GetTaskRequest(id='task1', history_length=2) + ) + ).id == 'task1' + events = [ + event async for event in transport.send_message_streaming(message) + ] + assert [event.task.id for event in events] == ['task1'] + events = [ + event + async for event in transport.subscribe( + SubscribeToTaskRequest(id='task1') + ) + ] + assert [event.task.id for event in events] == ['task1'] + await transport.delete_task_push_notification_config( + DeleteTaskPushNotificationConfigRequest( + task_id='task1', id='config1' + ) + ) + assert seen == expected_paths