mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-11 12:37:32 +01:00
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
161 lines
6.0 KiB
Python
161 lines
6.0 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""Trigger resolution."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
import pytest
|
|
|
|
from signal_bot.context import CommandContext
|
|
from signal_bot.models import parse_envelope
|
|
from signal_bot.registry import CommandRegistry, DuplicateTriggerError
|
|
from signal_bot.transport_fake import FakeTransport
|
|
from tests.conftest import WATCHED_GROUP, envelope
|
|
|
|
if TYPE_CHECKING:
|
|
from signal_bot.config import Config
|
|
from signal_bot.store import Store
|
|
|
|
|
|
async def _noop(ctx: CommandContext) -> None:
|
|
return None
|
|
|
|
|
|
def test_resolves_a_registered_trigger() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("cat", ["!cat", "!kot"], _noop, "cat description")
|
|
assert registry.resolve("!kot") is not None
|
|
assert registry.resolve("!cat").name == "cat"
|
|
|
|
|
|
def test_resolution_is_case_insensitive_and_trims() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("cat", ["!cat"], _noop, "cat description")
|
|
assert registry.resolve(" !CAT ") is not None
|
|
|
|
|
|
def test_unknown_and_prefixless_text_resolves_to_nothing() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("cat", ["!cat"], _noop, "cat description")
|
|
assert registry.resolve("!nope") is None
|
|
assert registry.resolve("cat") is None
|
|
|
|
|
|
@pytest.mark.parametrize("text", [None, ""])
|
|
def test_empty_text_resolves_to_nothing(text: str | None) -> None:
|
|
assert CommandRegistry().resolve(text) is None
|
|
|
|
|
|
def test_duplicate_trigger_is_rejected() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("cat", ["!cat"], _noop, "cat description")
|
|
with pytest.raises(DuplicateTriggerError, match="!cat"):
|
|
registry.register("feline", ["!cat"], _noop, "feline description")
|
|
|
|
|
|
def test_commands_lists_in_registration_order() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("cat", ["!cat"], _noop, "cat description")
|
|
registry.register("dog", ["!dog"], _noop, "dog description")
|
|
assert [c.name for c in registry.commands] == ["cat", "dog"]
|
|
|
|
|
|
def _ctx(transport: FakeTransport, store: Store, config: Config) -> CommandContext:
|
|
message = parse_envelope(envelope(text="!papiez"))
|
|
assert message is not None
|
|
return CommandContext(
|
|
message=message,
|
|
group_id=WATCHED_GROUP,
|
|
transport=transport,
|
|
store=store,
|
|
config=config,
|
|
command_name="pope",
|
|
now=100.0,
|
|
day="2026-08-30",
|
|
)
|
|
|
|
|
|
async def test_reply_image_defaults_to_no_caption(store: Store, config: Config) -> None:
|
|
transport = FakeTransport()
|
|
await _ctx(transport, store, config).reply_image("Zm9v")
|
|
assert transport.sent[0].caption == ""
|
|
|
|
|
|
async def test_reply_image_passes_the_caption_through(store: Store, config: Config) -> None:
|
|
"""The caption rides in the same payload, so Signal shows one message."""
|
|
transport = FakeTransport()
|
|
await _ctx(transport, store, config).reply_image("Zm9v", "8. Telesfor")
|
|
sent = transport.sent[0]
|
|
assert sent.caption == "8. Telesfor"
|
|
assert sent.image_base64 == "Zm9v"
|
|
assert sent.quote is not None
|
|
|
|
|
|
async def _nothing(ctx: CommandContext) -> None:
|
|
"""A handler that does nothing, for tests about resolution only."""
|
|
|
|
|
|
def test_a_command_with_no_groups_exists_everywhere() -> None:
|
|
registry = CommandRegistry()
|
|
command = registry.register("open", ["!open"], _nothing, "everywhere")
|
|
assert command.allowed_in("group-a==")
|
|
assert registry.resolve_with_args("!open", "group-b==") is not None
|
|
|
|
|
|
def test_a_scoped_command_does_not_exist_elsewhere() -> None:
|
|
"""Not refused -- absent. A refusal would announce that it exists."""
|
|
registry = CommandRegistry()
|
|
registry.register("shy", ["!shy"], _nothing, "here only", groups=frozenset({"group-a=="}))
|
|
assert registry.resolve_with_args("!shy", "group-a==") is not None
|
|
assert registry.resolve_with_args("!shy", "group-b==") is None
|
|
|
|
|
|
def test_words_after_a_trigger_are_arguments_only_where_they_are_wanted() -> None:
|
|
""" "!cat blah" has always resolved to nothing, and still does."""
|
|
registry = CommandRegistry()
|
|
registry.register("plain", ["!plain"], _nothing, "no arguments")
|
|
registry.register("takes", ["!takes"], _nothing, "arguments", takes_args=True)
|
|
assert registry.resolve_with_args("!plain blah", "g==") is None
|
|
resolved = registry.resolve_with_args("!takes one two", "g==")
|
|
assert resolved is not None
|
|
assert resolved.args == ("one", "two")
|
|
|
|
|
|
def test_a_bare_trigger_has_no_arguments() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("takes", ["!takes"], _nothing, "arguments", takes_args=True)
|
|
resolved = registry.resolve_with_args("!takes", "g==")
|
|
assert resolved is not None
|
|
assert resolved.args == ()
|
|
|
|
|
|
def test_nothing_resolves_out_of_an_empty_message() -> None:
|
|
registry = CommandRegistry()
|
|
registry.register("takes", ["!takes"], _nothing, "arguments", takes_args=True)
|
|
assert registry.resolve_with_args(None, "g==") is None
|
|
assert registry.resolve_with_args(" ", "g==") is None
|
|
assert registry.resolve_with_args("!nobody has this", "g==") is None
|
|
|
|
|
|
def test_triggers_in_returns_only_what_this_group_actually_has() -> None:
|
|
"""What the near-miss search reads.
|
|
|
|
Scoped rather than global, and that is the whole point: a command
|
|
another group owns must not be offerable as a suggestion here, because
|
|
offering it would name it.
|
|
"""
|
|
registry = CommandRegistry()
|
|
everywhere = registry.register("cat", ["!kot", "!cat"], _noop, "kot")
|
|
scoped = registry.register("pack:p1", ["!alfa"], _noop, "zdjęcia", groups=frozenset({"g1"}))
|
|
here = registry.triggers_in("g1")
|
|
assert here == {"!kot": everywhere, "!cat": everywhere, "!alfa": scoped}
|
|
assert registry.triggers_in("g2") == {"!kot": everywhere, "!cat": everywhere}
|
|
|
|
|
|
def test_triggers_in_maps_a_folded_trigger_to_its_command() -> None:
|
|
"""Folded, so both sides of a comparison went through the same function."""
|
|
registry = CommandRegistry()
|
|
registry.register("pope", ["!papież"], _noop, "papież")
|
|
assert set(registry.triggers_in("g1")) == {"!papiez"}
|