feat: added headers to ResendError

Author: drish

resend/exceptions.py

@@ -4,7 +4,7 @@
 codes as outlined in https://resend.com/docs/api-reference/errors.
 """
 
-from typing import Any, Dict, NoReturn, Union
+from typing import Any, Dict, NoReturn, Optional, Union
 
 
 class ResendError(Exception):
@@ -29,12 +29,14 @@ def __init__(
         error_type: str,
         message: str,
         suggested_action: str,
+        headers: Optional[Dict[str, str]] = None,
     ):
         Exception.__init__(self, message)
         self.code = code
         self.message = message
         self.suggested_action = suggested_action
         self.error_type = error_type
+        self.headers = headers or {}
 
 
 class MissingApiKeyError(ResendError):
@@ -45,6 +47,7 @@ def __init__(
         message: str,
         error_type: str,
         code: Union[str, int],
+        headers: Optional[Dict[str, str]] = None,
     ):
         suggested_action = """Include the following header
         Authorization: Bearer YOUR_API_KEY in the request."""
@@ -57,6 +60,7 @@ def __init__(
             suggested_action=suggested_action,
             code=code,
             error_type=error_type,
+            headers=headers,
         )
 
 
@@ -68,6 +72,7 @@ def __init__(
         message: str,
         error_type: str,
         code: Union[str, int],
+        headers: Optional[Dict[str, str]] = None,
     ):
         suggested_action = """Generate a new API key in the dashboard."""
 
@@ -77,6 +82,7 @@ def __init__(
             suggested_action=suggested_action,
             code=code,
             error_type=error_type,
+            headers=headers,
         )
 
 
@@ -88,6 +94,7 @@ def __init__(
         message: str,
         error_type: str,
         code: Union[str, int],
+        headers: Optional[Dict[str, str]] = None,
     ):
         default_message = """
         The request body is missing one or more required fields."""
@@ -104,6 +111,7 @@ def __init__(
             message=message,
             suggested_action=suggested_action,
             error_type=error_type,
+            headers=headers,
         )
 
 
@@ -115,6 +123,7 @@ def __init__(
         message: str,
         error_type: str,
         code: Union[str, int],
+        headers: Optional[Dict[str, str]] = None,
     ):
         default_message = """
         The request body is missing one or more required fields."""
@@ -131,6 +140,7 @@ def __init__(
             message=message,
             suggested_action=suggested_action,
             error_type=error_type,
+            headers=headers,
         )
 
 
@@ -142,6 +152,7 @@ def __init__(
         message: str,
         error_type: str,
         code: Union[str, int],
+        headers: Optional[Dict[str, str]] = None,
     ):
         default_message = """
         Something went wrong."""
@@ -157,6 +168,7 @@ def __init__(
             message=message,
             suggested_action=suggested_action,
             error_type=error_type,
+            headers=headers,
         )
 
 
@@ -168,6 +180,7 @@ def __init__(
         message: str,
         error_type: str,
         code: Union[str, int],
+        headers: Optional[Dict[str, str]] = None,
     ):
         suggested_action = """Reduce your request rate or wait before retrying. """
         suggested_action += """Check the response headers for rate limit information."""
@@ -178,6 +191,7 @@ def __init__(
             message=message,
             suggested_action=suggested_action,
             error_type=error_type,
+            headers=headers,
         )
 
 
@@ -200,14 +214,18 @@ def __init__(
 
 
 def raise_for_code_and_type(
-    code: Union[str, int], error_type: str, message: str
+    code: Union[str, int],
+    error_type: str,
+    message: str,
+    headers: Optional[Dict[str, str]] = None,
 ) -> NoReturn:
     """Raise the appropriate error based on the code and type.
 
     Args:
         code (str): The error code
         error_type (str): The error type
         message (str): The error message
+        headers (Optional[Dict[str, str]]): The HTTP response headers
 
     Raises:
         ResendError: If it is a Resend err
