Improvements on handling error raised in AQUA

Author: mingkang111

ads/aqua/decorator.py

@@ -17,6 +17,7 @@
     RequestException,
     ServiceError,
 )
+from tornado.web import HTTPError
 
 from ads.aqua.exception import AquaError
 from ads.aqua.extension.base_handler import AquaAPIhandler
@@ -58,6 +59,7 @@ def inner_function(self: AquaAPIhandler, *args, **kwargs):
         except ServiceError as error:
             self.write_error(
                 status_code=error.status or 500,
+                message=error.message,
                 reason=error.message,
                 service_payload=error.args[0] if error.args else None,
                 exc_info=sys.exc_info(),
@@ -91,6 +93,12 @@ def inner_function(self: AquaAPIhandler, *args, **kwargs):
                 service_payload=error.service_payload,
                 exc_info=sys.exc_info(),
             )
+        except HTTPError as e:
+            self.write_error(
+                status_code=e.status_code,
+                reason=e.log_message,
+                exc_info=sys.exc_info(),
+            )
         except Exception as ex:
             self.write_error(
                 status_code=500,

ads/aqua/extension/base_handler.py

@@ -8,14 +8,16 @@
 import traceback
 import uuid
 from dataclasses import asdict, is_dataclass
+from http.client import responses
 from typing import Any
 
 from notebook.base.handlers import APIHandler
-from tornado.web import HTTPError, Application
 from tornado import httputil
-from ads.telemetry.client import TelemetryClient
-from ads.config import AQUA_TELEMETRY_BUCKET, AQUA_TELEMETRY_BUCKET_NS
+from tornado.web import Application, HTTPError
+
 from ads.aqua import logger
+from ads.config import AQUA_TELEMETRY_BUCKET, AQUA_TELEMETRY_BUCKET_NS
+from ads.telemetry.client import TelemetryClient
 
 
 class AquaAPIhandler(APIHandler):
@@ -66,12 +68,15 @@ def finish(self, payload=None):  # pylint: disable=W0221
 
     def write_error(self, status_code, **kwargs):
         """AquaAPIhandler errors are JSON, not human pages."""
-
         self.set_header("Content-Type", "application/json")
         reason = kwargs.get("reason")
         self.set_status(status_code, reason=reason)
         service_payload = kwargs.get("service_payload", {})
-        message = self.get_default_error_messages(service_payload, str(status_code))
+        default_msg = responses.get(status_code, "Unknown HTTP Error")
+        message = self.get_default_error_messages(
+            service_payload, str(status_code), kwargs.get("message", default_msg)
+        )
+
         reply = {
             "status": status_code,
             "message": message,
@@ -84,7 +89,7 @@ def write_error(self, status_code, **kwargs):
             e = exc_info[1]
             if isinstance(e, HTTPError):
                 reply["message"] = e.log_message or message
-                reply["reason"] = e.reason
+                reply["reason"] = e.reason if e.reason else reply["reason"]
                 reply["request_id"] = str(uuid.uuid4())
             else:
                 reply["request_id"] = str(uuid.uuid4())
@@ -102,15 +107,18 @@ def write_error(self, status_code, **kwargs):
         self.finish(json.dumps(reply))
 
     @staticmethod
-    def get_default_error_messages(service_payload: dict, status_code: str):
+    def get_default_error_messages(
+        service_payload: dict,
+        status_code: str,
+        default_msg: str = "Unknown HTTP Error.",
+    ):
         """Method that maps the error messages based on the operation performed or the status codes encountered."""
 
         messages = {
             "400": "Something went wrong with your request.",
             "403": "We're having trouble processing your request with the information provided.",
             "404": "Authorization Failed: The resource you're looking for isn't accessible.",
             "408": "Server is taking too long to response, please try again.",
-            "500": "An error occurred while creating the resource.",
             "create": "Authorization Failed: Could not create resource.",
             "get": "Authorization Failed: The resource you're looking for isn't accessible.",
         }
@@ -128,7 +136,7 @@ def get_default_error_messages(service_payload: dict, status_code: str):
         if status_code in messages:
             return messages[status_code]
         else:
-            return "Unknown HTTP Error."
+            return default_msg
 
 
 # todo: remove after error handler is implemented

ads/aqua/extension/common_handler.py

@@ -6,21 +6,24 @@
 
 from importlib import metadata
 
-from ads.aqua.extension.base_handler import AquaAPIhandler
 from ads.aqua import ODSC_MODEL_COMPARTMENT_OCID
+from ads.aqua.decorator import handle_exceptions
 from ads.aqua.exception import AquaResourceAccessError
+from ads.aqua.extension.base_handler import AquaAPIhandler
 
 
 class ADSVersionHandler(AquaAPIhandler):
     """The handler to get the current version of the ADS."""
 
+    @handle_exceptions
     def get(self):
         self.finish({"data": metadata.version("oracle_ads")})
 
 
 class CompatibilityCheckHandler(AquaAPIhandler):
     """The handler to check if the extension is compatible."""
 
+    @handle_exceptions
     def get(self):
         if ODSC_MODEL_COMPARTMENT_OCID:
             return self.finish(dict(status="ok"))

ads/aqua/extension/deployment_handler.py

@@ -7,10 +7,10 @@
 
 from tornado.web import HTTPError
 
+from ads.aqua.decorator import handle_exceptions
 from ads.aqua.deployment import AquaDeploymentApp, MDInferenceResponse, ModelParams
 from ads.aqua.extension.base_handler import AquaAPIhandler, Errors
 from ads.config import COMPARTMENT_OCID, PROJECT_OCID
-from ads.aqua.decorator import handle_exceptions
 
 
 class AquaDeploymentHandler(AquaAPIhandler):
@@ -110,12 +110,10 @@ def post(self, *args, **kwargs):
             )
         )
 
