-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathtest_session.py
More file actions
2305 lines (1804 loc) · 86.4 KB
/
test_session.py
File metadata and controls
2305 lines (1804 loc) · 86.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import asyncio
import dataclasses
import json
import threading
from typing import Any, cast
from unittest.mock import AsyncMock, Mock, PropertyMock, patch
import pytest
from pydantic import BaseModel, ConfigDict
from agents.exceptions import UserError
from agents.guardrail import GuardrailFunctionOutput, OutputGuardrail
from agents.handoffs import Handoff
from agents.realtime.agent import RealtimeAgent
from agents.realtime.config import RealtimeRunConfig, RealtimeSessionModelSettings
from agents.realtime.events import (
RealtimeAgentEndEvent,
RealtimeAgentStartEvent,
RealtimeAudio,
RealtimeAudioEnd,
RealtimeAudioInterrupted,
RealtimeError,
RealtimeGuardrailTripped,
RealtimeHistoryAdded,
RealtimeHistoryUpdated,
RealtimeRawModelEvent,
RealtimeToolApprovalRequired,
RealtimeToolEnd,
RealtimeToolStart,
)
from agents.realtime.items import (
AssistantAudio,
AssistantMessageItem,
AssistantText,
InputAudio,
InputText,
RealtimeItem,
UserMessageItem,
)
from agents.realtime.model import RealtimeModel, RealtimeModelConfig
from agents.realtime.model_events import (
RealtimeModelAudioDoneEvent,
RealtimeModelAudioEvent,
RealtimeModelAudioInterruptedEvent,
RealtimeModelConnectionStatusEvent,
RealtimeModelErrorEvent,
RealtimeModelInputAudioTranscriptionCompletedEvent,
RealtimeModelItemDeletedEvent,
RealtimeModelItemUpdatedEvent,
RealtimeModelOtherEvent,
RealtimeModelToolCallEvent,
RealtimeModelTranscriptDeltaEvent,
RealtimeModelTurnEndedEvent,
RealtimeModelTurnStartedEvent,
)
from agents.realtime.model_inputs import (
RealtimeModelSendAudio,
RealtimeModelSendInterrupt,
RealtimeModelSendSessionUpdate,
RealtimeModelSendUserInput,
)
from agents.realtime.session import REJECTION_MESSAGE, RealtimeSession, _serialize_tool_output
from agents.tool import FunctionTool
from agents.tool_context import ToolContext
class _DummyModel(RealtimeModel):
def __init__(self) -> None:
super().__init__()
self.events: list[Any] = []
self.listeners: list[Any] = []
async def connect(self, options=None): # pragma: no cover - not used here
pass
async def close(self): # pragma: no cover - not used here
pass
async def send_event(self, event):
self.events.append(event)
def add_listener(self, listener):
self.listeners.append(listener)
def remove_listener(self, listener):
if listener in self.listeners:
self.listeners.remove(listener)
@pytest.mark.asyncio
async def test_property_and_send_helpers_and_enter_alias():
model = _DummyModel()
agent = RealtimeAgent(name="agent")
session = RealtimeSession(model, agent, None)
# property
assert session.model is model
# enter alias calls __aenter__
async with await session.enter():
# send helpers
await session.send_message("hi")
await session.send_audio(b"abc", commit=True)
await session.interrupt()
# verify sent events
assert any(isinstance(e, RealtimeModelSendUserInput) for e in model.events)
assert any(isinstance(e, RealtimeModelSendAudio) and e.commit for e in model.events)
assert any(isinstance(e, RealtimeModelSendInterrupt) for e in model.events)
@pytest.mark.asyncio
async def test_aiter_cancel_breaks_loop_gracefully():
model = _DummyModel()
agent = RealtimeAgent(name="agent")
session = RealtimeSession(model, agent, None)
async def consume():
async for _ in session:
pass
consumer = asyncio.create_task(consume())
await asyncio.sleep(0.01)
consumer.cancel()
# The iterator swallows CancelledError internally and exits cleanly
await consumer
@pytest.mark.asyncio
async def test_transcription_completed_adds_new_user_item():
model = _DummyModel()
agent = RealtimeAgent(name="agent")
session = RealtimeSession(model, agent, None)
event = RealtimeModelInputAudioTranscriptionCompletedEvent(item_id="item1", transcript="hello")
await session.on_event(event)
# Should have appended a new user item
assert len(session._history) == 1
assert session._history[0].type == "message"
assert session._history[0].role == "user"
class _FakeAudio:
# Looks like an audio part but is not an InputAudio/AssistantAudio instance
type = "audio"
transcript = None
@pytest.mark.asyncio
async def test_item_updated_merge_exception_path_logs_error(monkeypatch):
model = _DummyModel()
agent = RealtimeAgent(name="agent")
session = RealtimeSession(model, agent, None)
# existing assistant message with transcript to preserve
existing = AssistantMessageItem(
item_id="a1", role="assistant", content=[AssistantAudio(audio=None, transcript="t")]
)
session._history = [existing]
# incoming message with a deliberately bogus content entry to trigger assertion path
incoming = AssistantMessageItem(
item_id="a1", role="assistant", content=[AssistantAudio(audio=None, transcript=None)]
)
incoming.content[0] = cast(Any, _FakeAudio())
with patch("agents.realtime.session.logger") as mock_logger:
await session.on_event(RealtimeModelItemUpdatedEvent(item=incoming))
# error branch should be hit
assert mock_logger.error.called
@pytest.mark.asyncio
async def test_handle_tool_call_handoff_invalid_result_raises():
model = _DummyModel()
target = RealtimeAgent(name="target")
bad_handoff = Handoff(
tool_name="switch",
tool_description="",
input_json_schema={},
on_invoke_handoff=AsyncMock(return_value=123), # invalid return
input_filter=None,
agent_name=target.name,
is_enabled=True,
)
agent = RealtimeAgent(name="agent", handoffs=[bad_handoff])
session = RealtimeSession(model, agent, None)
with pytest.raises(UserError):
await session._handle_tool_call(
RealtimeModelToolCallEvent(name="switch", call_id="c1", arguments="{}")
)
@pytest.mark.asyncio
async def test_on_guardrail_task_done_emits_error_event():
model = _DummyModel()
agent = RealtimeAgent(name="agent")
session = RealtimeSession(model, agent, None)
async def failing_task():
raise ValueError("task failed")
task = asyncio.create_task(failing_task())
# Wait for it to finish so exception() is available
try:
await task
except Exception: # noqa: S110
pass
session._on_guardrail_task_done(task)
# Allow event task to enqueue
await asyncio.sleep(0.01)
# Should have a RealtimeError queued
err = await session._event_queue.get()
assert isinstance(err, RealtimeError)
@pytest.mark.asyncio
async def test_get_handoffs_async_is_enabled(monkeypatch):
# Agent includes both a direct Handoff and a RealtimeAgent (auto-converted)
target = RealtimeAgent(name="target")
other = RealtimeAgent(name="other")
async def is_enabled(ctx, agent):
return True
# direct handoff with async is_enabled
direct = Handoff(
tool_name="to_target",
tool_description="",
input_json_schema={},
on_invoke_handoff=AsyncMock(return_value=target),
input_filter=None,
agent_name=target.name,
is_enabled=is_enabled,
)
a = RealtimeAgent(name="a", handoffs=[direct, other])
session = RealtimeSession(_DummyModel(), a, None)
enabled = await RealtimeSession._get_handoffs(a, session._context_wrapper)
# Both should be enabled
assert len(enabled) == 2
class MockRealtimeModel(RealtimeModel):
def __init__(self):
super().__init__()
self.listeners = []
self.connect_called = False
self.close_called = False
self.sent_events = []
# Legacy tracking for tests that haven't been updated yet
self.sent_messages = []
self.sent_audio = []
self.sent_tool_outputs = []
self.interrupts_called = 0
async def connect(self, options=None):
self.connect_called = True
def add_listener(self, listener):
self.listeners.append(listener)
def remove_listener(self, listener):
if listener in self.listeners:
self.listeners.remove(listener)
async def send_event(self, event):
from agents.realtime.model_inputs import (
RealtimeModelSendAudio,
RealtimeModelSendInterrupt,
RealtimeModelSendToolOutput,
RealtimeModelSendUserInput,
)
self.sent_events.append(event)
# Update legacy tracking for compatibility
if isinstance(event, RealtimeModelSendUserInput):
self.sent_messages.append(event.user_input)
elif isinstance(event, RealtimeModelSendAudio):
self.sent_audio.append((event.audio, event.commit))
elif isinstance(event, RealtimeModelSendToolOutput):
self.sent_tool_outputs.append((event.tool_call, event.output, event.start_response))
elif isinstance(event, RealtimeModelSendInterrupt):
self.interrupts_called += 1
async def close(self):
self.close_called = True
@pytest.fixture
def mock_agent():
agent = Mock(spec=RealtimeAgent)
agent.get_all_tools = AsyncMock(return_value=[])
type(agent).handoffs = PropertyMock(return_value=[])
type(agent).output_guardrails = PropertyMock(return_value=[])
return agent
@pytest.fixture
def mock_model():
return MockRealtimeModel()
def _set_default_timeout_fields(tool: Mock) -> Mock:
tool.timeout_seconds = None
tool.timeout_behavior = "error_as_result"
tool.timeout_error_function = None
return tool
@pytest.fixture
def mock_function_tool():
tool = _set_default_timeout_fields(Mock(spec=FunctionTool))
tool.name = "test_function"
tool.on_invoke_tool = AsyncMock(return_value="function_result")
tool.needs_approval = False
return tool
@pytest.fixture
def mock_handoff():
handoff = Mock(spec=Handoff)
handoff.name = "test_handoff"
return handoff
class TestEventHandling:
"""Test suite for event handling and transformation in RealtimeSession.on_event"""
@pytest.mark.asyncio
async def test_error_event_transformation(self, mock_model, mock_agent):
"""Test that error events are properly transformed and queued"""
session = RealtimeSession(
mock_model, mock_agent, None, run_config={"async_tool_calls": False}
)
error_event = RealtimeModelErrorEvent(error="Test error")
await session.on_event(error_event)
# Check that events were queued
assert session._event_queue.qsize() == 2
# First event should be raw model event
raw_event = await session._event_queue.get()
assert isinstance(raw_event, RealtimeRawModelEvent)
assert raw_event.data == error_event
# Second event should be transformed error event
error_session_event = await session._event_queue.get()
assert isinstance(error_session_event, RealtimeError)
assert error_session_event.error == "Test error"
@pytest.mark.asyncio
async def test_audio_events_transformation(self, mock_model, mock_agent):
"""Test that audio-related events are properly transformed"""
session = RealtimeSession(
mock_model, mock_agent, None, run_config={"async_tool_calls": False}
)
# Test audio event
audio_event = RealtimeModelAudioEvent(
data=b"audio_data", response_id="resp_1", item_id="item_1", content_index=0
)
await session.on_event(audio_event)
# Test audio interrupted event
interrupted_event = RealtimeModelAudioInterruptedEvent(item_id="item_1", content_index=0)
await session.on_event(interrupted_event)
# Test audio done event
done_event = RealtimeModelAudioDoneEvent(item_id="item_1", content_index=0)
await session.on_event(done_event)
# Should have 6 events total (2 per event: raw + transformed)
assert session._event_queue.qsize() == 6
# Check audio event transformation
await session._event_queue.get() # raw event
audio_session_event = await session._event_queue.get()
assert isinstance(audio_session_event, RealtimeAudio)
assert audio_session_event.audio == audio_event
# Check audio interrupted transformation
await session._event_queue.get() # raw event
interrupted_session_event = await session._event_queue.get()
assert isinstance(interrupted_session_event, RealtimeAudioInterrupted)
# Check audio done transformation
await session._event_queue.get() # raw event
done_session_event = await session._event_queue.get()
assert isinstance(done_session_event, RealtimeAudioEnd)
@pytest.mark.asyncio
async def test_turn_events_transformation(self, mock_model, mock_agent):
"""Test that turn start/end events are properly transformed"""
session = RealtimeSession(
mock_model, mock_agent, None, run_config={"async_tool_calls": False}
)
# Test turn started event
turn_started = RealtimeModelTurnStartedEvent()
await session.on_event(turn_started)
# Test turn ended event
turn_ended = RealtimeModelTurnEndedEvent()
await session.on_event(turn_ended)
# Should have 4 events total (2 per event: raw + transformed)
assert session._event_queue.qsize() == 4
# Check turn started transformation
await session._event_queue.get() # raw event
start_session_event = await session._event_queue.get()
assert isinstance(start_session_event, RealtimeAgentStartEvent)
assert start_session_event.agent == mock_agent
# Check turn ended transformation
await session._event_queue.get() # raw event
end_session_event = await session._event_queue.get()
assert isinstance(end_session_event, RealtimeAgentEndEvent)
assert end_session_event.agent == mock_agent
@pytest.mark.asyncio
async def test_transcription_completed_event_updates_history(self, mock_model, mock_agent):
"""Test that transcription completed events update history and emit events"""
session = RealtimeSession(
mock_model, mock_agent, None, run_config={"async_tool_calls": False}
)
# Set up initial history with an audio message
initial_item = UserMessageItem(
item_id="item_1", role="user", content=[InputAudio(transcript=None)]
)
session._history = [initial_item]
# Create transcription completed event
transcription_event = RealtimeModelInputAudioTranscriptionCompletedEvent(
item_id="item_1", transcript="Hello world"
)
await session.on_event(transcription_event)
# Check that history was updated
assert len(session._history) == 1
updated_item = session._history[0]
assert updated_item.content[0].transcript == "Hello world" # type: ignore
assert updated_item.status == "completed" # type: ignore
# Should have 2 events: raw + history updated
assert session._event_queue.qsize() == 2
await session._event_queue.get() # raw event
history_event = await session._event_queue.get()
assert isinstance(history_event, RealtimeHistoryUpdated)
assert len(history_event.history) == 1
@pytest.mark.asyncio
async def test_item_updated_event_adds_new_item(self, mock_model, mock_agent):
"""Test that item_updated events add new items to history"""
session = RealtimeSession(
mock_model,
mock_agent,
None,
run_config={"async_tool_calls": False},
)
new_item = AssistantMessageItem(
item_id="new_item", role="assistant", content=[AssistantText(text="Hello")]
)
item_updated_event = RealtimeModelItemUpdatedEvent(item=new_item)
await session.on_event(item_updated_event)
# Check that item was added to history
assert len(session._history) == 1
assert session._history[0] == new_item
# Should have 2 events: raw + history added
assert session._event_queue.qsize() == 2
await session._event_queue.get() # raw event
history_event = await session._event_queue.get()
assert isinstance(history_event, RealtimeHistoryAdded)
assert history_event.item == new_item
@pytest.mark.asyncio
async def test_item_updated_event_updates_existing_item(self, mock_model, mock_agent):
"""Test that item_updated events update existing items in history"""
session = RealtimeSession(
mock_model,
mock_agent,
None,
run_config={"async_tool_calls": False},
)
# Set up initial history
initial_item = AssistantMessageItem(
item_id="existing_item", role="assistant", content=[AssistantText(text="Initial")]
)
session._history = [initial_item]
# Create updated version
updated_item = AssistantMessageItem(
item_id="existing_item", role="assistant", content=[AssistantText(text="Updated")]
)
item_updated_event = RealtimeModelItemUpdatedEvent(item=updated_item)
await session.on_event(item_updated_event)
# Check that item was updated
assert len(session._history) == 1
updated_item = cast(AssistantMessageItem, session._history[0])
assert updated_item.content[0].text == "Updated" # type: ignore
# Should have 2 events: raw + history updated (not added)
assert session._event_queue.qsize() == 2
await session._event_queue.get() # raw event
history_event = await session._event_queue.get()
assert isinstance(history_event, RealtimeHistoryUpdated)
@pytest.mark.asyncio
async def test_item_deleted_event_removes_item(self, mock_model, mock_agent):
"""Test that item_deleted events remove items from history"""
session = RealtimeSession(mock_model, mock_agent, None)
# Set up initial history with multiple items
item1 = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="First")]
)
item2 = AssistantMessageItem(
item_id="item_2", role="assistant", content=[AssistantText(text="Second")]
)
session._history = [item1, item2]
# Delete first item
delete_event = RealtimeModelItemDeletedEvent(item_id="item_1")
await session.on_event(delete_event)
# Check that item was removed
assert len(session._history) == 1
assert session._history[0].item_id == "item_2"
# Should have 2 events: raw + history updated
assert session._event_queue.qsize() == 2
await session._event_queue.get() # raw event
history_event = await session._event_queue.get()
assert isinstance(history_event, RealtimeHistoryUpdated)
assert len(history_event.history) == 1
@pytest.mark.asyncio
async def test_transcript_delta_updates_history_and_emits_history_updated(
self, mock_model, mock_agent
):
"""Test that transcript deltas keep high-level history subscribers in sync."""
session = RealtimeSession(mock_model, mock_agent, None)
transcript_event = RealtimeModelTranscriptDeltaEvent(
item_id="item_1", delta="hello", response_id="resp_1"
)
await session.on_event(transcript_event)
assert len(session._history) == 1
updated_item = cast(AssistantMessageItem, session._history[0])
assert updated_item.item_id == "item_1"
assert cast(AssistantAudio, updated_item.content[0]).transcript == "hello"
# Should have raw + high-level history_updated
assert session._event_queue.qsize() == 2
raw_event = await session._event_queue.get()
assert isinstance(raw_event, RealtimeRawModelEvent)
history_event = await session._event_queue.get()
assert isinstance(history_event, RealtimeHistoryUpdated)
updated_history_item = cast(AssistantMessageItem, history_event.history[0])
assert cast(AssistantAudio, updated_history_item.content[0]).transcript == "hello"
@pytest.mark.asyncio
async def test_ignored_events_only_generate_raw_events(self, mock_model, mock_agent):
"""Test that ignored events (connection_status, other) only generate raw events"""
session = RealtimeSession(mock_model, mock_agent, None)
# Test connection status (should be ignored)
connection_event = RealtimeModelConnectionStatusEvent(status="connected")
await session.on_event(connection_event)
# Test other event (should be ignored)
other_event = RealtimeModelOtherEvent(data={"custom": "data"})
await session.on_event(other_event)
# Should only have 2 raw events (no transformed events)
assert session._event_queue.qsize() == 2
for _ in range(2):
event = await session._event_queue.get()
assert isinstance(event, RealtimeRawModelEvent)
@pytest.mark.asyncio
async def test_function_call_event_triggers_tool_handling(self, mock_model, mock_agent):
"""Test that function_call events trigger tool call handling synchronously when disabled"""
session = RealtimeSession(
mock_model,
mock_agent,
None,
run_config={"async_tool_calls": False},
)
# Create function call event
function_call_event = RealtimeModelToolCallEvent(
name="test_function", call_id="call_123", arguments='{"param": "value"}'
)
# We'll test the detailed tool handling in a separate test class
# Here we just verify that it gets to the handler
with pytest.MonkeyPatch().context() as m:
handle_tool_call_mock = AsyncMock()
m.setattr(session, "_handle_tool_call", handle_tool_call_mock)
await session.on_event(function_call_event)
# Should have called the tool handler
handle_tool_call_mock.assert_called_once_with(
function_call_event, agent_snapshot=mock_agent
)
# Should still have raw event
assert session._event_queue.qsize() == 1
raw_event = await session._event_queue.get()
assert isinstance(raw_event, RealtimeRawModelEvent)
assert raw_event.data == function_call_event
@pytest.mark.asyncio
async def test_function_call_event_runs_async_by_default(self, mock_model, mock_agent):
"""Function call handling should be scheduled asynchronously by default"""
session = RealtimeSession(mock_model, mock_agent, None)
function_call_event = RealtimeModelToolCallEvent(
name="test_function",
call_id="call_async",
arguments='{"param": "value"}',
)
with pytest.MonkeyPatch().context() as m:
handle_tool_call_mock = AsyncMock()
m.setattr(session, "_handle_tool_call", handle_tool_call_mock)
await session.on_event(function_call_event)
# Let the background task run
await asyncio.sleep(0)
handle_tool_call_mock.assert_awaited_once_with(
function_call_event, agent_snapshot=mock_agent
)
# Raw event still enqueued
assert session._event_queue.qsize() == 1
raw_event = await session._event_queue.get()
assert isinstance(raw_event, RealtimeRawModelEvent)
assert raw_event.data == function_call_event
class TestHistoryManagement:
"""Test suite for history management and audio transcription in
RealtimeSession._get_new_history"""
def test_merge_transcript_into_existing_audio_message(self):
"""Test merging audio transcript into existing placeholder input_audio message"""
# Create initial history with audio message without transcript
initial_item = UserMessageItem(
item_id="item_1",
role="user",
content=[
InputText(text="Before audio"),
InputAudio(transcript=None, audio="audio_data"),
InputText(text="After audio"),
],
)
old_history = [initial_item]
# Create transcription completed event
transcription_event = RealtimeModelInputAudioTranscriptionCompletedEvent(
item_id="item_1", transcript="Hello world"
)
# Apply the history update
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), transcription_event
)
# Verify the transcript was merged
assert len(new_history) == 1
updated_item = cast(UserMessageItem, new_history[0])
assert updated_item.item_id == "item_1"
assert hasattr(updated_item, "status") and updated_item.status == "completed"
assert len(updated_item.content) == 3
# Check that audio content got transcript but other content unchanged
assert cast(InputText, updated_item.content[0]).text == "Before audio"
assert cast(InputAudio, updated_item.content[1]).transcript == "Hello world"
# Should preserve audio data
assert cast(InputAudio, updated_item.content[1]).audio == "audio_data"
assert cast(InputText, updated_item.content[2]).text == "After audio"
def test_merge_transcript_preserves_other_items(self):
"""Test that merging transcript preserves other items in history"""
# Create history with multiple items
item1 = UserMessageItem(
item_id="item_1", role="user", content=[InputText(text="First message")]
)
item2 = UserMessageItem(
item_id="item_2", role="user", content=[InputAudio(transcript=None)]
)
item3 = AssistantMessageItem(
item_id="item_3", role="assistant", content=[AssistantText(text="Third message")]
)
old_history = [item1, item2, item3]
# Create transcription event for item_2
transcription_event = RealtimeModelInputAudioTranscriptionCompletedEvent(
item_id="item_2", transcript="Transcribed audio"
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), transcription_event
)
# Should have same number of items
assert len(new_history) == 3
# First and third items should be unchanged
assert new_history[0] == item1
assert new_history[2] == item3
# Second item should have transcript
updated_item2 = cast(UserMessageItem, new_history[1])
assert updated_item2.item_id == "item_2"
assert cast(InputAudio, updated_item2.content[0]).transcript == "Transcribed audio"
assert hasattr(updated_item2, "status") and updated_item2.status == "completed"
def test_merge_transcript_only_affects_matching_audio_content(self):
"""Test that transcript merge only affects audio content, not text content"""
# Create item with mixed content including multiple audio items
item = UserMessageItem(
item_id="item_1",
role="user",
content=[
InputText(text="Text content"),
InputAudio(transcript=None, audio="audio1"),
InputAudio(transcript="existing", audio="audio2"),
InputText(text="More text"),
],
)
old_history = [item]
transcription_event = RealtimeModelInputAudioTranscriptionCompletedEvent(
item_id="item_1", transcript="New transcript"
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), transcription_event
)
updated_item = cast(UserMessageItem, new_history[0])
# Text content should be unchanged
assert cast(InputText, updated_item.content[0]).text == "Text content"
assert cast(InputText, updated_item.content[3]).text == "More text"
# All audio content should have the new transcript (current implementation overwrites all)
assert cast(InputAudio, updated_item.content[1]).transcript == "New transcript"
assert (
cast(InputAudio, updated_item.content[2]).transcript == "New transcript"
) # Implementation overwrites existing
def test_update_existing_item_by_id(self):
"""Test updating an existing item by item_id"""
# Create initial history
original_item = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="Original")]
)
old_history = [original_item]
# Create updated version of same item
updated_item = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="Updated")]
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), updated_item
)
# Should have same number of items
assert len(new_history) == 1
# Item should be updated
result_item = cast(AssistantMessageItem, new_history[0])
assert result_item.item_id == "item_1"
assert result_item.content[0].text == "Updated" # type: ignore
def test_update_existing_item_preserves_order(self):
"""Test that updating existing item preserves its position in history"""
# Create history with multiple items
item1 = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="First")]
)
item2 = AssistantMessageItem(
item_id="item_2", role="assistant", content=[AssistantText(text="Second")]
)
item3 = AssistantMessageItem(
item_id="item_3", role="assistant", content=[AssistantText(text="Third")]
)
old_history = [item1, item2, item3]
# Update middle item
updated_item2 = AssistantMessageItem(
item_id="item_2", role="assistant", content=[AssistantText(text="Updated Second")]
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), updated_item2
)
# Should have same number of items in same order
assert len(new_history) == 3
assert new_history[0].item_id == "item_1"
assert new_history[1].item_id == "item_2"
assert new_history[2].item_id == "item_3"
# Middle item should be updated
updated_result = cast(AssistantMessageItem, new_history[1])
assert updated_result.content[0].text == "Updated Second" # type: ignore
# Other items should be unchanged
item1_result = cast(AssistantMessageItem, new_history[0])
item3_result = cast(AssistantMessageItem, new_history[2])
assert item1_result.content[0].text == "First" # type: ignore
assert item3_result.content[0].text == "Third" # type: ignore
def test_insert_new_item_after_previous_item(self):
"""Test inserting new item after specified previous_item_id"""
# Create initial history
item1 = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="First")]
)
item3 = AssistantMessageItem(
item_id="item_3", role="assistant", content=[AssistantText(text="Third")]
)
old_history = [item1, item3]
# Create new item to insert between them
new_item = AssistantMessageItem(
item_id="item_2",
previous_item_id="item_1",
role="assistant",
content=[AssistantText(text="Second")],
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), new_item
)
# Should have one more item
assert len(new_history) == 3
# Items should be in correct order
assert new_history[0].item_id == "item_1"
assert new_history[1].item_id == "item_2"
assert new_history[2].item_id == "item_3"
# Content should be correct
item2_result = cast(AssistantMessageItem, new_history[1])
assert item2_result.content[0].text == "Second" # type: ignore
def test_insert_new_item_after_nonexistent_previous_item(self):
"""Test that item with nonexistent previous_item_id gets added to end"""
# Create initial history
item1 = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="First")]
)
old_history = [item1]
# Create new item with nonexistent previous_item_id
new_item = AssistantMessageItem(
item_id="item_2",
previous_item_id="nonexistent",
role="assistant",
content=[AssistantText(text="Second")],
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), new_item
)
# Should add to end when previous_item_id not found
assert len(new_history) == 2
assert new_history[0].item_id == "item_1"
assert new_history[1].item_id == "item_2"
def test_add_new_item_to_end_when_no_previous_item_id(self):
"""Test adding new item to end when no previous_item_id is specified"""
# Create initial history
item1 = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="First")]
)
old_history = [item1]
# Create new item without previous_item_id
new_item = AssistantMessageItem(
item_id="item_2", role="assistant", content=[AssistantText(text="Second")]
)
new_history = RealtimeSession._get_new_history(
cast(list[RealtimeItem], old_history), new_item
)
# Should add to end
assert len(new_history) == 2
assert new_history[0].item_id == "item_1"
assert new_history[1].item_id == "item_2"
def test_add_first_item_to_empty_history(self):
"""Test adding first item to empty history"""
old_history: list[RealtimeItem] = []
new_item = AssistantMessageItem(
item_id="item_1", role="assistant", content=[AssistantText(text="First")]
)
new_history = RealtimeSession._get_new_history(old_history, new_item)
assert len(new_history) == 1
assert new_history[0].item_id == "item_1"
def test_complex_insertion_scenario(self):
"""Test complex scenario with multiple insertions and updates"""
# Start with items A and C
itemA = AssistantMessageItem(
item_id="A", role="assistant", content=[AssistantText(text="A")]
)
itemC = AssistantMessageItem(
item_id="C", role="assistant", content=[AssistantText(text="C")]
)
history: list[RealtimeItem] = [itemA, itemC]
# Insert B after A
itemB = AssistantMessageItem(
item_id="B", previous_item_id="A", role="assistant", content=[AssistantText(text="B")]
)
history = RealtimeSession._get_new_history(history, itemB)
# Should be A, B, C
assert len(history) == 3
assert [item.item_id for item in history] == ["A", "B", "C"]
# Insert D after B
itemD = AssistantMessageItem(
item_id="D", previous_item_id="B", role="assistant", content=[AssistantText(text="D")]
)
history = RealtimeSession._get_new_history(history, itemD)
# Should be A, B, D, C
assert len(history) == 4
assert [item.item_id for item in history] == ["A", "B", "D", "C"]
# Update B
updated_itemB = AssistantMessageItem(
item_id="B", role="assistant", content=[AssistantText(text="Updated B")]
)
history = RealtimeSession._get_new_history(history, updated_itemB)
# Should still be A, B, D, C but B is updated
assert len(history) == 4
assert [item.item_id for item in history] == ["A", "B", "D", "C"]
itemB_result = cast(AssistantMessageItem, history[1])
assert itemB_result.content[0].text == "Updated B" # type: ignore
# Test 3: Tool call execution flow (_handle_tool_call method)
class TestToolCallExecution:
"""Test suite for tool call execution flow in RealtimeSession._handle_tool_call"""
@pytest.mark.asyncio
async def test_function_tool_execution_success(
self, mock_model, mock_agent, mock_function_tool