Consolidate Error Classes (#35)

* WIP

* Consolidate erro classes

* Add import

* Fix some bugs in response handling

* A few more type oddities

Co-authored-by: Ted Benson <[email protected]>

Author: eob

src/steamship/app/__init__.py

@@ -1,4 +1,4 @@
 from .app import App, get, post
 from .lambda_handler import create_handler
 from .request import Request, Invocation
-from .response import Response, AppResponse, ErrorResponse, Error
+from .response import Response, AppResponse, Error

src/steamship/app/lambda_handler.py

@@ -7,7 +7,7 @@
 from steamship.app.request import Request
 from steamship.app.response import Response, Error, Http
 from steamship.client.client import Steamship
-
+from steamship.base import SteamshipError
 
 def create_handler(App: Type[App]):
     """Wrapper function for an Steamship app within an AWS Lambda function.
@@ -54,6 +54,11 @@ def handler(event: Dict, context: Dict = None) -> Dict:
 
         if type(response) == Response:
             lambda_response = response
+        elif type(response) == SteamshipError:
+            lambda_response = Response(
+                error=response,
+                http=Http(status=500)
+            )
         elif type(response) == io.BytesIO:
             lambda_response = Response(bytes=response)
         elif type(response) == dict:
@@ -66,16 +71,14 @@ def handler(event: Dict, context: Dict = None) -> Dict:
             lambda_response = Response(json=response)
         else:
             lambda_response = Response(
-                error=Error(message="Handler provided unknown response type."),
-                http=Http(statusCode=500)
+                error=SteamshipError(message="Handler provided unknown response type."),
+                http=Http(status=500)
             )
-
         if lambda_response is None:
             lambda_response = Response(
-                error=Error(message="Handler provided no response."),
-                http=Http(statusCode=500)
+                error=SteamshipError(message="Handler provided no response."),
+                http=Http(status=500)
             )
-
         return dataclasses.asdict(lambda_response)
 
     return handler

src/steamship/app/response.py

@@ -4,27 +4,14 @@
 from typing import Dict, Any
 
 from steamship.base.binary_utils import flexi_create
+from steamship.base import SteamshipError
 
 
 @dataclass
 class AppResponse:
     pass
 
 
-@dataclass
-class ErrorResponse():
-    message: str = None
-    internalMessage: str = None
-    error: str = None
-    suggestion: str = None
-    code: str = None
-
-    def log(self):
-        logging.error("[{}] {}. [Internal: {}]".format(self.code, self.message, self.internalMessage))
-        if self.error:
-            logging.error(self.error)
-
-
 @dataclass
 class Http():
     status: int = None
@@ -33,13 +20,13 @@ class Http():
 
 @dataclass
 class Response(AppResponse):
-    error: ErrorResponse = None
+    error: SteamshipError = None
     http: Http = None
     body: any = None
 
     def __init__(
             self,
-            error: ErrorResponse = None,
+            error: SteamshipError = None,
             http: Http = None,
             body: any = None,
             string: str = None,
@@ -74,10 +61,10 @@ def Error(
         suggestion: str = None,
         error: Exception = None
 ) -> Response:
-    err = ErrorResponse(
+    err = SteamshipError(
         message=message,
         internalMessage=internalMessage,
-        error="{}".format(error),
+        error=error,
         suggestion=suggestion,
         code=code
     )

src/steamship/base/error.py

@@ -1,16 +1,26 @@
 from typing import Any
+from dataclasses import dataclass
+import logging
+from typing import Union
 
-
+@dataclass
 class SteamshipError(Exception):
-    statusMessage: str = None
-    statusSuggestion: str = None
-    statusCode: str = None
+    message: str = None
+    internalMessage: str = None
+    suggestion: str = None
+    code: str = None
     error: str = None
 
-    def __init__(self, message: str = "Undefined remote error", suggestion: str = None, code: str = None,
-                 error: Exception = None):
-        self.statusMessage = message
-        self.statusSuggestion = suggestion
+    def __init__(
+            self,
+            message: str = "Undefined remote error",
+            internalMessage : str = None,
+            suggestion: str = None,
+            code: str = None,
+            error: Union[Exception, str] = None):
+        self.message = message
+        self.suggestion = suggestion
+        self.internalMessage = internalMessage
         self.statusCode = code
         if error is not None:
             self.error = "{}".format(error)
@@ -20,16 +30,34 @@ def __init__(self, message: str = "Undefined remote error", suggestion: str = No
             parts.append("[{}]".format(code))
         if message is not None:
             parts.append(message)
+        if internalMessage is not None:
+            parts.append("Internal Message: {}".format(internalMessage))
         if suggestion is not None:
             parts.append("Suggestion: {}".format(suggestion))
 
         super().__init__("\n".join(parts))
 
+    def log(self):
+        logging.error("[{}] {}. [Internal: {}] [Suggestion: {}]".format(self.code, self.message, self.internalMessage, self.suggestion))
+        if self.error:
+            logging.error(self.error)
+
+    def to_dict(self) -> dict:
+        return dict(
+            message=self.message,
+            internalMessage=self.internalMessage,
+            suggestion=self.suggestion,
+            code=self.code,
+            error=self.error
+        )
+
     @staticmethod
     def from_dict(d: any, client: Any = None) -> "SteamshipError":
         """Last resort if subclass doesn't override: pass through."""
         return SteamshipError(
-            message=d.get('statusMessage', None),
-            suggestion=d.get('statusSuggestion', None),
-            code=d.get('statusCode', None)
+            message=d.get('statusMessage', d.get('message', None)),
+            internalMessage=d.get('internalMessage', None),
+            suggestion=d.get('statusSuggestion', suggestion=d.get('suggestion', None)),
+            code=d.get('statusCode', d.get('code', None)),
+            error=d.get('error', d.get('error', None))
         )