chore: consolidate load_dotenv + remove decorative headers + fix emojis

DevanshuNEU · DevanshuNEU · commit c649e25f30f4 · 2026-02-22T20:03:55.000-05:00
OPE-86: Consolidate load_dotenv() to single call in main.py
- Added load_dotenv() at top of main.py BEFORE any service imports
- Removed from: dependencies.py, cache.py, indexer_optimized.py,
  supabase_service.py (4 duplicate calls)
- Prevents import-order-dependent env var issues

OPE-74: Remove decorative ASCII headers
- Removed '# =====' and '# -----' section dividers from 13 files
- Affected: main.py, config/api.py, middleware/auth.py,
  observability.py, sentry.py, playground_limiter.py, playground.py,
  supabase_service.py, conftest.py, and 4 test files
- Plain section comments retained where they add value

OPE-74: Fix emojis in sentry.py startup messages
- Replaced emoji print statements with plain text markers:
  [INFO], [OK], [WARN]

Net change: -104 lines (113 deleted, 9 added).
284 tests pass.

Closes OPE-86, OPE-74
diff --git a/backend/config/api.py b/backend/config/api.py
@@ -5,15 +5,11 @@
 Example: "v1" -> "v2" will change /api/v1/* to /api/v2/*
 """
 
-# =============================================================================
 # API VERSION CONFIGURATION
-# =============================================================================
 
 API_VERSION = "v1"
 
-# =============================================================================
 # DERIVED PREFIXES (auto-calculated from version)
-# =============================================================================
 
 # Current versioned API prefix: /api/v1
 API_PREFIX = f"/api/{API_VERSION}"
@@ -22,9 +18,7 @@
 # Routes here will be deprecated but still functional
 LEGACY_API_PREFIX = "/api"
 
-# =============================================================================
 # DEPRECATION SETTINGS
-# =============================================================================
 
 # When True, legacy routes (/api/*) will include deprecation warning headers
 LEGACY_DEPRECATION_ENABLED = True
@@ -33,9 +27,7 @@
 DEPRECATION_HEADER = "X-API-Deprecated"
 DEPRECATION_MESSAGE = f"This endpoint is deprecated. Please use {API_PREFIX} instead."
 
-# =============================================================================
 # HELPER FUNCTIONS
-# =============================================================================
 
 def get_versioned_prefix() -> str:
     """Get the current versioned API prefix."""
diff --git a/backend/dependencies.py b/backend/dependencies.py
@@ -3,10 +3,6 @@
 All route modules import from here to avoid circular imports.
 """
 from fastapi import HTTPException, Depends
-from dotenv import load_dotenv
-
-# Load env vars first
-load_dotenv()
 
 from services.indexer_optimized import OptimizedCodeIndexer
 from services.repo_manager import RepositoryManager
diff --git a/backend/main.py b/backend/main.py
@@ -2,6 +2,11 @@
 CodeIntel Backend API
 FastAPI backend for codebase intelligence
 """
+# Load environment variables ONCE, before any service imports.
+# Do not call load_dotenv() anywhere else in the codebase.
+from dotenv import load_dotenv
+load_dotenv()
+
 from contextlib import asynccontextmanager
 from fastapi import FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
@@ -51,7 +56,6 @@ async def lifespan(app: FastAPI):
 )
 
 
-# ===== MIDDLEWARE =====
 
 class RequestSizeLimitMiddleware(BaseHTTPMiddleware):
     """Limit request body size to prevent abuse."""
@@ -81,7 +85,6 @@ async def dispatch(self, request: Request, call_next):
 )
 
 
-# ===== ROUTERS =====
 # All API routes are prefixed with API_PREFIX (e.g., /api/v1)
 # Route files define their sub-path (e.g., /auth, /repos)
 # Final paths: /api/v1/auth, /api/v1/repos, etc.
@@ -104,7 +107,6 @@ async def dispatch(self, request: Request, call_next):
 app.add_api_websocket_route(f"{API_PREFIX}/ws/repos/{{repo_id}}/indexing", websocket_repo_indexing)
 
 
-# ===== ERROR HANDLERS =====
 
 @app.exception_handler(RequestValidationError)
 async def validation_exception_handler(request: Request, exc: RequestValidationError):
diff --git a/backend/middleware/auth.py b/backend/middleware/auth.py
@@ -29,9 +29,7 @@ async def demo_search(auth: AuthContext = Depends(public_auth)):
 from fastapi.security.http import HTTPAuthorizationCredentials
 
 
-# ---------------------------------------------------------------------------
 # Auth Context - unified return type for all auth methods
-# ---------------------------------------------------------------------------
 
 @dataclass
 class AuthContext:
@@ -52,17 +50,13 @@ def identifier(self) -> str:
         return self.user_id or self.api_key_name or "anonymous"
 
 
-# ---------------------------------------------------------------------------
 # Bearer token scheme (auto_error=False allows optional auth)
-# ---------------------------------------------------------------------------
 
 _bearer = HTTPBearer(auto_error=False)
 _bearer_required = HTTPBearer(auto_error=True)
 
 
-# ---------------------------------------------------------------------------
 # Core validation functions
-# ---------------------------------------------------------------------------
 
 def _validate_jwt(token: str) -> Optional[AuthContext]:
     """Validate Supabase JWT token"""
@@ -143,9 +137,7 @@ def _authenticate(token: str) -> AuthContext:
     )
 
 
-# ---------------------------------------------------------------------------
 # FastAPI Dependencies - use these in your routes
-# ---------------------------------------------------------------------------
 
 async def require_auth(
     credentials: HTTPAuthorizationCredentials = Depends(_bearer_required)
@@ -177,9 +169,7 @@ async def public_auth(
         return AuthContext(is_public=True)
 
 
-# ---------------------------------------------------------------------------
 # Legacy functions - kept for backwards compatibility
-# ---------------------------------------------------------------------------
 
 async def get_current_user(
     credentials: HTTPAuthorizationCredentials = Depends(_bearer_required)
diff --git a/backend/routes/playground.py b/backend/routes/playground.py
@@ -785,9 +785,7 @@ async def validate_github_repo(request: ValidateRepoRequest, req: Request):
     return result
 
 
-# =============================================================================
 # Anonymous Indexing Endpoint (#125)
-# =============================================================================
 
 @router.post("/index", status_code=202)
 async def start_anonymous_indexing(
@@ -1030,9 +1028,7 @@ async def start_anonymous_indexing(
     return response_data
 
 
-# =============================================================================
 # GET /playground/index/{job_id} - Check indexing job status (#126)
-# =============================================================================
 
 @router.get(
     "/index/{job_id}",
diff --git a/backend/services/cache.py b/backend/services/cache.py
@@ -7,12 +7,9 @@
 import hashlib
 from typing import Optional, List, Dict
 import os
-from dotenv import load_dotenv
 
 from services.observability import logger, metrics
 
-load_dotenv()
-
 # Configuration
 REDIS_URL = os.getenv("REDIS_URL")  # Railway/Cloud Redis URL
 REDIS_HOST = os.getenv("REDIS_HOST", "localhost")
diff --git a/backend/services/indexer_optimized.py b/backend/services/indexer_optimized.py
@@ -27,7 +27,6 @@
 
 # Utils
 import hashlib
-from dotenv import load_dotenv
 import time
 
 # Search enhancement
@@ -39,8 +38,6 @@
 # Observability
 from services.observability import logger, trace_operation, track_time, capture_exception, add_breadcrumb, metrics
 
-load_dotenv()
-
 # Configuration
 # Note: If using existing Pinecone index, match the dimension (1536 for small, 3072 for large)
 EMBEDDING_MODEL = os.getenv("EMBEDDING_MODEL", "text-embedding-3-small")
diff --git a/backend/services/observability.py b/backend/services/observability.py
@@ -30,9 +30,7 @@ async def index_repo(repo_id: str):
 LOG_LEVEL = os.getenv("LOG_LEVEL", "INFO" if IS_PRODUCTION else "DEBUG")
 
 
-# =============================================================================
 # STRUCTURED LOGGER
-# =============================================================================
 
 class StructuredLogger:
     """
@@ -112,9 +110,7 @@ def critical(self, message: str, **kwargs):
 logger = StructuredLogger()
 
 
-# =============================================================================
 # SENTRY INTEGRATION HELPERS
-# =============================================================================
 
 def set_operation_context(operation: str, **kwargs):
     """
@@ -191,9 +187,7 @@ def capture_message(message: str, level: str = "info", **context):
         pass
 
 
-# =============================================================================
 # PERFORMANCE TRACKING
-# =============================================================================
 
 @contextmanager
 def track_time(operation: str, **tags):
@@ -307,9 +301,7 @@ def sync_wrapper(*args, **kwargs):
     return decorator
 
 
-# =============================================================================
 # SIMPLE METRICS (in-memory counters)
-# =============================================================================
 
 class Metrics:
     """
diff --git a/backend/services/playground_limiter.py b/backend/services/playground_limiter.py
@@ -25,9 +25,7 @@
 from services.sentry import capture_exception
 
 
-# =============================================================================
 # DATA CLASSES
-# =============================================================================
 
 @dataclass
 class PlaygroundLimitResult:
@@ -134,9 +132,7 @@ def _truncate_id(session_id: str) -> str:
         return session_id
 
 
-# =============================================================================
 # MAIN CLASS
-# =============================================================================
 
 class PlaygroundLimiter:
     """
@@ -788,9 +784,7 @@ def get_usage_stats(self) -> dict:
             return {"error": str(e), "redis_available": False}
 
 
-# =============================================================================
 # SINGLETON
-# =============================================================================
 
 _playground_limiter: Optional[PlaygroundLimiter] = None
 
diff --git a/backend/services/sentry.py b/backend/services/sentry.py
@@ -19,7 +19,7 @@ def init_sentry() -> bool:
     sentry_dsn = os.getenv("SENTRY_DSN")
 
     if not sentry_dsn:
-        print("ℹ️  Sentry DSN not configured - error tracking disabled")
+        print("[INFO] Sentry DSN not configured - error tracking disabled")
         return False
 
     try:
@@ -61,14 +61,14 @@ def init_sentry() -> bool:
             include_local_variables=True,
         )
 
-        print(f"✅ Sentry initialized (environment: {environment})")
+        print(f"[OK] Sentry initialized (environment: {environment})")
         return True
 
     except ImportError:
-        print("⚠️  sentry-sdk not installed - error tracking disabled")
+        print("[WARN] sentry-sdk not installed - error tracking disabled")
         return False
     except Exception as e:
-        print(f"⚠️  Failed to initialize Sentry: {e}")
+        print(f"[WARN] Failed to initialize Sentry: {e}")
         return False
 
 
@@ -97,9 +97,7 @@ def _filter_events(event, hint):
     return event
 
 
-# ============================================================================
 # LEGACY FUNCTIONS - Use observability module for new code
-# ============================================================================
 
 def set_user_context(user_id: Optional[str] = None, email: Optional[str] = None):
     """
diff --git a/backend/services/supabase_service.py b/backend/services/supabase_service.py
@@ -6,12 +6,10 @@
 from typing import Dict, List, Optional, Any
 from datetime import datetime
 from supabase import create_client, Client, ClientOptions
-from dotenv import load_dotenv
 import uuid
 
 from services.observability import logger
 
-load_dotenv()
 
 
 class SupabaseService:
diff --git a/backend/tests/conftest.py b/backend/tests/conftest.py
@@ -20,9 +20,7 @@
 os.environ["SUPABASE_ANON_KEY"] = "test-anon-key"
 os.environ["SUPABASE_JWT_SECRET"] = "test-jwt-secret"
 
-# =============================================================================
 # EARLY PATCHING - runs during collection, before any imports
-# =============================================================================
 # These patches prevent external service initialization during test collection
 
 _pinecone_patcher = patch('pinecone.Pinecone')
@@ -47,7 +45,6 @@
 _supabase_client.auth.get_user.return_value = _auth_response
 _mock_supabase.return_value = _supabase_client
 
-# =============================================================================
 
 # Add backend to path
 backend_dir = Path(__file__).parent.parent
diff --git a/backend/tests/test_anonymous_indexing.py b/backend/tests/test_anonymous_indexing.py
@@ -22,9 +22,7 @@
 )
 
 
-# =============================================================================
 # REQUEST MODEL TESTS
-# =============================================================================
 
 class TestIndexRepoRequest:
     """Tests for IndexRepoRequest validation."""
@@ -76,9 +74,7 @@ def test_url_whitespace_trimmed(self):
         assert req.github_url == "https://github.com/user/repo"
 
 
-# =============================================================================
 # JOB MANAGER TESTS
-# =============================================================================
 
 class TestAnonymousIndexingJob:
     """Tests for AnonymousIndexingJob service."""
@@ -230,9 +226,7 @@ def test_update_status_failed_with_error(self, job_manager, mock_redis):
         assert result is True
 
 
-# =============================================================================
 # JOB DATACLASS TESTS
-# =============================================================================
 
 class TestJobDataclasses:
     """Tests for JobProgress and JobStats."""
@@ -268,9 +262,7 @@ def test_job_stats_to_dict(self):
         assert d["indexing_time_seconds"] == 45.5
 
 
-# =============================================================================
 # ENDPOINT TESTS (Integration)
-# =============================================================================
 
 class TestIndexEndpoint:
     """Integration tests for POST /playground/index."""
@@ -428,9 +420,7 @@ def test_github_rate_limit_returns_429(self, mock_metadata, client):
         assert response.status_code == 429
 
 
-# =============================================================================
 # SESSION CONFLICT TESTS
-# =============================================================================
 
 class TestSessionConflict:
     """Tests for session-already-has-repo behavior."""
@@ -514,9 +504,7 @@ def test_expired_repo_allows_new_indexing(
         assert response.json()["job_id"] == "idx_new123456"
 
 
-# =============================================================================
 # STATUS ENDPOINT TESTS (GET /playground/index/{job_id})
-# =============================================================================
 
 class TestStatusEndpoint:
     """Tests for GET /playground/index/{job_id} status endpoint."""
@@ -682,9 +670,7 @@ def test_partial_job_includes_partial_info(self, mock_job_class, client):
 
 
 
-# =============================================================================
 # Issue #128: Search User-Indexed Repos Tests
-# =============================================================================
 
 class TestSearchUserRepos:
     """Tests for searching user-indexed repositories."""
diff --git a/backend/tests/test_multi_tenancy.py b/backend/tests/test_multi_tenancy.py
diff --git a/backend/tests/test_playground_limiter.py b/backend/tests/test_playground_limiter.py
diff --git a/backend/tests/test_validate_repo.py b/backend/tests/test_validate_repo.py
