signal-bot/signal_bot/quoting.py
Krzysztof kuhy Rudnicki a202317072 feat: answer the message that asked, not just the room
A "!cat" in a busy group produced a cat picture floating loose in the chat with
nothing tying it to whoever asked. Replies now quote the triggering message.

The container advertises this and always could: /v1/about reports
capabilities {"v2/send": ["quotes", "mentions"]}, and /v2/send takes
quote_timestamp, quote_author and quote_message. What was missing was on this
side -- parse_envelope discarded the envelope's timestamp, which is the id
Signal quotes a message by, so nothing downstream could have built a quote even
in principle. IncomingMessage now carries it, preferring the payload's own
value over the envelope's for the case where they ever disagree.

Quote is a value object rather than three more parameters threaded through
every send: the Transport protocol has five methods and two of them send.
CommandContext grows reply_image() so quoting lives in one place instead of
each handler reaching for ctx.transport itself, which is what animals.py did.

quote_of() returns None when the timestamp or author is missing. Answering the
room is a worse reply than a quoted one but a much better outcome than a
payload the container rejects.

The e2e gate learned to tell the two apart: Expectation.quotes demands a send
either does or does not point at a message, defaulting to None so the ten
existing scenarios stay indifferent. Without it the fake would have accepted an
unquoted reply as a pass.

Verified in the testbot group on a real Signal client before this bump, per
kuhy's rule that a bump is a publish rather than a checkpoint: he sent !cat and
confirmed the picture renders attached to his message as a reply.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015d48t4qsQLBJnDwDeo2Nom
2026-08-29 23:01:01 +02:00

49 lines
1.6 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""Answering a specific message rather than the room.
The container advertises this: /v1/about reports
``capabilities: {"v2/send": ["quotes", "mentions"]}`` and /v2/send accepts
``quote_timestamp``, ``quote_author`` and ``quote_message``.
A quote needs the *sent timestamp of the message being answered*, which is why
``IncomingMessage`` had to start carrying one -- parse_envelope threw it away,
so until now nothing downstream could have built a quote even in principle.
"""
from __future__ import annotations
from dataclasses import dataclass
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from signal_bot.models import IncomingMessage
@dataclass(frozen=True, slots=True)
class Quote:
"""The message a reply points at."""
timestamp: int
author: str
text: str
def payload(self) -> dict[str, str | int]:
"""The three keys /v2/send wants for a quoted reply."""
return {
"quote_timestamp": self.timestamp,
"quote_author": self.author,
"quote_message": self.text,
}
def quote_of(message: IncomingMessage) -> Quote | None:
"""Return the quote that answers this message, or None if it has none.
Both fields are required by the API, and an envelope missing either is a
shape this bot has not seen -- worth replying without a quote rather than
sending something the container will reject.
"""
if not message.timestamp or not message.source_uuid:
return None
return Quote(message.timestamp, message.source_uuid, message.text or "")