mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-10 20:27:17 +01:00
Krzysztof kuhy Rudnicki
dc1995b558
The tally was one integer per person, deleted after each post. Nothing dated survived it, so weeks, months, records, streaks and weekday averages were all unanswerable. This replaces it with an append-only per-message log holding metadata only -- never a message body -- and rebuilds the nightly report on top. What changes for the group: a photo posted without a caption now counts (it was worth zero), stickers count, the bot's own messages no longer do, people who said nothing appear with a 0, and the report covers the previous full calendar day in Europe/Warsaw instead of "since the last post" -- which used to merge two days whenever a group went quiet. Notable decisions, each with the trap it avoids: - Events and people are PERMANENT_TABLES: neither forget_group nor a future SCHEMA_VERSION bump may drop them. Both paths used to cost a day's counter and would now cost the entire history, and forget_group fires on a listing that merely omits members. - is_own comes from which envelope branch carried the payload, not from comparing identities. The account is spelled as a uuid on some frames and a +E.164 number on others, so any comparison misses one of them. - The roster is stashed in refresh(), not _adopt(), which returns early once the watched set stops changing -- i.e. always, in the steady state. - The roster matches on uuid OR number because /v1/groups spells kuhy as +48123456789 while his messages carry an ACI uuid. Joining on uuid alone would have listed him twice every night, once with 0. - Members whose display name we have never seen are counted, not named: their only spellings are a uuid or a phone number. - (group, uuid, sent_at_ms) is the primary key, so a websocket redelivery after a reconnect cannot inflate the counts. - Days come from a stored Warsaw date string, never a timestamp range: 2026-03-29 is 23 hours long and 2026-10-25 is 25. - Polish number agreement is a real rule with a 12-14 exception, so "44 znaki" and "45 znaków" are both spelled correctly. config.py and startup.py were two lines under the 250-line cap and both had to grow, so config_env and startup_retry come out of them first, as pure moves. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015d48t4qsQLBJnDwDeo2Nom
197 lines
6.9 KiB
Python
197 lines
6.9 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""The reusable gates, tested against a harmless command."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import replace
|
|
from typing import TYPE_CHECKING
|
|
|
|
import pytest
|
|
|
|
from signal_bot.decorators import cooldown, daily_limit, vote_gated
|
|
from signal_bot.models import parse_envelope
|
|
from signal_bot.registry import CommandContext, Handler
|
|
from tests.conftest import SECOND_GROUP, WATCHED_GROUP, envelope
|
|
|
|
if TYPE_CHECKING:
|
|
from signal_bot.config import Config
|
|
from signal_bot.store import Store
|
|
from signal_bot.transport_fake import FakeTransport
|
|
|
|
DAY = "2026-08-29"
|
|
|
|
|
|
def _context(
|
|
store: Store,
|
|
transport: FakeTransport,
|
|
config: Config,
|
|
*,
|
|
uuid: str = "u1",
|
|
now: float = 100.0,
|
|
group: str = WATCHED_GROUP,
|
|
) -> CommandContext:
|
|
message = parse_envelope(envelope(text="!ping", sender=(uuid, "Alice"), group_id=group))
|
|
assert message is not None
|
|
return CommandContext(
|
|
message=message,
|
|
group_id=group,
|
|
transport=transport,
|
|
store=store,
|
|
config=config,
|
|
command_name="ping",
|
|
now=now,
|
|
day=DAY,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def runs() -> list[str]:
|
|
return []
|
|
|
|
|
|
@pytest.fixture
|
|
def handler(runs: list[str]) -> Handler:
|
|
async def _handler(ctx: CommandContext) -> None:
|
|
runs.append(ctx.message.source_uuid)
|
|
|
|
return _handler
|
|
|
|
|
|
async def test_cooldown_allows_first_use(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
await cooldown(10, "wait {seconds}")(handler)(_context(store, transport, config))
|
|
assert runs == ["u1"]
|
|
|
|
|
|
async def test_cooldown_blocks_and_reports_remaining(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
store.record_use(WATCHED_GROUP, "u1", "ping", 100.0, DAY)
|
|
ctx = _context(store, transport, config, now=104.0)
|
|
await cooldown(10, "wait {seconds}")(handler)(ctx)
|
|
assert runs == []
|
|
assert transport.texts == ["wait 7"]
|
|
|
|
|
|
async def test_cooldown_expires(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
store.record_use(WATCHED_GROUP, "u1", "ping", 100.0, DAY)
|
|
await cooldown(10, "wait {seconds}")(handler)(_context(store, transport, config, now=111.0))
|
|
assert runs == ["u1"]
|
|
|
|
|
|
async def test_cooldown_is_per_user(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
"""One person's cat picture used to silence everybody."""
|
|
store.record_use(WATCHED_GROUP, "u1", "ping", 100.0, DAY)
|
|
await cooldown(10, "wait {seconds}")(handler)(
|
|
_context(store, transport, config, uuid="u2", now=101.0)
|
|
)
|
|
assert runs == ["u2"]
|
|
|
|
|
|
async def test_daily_limit_allows_under_the_cap(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
await daily_limit(1, "no more")(handler)(_context(store, transport, config))
|
|
assert runs == ["u1"]
|
|
|
|
|
|
async def test_daily_limit_blocks_at_the_cap(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
store.record_use(WATCHED_GROUP, "u1", "ping", 100.0, DAY)
|
|
await daily_limit(1, "no more, used {used}/{max_uses}")(handler)(
|
|
_context(store, transport, config)
|
|
)
|
|
assert runs == []
|
|
assert transport.texts == ["no more, used 1/1"]
|
|
|
|
|
|
async def test_vote_gate_waits_for_quorum(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
gated = vote_gated(2, 900, "{votes}/{required}")(handler)
|
|
await gated(_context(store, transport, config, uuid="u1"))
|
|
assert runs == []
|
|
assert transport.texts == ["1/2"]
|
|
|
|
|
|
async def test_vote_gate_fires_on_quorum(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
gated = vote_gated(2, 900, "{votes}/{required}")(handler)
|
|
await gated(_context(store, transport, config, uuid="u1"))
|
|
await gated(_context(store, transport, config, uuid="u2"))
|
|
assert runs == ["u2"]
|
|
|
|
|
|
async def test_repeat_vote_does_not_reach_quorum(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
gated = vote_gated(2, 900, "{votes}/{required}")(handler)
|
|
await gated(_context(store, transport, config, uuid="u1"))
|
|
await gated(_context(store, transport, config, uuid="u1", now=101.0))
|
|
assert runs == []
|
|
|
|
|
|
async def test_votes_expire_outside_the_window(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
gated = vote_gated(2, 60, "{votes}/{required}")(handler)
|
|
await gated(_context(store, transport, config, uuid="u1", now=100.0))
|
|
await gated(_context(store, transport, config, uuid="u2", now=1000.0))
|
|
assert runs == []
|
|
|
|
|
|
async def test_vote_tally_resets_after_firing(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
gated = vote_gated(2, 900, "{votes}/{required}")(handler)
|
|
await gated(_context(store, transport, config, uuid="u1"))
|
|
await gated(_context(store, transport, config, uuid="u2"))
|
|
assert store.count_votes(WATCHED_GROUP, "ping", 0.0) == 0
|
|
|
|
|
|
async def test_gates_stack(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
stacked = cooldown(10, "wait {seconds}")(daily_limit(2, "no more")(handler))
|
|
await stacked(_context(store, transport, config))
|
|
assert runs == ["u1"]
|
|
assert replace(config, cooldown_seconds=10).cooldown_seconds == 10
|
|
|
|
|
|
async def test_cooldown_is_per_group(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
"""A test-group command must not throttle the production group."""
|
|
store.record_use(WATCHED_GROUP, "u1", "ping", 100.0, DAY)
|
|
await cooldown(10, "wait {seconds}")(handler)(
|
|
_context(store, transport, config, now=101.0, group=SECOND_GROUP)
|
|
)
|
|
assert runs == ["u1"]
|
|
assert transport.texts == []
|
|
|
|
|
|
async def test_daily_limit_is_per_group(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
store.record_use(WATCHED_GROUP, "u1", "ping", 100.0, DAY)
|
|
await daily_limit(1, "no more")(handler)(_context(store, transport, config, group=SECOND_GROUP))
|
|
assert runs == ["u1"]
|
|
|
|
|
|
async def test_votes_do_not_carry_between_groups(
|
|
store: Store, transport: FakeTransport, config: Config, handler: Handler, runs: list[str]
|
|
) -> None:
|
|
"""Quorum in one group must not fire the command in another."""
|
|
gated = vote_gated(2, 900, "{votes}/{required}")(handler)
|
|
await gated(_context(store, transport, config, uuid="u1"))
|
|
await gated(_context(store, transport, config, uuid="u2", group=SECOND_GROUP))
|
|
assert runs == []
|
|
assert transport.texts == ["1/2", "1/2"]
|