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
|
# pylint: disable=line-too-long,useless-suppression
from typing import AsyncIterator, List
from unittest.mock import AsyncMock, patch
import pytest
import os
from azure.ai.agents.models import (
AsyncAgentEventHandler,
BaseAsyncAgentEventHandler,
SubmitToolOutputsAction,
ThreadRun,
)
from azure.ai.agents.models import AgentStreamEvent
def read_file(file_name: str) -> str:
with open(os.path.join(os.path.dirname(__file__), "assets", f"{file_name}.txt"), "r") as file:
return file.read()
main_stream_response = read_file("main_stream_response")
fetch_current_datetime_and_weather_stream_response = read_file("fetch_current_datetime_and_weather_stream_response")
send_email_stream_response = read_file("send_email_stream_response")
async def convert_to_byte_iterator(input: str) -> AsyncIterator[bytes]:
yield input.encode()
async def async_bytes_iter(iterable: List[bytes]) -> AsyncIterator[bytes]:
for item in iterable:
yield item
class TestBaseAsyncAgentEventHandler:
class MyAgentEventhHandler(BaseAsyncAgentEventHandler[str]):
async def _process_event(self, event_data_str: str) -> str:
return event_data_str
async def break_main_stream_response(self, indices: List[int], response: str):
previous_index = 0
for index in indices:
yield response[previous_index:index].encode()
previous_index = index
yield response[previous_index:].encode()
async def mock_callable(self, _: ThreadRun, __: BaseAsyncAgentEventHandler[str]) -> None:
pass
@pytest.mark.asyncio
async def test_event_handler_process_response_when_break_around_event_separators(self):
# events are split into multiple chunks.
# Each chunk might contains more than one or incomplete response.
# Test the chunks are borken around the event separators which are "\n\n"
handler = self.MyAgentEventhHandler()
new_line_indices = [i for i in range(len(main_stream_response)) if main_stream_response.startswith("\n\n", i)]
indices_around_new_lines = [i + offset for i, offset in zip(new_line_indices, [0, -1, 1, 2, 3, 4, 5])]
handler.initialize(
self.break_main_stream_response(indices_around_new_lines, main_stream_response), self.mock_callable
)
count = 0
all_event_str: List[str] = []
async for event_str in handler:
assert event_str.startswith("event:")
all_event_str.append(event_str)
count += 1
assert count == main_stream_response.count("event:")
assert all_event_str[-1].startswith("event: done")
@pytest.mark.asyncio
async def test_event_handler_process_response_when_break_at_the_start(self):
handler = self.MyAgentEventhHandler()
handler.initialize(
# the numbers of the index around the new line characters, middle of the event, or at the end
self.break_main_stream_response([2], main_stream_response),
self.mock_callable,
)
count = 0
all_event_str: List[str] = []
async for event_str in handler:
assert event_str.startswith("event:")
all_event_str.append(event_str)
count += 1
assert count == main_stream_response.count("event:")
assert all_event_str[-1].startswith("event: done")
@pytest.mark.asyncio
async def test_event_handler_process_response_when_break_at_the_end(self):
handler = self.MyAgentEventhHandler()
response_len = len(main_stream_response)
indices_around_new_lines = list(range(response_len - 5, response_len + 1))
handler.initialize(
# the numbers of the index around the new line characters, middle of the event, or at the end
self.break_main_stream_response(indices_around_new_lines, main_stream_response),
self.mock_callable,
)
count = 0
all_event_str: List[str] = []
async for event_str in handler:
assert event_str.startswith("event:")
all_event_str.append(event_str)
count += 1
assert count == main_stream_response.count("event:")
assert all_event_str[-1].startswith("event: done")
@pytest.mark.asyncio
async def test_event_handler_chain_responses(self):
# Test if the event handler can have the second stream followed by the first one.
handler = self.MyAgentEventhHandler()
handler.initialize(convert_to_byte_iterator(main_stream_response), self.mock_callable)
handler.initialize(
convert_to_byte_iterator(fetch_current_datetime_and_weather_stream_response), self.mock_callable
)
count = 0
all_event_str: List[str] = []
async for event_str in handler:
assert event_str.startswith("event:")
all_event_str.append(event_str)
count += 1
assert count == main_stream_response.count("event:") + fetch_current_datetime_and_weather_stream_response.count(
"event:"
)
assert all_event_str[-1].startswith("event: done")
@pytest.mark.asyncio
async def test_event_handler_reusable(self):
# Test if the event handler can be reused after a stream is done.
handler = self.MyAgentEventhHandler()
handler.initialize(convert_to_byte_iterator(main_stream_response), self.mock_callable)
count = 0
all_event_str: List[str] = []
async for event_str in handler:
assert event_str.startswith("event:")
handler.initialize(
convert_to_byte_iterator(fetch_current_datetime_and_weather_stream_response), self.mock_callable
)
async for event_str in handler:
assert event_str.startswith("event:")
all_event_str.append(event_str)
count += 1
assert fetch_current_datetime_and_weather_stream_response.count("event:")
assert all_event_str[-1].startswith("event: done")
@pytest.mark.asyncio
async def test_event_handler_with_split_chinese_char(self):
response_bytes_split_chinese_char: List[bytes] = [
b'event: thread.message.delta\ndata: data: {"id":"msg_01","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"\xe5',
b"\xa4",
b'\xa9"}}]}}\n\n',
b'event: thread.message.delta\ndata: data: {"id":"msg_02","object":"thread.message.delta","delta":{"content":[{"index":0,"type":"text","text":{"value":"."}}]}}}\n\nevent: done\ndata: [DONE]\n\n',
]
handler = self.MyAgentEventhHandler()
handler.initialize(
# the numbers of the index around the new line characters, middle of the event, or at the end
async_bytes_iter(response_bytes_split_chinese_char),
self.mock_callable,
)
count = 0
all_event_str: List[str] = []
async for event_str in handler:
assert event_str.startswith("event:")
all_event_str.append(event_str)
count += 1
assert count == 3
assert all_event_str[-1].startswith("event: done")
class TestAsyncAgentEventHandler:
deserializable_events = [
AgentStreamEvent.THREAD_CREATED.value,
AgentStreamEvent.ERROR.value,
AgentStreamEvent.DONE.value,
]
class MyAgentEventHandler(AsyncAgentEventHandler[None]):
pass
@pytest.mark.asyncio
@patch("azure.ai.agents.models._patch._parse_event")
async def test_tool_calls(self, mock_parse_event: AsyncMock):
# Test if the event type and status are met, submit function calls.
submit_tool_outputs = AsyncMock()
handler = self.MyAgentEventHandler()
handler.initialize(convert_to_byte_iterator("event\n\n"), submit_tool_outputs)
event_obj = ThreadRun({})
event_obj.status = "requires_action"
event_obj.required_action = SubmitToolOutputsAction({})
mock_parse_event.return_value = ("", event_obj)
async for _ in handler:
await handler.until_done()
assert mock_parse_event.call_count == 1
assert mock_parse_event.call_args[0][0] == "event"
assert submit_tool_outputs.call_count == 1
assert submit_tool_outputs.call_args[0] == (event_obj, handler, True)
@pytest.mark.asyncio
@patch("azure.ai.agents.models._patch.AsyncAgentEventHandler.on_unhandled_event")
@pytest.mark.parametrize("event_type", [e.value for e in AgentStreamEvent])
async def test_parse_event(self, mock_on_unhandled_event: AsyncMock, event_type: str):
# Make sure all the event types defined in AgentStreamEvent are deserializable except Created, Done, and Error
# And ensure handle_event is never raised.
handler = self.MyAgentEventHandler()
event_data_str = f"event: {event_type}\ndata: {{}}"
_, event_obj, _ = await handler._process_event(event_data_str)
if event_type in self.deserializable_events:
assert isinstance(event_obj, str)
else:
assert not isinstance(event_obj, str)
# The only event we are not handling today is CREATED which is never sent by backend.
if event_type == AgentStreamEvent.THREAD_CREATED.value:
assert mock_on_unhandled_event.call_count == 1
else:
assert mock_on_unhandled_event.call_count == 0
|
