Skip to content

Commit

Permalink
chore: Review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@jawoznia
jawoznia committed Sep 18, 2024
1 parent fc5543d commit 2af6f59
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 79 deletions.
161 changes: 90 additions & 71 deletions sylvia-derive/src/contract/communication/reply.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ impl<'a> Reply<'a> {

match id {
#(#match_arms,)*
// TODO: Add proper result forwarding.
_ => {
let err_msg = format!("Unknown reply id: {}.", id);
Err( #sylvia ::cw_std::StdError::generic_err(err_msg)).map_err(Into::into)
Expand Down Expand Up @@ -114,34 +113,37 @@ impl<'a> ReplyVariants<'a> for MsgVariants<'a, GenericParam> {
fn as_reply_data(&self) -> Vec<ReplyData> {
let mut reply_data: Vec<ReplyData> = vec![];

self
.variants()
self.variants()
.flat_map(ReplyVariant::as_reply_data)
.for_each(|(reply_id, function_name, reply_on)| {
match reply_data.iter_mut().find(|existing_data| existing_data.reply_id == reply_id) {
match reply_data
.iter_mut()
.find(|existing_data| existing_data.reply_id == reply_id)
{
Some(existing_data)
if existing_data.handlers
if existing_data
.handlers
.iter()
.any(|(_, prev_reply_on)| {
prev_reply_on.excludes(&reply_on)
}) =>
.any(|(_, prev_reply_on)| prev_reply_on.excludes(&reply_on)) =>
{
existing_data.handlers.iter().for_each(|(prev_function_name, prev_reply_on)|{
emit_error!(reply_id.span(), "Duplicated reply handler.";
note = prev_function_name.span() => format!("Previous definition of handler={} for reply_on={}", existing_data.reply_id.to_string(), prev_reply_on)
)
})
},
Some(existing_data) => {
existing_data.handlers.push((function_name, reply_on))
},
None => reply_data.push(ReplyData::new (reply_id, function_name, reply_on)),
}});
existing_data.handlers.iter().for_each(
|(prev_function_name, prev_reply_on)| {
emit_error!(reply_id.span(), "Duplicated reply handler.";
note = existing_data.reply_id.span() => format!("Previous definition of handler={} for reply_on={} defined on `fn {}()`", existing_data.reply_id.to_string(), prev_reply_on, prev_function_name);
)
},
)
}
Some(existing_data) => existing_data.handlers.push((function_name, reply_on)),
None => reply_data.push(ReplyData::new(reply_id, function_name, reply_on)),
}
});

reply_data
}
}

/// Maps single reply id with its handlers.
struct ReplyData<'a> {
pub reply_id: Ident,
pub handlers: Vec<(&'a Ident, ReplyOn)>,
Expand All @@ -155,67 +157,19 @@ impl<'a> ReplyData<'a> {
}
}

/// Emits success and failure match arms for a single `ReplyId`.
fn emit_match_arms(&self, contract: &Type, generics: &[&GenericParam]) -> TokenStream {
let Self { reply_id, handlers } = self;

let sylvia = crate_module();
let contract_turbo: Type = if !generics.is_empty() {
let contract_name = StripGenerics.fold_type((contract.clone()).clone());
parse_quote! { #contract_name :: < #(#generics),* > }
} else {
parse_quote! { #contract }
};

let success_match_arm = match handlers
.iter()
.find(|(_, reply_on)| reply_on == &ReplyOn::Success || reply_on == &ReplyOn::Always)
{
Some((function_name, reply_on)) if reply_on == &ReplyOn::Success => quote! {
#sylvia ::cw_std::SubMsgResult::Ok(sub_msg_resp) => {
#[allow(deprecated)]
let #sylvia ::cw_std::SubMsgResponse { events, data, msg_responses} = sub_msg_resp;
#contract_turbo ::new(). #function_name ((deps, env, gas_used, events, msg_responses).into(), data, payload)
}
},
Some((function_name, reply_on)) if reply_on == &ReplyOn::Always => quote! {
#sylvia ::cw_std::SubMsgResult::Ok(_) => {
#contract_turbo ::new(). #function_name ((deps, env, gas_used, vec![], vec![]).into(), result, payload)
}
},
_ => quote! {
#sylvia ::cw_std::SubMsgResult::Ok(sub_msg_resp) => {
let mut resp = sylvia::cw_std::Response::new().add_events(sub_msg_resp.events);

#[allow(deprecated)]
if sub_msg_resp.data.is_some() {
resp = resp.set_data(sub_msg_resp.data.unwrap());
}

Ok(resp)
}
},
};

let failure_match_arm = match handlers
.iter()
.find(|(_, reply_on)| reply_on == &ReplyOn::Failure || reply_on == &ReplyOn::Always)
{
Some((function_name, reply_on)) if reply_on == &ReplyOn::Failure => quote! {
#sylvia ::cw_std::SubMsgResult::Err(error) => {
#contract_turbo ::new(). #function_name ((deps, env, gas_used, vec![], vec![]).into(), error, payload)
}
},
Some((function_name, reply_on)) if reply_on == &ReplyOn::Always => quote! {
#sylvia ::cw_std::SubMsgResult::Err(_) => {
#contract_turbo ::new(). #function_name ((deps, env, gas_used, vec![], vec![]).into(), result, payload)
}
},
_ => quote! {
#sylvia ::cw_std::SubMsgResult::Err(error) => {
Err(sylvia::cw_std::StdError::generic_err(error)).map_err(Into::into)
}
},
};
let success_match_arm = emit_success_match_arm(handlers, &contract_turbo);
let failure_match_arm = emit_failure_match_arm(handlers, &contract_turbo);

