Files
PacketStation/server/packetstation/main.py
T
spencermandClaude Fable 5.1 39a4eb5213
ci / frontend (push) Successful in 30s
ci / server (push) Successful in 4m30s
ci / image (push) Successful in 35s
ci / e2e (push) Successful in 1m40s
Phase 4: Warehouse screen, pull table, shorts, MTRs and the upload pipeline
The Warehouse home with the numbers, the Open shorts table, the find bar and the five-column task board
(waiting, being pulled, on hold, pulled, released in the last 3 days) with buttons, hold reasons and drag.
Every role sees the warehouse stage on a packet as the WH pill and the line under it. The pull table on the
Materials tab: Pulled with auto-start, issued, location, heat with Enter to the next line, shorts with
receipts, N/A, MTR per line with a viewer. Send back to Clerical with a reason. Release to supervisor stays
blocked until every line is pulled or short and every pulled line has a heat.

Server: the heats_recorded precondition on WH_RELEASE, receive by custody, server-validated hold and short
reasons, the old packet history texts, GET /api/warehouse/board, cards with the warehouse stage and pull
counts. Uploads typed by content per kind (drawing, mtr, document, bom with XLSX and CSV), limits per kind,
optional ClamAV behind the clamav compose profile, a storage quota alert on the new notification_events
table (migration 0005) shown on the Admin Storage tab.

Tests: every warehouse action as every role, the release gate, the short-receive exception, the heat
pattern, upload sniffing and limits, the ClamAV path with a fake scanner, the quota alert; frontend board
and pull table tests; Playwright scenarios for the board and the pull flow. Verified on docker-1 in the CI
stack: 3557 server tests, 106 frontend tests, 17 Playwright scenarios. Docs updated; D5 closed.

Co-Authored-By: Claude Fable 5.1 <[email protected]>
2026-10-16 17:13:31 -06:00

190 lines
6.2 KiB
Python

"""The FastAPI app. `packetstation.main:app` is built on first access so imports need no settings."""
from __future__ import annotations
import asyncio
import contextlib
import importlib
import logging
from collections.abc import AsyncIterator
from pathlib import Path
from typing import Any
from fastapi import FastAPI
from fastapi.responses import FileResponse, HTMLResponse, JSONResponse, Response
from starlette.concurrency import run_in_threadpool
from . import db, guard
from .api import errors as api_errors
from .api.origin import OriginCheckMiddleware
from .auth.ldap import DirectoryProtocol
from .events import EventHub
from .proxy import TrustedProxies, TrustedProxyMiddleware
from .security import RequestLogMiddleware, SecurityHeadersMiddleware
from .settings import Settings, get_settings
log = logging.getLogger(__name__)
PLACEHOLDER = """<!doctype html>
<html lang="en"><head><meta charset="utf-8"><title>Packet Station</title></head>
<body><h1>Packet Station</h1><p>The web client is not built into this image (STATIC_DIR missing).</p></body></html>
"""
NO_FALLBACK = ("api", "_blob")
def _static_file(static_dir: Path, path: str) -> Path | None:
"""The file under static_dir for a URL path, or None. Never escapes static_dir."""
if not path:
return None
root = static_dir.resolve()
candidate = (root / path).resolve()
if not candidate.is_relative_to(root) or not candidate.is_file():
return None
return candidate
def _load_departments(s: Settings) -> None:
"""Rebuild the group map from the departments table; the built-in seed stays when the DB is not there."""
from .auth import groups
try:
with db.connect_as("app", s, autocommit=True) as conn:
deps = groups.load_departments(conn)
except Exception as e:
log.warning("group map from the built-in departments (database: %s)", type(e).__name__)
return
if deps:
groups.use_departments(deps)
def create_app(
settings: Settings | None = None, *, run_guard: bool = True, directory: DirectoryProtocol | None = None
) -> FastAPI:
s = settings or get_settings()
if run_guard:
guard.startup_checks(s)
trusted = TrustedProxies(s.trusted_proxy_host)
hub = EventHub(connect=lambda: db.connect_as("app", s, autocommit=True))
@contextlib.asynccontextmanager
async def lifespan(_: FastAPI) -> AsyncIterator[None]:
await asyncio.to_thread(trusted.refresh)
task = asyncio.create_task(trusted.run()) if trusted.host else None
deps_task = asyncio.create_task(asyncio.to_thread(_load_departments, s))
hub.start() # connects in its own thread and retries with backoff; never blocks startup
log.info("packetstation app starting", extra={"ps": {"build": s.ps_build, "stack": s.stack}})
try:
yield
finally:
if task:
task.cancel()
deps_task.cancel()
await asyncio.to_thread(hub.stop)
await run_in_threadpool(db.close_pool)
app = FastAPI(
title="Packet Station", version=s.ps_build, lifespan=lifespan, docs_url=None, redoc_url=None, openapi_url=None
)
app.state.settings = s
app.state.trusted = trusted
app.state.directory = directory # None: built from settings on first use
app.state.events = hub
app.state.session_key = None
app.state.groups_cache = None
api_errors.install(app)
from .api import (
account,
admin,
assets,
auth,
departments,
feed_settings,
jobs,
packet_children,
packets,
projects,
units,
warehouse,
)
from .api import events as events_api
# Routers go in before the static catch-all below, which answers every other GET.
for module in (
auth,
account,
admin,
departments,
events_api,
projects,
units,
packets,
packet_children,
assets,
jobs,
feed_settings,
warehouse,
):
app.include_router(module.router)
app.include_router(assets.blob_router)
for name in ("feed", "packet_visual"):
modname = f"{__package__}.api.{name}"
try:
extra = importlib.import_module(modname)
except ModuleNotFoundError as e:
if e.name != modname:
raise
log.warning("router api.%s not there yet; not loaded", name)
continue
app.include_router(extra.router)
@app.get("/healthz")
def healthz() -> dict[str, Any]:
return {"ok": True, "build": s.ps_build}
@app.get("/api/version")
def version() -> dict[str, Any]:
return {"build": s.ps_build, "stack": s.stack, "site_tz": s.site_tz}
@app.get("/api/db-health")
def db_health() -> Response:
try:
db.ping(s)
except db.DatabaseUnavailable:
log.warning("db-health: database unavailable")
return JSONResponse({"ok": False, "error": "database unavailable"}, status_code=503)
return JSONResponse({"ok": True})
@app.api_route("/{path:path}", methods=["GET", "HEAD"], include_in_schema=False)
def static(path: str) -> Response:
if path.split("/", 1)[0] in NO_FALLBACK:
return JSONResponse({"detail": "Not Found"}, status_code=404)
static_dir = s.static_dir
index = static_dir / "index.html"
if not index.is_file():
return HTMLResponse(PLACEHOLDER)
found = _static_file(static_dir, path)
if found is not None:
return FileResponse(found)
return FileResponse(index, headers={"Cache-Control": "no-cache"})
# Last added runs first: proxy rewrite, then the log (sees the real ip), then headers, then the Origin check
app.add_middleware(OriginCheckMiddleware)
app.add_middleware(SecurityHeadersMiddleware)
app.add_middleware(RequestLogMiddleware, build=s.ps_build)
app.add_middleware(TrustedProxyMiddleware, trusted=trusted)
return app
_app: FastAPI | None = None
def __getattr__(name: str) -> Any:
global _app
if name == "app":
if _app is None:
_app = create_app()
return _app
raise AttributeError(name)