refactor: migrate CoderAPI configuration to centralized config module

- Replaced dotenv loading in CoderAPI with centralized configuration from config.py, enhancing consistency and maintainability.
- Updated CoderAPI initialization to use environment variables directly from the config module.
- Adjusted error messages to reflect the new configuration approach, improving clarity for required variables.
- Streamlined imports across various modules to utilize the new configuration structure, promoting better organization.

Author: atyrode

src/backend/coder.py

@@ -1,26 +1,22 @@
 import os
 import requests
-from dotenv import load_dotenv
+from config import CODER_API_KEY, CODER_URL, CODER_TEMPLATE_ID, CODER_DEFAULT_ORGANIZATION, CODER_WORKSPACE_NAME
 
 class CoderAPI:
     """
-    A class for interacting with the Coder API using credentials from .env file
+    A class for interacting with the Coder API using credentials from config
     """
 
     def __init__(self):
-        # Load environment variables from .env file
-        load_dotenv()
+        # Get configuration from config
+        self.api_key = CODER_API_KEY
+        self.coder_url = CODER_URL
+        self.template_id = CODER_TEMPLATE_ID
+        self.default_organization_id = CODER_DEFAULT_ORGANIZATION
 
-        # Get configuration from environment variables
-        self.api_key = os.getenv("CODER_API_KEY")
-        self.coder_url = os.getenv("CODER_URL")
-        self.user_id = os.getenv("USER_ID")
-        self.template_id = os.getenv("CODER_TEMPLATE_ID")
-        self.default_organization_id = os.getenv("CODER_DEFAULT_ORGANIZATION")
-        
-        # Check if required environment variables are set
+        # Check if required configuration variables are set
         if not self.api_key or not self.coder_url:
