Skip to content

Commit 8a9ee27

Browse files
authored
fix(http): accept CR line endings in SSE streams (#198)
Co-authored-by: Elon-Jiang <191222665+Elon-Jiang@users.noreply.github.com>
1 parent 4fed584 commit 8a9ee27

2 files changed

Lines changed: 66 additions & 1 deletion

File tree

‎src/acp/_sse.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,16 @@ async def parse_sse_stream(
7676
decoder = codecs.getincrementaldecoder("utf-8")()
7777
buffer = ""
7878
data_lines: list[str] = []
79+
skip_lf = False
7980

8081
async for chunk in chunks:
81-
buffer += decoder.decode(chunk)
82+
text = decoder.decode(chunk)
83+
if not text:
84+
continue
85+
if skip_lf and text.startswith("\n"):
86+
text = text[1:]
87+
skip_lf = text.endswith("\r")
88+
buffer += text.replace("\r\n", "\n").replace("\r", "\n")
8289
while "\n" in buffer:
8390
line, buffer = buffer.split("\n", 1)
8491
line = line.rstrip("\r")

‎tests/http/test_http_client.py‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,3 +288,61 @@ async def test_load_opens_session_stream_from_request_id(result: Any) -> None:
288288
finally:
289289
await transport.close()
290290
await client.aclose()
291+
292+
293+
@pytest.mark.parametrize("line_ending", ["\n", "\r\n", "\r"])
294+
@pytest.mark.asyncio
295+
async def test_connection_sse_accepts_standard_line_endings(line_ending: str) -> None:
296+
"""A complete event is delivered while its connection remains open."""
297+
server = FakeServer()
298+
transport, client = _make_transport(server)
299+
message = {"jsonrpc": "2.0", "method": "_test/update", "params": {"text": "ready"}}
300+
try:
301+
await transport.send({"jsonrpc": "2.0", "id": 0, "method": "initialize", "params": {}})
302+
await asyncio.wait_for(transport.receive(), timeout=1)
303+
data = json.dumps(message)
304+
server.conn_stream.put_nowait(f"data: {data}{line_ending}{line_ending}".encode())
305+
assert await asyncio.wait_for(transport.receive(), timeout=1) == message
306+
finally:
307+
await transport.close()
308+
await client.aclose()
309+
310+
311+
@pytest.mark.parametrize("layout", ["cr", "crlf-split", "mixed", "bytewise"])
312+
@pytest.mark.asyncio
313+
async def test_connection_sse_preserves_split_and_multiline_events(layout: str) -> None:
314+
"""CRLF split across reads is one ending, including before a second data field."""
315+
server = FakeServer()
316+
transport, client = _make_transport(server)
317+
first = {"jsonrpc": "2.0", "method": "_test/update", "params": {"text": "\u4e2d\u6587\u0085\u2028"}}
318+
second = {"jsonrpc": "2.0", "method": "_test/done"}
319+
head = 'data: {"jsonrpc":"2.0",'
320+
tail = 'data: "method":"_test/update","params":{"text":"\u4e2d\u6587\u0085\u2028"}}'
321+
last = "data: " + json.dumps(second)
322+
if layout == "cr":
323+
chunks = [(head + "\r" + tail + "\r\r" + last + "\r\r").encode()]
324+
elif layout == "crlf-split":
325+
chunks = [
326+
(head + "\r").encode(),
327+
b"",
328+
("\n" + tail + "\r").encode(),
329+
b"\n\r",
330+
("\n" + last + "\r").encode(),
331+
b"\n\r",
332+
b"\n",
333+
]
334+
elif layout == "mixed":
335+
chunks = [(head + "\r" + tail + "\n\r\n" + last + "\r\r").encode()]
336+
else:
337+
data = (head + "\r\n" + tail + "\r\r" + last + "\n\n").encode()
338+
chunks = [data[index : index + 1] for index in range(len(data))]
339+
try:
340+
await transport.send({"jsonrpc": "2.0", "id": 0, "method": "initialize", "params": {}})
341+
await asyncio.wait_for(transport.receive(), timeout=1)
342+
for chunk in chunks:
343+
server.conn_stream.put_nowait(chunk)
344+
assert await asyncio.wait_for(transport.receive(), timeout=1) == first
345+
assert await asyncio.wait_for(transport.receive(), timeout=1) == second
346+
finally:
347+
await transport.close()
348+
await client.aclose()

0 commit comments

Comments
 (0)