From 582606f176f5467deb96bb949e0879a8e18f31dd Mon Sep 17 00:00:00 2001
From: kshitij <82637225+kshitijk4poor@users.noreply.github.com>
Date: Sun, 2 Aug 2026 11:46:40 +0530
Subject: [PATCH] test(tts): reconcile test file with main and add regression
 tests

Start from main's 13 tests (renamed test_openai_available_reflects_key
to test_openai_available_reflects_audio_key_resolution, added 4 new
tests for xai oauth, elevenlabs secret resolver, openai configured
key, stream cap). Append 12 new regression tests from PR #71084 for
the prefetch pipeline, PCM misalignment, and PortAudio resilience.
Patch platform.system in stream-path tests for main's macOS guard.
---
 tests/tools/test_tts_streaming.py | 571 ++++++++++++++++++++++++++++++
 1 file changed, 571 insertions(+)

diff --git a/tests/tools/test_tts_streaming.py b/tests/tools/test_tts_streaming.py
index 9b9631f7eab0c..ed9da09a074cd 100644
--- a/tests/tools/test_tts_streaming.py
+++ b/tests/tools/test_tts_streaming.py
@@ -221,3 +221,574 @@ def test_stream_cap_truncates_runaway_upstream(monkeypatch):
     out = list(ts._capped(_endless(), "test"))
     assert len(out) == 1  # 64 ok, 128 > cap → stop
     assert sum(len(c) for c in out) <= 100
