From 8c128edb5d3790096376c086f9fa1027f6344e08 Mon Sep 17 00:00:00 2001
From: Chesars <cesarponce19544@gmail.com>
Date: Wed, 26 Nov 2025 17:05:40 -0300
Subject: [PATCH] test: add unit tests for BaseModelResponseIterator empty SSE
 line filtering

Tests verify that empty lines between SSE events are properly filtered
and don't produce extra empty chunks in streaming responses.
---
 .../llms/base_llm/test_base_model_iterator.py | 117 ++++++++++++++++++
 1 file changed, 117 insertions(+)
 create mode 100644 tests/test_litellm/llms/base_llm/test_base_model_iterator.py

diff --git a/tests/test_litellm/llms/base_llm/test_base_model_iterator.py b/tests/test_litellm/llms/base_llm/test_base_model_iterator.py
new file mode 100644
index 00000000000..d5166c4690e
--- /dev/null
+++ b/tests/test_litellm/llms/base_llm/test_base_model_iterator.py
@@ -0,0 +1,117 @@
+"""
+Tests for BaseModelResponseIterator - specifically testing that empty SSE lines are filtered
+"""
+
+import pytest
+from litellm.llms.base_llm.base_model_iterator import BaseModelResponseIterator
+from litellm.types.utils import GenericStreamingChunk, ModelResponseStream
+
+
+class TestBaseModelResponseIterator:
+    """Test cases for BaseModelResponseIterator empty line filtering"""
+
+    def test_filter_empty_sse_lines_sync(self):
+        """
+        Test that empty SSE lines (common between SSE events) are filtered out
+        and don't produce empty chunks.
+
+        This fixes the bug where providers using BaseLLMHTTPHandler (like xAI)
+        would return extra empty chunks when streaming with include_usage=True.
+
+        Related: GitHub Issue #17136
+        """
+        # Simulate SSE stream with empty lines between events (normal SSE format)
+        sse_lines = [
+            'data: {"id":"1","choices":[{"delta":{"content":"Hello"}}]}',
+            '',  # Empty line (SSE separator)
+            'data: {"id":"1","choices":[{"delta":{"content":" World"}}]}',
+            '',  # Empty line (SSE separator)
+            'data: {"id":"1","choices":[],"usage":{"prompt_tokens":10,"completion_tokens":5}}',
+            '',  # Empty line (SSE separator)
+            'data: [DONE]',
+            '',  # Empty line after DONE
+        ]
+
+        iterator = BaseModelResponseIterator(
+            streaming_response=iter(sse_lines),
+            sync_stream=True
+        )
+
+        chunks = list(iterator)
+
+        # Should have 4 chunks: 2 content + 1 usage + 1 DONE
+        # Empty lines should be filtered out
+        assert len(chunks) == 4, f"Expected 4 chunks, got {len(chunks)}"
+
+        # Verify no empty/None chunks were included
+        # The base iterator returns ModelResponseStream objects
+        for i, chunk in enumerate(chunks):
+            assert chunk is not None, f"Chunk {i} should not be None"
+
+    def test_filter_whitespace_only_lines_sync(self):
+        """Test that lines with only whitespace are also filtered"""
+        sse_lines = [
+            'data: {"id":"1","choices":[{"delta":{"content":"Hi"}}]}',
+            '   ',  # Whitespace only
+            '\t',   # Tab only
+            'data: [DONE]',
+        ]
+
+        iterator = BaseModelResponseIterator(
+            streaming_response=iter(sse_lines),
+            sync_stream=True
+        )
+
+        chunks = list(iterator)
+
+        # Should have 2 chunks: 1 content + 1 DONE
+        assert len(chunks) == 2, f"Expected 2 chunks, got {len(chunks)}"
+
+    def test_valid_chunks_not_filtered_sync(self):
+        """Test that valid data chunks are not filtered"""
+        sse_lines = [
+            'data: {"id":"1","choices":[{"delta":{"content":"A"}}]}',
+            'data: {"id":"1","choices":[{"delta":{"content":"B"}}]}',
+            'data: {"id":"1","choices":[{"delta":{"content":"C"}}]}',
+            'data: [DONE]',
+        ]
+
+        iterator = BaseModelResponseIterator(
+            streaming_response=iter(sse_lines),
+            sync_stream=True
+        )
+
+        chunks = list(iterator)
+
+        # All 4 chunks should be present
+        assert len(chunks) == 4, f"Expected 4 chunks, got {len(chunks)}"
+
+
+@pytest.mark.asyncio
+async def test_filter_empty_sse_lines_async():
+    """
+    Test async version: empty SSE lines should be filtered out
+    """
+    async def async_sse_generator():
+        lines = [
+            'data: {"id":"1","choices":[{"delta":{"content":"Hello"}}]}',
+            '',  # Empty line
+            'data: {"id":"1","choices":[{"delta":{"content":" World"}}]}',
+            '',  # Empty line
+            'data: [DONE]',
+            '',  # Empty line
+        ]
+        for line in lines:
+            yield line
+
+    iterator = BaseModelResponseIterator(
+        streaming_response=async_sse_generator(),
+        sync_stream=False
+    )
+
+    chunks = []
+    async for chunk in iterator:
+        chunks.append(chunk)
+
+    # Should have 3 chunks: 2 content + 1 DONE
+    assert len(chunks) == 3, f"Expected 3 chunks, got {len(chunks)}"