Do not include error sources in Display formatting

The source chain is traversed when reporting the error, so if the source
is included in the Display formatting, it is reported twice.

Author: radekchannable

libs/opsqueue_python/src/errors.rs

@@ -70,7 +70,7 @@ pub type CPyResult<T, E> = Result<T, CError<E>>;
 /// allowing things like `KeyboardInterrupt`, `SystemExit` or `MemoryError`,
 /// to trigger cleanup-and-exit.
 #[derive(thiserror::Error, Debug)]
-#[error("Fatal Python exception: {0}")]
+#[error("Fatal Python exception")]
 pub struct FatalPythonException(#[from] pub PyErr);
 
 impl From<CError<FatalPythonException>> for PyErr {

opsqueue/src/common/errors.rs

@@ -16,11 +16,8 @@ use super::{
     submission::{SubmissionCancelled, SubmissionCompleted, SubmissionFailed, SubmissionId},
 };
 
-// #[derive(Error, Debug, Clone, Serialize, Deserialize)]
-// #[error("Low-level database error: {0:?}")]
-// pub struct DatabaseError(#[from] pub serde_error::Error);
 #[cfg_attr(feature = "server-logic", derive(Error, Debug))]
-#[cfg_attr(feature = "server-logic", error("Low-level database error: {0:?}"))]
+#[cfg_attr(feature = "server-logic", error("Low-level database error"))]
 #[cfg(feature = "server-logic")]
 pub struct DatabaseError(#[from] pub sqlx::Error);
 
@@ -136,7 +133,7 @@ impl<L, R1, R2> From<E<R1, R2>> for E<L, E<R1, R2>> {
 }
 
 #[derive(Error, Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
-#[error("You are using Opsqueue incorrectly. Details: {0}")]
+#[error("You are using Opsqueue incorrectly")]
 pub struct IncorrectUsage<E>(#[from] pub E);
 
 #[derive(Error, Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]

opsqueue/src/common/mod.rs

@@ -51,18 +51,30 @@ impl std::fmt::Display for MaxSubmissions {
     }
 }
 
+impl std::str::FromStr for MaxSubmissions {
+    type Err = ParseMaxSubmissionsError;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let value: NonZero<u64> = s.parse()?;
+        Ok(MaxSubmissions::new(value)?)
+    }
+}
+
 #[derive(Debug, thiserror::Error)]
 pub enum ParseMaxSubmissionsError {
     #[error(transparent)]
-    NotANumber(#[from] std::num::ParseIntError),
+    NotANumber(std::num::ParseIntError),
     #[error(transparent)]
-    TooLarge(#[from] MaxSubmissionsTooLarge),
+    TooLarge(MaxSubmissionsTooLarge),
 }
 
-impl std::str::FromStr for MaxSubmissions {
-    type Err = ParseMaxSubmissionsError;
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        let value: NonZero<u64> = s.parse()?;
-        Ok(MaxSubmissions::new(value)?)
+impl From<std::num::ParseIntError> for ParseMaxSubmissionsError {
+    fn from(value: std::num::ParseIntError) -> Self {
+        Self::NotANumber(value)
+    }
+}
+
+impl From<MaxSubmissionsTooLarge> for ParseMaxSubmissionsError {
+    fn from(value: MaxSubmissionsTooLarge) -> Self {
+        Self::TooLarge(value)
     }
 }

opsqueue/src/consumer/client.rs

@@ -519,10 +519,10 @@ impl Client {
 
 #[derive(thiserror::Error, Debug)]
 pub enum InternalConsumerClientError {
-    #[error("Low-level error in the websocket connection: {0}")]
+    #[error("Low-level error in the websocket connection")]
     LowLevelWebsocketError(#[from] tokio_tungstenite::tungstenite::Error),
     #[error(
-        "The oneshot channel to receive a sync response to an earlier request was dropped before a response was received: {0}"
+        "The oneshot channel to receive a sync response to an earlier request was dropped before a response was received"
     )]
     OneshotSenderDropped(#[from] RecvError),
     #[error("Expected the sync response of kind {expected} but received {actual:?}")]

opsqueue/src/object_store/mod.rs

@@ -50,9 +50,10 @@ impl std::fmt::Display for ChunkType {
 #[derive(thiserror::Error, Debug)]
 pub enum ChunkRetrievalError {
     #[error(
-        "Failed to retrieve chunk ({submission_prefix}, {chunk_index}, {chunk_type}) from object store: {source}"
+        "Failed to retrieve chunk ({submission_prefix}, {chunk_index}, {chunk_type}) from object store"
     )]
     ObjectStoreError {
+        #[source]
         source: object_store::Error,
         submission_prefix: Box<str>,
         chunk_index: chunk::ChunkIndex,
@@ -63,19 +64,21 @@ pub enum ChunkRetrievalError {
 #[derive(thiserror::Error, Debug)]
 pub enum ChunkStorageError {
     #[error(
-        "Failed to store chunk ({submission_prefix}, {chunk_index}, {chunk_type}) to object store: {source}"
+        "Failed to store chunk ({submission_prefix}, {chunk_index}, {chunk_type}) to object store"
     )]
     ObjectStoreError {
+        #[source]
         source: object_store::Error,
         submission_prefix: Box<str>,
         chunk_index: chunk::ChunkIndex,
         chunk_type: ChunkType,
     },
-    #[error("Failed to read chunk element from stream/iterator at index {chunk_index}: ")]
+    #[error("Failed to read chunk element from stream/iterator at index {chunk_index}")]
     ChunkContentsEvalError {
         submission_prefix: Box<str>,
         chunk_index: chunk::ChunkIndex,
         chunk_type: ChunkType,
+        #[source]
         source: anyhow::Error,
     },
 }
@@ -84,19 +87,20 @@ pub enum ChunkStorageError {
 pub enum ChunksStorageError {
     #[error(transparent)]
     ChunkStorageError(#[from] ChunkStorageError),
-    #[error("Failed to read chunk element from stream/iterator: {source}")]
+    #[error("Failed to read chunk element from stream/iterator")]
     ChunkContentsEvalError {
         submission_prefix: Box<str>,
         chunk_type: ChunkType,
+        #[source]
         source: anyhow::Error,
     },
 }
 
 #[derive(thiserror::Error, Debug)]
 pub enum NewObjectStoreClientError {
-    #[error("Failed to parse URL: {0}")]
+    #[error("Failed to parse URL")]
     UrlParseFailure(#[from] url::ParseError),
-    #[error("URL is not valid object store URL {0}")]
+    #[error("URL is not valid object store URL")]
     ObjectStoreUrlFailure(#[from] object_store::Error),
 }
 

opsqueue/src/producer/client.rs

@@ -337,9 +337,9 @@ impl Client {
 
 #[derive(thiserror::Error, Debug)]
 pub enum InternalProducerClientError {
-    #[error("HTTP request failed: {0}")]
+    #[error("HTTP request failed")]
     HTTPClientError(#[from] reqwest::Error),
-    #[error("Error decoding JSON response: {0}")]
+    #[error("Error decoding JSON response")]
     ResponseDecodingError(#[from] serde_json::Error),
     #[error("Internal client received unexpected status: {0}")]
     UnexpectedStatus(StatusCode),