- Introduced rate-limiting to `/auth/*` routes with configurable limits using `SlowAPI`. - Added `/health` endpoint for service monitoring and load balancer health checks. - Updated `requirements.txt` to include `SlowAPI` for rate limiting. - Implemented tests for rate-limiting and health check functionality. - Enhanced configuration and security with updated environment variables, pinned dependencies, and validation adjustments. - Provided example usage and extended coverage in testing.
117 lines
3.3 KiB
Python
117 lines
3.3 KiB
Python
import logging
|
|
from datetime import datetime
|
|
from typing import Dict, Any
|
|
|
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
|
from fastapi import FastAPI, status, Request
|
|
from fastapi.middleware.cors import CORSMiddleware
|
|
from fastapi.responses import HTMLResponse, JSONResponse
|
|
from slowapi import Limiter, _rate_limit_exceeded_handler
|
|
from slowapi.util import get_remote_address
|
|
from slowapi.errors import RateLimitExceeded
|
|
from sqlalchemy import text
|
|
|
|
from app.api.main import api_router
|
|
from app.core.config import settings
|
|
from app.core.database import get_db
|
|
|
|
scheduler = AsyncIOScheduler()
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Initialize rate limiter
|
|
limiter = Limiter(key_func=get_remote_address)
|
|
|
|
logger.info(f"Starting app!!!")
|
|
app = FastAPI(
|
|
title=settings.PROJECT_NAME,
|
|
version=settings.VERSION,
|
|
openapi_url=f"{settings.API_V1_STR}/openapi.json"
|
|
)
|
|
|
|
# Add rate limiter state to app
|
|
app.state.limiter = limiter
|
|
app.add_exception_handler(RateLimitExceeded, _rate_limit_exceeded_handler)
|
|
|
|
# Set up CORS middleware
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
allow_origins=settings.BACKEND_CORS_ORIGINS,
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
|
|
@app.get("/", response_class=HTMLResponse)
|
|
async def root():
|
|
return """
|
|
<html>
|
|
<head>
|
|
<title>App API</title>
|
|
</head>
|
|
<body>
|
|
<h1>Welcome to app API</h1>
|
|
<p>Explore the available endpoints and documentation:</p>
|
|
<a href="/docs">OpenAPI Documentation</a>
|
|
</body>
|
|
</html>
|
|
"""
|
|
|
|
|
|
@app.get(
|
|
"/health",
|
|
summary="Health Check",
|
|
description="Check the health status of the API and its dependencies",
|
|
response_description="Health status information",
|
|
tags=["Health"],
|
|
operation_id="health_check"
|
|
)
|
|
async def health_check() -> JSONResponse:
|
|
"""
|
|
Health check endpoint for monitoring and load balancers.
|
|
|
|
Returns:
|
|
JSONResponse: Health status with the following information:
|
|
- status: Overall health status ("healthy" or "unhealthy")
|
|
- timestamp: Current server timestamp (ISO 8601 format)
|
|
- version: API version
|
|
- environment: Current environment (development, staging, production)
|
|
- database: Database connectivity status
|
|
"""
|
|
health_status: Dict[str, Any] = {
|
|
"status": "healthy",
|
|
"timestamp": datetime.utcnow().isoformat() + "Z",
|
|
"version": settings.VERSION,
|
|
"environment": settings.ENVIRONMENT,
|
|
"checks": {}
|
|
}
|
|
|
|
response_status = status.HTTP_200_OK
|
|
|
|
# Database health check
|
|
try:
|
|
db = next(get_db())
|
|
db.execute(text("SELECT 1"))
|
|
health_status["checks"]["database"] = {
|
|
"status": "healthy",
|
|
"message": "Database connection successful"
|
|
}
|
|
db.close()
|
|
except Exception as e:
|
|
health_status["status"] = "unhealthy"
|
|
health_status["checks"]["database"] = {
|
|
"status": "unhealthy",
|
|
"message": f"Database connection failed: {str(e)}"
|
|
}
|
|
response_status = status.HTTP_503_SERVICE_UNAVAILABLE
|
|
logger.error(f"Health check failed - database error: {e}")
|
|
|
|
return JSONResponse(
|
|
status_code=response_status,
|
|
content=health_status
|
|
)
|
|
|
|
|
|
app.include_router(api_router, prefix=settings.API_V1_STR)
|