Skip to content

Commit b910ce5

Browse files
authored
Extract SSE byte buffer policy (#1979)
## Description Extracts the pure SSE byte-buffer parser from `helpers.py` into `headroom.proxy.sse_byte_buffer_policy`. Existing helper imports remain as delegates, while the protocol parser now has its own module and direct tests. Closes # ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [x] Code refactoring (no functional changes) ## Changes Made - Added `sse_byte_buffer_policy.py` for SSE terminator detection and complete-event parsing. - Kept `helpers.parse_sse_events_from_byte_buffer` and `_find_sse_event_terminator` delegating to the extracted policy. - Added direct policy tests for LF/CRLF terminators, buffer draining, split UTF-8 preservation, and invalid complete UTF-8 events. - Carried forward the LiteLLM callback compatibility shim needed for current mypy on `main`. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [ ] Manual testing performed ### Test Output ```text python -m pytest tests\test_sse_byte_buffer_policy.py tests\test_sse_utf8_split.py 8 passed in 0.23s python -m ruff check . All checks passed! python -m ruff format --check . 1095 files already formatted python -m mypy headroom --ignore-missing-imports Success: no issues found in 409 source files gitleaks protect --staged --no-banner --redact no leaks found ``` ## Real Behavior Proof - Environment: Windows, Python 3.13.13, branch `jd/architecture-slice-29`. - Exact command / steps: ran new SSE byte-buffer policy tests, existing SSE UTF-8 split tests, ruff, ruff format check, mypy, and staged gitleaks scan. - Observed result: SSE parser behavior remains covered and local lint/type/security checks pass. - Not tested: live streaming proxy runtime; existing helper imports remain intact. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A ## Additional Notes Documentation and changelog updates are N/A for this internal architecture-only refactor. The push reported existing default-branch Dependabot alerts; no staged secret leaks were found for this PR.
1 parent 984a2c7 commit b910ce5

3 files changed

Lines changed: 97 additions & 43 deletions

File tree

headroom/proxy/helpers.py

Lines changed: 4 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
from headroom import paths as _paths
2626
from headroom._subprocess import run
27-
from headroom.proxy import request_limit_policy, wire_debug_redaction_policy
27+
from headroom.proxy import request_limit_policy, sse_byte_buffer_policy, wire_debug_redaction_policy
2828
from headroom.proxy.body_forwarding import (
2929
BodyMutationTracker as BodyMutationTracker, # noqa: F401 - compatibility export
3030
)
@@ -533,22 +533,12 @@ def get_body_too_large_status() -> int:
533533
)
534534

535535

536-
# SSE byte-buffer helper supports LF and CRLF event separators. Per the SSE
537-
# spec the default event name is "message"; we return ``None`` so callers can
538-
# decide whether to apply that default.
539-
_SSE_EVENT_TERMINATORS = (b"\n\n", b"\r\n\r\n")
536+
_SSE_EVENT_TERMINATORS = sse_byte_buffer_policy.SSE_EVENT_TERMINATORS
540537

541538

542539
def _find_sse_event_terminator(buf: bytearray) -> tuple[int, int] | None:
543540
"""Return the earliest complete SSE event terminator in ``buf``."""
544-
matches = [
545-
(idx, len(terminator))
546-
for terminator in _SSE_EVENT_TERMINATORS
547-
if (idx := buf.find(terminator)) != -1
548-
]
549-
if not matches:
550-
return None
551-
return min(matches, key=lambda match: match[0])
541+
return sse_byte_buffer_policy.find_sse_event_terminator(buf)
552542

553543

554544
_SSE_EVENT_LINE_PREFIX = b"event:"
@@ -595,36 +585,7 @@ def parse_sse_events_from_byte_buffer(
595585
``decode("utf-8", errors="ignore")`` on a partial buffer; UTF-8
596586
multi-byte characters split across TCP reads will corrupt content.
597587
"""
598-
events: list[tuple[str | None, str]] = []
599-
while True:
600-
terminator_match = _find_sse_event_terminator(buf)
601-
if terminator_match is None:
602-
break
603-
idx, terminator_len = terminator_match
604-
event_bytes = bytes(buf[:idx])
605-
# Drain the event + the trailing terminator from the buffer.
606-
del buf[: idx + terminator_len]
607-
# Decoding the COMPLETE event must succeed. If it doesn't, the
608-
# upstream emitted invalid UTF-8 mid-stream — surface loudly.
609-
event_text = event_bytes.decode("utf-8")
610-
event_name: str | None = None
611-
data_lines: list[str] = []
612-
for line in event_text.splitlines():
613-
if not line:
614-
continue
615-
# SSE comment line — ignored per spec.
616-
if line.startswith(":"):
617-
continue
618-
if line.startswith("event:"):
619-
event_name = line[len("event:") :].lstrip()
620-
elif line.startswith("data:"):
621-
data_lines.append(line[len("data:") :].lstrip())
622-
# Per SSE spec, multiple `data:` lines join with newline. We
623-
# preserve that here even though OpenAI/Anthropic emit one
624-
# `data:` per event.
625-
if data_lines:
626-
events.append((event_name, "\n".join(data_lines)))
627-
return events
588+
return sse_byte_buffer_policy.parse_sse_events_from_byte_buffer(buf)
628589

629590

630591
# Maximum message array length (prevents DoS from deeply nested payloads)
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
"""Pure SSE byte-buffer parsing policy."""
2+
3+
from __future__ import annotations
4+
5+
# SSE byte-buffer helper supports LF and CRLF event separators. Per the SSE
6+
# spec the default event name is "message"; we return ``None`` so callers can
7+
# decide whether to apply that default.
8+
SSE_EVENT_TERMINATORS = (b"\n\n", b"\r\n\r\n")
9+
SSE_EVENT_LINE_PREFIX = "event:"
10+
SSE_DATA_LINE_PREFIX = "data:"
11+
12+
13+
def find_sse_event_terminator(buf: bytearray) -> tuple[int, int] | None:
14+
"""Return the earliest complete SSE event terminator in ``buf``."""
15+
matches = [
16+
(idx, len(terminator))
17+
for terminator in SSE_EVENT_TERMINATORS
18+
if (idx := buf.find(terminator)) != -1
19+
]
20+
if not matches:
21+
return None
22+
return min(matches, key=lambda match: match[0])
23+
24+
25+
def parse_sse_events_from_byte_buffer(
26+
buf: bytearray,
27+
) -> list[tuple[str | None, str]]:
28+
"""Drain complete ``event:`` + ``data:`` events from a bytes buffer.
29+
30+
Returns list of ``(event_name, data_str)`` tuples for complete events.
31+
Mutates ``buf`` in-place to leave only partial-event tail bytes.
32+
33+
Operates on bytes; only decodes complete events as UTF-8 (raises if a
34+
*complete* event has invalid UTF-8, which is an upstream protocol bug).
35+
"""
36+
events: list[tuple[str | None, str]] = []
37+
while True:
38+
terminator_match = find_sse_event_terminator(buf)
39+
if terminator_match is None:
40+
break
41+
idx, terminator_len = terminator_match
42+
event_bytes = bytes(buf[:idx])
43+
del buf[: idx + terminator_len]
44+
45+
event_text = event_bytes.decode("utf-8")
46+
event_name: str | None = None
47+
data_lines: list[str] = []
48+
for line in event_text.splitlines():
49+
if not line:
50+
continue
51+
if line.startswith(":"):
52+
continue
53+
if line.startswith(SSE_EVENT_LINE_PREFIX):
54+
event_name = line[len(SSE_EVENT_LINE_PREFIX) :].lstrip()
55+
elif line.startswith(SSE_DATA_LINE_PREFIX):
56+
data_lines.append(line[len(SSE_DATA_LINE_PREFIX) :].lstrip())
57+
58+
if data_lines:
59+
events.append((event_name, "\n".join(data_lines)))
60+
return events
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
from __future__ import annotations
2+
3+
import pytest
4+
5+
from headroom.proxy.sse_byte_buffer_policy import (
6+
find_sse_event_terminator,
7+
parse_sse_events_from_byte_buffer,
8+
)
9+
10+
11+
def test_find_sse_event_terminator_returns_earliest_separator() -> None:
12+
assert find_sse_event_terminator(bytearray(b"data: one\r\n\r\ndata: two\n\n")) == (9, 4)
13+
14+
15+
def test_parse_sse_events_drains_complete_events_and_leaves_tail() -> None:
16+
buf = bytearray(b": ignored\nevent: delta\ndata: one\ndata: two\n\npartial")
17+
18+
assert parse_sse_events_from_byte_buffer(buf) == [("delta", "one\ntwo")]
19+
assert bytes(buf) == b"partial"
20+
21+
22+
def test_parse_sse_events_preserves_split_utf8_tail() -> None:
23+
smile = "\U0001f642".encode()
24+
buf = bytearray(b"data: hello " + smile[:2])
25+
26+
assert parse_sse_events_from_byte_buffer(buf) == []
27+
buf.extend(smile[2:] + b"\n\n")
28+
assert parse_sse_events_from_byte_buffer(buf) == [(None, "hello \U0001f642")]
29+
30+
31+
def test_parse_sse_events_raises_on_complete_invalid_utf8_event() -> None:
32+
with pytest.raises(UnicodeDecodeError):
33+
parse_sse_events_from_byte_buffer(bytearray(b"data: \xff\n\n"))

0 commit comments

Comments
 (0)