feat: improve unknown API errors

Author: DanielleHuisman

src/core/error.rs

@@ -1,5 +1,15 @@
 use thiserror::Error;
 
+/// A JSON or text body.
+#[derive(Clone, Debug)]
+pub enum JsonOrText {
+    /// JSON body.
+    Json(serde_json::Value),
+
+    /// Text body.
+    Text(String),
+}
+
 /// A WorkOS SDK error.
 #[derive(Debug, Error)]
 pub enum WorkOsError<E> {
@@ -11,6 +21,16 @@ pub enum WorkOsError<E> {
     #[error("unauthorized")]
     Unauthorized,
 
+    /// An unknown error response was received from the WorkOS API.
+    #[error("unknown error")]
+    Unknown {
+        /// The response status code.
+        status: reqwest::StatusCode,
+
+        /// The response body.
+        body: JsonOrText,
+    },
+
     /// An error occurred while parsing a URL.
     #[error("URL parse error")]
     UrlParseError(#[from] url::ParseError),
@@ -22,10 +42,6 @@ pub enum WorkOsError<E> {
     /// An unhandled error occurred with the API request.
     #[error("request error")]
     RequestError(#[from] reqwest::Error),
-
-    /// The API responded with an error.
-    #[error("API error")]
-    ApiError(serde_json::Value),
 }
 
 /// A WorkOS SDK result.

src/core/response.rs

@@ -1,6 +1,6 @@
 use reqwest::{Response, StatusCode};
 
-use crate::{WorkOsError, WorkOsResult};
+use crate::{JsonOrText, WorkOsError, WorkOsResult};
 
 pub trait ResponseExt
 where
@@ -37,12 +37,18 @@ impl ResponseExt for Response {
                 .is_some_and(|value| value.to_lowercase().starts_with("application/json"))
             {
                 match self.json().await {
-                    Ok(value) => Err(WorkOsError::ApiError(value)),
+                    Ok(value) => Err(WorkOsError::Unknown {
+                        status,
+                        body: JsonOrText::Json(value),
+                    }),
                     Err(err) => Err(WorkOsError::RequestError(err)),
                 }
             } else {
-                match self.error_for_status() {
-                    Ok(response) => Ok(response),
+                match self.text().await {
+                    Ok(text) => Err(WorkOsError::Unknown {
+                        status,
+                        body: JsonOrText::Text(text),
+                    }),
                     Err(err) => Err(WorkOsError::RequestError(err)),
                 }
             }