Improves error deserialization to handle bad format returned from the JSON (#263)

Author: jchen293

CHANGELOG.md

@@ -1,8 +1,12 @@
 # CHANGELOG
 
+## Next release
+
+- Improves error deserialization to handle bad format returned from the JSON
+
 ## v7.11.0 (2023-04-04)
 
-- Add `get_next_page` function that retrieves the next page of results for a paginated collection
+- Adds `get_next_page` function that retrieves the next page of results for a paginated collection
 
 ## v7.10.0 (2023-02-17)
 

easypost/error.py

@@ -1,5 +1,8 @@
 import json
 from typing import (
+    Any,
+    Dict,
+    List,
     Optional,
     Union,
 )
@@ -9,14 +12,16 @@ class Error(Exception):
     def __init__(
         self,
         message: Optional[
-            Union[str, list]
+            Union[Dict[str, Any], list, str]
         ] = None,  # message should be a string but can sometimes incorrectly come back as a list
         http_status: Optional[int] = None,
         http_body: Optional[Union[str, bytes]] = None,
         original_exception: Optional[Exception] = None,
     ):
         super(Error, self).__init__(message)
-        self.message = ", ".join(message) if type(message) == list else message
+        message_list: List[str] = []
+        Error.traverse_json_element(message, message_list)
+        self.message = ", ".join(message_list)
         self.http_status = http_status
         self.http_body = http_body
         self.original_exception = original_exception
@@ -32,3 +37,19 @@ def __init__(
             self.param = self.json_body["error"].get("param", None)
         except Exception:
             self.param = None
+
+    @staticmethod
+    def traverse_json_element(
+        error_message: Optional[Union[Dict[str, Any], list, str]], messages_list: List[str]
+    ) -> None:
+        """Recursively traverses a JSON object or array and extracts error messages
+        as strings. Adds the extracted messages to the specified messages_list array.
+        """
+        if isinstance(error_message, dict):
+            for value in error_message.values():
+                Error.traverse_json_element(value, messages_list)
+        elif isinstance(error_message, list):
+            for value in error_message:
+                Error.traverse_json_element(value, messages_list)
+        else:
+            messages_list.append(str(error_message))

tests/test_error.py

@@ -30,3 +30,30 @@ def test_error_list_message():
     error = easypost.Error(message=["Error1", "Error2"])
 
     assert error.message == "Error1, Error2"
+
+
+def test_error_dict_message():
+    """Tests that we concatenate error messages that are a dict (they should be a string from the
+    API but aren't always so we protect against that here).
+    """
+    message_data = {"errors": ["Bad format 1", "Bad format 2"]}
+
+    error = easypost.Error(message=message_data)
+
+    assert error.message == "Bad format 1, Bad format 2"
+
+
+def test_error_bad_format_message():
+    """Tests that we concatenate error messages that has really bad format
+    (they should be a string from the API but aren't always so we protect against that here).
+    """
+    message_data = {
+        "errors": ["Bad format 1", "Bad format 2"],
+        "bad_data": [
+            {"first_message": "Bad format 3", "second_message": "Bad format 4", "thrid_message": "Bad format 5"}
+        ],
+    }
+
+    error = easypost.Error(message=message_data)
+
+    assert error.message == "Bad format 1, Bad format 2, Bad format 3, Bad format 4, Bad format 5"