@@ -231,7 +249,8 @@ def raise_for_code_and_type(
     # Handle the case where the error might be unknown
     if error is None:
         raise ResendError(
-            code=code, message=message, error_type=error_type, suggested_action=""
+            code=code, message=message, error_type=error_type, suggested_action="",
+            headers=headers,
         )
 
     # Raise error from errors list
@@ -242,10 +261,12 @@ def raise_for_code_and_type(
             code=code,
             message=message,
             error_type=error_type,
+            headers=headers,
         )
     # defaults to ResendError if finally can't find error type
     raise ResendError(
-        code=code, message=message, error_type=error_type, suggested_action=""
+        code=code, message=message, error_type=error_type, suggested_action="",
+        headers=headers,
     )
 
 

resend/request.py

@@ -38,6 +38,7 @@ def perform(self) -> Union[T, None]:
                 code=data.get("statusCode") or 500,
                 message=data.get("message", "Unknown error"),
                 error_type=data.get("name", "InternalServerError"),
+                headers=self._response_headers,
             )
 
         if isinstance(data, dict):
@@ -106,6 +107,7 @@ def make_request(self, url: str) -> Union[Dict[str, Any], List[Any]]:
                 code=500,
                 message=f"Expected JSON response but got: {content_type}",
                 error_type="InternalServerError",
+                headers=self._response_headers,
             )
 
         try:
@@ -120,4 +122,5 @@ def make_request(self, url: str) -> Union[Dict[str, Any], List[Any]]:
                 code=500,
                 message="Failed to decode JSON response",
                 error_type="InternalServerError",
+                headers=self._response_headers,
             )

tests/exceptions_test.py

@@ -55,3 +55,52 @@ def test_monthly_quota_exceeded_error(self) -> None:
         assert e.type is RateLimitError
         assert e.value.code == 429
         assert e.value.error_type == "monthly_quota_exceeded"
+
+    def test_headers_default_to_empty_dict(self) -> None:
+        with pytest.raises(ResendError) as e:
+            raise_for_code_and_type(999, "error_type", "msg")
+        assert e.value.headers == {}
+
+    def test_headers_passed_to_known_error(self) -> None:
+        headers = {
+            "retry-after": "5",
+            "x-ratelimit-limit": "100",
+            "x-ratelimit-remaining": "0",
+            "x-ratelimit-reset": "1699564800",
+        }
+        with pytest.raises(RateLimitError) as e:
+            raise_for_code_and_type(
+                429, "rate_limit_exceeded", "Rate limit exceeded",
+                headers=headers,
+            )
+        assert e.value.headers == headers
+        assert e.value.headers["retry-after"] == "5"
+        assert e.value.headers["x-ratelimit-remaining"] == "0"
+
+    def test_headers_passed_to_unknown_error(self) -> None:
+        headers = {"x-request-id": "req_123"}
+        with pytest.raises(ResendError) as e:
+            raise_for_code_and_type(999, "unknown", "msg", headers=headers)
+        assert e.value.headers == headers
+
+    def test_headers_passed_to_unknown_error_type(self) -> None:
+        headers = {"x-request-id": "req_456"}
+        with pytest.raises(ResendError) as e:
+            raise_for_code_and_type(500, "unknown_type", "msg", headers=headers)
+        assert e.value.headers == headers
+
+    def test_headers_on_validation_error(self) -> None:
+        headers = {"x-request-id": "req_789"}
+        with pytest.raises(ValidationError) as e:
+            raise_for_code_and_type(
+                400, "validation_error", "err", headers=headers,
+            )
+        assert e.value.headers == headers
+
+    def test_headers_on_application_error(self) -> None:
+        headers = {"x-request-id": "req_abc"}
+        with pytest.raises(ApplicationError) as e:
+            raise_for_code_and_type(
+                500, "application_error", "err", headers=headers,
+            )
+        assert e.value.headers == headers