mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-10 18:07:29 +01:00
Krzysztof kuhy Rudnicki
6bde3493a4
The bot did not work. `run.sh` started a FastAPI app whose
`@app.on_event("startup")` awaited `asyncio.gather()` on two infinite
tasks, so uvicorn never finished starting up and no HTTP was ever served;
the readme's `python main.py` was a no-op with no `__main__` block and no
`uvicorn.run()` call. All three CI workflows were red, one referencing an
`environment.yml` that does not exist.
Rewritten as a package behind an injectable transport seam, which is what
makes the offline environment possible.
Bugs fixed:
- startup deadlock: lifespan spawns the loops instead of awaiting them
- sticker filter read dataMessage.sticker even on syncMessage envelopes, so
the account's own stickers were never filtered (e038772, 53028cc, 07fa90d,
2416cef all fought this symptom)
- no websocket reconnect: a container restart killed the bot silently
- blocking `requests` inside async functions stalled the event loop
- every counted message DMed the whole tally to the bot itself
- images were written to CWD under a filename taken from the remote URL
- one global 10s cooldown shared across all users and commands
- dead code: RECEIVE_URL, get_attachments (no call site), USER_MESSAGE_COUNT
- .env.sample declared PRIMARY/SECONDARY_PHONE_NUMBER and MODE, none read
Scoping is now an enforced invariant. A linked device receives every DM and
every group on the account; GROUP_ID was the only thing narrowing that and
defaulted to "". Config refuses to start unscoped, direct messages are
dropped explicitly rather than by a falsy check, and a scenario asserts that
DMs and other groups produce zero outbound messages.
Offline environment: fake_signal/ serves the real protocol surface, so the
unmodified bot connects to it by pointing API_BASE_URL at it. scripts/e2e.sh
boots both, replays 7 scenarios and exits non-zero on mismatch. A local
Signal server is not achievable (signal-cli compiles its endpoints and trust
store in; Signal-Server needs FoundationDB), so faking this boundary is the
only way to test every feature without an account.
Transport pinned to bbernhard/signal-cli-rest-api:0.100 with
MODE=json-rpc-native. The readme pinned 0.167-dev; the dev tag series counts
separately, so that was older than 0.100, not newer. /v1/receive is only a
WebSocket in a json-rpc mode, so the mode is verified at startup.
Repo standards: ruff select=ALL, mypy --strict, 189 tests at 100% branch
coverage, 250-line cap, exact pins at newest stable, shared gates delegated
to ~/utils, one CI workflow replacing three red ones. No noqa, no
type: ignore, no coverage omits anywhere.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013yaBT45KhHqxTKVCTA87iy
127 lines
3.8 KiB
Python
127 lines
3.8 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""Routing: scoping, counting, dispatch and error containment."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import datetime as dt
|
|
from typing import TYPE_CHECKING
|
|
|
|
import pytest
|
|
|
|
from signal_bot.dispatcher import Dispatcher
|
|
from signal_bot.registry import CommandContext, CommandRegistry
|
|
from tests.conftest import OTHER_GROUP, envelope
|
|
|
|
if TYPE_CHECKING:
|
|
from signal_bot.config import Config
|
|
from signal_bot.store import Store
|
|
from signal_bot.transport_fake import FakeTransport
|
|
|
|
NOW = dt.datetime(2026, 8, 29, 12, 0, tzinfo=dt.UTC)
|
|
|
|
|
|
@pytest.fixture
|
|
def runs() -> list[str]:
|
|
return []
|
|
|
|
|
|
@pytest.fixture
|
|
def registry(runs: list[str]) -> CommandRegistry:
|
|
async def handler(ctx: CommandContext) -> None:
|
|
runs.append(ctx.command_name)
|
|
|
|
reg = CommandRegistry()
|
|
reg.register("cat", ["!cat"], handler)
|
|
return reg
|
|
|
|
|
|
@pytest.fixture
|
|
def dispatcher(
|
|
config: Config, registry: CommandRegistry, store: Store, transport: FakeTransport
|
|
) -> Dispatcher:
|
|
return Dispatcher(
|
|
config=config,
|
|
registry=registry,
|
|
store=store,
|
|
transport=transport,
|
|
clock=lambda: NOW,
|
|
)
|
|
|
|
|
|
async def test_counts_a_plain_group_message(dispatcher: Dispatcher, store: Store) -> None:
|
|
await dispatcher.handle(envelope(text="hello"))
|
|
assert store.tallies()[0].count == 1
|
|
|
|
|
|
async def test_runs_a_command_and_records_the_use(
|
|
dispatcher: Dispatcher, store: Store, runs: list[str]
|
|
) -> None:
|
|
await dispatcher.handle(envelope(text="!cat"))
|
|
assert runs == ["cat"]
|
|
assert store.last_used("uuid-alice", "cat") == NOW.timestamp()
|
|
assert store.uses_today("uuid-alice", "cat", "2026-08-29") == 1
|
|
|
|
|
|
async def test_direct_messages_are_never_handled(
|
|
dispatcher: Dispatcher, store: Store, runs: list[str], transport: FakeTransport
|
|
) -> None:
|
|
"""A linked device sees every DM on the account; none may reach a handler."""
|
|
await dispatcher.handle(envelope(text="!cat", group_id=None))
|
|
assert runs == []
|
|
assert store.tallies() == []
|
|
assert transport.sent == []
|
|
|
|
|
|
async def test_other_groups_are_never_handled(
|
|
dispatcher: Dispatcher, store: Store, runs: list[str]
|
|
) -> None:
|
|
await dispatcher.handle(envelope(text="!cat", group_id=OTHER_GROUP))
|
|
assert runs == []
|
|
assert store.tallies() == []
|
|
|
|
|
|
async def test_unparseable_frames_are_dropped(dispatcher: Dispatcher, store: Store) -> None:
|
|
await dispatcher.handle("not json")
|
|
assert store.tallies() == []
|
|
|
|
|
|
async def test_stickers_are_not_counted(dispatcher: Dispatcher, store: Store) -> None:
|
|
await dispatcher.handle(envelope(text="hi", sticker=True, sync=True))
|
|
assert store.tallies() == []
|
|
|
|
|
|
async def test_reactions_are_not_counted(dispatcher: Dispatcher, store: Store) -> None:
|
|
await dispatcher.handle(envelope(text="hi", reaction=True))
|
|
assert store.tallies() == []
|
|
|
|
|
|
async def test_non_command_text_runs_nothing(dispatcher: Dispatcher, runs: list[str]) -> None:
|
|
await dispatcher.handle(envelope(text="just chatting"))
|
|
assert runs == []
|
|
|
|
|
|
async def test_a_failing_command_does_not_kill_the_loop(
|
|
config: Config, store: Store, transport: FakeTransport
|
|
) -> None:
|
|
async def boom(ctx: CommandContext) -> None:
|
|
msg = "upstream is down"
|
|
raise RuntimeError(msg)
|
|
|
|
registry = CommandRegistry()
|
|
registry.register("cat", ["!cat"], boom)
|
|
dispatcher = Dispatcher(
|
|
config=config,
|
|
registry=registry,
|
|
store=store,
|
|
transport=transport,
|
|
clock=lambda: NOW,
|
|
)
|
|
await dispatcher.handle(envelope(text="!cat"))
|
|
# The use is not recorded, so the cooldown does not punish a failed run.
|
|
assert store.last_used("uuid-alice", "cat") is None
|
|
|
|
|
|
async def test_command_message_is_also_counted(dispatcher: Dispatcher, store: Store) -> None:
|
|
await dispatcher.handle(envelope(text="!cat"))
|
|
assert store.tallies()[0].count == 1
|