fix: ease the error type that is returned by a worker function (#577)

* fix: ease the error type that is returned

* chore: add changelog

Author: geofmureithi

CHANGELOG.md

@@ -12,10 +12,7 @@ All notable changes to this project are documented in this file.
 - **deps** : update rust crate redis to 0.31 ([#555](https://github.com/geofmureithi/apalis/pull/555))
 - **deps** : update rust crate sentry-core to 0.38.0 ([#569](https://github.com/geofmureithi/apalis/pull/569))
 - **deps** : update rust crate criterion to 0.6.0 ([#574](https://github.com/geofmureithi/apalis/pull/574))
-
-
-## Fixed
-
+- **error-handling** : ease the error type that is returned by a worker function ([#577](https://github.com/geofmureithi/apalis/pull/577))
 - **PostgresStorage**: fix type error when updating jobs ([#539](https://github.com/geofmureithi/apalis/issues/539))
 
 ## [0.7.1](https://github.com/geofmureithi/apalis/releases/tag/v0.7.1)

examples/basics/src/main.rs

@@ -29,18 +29,6 @@ async fn produce_jobs(storage: &SqliteStorage<Email>) {
     }
 }
 
-#[derive(thiserror::Error, Debug)]
-pub enum ServiceError {
-    #[error("data store disconnected")]
-    Disconnect(#[from] std::io::Error),
-    #[error("the data for key `{0}` is not available")]
-    Redaction(String),
-    #[error("invalid header (expected {expected:?}, found {found:?})")]
-    InvalidHeader { expected: String, found: String },
-    #[error("unknown data store error")]
-    Unknown,
-}
-
 #[derive(thiserror::Error, Debug)]
 pub enum PanicError {
     #[error("{0}")]
@@ -54,7 +42,7 @@ async fn send_email(
     svc: Data<EmailService>,
     worker: Worker<Context>,
     cache: Data<ValidEmailCache>,
-) -> Result<(), ServiceError> {
+) -> Result<(), BoxDynError> {
     info!("Job started in worker {:?}", worker.id());
     let cache_clone = cache.clone();
     let email_to = email.to.clone();

packages/apalis-core/src/response.rs

@@ -1,7 +1,7 @@
-use std::{any::Any, fmt::Debug, sync::Arc};
+use std::{fmt::Debug, sync::Arc};
 
 use crate::{
-    error::Error,
+    error::{BoxDynError, Error},
     task::{attempt::Attempt, task_id::TaskId},
 };
 
@@ -133,21 +133,17 @@ impl IntoResponse for bool {
     }
 }
 
-impl<T: Any, E: std::error::Error + Sync + Send + 'static + Any> IntoResponse
-    for std::result::Result<T, E>
-{
+impl<T, E: Into<BoxDynError>> IntoResponse for std::result::Result<T, E> {
     type Result = Result<T, Error>;
     fn into_response(self) -> Result<T, Error> {
         match self {
             Ok(value) => Ok(value),
             Err(e) => {
-                // Try to downcast the error to see if it is already of type `Error`
-                if let Some(custom_error) =
-                    (&e as &(dyn std::error::Error + 'static)).downcast_ref::<Error>()
-                {
+                let e = e.into();
+                if let Some(custom_error) = e.downcast_ref::<Error>() {
                     return Err(custom_error.clone());
                 }
-                Err(Error::Failed(Arc::new(Box::new(e))))
+                Err(Error::Failed(Arc::new(e)))
             }
         }
     }