mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-10 19:27:20 +01:00
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
151 lines
4.6 KiB
Python
151 lines
4.6 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""Application wiring and the ASGI entrypoint."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import contextlib
|
|
import datetime as dt
|
|
import logging
|
|
from dataclasses import dataclass, field
|
|
from typing import TYPE_CHECKING
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import AsyncIterator
|
|
|
|
from signal_bot.transport_base import Transport
|
|
|
|
import httpx
|
|
from fastapi import FastAPI
|
|
|
|
from signal_bot.animals import register_animal_commands
|
|
from signal_bot.config import Config, load_config
|
|
from signal_bot.counting import format_tally
|
|
from signal_bot.decorators import cooldown
|
|
from signal_bot.dispatcher import Dispatcher
|
|
from signal_bot.http_client import ImageFetcher
|
|
from signal_bot.registry import CommandRegistry
|
|
from signal_bot.scheduler import DailyScheduler
|
|
from signal_bot.store import Store
|
|
from signal_bot.transport_rest import RestTransport
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
COOLDOWN_MESSAGE = "BEEP BOOP POCZEKAJ {seconds} SEKUND."
|
|
HTTP_TIMEOUT_SECONDS = 30.0
|
|
|
|
|
|
def now_local() -> dt.datetime:
|
|
"""Current local time, timezone-aware."""
|
|
return dt.datetime.now().astimezone()
|
|
|
|
|
|
@dataclass
|
|
class Bot:
|
|
"""The wired-up bot and its two long-running loops."""
|
|
|
|
config: Config
|
|
store: Store
|
|
transport: Transport
|
|
dispatcher: Dispatcher
|
|
|
|
async def publish_report(self) -> None:
|
|
"""Post the tally to the reply group and reset it."""
|
|
rows = [(t.display_name or t.uuid, t.count) for t in self.store.tallies()]
|
|
await self.transport.send_text(format_tally(rows), self.config.group_id_send)
|
|
self.store.reset_tallies()
|
|
|
|
async def listen(self) -> None:
|
|
"""Consume frames forever, handing each to the dispatcher."""
|
|
async for frame in self.transport.receive():
|
|
await self.dispatcher.handle(frame)
|
|
|
|
|
|
def build_bot(config: Config, client: httpx.AsyncClient, store: Store, transport: Transport) -> Bot:
|
|
"""Assemble the object graph from its injected dependencies."""
|
|
registry = CommandRegistry()
|
|
register_animal_commands(
|
|
registry,
|
|
ImageFetcher(client),
|
|
decorate=cooldown(config.cooldown_seconds, COOLDOWN_MESSAGE),
|
|
endpoints={"cat": config.cat_api_url, "dog": config.dog_api_url},
|
|
)
|
|
dispatcher = Dispatcher(
|
|
config=config,
|
|
registry=registry,
|
|
store=store,
|
|
transport=transport,
|
|
clock=now_local,
|
|
)
|
|
return Bot(config=config, store=store, transport=transport, dispatcher=dispatcher)
|
|
|
|
|
|
@dataclass
|
|
class Runtime:
|
|
"""Owns everything that must be torn down when the app stops."""
|
|
|
|
bot: Bot
|
|
client: httpx.AsyncClient
|
|
store: Store
|
|
tasks: list[asyncio.Task[None]] = field(default_factory=list)
|
|
|
|
def start(self) -> None:
|
|
"""Spawn the listener and the daily scheduler as background tasks."""
|
|
scheduler = DailyScheduler(
|
|
self.bot.config.report_hour,
|
|
self.bot.config.report_minute,
|
|
self.bot.publish_report,
|
|
now_local,
|
|
asyncio.sleep,
|
|
)
|
|
self.tasks = [
|
|
asyncio.create_task(self.bot.listen()),
|
|
asyncio.create_task(scheduler.run()),
|
|
]
|
|
|
|
async def stop(self) -> None:
|
|
"""Cancel the background tasks and close every resource."""
|
|
for task in self.tasks:
|
|
task.cancel()
|
|
for task in self.tasks:
|
|
with contextlib.suppress(asyncio.CancelledError):
|
|
await task
|
|
await self.client.aclose()
|
|
self.store.close()
|
|
|
|
|
|
async def create_runtime(config: Config, client: httpx.AsyncClient) -> Runtime:
|
|
"""Build a Runtime, verifying the container exposes a WebSocket first."""
|
|
store = Store(config.database_path)
|
|
transport = RestTransport(config, client)
|
|
await transport.verify_mode()
|
|
return Runtime(bot=build_bot(config, client, store, transport), client=client, store=store)
|
|
|
|
|
|
@contextlib.asynccontextmanager
|
|
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
|
|
"""Start the background tasks without blocking ASGI startup.
|
|
|
|
The previous version awaited asyncio.gather() on two infinite tasks inside
|
|
an on_event("startup") handler, so uvicorn never finished starting up and
|
|
the HTTP app never began serving.
|
|
"""
|
|
config = load_config()
|
|
client = httpx.AsyncClient(timeout=HTTP_TIMEOUT_SECONDS)
|
|
runtime = await create_runtime(config, client)
|
|
runtime.start()
|
|
app.state.runtime = runtime
|
|
try:
|
|
yield
|
|
finally:
|
|
await runtime.stop()
|
|
|
|
|
|
app = FastAPI(lifespan=lifespan)
|
|
|
|
|
|
@app.get("/healthz")
|
|
async def healthz() -> dict[str, str]:
|
|
"""Liveness probe. The old app defined no routes at all."""
|
|
return {"status": "ok"}
|