feat: migrate from thiserror to snafu (#234)

* feat(transact): migrate from thiserror to snafu

* feat: migrate other crates from thiserror to snafu

* feat: migrate apis from thiserror to snafu

* chore: cargo fmt

* fix: fix remaining error-related errors

* chore: fix extra space in error message

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: joe-p

Cargo.lock

@@ -20,7 +20,7 @@ members = [
 
 [workspace.dependencies]
 uniffi = { version = "0.28.3" }
-thiserror = { version = "2.0.7" }
+snafu = { version = "0.8" }
 wasm-bindgen = { version = "0.2.99" }
 tsify-next = { version = "0.5.4", features = ["js"] }
 js-sys = { version = "0.3.77" }

Cargo.toml

@@ -123,7 +123,7 @@ pub async fn {{ operation.rust_function_name }}(
     headers.insert("Accept".to_string(), "application/json".to_string());
 
     let body = {% if has_request_body(operation) %}
-        Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde(e.to_string()))?)
+        Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde { message: e.to_string() })?)
     {% else %}
     None
     {% endif %};
@@ -137,10 +137,10 @@ pub async fn {{ operation.rust_function_name }}(
         {% if request_body_type == "Vec<u8>" %}
         Some(p_{{ get_request_body_name(operation) }})
         {% else %}
-        Some(rmp_serde::to_vec_named(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde(e.to_string()))?)
+        Some(rmp_serde::to_vec_named(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde { message: e.to_string() })?)
         {% endif %}
         {% else %}
-        Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde(e.to_string()))?)
+        Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde { message: e.to_string() })?)
         {% endif %}
     {% else %}
     None
@@ -163,13 +163,13 @@ pub async fn {{ operation.rust_function_name }}(
             {% if request_body_type == "Vec<u8>" %}
             Some(p_{{ get_request_body_name(operation) }})
             {% else %}
-            Some(rmp_serde::to_vec_named(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde(e.to_string()))?)
+            Some(rmp_serde::to_vec_named(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde { message: e.to_string() })?)
             {% endif %}
         } else {
-            Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde(e.to_string()))?)
+            Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde { message: e.to_string() })?)
         }
         {% else %}
-        Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde(e.to_string()))?)
+        Some(serde_json::to_vec(&p_{{ get_request_body_name(operation) }}).map_err(|e| Error::Serde { message: e.to_string() })?)
         {% endif %}
     {% else %}
     None
@@ -185,7 +185,7 @@ pub async fn {{ operation.rust_function_name }}(
             Some(headers),
         )
         .await
-        .map_err(Error::Http)?;
+        .map_err(|e| Error::Http { source: e })?;
 
     {% if get_success_response_type(operation) %}
     let content_type = response
@@ -195,17 +195,17 @@ pub async fn {{ operation.rust_function_name }}(
         .unwrap_or("application/json");
 
     match ContentType::from(content_type) {
-        ContentType::Json => serde_json::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string())),
+        ContentType::Json => serde_json::from_slice(&response.body).map_err(|e| Error::Serde { message: e.to_string() }),
         {% if operation.supports_msgpack %}
-        ContentType::MsgPack => rmp_serde::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string())),
+        ContentType::MsgPack => rmp_serde::from_slice(&response.body).map_err(|e| Error::Serde { message: e.to_string() }),
         {% else %}
-        ContentType::MsgPack => Err(Error::Serde("MsgPack not supported".to_string())),
+        ContentType::MsgPack => Err(Error::Serde { message: "MsgPack not supported".to_string() }),
         {% endif %}
         ContentType::Text => {
-            let text = String::from_utf8(response.body).map_err(|e| Error::Serde(e.to_string()))?;
-            Err(Error::Serde(format!("Unexpected text response: {}", text)))
+            let text = String::from_utf8(response.body).map_err(|e| Error::Serde { message: e.to_string() })?;
+            Err(Error::Serde { message: format!("Unexpected text response: {}", text) })
         },
-        ContentType::Unsupported(ct) => Err(Error::Serde(format!("Unsupported content type: {}", ct))),
+        ContentType::Unsupported(ct) => Err(Error::Serde { message: format!("Unsupported content type: {}", ct) }),
     }
     {% else %}
     let _ = response;

