signal-bot/signal_bot/roster.py
Krzysztof kuhy Rudnicki dc1995b558 feat: the message event log, and the nightly report built on it
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
2026-08-30 19:14:43 +02:00

62 lines
2.4 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""Who is in a group, according to the last listing that actually arrived.
The nightly report shows a 0 next to people who said nothing, and the event
log cannot supply them: somebody who has never written has no events. Only the
group listing knows, and it is fetched, not stored -- so this is a cache of a
live answer, deliberately held in memory. A roster persisted to the database
would outlive the truth, and the failure mode of a stale roster is naming
somebody who left.
Kept out of ``discovery`` because that module was two lines under the 250-line
cap, and because "who may the bot watch" and "who is in the room" are separate
questions that happen to be answered by the same HTTP response.
"""
from __future__ import annotations
from collections.abc import Callable
from typing import Any
from signal_bot.trust import identities
Permitted = Callable[[dict[str, Any]], "str | None"]
class RosterCache:
"""Each watched group's membership, from the last good listing."""
def __init__(self, own_number: str) -> None:
"""Wire the cache to the bot's own number, which it excludes.
Args:
own_number: The account's +E.164 number. The bot is a member of
every group it watches, and counting itself as a silent
participant would put the bot in its own report.
"""
self._own = own_number
self._members: dict[str, frozenset[str]] = {}
def remember(self, entries: list[dict[str, Any]], permitted: Permitted) -> None:
"""Stash the membership of every permitted group in a listing.
Pending invitees are excluded: they cannot have written anything, so
listing them as silent members would be wrong rather than merely
noisy.
"""
for entry in entries:
group_id = permitted(entry)
if group_id is None:
continue
members = identities(entry, "members") - identities(entry, "pending_invites")
self._members[group_id] = frozenset(members - {self._own})
def identities(self, group_id: str) -> frozenset[str]:
"""One group's members, or empty for a group no listing has covered.
A mix of ACI uuids and +E.164 numbers -- the listing uses whichever
spelling it has for a given person, which is why the event store
matches on both.
"""
return self._members.get(group_id, frozenset())