Files
LangBot/tests/unit_tests/platform/test_botmgr_execution_trace.py
T
Hyu 0efc1fb1cc feat(telemetry): trace one inbound event end to end
Execution telemetry already reported window counters. This adds one bounded,
content-free chain per inbound platform event, so a single event can be
followed from its source platform through routing and processing to the
platform API calls it caused.

- telemetry/trace.py: ContextVar trace identity with route and run scopes, and
  a 32-stage bound per chain.
- telemetry/execution.py: keeps at most 64 chains for 120s, decides sampling
  from the observed outcome, and sends one payload per chain keyed by
  query_id = trace_id, so Space fetches a chain by primary identity. Window
  counters are unchanged and remain the source of coverage statistics.
- botmgr / pipelinemgr / orchestrator: bind the trace at the ingress boundary,
  scope routing identity per dispatch, and attach the run identity, so nested
  lanes (event -> route -> pipeline/runner -> platform API) reuse one chain. A
  run reached without an ingress (WebUI debug, service API) owns its own chain.
- space.execution_trace selects off | failures | sampled | all (default
  sampled: failures, WebUI debug runs and every N-th success).

Chains carry only code-defined identifiers (adapter and runner types, route
identity as type:uuid, run id); never message content, tool arguments or
platform user identifiers.
2026-10-01 02:12:44 +08:00

187 lines
6.2 KiB
Python

"""RuntimeBot ingress tracing: one inbound event owns one execution trace."""
from __future__ import annotations
from types import SimpleNamespace
from unittest.mock import AsyncMock, Mock
import pytest
from langbot.pkg.api.http.context import ExecutionContext
TEST_CONTEXT = ExecutionContext(
instance_uuid='instance-test',
workspace_uuid='workspace-test',
placement_generation=1,
bot_uuid='bot-1',
)
class FakeTelemetryManager:
def __init__(self, config=None):
self.telemetry_config = (
{'url': 'https://space.example.test', 'execution_trace': 'all'} if config is None else config
)
self.sent: list[dict] = []
async def send(self, payload: dict) -> bool:
self.sent.append(payload)
return True
def start_send_task(self, payload: dict) -> None:
self.sent.append(payload)
def make_bot(event_bindings: list[dict], config=None, agent=None):
from langbot.pkg.platform.botmgr import RuntimeBot
from langbot.pkg.telemetry.execution import ExecutionCounters
manager = FakeTelemetryManager(config)
counters = ExecutionCounters(manager)
bot = object.__new__(RuntimeBot)
bot.bot_entity = SimpleNamespace(
uuid='bot-1',
workspace_uuid=TEST_CONTEXT.workspace_uuid,
event_bindings=event_bindings,
plugin_processors=[],
)
bot.execution_context = TEST_CONTEXT
bot.workspace_uuid = TEST_CONTEXT.workspace_uuid
bot.placement_generation = TEST_CONTEXT.placement_generation
bot.logger = SimpleNamespace(info=AsyncMock(), warning=AsyncMock(), error=AsyncMock(), debug=AsyncMock())
bot.adapter = FakeAdapter()
bot.ap = SimpleNamespace(
telemetry=SimpleNamespace(execution=counters),
agent_service=SimpleNamespace(get_agent=AsyncMock(return_value=agent)),
pipeline_service=SimpleNamespace(get_pipeline=AsyncMock(return_value=None)),
)
return bot, manager, counters
def message_received_event():
from langbot_plugin.api.entities.builtin.platform import entities, events, message
return events.MessageReceivedEvent(
message_id='message-1',
message_chain=message.MessageChain([message.Plain(text='hello')]),
sender=entities.User(id='user-1', nickname='QA User'),
chat_type=entities.ChatType.PRIVATE,
chat_id='user-1',
)
class FakeAdapter:
async def get_supported_apis(self):
return []
@pytest.mark.asyncio
async def test_route_miss_emits_one_closed_trace():
bot, manager, counters = make_bot([])
await bot._handle_platform_event(message_received_event(), FakeAdapter())
assert len(manager.sent) == 1
payload = manager.sent[0]
assert payload['event_type'] == 'feature_execution'
assert len(payload['query_id']) == 36
assert payload['instance_id'] == 'instance-test'
assert payload['workspace_uuid'] == 'workspace-test'
features = payload['features']
assert features['schema'] == 1
assert [(row['family'], row['operation'], row['outcome']) for row in features['observations']] == [
('platform_event', 'message.received', 'success'),
('event_route', 'message.received', 'skipped'),
]
assert [row['seq'] for row in features['observations']] == [0, 1]
assert all(row['trace_id'] == payload['query_id'] for row in features['observations'])
assert all(row['adapter'] == 'FakeAdapter' for row in features['observations'])
assert features['trace']['closed_by'] == 'event_done'
# Window counters are still aggregated for coverage.
assert counters.pending
@pytest.mark.asyncio
async def test_unavailable_route_target_carries_route_identity():
bot, manager, _ = make_bot(
[
{
'id': 'agent-binding',
'enabled': True,
'event_pattern': 'message.received',
'target_type': 'agent',
'target_uuid': 'agent-1',
}
]
)
await bot._handle_platform_event(message_received_event(), FakeAdapter())
stages = manager.sent[0]['features']['observations']
assert [(stage['family'], stage['outcome'], stage['mode']) for stage in stages] == [
('platform_event', 'success', 'none'),
('event_route', 'failed', 'agent'),
]
assert stages[1]['route_ref'] == 'agent:agent-1'
assert stages[0]['route_ref'] == ''
@pytest.mark.asyncio
async def test_discarded_route_is_visible_without_user_values():
bot, manager, _ = make_bot(
[
{
'id': 'discard-binding',
'enabled': True,
'event_pattern': '*',
'target_type': 'discard',
}
]
)
await bot._handle_platform_event(SimpleNamespace(type='platform.member.joined'), FakeAdapter())
stages = manager.sent[0]['features']['observations']
assert [stage['outcome'] for stage in stages] == ['success', 'skipped']
assert stages[1]['operation'] == 'platform.member.joined'
assert stages[1]['mode'] == 'none'
@pytest.mark.asyncio
async def test_telemetry_opt_out_emits_nothing():
bot, manager, counters = make_bot([], config={'url': 'https://space.example.test', 'disable_telemetry': True})
await bot._handle_platform_event(message_received_event(), FakeAdapter())
assert manager.sent == []
assert counters.pending == {}
assert counters.traces == {}
@pytest.mark.asyncio
async def test_route_trace_scope_is_restored_after_dispatch():
from langbot.pkg.telemetry import trace as trace_mod
bot, _, _ = make_bot([])
assert trace_mod.current() is None
await bot._handle_platform_event(message_received_event(), FakeAdapter())
assert trace_mod.current() is None
# A later record outside the ingress must not join the closed trace.
from langbot.pkg.telemetry.execution import record
record(bot.ap, TEST_CONTEXT, family='platform_api', operation='send_message', outcome='success')
assert list(bot.ap.telemetry.execution.pending.values())[-1]['count'] == 1
@pytest.mark.asyncio
async def test_adapter_call_without_ingress_still_counts():
"""Mock adapter objects used by other tests must not break the ingress path."""
bot, manager, _ = make_bot([])
adapter = Mock()
await bot._handle_platform_event(message_received_event(), adapter)
assert manager.sent