f1f5a986e8
UIWorker is an LLMContextWorker that observes and drives a client GUI over the RTVI UI channel: it stores accessibility snapshots, auto-injects <ui_state> at the start of each respond job, dispatches client events to @on_ui_event handlers, sends UI commands back to the client, and surfaces fan-out work as cancellable task cards via user_job_group(). The optional ReplyToolMixin exposes a bundled reply tool. The prompt_guide parameter auto-appends the UI wire-format guide to the LLM's system instruction (default UI_STATE_PROMPT_GUIDE; override with a string or disable with None), so the LLM can parse the injected <ui_state> / <ui_event> messages without the app concatenating the guide by hand.
806 lines
28 KiB
Python
806 lines
28 KiB
Python
#
|
|
# Copyright (c) 2026, Daily
|
|
#
|
|
# SPDX-License-Identifier: BSD 2-Clause License
|
|
#
|
|
|
|
"""Tests for UIWorker dispatch, LLM-context injection, and single-flight respond."""
|
|
|
|
import asyncio
|
|
import json
|
|
import unittest
|
|
from unittest.mock import AsyncMock, MagicMock
|
|
|
|
from pipecat.bus.messages import BusJobCancelMessage, BusJobRequestMessage
|
|
from pipecat.bus.ui_messages import _UI_SNAPSHOT_BUS_EVENT_NAME, BusUIEventMessage
|
|
from pipecat.frames.frames import LLMMessagesAppendFrame, LLMMessagesUpdateFrame
|
|
from pipecat.processors.frame_processor import FrameDirection
|
|
from pipecat.utils.asyncio.task_manager import TaskManager, TaskManagerParams
|
|
from pipecat.workers.ui import UI_STATE_PROMPT_GUIDE, UIWorker, on_ui_event
|
|
|
|
|
|
class _StubUIWorker(UIWorker):
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.captured: list[BusUIEventMessage] = []
|
|
|
|
@on_ui_event("nav_click")
|
|
async def _on_nav(self, message: BusUIEventMessage) -> None:
|
|
self.captured.append(message)
|
|
|
|
|
|
class _PlainWorker(UIWorker):
|
|
pass
|
|
|
|
|
|
async def _make_worker(cls=_StubUIWorker, **kwargs) -> UIWorker:
|
|
"""A UIWorker wired with a task manager and a ``queue_frame`` spy.
|
|
|
|
``queue_frame`` is replaced with a recorder so tests can assert the
|
|
frames the UI logic produces without running the pipeline. The
|
|
respond handler sends its own response, so ``send_job_response`` is
|
|
mocked to let ``respond_with_llm`` run without an active job entry.
|
|
"""
|
|
worker = cls("ui", llm=MagicMock(), active=False, **kwargs)
|
|
tm = TaskManager()
|
|
tm.setup(TaskManagerParams(loop=asyncio.get_running_loop()))
|
|
worker._task_manager = tm
|
|
|
|
recorded: list = []
|
|
|
|
async def _record(frame, direction=FrameDirection.DOWNSTREAM):
|
|
recorded.append(frame)
|
|
|
|
worker.queue_frame = _record # type: ignore[method-assign]
|
|
worker._recorded = recorded # type: ignore[attr-defined]
|
|
worker.send_job_response = AsyncMock() # type: ignore[method-assign]
|
|
return worker
|
|
|
|
|
|
async def _settle() -> None:
|
|
"""Yield enough times for spawned task handlers to run/park."""
|
|
for _ in range(10):
|
|
await asyncio.sleep(0)
|
|
|
|
|
|
async def _start(worker: UIWorker, message: BusJobRequestMessage) -> asyncio.Task:
|
|
"""Start a respond turn; it parks at ``await self._pending`` until resolved."""
|
|
t = asyncio.create_task(worker.respond_with_llm(message))
|
|
await _settle()
|
|
return t
|
|
|
|
|
|
def _respond_msg(job_id: str, query: str = "hi") -> BusJobRequestMessage:
|
|
return BusJobRequestMessage(
|
|
source="voice", target="ui", job_name="respond", job_id=job_id, payload={"query": query}
|
|
)
|
|
|
|
|
|
async def _dispatch(worker: UIWorker, message: BusUIEventMessage) -> None:
|
|
await worker.on_bus_message(message)
|
|
for _ in range(5):
|
|
await asyncio.sleep(0)
|
|
|
|
|
|
def _append_frames(worker) -> list[LLMMessagesAppendFrame]:
|
|
return [f for f in worker._recorded if isinstance(f, LLMMessagesAppendFrame)]
|
|
|
|
|
|
def _update_frames(worker) -> list[LLMMessagesUpdateFrame]:
|
|
return [f for f in worker._recorded if isinstance(f, LLMMessagesUpdateFrame)]
|
|
|
|
|
|
class TestUIWorkerDispatch(unittest.IsolatedAsyncioTestCase):
|
|
async def test_dispatches_to_matching_on_ui_event_handler(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target="ui", event_name="nav_click", payload={"view": "home"}
|
|
),
|
|
)
|
|
|
|
self.assertEqual(len(worker.captured), 1)
|
|
self.assertEqual(worker.captured[0].event_name, "nav_click")
|
|
self.assertEqual(worker.captured[0].payload, {"view": "home"})
|
|
|
|
async def test_unknown_event_name_does_not_raise(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target="ui", event_name="never_registered", payload={"x": 1}
|
|
),
|
|
)
|
|
|
|
self.assertEqual(worker.captured, [])
|
|
|
|
async def test_ignores_events_targeted_at_other_workers(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music",
|
|
target="someone_else",
|
|
event_name="nav_click",
|
|
payload={"view": "home"},
|
|
),
|
|
)
|
|
|
|
self.assertEqual(worker.captured, [])
|
|
self.assertEqual(_append_frames(worker), [])
|
|
|
|
async def test_broadcast_event_with_no_target_is_handled(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target=None, event_name="nav_click", payload={"view": "home"}
|
|
),
|
|
)
|
|
|
|
self.assertEqual(len(worker.captured), 1)
|
|
|
|
async def test_handler_runs_in_separate_task_so_bus_is_not_blocked(self):
|
|
gate = asyncio.Event()
|
|
observed: list[bool] = []
|
|
|
|
class _BlockingWorker(_StubUIWorker):
|
|
@on_ui_event("slow")
|
|
async def _slow(self, message):
|
|
await gate.wait()
|
|
observed.append(True)
|
|
|
|
worker = await _make_worker(cls=_BlockingWorker)
|
|
|
|
await worker.on_bus_message(
|
|
BusUIEventMessage(source="music", target="ui", event_name="slow", payload={})
|
|
)
|
|
self.assertEqual(observed, [])
|
|
|
|
gate.set()
|
|
await _settle()
|
|
self.assertEqual(observed, [True])
|
|
|
|
async def test_duplicate_handler_names_raise_at_init(self):
|
|
with self.assertRaises(ValueError):
|
|
|
|
class _Bad(UIWorker):
|
|
@on_ui_event("nav")
|
|
async def a(self, message):
|
|
pass
|
|
|
|
@on_ui_event("nav")
|
|
async def b(self, message):
|
|
pass
|
|
|
|
_Bad("ui", llm=MagicMock())
|
|
|
|
async def test_bridged_with_default_auto_inject_raises(self):
|
|
with self.assertRaises(ValueError) as ctx:
|
|
_PlainWorker("ui", llm=MagicMock(), bridged=())
|
|
self.assertIn("bridged", str(ctx.exception))
|
|
self.assertIn("auto_inject_ui_state", str(ctx.exception))
|
|
|
|
async def test_bridged_with_explicit_auto_inject_disabled_is_allowed(self):
|
|
worker = _PlainWorker("ui", llm=MagicMock(), bridged=(), auto_inject_ui_state=False)
|
|
self.assertFalse(worker._auto_inject_ui_state)
|
|
|
|
async def test_default_construction_unaffected(self):
|
|
worker = _PlainWorker("ui", llm=MagicMock())
|
|
self.assertTrue(worker._auto_inject_ui_state)
|
|
self.assertTrue(worker.active)
|
|
|
|
|
|
class TestUIWorkerInjection(unittest.IsolatedAsyncioTestCase):
|
|
async def test_injects_xml_developer_message_by_default(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target="ui", event_name="nav_click", payload={"view": "home"}
|
|
),
|
|
)
|
|
|
|
frames = _append_frames(worker)
|
|
self.assertEqual(len(frames), 1)
|
|
|
|
frame = frames[0]
|
|
self.assertFalse(frame.run_llm)
|
|
self.assertEqual(len(frame.messages), 1)
|
|
msg = frame.messages[0]
|
|
self.assertEqual(msg["role"], "developer")
|
|
|
|
content = msg["content"]
|
|
self.assertIn('<ui_event name="nav_click">', content)
|
|
self.assertIn("</ui_event>", content)
|
|
inner = content[len('<ui_event name="nav_click">') : -len("</ui_event>")]
|
|
self.assertEqual(json.loads(inner), {"view": "home"})
|
|
|
|
async def test_inject_events_false_disables_injection(self):
|
|
worker = await _make_worker(inject_events=False)
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target="ui", event_name="nav_click", payload={"view": "home"}
|
|
),
|
|
)
|
|
|
|
self.assertEqual(_append_frames(worker), [])
|
|
self.assertEqual(len(worker.captured), 1)
|
|
|
|
async def test_render_override_replaces_default_xml(self):
|
|
class _CustomRender(_StubUIWorker):
|
|
def render_ui_event(self, message):
|
|
return f"[UI] {message.event_name}"
|
|
|
|
worker = await _make_worker(cls=_CustomRender)
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target="ui", event_name="nav_click", payload={"view": "home"}
|
|
),
|
|
)
|
|
|
|
frames = _append_frames(worker)
|
|
self.assertEqual(len(frames), 1)
|
|
self.assertEqual(frames[0].messages[0]["content"], "[UI] nav_click")
|
|
|
|
async def test_empty_render_skips_injection(self):
|
|
class _NoRender(_StubUIWorker):
|
|
def render_ui_event(self, message):
|
|
return ""
|
|
|
|
worker = await _make_worker(cls=_NoRender)
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music", target="ui", event_name="nav_click", payload={"view": "home"}
|
|
),
|
|
)
|
|
|
|
self.assertEqual(_append_frames(worker), [])
|
|
|
|
|
|
_SAMPLE_SNAPSHOT = {
|
|
"root": {
|
|
"ref": "e1",
|
|
"role": "generic",
|
|
"children": [
|
|
{
|
|
"ref": "e2",
|
|
"role": "main",
|
|
"children": [
|
|
{"ref": "e3", "role": "heading", "name": "Home", "level": 1},
|
|
{
|
|
"ref": "e4",
|
|
"role": "region",
|
|
"name": "Trending artists",
|
|
"children": [
|
|
{"ref": "e5", "role": "button", "name": "Bad Bunny"},
|
|
{
|
|
"ref": "e6",
|
|
"role": "button",
|
|
"name": "Taylor Swift",
|
|
"state": ["focused"],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
"captured_at": 1700000000000,
|
|
}
|
|
|
|
|
|
class TestUIWorkerSnapshot(unittest.IsolatedAsyncioTestCase):
|
|
async def test_reserved_snapshot_event_stored_without_dispatch(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music",
|
|
target="ui",
|
|
event_name=_UI_SNAPSHOT_BUS_EVENT_NAME,
|
|
payload=_SAMPLE_SNAPSHOT,
|
|
),
|
|
)
|
|
|
|
self.assertEqual(worker._latest_snapshot, _SAMPLE_SNAPSHOT)
|
|
self.assertEqual(worker.captured, [])
|
|
self.assertEqual(_append_frames(worker), [])
|
|
|
|
async def test_non_dict_snapshot_payload_is_ignored(self):
|
|
worker = await _make_worker()
|
|
|
|
await _dispatch(
|
|
worker,
|
|
BusUIEventMessage(
|
|
source="music",
|
|
target="ui",
|
|
event_name=_UI_SNAPSHOT_BUS_EVENT_NAME,
|
|
payload="not a snapshot",
|
|
),
|
|
)
|
|
|
|
self.assertIsNone(worker._latest_snapshot)
|
|
|
|
async def test_render_ui_state_empty_without_snapshot(self):
|
|
worker = await _make_worker()
|
|
self.assertEqual(worker.render_ui_state(), "")
|
|
|
|
async def test_render_ui_state_produces_indented_block(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
rendered = worker.render_ui_state()
|
|
|
|
self.assertTrue(rendered.startswith("<ui_state>\n"))
|
|
self.assertTrue(rendered.endswith("\n</ui_state>"))
|
|
|
|
self.assertIn("- generic [ref=e1]:", rendered)
|
|
self.assertIn("- main [ref=e2]:", rendered)
|
|
self.assertIn('- heading "Home" [level=1] [ref=e3]', rendered)
|
|
self.assertIn('- region "Trending artists" [ref=e4]:', rendered)
|
|
self.assertIn('- button "Bad Bunny" [ref=e5]', rendered)
|
|
self.assertIn('- button "Taylor Swift" [focused] [ref=e6]', rendered)
|
|
|
|
self.assertIn(" - main", rendered)
|
|
self.assertIn(" - heading", rendered)
|
|
self.assertIn(" - button", rendered)
|
|
|
|
async def test_inject_ui_state_queues_expected_frame(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
await worker.inject_ui_state()
|
|
|
|
frames = _append_frames(worker)
|
|
self.assertEqual(len(frames), 1)
|
|
frame = frames[0]
|
|
self.assertFalse(frame.run_llm)
|
|
self.assertEqual(len(frame.messages), 1)
|
|
msg = frame.messages[0]
|
|
self.assertEqual(msg["role"], "developer")
|
|
self.assertTrue(msg["content"].startswith("<ui_state>"))
|
|
self.assertTrue(msg["content"].endswith("</ui_state>"))
|
|
|
|
async def test_inject_ui_state_no_op_without_snapshot(self):
|
|
worker = await _make_worker()
|
|
await worker.inject_ui_state()
|
|
self.assertEqual(_append_frames(worker), [])
|
|
|
|
async def test_render_emits_grid_dims(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = {
|
|
"root": {
|
|
"ref": "e1",
|
|
"role": "generic",
|
|
"children": [
|
|
{
|
|
"ref": "e2",
|
|
"role": "grid",
|
|
"name": "Trending artists",
|
|
"colcount": 8,
|
|
"rowcount": 2,
|
|
"children": [{"ref": "e3", "role": "button", "name": "Bad Bunny"}],
|
|
},
|
|
],
|
|
},
|
|
"captured_at": 1700000000000,
|
|
}
|
|
|
|
rendered = worker.render_ui_state()
|
|
self.assertIn('- grid "Trending artists" [cols=8] [rows=2] [ref=e2]', rendered)
|
|
|
|
async def test_render_preserves_offscreen_tag(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = {
|
|
"root": {
|
|
"ref": "e1",
|
|
"role": "generic",
|
|
"children": [
|
|
{"ref": "e2", "role": "button", "name": "Visible"},
|
|
{"ref": "e3", "role": "button", "name": "Below fold", "state": ["offscreen"]},
|
|
],
|
|
},
|
|
"captured_at": 1700000000000,
|
|
}
|
|
|
|
rendered = worker.render_ui_state()
|
|
self.assertIn('- button "Visible" [ref=e2]', rendered)
|
|
self.assertIn('- button "Below fold" [offscreen] [ref=e3]', rendered)
|
|
|
|
async def test_visible_nodes_empty_without_snapshot(self):
|
|
worker = await _make_worker()
|
|
self.assertEqual(worker.visible_nodes(), [])
|
|
|
|
async def test_render_emits_selection_block_when_present(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = {
|
|
"root": {"ref": "e1", "role": "generic", "children": [{"ref": "e2", "role": "main"}]},
|
|
"captured_at": 1700000000000,
|
|
"selection": {"ref": "e2", "text": "the highlighted passage"},
|
|
}
|
|
|
|
rendered = worker.render_ui_state()
|
|
self.assertIn('<selection ref="e2">', rendered)
|
|
self.assertIn("the highlighted passage", rendered)
|
|
self.assertIn("</selection>", rendered)
|
|
self.assertTrue(rendered.endswith("</ui_state>"))
|
|
sel_idx = rendered.index('<selection ref="e2">')
|
|
close_idx = rendered.index("</ui_state>")
|
|
self.assertLess(sel_idx, close_idx)
|
|
|
|
async def test_render_omits_selection_when_missing(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = {
|
|
"root": {"ref": "e1", "role": "generic"},
|
|
"captured_at": 1700000000000,
|
|
}
|
|
|
|
rendered = worker.render_ui_state()
|
|
self.assertNotIn("<selection", rendered)
|
|
|
|
async def test_render_skips_selection_with_missing_ref_or_text(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = {
|
|
"root": {"ref": "e1", "role": "generic"},
|
|
"captured_at": 1,
|
|
"selection": {"ref": "e2"},
|
|
}
|
|
self.assertNotIn("<selection", worker.render_ui_state())
|
|
|
|
worker._latest_snapshot = {
|
|
"root": {"ref": "e1", "role": "generic"},
|
|
"captured_at": 1,
|
|
"selection": {"text": "stuff"},
|
|
}
|
|
self.assertNotIn("<selection", worker.render_ui_state())
|
|
|
|
async def test_visible_nodes_filters_offscreen_entries(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = {
|
|
"root": {
|
|
"ref": "e1",
|
|
"role": "generic",
|
|
"children": [
|
|
{"ref": "e2", "role": "button", "name": "Visible"},
|
|
{"ref": "e3", "role": "button", "name": "Below fold", "state": ["offscreen"]},
|
|
{
|
|
"ref": "e4",
|
|
"role": "region",
|
|
"name": "Tracks",
|
|
"state": ["offscreen"],
|
|
"children": [{"ref": "e5", "role": "button", "name": "Bloom"}],
|
|
},
|
|
],
|
|
},
|
|
"captured_at": 1700000000000,
|
|
}
|
|
|
|
refs = [n["ref"] for n in worker.visible_nodes()]
|
|
self.assertIn("e1", refs)
|
|
self.assertIn("e2", refs)
|
|
self.assertNotIn("e3", refs)
|
|
self.assertNotIn("e4", refs)
|
|
self.assertIn("e5", refs)
|
|
|
|
|
|
class TestUIWorkerAutoInject(unittest.IsolatedAsyncioTestCase):
|
|
async def test_respond_auto_injects_latest_snapshot(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"query": "hi"}),
|
|
)
|
|
|
|
frames = _append_frames(worker)
|
|
self.assertEqual(len(frames), 2)
|
|
self.assertEqual(frames[0].messages[0]["role"], "developer")
|
|
self.assertTrue(frames[0].messages[0]["content"].startswith("<ui_state>"))
|
|
self.assertFalse(frames[0].run_llm)
|
|
self.assertEqual(frames[1].messages[0]["content"], "hi")
|
|
self.assertTrue(frames[1].run_llm)
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_auto_inject_ui_state_false_suppresses_injection(self):
|
|
worker = await _make_worker(auto_inject_ui_state=False)
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"query": "hi"}),
|
|
)
|
|
|
|
frames = _append_frames(worker)
|
|
self.assertEqual(len(frames), 1)
|
|
self.assertFalse(frames[0].messages[0]["content"].startswith("<ui_state>"))
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_auto_inject_no_op_without_snapshot(self):
|
|
worker = await _make_worker()
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"query": "hi"}),
|
|
)
|
|
|
|
frames = _append_frames(worker)
|
|
self.assertEqual(len(frames), 1)
|
|
self.assertFalse(frames[0].messages[0]["content"].startswith("<ui_state>"))
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
|
|
class TestUIWorkerKeepHistory(unittest.IsolatedAsyncioTestCase):
|
|
async def test_default_resets_context_per_job(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"query": "hi"}),
|
|
)
|
|
|
|
updates = _update_frames(worker)
|
|
self.assertEqual(len(updates), 1)
|
|
self.assertEqual(updates[0].messages, [])
|
|
self.assertFalse(updates[0].run_llm)
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_reset_runs_before_inject(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"query": "hi"}),
|
|
)
|
|
|
|
frame_types = [type(f).__name__ for f in worker._recorded]
|
|
update_idx = frame_types.index("LLMMessagesUpdateFrame")
|
|
append_idx = frame_types.index("LLMMessagesAppendFrame")
|
|
self.assertLess(update_idx, append_idx)
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_keep_history_true_skips_reset(self):
|
|
worker = await _make_worker(keep_history=True)
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"query": "hi"}),
|
|
)
|
|
|
|
self.assertEqual(_update_frames(worker), [])
|
|
self.assertEqual(len(_append_frames(worker)), 2)
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_reset_context_method_emits_update_frame(self):
|
|
worker = await _make_worker(keep_history=True)
|
|
|
|
await worker.reset_context()
|
|
|
|
updates = _update_frames(worker)
|
|
self.assertEqual(len(updates), 1)
|
|
self.assertEqual(updates[0].messages, [])
|
|
self.assertFalse(updates[0].run_llm)
|
|
|
|
|
|
class TestUIWorkerRespondToJob(unittest.IsolatedAsyncioTestCase):
|
|
async def test_current_job_tracks_in_flight_request(self):
|
|
worker = await _make_worker()
|
|
self.assertIsNone(worker.current_job)
|
|
message = BusJobRequestMessage(
|
|
source="voice", target="ui", job_id="t1", payload={"query": "hi"}
|
|
)
|
|
t = await _start(worker, message)
|
|
self.assertIs(worker.current_job, message)
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_respond_to_job_clears_current_and_sends_response(self):
|
|
worker = await _make_worker()
|
|
message = BusJobRequestMessage(source="voice", target="ui", job_id="t1")
|
|
t = await _start(worker, message)
|
|
|
|
await worker.respond_to_job(speak="hello")
|
|
await t
|
|
|
|
worker.send_job_response.assert_awaited_once()
|
|
call = worker.send_job_response.await_args
|
|
self.assertEqual(call.args[0], "t1")
|
|
self.assertEqual(call.kwargs["response"], {"speak": "hello"})
|
|
self.assertIsNone(worker.current_job)
|
|
|
|
async def test_respond_to_job_no_op_when_idle(self):
|
|
worker = await _make_worker()
|
|
await worker.respond_to_job(speak="hello")
|
|
worker.send_job_response.assert_not_awaited()
|
|
|
|
async def test_respond_to_job_omits_speak_when_none(self):
|
|
worker = await _make_worker()
|
|
t = await _start(worker, BusJobRequestMessage(source="voice", target="ui", job_id="t1"))
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
call = worker.send_job_response.await_args
|
|
self.assertEqual(call.kwargs["response"], {})
|
|
|
|
async def test_respond_to_job_merges_speak_into_response(self):
|
|
worker = await _make_worker()
|
|
t = await _start(worker, BusJobRequestMessage(source="voice", target="ui", job_id="t1"))
|
|
|
|
await worker.respond_to_job({"description": "scrolled"}, speak="ok")
|
|
await t
|
|
|
|
call = worker.send_job_response.await_args
|
|
self.assertEqual(call.kwargs["response"], {"description": "scrolled", "speak": "ok"})
|
|
|
|
async def test_cancellation_frees_lock_for_subsequent_jobs(self):
|
|
worker = await _make_worker()
|
|
msg_a = _respond_msg("a")
|
|
msg_b = _respond_msg("b")
|
|
|
|
await worker._handle_job_request(msg_a)
|
|
await _settle()
|
|
self.assertIs(worker.current_job, msg_a)
|
|
self.assertTrue(worker._job_locks["respond"].locked())
|
|
|
|
await worker._handle_job_cancel(
|
|
BusJobCancelMessage(source="voice", target="ui", job_id="a")
|
|
)
|
|
await _settle()
|
|
self.assertIsNone(worker.current_job)
|
|
self.assertFalse(worker._job_locks["respond"].locked())
|
|
|
|
await worker._handle_job_request(msg_b)
|
|
await _settle()
|
|
self.assertIs(worker.current_job, msg_b)
|
|
|
|
await worker.respond_to_job(speak="B done")
|
|
await _settle()
|
|
|
|
async def test_cancel_unknown_job_id_is_noop(self):
|
|
worker = await _make_worker()
|
|
msg_a = _respond_msg("a")
|
|
|
|
await worker._handle_job_request(msg_a)
|
|
await _settle()
|
|
|
|
await worker._handle_job_cancel(
|
|
BusJobCancelMessage(source="voice", target="ui", job_id="unrelated")
|
|
)
|
|
await _settle()
|
|
|
|
self.assertIs(worker.current_job, msg_a)
|
|
self.assertTrue(worker._job_locks["respond"].locked())
|
|
|
|
await worker.respond_to_job(speak="A done")
|
|
await _settle()
|
|
|
|
async def test_concurrent_same_name_jobs_serialize(self):
|
|
worker = await _make_worker()
|
|
msg_a = _respond_msg("a")
|
|
msg_b = _respond_msg("b")
|
|
|
|
await worker._handle_job_request(msg_a)
|
|
await _settle()
|
|
self.assertIs(worker.current_job, msg_a)
|
|
|
|
await worker._handle_job_request(msg_b)
|
|
await _settle()
|
|
self.assertIs(worker.current_job, msg_a)
|
|
|
|
await worker.respond_to_job(speak="A done")
|
|
await _settle()
|
|
self.assertIs(worker.current_job, msg_b)
|
|
|
|
await worker.respond_to_job(speak="B done")
|
|
await _settle()
|
|
self.assertIsNone(worker.current_job)
|
|
|
|
|
|
class TestUIWorkerRespondJob(unittest.IsolatedAsyncioTestCase):
|
|
async def test_respond_handler_runs_after_setup(self):
|
|
worker = await _make_worker()
|
|
worker._latest_snapshot = _SAMPLE_SNAPSHOT
|
|
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(
|
|
source="voice", target="ui", job_id="t1", payload={"query": "hello"}
|
|
),
|
|
)
|
|
|
|
appends = _append_frames(worker)
|
|
self.assertEqual(len(appends), 2)
|
|
self.assertTrue(appends[0].messages[0]["content"].startswith("<ui_state>"))
|
|
self.assertFalse(appends[0].run_llm)
|
|
self.assertEqual(appends[1].messages[0]["content"], "hello")
|
|
self.assertTrue(appends[1].run_llm)
|
|
self.assertEqual(worker.current_job.job_id, "t1")
|
|
|
|
await worker.respond_to_job(speak="done")
|
|
await t
|
|
self.assertIsNone(worker.current_job)
|
|
worker.send_job_response.assert_awaited_once()
|
|
|
|
async def test_render_query_override(self):
|
|
class _Custom(_StubUIWorker):
|
|
def render_query(self, message):
|
|
return f"Q: {message.payload['q']}"
|
|
|
|
worker = await _make_worker(cls=_Custom)
|
|
t = await _start(
|
|
worker,
|
|
BusJobRequestMessage(source="voice", target="ui", job_id="t1", payload={"q": "hi"}),
|
|
)
|
|
|
|
query_frames = [f for f in _append_frames(worker) if f.run_llm]
|
|
self.assertEqual(query_frames[0].messages[0]["content"], "Q: hi")
|
|
|
|
await worker.respond_to_job()
|
|
await t
|
|
|
|
async def test_handler_failure_clears_state(self):
|
|
class _Boom(_StubUIWorker):
|
|
def render_query(self, message):
|
|
raise RuntimeError("boom")
|
|
|
|
worker = await _make_worker(cls=_Boom)
|
|
|
|
with self.assertRaises(RuntimeError):
|
|
await worker.respond_with_llm(
|
|
BusJobRequestMessage(
|
|
source="voice", target="ui", job_id="t1", payload={"query": "x"}
|
|
)
|
|
)
|
|
|
|
self.assertIsNone(worker.current_job)
|
|
self.assertIsNone(worker._pending)
|
|
|
|
|
|
class TestUIWorkerPromptGuide(unittest.IsolatedAsyncioTestCase):
|
|
async def test_default_appends_ui_state_prompt_guide(self):
|
|
worker = UIWorker("ui", llm=MagicMock(), active=False)
|
|
worker.llm.append_system_instruction.assert_called_once_with(UI_STATE_PROMPT_GUIDE)
|
|
|
|
async def test_custom_prompt_guide_overrides(self):
|
|
worker = UIWorker("ui", llm=MagicMock(), active=False, prompt_guide="MY GUIDE")
|
|
worker.llm.append_system_instruction.assert_called_once_with("MY GUIDE")
|
|
|
|
async def test_none_disables_injection(self):
|
|
worker = UIWorker("ui", llm=MagicMock(), active=False, prompt_guide=None)
|
|
worker.llm.append_system_instruction.assert_not_called()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|