refactor: error handling with model

Author: jgfranco17

api/errorhandling/errors.py

@@ -0,0 +1,28 @@
+from dataclasses import asdict, dataclass
+from typing import Optional
+
+from fastapi import HTTPException
+
+
+@dataclass(frozen=True)
+class ErrorResponse:
+    status_code: int
+    text: str
+    solution: Optional[str] = None
+    additional_info: Optional[str] = None
+
+    def json(self) -> dict[str, str | int]:
+        """Generate a JSON instance from the error content.
+
+        Returns:
+            dict[str, str | int]: JSON representation of the error
+        """
+        return asdict(self)
+
+    def as_http_exception(self) -> HTTPException:
+        """Convert the error response into an HTTPException.
+
+        Returns:
+            HTTPException: Raisable HTTP exception with details
+        """
+        return HTTPException(status_code=self.status_code, detail=self.json())

api/routes/v0/fizzbuzz.py

@@ -3,14 +3,15 @@
 import logging
 import os
 from http import HTTPStatus
-from typing import Optional, Tuple
+from typing import Tuple
 
-from fastapi import APIRouter, HTTPException
+from fastapi import APIRouter
 from redis import Redis
 
 from api.core.computation import generate_fizzbuzz_sequence
 from api.core.constants import EnvironmentVariables, RedisConfigs
 from api.core.models import FizzBuzzSequence
+from api.errorhandling.errors import ErrorResponse
 
 logger = logging.getLogger(__name__)
 redis_client = Redis(
@@ -44,19 +45,16 @@ def __validate_number_input(value: int) -> Tuple[bool, str]:
 @router_v0.get("/fizzbuzz")
 def compute(number: int) -> FizzBuzzSequence:
     """Compute the fizzbuzz sequence until the given number."""
-    try:
-        is_valid, error_message = __validate_number_input(number)
-        if not is_valid:
-            raise HTTPException(
-                status_code=HTTPStatus.BAD_REQUEST,
-                detail={"error": error_message},
-            )
-    except HTTPException as http_err:
-        logger.error(f"Invalid input: {http_err.detail}")
-        raise HTTPException(
-            status_code=http_err.status_code,
-            detail={"error": f"Invalid input: {http_err.detail}"},
+
+    is_valid, error_message = __validate_number_input(number)
+    if not is_valid:
+        logger.error(f"Invalid input: {error_message}")
+        error_data = ErrorResponse(
+            status_code=HTTPStatus.BAD_REQUEST,
+            text=error_message,
+            solution="Please provide a valid 'number' query parameter and try again",
         )
+        raise error_data.as_http_exception()
 
     cache_key = f"fizzbuzz:{number}"
     if __should_use_cache():

justfile

@@ -47,9 +47,6 @@ clean:
 pytest *args:
 	@echo "Running unittest suite..."
 	poetry run pytest {{ args }}
-	-@find ./ -name '__pycache__' -exec rm -rf {} \;
-	-@rm -rf .pytest_cache
-	@echo "Cleaned up test environment"
 
 coverage:
     @poetry run coverage run -m pytest

tests/test_api.py

@@ -60,8 +60,7 @@ def test_compute_endpoint_valid_input(client: TestClient):
 @pytest.mark.api
 def test_compute_endpoint_no_number(client: TestClient):
     response = client.get("/v0/fizzbuzz")
-    assert response.status_code == 400
-    assert "no number provided" in response.json()["message"]
+    assert response.status_code == 422
 
 
 @pytest.mark.api
@@ -76,7 +75,10 @@ def test_compute_endpoint_no_number(client: TestClient):
 def test_compute_endpoint_invalid_number(client: TestClient, value: int, error: str):
     response = client.get(f"/v0/fizzbuzz?number={value}")
     assert response.status_code == 400
-    assert error in response.json()["message"]
+    error_detail = response.json()["message"]
+    assert (
+        error in error_detail["text"]
+    ), f"Expected error message to contain '{error_detail}'"
 
 
 @pytest.mark.api