signal-bot/signal_bot/manage/app.py
Krzysztof kuhy Rudnicki 72e90acb47
Some checks are pending
CI / check (push) Waiting to run
CI / web (push) Waiting to run
Let the operator add aliases from the Commands tab
A custom alias is data the command table is built from, so it cannot be a
live switch like the ones already on the tab. Instead the management page
writes aliases_custom.json in the bot's state directory and then asks the
bot to reload, in one step: whenever the answer is anything but `reloaded`
-- a word another command has, a name no command has, a bot still
connecting -- the file is restored byte for byte and the bot's own reason is
shown next to the field. What is on disk is therefore always what the bot
serves, and a typo cannot sit in the file poisoning every later reload.

The registry appends the operator's words to the shipped list at
registration, which keeps `!pomoc` on the shipped spelling and routes the
new words through the same clash check as aliases.json. An alias for a name
no command has fails the whole build (ConfigError -> `kept`), because a
silently ignored entry is how a file drifts. The tagger treats custom
aliases as reserved words too, so a person cannot be given one.

registry.py crossed the 250-line cap and now re-exports the record and the
error types from command.py; the bot's state directory lookup, previously
duplicated in pack.py and the suggestions export, is state_dir.py.

Proven end to end: !e2ekot is unknown, the file is written and reload.sh
runs, !e2ekot posts a cat, a file naming a command that does not exist is
refused with 409 and the previous table still answers.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-09-04 16:20:05 +02:00

62 lines
2.0 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""The management application, assembled.
A second process rather than more routes on the bot's own app. Two reasons,
and both are about blast radius: this one can rewrite ``.env``, and the bot's
port already serves ``/_selftest``, which posts for real into a real group.
Keeping them apart means the surface that can reconfigure the bot is only
listening while somebody has the page open.
Order is load-bearing. The guard goes on first so it sees every request; the
API routers are registered next; the static catch-all is registered last,
because ``/{path:path}`` would otherwise shadow every route after it.
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from fastapi import FastAPI
from signal_bot.manage import (
assets,
guard,
routes_actions,
routes_album,
routes_aliases,
routes_analytics,
routes_commands,
routes_env,
routes_status,
routes_suggestions,
)
if TYPE_CHECKING:
from signal_bot.manage.deps import ManageDeps
DEFAULT_CONTAINER = "signal-api"
def build_app(deps: ManageDeps, *, container: str = DEFAULT_CONTAINER) -> FastAPI:
"""The whole page, bound to one bot and one album.
Args:
deps: Everything the app is pointed at.
container: The docker container signal-cli runs in.
Returns:
An application ready for uvicorn, or for a test client.
"""
app = FastAPI(title="signal-bot", docs_url=None, redoc_url=None, openapi_url=None)
guard.install(app, deps.port)
app.include_router(routes_status.router(deps))
app.include_router(routes_env.router(deps))
app.include_router(routes_actions.router(deps, container))
app.include_router(routes_album.router(deps))
app.include_router(routes_suggestions.router(deps))
app.include_router(routes_analytics.router(deps))
app.include_router(routes_commands.router(deps))
app.include_router(routes_aliases.router(deps))
assets.install(app, deps.dist_dir)
return app