Files
EvoScientist-Multi/tests/test_middleware_event_sink.py
T
dinos 01845f4311 refactor: route middleware display events through an injected event sink (#343)
* chore: add pytest-asyncio in auto mode

* test: migrate channel and stream tests to native async

Convert run_async() wrapper tests to plain 'async def test_*' under
pytest-asyncio auto mode. collect_events() in stream_v3_fakes becomes a
coroutine awaited at every call site.

* test: migrate command and model/middleware tests to native async

Convert run_async() wrappers (import, alias, and fixture forms) to plain
'async def test_*'. Multi-call tests merge onto one loop as sequential
awaits; none asserted on loop identity.

* test: migrate TUI, notifier, gateway, and session tests to native async

TUI/notifier/gateway files convert run_async wrappers to plain async
tests. test_sessions.py's unittest.TestCase classes move to
unittest.IsolatedAsyncioTestCase (pytest-asyncio does not await async
methods on plain TestCase; converting blindly would have made ~70 tests
silently vacuous). Its setUpClass keeps a one-shot asyncio.run() since
IsolatedAsyncioTestCase has no async class-level hook. TestLoadingWidget
in test_tui_widgets.py drops its TestCase base for the same reason.

* test: replace direct asyncio.run() calls with native async tests

Convert tests that called asyncio.run() (directly or via a local _run
helper) to plain 'async def test_*'; delete the local helpers.

* test: drop undeclared anyio markers and delete run_async helper

The @pytest.mark.anyio tests relied on anyio being a transitive dep of
httpx; auto-mode pytest-asyncio collects them natively. run_async() and
its fixture are unreferenced after the migration, so remove them —
pytest-asyncio's per-test loop teardown covers the pending-task
cancellation the helper existed for (verified: full suite runs with no
'Event loop is closed' errors or destroyed-task warnings).

* test: add autouse fixture for watcher cleanup

* refactor: remove redundant hasattr calls

* refactor: add typed middleware event sink and thread through assembly

Add MiddlewareEventSink protocol + NoOpSink in middleware/events.py
with a documented any-thread non-blocking contract (contract test uses a
deliberately-slow fake sink). Thread an optional `events` parameter
through create_cli_agent -> _get_default_middleware -> tool selector /
model fallback constructors; subagent stacks are always forced to
NoOpSink.

* refactor: inject a notifier port into async-watcher and background middleware

Add public pre_cancel_watcher() and enqueue_task_notification() to
cli/async_notifier.py and a small NotifierPort protocol
(middleware/notifier.py) that the module satisfies structurally.
AsyncWatcherMiddleware and BackgroundExecutionMiddleware now receive the
port by constructor injection at the composition root, deleting the lazy
'from ..cli import async_notifier' imports and the private
_watcher_by_thread / _enqueue pokes.

* refactor: invert tool-selection ownership onto a frontend event sink

The adaptive tool selector now reports on_tool_selection_started /
on_tool_selection / on_tool_selection_ended to the injected sink instead
of writing four process-global module variables. The frontend sink
(stream/sink.py FrontendEventSink) owns the selected/total/active state
with consume-once + dedup-vs-last-emitted semantics;
stream/tool_selection.py reads that sink object (a ToolSelectionView)
rather than reaching into tool_selector's globals.

Deleted: the 4 module globals, the cross-module mutations in
tool_selection.py, the track_stream_selection flag, the now-vestigial
_ToolSelectionTrackerMiddleware, reset_tool_selection_state_for_tests,
and the autouse conftest fixture. The sink is threaded from the two
interactive frontends through create_runtime_gateways ->
LocalGraphGateway (read side) and _load_agent -> create_cli_agent (write
side); subagent / headless stacks get NoOpSink.

* refactor: route model-fallback narration through the injected event sink

Delete the _ui_emit_fn / set_ui_emit module global and the
..stream.console import from model_fallback.py. The fallback middleware
now reports through its injected sink: the fallback transition via the
structured on_model_fallback (the frontend formats the '-> Falling back
to ...' line), and the surrounding narration (primary-failure header,
per-attempt outcome, exhaustion, non-fallbackable rejection) via
emit_fallback_notice, preserving the exact user-facing text. The TUI
binds its _append_system as the sink's fallback display where it used to
call set_ui_emit (cleared on exit); the Rich CLI's sink prints to the
console. _try_fallbacks / _guard_and_fallback take the sink.

* refactor: declare events on the GraphGateway protocol

Both gateway implementations now carry an explicit events attribute
(LangGraphServerGateway holds None — no frontend renders middleware
events across the HTTP boundary), so the four call sites use plain
attribute access instead of getattr probing an implicit contract.

* refactor: bind fallback display via the closure-scoped concrete sink

The App methods used gateway.events (typed as the read-side view) and
hasattr-probed for the concrete FrontendEventSink API. The enclosing
factory creates that sink two hundred lines up — close over it directly:
no probing, fully typed, and it becomes a constructor parameter
naturally when the App class is hoisted out of the factory.

* fix: end tool selection before fallback handler

* fix: keep fallback display errors non-fatal

* fix: preserve selector suppression for default streams

* fix: restore fallback notice console display

* refactor: consolidate fallback narration events

* refactor: clean middleware event sink plumbing

* fix: type gateway session events

* refactor: make all event protocols runtime-checkable

MiddlewareEventSink already carried @runtime_checkable (the stream
binding guard isinstance-checks it); ToolSelectionView and SessionEvents
now match, so mirroring that pattern against any of the three protocols
works instead of raising TypeError.

* fix(cli): close QuickJS workers after one-shot failures

* fix(cli): honor no-thinking in final output

* fix(channels): report failed startup accurately

* fix(channels): make Telegram cleanup idempotent

* fix(tui): skip command sync during exit

* fix(channels): preserve startup state during retries

* refactor(channels): share pending startup status

* refactor(cli): expose channel startup snapshot

* fix(tui): move channel startup off event loop

* test(channels): release retry gate on assertion failure

---------

Co-authored-by: Xi Zhang <106144707+X-iZhang@users.noreply.github.com>
2026-07-14 22:34:17 +00:00

112 lines
3.6 KiB
Python

"""Contract tests for the middleware event sink.
Pins two things:
1. The protocol / :class:`NoOpSink` shape is stable and structural.
2. The threading/blocking contract: sinks may be called from any thread, and
a sink that blocks stalls its caller (nothing isolates a slow sink from the
emitting thread). The deliberately-slow fake sink documents this.
"""
from __future__ import annotations
import threading
import time
from EvoScientist.middleware.events import MiddlewareEventSink, NoOpSink
class _SlowSink:
"""A deliberately-slow, thread-safe sink used to exercise the contract.
Every event method sleeps ``delay`` seconds under a lock and records the
thread it was called on. A real frontend must NOT do this — it exists only
to demonstrate that a blocking sink holds the emitting thread.
"""
def __init__(self, delay: float) -> None:
self._delay = delay
self._lock = threading.Lock()
self.calls: list[tuple[str, threading.Thread]] = []
def _record(self, name: str) -> None:
time.sleep(self._delay)
with self._lock:
self.calls.append((name, threading.current_thread()))
def on_tool_selection_started(self, total_tools: int) -> None:
self._record("started")
def on_tool_selection(self, selected: list[str], total_tools: int) -> None:
self._record("selection")
def on_tool_selection_ended(self) -> None:
self._record("ended")
def emit_fallback_notice(self, text: str, style: str = "yellow") -> None:
self._record("notice")
def test_noopsink_satisfies_protocol():
sink = NoOpSink()
assert isinstance(sink, MiddlewareEventSink)
# Every event is a no-op and returns None regardless of arguments.
assert sink.on_tool_selection_started(10) is None
assert sink.on_tool_selection(["a", "b"], 10) is None
assert sink.on_tool_selection_ended() is None
assert sink.emit_fallback_notice("fallback notice") is None
def test_slow_sink_satisfies_protocol():
assert isinstance(_SlowSink(0.0), MiddlewareEventSink)
def test_sink_is_callable_from_any_thread():
"""Sink methods may be invoked from worker threads (the sync-hook world)."""
sink = _SlowSink(0.0)
main = threading.current_thread()
def _worker() -> None:
sink.on_tool_selection_started(3)
sink.on_tool_selection(["think_tool"], 3)
sink.on_tool_selection_ended()
t = threading.Thread(target=_worker)
t.start()
t.join()
names = [name for name, _ in sink.calls]
assert names == ["started", "selection", "ended"]
# All calls landed on the worker thread, not the caller's thread.
assert all(thread is not main for _, thread in sink.calls)
assert all(thread is t for _, thread in sink.calls)
def test_blocking_sink_stalls_the_emitting_thread():
"""A slow sink holds its caller: the contract requires non-blocking sinks.
This is the negative proof — nothing in the framework isolates the caller
from a blocking sink, so the emitting thread waits the full delay.
"""
delay = 0.2
sink = _SlowSink(delay)
start = time.perf_counter()
sink.emit_fallback_notice("fallback notice")
elapsed = time.perf_counter() - start
# The caller was blocked for at least the sink's delay.
assert elapsed >= delay
assert [name for name, _ in sink.calls] == ["notice"]
def test_noopsink_never_blocks():
sink = NoOpSink()
start = time.perf_counter()
for _ in range(10_000):
sink.on_tool_selection_started(50)
sink.emit_fallback_notice("fallback notice")
elapsed = time.perf_counter() - start
# 20k no-op calls are effectively free.
assert elapsed < 0.5