quote! {
#reply_id => {
Expand All @@ -228,6 +182,71 @@ impl<'a> ReplyData<'a> {
}
}

/// Emits match arm for [ReplyOn::Success].
/// In case neither [ReplyOn::Success] nor [ReplyOn::Always] is present, `Response::events`
/// and `Response::data` are forwarded in the `Response`
fn emit_success_match_arm(handlers: &[(&Ident, ReplyOn)], contract_turbo: &Type) -> TokenStream {
let sylvia = crate_module();

match handlers
.iter()
.find(|(_, reply_on)| reply_on == &ReplyOn::Success || reply_on == &ReplyOn::Always)
{
Some((function_name, reply_on)) if reply_on == &ReplyOn::Success => quote! {
#sylvia ::cw_std::SubMsgResult::Ok(sub_msg_resp) => {
#[allow(deprecated)]
let #sylvia ::cw_std::SubMsgResponse { events, data, msg_responses} = sub_msg_resp;
#contract_turbo ::new(). #function_name ((deps, env, gas_used, events, msg_responses).into(), data, payload)
}
},
Some((function_name, reply_on)) if reply_on == &ReplyOn::Always => quote! {
#sylvia ::cw_std::SubMsgResult::Ok(_) => {
#contract_turbo ::new(). #function_name ((deps, env, gas_used, vec![], vec![]).into(), result, payload)
}
},
_ => quote! {
#sylvia ::cw_std::SubMsgResult::Ok(sub_msg_resp) => {
let mut resp = sylvia::cw_std::Response::new().add_events(sub_msg_resp.events);

#[allow(deprecated)]
if sub_msg_resp.data.is_some() {
resp = resp.set_data(sub_msg_resp.data.unwrap());
}

Ok(resp)
}
},
}
}

/// Emits match arm for [ReplyOn::Failure].
/// In case neither [ReplyOn::Failure] nor [ReplyOn::Always] is present,
/// the error is forwarded.
fn emit_failure_match_arm(handlers: &[(&Ident, ReplyOn)], contract_turbo: &Type) -> TokenStream {
let sylvia = crate_module();

match handlers
.iter()
.find(|(_, reply_on)| reply_on == &ReplyOn::Failure || reply_on == &ReplyOn::Always)
{
Some((function_name, reply_on)) if reply_on == &ReplyOn::Failure => quote! {
#sylvia ::cw_std::SubMsgResult::Err(error) => {
#contract_turbo ::new(). #function_name ((deps, env, gas_used, vec![], vec![]).into(), error, payload)
}
},
Some((function_name, reply_on)) if reply_on == &ReplyOn::Always => quote! {
#sylvia ::cw_std::SubMsgResult::Err(_) => {
#contract_turbo ::new(). #function_name ((deps, env, gas_used, vec![], vec![]).into(), result, payload)
}
},
_ => quote! {
#sylvia ::cw_std::SubMsgResult::Err(error) => {
Err(sylvia::cw_std::StdError::generic_err(error)).map_err(Into::into)
}
},
}
}

trait ReplyVariant<'a> {
fn as_handlers(&'a self) -> Vec<&'a Ident>;
fn as_reply_data(&self) -> Vec<(Ident, &Ident, ReplyOn)>;
Expand Down Expand Up @@ -255,7 +274,7 @@ impl<'a> ReplyVariant<'a> for MsgVariant<'a> {
}
}

/// Maps self to a reply id
/// Maps self to an [Ident] reply id.
trait AsReplyId {
fn as_reply_id(&self) -> Ident;
}
Expand Down
6 changes: 3 additions & 3 deletions sylvia/tests/ui/attributes/msg/overlapping_reply_handlers.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ impl Contract {
Ok(Response::new())
}

#[sv::msg(reply, handlers(handler1))]
#[sv::msg(reply, handlers=[handler1])]
fn reply_always(&self, _ctx: ReplyCtx, _reply: Reply) -> StdResult<Response> {
Ok(Response::new())
}

#[sv::msg(reply, handlers(handler1), reply_on=success)]
#[sv::msg(reply, handlers=[handler1], reply_on=success)]
fn duplicated_success_for_reply_always(
&self,
_ctx: ReplyCtx,
Expand All @@ -32,7 +32,7 @@ impl Contract {
Ok(Response::new())
}

#[sv::msg(reply, handlers(handler2), reply_on=failure)]
#[sv::msg(reply, handlers=[handler2], reply_on=failure)]
fn some_reply(&self, _ctx: ReplyCtx, _reply: Reply) -> StdResult<Response> {
Ok(Response::new())
}
Expand Down
10 changes: 5 additions & 5 deletions sylvia/tests/ui/attributes/msg/overlapping_reply_handlers.stderr
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
error: Duplicated reply handler.

= note: Previous definition of handler=HANDLER_1_REPLY_ID for reply_on=always
= note: Previous definition of handler=HANDLER_1_REPLY_ID for reply_on=always defined on `fn reply_always()`

--> tests/ui/attributes/msg/overlapping_reply_handlers.rs:26:31
--> tests/ui/attributes/msg/overlapping_reply_handlers.rs:26:32
|
26 | #[sv::msg(reply, handlers(handler1), reply_on=success)]
| ^^^^^^^^
26 | #[sv::msg(reply, handlers=[handler1], reply_on=success)]
| ^^^^^^^^

error: Duplicated reply handler.

= note: Previous definition of handler=HANDLER_2_REPLY_ID for reply_on=failure
= note: Previous definition of handler=HANDLER_2_REPLY_ID for reply_on=failure defined on `fn some_reply()`

--> tests/ui/attributes/msg/overlapping_reply_handlers.rs:41:8
|
Expand Down

0 comments on commit 2af6f59

Please sign in to comment.