mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-12 08:31:06 +01:00
Krzysztof kuhy Rudnicki
d5c63b423b
Today the bot was up, healthy and answering nothing for three hours. A host
firewall change (fixed in testsAndMisc 334c0cd9) cut every Docker container
off the internet; signal-cli lost Signal and reconnected in a loop from
15:32:50 onward. Nothing noticed:
- the container's own healthcheck answered 204
- /v1/groups answered 200 out of local state, so discovery saw no change
- the bot's WebSocket to the container stayed OPEN, so the transport's
reconnect logic never fired
- /healthz answered {"status": "ok"} the entire time
The only symptom was silence, which is also what a quiet evening looks like.
signal_bot/liveness.py asks the one question that cannot be answered from a
cache -- GET /v1/devices, which needs a live round trip -- but only after
SILENCE_SECONDS (120) with no frame of any kind, so a busy group costs
nothing and an idle one costs one request per window. Three consecutive
failures and /healthz answers 503 with the reason. Verified end to end in
scripts/e2e.sh against the real process: 503 after 84s with the fake's
connection cut, back to 200 on its own 30s after restoring it.
scripts/signal_api_watchdog.sh + a two-minute user timer do the recovery the
bot cannot do for itself, since a wedged bot cannot restart the container it
depends on. Two tiers, so the steady state costs no Signal round trip at
all: the bot's own /healthz first, the authenticated probe only when that is
not 200. It stops after 3 restarts in 6 hours and escalates instead -- a
deregistered account or a blocked network is not fixable by restarting, and
a restart loop would hide it. Its own bash suite stubs curl and docker and
drives every branch including the give-up cap.
signal_bot/trust.py answers the other half: TRUSTED_INVITERS decides who may
put this bot in a group. The gate sits in GroupDirectory._permitted, which
both _join_pending and _adopt already route through -- gating only invites
would gate the door nobody uses, since prime_profile.sh exists precisely so
that an add becomes a direct join. Evidence is either the group-update
envelope, which is the only frame naming an inviter, or a trusted identity
being a full member in the listing. A refusal is logged once, with that
group's members, so the operator can see which string to add.
verify_allowlist moved to membership.py to keep discovery.py under the
250-line gate; it was already the module that owns MembershipError.
Verified live, by stopping the container by hand and touching nothing else:
18:54:35 docker stop signal-api
18:56:36 liveness: failure 1 of 3 after 123s of silence
18:57:36 failure 3 of 3 -> /healthz answers 503 from 18:57:45
18:58:18 watchdog: probe failed (1/2)
19:00:28 watchdog: probe failed (2/2) -> docker restart signal-api
19:00:36 liveness: receive path recovered after 8 failed probe(s)
19:01:13 watchdog: signal-api is back
Six minutes, unattended, against three hours of silence this afternoon. All
four real groups are still adopted with TRUSTED_INVITERS=+48123456789 set,
and no group was refused.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KbjfWdAyHbCubac7wJKJZW
83 lines
3.0 KiB
Python
83 lines
3.0 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""The injector's control plane. Not part of the real API."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from fastapi import APIRouter, Request
|
|
|
|
if TYPE_CHECKING:
|
|
from fake_signal.state import State
|
|
|
|
|
|
def _state(request: Request) -> State:
|
|
"""Return the State attached to the running app."""
|
|
state: State = request.app.state.fake
|
|
return state
|
|
|
|
|
|
def build_control_router() -> APIRouter:
|
|
"""Build the router the scenario injector drives."""
|
|
router = APIRouter(prefix="/_control")
|
|
|
|
@router.post("/inject")
|
|
async def inject(request: Request, frame: dict[str, Any]) -> dict[str, int]:
|
|
delivered = 0
|
|
for socket in list(_state(request).sockets):
|
|
await socket.send_text(str(frame["raw"]))
|
|
delivered += 1
|
|
return {"delivered": delivered}
|
|
|
|
@router.post("/connection")
|
|
async def set_connection(request: Request, body: dict[str, Any]) -> dict[str, bool]:
|
|
"""Cut or restore signal-cli's connection to Signal."""
|
|
state = _state(request)
|
|
state.connection_alive = bool(body.get("alive", True))
|
|
return {"alive": state.connection_alive}
|
|
|
|
@router.post("/groups")
|
|
async def set_groups(request: Request, groups: list[dict[str, Any]]) -> dict[str, int]:
|
|
"""Replace the group list, so the group picker can be rehearsed offline."""
|
|
state = _state(request)
|
|
state.groups.clear()
|
|
state.groups.extend(groups)
|
|
return {"groups": len(state.groups)}
|
|
|
|
@router.post("/groups/add")
|
|
async def add_groups(request: Request, groups: list[dict[str, Any]]) -> dict[str, int]:
|
|
"""Add groups without disturbing the existing ones.
|
|
|
|
Additive on purpose. A scenario that declares only the group it
|
|
cares about would otherwise silently remove the others -- and with
|
|
the bot dropping a departed group's rows, that would delete state
|
|
every later scenario in the same process depends on.
|
|
"""
|
|
state = _state(request)
|
|
known = {group.get("id") for group in state.groups}
|
|
state.groups.extend(group for group in groups if group.get("id") not in known)
|
|
return {"groups": len(state.groups)}
|
|
|
|
@router.post("/accounts")
|
|
async def set_accounts(request: Request, accounts: list[str]) -> dict[str, int]:
|
|
"""Seed the registered accounts, so /v1/groups answers at all."""
|
|
state = _state(request)
|
|
state.accounts.clear()
|
|
state.accounts.extend(accounts)
|
|
return {"accounts": len(state.accounts)}
|
|
|
|
@router.get("/sent")
|
|
async def captured(request: Request) -> list[dict[str, Any]]:
|
|
return list(_state(request).sent)
|
|
|
|
@router.post("/reset")
|
|
async def reset(request: Request) -> dict[str, str]:
|
|
_state(request).reset()
|
|
return {"status": "ok"}
|
|
|
|
@router.get("/ready")
|
|
async def ready(request: Request) -> dict[str, int]:
|
|
return {"sockets": len(_state(request).sockets)}
|
|
|
|
return router
|