API Refactoring

lib/__init__.py

@@ -1,10 +1,18 @@
 # lib/__init__.py
 import logging
-from .api import app
 
 logging.basicConfig(
     level=logging.INFO,
     filename='app.log',
     filemode='a',
     format='%(asctime)s - %(levelname)s - %(message)s',
 )
+
+
+def parse_error(error):
+    exc_type = type(error).__name__
+    exc_obj = f"{error}".replace("\n", " ").replace("   ", " ")
+    return f"{exc_type} exception: {exc_obj}"
+
+
+from .api import app  # noqa

lib/api.py

@@ -8,7 +8,7 @@
 from fastapi.openapi.utils import get_openapi
 from fastapi.responses import RedirectResponse, JSONResponse
 
-from lib import logging
+from lib import logging, parse_error
 from lib.routes import flight, environment, motor, rocket
 
 logger = logging.getLogger(__name__)
@@ -84,9 +84,8 @@ async def __perform_healthcheck():
 async def validation_exception_handler(
     request: Request, exc: RequestValidationError
 ):
-    exc_str = f"{exc}".replace("\n", " ").replace("   ", " ")
+    exc_str = parse_error(exc)
     logger.error(f"{request}: {exc_str}")
-    content = {"status_code": 10422, "message": exc_str, "data": None}
     return JSONResponse(
-        content=content, status_code=status.HTTP_422_UNPROCESSABLE_ENTITY
+        content=exc_str, status_code=status.HTTP_422_UNPROCESSABLE_ENTITY
     )

lib/controllers/__init__.py

@@ -1,6 +1 @@
 # lib/controllers/__init__.py
-
-
-def parse_error(e):
-    exc_str = f"{e}".replace("\n", " ").replace("   ", " ")
-    return exc_str

lib/controllers/environment.py

@@ -4,8 +4,7 @@
 from rocketpy.environment.environment import Environment as RocketPyEnvironment
 from fastapi import HTTPException, status
 
-from lib import logging
-from lib.controllers import parse_error
+from lib import logging, parse_error
 from lib.models.environment import Env
 from lib.repositories.environment import EnvRepository
 from lib.views.environment import (
@@ -30,7 +29,7 @@ class EnvController:
 
     Enables:
         - Simulation of RocketPyEnvironment from models.Env
-        - CRUD operations over modeols.Env on the database
+        - CRUD operations over models.Env on the database
     """
 
     def __init__(self, env: Env):
@@ -45,7 +44,7 @@ def env(self, env: Env):
         self._env = env
 
     @staticmethod
-    async def get_rocketpy_env(env: Env) -> RocketPyEnvironment:
+    def get_rocketpy_env(env: Env) -> RocketPyEnvironment:
         """
         Get the rocketpy env object.
 
@@ -63,38 +62,36 @@ async def get_rocketpy_env(env: Env) -> RocketPyEnvironment:
         )
         return rocketpy_env
 
-    async def create_env(self) -> "Union[EnvCreated, HTTPException]":
+    async def create_env(self) -> Union[EnvCreated, HTTPException]:
         """
         Create a env in the database.
 
         Returns:
             views.EnvCreated
         """
         try:
-            created_env = await EnvRepository(
-                environment=self.env
-            ).create_env()
+            await EnvRepository.fetch_env(self.env).create_env()
         except Exception as e:
             exc_str = parse_error(e)
             logger.error(f"controllers.environment.create_env: {exc_str}")
             raise HTTPException(
                 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                detail=f"Failed to create environment: {e}",
+                detail=f"Failed to create environment: {exc_str}",
             ) from e
         else:
-            return EnvCreated(env_id=created_env.env_id)
+            return EnvCreated(env_id=self.env.env_id)
         finally:
             logger.info(
-                f"Call to controllers.environment.create_env completed; params: Env {hash(self.env)}"
+                f"Call to controllers.environment.create_env completed for Env {hash(self.env)}"
             )
 
     @staticmethod
-    async def get_env_by_id(env_id: int) -> "Union[Env, HTTPException]":
+    async def get_env_by_id(env_id: str) -> Union[Env, HTTPException]:
         """
         Get a env from the database.
 
         Args:
-            env_id: int
+            env_id: str
 
         Returns:
             models.Env
@@ -103,13 +100,13 @@ async def get_env_by_id(env_id: int) -> "Union[Env, HTTPException]":
             HTTP 404 Not Found: If the env is not found in the database.
         """
         try:
-            read_env = await EnvRepository(env_id=env_id).get_env()
+            read_env = await EnvRepository().get_env_by_id(env_id)
         except Exception as e:
             exc_str = parse_error(e)
             logger.error(f"controllers.environment.get_env_by_id: {exc_str}")
             raise HTTPException(
                 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                detail=f"Failed to read environment: {e}",
+                detail=f"Failed to read environment: {exc_str}",
             ) from e
         else:
             if read_env:
@@ -120,19 +117,19 @@ async def get_env_by_id(env_id: int) -> "Union[Env, HTTPException]":
             )
         finally:
             logger.info(
-                f"Call to controllers.environment.get_env_by_id completed; params: EnvID {env_id}"
+                f"Call to controllers.environment.get_env_by_id completed for Env {env_id}"
             )
 
     @classmethod
     async def get_rocketpy_env_as_jsonpickle(
         cls,
-        env_id: int,
-    ) -> "Union[EnvPickle, HTTPException]":
+        env_id: str,
+    ) -> Union[EnvPickle, HTTPException]:
         """
         Get rocketpy.Environmnet as jsonpickle string.
 
         Args:
-            env_id: int
+            env_id: str
 
         Returns:
             views.EnvPickle
@@ -142,6 +139,7 @@ async def get_rocketpy_env_as_jsonpickle(
         """
         try:
             read_env = await cls.get_env_by_id(env_id)