+
+
+# ── Dispatch: chunked streamer path (regression tests) ───────────────────
+
+
+def test_streamer_path_handles_misaligned_pcm_chunks(monkeypatch):
+    """Regression: PCM chunks with odd byte counts must not be dropped.
+
+    OpenAI's streaming PCM API yields HTTP chunks on arbitrary byte
+    boundaries that are not aligned to the int16 frame width (2 bytes).
+    The old code called numpy.frombuffer directly on each chunk, which
+    raised "buffer size must be a multiple of element size" on any
+    odd-length chunk and silently dropped it — producing scattered
+    audio fragments. The fix carries leftover bytes into the next chunk.
+    """
+    from tools import tts_tool
+
+    class _OddChunkProvider(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            # Deliberately yield chunks with odd byte counts so the
+            # int16 frame boundary falls between chunks.
+            yield b"\x01\x00\x02"       # 3 bytes — odd, would crash old code
+            yield b"\x00\x03\x00\x04"   # 4 bytes — even, old code OK
+            yield b"\x00\x05\x00"       # 3 bytes — odd, would crash old code
+
+    sd, out = _sd_mock()
+    q = _drain_queue(["A complete sentence for testing."])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_OddChunkProvider({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    # Every chunk must have been written — no drops from misalignment.
+    assert out.write.called, "expected PCM chunks written despite odd byte counts"
+    # Collect all bytes the output stream received across all write calls.
+    written_bytes = b""
+    for call_args in out.write.call_args_list:
+        arr = call_args[0][0]
+        written_bytes += arr.tobytes()
+    # The provider yielded 3 + 4 + 3 = 10 bytes total; all should arrive.
+    assert len(written_bytes) == 10, (
+        f"expected 10 bytes of PCM data, got {len(written_bytes)} — "
+        "misaligned chunks were likely dropped"
+    )
+    assert done.is_set()
+
+
+def test_streamer_path_survives_portaudio_write_error(monkeypatch):
+    """Regression: a transient PortAudio error on output_stream.write must
+    not kill the playback thread or hang the pipeline join.
+
+    PortAudio/Core Audio can raise errors mid-stream (e.g. PaErrorCode -9986
+    "Internal PortAudio error" on macOS device state changes).  The worker
+    must log and break, not crash — otherwise _playback_done never fires.
+    """
+    from tools import tts_tool
+
+    class _Fake(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            yield b"\x01\x00" * 50
+            yield b"\x02\x00" * 50
+
+    sd, out = _sd_mock()
+    out.write.side_effect = OSError("Internal PortAudio error [PaErrorCode -9986]")
+    q = _drain_queue(["A complete sentence for testing."])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Fake({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert out.write.called, "expected at least one write attempt"
+    assert done.is_set(), "done event must fire even after PortAudio error"
+
+
+def test_streamer_reinit_after_portaudio_error_plays_remaining_sentences(monkeypatch):
+    """Regression: after a PortAudio error the worker must reinit the stream
+    and continue playing remaining sentences instead of dropping them.
+
+    Simulates two sentences where the first triggers a PortAudio -9986 error
+    on write.  The mock sounddevice returns a *fresh* OutputStream on the
+    second call to ``OutputStream()`` (the reinit).  The second sentence must
+    be written to that fresh stream, proving the pipeline recovered.
+    """
+    from tools import tts_tool
+
+    class _Fake(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            yield b"\x01\x00" * 50
+            yield b"\x02\x00" * 50
+
+    # First OutputStream fails on write; second (reinit) succeeds.
+    sd = MagicMock()
+    broken_out = MagicMock()
+    fresh_out = MagicMock()
+    out_pool = [broken_out, fresh_out]
+    broken_out.write.side_effect = OSError(
+        "Internal PortAudio error [PaErrorCode -9986]"
+    )
+
+    def _make_stream(*args, **kwargs):
+        return out_pool.pop(0) if out_pool else MagicMock()
+
+    sd.OutputStream.side_effect = _make_stream
+
+    q = _drain_queue([
+        "First sentence triggers PortAudio error here. ",
+        "Second sentence must still play after reinit. ",
+    ])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Fake({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert broken_out.write.called, "first stream should have received a write"
+    assert fresh_out.write.called, (
+        "second (reinit) stream should have received writes for the "
+        "remaining sentence — proves the pipeline recovered"
+    )
+    assert done.is_set(), "done event must fire after recovery"
+
+
+def test_streamer_tempfile_fallback_after_reinit_exhausted(monkeypatch):
+    """Regression: after 3 failed reinits, remaining sentences must play
+    via the temp-file fallback, not be silently dropped.
+    """
+    from tools import tts_tool
+
+    class _Fake(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            yield b"\x01\x00" * 50
+
+    # Every OutputStream fails on write — reinit will keep failing.
+    sd = MagicMock()
+    out = MagicMock()
+    sd.OutputStream.return_value = out
+    out.write.side_effect = OSError(
+        "Internal PortAudio error [PaErrorCode -9986]"
+    )
+
+    # Patch play_audio_file so the tempfile fallback doesn't actually
+    # try to play audio — just count that it was called.
+    play_calls: list[str] = []
+
+    def _fake_play(path):
+        play_calls.append(path)
+
+    q = _drain_queue([
+        "First sentence triggers PortAudio error. ",
+        "Second sentence fails after first reinit. ",
+        "Third sentence fails after second reinit. ",
+        "Fourth sentence fails after third reinit. ",
+        "Fifth sentence plays via tempfile fallback. ",
+    ])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Fake({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"), \
+         patch("tools.voice_mode.play_audio_file", side_effect=_fake_play):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    # The stream was created 4 times: initial + 3 reinit attempts.
+    assert sd.OutputStream.call_count == 4, (
+        f"expected 4 OutputStream calls (initial + 3 reinits), "
+        f"got {sd.OutputStream.call_count}"
+    )
+    assert done.is_set(), "done event must fire even after reinit exhaustion"
+    assert len(play_calls) >= 1, (
+        "tempfile fallback should have been invoked for remaining "
+        "sentences after reinit exhaustion"
+    )
+
+
+
+# ── Dispatch: hybrid batch-prefetch path ──────────────────────────────────
+
+def test_hybrid_first_sentence_streamed_individually(monkeypatch):
+    """The first sentence must get its own stream() call for low TTFA."""
+    from tools import tts_tool
+
+    stream_calls: list[str] = []
+
+    class _Tracking(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            stream_calls.append(text)
+            yield b"\x00\x00" * 10
+
+    sd, out = _sd_mock()
+    q = _drain_queue(["This is the first complete sentence."])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Tracking({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert len(stream_calls) == 1, (
+        f"single sentence should trigger 1 stream() call, got {stream_calls}"
+    )
+    assert done.is_set()
+
+
+def test_hybrid_subsequent_sentences_prefetched_individually(monkeypatch):
+    """Every sentence should get its own stream() call — per-sentence
+    prefetch fires the HTTP request the moment each sentence completes,
+    eliminating inter-sentence gaps."""
+    from tools import tts_tool
+
+    stream_calls: list[str] = []
+
+    class _Tracking(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            stream_calls.append(text)
+            yield b"\x00\x00" * 10
+
+    sd, out = _sd_mock()
+    # Four sentences — each gets its own stream() call.
+    sentences = [
+        "This is the very first sentence here. ",
+        "This is the second complete sentence. ",
+        "This is the third complete sentence. ",
+        "This is the fourth complete sentence. ",
+    ]
+    q = _drain_queue(sentences)
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Tracking({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    # Exactly 4 calls: one per sentence.
+    assert len(stream_calls) == 4, (
+        f"expected 4 stream() calls (1 per sentence), "
+        f"got {len(stream_calls)}: {stream_calls}"
+    )
+    # Each call contains its corresponding sentence's text.
+    assert "first sentence" in stream_calls[0]
+    assert "second" in stream_calls[1].lower()
+    assert "third" in stream_calls[2].lower()
+    assert "fourth" in stream_calls[3].lower()
+    assert done.is_set()
+
+
+def test_hybrid_short_sentences_each_get_own_call(monkeypatch):
+    """Short sentences should each get their own stream() call — no batching,
+    no waiting for a threshold or end-of-text."""
+    from tools import tts_tool
+
+    stream_calls: list[str] = []
+
+    class _Tracking(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            stream_calls.append(text)
+            yield b"\x00\x00" * 10
+
+    sd, out = _sd_mock()
+    # Two short sentences — each gets its own stream() call.
+    q = _drain_queue([
+        "This is the first sentence. ",
+        "Short second one. ",
+    ])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Tracking({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert len(stream_calls) == 2, (
+        f"expected 2 stream() calls (1 per sentence), "
+        f"got {len(stream_calls)}: {stream_calls}"
+    )
+    assert "first" in stream_calls[0].lower()
+    assert "second" in stream_calls[1].lower()
+    assert done.is_set()
+
+
+def test_hybrid_done_event_waits_for_prefetch(monkeypatch):
+    """The done event must not fire until the prefetch thread has finished,
+    otherwise continuous voice mode could overlap turns."""
+    from tools import tts_tool
+
+    prefetch_done = threading.Event()
+
+    class _Blocking(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            # For the batch call (second stream() invocation), block until
+            # the test signals. The first call returns immediately.
+            yield b"\x00\x00" * 10
+            # Small delay to ensure the prefetch thread is running when
+            # the main loop hits end-of-text.
+            import time as _time
+            _time.sleep(0.3)
+            prefetch_done.set()
+
+    sd, out = _sd_mock()
+    sentences = [
+        "This is the first sentence here. ",
+        "This is the second sentence here. ",
+        "This is the third sentence here. ",
+    ]
+    q = _drain_queue(sentences)
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Blocking({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    # done.is_set() is true — but only after the prefetch joined.
+    assert done.is_set()
+    # The prefetch thread should have completed before done was set.
+    assert prefetch_done.is_set(), (
+        "done event fired before the prefetch thread finished — "
+        "this would cause audio overlap in continuous voice mode"
+    )
+
+
+def test_hybrid_single_sentence_still_works(monkeypatch):
+    """A single-sentence reply should stream immediately with no batch."""
+    from tools import tts_tool
+
+    stream_calls: list[str] = []
+
+    class _Tracking(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            stream_calls.append(text)
+            yield b"\x00\x00" * 10
+
+    sd, out = _sd_mock()
+    q = _drain_queue(["Just one complete sentence."])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Tracking({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert len(stream_calls) == 1, (
+        f"single sentence should trigger exactly 1 stream() call, got {stream_calls}"
+    )
+    assert done.is_set()
+
+
+def test_hybrid_playback_serialized_no_overlap(monkeypatch):
+    """Multiple batch flushes must not overlap on the output stream.
+
+    The playback lock serializes write calls so audio segments play in
+    order. We verify by tracking concurrent playback — at most one thread
+    should be inside _play_pcm_chunks at any time.
+    """
+    from tools import tts_tool
+
+    active_plays = [0]
+    max_concurrent = [0]
+    play_order: list[str] = []
+
+    class _Tracking(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            # Yield enough data to exercise the write loop.
+            for _ in range(5):
+                yield b"\x00\x00" * 20
+
+    sd = MagicMock()
+    out = MagicMock()
+
+    def _mock_write(_data):
+        active_plays[0] += 1
+        max_concurrent[0] = max(max_concurrent[0], active_plays[0])
+        # Track which batch is playing by the data pattern (not text,
+        # since we can't access it from the write callback).
+        play_order.append("play")
+        active_plays[0] -= 1
+
+    out.write.side_effect = _mock_write
+    sd.OutputStream.return_value = out
+
+    # Many sentences to force multiple batch flushes.
+    sentences = [f"This is sentence number {i} here. " for i in range(10)]
+    q = _drain_queue(sentences)
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Tracking({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert done.is_set()
+    assert max_concurrent[0] <= 1, (
+        f"playback threads overlapped: max concurrent writes = {max_concurrent[0]}"
+    )
+
+
+def test_hybrid_prefetch_fires_http_immediately(monkeypatch):
+    """The prefetch thread must start consuming the generator (firing the
+    HTTP request) the moment _enqueue_audio is called, NOT when the
+    playback worker gets to it.
+
+    We verify by recording the wall-clock time when stream() first yields
+    and asserting that the second call's first yield happens before the
+    first call's playback completes.
+    """
+    import time
+    from tools import tts_tool
+
+    stream_start_times: list[float] = []
+    playback_done_times: list[float] = []
+    block_first_playback = threading.Event()
+
+    class _BlockingFirst(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            stream_start_times.append(time.monotonic())
+            # First sentence: block until the test signals playback to proceed.
+            # This simulates a long audio segment still playing.
+            if len(stream_start_times) == 1:
+                block_first_playback.wait(timeout=5.0)
+            yield b"\x00\x00" * 10
+
+    sd, out = _sd_mock()
+    write_count = [0]
+
+    def _mock_write(_data):
+        write_count[0] += 1
+        if write_count[0] == 1:
+            # First write of first sentence — unblock so playback can finish.
+            block_first_playback.set()
+
+    out.write.side_effect = _mock_write
+
+    # Two sentences: first blocks, second should prefetch while first plays.
+    q = _drain_queue(["First sentence here. ", "Second sentence here. "])
+    stop, done = threading.Event(), threading.Event()
+
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_BlockingFirst({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done)
+
+    assert done.is_set()
+    assert len(stream_start_times) == 2, (
+        f"expected 2 stream() calls, got {len(stream_start_times)}"
+    )
+    # The second stream() call must have started (HTTP fired) while the
+    # first was still blocked/playing. Since the first blocks until
+    # playback starts, and the second is enqueued immediately after,
+    # the second's start time should be very close to the first's.
+    # We just assert both fired (the timing is inherently tested by the
+    # fact that block_first_playback was needed to unblock the first).
+    assert stream_start_times[1] > stream_start_times[0], (
+        "second stream() should start after the first"
+    )
+
+
+def test_display_callback_not_called_when_streaming_enabled(monkeypatch):
+    """When streaming is enabled, display_callback must NOT be passed to
+    the TTS consumer — the token stream already renders text. This
+    prevents duplicate rendering (fix #1).
+
+    This is a CLI-level test simulated at the tts_tool level: the key
+    invariant is that stream_tts_to_speaker with display_callback=None
+    still works correctly (no crash, no display).
+    """
+    from tools import tts_tool
+
+    class _Fake(ts.StreamingTTSProvider):
+        sample_rate = 24000
+
+        @staticmethod
+        def available():
+            return True
+
+        def stream(self, text):
+            yield b"\x00\x00" * 10
+
+    sd, out = _sd_mock()
+    q = _drain_queue(["A sentence for the no-callback path. "])
+    stop, done = threading.Event(), threading.Event()
+
+    # display_callback=None simulates the streaming_enabled=True case.
+    with patch("tools.tts_streaming.resolve_streaming_provider",
+               return_value=_Fake({}, {})), \
+         patch.object(tts_tool, "_import_sounddevice", return_value=sd), \
+         patch("platform.system", return_value="Linux"):
+        tts_tool.stream_tts_to_speaker(q, stop, done, display_callback=None)
+
+    assert done.is_set()
+    # No assertion on display — the point is no crash and done is set.