Skip to content

Commit a87a1f8

Browse files
fix(client): preserve hardcoded query params when merging with user params
1 parent 3c67098 commit a87a1f8

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

src/orb/_base_client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,10 @@ def _build_request(
541541
files = cast(HttpxRequestFiles, ForceMultipartDict())
542542

543543
prepared_url = self._prepare_url(options.url)
544+
# preserve hard-coded query params from the url
545+
if params and prepared_url.query:
546+
params = {**dict(prepared_url.params.items()), **params}
547+
prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0])
544548
if "_" in prepared_url.host:
545549
# work around https://github.com/encode/httpx/discussions/2880
546550
kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")}

tests/test_client.py

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,30 @@ def test_default_query_option(self) -> None:
419419

420420
client.close()
421421

422+
def test_hardcoded_query_params_in_url(self, client: Orb) -> None:
423+
request = client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true"))
424+
url = httpx.URL(request.url)
425+
assert dict(url.params) == {"beta": "true"}
426+
427+
request = client._build_request(
428+
FinalRequestOptions(
429+
method="get",
430+
url="/foo?beta=true",
431+
params={"limit": "10", "page": "abc"},
432+
)
433+
)
434+
url = httpx.URL(request.url)
435+
assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"}
436+
437+
request = client._build_request(
438+
FinalRequestOptions(
439+
method="get",
440+
url="/files/a%2Fb?beta=true",
441+
params={"limit": "10"},
442+
)
443+
)
444+
assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10"
445+
422446
def test_request_extra_json(self, client: Orb) -> None:
423447
request = client._build_request(
424448
FinalRequestOptions(
@@ -1366,6 +1390,30 @@ async def test_default_query_option(self) -> None:
13661390

13671391
await client.close()
13681392

1393+
async def test_hardcoded_query_params_in_url(self, async_client: AsyncOrb) -> None:
1394+
request = async_client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true"))
1395+
url = httpx.URL(request.url)
1396+
assert dict(url.params) == {"beta": "true"}
1397+
1398+
request = async_client._build_request(
1399+
FinalRequestOptions(
1400+
method="get",
1401+
url="/foo?beta=true",
1402+
params={"limit": "10", "page": "abc"},
1403+
)
1404+
)
1405+
url = httpx.URL(request.url)
1406+
assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"}
1407+
1408+
request = async_client._build_request(
1409+
FinalRequestOptions(
1410+
method="get",
1411+
url="/files/a%2Fb?beta=true",
1412+
params={"limit": "10"},
1413+
)
1414+
)
1415+
assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10"
1416+
13691417
def test_request_extra_json(self, client: Orb) -> None:
13701418
request = client._build_request(
13711419
FinalRequestOptions(

0 commit comments

Comments
 (0)