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
112 lines
3.6 KiB
Python
112 lines
3.6 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""The cat and dog commands, and their data-driven aliases."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from typing import TYPE_CHECKING
|
|
|
|
import httpx
|
|
import pytest
|
|
|
|
from signal_bot.animals import (
|
|
ALIAS_FILE,
|
|
load_aliases,
|
|
register_animal_commands,
|
|
)
|
|
from signal_bot.decorators import cooldown
|
|
from signal_bot.http_client import ImageFetcher
|
|
from signal_bot.models import parse_envelope
|
|
from signal_bot.registry import CommandContext, CommandRegistry
|
|
from tests.conftest import REPLY_GROUP, envelope
|
|
|
|
if TYPE_CHECKING:
|
|
from pathlib import Path
|
|
|
|
from signal_bot.config import Config
|
|
from signal_bot.store import Store
|
|
from signal_bot.transport_fake import FakeTransport
|
|
|
|
IMAGE = b"png-bytes"
|
|
|
|
|
|
def _fetcher() -> ImageFetcher:
|
|
def handler(request: httpx.Request) -> httpx.Response:
|
|
if "thecatapi" in str(request.url):
|
|
return httpx.Response(200, json=[{"url": "https://cdn/cat.png"}])
|
|
if "dog.ceo" in str(request.url):
|
|
return httpx.Response(200, json={"message": "https://cdn/dog.png"})
|
|
return httpx.Response(200, content=IMAGE)
|
|
|
|
return ImageFetcher(httpx.AsyncClient(transport=httpx.MockTransport(handler)))
|
|
|
|
|
|
def _ctx(
|
|
transport: FakeTransport, store: Store, config: Config, name: str, text: str
|
|
) -> CommandContext:
|
|
message = parse_envelope(envelope(text=text))
|
|
assert message is not None
|
|
return CommandContext(
|
|
message=message,
|
|
recipient=REPLY_GROUP,
|
|
transport=transport,
|
|
store=store,
|
|
config=config,
|
|
command_name=name,
|
|
now=100.0,
|
|
day="2026-08-29",
|
|
)
|
|
|
|
|
|
def test_alias_file_ships_with_the_package() -> None:
|
|
assert ALIAS_FILE.is_file()
|
|
aliases = load_aliases()
|
|
assert "!cat" in aliases["cat"]
|
|
assert "!pies" in aliases["dog"]
|
|
|
|
|
|
def test_comment_keys_are_skipped(tmp_path: Path) -> None:
|
|
path = tmp_path / "a.json"
|
|
path.write_text(json.dumps({"_comment": "x", "cat": ["!cat"]}), encoding="utf-8")
|
|
assert load_aliases(path) == {"cat": ["!cat"]}
|
|
|
|
|
|
def test_styled_unicode_aliases_resolve() -> None:
|
|
registry = CommandRegistry()
|
|
register_animal_commands(registry, _fetcher())
|
|
assert registry.resolve("!\U0001d5f8\U0001d5fc\U0001d601") is not None
|
|
assert registry.resolve("!miau").name == "cat"
|
|
assert registry.resolve("!szczek").name == "dog"
|
|
|
|
|
|
@pytest.mark.parametrize(("trigger", "name"), [("!cat", "cat"), ("!dog", "dog")])
|
|
async def test_commands_post_an_image(
|
|
transport: FakeTransport, store: Store, config: Config, trigger: str, name: str
|
|
) -> None:
|
|
registry = CommandRegistry()
|
|
register_animal_commands(registry, _fetcher())
|
|
command = registry.resolve(trigger)
|
|
assert command is not None
|
|
await command.handler(_ctx(transport, store, config, name, trigger))
|
|
assert transport.sent[0].image_base64 is not None
|
|
assert transport.sent[0].recipient == REPLY_GROUP
|
|
|
|
|
|
async def test_decorator_is_applied_when_given(
|
|
transport: FakeTransport, store: Store, config: Config
|
|
) -> None:
|
|
registry = CommandRegistry()
|
|
register_animal_commands(registry, _fetcher(), decorate=cooldown(10, "wait {seconds}"))
|
|
store.record_use("uuid-alice", "cat", 100.0, "2026-08-29")
|
|
command = registry.resolve("!cat")
|
|
assert command is not None
|
|
await command.handler(_ctx(transport, store, config, "cat", "!cat"))
|
|
assert transport.texts == ["wait 11"]
|
|
|
|
|
|
def test_custom_alias_table_is_honoured() -> None:
|
|
registry = CommandRegistry()
|
|
register_animal_commands(registry, _fetcher(), aliases={"cat": ["!c"], "dog": ["!d"]})
|
|
assert registry.resolve("!c").name == "cat"
|
|
assert registry.resolve("!cat") is None
|