Create Backend Config Manager (#614)

# Purpose
Closes #335 
Create a BackendConfiguration class to store backend config info (logger
excluded params and CORS config settings)

# New Changes
- added .*.env to the .gitignore
- created Pydantic classes to represent CORS and logger configurations
- created a BackendConfiguration class to store CORS and logger config
settings
- changed middleware and setup files to take info from an instance of
the BackendConfiguration class

# Testing
Explain tests that you ran to verify code functionality.
- [x] I have unit-tested this PR. Otherwise, explain why it cannot be
unit-tested.
- [x] I have included screenshots of the tests performed below.

<img width="555" height="54" alt="image"
src="https://github.com/user-attachments/assets/6cda094c-4923-4637-ae5a-0890af3757c9"
/>

# Outstanding Changes
If there are non-critical changes (i.e. additional features) that can be
made to this feature in the future, indicate them here.

---------

Co-authored-by: Brain256 <brian@BrianYoga7.localdomain>

Author: Brain256

.gitignore

@@ -64,6 +64,7 @@ compile_commands.json
 *.sw?
 
 .env
+.*.env
 *.db
 
 /build*

gs/backend/api/backend_setup.py

@@ -9,6 +9,7 @@
 from gs.backend.api.v1.mcc.endpoints.commands import commands_router
 from gs.backend.api.v1.mcc.endpoints.main_commands import main_commands_router
 from gs.backend.api.v1.mcc.endpoints.telemetry import telemetry_router
+from gs.backend.config.config import backend_config
 
 
 def setup_routes(app: FastAPI) -> None:
@@ -32,4 +33,7 @@ def setup_middlewares(app: FastAPI) -> None:
     """Adds the middlewares to the app"""
     add_cors_middleware(app)  # Cors middleware should be added first
     app.add_middleware(AuthMiddleware)
-    app.add_middleware(LoggerMiddleware, excluded_endpoints=[])
+    app.add_middleware(
+        LoggerMiddleware,
+        excluded_endpoints=backend_config.logger_config.excluded_endpoints,
+    )

gs/backend/api/middleware/cors_middleware.py

@@ -1,6 +1,8 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
+from gs.backend.config.config import backend_config
+
 
 def add_cors_middleware(app: FastAPI) -> None:
     """
@@ -10,8 +12,8 @@ def add_cors_middleware(app: FastAPI) -> None:
     """
     app.add_middleware(
         CORSMiddleware,
-        allow_origins=["http://localhost:5173"],
-        allow_credentials=True,
-        allow_methods=["*"],
-        allow_headers=["*"],
+        allow_origins=backend_config.cors_config.allow_origins,
+        allow_credentials=backend_config.cors_config.allow_credentials,
+        allow_methods=backend_config.cors_config.allow_methods,
+        allow_headers=backend_config.cors_config.allow_headers,
     )

gs/backend/config/config.py

@@ -4,9 +4,24 @@
 
 from dotenv import load_dotenv
 
+from .cors_config import CORSConfig
+from .logger_config import LoggerConfig
+
 load_dotenv()
 
 
+class BackendConfiguration:
+    """
+    Class for storing backend configuration settings
+    """
+
+    def __init__(self) -> None:
+        self.cors_config = CORSConfig()
+        self.logger_config = LoggerConfig()
+
+
+backend_config = BackendConfiguration()
+
 # TODO: Make these throw an exception if they are None
 GS_DATABASE_USER = environ.get("GS_DATABASE_USER")
 GS_DATABASE_PASSWORD = environ.get("GS_DATABASE_PASSWORD")

gs/backend/config/cors_config.py

@@ -0,0 +1,14 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class CORSConfig(BaseSettings):
+    """
+    Pydantic class for storing CORS middleware configuration settings
+    """
+
+    model_config = SettingsConfigDict(env_prefix="CORS_")
+
+    allow_origins: list[str] = ["http://localhost:5173"]
+    allow_credentials: bool = True
+    allow_methods: list[str] = ["*"]
+    allow_headers: list[str] = ["*"]

gs/backend/config/logger_config.py

@@ -0,0 +1,13 @@
+from collections.abc import Sequence
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class LoggerConfig(BaseSettings):
+    """
+    Pydantic class for storing logger middleware configuration settings
+    """
+
+    model_config = SettingsConfigDict(env_prefix="LOGGER_")
+
+    excluded_endpoints: Sequence[str] = []

python_test/test_config_manager.py

@@ -0,0 +1,29 @@
+import importlib
+
+from gs.backend.config import config
+from gs.backend.config.cors_config import CORSConfig
+from gs.backend.config.logger_config import LoggerConfig
+
+
+def test_logger_config_default():
+    cfg = LoggerConfig()
+    assert cfg.excluded_endpoints == []
+
+
+def test_cors_config_default():
+    cfg = CORSConfig()
+
+    assert cfg.allow_origins == ["http://localhost:5173"]
+    assert cfg.allow_credentials == True
+    assert cfg.allow_methods == ["*"]
+    assert cfg.allow_headers == ["*"]
+
+
+def test_backend_configuration_from_env(monkeypatch):
+    monkeypatch.setenv("LOGGER_EXCLUDED_ENDPOINTS", '["/test"]')
+    monkeypatch.setenv("CORS_ALLOW_ORIGINS", '["http://test.com"]')
+
+    importlib.reload(config)
+    cfg = config.backend_config
+    assert "/test" in cfg.logger_config.excluded_endpoints
+    assert "http://test.com" in cfg.cors_config.allow_origins

requirements.txt

@@ -15,6 +15,7 @@ hypothesis==6.131.30
 psycopg2-binary==2.9.10
 python-dotenv==1.1.0
 tqdm==4.67
+pydantic-settings==2.4.0
 
 # Typed packages
 types-requests==2.31.0