mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-10 21:27:16 +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
102 lines
3.2 KiB
Python
102 lines
3.2 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""Envelope parsing across both message shapes."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
|
|
import pytest
|
|
|
|
from signal_bot.models import parse_envelope
|
|
from tests.conftest import WATCHED_GROUP, envelope
|
|
|
|
|
|
def test_parses_group_data_message() -> None:
|
|
message = parse_envelope(envelope(text="!cat"))
|
|
assert message is not None
|
|
assert message.text == "!cat"
|
|
assert message.group_id == WATCHED_GROUP
|
|
assert message.source_uuid == "uuid-alice"
|
|
assert message.source_name == "Alice"
|
|
assert not message.is_direct_message
|
|
|
|
|
|
def test_parses_own_account_sync_message() -> None:
|
|
message = parse_envelope(envelope(text="!dog", sync=True))
|
|
assert message is not None
|
|
assert message.text == "!dog"
|
|
assert message.group_id == WATCHED_GROUP
|
|
|
|
|
|
@pytest.mark.parametrize("shape", [{"sync": False}, {"sync": True}])
|
|
def test_detects_sticker_in_both_shapes(shape: dict[str, bool]) -> None:
|
|
"""The original bot only ever looked under dataMessage, so its own
|
|
stickers were never filtered out of the tally."""
|
|
message = parse_envelope(envelope(sticker=True, **shape))
|
|
assert message is not None
|
|
assert message.has_sticker
|
|
|
|
|
|
@pytest.mark.parametrize("shape", [{"sync": False}, {"sync": True}])
|
|
def test_detects_reaction_in_both_shapes(shape: dict[str, bool]) -> None:
|
|
message = parse_envelope(envelope(reaction=True, **shape))
|
|
assert message is not None
|
|
assert message.is_reaction
|
|
|
|
|
|
def test_direct_message_has_no_group() -> None:
|
|
message = parse_envelope(envelope(group_id=None))
|
|
assert message is not None
|
|
assert message.group_id is None
|
|
assert message.is_direct_message
|
|
|
|
|
|
def test_missing_text_is_none() -> None:
|
|
message = parse_envelope(envelope(text=None))
|
|
assert message is not None
|
|
assert message.text is None
|
|
|
|
|
|
def test_non_string_text_is_none() -> None:
|
|
raw = json.dumps({"envelope": {"dataMessage": {"message": 42}}})
|
|
message = parse_envelope(raw)
|
|
assert message is not None
|
|
assert message.text is None
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"raw",
|
|
[
|
|
"not json at all",
|
|
json.dumps(["a", "list"]),
|
|
json.dumps({"envelope": "not a dict"}),
|
|
json.dumps({"account": "+1"}),
|
|
json.dumps({"envelope": {"receiptMessage": {"when": 1}}}),
|
|
json.dumps({"envelope": {"syncMessage": "not a dict"}}),
|
|
json.dumps({"envelope": {"syncMessage": {"readMessages": []}}}),
|
|
],
|
|
)
|
|
def test_unparseable_frames_return_none(raw: str) -> None:
|
|
assert parse_envelope(raw) is None
|
|
|
|
|
|
def test_accepts_bytes() -> None:
|
|
message = parse_envelope(envelope(text="hi").encode())
|
|
assert message is not None
|
|
assert message.text == "hi"
|
|
|
|
|
|
def test_invalid_utf8_bytes_return_none() -> None:
|
|
assert parse_envelope(b"\xff\xfe not utf8") is None
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"group_info",
|
|
["not a dict", {"type": "DELIVER"}, {"groupId": ""}, {"groupId": 12}],
|
|
)
|
|
def test_malformed_group_info_reads_as_direct_message(group_info: object) -> None:
|
|
raw = json.dumps({"envelope": {"dataMessage": {"message": "hi", "groupInfo": group_info}}})
|
|
message = parse_envelope(raw)
|
|
assert message is not None
|
|
assert message.is_direct_message
|