signal-bot/tests/test_dispatcher_unknown.py
Krzysztof kuhy Rudnicki 6ec746fad2 feat: a word the bot does not know gets an answer, and gets kept
An unrecognised "!word" was dropped in silence, which made a typo
indistinguishable from the bot being down and threw away the best available
list of commands worth writing. Three things now happen at the one place in
dispatcher.py that used to be a bare `return`.

A near miss is corrected -- "!cta" asks whether you meant "!kot". The
distance is optimal string alignment rather than difflib's ratio: a
transposition is the typo people actually make, it costs one edit here, and
it shreds the matching blocks a ratio counts ("!cta"/"!cat" scores 0.75 but
"!cta"/"!kot" scores 0.50, so no cutoff separates them on principle).

A word with no near miss points at !zaproponuj, which files an idea from
inside the group. Either way the word and the message are recorded, and the
management page grows an Ideas tab that lists them.

Three things stay silent, each for its own reason. "!kot ladny" is a real
trigger with words after it and always has been silent. "!!" is punctuation.
And a command claimed in some *other* group is neither answered nor recorded
-- the album's triggers are real people's names, and pack_scoping.yaml says
it out loud: a refusal would itself announce that the album exists. The
existence check is therefore global, which is what pack_add already asks.

Measured rather than guessed, against the shipped aliases.json:

- a minimum candidate length, because "!ja" is one edit from ~40 of the 676
  two-letter words somebody could type; 69 of them got a suggestion before
  the rule and 18 after.
- the two-edit budget starts at six characters, not five. At five it put
  four pairs of *different* commands within reach of each other --
  !pies/!popes, !days/!cats, !dzis/!dni, !mnie/!dni -- and costs nothing to
  give up, because every real typo this was written for is one edit away.
  test_no_two_commands_are_within_reach_of_each_other fails if a future
  alias reopens the gap.

Both new tables are keyed on the envelope's own sent_at_ms, never the wall
clock: signal-cli replays undelivered frames on reconnect, and a clock-keyed
table collects a duplicate row per reconnect instead of ignoring one.

The branch is gated on should_count -- which excludes the bot's own envelope,
and that is the loop guard, since handle() checks is_own nowhere else -- and
wrapped in its own try/except, because it runs above the one that wraps a
handler and Bot.listen has no exception handling of its own.

Suggestions live in SQLite, not in a tracked file, and the export goes to the
state directory. check_personal_data learns the names it refuses from the
live database, so it catches a name somebody has typed and cannot catch a
misspelling of one -- and an unrecognised-command corpus is made of
misspellings. A group-writable file in a public tree is both a leak and a
wedge. The export therefore carries
deliberate !zaproponuj notes in full and unrecognised words as counts only;
bodies stay on the loopback-only page.

Verified on the live bot: restarted, both tables created with every existing
row count unchanged, !cta and !zaproponuj !pogoda delivered through
/_selftest, both rows read back out of the live database, and the journal
names neither the word nor the body.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01416TegJ3sa8xL5qGGgrygP
2026-08-31 16:48:26 +02:00

122 lines
3.9 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""The dispatcher branch that used to be a bare `return`.
Split out of test_dispatcher.py at the 250-line cap. The seam is real: that
file is "does the right command run", this one is "what happens when none
does".
"""
from __future__ import annotations
import datetime as dt
from typing import TYPE_CHECKING
import pytest
from signal_bot.context import CommandContext
from signal_bot.discovery import GroupDirectory
from signal_bot.dispatcher import Dispatcher
from signal_bot.registry import CommandRegistry
from tests.conftest import WATCHED_GROUP, envelope
if TYPE_CHECKING:
from signal_bot.config import Config
from signal_bot.context import CommandContext
from signal_bot.discovery import GroupDirectory
from signal_bot.store import Store
from signal_bot.transport_fake import FakeTransport
NOW = dt.datetime(2026, 8, 31, 12, 0, tzinfo=dt.UTC)
@pytest.fixture
def registry() -> CommandRegistry:
"""One command, so "!cta" has something to be a near miss for."""
async def handler(ctx: CommandContext) -> None:
"""Answer nothing; only the routing is under test here."""
reg = CommandRegistry()
reg.register("cat", ["!cat"], handler, "cat description")
return reg
@pytest.fixture
def dispatcher(
config: Config,
directory: GroupDirectory,
registry: CommandRegistry,
store: Store,
transport: FakeTransport,
) -> Dispatcher:
"""The real dispatcher, wired the way build_bot wires it."""
return Dispatcher(
config=config,
directory=directory,
registry=registry,
store=store,
transport=transport,
clock=lambda: NOW,
)
async def test_an_unrecognised_command_is_answered_and_remembered(
dispatcher: Dispatcher, transport: FakeTransport, store: Store
) -> None:
"""The branch that used to be a bare `return`."""
await dispatcher.handle(envelope(text="!cta", timestamp=808))
assert "!cat" in (transport.sent[-1].text or "")
(row,) = store.suggestions.unknown()
assert row.word == "!cta"
async def test_an_unrecognised_command_is_still_not_counted_as_a_command(
dispatcher: Dispatcher, store: Store
) -> None:
"""The bot saying something about a word does not make the word a command."""
await dispatcher.handle(envelope(text="!cta"))
row = store.events.connection.execute(
"SELECT is_command FROM message_events WHERE group_id = ?", (WATCHED_GROUP,)
).fetchone()
assert int(row["is_command"]) == 0
async def test_the_bot_never_answers_its_own_message(
dispatcher: Dispatcher, transport: FakeTransport, store: Store
) -> None:
"""The loop guard, tested with the worst case rather than a polite one.
handle() checks is_own nowhere else, so an outbound frame carrying a
word is what would loop -- uncapped, because unknown commands are
answered every time by design.
"""
await dispatcher.handle(envelope(text="!cta", sync=True))
assert transport.sent == []
assert store.suggestions.unknown() == []
async def test_a_reaction_is_not_a_mistyped_command(
dispatcher: Dispatcher, transport: FakeTransport
) -> None:
"""should_count gates the branch, and it excludes annotations."""
await dispatcher.handle(envelope(text="!cta", extra="reaction"))
assert transport.sent == []
async def test_a_failure_while_answering_does_not_end_the_receive_loop(
dispatcher: Dispatcher, monkeypatch: pytest.MonkeyPatch
) -> None:
"""Bot.listen has no try/except of its own.
This branch runs above the one that wraps a handler, so an unguarded
raise here would end the websocket consumer and the bot would go
silently deaf until the watchdog restarted it.
"""
async def explode(**_kwargs: object) -> None:
msg = "the container went away"
raise RuntimeError(msg)
monkeypatch.setattr("signal_bot.dispatcher.answer_unknown", explode)
await dispatcher.handle(envelope(text="!cta"))