Skip to content

Commit

Permalink
refactor: provide better context for errors (#430)
Browse files Browse the repository at this point in the history
  • Loading branch information
@chesedo
chesedo authored Oct 25, 2022
1 parent 65b71c8 commit bc13eb7
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 21 deletions.
47 changes: 26 additions & 21 deletions codegen/src/main/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ pub(crate) fn r#impl(_attr: TokenStream, item: TokenStream) -> TokenStream {
addr: std::net::SocketAddr,
runtime: &shuttle_service::Runtime,
) -> shuttle_service::ServeHandle {
runtime.spawn(async move { service.bind(addr).await })
use shuttle_service::Context;
runtime.spawn(async move { service.bind(addr).await.context("failed to bind service").map_err(Into::into) })
}

#fn_decl
Expand Down Expand Up @@ -228,6 +229,7 @@ impl ToTokens for Wrapper {
runtime: &shuttle_service::Runtime,
logger: shuttle_service::Logger,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
use shuttle_service::Context;
use shuttle_service::tracing_subscriber::prelude::*;
#extra_imports

Expand All @@ -249,15 +251,15 @@ impl ToTokens for Wrapper {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked setting logger".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to set logger"))
}
})?;

#(let #fn_inputs = #fn_inputs_builder::new()#fn_inputs_builder_options.build(#factory_ident, runtime).await?;)*
#(let #fn_inputs = #fn_inputs_builder::new()#fn_inputs_builder_options.build(#factory_ident, runtime).await.context(format!("failed to provision {}", stringify!(#fn_inputs_builder)))?;)*

runtime.spawn(async {
#fn_ident(#(#fn_inputs),*)
Expand All @@ -271,11 +273,11 @@ impl ToTokens for Wrapper {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked calling main".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to call main"))
}
})?
}
Expand Down Expand Up @@ -320,6 +322,7 @@ mod tests {
runtime: &shuttle_service::Runtime,
logger: shuttle_service::Logger,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
use shuttle_service::Context;
use shuttle_service::tracing_subscriber::prelude::*;
runtime.spawn_blocking(move || {
let filter_layer =
Expand All @@ -339,11 +342,11 @@ mod tests {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked setting logger".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to set logger"))
}
})?;

Expand All @@ -359,11 +362,11 @@ mod tests {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked calling main".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to call main"))
}
})?
}
Expand Down Expand Up @@ -432,6 +435,7 @@ mod tests {
runtime: &shuttle_service::Runtime,
logger: shuttle_service::Logger,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
use shuttle_service::Context;
use shuttle_service::tracing_subscriber::prelude::*;
use shuttle_service::ResourceBuilder;

Expand All @@ -453,16 +457,16 @@ mod tests {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked setting logger".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to set logger"))
}
})?;

let pool = shuttle_shared_db::Postgres::new().build(factory, runtime).await?;
let redis = shuttle_shared_db::Redis::new().build(factory, runtime).await?;
let pool = shuttle_shared_db::Postgres::new().build(factory, runtime).await.context(format!("failed to provision {}", stringify!(shuttle_shared_db::Postgres)))?;
let redis = shuttle_shared_db::Redis::new().build(factory, runtime).await.context(format!("failed to provision {}", stringify!(shuttle_shared_db::Redis)))?;

runtime.spawn(async {
complex(pool, redis)
Expand All @@ -476,11 +480,11 @@ mod tests {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked calling main".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to call main"))
}
})?
}
Expand Down Expand Up @@ -593,6 +597,7 @@ mod tests {
runtime: &shuttle_service::Runtime,
logger: shuttle_service::Logger,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
use shuttle_service::Context;
use shuttle_service::tracing_subscriber::prelude::*;
use shuttle_service::ResourceBuilder;

Expand All @@ -614,15 +619,15 @@ mod tests {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked setting logger".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to set logger"))
}
})?;

let pool = shuttle_shared_db::Postgres::new().size("10Gb").public(false).build(factory, runtime).await?;
let pool = shuttle_shared_db::Postgres::new().size("10Gb").public(false).build(factory, runtime).await.context(format!("failed to provision {}", stringify!(shuttle_shared_db::Postgres)))?;

runtime.spawn(async {
complex(pool)
Expand All @@ -636,11 +641,11 @@ mod tests {
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
.unwrap_or_else(|| "panicked calling main".to_string());

shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e).context("failed to call main"))
}
})?
}
Expand Down
1 change: 1 addition & 0 deletions service/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ use std::pin::Pin;
pub use async_trait::async_trait;

// Pub uses by `codegen`
pub use anyhow::Context;
pub use tokio::runtime::Runtime;
pub use tracing;
pub use tracing_subscriber;
Expand Down

0 comments on commit bc13eb7

Please sign in to comment.