api/oas_generator/rust_oas_generator/templates/apis/endpoint.rs.j2

@@ -23,35 +23,37 @@ pub mod parameter_enums;
 pub mod {{ operation.rust_function_name }};
 {% endfor %}
 
+use snafu::Snafu;
+
 /// Unified error type that can represent any API error from any endpoint
-#[derive(Debug, thiserror::Error)]
+#[derive(Debug, Snafu)]
 pub enum {{ client_type }}ApiError {
 {% for operation in operations %}
-    #[error("{{ operation.rust_function_name | title }} error: {0:?}")]
-    {{ operation.rust_function_name | pascal_case }}({{ operation.rust_function_name }}::{{ operation.rust_error_enum }}),
+    #[snafu(display("{{ operation.rust_function_name | title }} error: {error:?}"))]
+    {{ operation.rust_function_name | pascal_case }} { error: {{ operation.rust_function_name }}::{{ operation.rust_error_enum }} },
 {% endfor %}
-    #[error("Unknown API error: {0}")]
-    Unknown(String),
+    #[snafu(display("Unknown API error: {message}"))]
+    Unknown { message: String },
 }
 
 {% for operation in operations %}
 impl From<{{ operation.rust_function_name }}::{{ operation.rust_error_enum }}> for {{ client_type }}ApiError {
     fn from(err: {{ operation.rust_function_name }}::{{ operation.rust_error_enum }}) -> Self {
-        {{ client_type }}ApiError::{{ operation.rust_function_name | pascal_case }}(err)
+        {{ client_type }}ApiError::{{ operation.rust_function_name | pascal_case }} { error: err }
     }
 }
 
 {% endfor %}
 
 /// The main error type for all {{ client_type | lower }} client operations
-#[derive(Debug, thiserror::Error)]
+#[derive(Debug, Snafu)]
 pub enum Error {
-    #[error("HTTP error: {0}")]
-    Http(#[from] algokit_http_client::HttpError),
-    #[error("Serialization error: {0}")]
-    Serde(String),
-    #[error("API error: {0}")]
-    Api(#[from] {{ client_type }}ApiError),
+    #[snafu(display("HTTP error: {source}"))]
+    Http { source: algokit_http_client::HttpError },
+    #[snafu(display("Serialization error: {message}"))]
+    Serde { message: String },
+    #[snafu(display("API error: {source}"))]
+    Api { source: {{ client_type }}ApiError },
 }
 
 #[derive(Debug, PartialEq, Eq)]

api/oas_generator/rust_oas_generator/templates/apis/mod.rs.j2

@@ -34,7 +34,7 @@ rmp-serde = "^1.1"
 {% endif %}
 
 # Error handling
-thiserror = "^1.0"
+snafu = { workspace = true }
 
 # Utilities
 base64 = "^0.22"
@@ -43,4 +43,3 @@ uuid = { version = "^1.0", features = ["v4"] }
 [dev-dependencies]
 tokio = { version = "1.0", features = ["full"] }
 tokio-test = "^0.4"
-

api/oas_generator/rust_oas_generator/templates/base/Cargo.toml.j2

@@ -32,12 +32,12 @@ algokit_transact = { path = "../algokit_transact" }
 rmp-serde = "^1.1"
 
 # Error handling
-thiserror = "^1.0"
+snafu = { workspace = true }
 
 # Utilities
 base64 = "^0.22"
 uuid = { version = "^1.0", features = ["v4"] }
 
 [dev-dependencies]
 tokio = { version = "1.0", features = ["full"] }
-tokio-test = "^0.4"
+tokio-test = "^0.4"

crates/algod_client/Cargo.toml

@@ -60,7 +60,7 @@ pub async fn abort_catchup(
             Some(headers),
         )
         .await
-        .map_err(Error::Http)?;
+        .map_err(|e| Error::Http { source: e })?;
 
     let content_type = response
         .headers
@@ -69,16 +69,22 @@ pub async fn abort_catchup(
         .unwrap_or("application/json");
 
     match ContentType::from(content_type) {
-        ContentType::Json => {
-            serde_json::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string()))
-        }
-        ContentType::MsgPack => Err(Error::Serde("MsgPack not supported".to_string())),
+        ContentType::Json => serde_json::from_slice(&response.body).map_err(|e| Error::Serde {
+            message: e.to_string(),
+        }),
+        ContentType::MsgPack => Err(Error::Serde {
+            message: "MsgPack not supported".to_string(),
+        }),
         ContentType::Text => {
-            let text = String::from_utf8(response.body).map_err(|e| Error::Serde(e.to_string()))?;
-            Err(Error::Serde(format!("Unexpected text response: {}", text)))
-        }
-        ContentType::Unsupported(ct) => {
-            Err(Error::Serde(format!("Unsupported content type: {}", ct)))
+            let text = String::from_utf8(response.body).map_err(|e| Error::Serde {
+                message: e.to_string(),
+            })?;
+            Err(Error::Serde {
+                message: format!("Unexpected text response: {}", text),
+            })
         }
+        ContentType::Unsupported(ct) => Err(Error::Serde {
+            message: format!("Unsupported content type: {}", ct),
+        }),
     }
 }

