mirror of
https://github.com/microsoft/autogen.git
synced 2025-07-07 09:01:29 +00:00

<!-- Thank you for your contribution! Please review https://microsoft.github.io/autogen/docs/Contribute before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? https://github.com/user-attachments/assets/b649053b-c377-40c7-aa51-ee64af766fc2 <img width="100%" alt="image" src="https://github.com/user-attachments/assets/03ba1df5-c9a2-4734-b6a2-0eb97ec0b0e0" /> ## Authentication This PR implements an experimental authentication feature to enable personalized experiences (multiple users). Currently, only GitHub authentication is supported. You can extend the base authentication class to add support for other authentication methods. By default authenticatio is disabled and only enabled when you pass in the `--auth-config` argument when running the application. ### Enable GitHub Authentication To enable GitHub authentication, create a `auth.yaml` file in your app directory: ```yaml type: github jwt_secret: "your-secret-key" token_expiry_minutes: 60 github: client_id: "your-github-client-id" client_secret: "your-github-client-secret" callback_url: "http://localhost:8081/api/auth/callback" scopes: ["user:email"] ``` Please see the documentation on [GitHub OAuth](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app) for more details on obtaining the `client_id` and `client_secret`. To pass in this configuration you can use the `--auth-config` argument when running the application: ```bash autogenstudio ui --auth-config /path/to/auth.yaml ``` Or set the environment variable: ```bash export AUTOGENSTUDIO_AUTH_CONFIG="/path/to/auth.yaml" ``` ```{note} - Authentication is currently experimental and may change in future releases - User data is stored in your configured database - When enabled, all API endpoints require authentication except for the authentication endpoints - WebSocket connections require the token to be passed as a query parameter (`?token=your-jwt-token`) ``` ## Related issue number <!-- For example: "Closes #1234" --> Closes #4350 ## Checks - [ ] I've included any doc changes needed for <https://microsoft.github.io/autogen/>. See <https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to build and test documentation locally. - [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed. --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
197 lines
4.9 KiB
Python
197 lines
4.9 KiB
Python
# api/app.py
|
|
import os
|
|
from contextlib import asynccontextmanager
|
|
from typing import AsyncGenerator
|
|
|
|
# import logging
|
|
from fastapi import FastAPI
|
|
from fastapi.middleware.cors import CORSMiddleware
|
|
from fastapi.staticfiles import StaticFiles
|
|
from loguru import logger
|
|
|
|
from ..version import VERSION
|
|
from .auth import authroutes
|
|
from .auth.middleware import AuthMiddleware
|
|
from .config import settings
|
|
from .deps import cleanup_managers, init_auth_manager, init_managers, register_auth_dependencies
|
|
from .initialization import AppInitializer
|
|
from .routes import gallery, runs, sessions, settingsroute, teams, validation, ws
|
|
|
|
# Initialize application
|
|
app_file_path = os.path.dirname(os.path.abspath(__file__))
|
|
initializer = AppInitializer(settings, app_file_path)
|
|
|
|
|
|
@asynccontextmanager
|
|
async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
|
|
"""
|
|
Lifecycle manager for the FastAPI application.
|
|
Handles initialization and cleanup of application resources.
|
|
"""
|
|
|
|
try:
|
|
# Initialize managers (DB, Connection, Team)
|
|
await init_managers(initializer.database_uri, initializer.config_dir, initializer.app_root)
|
|
|
|
await register_auth_dependencies(app, auth_manager)
|
|
|
|
# Any other initialization code
|
|
logger.info(
|
|
f"Application startup complete. Navigate to http://{os.environ.get('AUTOGENSTUDIO_HOST', '127.0.0.1')}:{os.environ.get('AUTOGENSTUDIO_PORT', '8081')}"
|
|
)
|
|
|
|
except Exception as e:
|
|
logger.error(f"Failed to initialize application: {str(e)}")
|
|
raise
|
|
|
|
yield # Application runs here
|
|
|
|
# Shutdown
|
|
try:
|
|
logger.info("Cleaning up application resources...")
|
|
await cleanup_managers()
|
|
logger.info("Application shutdown complete")
|
|
except Exception as e:
|
|
logger.error(f"Error during shutdown: {str(e)}")
|
|
|
|
|
|
auth_manager = init_auth_manager(initializer.config_dir)
|
|
# Create FastAPI application
|
|
app = FastAPI(lifespan=lifespan, debug=True)
|
|
|
|
# CORS middleware configuration
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
allow_origins=[
|
|
"http://localhost:8000",
|
|
"http://127.0.0.1:8000",
|
|
"http://localhost:8001",
|
|
"http://localhost:8081",
|
|
],
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
app.add_middleware(AuthMiddleware, auth_manager=auth_manager)
|
|
|
|
# Create API router with version and documentation
|
|
api = FastAPI(
|
|
root_path="/api",
|
|
title="AutoGen Studio API",
|
|
version=VERSION,
|
|
description="AutoGen Studio is a low-code tool for building and testing multi-agent workflows.",
|
|
docs_url="/docs" if settings.API_DOCS else None,
|
|
)
|
|
|
|
# Include all routers with their prefixes
|
|
api.include_router(
|
|
sessions.router,
|
|
prefix="/sessions",
|
|
tags=["sessions"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
api.include_router(
|
|
runs.router,
|
|
prefix="/runs",
|
|
tags=["runs"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
api.include_router(
|
|
teams.router,
|
|
prefix="/teams",
|
|
tags=["teams"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
|
|
api.include_router(
|
|
ws.router,
|
|
prefix="/ws",
|
|
tags=["websocket"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
api.include_router(
|
|
validation.router,
|
|
prefix="/validate",
|
|
tags=["validation"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
api.include_router(
|
|
settingsroute.router,
|
|
prefix="/settings",
|
|
tags=["settings"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
api.include_router(
|
|
gallery.router,
|
|
prefix="/gallery",
|
|
tags=["gallery"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
# Include authentication routes
|
|
api.include_router(
|
|
authroutes.router,
|
|
prefix="/auth",
|
|
tags=["auth"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
# Version endpoint
|
|
|
|
|
|
@api.get("/version")
|
|
async def get_version():
|
|
"""Get API version"""
|
|
return {
|
|
"status": True,
|
|
"message": "Version retrieved successfully",
|
|
"data": {"version": VERSION},
|
|
}
|
|
|
|
|
|
# Health check endpoint
|
|
|
|
|
|
@api.get("/health")
|
|
async def health_check():
|
|
"""API health check endpoint"""
|
|
return {
|
|
"status": True,
|
|
"message": "Service is healthy",
|
|
}
|
|
|
|
|
|
# Mount static file directories
|
|
app.mount("/api", api)
|
|
app.mount(
|
|
"/files",
|
|
StaticFiles(directory=initializer.static_root, html=True),
|
|
name="files",
|
|
)
|
|
app.mount("/", StaticFiles(directory=initializer.ui_root, html=True), name="ui")
|
|
|
|
# Error handlers
|
|
|
|
|
|
@app.exception_handler(500)
|
|
async def internal_error_handler(request, exc):
|
|
logger.error(f"Internal error: {str(exc)}")
|
|
return {
|
|
"status": False,
|
|
"message": "Internal server error",
|
|
"detail": str(exc) if settings.API_DOCS else "Internal server error",
|
|
}
|
|
|
|
|
|
def create_app() -> FastAPI:
|
|
"""
|
|
Factory function to create and configure the FastAPI application.
|
|
Useful for testing and different deployment scenarios.
|
|
"""
|
|
return app
|