add description field to error, more info in error message (#137)

* add description field to error, more info in error message

* more generic error message

* doc: use no_run instead ignore

src/error.rs

@@ -1,6 +1,6 @@
+use std::{borrow::Cow, error::Error, fmt::Display};
+
 use serde::{Deserialize, Serialize};
-use std::error::Error;
-use std::fmt::Display;
 
 #[derive(Debug)]
 pub enum KeycloakError {
@@ -12,31 +12,53 @@ pub enum KeycloakError {
     },
 }
 
-#[derive(Debug, Clone, Deserialize, Serialize)]
-pub struct KeycloakHttpError {
-    pub error: Option<String>,
-    #[serde(rename = "errorMessage")]
-    pub error_message: Option<String>,
-}
-
 impl From<reqwest::Error> for KeycloakError {
     fn from(value: reqwest::Error) -> Self {
         KeycloakError::ReqwestFailure(value)
     }
 }
 
-impl Error for KeycloakError {
-    fn description(&self) -> &str {
-        "keycloak error"
-    }
+impl Error for KeycloakError {}
 
-    fn cause(&self) -> Option<&dyn Error> {
-        None
+impl Display for KeycloakError {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            KeycloakError::ReqwestFailure(e) => write!(f, "keycloak error (network): {e}"),
+            KeycloakError::HttpFailure { status, body, text } => write!(
+                f,
+                "keycloak error (rest): {status} {}",
+                body.as_ref()
+                    .and_then(|e| e.message())
+                    .unwrap_or_else(|| Cow::from(text))
+            ),
+        }
     }
 }
 
-impl Display for KeycloakError {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(f, "keycloak error")
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct KeycloakHttpError {
+    pub error: Option<String>,
+    pub error_description: Option<String>,
+    #[serde(rename = "errorMessage")]
+    pub error_message: Option<String>,
+}
+
+impl KeycloakHttpError {
+    pub fn message(&self) -> Option<Cow<'_, str>> {
+        self.error_message
+            .as_deref()
+            .map(Cow::from)
+            .or_else(|| {
+                self.error
+                    .as_deref()
+                    .map(|error| {
+                        format!(
+                            "{} [{error}]",
+                            self.error_description.as_deref().unwrap_or("null")
+                        )
+                    })
+                    .map(Cow::from)
+            })
+            .or_else(|| self.error_description.as_deref().map(Cow::from))
     }
 }

src/lib.rs

@@ -28,7 +28,7 @@ Add dependency to Cargo.toml:
 keycloak = "25.0"
 ```
 
-```rust#ignore
+```rust, no_run
 use keycloak::{
     types::*,
     {KeycloakAdmin, KeycloakAdminToken},
@@ -118,4 +118,4 @@ pub use error::KeycloakError;
 pub use rest::{
     KeycloakAdmin, KeycloakAdminToken, KeycloakServiceAccountAdminTokenRetriever,
     KeycloakTokenSupplier,
-};
+};

templates/src/lib.rs

@@ -1,5 +1,5 @@
 /*!
-{{ replace ( render ( read_to_str "templates/README.md" ) ) "```rust" "```rust#ignore" }}
+{{ replace ( render ( read_to_str "templates/README.md" ) ) "```rust" "```rust, no_run" }}
 */
 
 pub mod types;