Skip to content

Commit 7fce7f6

Browse files
authored
fix(voice): stop forcing the STT session logging header (#5114)
1 parent de0aa85 commit 7fce7f6

3 files changed

Lines changed: 66 additions & 46 deletions

File tree

‎src/agents/voice/models/openai_stt.py‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,7 @@ def _prepare_websocket_url(client: AsyncOpenAI) -> str:
7676

7777

7878
def _prepare_websocket_headers(client: AsyncOpenAI) -> dict[str, str]:
79-
return merge_openai_client_websocket_headers(
80-
client,
81-
extra_headers={"OpenAI-Log-Session": "1"},
82-
)
79+
return merge_openai_client_websocket_headers(client)
8380

8481

8582
async def _wait_for_event(

‎tests/voice/test_openai_stt.py‎

Lines changed: 60 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import numpy as np
1414
import numpy.typing as npt
1515
import pytest
16-
from openai import AsyncOpenAI
16+
from openai import AsyncOpenAI, Omit, omit
1717

1818
import agents._debug as _debug
1919
from agents import trace
@@ -455,7 +455,19 @@ async def test_non_json_messages_should_crash():
455455

456456

457457
@pytest.mark.asyncio
458-
async def test_session_connects_and_configures_successfully():
458+
@pytest.mark.parametrize(
459+
("session_header", "expected_session_headers"),
460+
[
461+
(None, {}),
462+
("0", {"openai-log-session": "0"}),
463+
("1", {"openai-log-session": "1"}),
464+
(omit, {}),
465+
],
466+
ids=["default", "explicit-zero", "explicit-one", "omitted"],
467+
)
468+
async def test_session_connects_and_configures_successfully(
469+
session_header: str | Omit | None, expected_session_headers: dict[str, str]
470+
):
459471
"""
460472
Test that the session:
461473
1) Connects to the correct URL with correct headers.
@@ -470,42 +482,53 @@ async def test_session_connects_and_configures_successfully():
470482
json.dumps({"type": "transcription_session.updated"}),
471483
]
472484
)
473-
with patch("websockets.connect", return_value=mock_ws) as mock_connect:
474-
# Instantiate the session
475-
input_audio = await StreamedAudioInputFactory.get(count=2)
476-
stt_settings = STTModelSettings()
477-
478-
session = OpenAISTTTranscriptionSession(
479-
input=input_audio,
480-
client=create_mock_openai_client(),
481-
model="whisper-1",
482-
settings=stt_settings,
483-
trace_include_sensitive_data=False,
484-
trace_include_sensitive_audio_data=False,
485-
)
486-
487-
# Start reading from transcribe_turns, which triggers _process_websocket_connection
488-
turns = session.transcribe_turns()
489-
490-
async for _ in turns:
491-
pass
492-
493-
# Check connect call
494-
args, kwargs = mock_connect.call_args
495-
assert "wss://api.openai.com/v1/realtime?intent=transcription" in args[0]
496-
headers = kwargs.get("additional_headers", {})
497-
assert headers.get("Authorization") == "Bearer FAKE_KEY"
498-
assert kwargs["logger"].isEnabledFor(logging.DEBUG) is False
499-
assert headers.get("OpenAI-Beta") is None
500-
assert headers.get("OpenAI-Log-Session") == "1"
501-
502-
# Check that we sent a 'session.update' message
503-
sent_messages = [call.args[0] for call in mock_ws.send.call_args_list]
504-
assert any('"type": "session.update"' in msg for msg in sent_messages), (
505-
f"Expected 'session.update' in {sent_messages}"
506-
)
485+
# Exercise real client header materialization without opening a network connection.
486+
default_headers = {} if session_header is None else {"openai-log-session": session_header}
487+
async with AsyncOpenAI(
488+
api_key="FAKE_KEY", base_url="https://api.openai.com/v1", default_headers=default_headers
489+
) as client:
490+
with patch("websockets.connect", return_value=mock_ws) as mock_connect:
491+
# Instantiate the session
492+
input_audio = await StreamedAudioInputFactory.get(count=2)
493+
stt_settings = STTModelSettings()
494+
495+
session = OpenAISTTTranscriptionSession(
496+
input=input_audio,
497+
client=client,
498+
model="whisper-1",
499+
settings=stt_settings,
500+
trace_include_sensitive_data=False,
501+
trace_include_sensitive_audio_data=False,
502+
)
507503

508-
await session.close()
504+
try:
505+
# Start reading from transcribe_turns, which triggers _process_websocket_connection
506+
turns = session.transcribe_turns()
507+
508+
async for _ in turns:
509+
pass
510+
511+
# Check connect call
512+
args, kwargs = mock_connect.call_args
513+
assert "wss://api.openai.com/v1/realtime?intent=transcription" in args[0]
514+
headers = kwargs.get("additional_headers", {})
515+
assert headers.get("Authorization") == "Bearer FAKE_KEY"
516+
assert kwargs["logger"].isEnabledFor(logging.DEBUG) is False
517+
assert headers.get("OpenAI-Beta") is None
518+
assert {
519+
key: value
520+
for key, value in headers.items()
521+
if key.lower() == "openai-log-session"
522+
} == expected_session_headers
523+
524+
# Check that we sent a 'session.update' message
525+
sent_messages = [call.args[0] for call in mock_ws.send.call_args_list]
526+
assert any('"type": "session.update"' in msg for msg in sent_messages), (
527+
f"Expected 'session.update' in {sent_messages}"
528+
)
529+
530+
finally:
531+
await session.close()
509532

510533

511534
@pytest.mark.asyncio

‎tests/voice/test_openai_stt_client_config.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def test_streaming_stt_websocket_headers_use_client_configuration() -> None:
9595
assert headers["OpenAI-Organization"] == "org-client"
9696
assert headers["OpenAI-Project"] == "proj-client"
9797
assert headers["X-Proxy-Token"] == "proxy-token"
98-
assert headers["OpenAI-Log-Session"] == "1"
98+
assert all(key.lower() != "openai-log-session" for key in headers)
9999

100100

101101
def test_streaming_stt_websocket_headers_skip_openai_omission_sentinels() -> None:
@@ -114,7 +114,7 @@ def test_streaming_stt_websocket_headers_skip_openai_omission_sentinels() -> Non
114114
assert headers["X-Proxy-Token"] == "proxy-token"
115115
assert "OpenAI-Organization" not in headers
116116
assert "OpenAI-Project" not in headers
117-
assert headers["OpenAI-Log-Session"] == "1"
117+
assert all(key.lower() != "openai-log-session" for key in headers)
118118

119119

120120
def test_streaming_stt_websocket_headers_omit_removes_inherited_header() -> None:
@@ -126,10 +126,10 @@ def test_streaming_stt_websocket_headers_omit_removes_inherited_header() -> None
126126
headers = _prepare_websocket_headers(client)
127127

128128
assert all(key.lower() != "authorization" for key in headers)
129-
assert headers["OpenAI-Log-Session"] == "1"
129+
assert all(key.lower() != "openai-log-session" for key in headers)
130130

131131

132-
def test_streaming_stt_websocket_fixed_session_header_replaces_client_casing() -> None:
132+
def test_streaming_stt_websocket_session_header_preserves_client_configuration() -> None:
133133
client = _mock_client(
134134
auth_headers={},
135135
default_headers={"openai-log-session": "0"},
@@ -140,4 +140,4 @@ def test_streaming_stt_websocket_fixed_session_header_replaces_client_casing() -
140140
session_headers = {
141141
key: value for key, value in headers.items() if key.lower() == "openai-log-session"
142142
}
143-
assert session_headers == {"OpenAI-Log-Session": "1"}
143+
assert session_headers == {"openai-log-session": "0"}

0 commit comments

Comments
 (0)