G2: F22 — add Event.is_error() helper and document .type-check contract

Why: wait_for_event matches a single EventType; when callers pass
[X, ERROR] to send() or wait_for_events, the return value may be an
error response whose payload is {"reason": "..."} — not the command-
specific keys the caller expects.  Without a documented contract and
a convenience helper, every call site independently forgets to check
.type before accessing payload keys, leading to KeyError (F21/M01,
M04) or silent fallthrough.  The is_error() helper and docstrings on
send()/wait_for_events() establish the contract that subsequent
commits in this branch rely on.

Refs: Forensics report finding F22
This commit is contained in:
Matthew Wolter 2026-04-11 20:03:39 -07:00
parent fbf84cbdac
commit 6a74f07da7
2 changed files with 28 additions and 4 deletions

View file

@ -90,6 +90,14 @@ class CommandHandlerBase:
expected_events: Optional[Union[EventType, List[EventType]]] = None,
timeout: Optional[float] = None,
) -> Event:
"""Wait for the first of *expected_events* to arrive.
Returns the first matched ``Event``. When ``EventType.ERROR`` is
among the expected types, the caller **must** check
``result.is_error()`` before accessing command-specific payload
keys an ERROR payload is ``{"reason": "..."}`` and will
``KeyError`` on any other key.
"""
try:
# Convert single event to list if needed
if not isinstance(expected_events, list):
@ -129,9 +137,6 @@ class CommandHandlerBase:
logger.debug(f"Command error: {e}")
return Event(EventType.ERROR, {"error": str(e)})
return Event(EventType.ERROR, {})
async def send(
self,
data: bytes,
@ -151,7 +156,14 @@ class CommandHandlerBase:
timeout: Timeout in seconds, or None to use default_timeout
Returns:
Event: The full event object that was received in response to the command
Event: The full event object that was received in response to
the command.
Important:
When ``EventType.ERROR`` is included in *expected_events*, the
returned event may be an error response. Callers **must**
check ``result.is_error()`` before accessing command-specific
payload keys to avoid ``KeyError``.
"""
if not self.dispatcher:
raise RuntimeError("Dispatcher not set, cannot send commands")
@ -266,6 +278,7 @@ class CommandHandlerBase:
contact = self._get_contact_by_prefix(dst_bytes.hex()) # need a contact for return path
if contact is None:
logger.error("No contact found")
return Event(EventType.ERROR, {"reason": "contact_not_found"})
zero_hop = False
if contact["out_path_len"] == -1:

View file

@ -104,6 +104,17 @@ class Event:
if kwargs:
self.attributes.update(kwargs)
def is_error(self) -> bool:
"""Return True if this event represents an error response.
Callers that include ``EventType.ERROR`` in their expected-events
list **must** check ``result.is_error()`` (or ``result.type ==
EventType.ERROR``) before accessing keyed payload fields, because
an ERROR payload contains ``{"reason": "..."}`` not the
command-specific keys the caller expects on the happy path.
"""
return self.type == EventType.ERROR
def clone(self):
"""
Create a copy of the event.