-    @handle_exceptions
     def read(self, id):
         """Read the information of an Aqua model deployment."""
         return self.finish(AquaDeploymentApp().get(model_deployment_id=id))
 
-    @handle_exceptions
     def list(self):
         """List Aqua models."""
         # If default is not specified,
@@ -129,7 +127,6 @@ def list(self):
             )
         )
 
-    @handle_exceptions
     def get_deployment_config(self, model_id):
         """Gets the deployment config for Aqua model."""
         return self.finish(AquaDeploymentApp().get_deployment_config(model_id=model_id))

ads/aqua/extension/evaluation_handler.py

@@ -5,11 +5,10 @@
 
 from urllib.parse import urlparse
 
-from requests import HTTPError
+from tornado.web import HTTPError
 
 from ads.aqua.decorator import handle_exceptions
 from ads.aqua.evaluation import AquaEvaluationApp, CreateAquaEvaluationDetails
-from ads.aqua.exception import AquaError
 from ads.aqua.extension.base_handler import AquaAPIhandler, Errors
 from ads.aqua.extension.utils import validate_function_parameters
 from ads.config import COMPARTMENT_OCID

ads/aqua/extension/finetune_handler.py

@@ -54,7 +54,6 @@ def post(self, *args, **kwargs):
 
         self.finish(AquaFineTuningApp().create(CreateFineTuningDetails(**input_data)))
 
-    @handle_exceptions
     def get_finetuning_config(self, model_id):
         """Gets the finetuning config for Aqua model."""
         return self.finish(AquaFineTuningApp().get_finetuning_config(model_id=model_id))

ads/aqua/extension/ui_handler.py

@@ -34,6 +34,7 @@ class AquaUIHandler(AquaAPIhandler):
     HTTPError: For various failure scenarios such as invalid input format, missing data, etc.
     """
 
+    @handle_exceptions
     def get(self, id=""):
         """Handle GET request."""
         url_parse = urlparse(self.request.path)
@@ -76,30 +77,25 @@ def delete(self, id=""):
         else:
             raise HTTPError(400, f"The request {self.request.path} is invalid.")
 
-    @handle_exceptions
     def list_log_groups(self, **kwargs):
         """Lists all log groups for the specified compartment or tenancy."""
         compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
         return self.finish(
             AquaUIApp().list_log_groups(compartment_id=compartment_id, **kwargs)
         )
 
-    @handle_exceptions
     def list_logs(self, log_group_id: str, **kwargs):
         """Lists the specified log group's log objects."""
         return self.finish(AquaUIApp().list_logs(log_group_id=log_group_id, **kwargs))
 
-    @handle_exceptions
     def list_compartments(self):
         """Lists the compartments in a compartment specified by ODSC_MODEL_COMPARTMENT_OCID env variable."""
         return self.finish(AquaUIApp().list_compartments())
 
-    @handle_exceptions
     def get_default_compartment(self):
         """Returns user compartment ocid."""
         return self.finish(AquaUIApp().get_default_compartment())
 
-    @handle_exceptions
     def list_model_version_sets(self, **kwargs):
         """Lists all model version sets for the specified compartment or tenancy."""
 
@@ -112,7 +108,6 @@ def list_model_version_sets(self, **kwargs):
             )
         )
 
-    @handle_exceptions
     def list_experiments(self, **kwargs):
         """Lists all experiments for the specified compartment or tenancy."""
 
@@ -125,7 +120,6 @@ def list_experiments(self, **kwargs):
             )
         )
 
-    @handle_exceptions
     def list_buckets(self, **kwargs):
         """Lists all model version sets for the specified compartment or tenancy."""
         compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
@@ -138,23 +132,20 @@ def list_buckets(self, **kwargs):
             )
         )
 
-    @handle_exceptions
     def list_job_shapes(self, **kwargs):
         """Lists job shapes available in the specified compartment."""
         compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
         return self.finish(
             AquaUIApp().list_job_shapes(compartment_id=compartment_id, **kwargs)
         )
 
-    @handle_exceptions
     def list_vcn(self, **kwargs):
         """Lists the virtual cloud networks (VCNs) in the specified compartment."""
         compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
         return self.finish(
             AquaUIApp().list_vcn(compartment_id=compartment_id, **kwargs)
         )
 
-    @handle_exceptions
     def list_subnets(self, **kwargs):
         """Lists the subnets in the specified VCN and the specified compartment."""
         compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
@@ -165,7 +156,6 @@ def list_subnets(self, **kwargs):
             )
         )
 
-    @handle_exceptions
     def get_shape_availability(self, **kwargs):
         """For a given compartmentId, resource limit name, and scope, returns the number of available resources associated
         with the given limit."""
@@ -178,7 +168,6 @@ def get_shape_availability(self, **kwargs):
             )
         )
 
-    @handle_exceptions
     def is_bucket_versioned(self):
         """For a given compartmentId, resource limit name, and scope, returns the number of available resources associated
         with the given limit."""

ads/aqua/extension/utils.py

@@ -4,16 +4,16 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 from dataclasses import fields
 from typing import Dict, Optional
-from requests import HTTPError
+
+from tornado.web import HTTPError
 
 from ads.aqua.extension.base_handler import Errors
 
 
 def validate_function_parameters(data_class, input_data: Dict):
-    """Validates if the required parameters are provided in input data."""    
+    """Validates if the required parameters are provided in input data."""
     required_parameters = [
-        field.name for field in fields(data_class) 
-        if field.type != Optional[field.type]
+        field.name for field in fields(data_class) if field.type != Optional[field.type]
     ]
 
     for required_parameter in required_parameters: