Refactor error handling.

Author: everaldorodrigo

src/handlers/api.py

@@ -17,6 +17,7 @@
 from controller.exceptions import ControllerError, NotFoundError
 from pipeline import MetaKGQueryPipeline
 from utils.downloader import DownloadError, download_async
+from utils.http_error import SmartAPIHTTPError
 from utils.metakg.export import edges2graphml
 from utils.metakg.path_finder import MetaKGPathFinder
 from utils.metakg.cytoscape_formatter import CytoscapeDataFormatter
@@ -112,7 +113,7 @@ class ValidateHandler(BaseHandler):
 
     async def get(self):
         if self.request.body:
-            raise HTTPError(status_code=400, log_message="GET takes no request body.")
+            raise HTTPError(status_code=400, reason="GET takes no request body.")
 
         raw = await self.download(self.args.url)
         self.validate(raw)
@@ -129,7 +130,7 @@ async def download(self, url):
         try:
             file = await download_async(url)
         except DownloadError as err:
-            raise HTTPError(status_code=400, log_message=str(err))
+            raise HTTPError(400, reason=str(err))
         else:  # other file info irrelevant for validation
             return file.raw
 
@@ -138,9 +139,8 @@ def validate(self, raw):
             smartapi = SmartAPI(SmartAPI.VALIDATION_ONLY)
             smartapi.raw = raw
             smartapi.validate()
-
         except (ControllerError, AssertionError) as err:
-            raise HTTPError(status_code=400, log_message=str(err))
+            raise SmartAPIHTTPError(400, reason=str(err))
         else:
             self.finish({"success": True, "details": f"valid SmartAPI ({smartapi.version}) metadata."})
 
@@ -169,14 +169,14 @@ async def post(self):
         try:
             file = await download_async(self.args.url)
         except DownloadError as err:
-            raise HTTPError(status_code=400, log_message=str(err)) from err
+            raise HTTPError(status_code=400, reason=str(err)) from err
 
         try:
             smartapi = SmartAPI(self.args.url)
             smartapi.raw = file.raw
             smartapi.validate()
         except (ControllerError, AssertionError) as err:
-            raise HTTPError(status_code=400, log_message=str(err)) from err
+            raise HTTPError(status_code=400, reason=str(err)) from err
 
         if self.args.dryrun:
             raise Finish({"success": True, "details": f"[Dryrun] Valid {smartapi.version} Metadata"})
@@ -186,7 +186,7 @@ async def post(self):
             smartapi.refresh(file)  # populate webdoc meta
             _id = smartapi.save()
         except ControllerError as err:
-            raise HTTPError(status_code=400, log_message=str(err)) from err
+            raise HTTPError(status_code=400, reason=str(err)) from err
         else:
             self.finish({"success": True, "_id": _id})
             await self._notify(smartapi)
@@ -258,14 +258,14 @@ async def put(self, _id):
 
         if self.args.slug is not None:
             if self.args.slug in {"api"}:  # reserved
-                raise HTTPError(status_code=400, log_message="slug is reserved")
+                raise HTTPError(status_code=400, reason="slug is reserved")
 
             try:  # update slug
                 smartapi.slug = self.args.slug or None
                 smartapi.save()
 
             except (ControllerError, ValueError) as err:
-                raise HTTPError(status_code=400, log_message=str(err)) from err
+                raise HTTPError(status_code=400, reason=str(err)) from err
 
             self.finish({"success": True})
 
@@ -299,7 +299,7 @@ def delete(self, _id):
         try:
             _id = smartapi.delete()
         except ControllerError as err:
-            raise HTTPError(status_code=400, log_message=str(err)) from err
+            raise HTTPError(status_code=400, reason=str(err)) from err
 
         self.finish({"success": True, "_id": _id})
 
@@ -345,7 +345,7 @@ class UptimeHandler(BaseHandler):
     @github_authenticated
     def get(self):
         if self.request.body:
-            raise HTTPError(status_code=400, log_message="GET takes no request body.")
+            raise HTTPError(status_code=400, reason="GET takes no request body.")
 
         if self.args.id:
             try:
@@ -357,11 +357,11 @@ def get(self):
             except NotFoundError:
                 raise HTTPError(status_code=404)
             except (ControllerError, AssertionError) as err:
-                raise HTTPError(status_code=400, log_message=str(err))
+                raise HTTPError(status_code=400, reason=str(err))
             else:
                 self.finish({"success": True, "details": status})
         else:
-            raise HTTPError(status_code=400, log_message="Missing required parameter: id")
+            raise HTTPError(status_code=400, reason="Missing required parameter: id")
 
     @github_authenticated
     def post(self):
@@ -375,11 +375,11 @@ def post(self):
             except NotFoundError:
                 raise HTTPError(status_code=404)
             except (ControllerError, AssertionError) as err:
-                raise HTTPError(status_code=400, log_message=str(err))
+                raise HTTPError(status_code=400, reason=str(err))
             else:
                 self.finish({"success": True, "details": status})
         else:
-            raise HTTPError(status_code=400, log_message="Missing required form field: id")
+            raise HTTPError(status_code=400, reason="Missing required form field: id")
 
 
 class MetaKGQueryHandler(QueryHandler):

src/utils/http_error.py

@@ -0,0 +1,39 @@
+from typing import Optional, Any
+from tornado.web import HTTPError
+import re
+
+
+class SmartAPIHTTPError(HTTPError):
+    """An extended HTTPError class with additional details and message sanitization.
+
+    Adds the following enhancements:
+    - A `details` parameter for including extra context about the error.
+    - A `clean_error_message` method for sanitizing log messages and details.
+
+    :arg str details: Additional information about the error.
+    """
+
+    def __init__(
+        self,
+        status_code: int = 500,
+        log_message: Optional[str] = None,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(status_code, log_message, *args, **kwargs)
+        if self.reason:
+            self.reason = self.clean_error_message(self.reason)
+        if self.log_message:
+            self.log_message = self.clean_error_message(self.log_message)
+
+    @staticmethod
+    def clean_error_message(message: str) -> str:
+        """
+        Sanitizes an error message by replacing newlines, tabs, and reducing multiple spaces.
+
+        :param message: The error message to sanitize.
+        :return: A cleaned and sanitized version of the message.
+        """
+        message = message.replace("\n", " ")  # Replace actual newlines with spaces
+        message = re.sub(r'\s+', ' ', message)  # Normalize spaces
+        return message.strip()