-            raise ValueError("CODER_API_KEY and CODER_URL must be set in .env file")
+            raise ValueError("CODER_API_KEY and CODER_URL must be set in environment variables")
 
         # Set up common headers for API requests
         self.headers = {
@@ -56,9 +52,9 @@ def create_workspace(self, user_id, parameter_values=None):
         template_id = self.template_id
 
         if not template_id:
-            raise ValueError("template_id must be provided or TEMPLATE_ID must be set in .env")
+            raise ValueError("template_id must be provided or TEMPLATE_ID must be set in environment variables")
 
-        name = os.getenv("CODER_WORKSPACE_NAME", "ubuntu")
+        name = CODER_WORKSPACE_NAME
 
         # Prepare the request data
         data = {
@@ -201,7 +197,7 @@ def get_workspace_status_for_user(self, username):
         Returns:
             dict: Workspace status data if found, None otherwise
         """
-        workspace_name = os.getenv("CODER_WORKSPACE_NAME", "ubuntu")
+        workspace_name = CODER_WORKSPACE_NAME
 
         endpoint = f"{self.coder_url}/api/v2/users/{username}/workspace/{workspace_name}"
         response = requests.get(endpoint, headers=self.headers)
@@ -282,4 +278,4 @@ def stop_workspace(self, workspace_id):
         headers['Content-Type'] = 'application/json'
         response = requests.post(endpoint, headers=headers, json=data)
         response.raise_for_status()
-        return response.json()
+        return response.json()

src/backend/config.py

@@ -7,29 +7,46 @@
 from typing import Optional, Dict, Any, Tuple
 from dotenv import load_dotenv
 
+# Load environment variables once
 load_dotenv()
 
+# ===== Application Configuration =====
 STATIC_DIR = os.getenv("STATIC_DIR")
 ASSETS_DIR = os.getenv("ASSETS_DIR")
+FRONTEND_URL = os.getenv('FRONTEND_URL')
 
-OIDC_CONFIG = {
-    'client_id': os.getenv('OIDC_CLIENT_ID'),
-    'client_secret': os.getenv('OIDC_CLIENT_SECRET'),
-    'server_url': os.getenv('OIDC_SERVER_URL'),
-    'realm': os.getenv('OIDC_REALM'),
-    'redirect_uri': os.getenv('REDIRECT_URI'),
-    'frontend_url': os.getenv('FRONTEND_URL')
-}
+# ===== PostHog Configuration =====
+POSTHOG_API_KEY = os.getenv("VITE_PUBLIC_POSTHOG_KEY")
+POSTHOG_HOST = os.getenv("VITE_PUBLIC_POSTHOG_HOST")
+
+# ===== OIDC Configuration =====
+OIDC_CLIENT_ID = os.getenv('OIDC_CLIENT_ID')
+OIDC_CLIENT_SECRET = os.getenv('OIDC_CLIENT_SECRET')
+OIDC_SERVER_URL = os.getenv('OIDC_SERVER_URL')
+OIDC_REALM = os.getenv('OIDC_REALM')
+OIDC_REDIRECT_URI = os.getenv('REDIRECT_URI')
+
+# ===== Redis Configuration =====
+REDIS_HOST = os.getenv('REDIS_HOST', 'localhost')
+REDIS_PASSWORD = os.getenv('REDIS_PASSWORD', None)
+REDIS_PORT = int(os.getenv('REDIS_PORT', 6379))
 
 # Redis connection
 redis_client = redis.Redis(
-    host=os.getenv('REDIS_HOST', 'localhost'),
-    password=os.getenv('REDIS_PASSWORD', None),
-    port=int(os.getenv('REDIS_PORT', 6379)),
+    host=REDIS_HOST,
+    password=REDIS_PASSWORD,
+    port=REDIS_PORT,
     db=0,
     decode_responses=True
 )
 
+# ===== Coder API Configuration =====
+CODER_API_KEY = os.getenv("CODER_API_KEY")
+CODER_URL = os.getenv("CODER_URL")
+CODER_TEMPLATE_ID = os.getenv("CODER_TEMPLATE_ID")
+CODER_DEFAULT_ORGANIZATION = os.getenv("CODER_DEFAULT_ORGANIZATION")
+CODER_WORKSPACE_NAME = os.getenv("CODER_WORKSPACE_NAME", "ubuntu")
+
 # Session management functions
 def get_session(session_id: str) -> Optional[Dict[str, Any]]:
     """Get session data from Redis"""

src/backend/main.py

@@ -8,10 +8,9 @@
 from fastapi.responses import FileResponse
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
-from dotenv import load_dotenv
 
 from database import init_db
-from config import STATIC_DIR, ASSETS_DIR
+from config import STATIC_DIR, ASSETS_DIR, POSTHOG_API_KEY, POSTHOG_HOST
 from dependencies import UserSession, optional_auth
 from routers.auth_router import auth_router
 from routers.user_router import user_router
@@ -21,11 +20,7 @@
 from database.service import TemplatePadService
 from database.database import async_session
 
-load_dotenv()
-
-POSTHOG_API_KEY = os.environ.get("VITE_PUBLIC_POSTHOG_KEY")
-POSTHOG_HOST = os.environ.get("VITE_PUBLIC_POSTHOG_HOST")
-
+# Initialize PostHog if API key is available
 if POSTHOG_API_KEY:
     posthog.project_api_key = POSTHOG_API_KEY
     posthog.host = POSTHOG_HOST

src/backend/routers/auth_router.py

@@ -5,7 +5,8 @@
 from fastapi.responses import RedirectResponse, FileResponse, JSONResponse
 import os
 
-from config import get_auth_url, get_token_url, OIDC_CONFIG, set_session, delete_session, STATIC_DIR, get_session
+from config import (get_auth_url, get_token_url, set_session, delete_session, get_session, 
+                    FRONTEND_URL, OIDC_CLIENT_ID, OIDC_CLIENT_SECRET, OIDC_SERVER_URL, OIDC_REALM, OIDC_REDIRECT_URI, STATIC_DIR)
 from dependencies import get_coder_api
 from coder import CoderAPI
 
@@ -47,10 +48,10 @@ async def callback(
             get_token_url(),
             data={
                 'grant_type': 'authorization_code',
-                'client_id': OIDC_CONFIG['client_id'],
-                'client_secret': OIDC_CONFIG['client_secret'],
+                'client_id': OIDC_CLIENT_ID,
+                'client_secret': OIDC_CLIENT_SECRET,
                 'code': code,
-                'redirect_uri': OIDC_CONFIG['redirect_uri']
+                'redirect_uri': OIDC_REDIRECT_URI
             }
         )
 
@@ -91,9 +92,8 @@ async def logout(request: Request):
     delete_session(session_id)
 
     # Create the Keycloak logout URL with redirect back to our app
-    logout_url = f"{OIDC_CONFIG['server_url']}/realms/{OIDC_CONFIG['realm']}/protocol/openid-connect/logout"
-    redirect_uri = OIDC_CONFIG['frontend_url']  # Match the frontend redirect URI
-    full_logout_url = f"{logout_url}?id_token_hint={id_token}&post_logout_redirect_uri={redirect_uri}"
+    logout_url = f"{OIDC_SERVER_URL}/realms/{OIDC_REALM}/protocol/openid-connect/logout"
+    full_logout_url = f"{logout_url}?id_token_hint={id_token}&post_logout_redirect_uri={FRONTEND_URL}"
 
     # Create a redirect response to Keycloak's logout endpoint
     response = JSONResponse({"status": "success", "logout_url": full_logout_url})

src/backend/routers/user_router.py

@@ -4,7 +4,7 @@
 import posthog
 from fastapi import APIRouter, Depends, HTTPException
 
-from config import redis_client, OIDC_CONFIG
+from config import redis_client, FRONTEND_URL
 from database import get_user_service
 from database.service import UserService
 from dependencies import UserSession, require_admin, require_auth
@@ -81,7 +81,7 @@ async def get_user_info(
 
     if os.getenv("VITE_PUBLIC_POSTHOG_KEY"):
         telemetry = user_data.copy()
-        telemetry["$current_url"] = OIDC_CONFIG["frontend_url"]
+        telemetry["$current_url"] = FRONTEND_URL
         posthog.identify(distinct_id=user_data["id"], properties=telemetry)
 
     return user