crates/algod_client/src/apis/abort_catchup.rs

@@ -80,7 +80,7 @@ pub async fn account_application_information(
             Some(headers),
         )
         .await
-        .map_err(Error::Http)?;
+        .map_err(|e| Error::Http { source: e })?;
 
     let content_type = response
         .headers
@@ -89,18 +89,22 @@ pub async fn account_application_information(
         .unwrap_or("application/json");
 
     match ContentType::from(content_type) {
-        ContentType::Json => {
-            serde_json::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string()))
-        }
-        ContentType::MsgPack => {
-            rmp_serde::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string()))
-        }
+        ContentType::Json => serde_json::from_slice(&response.body).map_err(|e| Error::Serde {
+            message: e.to_string(),
+        }),
+        ContentType::MsgPack => rmp_serde::from_slice(&response.body).map_err(|e| Error::Serde {
+            message: e.to_string(),
+        }),
         ContentType::Text => {
-            let text = String::from_utf8(response.body).map_err(|e| Error::Serde(e.to_string()))?;
-            Err(Error::Serde(format!("Unexpected text response: {}", text)))
-        }
-        ContentType::Unsupported(ct) => {
-            Err(Error::Serde(format!("Unsupported content type: {}", ct)))
+            let text = String::from_utf8(response.body).map_err(|e| Error::Serde {
+                message: e.to_string(),
+            })?;
+            Err(Error::Serde {
+                message: format!("Unexpected text response: {}", text),
+            })
         }
+        ContentType::Unsupported(ct) => Err(Error::Serde {
+            message: format!("Unsupported content type: {}", ct),
+        }),
     }
 }

crates/algod_client/src/apis/account_application_information.rs

@@ -80,7 +80,7 @@ pub async fn account_asset_information(
             Some(headers),
         )
         .await
-        .map_err(Error::Http)?;
+        .map_err(|e| Error::Http { source: e })?;
 
     let content_type = response
         .headers
@@ -89,18 +89,22 @@ pub async fn account_asset_information(
         .unwrap_or("application/json");
 
     match ContentType::from(content_type) {
-        ContentType::Json => {
-            serde_json::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string()))
-        }
-        ContentType::MsgPack => {
-            rmp_serde::from_slice(&response.body).map_err(|e| Error::Serde(e.to_string()))
-        }
+        ContentType::Json => serde_json::from_slice(&response.body).map_err(|e| Error::Serde {
+            message: e.to_string(),
+        }),
+        ContentType::MsgPack => rmp_serde::from_slice(&response.body).map_err(|e| Error::Serde {
+            message: e.to_string(),
+        }),
         ContentType::Text => {
-            let text = String::from_utf8(response.body).map_err(|e| Error::Serde(e.to_string()))?;
-            Err(Error::Serde(format!("Unexpected text response: {}", text)))
-        }
-        ContentType::Unsupported(ct) => {
-            Err(Error::Serde(format!("Unsupported content type: {}", ct)))
+            let text = String::from_utf8(response.body).map_err(|e| Error::Serde {
+                message: e.to_string(),
+            })?;
+            Err(Error::Serde {
+                message: format!("Unexpected text response: {}", text),
+            })
         }
+        ContentType::Unsupported(ct) => Err(Error::Serde {
+            message: format!("Unsupported content type: {}", ct),
+        }),
     }
 }