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
|
from typing import AsyncIterator, Iterator
import httpx
import pytest
from httpx_sse import EventSource
# NOTE: the 'whatwg_example*' test cases are inspired by:
# https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation # noqa: E501
def test_iter_sse_whatwg_example1() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"data: YH00\n"
yield b"data: +2\n"
yield b"data: 10\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 1
assert events[0].event == "message"
assert events[0].data == "YH00\n+2\n10"
assert events[0].id == ""
assert events[0].retry is None
def test_iter_sse_whatwg_example2() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b": test stream\n"
yield b"\n"
yield b"data: first event\n"
yield b"id: 1\n"
yield b"\n"
yield b"data: second event\n"
yield b"id\n"
yield b"\n"
yield b"data: third event\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 3
assert events[0].event == "message"
assert events[0].data == "first event"
assert events[0].id == "1"
assert events[0].retry is None
assert events[1].event == "message"
assert events[1].data == "second event"
assert events[1].id == ""
assert events[1].retry is None
assert events[2].event == "message"
assert events[2].data == " third event"
assert events[2].id == ""
assert events[2].retry is None
def test_iter_sse_whatwg_example3() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"data\n"
yield b"\n"
yield b"data\n"
yield b"data\n"
yield b"\n"
yield b"data:\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 2
assert events[0].event == "message"
assert events[0].data == ""
assert events[0].id == ""
assert events[0].retry is None
assert events[1].event == "message"
assert events[1].data == "\n"
assert events[1].id == ""
assert events[1].retry is None
def test_iter_sse_whatwg_example4() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"data:test\n"
yield b"\n"
yield b"data: test\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 2
assert events[0].event == "message"
assert events[0].data == "test"
assert events[0].id == ""
assert events[0].retry is None
assert events[1].event == "message"
assert events[1].data == "test"
assert events[1].id == ""
assert events[1].retry is None
def test_iter_sse_event() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"event: logline\n"
yield b"data: New user connected\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 1
assert events[0].event == "logline"
assert events[0].data == "New user connected"
assert events[0].id == ""
assert events[0].retry is None
def test_iter_sse_id_null() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"data: test\n"
yield b"id: 123\0\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 1
assert events[0].event == "message"
assert events[0].data == "test"
assert events[0].id == ""
assert events[0].retry is None
def test_iter_sse_id_retry() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"retry: 10000\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 1
assert events[0].event == "message"
assert events[0].data == ""
assert events[0].id == ""
assert events[0].retry == 10000
def test_iter_sse_id_retry_invalid() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"retry: 1667a\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 0
def test_iter_sse_unknown_field() -> None:
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
yield b"something: ignore\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 0
def test_unicode_line_separator_not_parsed_as_newline() -> None:
"""Test that Unicode line separator (U+2028) is not parsed as a newline.
The SSE spec only allows CR, LF, or CRLF as line separators.
Other Unicode newline characters should be preserved in the data.
See: https://github.com/florimondmanca/httpx-sse/issues/34
"""
class Body(httpx.SyncByteStream):
def __iter__(self) -> Iterator[bytes]:
# U+2028 is LINE SEPARATOR in UTF-8 encoding: \xe2\x80\xa8
yield b"event: message\n"
yield b'data: {"text":"Hello\xe2\x80\xa8World"}\n'
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=Body(),
)
events = list(EventSource(response).iter_sse())
assert len(events) == 1
assert events[0].event == "message"
# The line separator should be preserved in the data, not treated as a line break
assert events[0].data == '{"text":"Hello\u2028World"}'
assert events[0].id == ""
assert events[0].retry is None
@pytest.mark.asyncio
async def test_aiter_sse() -> None:
class AsyncBody(httpx.AsyncByteStream):
async def __aiter__(self) -> AsyncIterator[bytes]:
yield b"data: YH00\n"
yield b"data: +2\n"
yield b"data: 10\n"
yield b"\n"
response = httpx.Response(
200,
headers={"content-type": "text/event-stream"},
stream=AsyncBody(),
)
events = [sse async for sse in EventSource(response).aiter_sse()]
assert len(events) == 1
assert events[0].event == "message"
assert events[0].data == "YH00\n+2\n10"
assert events[0].id == ""
assert events[0].retry is None
|
