Skip to content

Fix case-insensitive header overrides #3486

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
fallintoplace wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix case-insensitive header overrides #3486

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
16 changes: 15 additions & 1 deletion src/openai/_base_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ def _custom_auth(

def _build_headers(self, options: FinalRequestOptions, *, retries_taken: int = 0) -> httpx.Headers:
custom_headers = options.headers or {}
headers_dict = _merge_mappings({**self._auth_headers(options.security), **self.default_headers}, custom_headers)
headers_dict = _merge_headers(self._auth_headers(options.security), self.default_headers, custom_headers)
self._validate_headers(headers_dict, custom_headers)

# headers are case-insensitive while dictionaries are not.
Expand Down Expand Up @@ -2212,3 +2212,17 @@ def _merge_mappings(
"""
merged = {**obj1, **obj2}
return {key: value for key, value in merged.items() if not isinstance(value, Omit)}


def _merge_headers(*mappings: Headers) -> dict[str, str]:
"""Merge headers case-insensitively, with later mappings taking precedence."""
merged: dict[str, tuple[str, str]] = {}
for mapping in mappings:
for name, value in mapping.items():
normalized_name = name.lower()
if isinstance(value, Omit):
merged.pop(normalized_name, None)
else:
merged[normalized_name] = (name, value)

return {name: value for name, value in merged.values()}
6 changes: 3 additions & 3 deletions src/openai/resources/beta/realtime/realtime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
from ...._models import construct_type_unchecked
from ...._resource import SyncAPIResource, AsyncAPIResource
from ...._exceptions import OpenAIError
from ...._base_client import _merge_mappings
from ...._base_client import _merge_headers
from ....types.beta.realtime import (
session_update_event_param,
response_create_event_param,
Expand Down Expand Up @@ -378,7 +378,7 @@ async def __aenter__(self) -> AsyncRealtimeConnection:
await connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**auth_headers,
"OpenAI-Beta": "realtime=v1",
Expand Down Expand Up @@ -561,7 +561,7 @@ def __enter__(self) -> RealtimeConnection:
connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**auth_headers,
"OpenAI-Beta": "realtime=v1",
Expand Down
6 changes: 3 additions & 3 deletions src/openai/resources/beta/responses/responses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
)
from ...._exceptions import OpenAIError, WebSocketConnectionClosedError
from ...._send_queue import SendQueue
from ...._base_client import _merge_mappings, make_request_options
from ...._base_client import _merge_headers, make_request_options
from ...._event_handler import EventHandlerRegistry
from ....types.beta.beta_response import BetaResponse
from ....types.beta.beta_tool_param import BetaToolParam
Expand Down Expand Up @@ -4384,7 +4384,7 @@ async def _connect_ws(self, extra_query: Query, extra_headers: Headers) -> Async
return await connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**self.__client.auth_headers,
},
Expand Down Expand Up @@ -4829,7 +4829,7 @@ def _connect_ws(self, extra_query: Query, extra_headers: Headers) -> WebSocketCo
return connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**self.__client.auth_headers,
},
Expand Down
6 changes: 3 additions & 3 deletions src/openai/resources/realtime/realtime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._exceptions import OpenAIError, WebSocketConnectionClosedError
from ..._send_queue import SendQueue
from ..._base_client import _merge_mappings
from ..._base_client import _merge_headers
from .client_secrets import (
ClientSecrets,
AsyncClientSecrets,
Expand Down Expand Up @@ -710,7 +710,7 @@ async def _connect_ws(self, extra_query: Query, extra_headers: Headers) -> Async
return await connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**auth_headers,
},
Expand Down Expand Up @@ -1178,7 +1178,7 @@ def _connect_ws(self, extra_query: Query, extra_headers: Headers) -> WebSocketCo
return connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**auth_headers,
},
Expand Down
6 changes: 3 additions & 3 deletions src/openai/resources/responses/responses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
)
from ..._exceptions import OpenAIError, WebSocketConnectionClosedError
from ..._send_queue import SendQueue
from ..._base_client import _merge_mappings, make_request_options
from ..._base_client import _merge_headers, make_request_options
from ..._event_handler import EventHandlerRegistry
from ...types.responses import (
response_create_params,
Expand Down Expand Up @@ -4335,7 +4335,7 @@ async def _connect_ws(self, extra_query: Query, extra_headers: Headers) -> Async
return await connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**self.__client.auth_headers,
},
Expand Down Expand Up @@ -4780,7 +4780,7 @@ def _connect_ws(self, extra_query: Query, extra_headers: Headers) -> WebSocketCo
return connect(
str(url),
user_agent_header=self.__client.user_agent,
additional_headers=_merge_mappings(
additional_headers=_merge_headers(
{
**self.__client.auth_headers,
},
Expand Down
29 changes: 29 additions & 0 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
DefaultHttpxClient,
DefaultAsyncHttpxClient,
get_platform,
_merge_headers,
make_request_options,
)

Expand Down Expand Up @@ -124,6 +125,14 @@ def _get_open_connections(client: OpenAI | AsyncOpenAI) -> int:


class TestOpenAI:
def test_merge_headers_case_insensitively(self) -> None:
headers = _merge_headers(
{"Authorization": "Bearer real", "X-Remove": "value"},
{"authorization": "Bearer custom", "x-remove": Omit()},
)

assert headers == {"authorization": "Bearer custom"}

@pytest.mark.respx(base_url=base_url)
def test_raw_response(self, respx_mock: MockRouter, client: OpenAI) -> None:
respx_mock.post("/foo").mock(return_value=httpx.Response(200, json={"foo": "bar"}))
Expand Down Expand Up @@ -454,6 +463,16 @@ def test_validate_headers(self) -> None:

assert request.headers.get("Authorization") == f"Bearer {api_key}"

lowercase_auth_request = client._build_request(
FinalRequestOptions(method="get", url="/foo", headers={"authorization": "Bearer custom"})
)
assert lowercase_auth_request.headers.get_list("Authorization") == ["Bearer custom"]

omitted_auth_request = client._build_request(
FinalRequestOptions(method="get", url="/foo", headers={"authorization": Omit()})
)
assert "Authorization" not in omitted_auth_request.headers

admin_request = client._build_request(
FinalRequestOptions(
method="get",
Expand Down Expand Up @@ -1718,6 +1737,16 @@ async def test_validate_headers(self) -> None:
request = client._build_request(options)
assert request.headers.get("Authorization") == f"Bearer {api_key}"

lowercase_auth_request = client._build_request(
FinalRequestOptions(method="get", url="/foo", headers={"authorization": "Bearer custom"})
)
assert lowercase_auth_request.headers.get_list("Authorization") == ["Bearer custom"]

omitted_auth_request = client._build_request(
FinalRequestOptions(method="get", url="/foo", headers={"authorization": Omit()})
)
assert "Authorization" not in omitted_auth_request.headers

admin_request = client._build_request(
FinalRequestOptions(
method="get",
Expand Down