signal-bot/signal_bot/scheduler.py
Krzysztof kuhy Rudnicki 6bde3493a4 feat: rewrite the bot so it runs, and gate it like the other repos
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
2026-08-29 13:05:42 +02:00

67 lines
2.0 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""The daily tally report.
Time is injected so the tests assert on the computed interval instead of
sleeping through it.
"""
from __future__ import annotations
import datetime as dt
import logging
from collections.abc import Awaitable, Callable
logger = logging.getLogger(__name__)
Clock = Callable[[], dt.datetime]
Sleeper = Callable[[float], Awaitable[None]]
Action = Callable[[], Awaitable[None]]
SECONDS_PER_DAY = 24 * 60 * 60
class DailyScheduler:
"""Runs one action at a fixed local wall-clock time, every day."""
def __init__(
self,
hour: int,
minute: int,
action: Action,
clock: Clock,
sleeper: Sleeper,
) -> None:
"""Store the target time, the action, and the injected time sources."""
self._hour = hour
self._minute = minute
self._action = action
self._clock = clock
self._sleep = sleeper
def seconds_until_next(self, now: dt.datetime) -> float:
"""Seconds from now until the next occurrence of the target time.
Rolls over to tomorrow when today's target has already passed, so the
result is always strictly positive.
"""
target = now.replace(hour=self._hour, minute=self._minute, second=0, microsecond=0)
if target <= now:
target += dt.timedelta(days=1)
return (target - now).total_seconds()
async def run(self, iterations: int | None = None) -> None:
"""Sleep until the target time and run the action, forever by default.
Args:
iterations: Stop after this many runs. None means run forever.
The tests use a finite count; production passes None.
"""
completed = 0
while iterations is None or completed < iterations:
await self._sleep(self.seconds_until_next(self._clock()))
try:
await self._action()
except Exception:
logger.exception("daily report failed")
completed += 1