+            rocketpy_env = cls.get_rocketpy_env(read_env)
         except HTTPException as e:
             raise e from e
         except Exception as e:
@@ -151,26 +149,25 @@ async def get_rocketpy_env_as_jsonpickle(
             )
             raise HTTPException(
                 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                detail=f"Failed to read environment: {e}",
+                detail=f"Failed to read environment: {exc_str}",
             ) from e
         else:
-            rocketpy_env = await cls.get_rocketpy_env(read_env)
             return EnvPickle(
                 jsonpickle_rocketpy_env=jsonpickle.encode(rocketpy_env)
             )
         finally:
             logger.info(
-                f"Call to controllers.environment.get_rocketpy_env_as_jsonpickle completed; params: EnvID {env_id}"
+                f"Call to controllers.environment.get_rocketpy_env_as_jsonpickle completed for Env {env_id}"
             )
 
-    async def update_env(
-        self, env_id: int
-    ) -> "Union[EnvUpdated, HTTPException]":
+    async def update_env_by_id(
+        self, env_id: str
+    ) -> Union[EnvUpdated, HTTPException]:
         """
-        Update a env in the database.
+        Update a models.Env in the database.
 
         Args:
-            env_id: int
+            env_id: str
 
         Returns:
             views.EnvUpdated
@@ -179,33 +176,31 @@ async def update_env(
             HTTP 404 Not Found: If the env is not found in the database.
         """
         try:
-            await EnvController.get_env_by_id(env_id)
-            updated_env = await EnvRepository(
-                environment=self.env, env_id=env_id
-            ).update_env()
-        except HTTPException as e:
-            raise e from e
+            env_repo = await EnvRepository.fetch_env(self.env).create_env()
+            await env_repo.delete_env_by_id(env_id)
         except Exception as e:
             exc_str = parse_error(e)
             logger.error(f"controllers.environment.update_env: {exc_str}")
             raise HTTPException(
                 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                detail=f"Failed to update environment: {e}",
+                detail=f"Failed to update environment: {exc_str}",
             ) from e
         else:
-            return EnvUpdated(new_env_id=updated_env.env_id)
+            return EnvUpdated(new_env_id=self.env.env_id)
         finally:
             logger.info(
-                f"Call to controllers.environment.update_env completed; params: EnvID {env_id}, Env {hash(self.env)}"
+                f"Call to controllers.environment.update_env completed for Env {env_id}; Env {hash(self.env)}"
             )
 
     @staticmethod
-    async def delete_env(env_id: str) -> "Union[EnvDeleted, HTTPException]":
+    async def delete_env_by_id(
+        env_id: str,
+    ) -> Union[EnvDeleted, HTTPException]:
         """
-        Delete a env from the database.
+        Delete a models.Env from the database.
 
         Args:
-            env_id: int
+            env_id: str
 
         Returns:
             views.EnvDeleted
@@ -214,28 +209,30 @@ async def delete_env(env_id: str) -> "Union[EnvDeleted, HTTPException]":
             HTTP 404 Not Found: If the env is not found in the database.
         """
         try:
-            await EnvRepository(env_id=env_id).delete_env()
+            await EnvRepository().delete_env_by_id(env_id)
         except Exception as e:
             exc_str = parse_error(e)
             logger.error(f"controllers.environment.delete_env: {exc_str}")
             raise HTTPException(
                 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                detail=f"Failed to delete environment: {e}",
+                detail=f"Failed to delete environment: {exc_str}",
             ) from e
         else:
             return EnvDeleted(deleted_env_id=env_id)
         finally:
             logger.info(
-                f"Call to controllers.environment.delete_env completed; params: EnvID {env_id}"
+                f"Call to controllers.environment.delete_env completed for Env {env_id}"
             )
 
     @classmethod
-    async def simulate(cls, env_id: int) -> "Union[EnvSummary, HTTPException]":
+    async def simulate_env(
+        cls, env_id: str
+    ) -> Union[EnvSummary, HTTPException]:
         """
         Simulate a rocket environment.
 
         Args:
-            env_id: int.
+            env_id: str.
 
         Returns:
             views.EnvSummary
@@ -245,7 +242,7 @@ async def simulate(cls, env_id: int) -> "Union[EnvSummary, HTTPException]":
         """
         try:
             read_env = await cls.get_env_by_id(env_id)
-            rocketpy_env = await cls.get_rocketpy_env(read_env)
+            rocketpy_env = cls.get_rocketpy_env(read_env)
             env_simulation_numbers = EnvData.parse_obj(
                 rocketpy_env.all_info_returned()
             )
@@ -262,11 +259,11 @@ async def simulate(cls, env_id: int) -> "Union[EnvSummary, HTTPException]":
             logger.error(f"controllers.environment.simulate: {exc_str}")
             raise HTTPException(
                 status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-                detail=f"Failed to simulate environment: {e}",
+                detail=f"Failed to simulate environment: {exc_str}",
             ) from e
         else:
             return env_summary
         finally:
             logger.info(
-                f"Call to controllers.environment.simulate completed; params: EnvID {env_id}"
+                f"Call to controllers.environment.simulate completed for Env {env_id}"
             )