"""
Regression tests for #893 — cancel_stream() now preserves partial streamed
assistant content rather than discarding it.
Before this fix, clicking Stop Generation threw away all streamed text. The
session was saved with only a cancellation marker appended, so the user lost
whatever the agent had produced up to that point.
After this fix:
- Partial text is accumulated in STREAM_PARTIAL_TEXT[stream_id] via on_token()
- cancel_stream() reads that buffer, strips thinking markup, and persists it
as a '_partial: True' assistant message before the cancel marker
- _sanitize_messages_for_api() does NOT strip _partial messages, so the model
sees the partial content as prior context on the next turn
- The cancel marker itself keeps _error=True so the model does not see it
"""
import threading
import time
import pytest
import api.config as config
import api.streaming as streaming
from api.config import STREAM_PARTIAL_TEXT, STREAMS_LOCK
@pytest.fixture(autouse=True)
def _isolate_stream_state():
"""Isolate shared stream state between tests."""
STREAM_PARTIAL_TEXT.clear()
config.STREAMS.clear()
config.CANCEL_FLAGS.clear()
config.AGENT_INSTANCES.clear()
yield
STREAM_PARTIAL_TEXT.clear()
config.STREAMS.clear()
config.CANCEL_FLAGS.clear()
config.AGENT_INSTANCES.clear()
class TestStreamPartialTextAccumulation:
def test_stream_partial_text_initialized_on_stream_creation(self, tmp_path, monkeypatch):
"""STREAM_PARTIAL_TEXT[stream_id] starts empty when a stream is registered."""
import queue
sid = 'test_init_stream'
q = queue.Queue()
cancel_event = threading.Event()
with STREAMS_LOCK:
config.STREAMS[sid] = q
config.CANCEL_FLAGS[sid] = cancel_event
STREAM_PARTIAL_TEXT[sid] = ''
assert STREAM_PARTIAL_TEXT.get(sid) == ''
def test_stream_partial_text_cleaned_up_on_stream_end(self):
"""STREAM_PARTIAL_TEXT[stream_id] is removed when the stream dict is cleaned up."""
import queue
sid = 'test_cleanup_stream'
q = queue.Queue()
with STREAMS_LOCK:
config.STREAMS[sid] = q
STREAM_PARTIAL_TEXT[sid] = 'some partial text'
with STREAMS_LOCK:
config.STREAMS.pop(sid, None)
STREAM_PARTIAL_TEXT.pop(sid, None)
assert sid not in STREAM_PARTIAL_TEXT
class TestCancelStreamPreservesPartial:
def test_cancel_stream_saves_partial_text_to_session(self, tmp_path, monkeypatch):
"""cancel_stream() persists accumulated partial text as an assistant message."""
import queue
from api.models import Session
from api.streaming import cancel_stream
session_dir = tmp_path / 'sessions'
session_dir.mkdir()
import api.models as _models
monkeypatch.setattr(config, 'SESSION_DIR', session_dir)
monkeypatch.setattr(config, 'SESSION_INDEX_FILE', session_dir / '_index.json')
monkeypatch.setattr(_models, 'SESSION_DIR', session_dir)
monkeypatch.setattr(_models, 'SESSION_INDEX_FILE', session_dir / '_index.json')
config.SESSIONS.clear()
_models.SESSIONS.clear()
# Create a session and a fake running stream
s = Session(session_id='sess_partial', title='Test')
s.messages.append({'role': 'user', 'content': 'Tell me about Python'})
s.active_stream_id = 'stream_partial'
s.save()
config.SESSIONS['sess_partial'] = s
q = queue.Queue()
cancel_event = threading.Event()
with STREAMS_LOCK:
config.STREAMS['stream_partial'] = q
config.CANCEL_FLAGS['stream_partial'] = cancel_event
STREAM_PARTIAL_TEXT['stream_partial'] = 'Python is a high-level programming language'
# Fake agent with session_id attribute
class FakeAgent:
session_id = 'sess_partial'
def interrupt(self, _): pass
config.AGENT_INSTANCES['stream_partial'] = FakeAgent()
result = cancel_stream('stream_partial')
assert result is True
# Reload the session and check messages
from api.models import Session
saved = Session.load('sess_partial')
assert saved is not None
msg_contents = [m.get('content', '') for m in saved.messages]
# Should have: user message, partial assistant content, cancel marker
assert any('Python is a high-level programming language' in c for c in msg_contents), (
f"Partial text not found in session messages: {msg_contents}"
)
assert any('Task cancelled:' in c for c in msg_contents), (
"Cancel marker missing from session messages"
)
# Partial message should NOT have _error=True (it's real content)
partial_msg = next(m for m in saved.messages
if 'Python is a high-level' in m.get('content', ''))
assert partial_msg.get('_partial') is True
assert not partial_msg.get('_error')
# Cancel marker should have _error=True
cancel_msg = next(m for m in saved.messages if 'Task cancelled:' in m.get('content', ''))
assert cancel_msg.get('_error') is True
assert cancel_msg.get('provider_details_label') == 'Cancellation details'
def test_cancel_stream_with_no_partial_text_still_saves_cancel_marker(self, tmp_path, monkeypatch):
"""If no tokens were streamed before cancel, only the cancel marker is saved."""
import queue
from api.models import Session
from api.streaming import cancel_stream
session_dir = tmp_path / 'sessions'
session_dir.mkdir()
import api.models as _models
monkeypatch.setattr(config, 'SESSION_DIR', session_dir)
monkeypatch.setattr(config, 'SESSION_INDEX_FILE', session_dir / '_index.json')
monkeypatch.setattr(_models, 'SESSION_DIR', session_dir)
monkeypatch.setattr(_models, 'SESSION_INDEX_FILE', session_dir / '_index.json')
config.SESSIONS.clear()
_models.SESSIONS.clear()
s = Session(session_id='sess_nopartial', title='Test')
s.messages.append({'role': 'user', 'content': 'Hello'})
s.active_stream_id = 'stream_nopartial'
s.save()
config.SESSIONS['sess_nopartial'] = s
q = queue.Queue()
cancel_event = threading.Event()
with STREAMS_LOCK:
config.STREAMS['stream_nopartial'] = q
config.CANCEL_FLAGS['stream_nopartial'] = cancel_event
STREAM_PARTIAL_TEXT['stream_nopartial'] = '' # empty — cancel before any tokens
class FakeAgent:
session_id = 'sess_nopartial'
def interrupt(self, _): pass
config.AGENT_INSTANCES['stream_nopartial'] = FakeAgent()
cancel_stream('stream_nopartial')
saved = Session.load('sess_nopartial')
msg_contents = [m.get('content', '') for m in saved.messages]
assert any('Task cancelled:' in c for c in msg_contents)
# No extra partial message when there was nothing streamed
assert not any(m.get('_partial') for m in saved.messages), (
"Should not add partial message when no tokens were streamed"
)
def test_cancel_stream_strips_thinking_markup_from_partial(self, tmp_path, monkeypatch):
"""Thinking blocks in partial text are stripped before saving."""
import queue
from api.models import Session
from api.streaming import cancel_stream
session_dir = tmp_path / 'sessions'
session_dir.mkdir()
import api.models as _models
monkeypatch.setattr(config, 'SESSION_DIR', session_dir)
monkeypatch.setattr(config, 'SESSION_INDEX_FILE', session_dir / '_index.json')
monkeypatch.setattr(_models, 'SESSION_DIR', session_dir)
monkeypatch.setattr(_models, 'SESSION_INDEX_FILE', session_dir / '_index.json')
config.SESSIONS.clear()
_models.SESSIONS.clear()
s = Session(session_id='sess_thinking', title='Test')
s.messages.append({'role': 'user', 'content': 'Think about this'})
s.active_stream_id = 'stream_thinking'
s.save()
config.SESSIONS['sess_thinking'] = s
q = queue.Queue()
cancel_event = threading.Event()
with STREAMS_LOCK:
config.STREAMS['stream_thinking'] = q
config.CANCEL_FLAGS['stream_thinking'] = cancel_event
STREAM_PARTIAL_TEXT['stream_thinking'] = (
'internal reasoning here\nThe answer is 42'
)
class FakeAgent:
session_id = 'sess_thinking'
def interrupt(self, _): pass
config.AGENT_INSTANCES['stream_thinking'] = FakeAgent()
cancel_stream('stream_thinking')
saved = Session.load('sess_thinking')
partial_msg = next(
(m for m in saved.messages if m.get('_partial')), None
)
assert partial_msg is not None, "Partial message should be saved when content remains after stripping"
assert '' not in partial_msg['content'], "Closed thinking block should be stripped"
assert 'The answer is 42' in partial_msg['content'], "Visible content should be preserved"
def test_cancel_stream_strips_unclosed_think_tag(self, tmp_path, monkeypatch):
"""The common cancel-mid-reasoning case: block without a closing tag."""
import queue
from api.models import Session
from api.streaming import cancel_stream
session_dir = tmp_path / 'sessions'
session_dir.mkdir()
import api.models as _models
monkeypatch.setattr(config, 'SESSION_DIR', session_dir)
monkeypatch.setattr(config, 'SESSION_INDEX_FILE', session_dir / '_index.json')
monkeypatch.setattr(_models, 'SESSION_DIR', session_dir)
monkeypatch.setattr(_models, 'SESSION_INDEX_FILE', session_dir / '_index.json')
config.SESSIONS.clear()
_models.SESSIONS.clear()
s = Session(session_id='sess_unclosed', title='Test')
s.messages.append({'role': 'user', 'content': 'Please reason step by step'})
s.active_stream_id = 'stream_unclosed'
s.save()
config.SESSIONS['sess_unclosed'] = s
q = queue.Queue()
cancel_event = threading.Event()
with STREAMS_LOCK:
config.STREAMS['stream_unclosed'] = q
config.CANCEL_FLAGS['stream_unclosed'] = cancel_event
# Simulates user hitting Stop mid-reasoning — never closed
STREAM_PARTIAL_TEXT['stream_unclosed'] = (
'\nStep 1: consider the problem...\nStep 2: the user wants'
)
class FakeAgent:
session_id = 'sess_unclosed'
def interrupt(self, _): pass
config.AGENT_INSTANCES['stream_unclosed'] = FakeAgent()
cancel_stream('stream_unclosed')
saved = Session.load('sess_unclosed')
# The entire content was inside an unclosed block — nothing visible
# remains after stripping, so no _partial message should be saved
partial_msg = next((m for m in saved.messages if m.get('_partial')), None)
assert partial_msg is None, (
"Unclosed think block with no visible content should not produce a partial message"
)
# Cancel marker should still be present
assert any('Task cancelled' in m.get('content', '') for m in saved.messages)
class TestPartialMessageInContext:
def test_partial_message_included_in_api_sanitization(self):
"""Partial messages (_partial=True) are included in API history (model should see them)."""
from api.streaming import _sanitize_messages_for_api
messages = [
{'role': 'user', 'content': 'Tell me about Python'},
{'role': 'assistant', 'content': 'Python is a high-level', '_partial': True},
{'role': 'assistant', 'content': '*Task cancelled.*', '_error': True},
]
clean = _sanitize_messages_for_api(messages)
roles = [m['role'] for m in clean]
contents = [m.get('content', '') for m in clean]
# User message and partial assistant message should be included
assert 'user' in roles
assert any('Python is a high-level' in c for c in contents), (
"Partial assistant content should be in API context so model can continue from it"
)
# Cancel marker (_error=True) should be excluded
assert not any('Task cancelled' in c for c in contents), (
"Cancel marker with _error=True must be stripped from API context"
)
def test_short_prior_assistant_reply_does_not_dedup_new_partial(self):
'''Stage-350 Opus SHOULD-FIX (#2151 follow-up): the partial-dedup loop
in cancel_stream must only dedup against actual prior _partial markers
with exact content match, not via substring containment against any
prior assistant reply.
The original substring check (`_stripped in _existing or _existing in
_stripped`) was too broad — a short prior assistant reply like "OK" or
"Here is the answer:" would be a substring of many later partial bodies
and silently drop the new partial, resurrecting the #893 data-loss bug.
'''
from api.models import Session
# Build a session that already has a short prior assistant reply
s = Session(session_id='sess_short_prior', title='Test')
s.messages = [
{'role': 'user', 'content': 'Question one'},
{'role': 'assistant', 'content': 'OK'}, # short reply, NOT _partial
{'role': 'user', 'content': 'Question two — please answer fully'},
]
# Simulate what cancel_stream does for the dedup check.
# The new partial would be "OK, let me think about this..."
# — "OK" appears as a substring of this. Under the OLD substring
# check, this would have set _partial_already_present=True and
# dropped the new partial. Under the NEW exact-match-against-_partial
# check, no prior _partial exists, so the loop should NOT short-circuit.
new_partial_content = 'OK, let me think about this carefully...'
_stripped = new_partial_content.strip()
# Inline the new dedup logic (matches api/streaming.py:4669-4685):
_partial_already_present = False
if _stripped:
for _m in s.messages:
if not isinstance(_m, dict) or not _m.get('_partial'):
continue
if str(_m.get('content') or '').strip() == _stripped:
_partial_already_present = True
break
assert _partial_already_present is False, (
"Tightened dedup must NOT consider 'OK' (a non-partial prior "
"assistant reply) as deduping a longer new partial that contains it. "
"Without the tightening, the substring check `_stripped in _existing "
"or _existing in _stripped` would have falsely matched."
)
def test_exact_partial_match_still_dedups(self):
'''Stage-350 Opus SHOULD-FIX (#2151 follow-up): the tighter dedup
still correctly deduplicates a partial that is being persisted twice
with exactly the same content (e.g. cancel_stream re-entered for the
same stream id after STREAMS_LOCK is released).
'''
from api.models import Session
s = Session(session_id='sess_exact_dedup', title='Test')
s.messages = [
{'role': 'user', 'content': 'Hello'},
# Prior _partial marker with exact same content as the incoming one
{'role': 'assistant', 'content': 'Partial reply text', '_partial': True},
]
_stripped = 'Partial reply text'
_partial_already_present = False
if _stripped:
for _m in s.messages:
if not isinstance(_m, dict) or not _m.get('_partial'):
continue
if str(_m.get('content') or '').strip() == _stripped:
_partial_already_present = True
break
assert _partial_already_present is True, (
"Exact-content match against a prior _partial marker must still "
"dedup so cancel_stream re-entry doesn't double-write the partial."
)
def test_non_partial_assistant_with_same_content_does_not_dedup(self):
'''Stage-350 Opus SHOULD-FIX (#2151 follow-up): even if a prior
assistant message has exactly the same content, if it isn't marked
_partial, it does NOT dedup the new partial. This is correct: the
prior message was a completed turn from an earlier conversation,
and the new _partial belongs to the current cancelled stream.
'''
from api.models import Session
s = Session(session_id='sess_nondiluted', title='Test')
s.messages = [
{'role': 'user', 'content': 'Hello'},
# Same content but NOT _partial — this is a completed prior turn
{'role': 'assistant', 'content': 'Hi there'},
]
_stripped = 'Hi there'
_partial_already_present = False
if _stripped:
for _m in s.messages:
if not isinstance(_m, dict) or not _m.get('_partial'):
continue
if str(_m.get('content') or '').strip() == _stripped:
_partial_already_present = True
break
assert _partial_already_present is False, (
"A prior assistant message with same content but NOT _partial "
"must not dedup the new partial — it's from a completed earlier turn."
)