agnes-the-ai-analyst/app/main.py
ZdenekSrotyr c7b14fb120 feat(admin): drop setup_banner feature; consolidate into single editor
Remove the setup_banner feature (admin-editable /setup page banner) and
all associated code: API router, repository, renderer, admin template,
tests, and docs. The setup_page handler no longer calls render_setup_banner;
the install.html template no longer renders banner_html. The setup_banner
DuckDB table (v22) is kept intact for forward-compat with already-migrated
instances — only the application code is removed.

CHANGELOG updated: setup_banner bullets removed; Agent Setup Prompt
(welcome-template feature) now stands alone as the single editable prompt.
2026-05-03 16:12:13 +02:00

696 lines
31 KiB
Python

"""FastAPI main application — unified server for web UI + API."""
# Silence authlib's internal forward-compat note. Authlib emits an
# AuthlibDeprecationWarning from its own _joserfc_helpers when our
# `from authlib.integrations.starlette_client import OAuth` import
# touches `authlib.jose` paths. The warning is upstream-internal — it's
# telling authlib to migrate to joserfc before its 2.0; it's not
# actionable on our side until either authlib ships the fix or we
# rewrite OAuth handling on top of joserfc directly. Filtering here
# (before authlib gets imported transitively) keeps `make local-dev`
# stdout clean without hiding warnings from any other package.
import warnings as _warnings
try:
from authlib.deprecate import AuthlibDeprecationWarning as _AuthlibDepr
_warnings.filterwarnings("ignore", category=_AuthlibDepr)
except ImportError:
# authlib too old / class moved — fall back to message-based match
# so the filter still keeps startup clean.
_warnings.filterwarnings(
"ignore",
message=r"authlib\.jose module is deprecated.*",
)
import logging
from contextlib import asynccontextmanager
from importlib.metadata import PackageNotFoundError
from importlib.metadata import version as _pkg_version
from pathlib import Path
from urllib.parse import quote
import os
# Initialise structured logging BEFORE any module that emits logs at import
# time. setup_logging is idempotent and safe to call once at process start.
from app.logging_config import setup_logging
setup_logging("app")
def _app_version() -> str:
"""Product version for FastAPI title / OpenAPI schema.
Single source of truth is `pyproject.toml` `[project].version`; we read
it back via `importlib.metadata` at runtime so `/docs`, `/openapi.json`,
`/api/version`, `/cli/latest`, and `da --version` can never drift.
"""
try:
return _pkg_version("agnes-the-ai-analyst")
except PackageNotFoundError:
return "dev"
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import RedirectResponse
from fastapi.staticfiles import StaticFiles
from starlette.exceptions import HTTPException as StarletteHTTPException
from starlette.middleware.gzip import GZipMiddleware
from starlette.middleware.sessions import SessionMiddleware
from starlette.types import ASGIApp, Receive, Scope, Send
from app.middleware.request_id import RequestIdMiddleware
class _SelectiveGZipMiddleware:
"""GZipMiddleware wrapper that skips a set of path prefixes.
Parquet-serving endpoints send responses that are already columnar-
compressed (parquet's internal codec) and — for /api/data — can reach
hundreds of MB. Gzipping them on the way out costs CPU and latency with
no meaningful size reduction. Skip those paths; every other endpoint
(JSON manifests, HTML previews, install.sh) still gets compressed.
"""
def __init__(self, app: ASGIApp, minimum_size: int = 1024, skip_prefixes: tuple[str, ...] = ()) -> None:
# `self.app` is the Starlette middleware convention — outer middleware
# (e.g. fastapi-debug-toolbar's APIRouter walker) traverses the chain
# via `.app` to find the inner FastAPI app. Keep `_raw` as the public
# alias used by our own __call__ for the skip-path branch.
self.app = app
self._raw = app
self._gzip = GZipMiddleware(app, minimum_size=minimum_size)
self._skip_prefixes = skip_prefixes
async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
if scope.get("type") == "http":
path = scope.get("path", "")
if any(path.startswith(p) for p in self._skip_prefixes):
await self._raw(scope, receive, send)
return
await self._gzip(scope, receive, send)
from app.auth.rate_limit import (
SlowAPIMiddleware as _AuthRateLimitMiddleware,
RateLimitExceeded as _AuthRateLimitExceeded,
_rate_limit_exceeded_handler as _auth_rate_limit_handler,
limiter as _auth_rate_limiter,
)
from app.auth.router import router as auth_router
from app.api.health import router as health_router
from app.api.sync import router as sync_router
from app.api.data import router as data_router
from app.api.query import router as query_router
from app.api.users import router as users_router
from app.api.memory import router as memory_router
from app.api.upload import router as upload_router
from app.api.scripts import router as scripts_router
from app.api.settings import router as settings_router
from app.api.catalog import router as catalog_router
from app.api.telegram import router as telegram_router
from app.api.access import router as access_router, me_router as me_access_router
from app.api.me_debug import router as me_debug_router
from app.api.admin import router as admin_router
from app.api.jira_webhooks import router as jira_webhooks_router
from app.api.metrics import router as metrics_router
from app.api.metadata import router as metadata_router
from app.api.query_hybrid import router as query_hybrid_router
from app.api.cli_artifacts import router as cli_artifacts_router
from app.api.tokens import router as tokens_router, admin_router as tokens_admin_router
from app.api.v2_catalog import router as v2_catalog_router
from app.api.v2_schema import router as v2_schema_router
from app.api.v2_sample import router as v2_sample_router
from app.api.v2_scan import router as v2_scan_router
from app.api.marketplaces import router as marketplaces_router
from app.api.welcome import router as welcome_router
from app.marketplace_server.router import router as marketplace_server_router
from app.marketplace_server.git_router import make_git_wsgi_app
from app.web.router import router as web_router
logger = logging.getLogger(__name__)
@asynccontextmanager
async def lifespan(app):
# Issue #81 Group A — log the effective remote_attach allowlist at
# startup so an operator's typo in AGNES_REMOTE_ATTACH_EXTENSIONS
# (which REPLACES, not extends, the default) is visible.
try:
from src.orchestrator_security import log_effective_policy
log_effective_policy()
except Exception:
pass # never block startup on a logging convenience
yield
from src.db import close_system_db
close_system_db()
DEBUG = os.environ.get("DEBUG", "").lower() in ("1", "true", "yes")
def _toolbar_show_callback(request, settings) -> bool:
"""Decide whether the debug toolbar shows on a request.
Replaces the upstream default (which reads `request.app.debug`) — we keep
`app.debug=False` so our @app.exception_handler(Exception) runs instead of
Starlette's debug-only ServerErrorMiddleware, but we still want the
toolbar mounted. Read DEBUG env directly.
"""
return os.environ.get("DEBUG", "").lower() in ("1", "true", "yes")
def create_app() -> FastAPI:
app = FastAPI(
title="AI Data Analyst",
description="Data distribution platform for AI analytical systems",
version=_app_version(),
lifespan=lifespan,
# Intentionally NOT debug=DEBUG: FastAPI's debug=True installs
# Starlette's ServerErrorMiddleware which intercepts unhandled
# Exceptions and renders a plain-HTML traceback BEFORE our
# @app.exception_handler(Exception) can run — robbing the 500 page
# of its chrome and the debug toolbar. We get the toolbar back via
# SHOW_TOOLBAR_CALLBACK below (reads DEBUG env directly instead of
# request.app.debug).
debug=False,
)
# FastAPI debug toolbar — only when DEBUG=1 in env. Injects per-request
# HTML overlay (headers, routes, timer, profiling, logs) on any HTML
# response; harmless on JSON. Inner try/except is for the import only:
# if a developer sets DEBUG=1 without installing dev deps, log a warning
# instead of crashing. The middleware mount itself fails loud if broken.
#
# Mounted FIRST (innermost on response) so it sees the raw HTML BEFORE
# GZip compresses it — debug_toolbar.middleware decodes response bodies
# as UTF-8 to inject markup, and a gzipped body fails that decode (the
# toolbar's own `Accept-Encoding` skip-check reads response headers, not
# request headers, so it never trips).
if DEBUG:
try:
from debug_toolbar.middleware import DebugToolbarMiddleware
from jinja2 import FileSystemLoader
# debug_toolbar.middleware splats **kwargs into DebugToolbarSettings
# (a pydantic-settings model with case-insensitive UPPERCASE fields).
# Pass field names as kwargs to add_middleware — `panels` becomes
# `PANELS`, etc. Do NOT wrap them in a `settings={...}` dict —
# that hits the model's actual `SETTINGS` field (Sequence[BaseSettings])
# and fails validation. Field reference:
# https://github.com/mongkok/fastapi-debug-toolbar/blob/master/debug_toolbar/settings.py
# ProfilingPanel (pyinstrument) is intentionally omitted: it
# raises "There is already a profiler running" under uvicorn's
# async context because pyinstrument's stack sampler can't be
# nested per task. Re-enable per-developer if you really want it
# via env override; the rest of the panels are async-safe.
#
# JINJA_LOADERS prepends our app/debug/templates so DuckDBPanel
# can resolve `panels/duckdb.html`. The toolbar's built-in loader
# (PackageLoader for debug_toolbar/templates) stays appended via
# ChoiceLoader, so first-party panels still render.
_debug_templates_dir = Path(__file__).parent / "debug" / "templates"
_toolbar_settings = dict(
panels=[
"debug_toolbar.panels.headers.HeadersPanel",
"debug_toolbar.panels.routes.RoutesPanel",
"debug_toolbar.panels.settings.SettingsPanel",
"debug_toolbar.panels.versions.VersionsPanel",
"debug_toolbar.panels.timer.TimerPanel",
"debug_toolbar.panels.logging.LoggingPanel",
"app.debug.duckdb_panel.DuckDBPanel",
],
jinja_loaders=[FileSystemLoader(str(_debug_templates_dir))],
show_toolbar_callback="app.main._toolbar_show_callback",
)
# Eagerly register the toolbar's own routes
# (/_debug_toolbar/render_panel/ + /_debug_toolbar/static mount)
# NOW, before app.web.router's /{full_path:path} catch-all gets
# added by include_router(web_router). Otherwise the catch-all
# swallows the toolbar's own GET requests and the panel scripts
# render our 404 page. We can't construct DebugToolbarMiddleware
# directly on the FastAPI app (its `while not isinstance(...,
# APIRouter): self.router = self.router.app` walk fails — FastAPI
# has `.router`, not `.app`), so call init_toolbar's body
# ourselves on the APIRouter directly. add_middleware below still
# works lazily; init_toolbar's NoMatchFound guard skips re-adding
# routes when called the second time.
from debug_toolbar.api import render_panel as _render_panel_view
from debug_toolbar.middleware import show_toolbar as _show_toolbar
from debug_toolbar.settings import DebugToolbarSettings
from fastapi import HTTPException as _HTTPException, status as _status
from fastapi.staticfiles import StaticFiles as _StaticFiles
_eager_settings = DebugToolbarSettings(**_toolbar_settings)
async def _require_show_toolbar(request, call_next=None):
"""Mirror DebugToolbarMiddleware.require_show_toolbar: 404 the
toolbar API for clients that wouldn't see the toolbar."""
if not _show_toolbar(request, _eager_settings):
raise _HTTPException(status_code=_status.HTTP_404_NOT_FOUND)
return await _render_panel_view(request)
app.router.get(
_eager_settings.API_URL,
name="debug_toolbar.render_panel",
include_in_schema=False,
)(_render_panel_view)
app.router.mount(
_eager_settings.STATIC_URL,
_StaticFiles(packages=["debug_toolbar"]),
name="debug_toolbar.static",
)
app.add_middleware(DebugToolbarMiddleware, **_toolbar_settings)
except ImportError:
logger.warning(
"DEBUG=1 but fastapi-debug-toolbar not installed; toolbar disabled",
)
# Compress JSON / HTML responses on the wire. Parquet downloads are
# excluded — they're already columnar-compressed and re-gzipping them
# just burns CPU with no size win. minimum_size=1024 keeps tiny
# responses uncompressed too (cheaper than the header overhead).
app.add_middleware(
_SelectiveGZipMiddleware,
minimum_size=1024,
skip_prefixes=(
"/api/data/",
"/cli/wheel/",
"/cli/download",
"/marketplace.git", # git smart-HTTP is self-chunked; double-gzip bloats
),
)
# Per-IP rate limiting on auth endpoints (#45). Wired here so the
# SlowAPIMiddleware sits in the standard middleware chain (above CORS,
# below GZip — order doesn't affect correctness, only metric/log
# ordering). The limiter singleton is created at import time in
# app.auth.rate_limit; we just register state + middleware + handler.
app.state.limiter = _auth_rate_limiter
app.add_middleware(_AuthRateLimitMiddleware)
app.add_exception_handler(_AuthRateLimitExceeded, _auth_rate_limit_handler)
# Session middleware (required for OAuth state)
from app.secrets import get_session_secret
session_secret = get_session_secret()
if len(session_secret) < 32:
# Same gate JWT applies (app/auth/jwt.py:_get_secret_key) — keeps the
# two HMAC surfaces consistent. session_internal_roles + google_groups
# are trusted off the cookie signature; a weak SESSION_SECRET means
# those gates are weak too.
import warnings as _warnings
_warnings.warn(
f"SESSION_SECRET is {len(session_secret)} chars — minimum 32 recommended",
UserWarning, stacklevel=2,
)
app.add_middleware(SessionMiddleware, secret_key=session_secret)
# CORS for CLI and external clients
cors_origins = os.environ.get("CORS_ORIGINS", "http://localhost:3000,http://localhost:8000").split(",")
app.add_middleware(
CORSMiddleware,
allow_origins=[o.strip() for o in cors_origins],
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
# RequestIdMiddleware mounted LAST — Starlette inserts middleware at
# index 0, so the last add_middleware call ends up OUTERMOST and runs
# FIRST per request. The request_id ContextVar is set before any
# downstream middleware or handler runs, and every response gets the
# x-request-id header.
app.add_middleware(RequestIdMiddleware)
# Load .env_overlay (persisted by /api/admin/configure)
_overlay = Path(os.environ.get("DATA_DIR", "./data")) / "state" / ".env_overlay"
if _overlay.exists():
for line in _overlay.read_text().splitlines():
if "=" in line and not line.startswith("#"):
k, v = line.split("=", 1)
os.environ.setdefault(k.strip(), v.strip())
# Load instance config on startup
try:
from app.instance_config import load_instance_config
load_instance_config()
logger.info("Instance config loaded")
except Exception as e:
logger.warning(f"Could not load instance config: {e}")
# Configure confidence scoring from instance config (corporate_memory.confidence section)
try:
from app.instance_config import get_corporate_memory_config
from services.corporate_memory.confidence import configure as configure_confidence
cm_config = get_corporate_memory_config()
if cm_config and "confidence" in cm_config:
configure_confidence(cm_config["confidence"])
logger.info("Corporate memory confidence config applied")
except Exception as e:
logger.warning(f"Could not configure corporate memory confidence: {e}")
# Startup banner
from src.db import SCHEMA_VERSION
logger.info(
"Agnes %s | channel: %s | schema v%s",
os.environ.get("AGNES_VERSION", "dev"),
os.environ.get("RELEASE_CHANNEL", "dev"),
SCHEMA_VERSION,
)
# LOCAL_DEV_MODE: bypass authentication for local development. DO NOT enable in prod.
# When on, every protected route auto-logs in as a seeded admin user (default dev@localhost).
from app.auth.dependencies import (
is_local_dev_mode, get_local_dev_email, get_local_dev_groups,
)
if is_local_dev_mode():
logger.warning("=" * 60)
logger.warning("LOCAL_DEV_MODE is ON — authentication is bypassed.")
logger.warning("All requests auto-authenticate as: %s", get_local_dev_email())
# Validate + report LOCAL_DEV_GROUPS at startup so a malformed JSON
# value gets surfaced loudly here instead of silently warning on the
# first authenticated request. Empty when unset is fine — just say so.
raw_groups_env = os.environ.get("LOCAL_DEV_GROUPS", "").strip()
mocked_groups = get_local_dev_groups()
if raw_groups_env and not mocked_groups:
logger.warning(
"LOCAL_DEV_GROUPS is set but produced no valid groups — "
"check the WARNING above for the parse error.",
)
elif mocked_groups:
logger.warning(
"LOCAL_DEV_GROUPS: mocking %d group(s) into session: %s",
len(mocked_groups),
", ".join(g["id"] for g in mocked_groups),
)
else:
logger.warning("LOCAL_DEV_GROUPS is unset — session.google_groups will be empty.")
logger.warning("NEVER enable this in a deployment reachable from the internet.")
logger.warning("=" * 60)
# Seed admin user (SEED_ADMIN_EMAIL) and add them to the Admin user_group.
# Optional SEED_ADMIN_PASSWORD lets the seeded user sign in immediately
# without going through bootstrap; never overwritten if already set.
# The Admin/Everyone user_groups themselves are seeded inside
# _ensure_schema (src.db._seed_system_groups), so this hook only has to
# handle membership for the seed admin.
seed_email = os.environ.get("SEED_ADMIN_EMAIL") or (get_local_dev_email() if is_local_dev_mode() else None)
if seed_email:
try:
from src.db import SYSTEM_ADMIN_GROUP, get_system_db
from src.repositories.user_group_members import UserGroupMembersRepository
from src.repositories.users import UserRepository
conn = get_system_db()
repo = UserRepository(conn)
seed_password = os.environ.get("SEED_ADMIN_PASSWORD") or None
password_hash = None
if seed_password:
from argon2 import PasswordHasher
password_hash = PasswordHasher().hash(seed_password)
existing = repo.get_by_email(seed_email)
if not existing:
import uuid
user_id = str(uuid.uuid4())
repo.create(
id=user_id,
email=seed_email,
name="Admin",
password_hash=password_hash,
)
logger.info("Seeded admin user: %s (password=%s)", seed_email, "yes" if password_hash else "no")
else:
user_id = existing["id"]
if password_hash and not existing.get("password_hash"):
repo.update(id=user_id, password_hash=password_hash)
logger.info("Set password on existing seed admin: %s", seed_email)
# Make sure the seed admin is actually in the Admin group — this
# is what gives them admin access in v12. Idempotent.
admin_group = conn.execute(
"SELECT id FROM user_groups WHERE name = ?", [SYSTEM_ADMIN_GROUP],
).fetchone()
if admin_group:
UserGroupMembersRepository(conn).add_member(
user_id=user_id,
group_id=admin_group[0],
source="system_seed",
added_by="app.main:seed_admin",
)
conn.close()
except Exception as e:
logger.warning(f"Could not seed admin: {e}")
# Seed the synthetic scheduler user when SCHEDULER_API_TOKEN is configured,
# so the very first cron tick after a fresh deploy already has a valid
# actor to attribute audit-log entries to. The lazy seed in
# `app.auth.scheduler_token.get_scheduler_user` covers the case where the
# secret is rotated mid-life, but doing it here keeps startup observable.
from app.auth.scheduler_token import get_scheduler_secret
if get_scheduler_secret():
try:
from app.auth.scheduler_token import (
SCHEDULER_TOKEN_MIN_LENGTH,
ensure_scheduler_user,
)
from src.db import get_system_db
secret = get_scheduler_secret()
if len(secret) < SCHEDULER_TOKEN_MIN_LENGTH:
logger.warning(
"SCHEDULER_API_TOKEN is set but only %d chars — auth path"
" disabled (minimum %d). Generate a longer secret in .env.",
len(secret), SCHEDULER_TOKEN_MIN_LENGTH,
)
else:
conn = get_system_db()
try:
ensure_scheduler_user(conn)
finally:
conn.close()
except Exception as e:
logger.warning(f"Could not seed scheduler user: {e}")
# C8: Warn when no user has a password_hash — bootstrap endpoint is open.
# This is intentional UX (operator can claim seed admin), but the open
# window should be visible in startup logs so it's not forgotten.
if not is_local_dev_mode():
try:
from src.db import get_system_db
from src.repositories.users import UserRepository
conn = get_system_db()
repo = UserRepository(conn)
all_users = repo.list_all()
has_password = any(u.get("password_hash") for u in all_users)
if not has_password:
logger.warning(
"No user has a password set — /auth/bootstrap is reachable. "
"Claim the seed admin (or set SEED_ADMIN_PASSWORD) to close this window."
)
conn.close()
except Exception:
pass # never block startup on a logging convenience
# Static files
static_dir = Path(__file__).parent / "web" / "static"
if static_dir.exists():
app.mount("/static", StaticFiles(directory=str(static_dir)), name="static")
# Auth providers (conditional registration)
from app.auth.providers.google import router as google_auth_router, is_available as google_available
from app.auth.providers.password import router as password_auth_router
from app.auth.providers.email import router as email_auth_router, is_available as email_available
# API routers
app.include_router(auth_router)
app.include_router(google_auth_router)
app.include_router(password_auth_router)
app.include_router(email_auth_router) # Always register, check availability per-request
app.include_router(health_router)
app.include_router(sync_router)
app.include_router(data_router)
app.include_router(query_router)
app.include_router(users_router)
app.include_router(memory_router)
app.include_router(upload_router)
app.include_router(scripts_router)
app.include_router(settings_router)
app.include_router(catalog_router)
app.include_router(telegram_router)
app.include_router(admin_router)
app.include_router(access_router)
app.include_router(me_access_router)
app.include_router(me_debug_router)
app.include_router(jira_webhooks_router)
app.include_router(metrics_router)
app.include_router(metadata_router)
app.include_router(query_hybrid_router)
app.include_router(cli_artifacts_router)
app.include_router(tokens_router)
app.include_router(tokens_admin_router)
app.include_router(v2_catalog_router)
app.include_router(v2_schema_router)
app.include_router(v2_sample_router)
app.include_router(v2_scan_router)
app.include_router(marketplaces_router)
app.include_router(welcome_router)
app.include_router(marketplace_server_router)
# Git smart-HTTP endpoint for Claude Code: /marketplace.git/*
# WSGI → ASGI bridge (dulwich is WSGI-native; FastAPI is ASGI).
from a2wsgi import WSGIMiddleware
app.mount("/marketplace.git", WSGIMiddleware(make_git_wsgi_app()))
# Web UI router (must be last — has catch-all routes)
app.include_router(web_router)
# Paths served as API responses (JSON / ZIP / git smart-HTTP) — never
# redirect a 401 here to the HTML login page; clients expect the raw 401.
_API_PATH_PREFIXES: tuple[str, ...] = (
"/api/",
"/auth/",
"/marketplace.zip",
"/marketplace.git",
"/marketplace/",
)
_ERROR_TITLES = {
400: "Bad request",
401: "Sign-in required",
403: "Forbidden",
404: "Page not found",
405: "Method not allowed",
408: "Request timeout",
413: "Payload too large",
422: "Unprocessable entity",
429: "Too many requests",
500: "Server error",
502: "Bad gateway",
503: "Service unavailable",
504: "Gateway timeout",
}
def _wants_html(request) -> bool:
"""True when the client looks like a browser (non-API path, explicit html).
We deliberately do NOT treat ``Accept: */*`` (curl's default) or an
empty Accept header as wanting HTML. curl-using operators were
getting JSON error bodies for non-API paths before this PR; matching
``*/*`` here would silently flip them to HTML and break tooling that
parses ``{"detail": "..."}``. A real browser sends
``Accept: text/html,application/xhtml+xml,...`` so the explicit
substring check below covers that case.
Devin ANALYSIS_0003 on PR #136 review.
"""
if request.url.path.startswith(_API_PATH_PREFIXES):
return False
accept = request.headers.get("accept", "")
return "text/html" in accept
async def _resolve_error_user(request) -> dict | None:
"""Best-effort user resolution for the error page header.
Mirrors ``app.auth.dependencies.get_optional_user`` precedence
(LOCAL_DEV_MODE → seeded dev user, else verify JWT from
Authorization header or ``access_token`` cookie). Returns None on
any failure — error page still renders, just without the user menu.
"""
try:
from app.auth.dependencies import get_current_user
from src.db import get_system_db
conn = get_system_db()
try:
authorization = request.headers.get("authorization")
return await get_current_user(
request=request, authorization=authorization, conn=conn
)
finally:
try:
conn.close()
except Exception:
pass
except Exception:
return None
async def _render_error(request, code: int, message: str, traceback_str: str | None = None):
"""Render error.html with the same chrome (header, theme, static_url)
as any other web route. Reuses ``_build_context`` so the page picks up
ConfigProxy, theme overrides, session user, and ``static_url`` /
``url_for`` helpers — without these, base.html + _app_header.html
silently render empty header/stylesheets."""
from app.logging_config import request_id_var
from app.web.router import templates as _web_templates, _build_context
title = _ERROR_TITLES.get(code, "Error")
user = await _resolve_error_user(request)
ctx = _build_context(
request,
user=user,
code=code,
title=title,
message=message,
path=request.url.path,
traceback=traceback_str,
request_id=request_id_var.get(),
)
return _web_templates.TemplateResponse(request, "error.html", ctx, status_code=code)
@app.exception_handler(StarletteHTTPException)
async def _html_auth_redirect_handler(request, exc: StarletteHTTPException):
"""Browser-friendly error rendering for HTML routes; JSON for API routes.
- 401 GET on a non-API path → redirect to ``/login`` (existing contract).
- Any other status code on a non-API path with HTML-accepting client →
render ``error.html`` (toolbar middleware injects panels because the
``_catch_all_404`` route at the end of ``app.web.router`` provides a
matched route for unrouted paths).
- API prefixes (``/api/``, ``/auth/``, ``/marketplace.zip``,
``/marketplace.git``, ``/marketplace/``) and non-HTML clients → JSON
``{"detail": "..."}`` per the existing contract.
"""
path_is_api = request.url.path.startswith(_API_PATH_PREFIXES)
if (
exc.status_code == 401
and request.method == "GET"
and not path_is_api
):
next_param = quote(request.url.path, safe="")
return RedirectResponse(url=f"/login?next={next_param}", status_code=302)
if not path_is_api and _wants_html(request):
return await _render_error(request, exc.status_code, exc.detail or "")
from fastapi.exception_handlers import http_exception_handler
return await http_exception_handler(request, exc)
@app.exception_handler(Exception)
async def _unhandled_exception_handler(request, exc: Exception):
"""Catch-all 500 handler — HTML for browsers, JSON for API clients."""
import os as _os
import traceback as _tb
logger.exception("Unhandled exception on %s %s", request.method, request.url.path)
path_is_api = request.url.path.startswith(_API_PATH_PREFIXES)
debug_on = _os.environ.get("DEBUG", "").lower() in ("1", "true", "yes")
tb_str = _tb.format_exc() if debug_on else None
if not path_is_api and _wants_html(request):
# In production (DEBUG unset), never leak str(exc) to the
# rendered page — exception messages routinely contain DB paths,
# SQL fragments, internal hostnames, or credentials embedded in
# connection strings. Match the JSON branch's debug_on guard.
# Devin BUG_0001 on PR #136 (b1c6ee9 review).
visible_message = str(exc) if debug_on else "Internal server error"
return await _render_error(request, 500, visible_message, tb_str)
from app.logging_config import request_id_var
from fastapi.responses import JSONResponse
body: dict[str, str | None] = {
"detail": "Internal server error",
"request_id": request_id_var.get(),
}
if debug_on:
body["error"] = str(exc)
return JSONResponse(body, status_code=500)
return app
app = create_app()