Merge pull request #101 from Pantheon-temple/dev

Dev

Author: dcloud347

.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit =
+    prometheus/script/*

.github/workflows/pytest_and_coverage.yml

@@ -17,6 +17,7 @@ jobs:
       # General settings
       PROMETHEUS_ENVIRONMENT: local
       PROMETHEUS_BACKEND_CORS_ORIGINS: "[\"*\"]"
+      PROMETHEUS_ENABLE_AUTHENTICATION: false
 
       # Neo4j settings
       PROMETHEUS_NEO4J_URI: bolt://localhost:7687

example.env

@@ -3,7 +3,9 @@ PROMETHEUS_LOGGING_LEVEL=DEBUG
 
 # General settings
 PROMETHEUS_ENVIRONMENT=local
-PROMETHEUS_BACKEND_CORS_ORIGINS=["*]
+PROMETHEUS_BACKEND_CORS_ORIGINS=["*"]
+PROMETHEUS_ENABLE_AUTHENTICATION=false
+
 
 # Neo4j settings
 PROMETHEUS_NEO4J_URI=bolt://neo4j:7687

prometheus/app/api/issue.py

@@ -1,5 +1,6 @@
 from fastapi import APIRouter, Request
 
+from prometheus.app.decorators.require_login import requireLogin
 from prometheus.app.models.requests.issue import IssueRequest
 from prometheus.app.models.response.issue import IssueResponse
 from prometheus.app.models.response.response import Response
@@ -16,6 +17,7 @@
     response_description="Returns the patch, test results, and issue response",
     response_model=Response[IssueResponse],
 )
+@requireLogin
 def answer_issue(issue: IssueRequest, request: Request) -> Response[IssueResponse]:
     if not request.app.state.service["knowledge_graph_service"].exists():
         raise ServerException(

prometheus/app/api/repository.py

@@ -1,31 +1,61 @@
 import git
 from fastapi import APIRouter, Request
 
+from prometheus.app.decorators.require_login import requireLogin
 from prometheus.app.models.response.response import Response
 from prometheus.app.services.knowledge_graph_service import KnowledgeGraphService
 from prometheus.app.services.repository_service import RepositoryService
+from prometheus.app.services.user_service import UserService
 from prometheus.exceptions.server_exception import ServerException
 
 router = APIRouter()
 
 
+def get_github_token(request: Request, github_token: str) -> str:
+    """Retrieve GitHub token from the request or user profile."""
+    # If the token is provided in the request, use it directly
+    if github_token:
+        return github_token
+    # If the token is not provided, fetch it from the user profile if logged in
+    # Check if the user is authenticated
+    if not request.state.user_id:
+        # If the user is not authenticated, raise an exception
+        raise ServerException(
+            code=401, message="GitHub token is required, please provide it or log in"
+        )
+    # If the user is authenticated, get the user service and fetch the token
+    user_service: UserService = request.app.state.service["user_service"]
+    user = user_service.get_user_by_id(request.state.user_id)
+    github_token = user.github_token if user else None
+
+    # If the token is still not available, raise an exception
+    if not github_token:
+        raise ServerException(
+            code=423, message="Either provide a GitHub token or set it in your user profile"
+        )
+    return github_token
+
+
 @router.get(
     "/github/",
     description="""
     Upload a GitHub repository to Prometheus, default to the latest commit in the main branch.
     """,
     response_model=Response,
 )
+@requireLogin
 def upload_github_repository(github_token: str, https_url: str, request: Request):
     # Get the repository and knowledge graph services
     repository_service: RepositoryService = request.app.state.service["repository_service"]
     knowledge_graph_service: KnowledgeGraphService = request.app.state.service[
         "knowledge_graph_service"
     ]
+    github_token = get_github_token(request, github_token)
 
     # Clean the services to ensure no previous data is present
     repository_service.clean()
     knowledge_graph_service.clear()
+
     try:
         # Clone the repository
         saved_path = repository_service.clone_github_repo(github_token, https_url)
@@ -43,6 +73,7 @@ def upload_github_repository(github_token: str, https_url: str, request: Request
     """,
     response_model=Response,
 )
+@requireLogin
 def upload_github_repository_at_commit(
     github_token, https_url: str, commit_id: str, request: Request
 ):
@@ -52,6 +83,8 @@ def upload_github_repository_at_commit(
         "knowledge_graph_service"
     ]
 
+    github_token = get_github_token(request, github_token)
+
     # Clean the services to ensure no previous data is present
     repository_service.clean()
     knowledge_graph_service.clear()
@@ -73,6 +106,7 @@ def upload_github_repository_at_commit(
     """,
     response_model=Response,
 )
+@requireLogin
 def delete(request: Request):
     knowledge_graph_service: KnowledgeGraphService = request.app.state.service[
         "knowledge_graph_service"
@@ -88,6 +122,7 @@ def delete(request: Request):
     return Response()
 
 
+@requireLogin
 @router.get(
     "/exists/",
     description="""

prometheus/app/decorators/__init__.py

@@ -0,0 +1,20 @@
+import inspect
+from functools import wraps
+
+
+def requireLogin(func):
+    """
+    Decorator to indicate that a route requires user authentication.
+    This decorator can be used to mark routes that should only be accessible to authenticated users.
+    """
+
+    @wraps(func)
+    async def wrapper(*args, **kwargs):
+        if inspect.iscoroutinefunction(func):
+            return await func(*args, **kwargs)
+        else:
+            return func(*args, **kwargs)
+
+    # Set a custom attribute to indicate that this route requires login
+    setattr(wrapper, "_require_login", True)
+    return wrapper

prometheus/app/decorators/require_login.py

@@ -3,11 +3,17 @@
 from datetime import datetime, timezone
 
 from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
 from fastapi.routing import APIRoute
 
 from prometheus.app import dependencies
-from prometheus.app.api import issue, repository
+from prometheus.app.api import auth, issue, repository
 from prometheus.app.exception_handler import register_exception_handlers
+from prometheus.app.middlewares.jwt_middleware import JWTMiddleware
+from prometheus.app.register_login_required_routes import (
+    login_required_routes,
+    register_login_required_routes,
+)
 from prometheus.configuration.config import settings
 
 # Create a logger for the application's namespace
@@ -67,12 +73,33 @@ def custom_generate_unique_id(route: APIRoute) -> str:
     debug=True if settings.ENVIRONMENT == "local" else False,
 )
 
-# Register the exception handlers
-register_exception_handlers(app)
+# Register middlewares
+if settings.ENABLE_AUTHENTICATION:
+    app.add_middleware(
+        JWTMiddleware,
+        base_url=settings.BASE_URL,
+        login_required_routes=login_required_routes,
+    )
+# Add CORS middleware
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=settings.BACKEND_CORS_ORIGINS,  # Configure appropriately for production
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
 
 app.include_router(repository.router, prefix="/repository", tags=["repository"])
 app.include_router(issue.router, prefix="/issue", tags=["issue"])
 
+if settings.ENABLE_AUTHENTICATION:
+    app.include_router(auth.router, prefix="/auth", tags=["auth"])
+
+# Register the exception handlers
+register_exception_handlers(app)
+# Register the login-required routes
+register_login_required_routes(app)
+
 
 @app.get("/health", tags=["health"])
 def health_check():

prometheus/app/main.py

@@ -0,0 +1,58 @@
+from typing import Set, Tuple
+
+from fastapi import FastAPI, Request
+from fastapi.security.utils import get_authorization_scheme_param
+from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.responses import JSONResponse
+
+from prometheus.exceptions.jwt_exception import JWTException
+from prometheus.utils.jwt_utils import JWTUtils
+
+
+class JWTMiddleware(BaseHTTPMiddleware):
+    def __init__(self, app: FastAPI, base_url: str, login_required_routes: Set[Tuple[str, str]]):
+        super().__init__(app)
+        self.jwt_utils = JWTUtils()  # Initialize the JWT utility
+        self.login_required_routes = (
+            login_required_routes  # List of paths to exclude from JWT validation
+        )
+        self.base_url = base_url
+
+    async def dispatch(self, request: Request, call_next):
+        # Allow OPTIONS requests to pass through without authentication (for CORS preflight)
+        if request.method == "OPTIONS":
+            response = await call_next(request)
+            return response
+
+        # Check if the request path is in excluded paths
+        path = request.url.path.replace(self.base_url, "")
+        if (request.method, path) not in self.login_required_routes:
+            # Proceed to the next middleware or route handler if the path is excluded
+            response = await call_next(request)
+            return response
+
+        # Retrieve the Authorization header from the request
+        authorization: str = request.headers.get("Authorization")
+        # Extract the scheme (e.g., "Bearer") and the token from the header
+        scheme, token = get_authorization_scheme_param(authorization)
+
+        # Check if authorization header is missing or incorrect scheme
+        if not authorization or scheme.lower() != "bearer":
+            return JSONResponse(
+                status_code=401,
+                content={"code": 401, "message": "Valid JWT Token is missing", "data": None},
+            )
+
+        try:
+            # Attempt to decode and validate the JWT token
+            payload = self.jwt_utils.decode_token(token)
+        except JWTException as e:
+            # If token validation fails, return an error response with details
+            return JSONResponse(
+                status_code=e.code,
+                content={"code": e.code, "message": e.message, "data": None},
+            )
+        request.state.user_id = payload.get("user_id", None)
+        # Proceed to the next middleware or route handler if validation succeeds
+        response = await call_next(request)
+        return response

prometheus/app/middlewares/jwt_middleware.py

@@ -13,7 +13,7 @@ class LoginRequest(BaseModel):
     password: str = Field(
         description="password of the user",
         examples=["P@ssw0rd!"],
-        min_length=12,
+        min_length=8,
         max_length=30,
     )