mirror of
https://github.com/rommapp/romm.git
synced 2026-02-18 23:42:07 +01:00
63f84b78d5
For steps that need to run before the web application starts, such as scheduling tasks, this new `startup.py` script is introduced. This fixes a recently introduced issue where task scheduling was not being triggered, because of it being included in the `if __name__ == "__main__":` block, which is not executed when the application is run by Gunicorn in production environments. We do not include this logic as part of FastAPI's lifespan implementation, as running multiple workers with Gunicorn would cause this logic to be executed multiple times.
149 lines
3.9 KiB
Python
149 lines
3.9 KiB
Python
import asyncio
|
|
import logging.config
|
|
import re
|
|
from collections.abc import AsyncGenerator
|
|
from contextlib import asynccontextmanager
|
|
|
|
import alembic.config
|
|
import endpoints.sockets.scan # noqa
|
|
import sentry_sdk
|
|
import uvicorn
|
|
from config import (
|
|
DEV_HOST,
|
|
DEV_PORT,
|
|
DISABLE_CSRF_PROTECTION,
|
|
IS_PYTEST_RUN,
|
|
ROMM_AUTH_SECRET_KEY,
|
|
SENTRY_DSN,
|
|
)
|
|
from endpoints import (
|
|
auth,
|
|
collections,
|
|
configs,
|
|
feeds,
|
|
firmware,
|
|
heartbeat,
|
|
platform,
|
|
raw,
|
|
rom,
|
|
saves,
|
|
screenshots,
|
|
search,
|
|
states,
|
|
stats,
|
|
tasks,
|
|
user,
|
|
)
|
|
from fastapi import FastAPI
|
|
from fastapi.middleware.cors import CORSMiddleware
|
|
from fastapi_pagination import add_pagination
|
|
from handler.auth.constants import ALGORITHM
|
|
from handler.auth.hybrid_auth import HybridAuthBackend
|
|
from handler.auth.middleware import CustomCSRFMiddleware, SessionMiddleware
|
|
from handler.socket_handler import socket_handler
|
|
from logger.log_middleware import LOGGING_CONFIG, CustomLoggingMiddleware
|
|
from starlette.middleware.authentication import AuthenticationMiddleware
|
|
from startup import main
|
|
from utils import get_version
|
|
from utils.context import (
|
|
ctx_aiohttp_session,
|
|
ctx_httpx_client,
|
|
initialize_context,
|
|
set_context_middleware,
|
|
)
|
|
|
|
logging.config.dictConfig(LOGGING_CONFIG)
|
|
|
|
|
|
@asynccontextmanager
|
|
async def lifespan(app: FastAPI) -> AsyncGenerator[None]:
|
|
async with initialize_context():
|
|
app.state.aiohttp_session = ctx_aiohttp_session.get()
|
|
app.state.httpx_client = ctx_httpx_client.get()
|
|
yield
|
|
|
|
|
|
sentry_sdk.init(
|
|
dsn=SENTRY_DSN,
|
|
release="romm@" + get_version(),
|
|
)
|
|
|
|
app = FastAPI(
|
|
title="RomM API",
|
|
version=get_version(),
|
|
lifespan=lifespan,
|
|
docs_url="/api/docs",
|
|
redoc_url="/api/redoc",
|
|
)
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
allow_origins=["*"],
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
if not IS_PYTEST_RUN and not DISABLE_CSRF_PROTECTION:
|
|
# CSRF protection (except endpoints listed in exempt_urls)
|
|
app.add_middleware(
|
|
CustomCSRFMiddleware,
|
|
cookie_name="romm_csrftoken",
|
|
secret=ROMM_AUTH_SECRET_KEY,
|
|
exempt_urls=[re.compile(r"^/api/token.*"), re.compile(r"^/ws")],
|
|
)
|
|
|
|
# Handles both basic and oauth authentication
|
|
app.add_middleware(
|
|
AuthenticationMiddleware,
|
|
backend=HybridAuthBackend(),
|
|
)
|
|
|
|
# Enables support for sessions on requests
|
|
app.add_middleware(
|
|
SessionMiddleware,
|
|
secret_key=ROMM_AUTH_SECRET_KEY,
|
|
session_cookie="romm_session",
|
|
same_site="strict",
|
|
https_only=False,
|
|
jwt_alg=ALGORITHM,
|
|
)
|
|
|
|
# Sets context vars in request-response cycle
|
|
app.middleware("http")(set_context_middleware)
|
|
|
|
app.include_router(heartbeat.router, prefix="/api")
|
|
app.include_router(auth.router, prefix="/api")
|
|
app.include_router(user.router, prefix="/api")
|
|
app.include_router(platform.router, prefix="/api")
|
|
app.include_router(rom.router, prefix="/api")
|
|
app.include_router(search.router, prefix="/api")
|
|
app.include_router(saves.router, prefix="/api")
|
|
app.include_router(states.router, prefix="/api")
|
|
app.include_router(tasks.router, prefix="/api")
|
|
app.include_router(feeds.router, prefix="/api")
|
|
app.include_router(configs.router, prefix="/api")
|
|
app.include_router(stats.router, prefix="/api")
|
|
app.include_router(raw.router, prefix="/api")
|
|
app.include_router(screenshots.router, prefix="/api")
|
|
app.include_router(firmware.router, prefix="/api")
|
|
app.include_router(collections.router, prefix="/api")
|
|
|
|
app.mount("/ws", socket_handler.socket_app)
|
|
|
|
add_pagination(app)
|
|
|
|
|
|
# NOTE: This code is only executed when running the application directly, not by Production
|
|
# deployments using Gunicorn.
|
|
if __name__ == "__main__":
|
|
# Run migrations
|
|
alembic.config.main(argv=["upgrade", "head"])
|
|
|
|
# Run startup tasks
|
|
asyncio.run(main())
|
|
|
|
# Run application
|
|
app.add_middleware(CustomLoggingMiddleware)
|
|
uvicorn.run("main:app", host=DEV_HOST, port=DEV_PORT, reload=True, access_log=False)
|