Skip to content

Make unit enums strings, not null objects. #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kixelated merged 1 commit into from
Apr 15, 2025
Merged

Make unit enums strings, not null objects. #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 49 additions & 33 deletions web-message-derive/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ fn expand_struct(ident: &syn::Ident, fields: &Fields) -> proc_macro2::TokenStrea
quote! {
impl ::web_message::Message for #ident {
fn from_message(message: ::web_sys::js_sys::wasm_bindgen::JsValue) -> Result<Self, ::web_message::Error> {
let obj = web_sys::js_sys::Object::try_from(&message).ok_or(::web_message::Error::ExpectedUnitObject)?;
let obj = web_sys::js_sys::Object::try_from(&message).ok_or(::web_message::Error::UnexpectedType)?;
Ok(Self {
#(#field_inits),*
})
Expand All @@ -58,7 +58,7 @@ fn expand_enum(
enum_ident: &syn::Ident,
variants: &syn::punctuated::Punctuated<syn::Variant, syn::token::Comma>,
) -> proc_macro2::TokenStream {
let from_matches = variants.iter().map(|variant| {
let from_obj= variants.iter().filter_map(|variant| {
let variant_ident = &variant.ident;
let variant_str = variant_ident.to_string();

Expand All @@ -74,26 +74,21 @@ fn expand_enum(
}
});

quote! {
Some(quote! {
#variant_str => {
Ok(#enum_ident::#variant_ident {
#(#field_assignments),*
})
}
}
})
}

Fields::Unit => {
quote! {
#variant_str if val.is_null() => Ok(#enum_ident::#variant_ident),
#variant_str => Err(::web_message::Error::ExpectedNull),
}
}
Fields::Unit => None,

Fields::Unnamed(fields_unnamed) if fields_unnamed.unnamed.len() == 1 => {
quote! {
Some(quote! {
#variant_str => Ok(#enum_ident::#variant_ident(::web_message::Message::from_message(val)?)),
}
})
}

Fields::Unnamed(_) => {
Expand All @@ -102,6 +97,19 @@ fn expand_enum(
}
});

let from_string = variants.iter().filter_map(|variant| {
let variant_ident = &variant.ident;
let variant_str = variant_ident.to_string();

if let Fields::Unit = &variant.fields {
Some(quote! {
#variant_str => Ok(#enum_ident::#variant_ident),
})
} else {
None
}
});

let into_matches = variants.iter().map(|variant| {
let variant_ident = &variant.ident;
let variant_str = variant_ident.to_string();
Expand All @@ -121,22 +129,26 @@ fn expand_enum(

quote! {
#enum_ident::#variant_ident { #(#field_names),* } => {
let obj = ::web_sys::js_sys::Object::new();
let inner = ::web_sys::js_sys::Object::new();
#(#set_fields)*
::web_sys::js_sys::Reflect::set(&obj, &#variant_str.into(), &inner.into()).unwrap()
::web_sys::js_sys::Reflect::set(&obj, &#variant_str.into(), &inner.into()).unwrap();
obj.into()
}
}
}
Fields::Unit => {
quote! {
#enum_ident::#variant_ident =>
::web_sys::js_sys::Reflect::set(&obj, &#variant_str.into(), &::web_sys::js_sys::wasm_bindgen::JsValue::NULL).unwrap()
#enum_ident::#variant_ident => #variant_str.into()
}
}
Fields::Unnamed(fields_unnamed) if fields_unnamed.unnamed.len() == 1 => {
quote! {
#enum_ident::#variant_ident(v) =>
::web_sys::js_sys::Reflect::set(&obj, &#variant_str.into(), &v.into_message(_transferable)).unwrap()
#enum_ident::#variant_ident(v) => {
let obj = ::web_sys::js_sys::Object::new();
::web_sys::js_sys::Reflect::set(&obj, &#variant_str.into(), &v.into_message(_transferable)).unwrap();
obj.into()
}
}
}
Fields::Unnamed(_) => unimplemented!("web-message does not support tuple variants (yet)"),
Expand All @@ -146,31 +158,35 @@ fn expand_enum(
quote! {
impl ::web_message::Message for #enum_ident {
fn from_message(message: ::web_sys::js_sys::wasm_bindgen::JsValue) -> ::std::result::Result<Self, ::web_message::Error> {
// Grab the single key from the object
let obj = web_sys::js_sys::Object::try_from(&message).ok_or(::web_message::Error::ExpectedUnitObject)?;

let keys = web_sys::js_sys::Object::keys(&obj);
if keys.length() != 1 {
return Err(::web_message::Error::ExpectedUnitObject);
}
if let Some(s) = message.as_string() {
match s.as_str() {
#(#from_string)*
_ => Err(::web_message::Error::UnknownTag),
}
} else if let Some(obj) = web_sys::js_sys::Object::try_from(&message) {
let keys = web_sys::js_sys::Object::keys(&obj);
if keys.length() != 1 {
return Err(::web_message::Error::UnexpectedType);
}

let tag = keys.get(0);
let tag_str = tag.as_string().ok_or(::web_message::Error::ExpectedUnitObject)?;
let tag = keys.get(0);
let tag_str = tag.as_string().ok_or(::web_message::Error::UnexpectedType)?;

let val = ::web_sys::js_sys::Reflect::get(&obj, &tag).unwrap();
let val = ::web_sys::js_sys::Reflect::get(&obj, &tag).unwrap();

match tag_str.as_str() {
#(#from_matches)*
_ => Err(::web_message::Error::UnknownTag(tag_str)),
match tag_str.as_str() {
#(#from_obj)*
_ => Err(::web_message::Error::UnknownTag),
}
} else {
Err(::web_message::Error::UnexpectedType)
}
}

fn into_message(self, _transferable: &mut ::web_sys::js_sys::Array) -> ::web_sys::js_sys::wasm_bindgen::JsValue {
let obj = ::web_sys::js_sys::Object::new();
match self {
#(#into_matches),*
};
obj.into()
}
}
}
}
Expand Down
17 changes: 4 additions & 13 deletions web-message/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,11 @@ pub enum Error {
#[error("invalid '{0}' field")]
InvalidField(&'static str),

#[error("expected object with a single (string) key")]
ExpectedUnitObject,
#[error("unexpected type")]
UnexpectedType,

#[error("expected null")]
ExpectedNull,

#[error("invalid type: {0}")]
InvalidType(&'static str),

#[error("expected string")]
ExpectedString,

#[error("unknown tag: {0}")]
UnknownTag(String),
#[error("unknown tag")]
UnknownTag,

#[cfg(feature = "url")]
#[error("invalid URL: {0}")]
Expand Down
14 changes: 7 additions & 7 deletions web-message/src/message.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ macro_rules! upstream {
}

fn from_message(message: JsValue) -> Result<Self, Error> {
Self::try_from(message).map_err(|_| Error::InvalidType(stringify!($t)))
Self::try_from(message).map_err(|_| Error::UnexpectedType)
}
}
)*
Expand All @@ -41,7 +41,7 @@ macro_rules! integer {
}

fn from_message(message: JsValue) -> Result<Self, Error> {
Ok(message.as_f64().ok_or(Error::InvalidType(stringify!($t)))? as $t)
Ok(message.as_f64().ok_or(Error::UnexpectedType)? as $t)
}
}
)*
Expand All @@ -57,7 +57,7 @@ impl Message for bool {
}

fn from_message(message: JsValue) -> Result<Self, Error> {
message.as_bool().ok_or(Error::InvalidType("bool"))
message.as_bool().ok_or(Error::UnexpectedType)
}
}

Expand Down Expand Up @@ -88,7 +88,7 @@ impl<T: Message> Message for Vec<T> {

fn from_message(message: JsValue) -> Result<Self, Error> {
if !message.is_array() {
return Err(Error::InvalidType("Vec"));
return Err(Error::UnexpectedType);
}

let array = Array::from(&message);
Expand All @@ -109,7 +109,7 @@ impl Message for js_sys::ArrayBuffer {
fn from_message(message: JsValue) -> Result<Self, Error> {
message
.dyn_into::<js_sys::ArrayBuffer>()
.map_err(|_| Error::InvalidType("ArrayBuffer"))
.map_err(|_| Error::UnexpectedType)
}
}

Expand All @@ -126,7 +126,7 @@ macro_rules! transferable_feature {
fn from_message(message: JsValue) -> Result<Self, Error> {
message
.dyn_into::<web_sys::$t>()
.map_err(|_| Error::InvalidType(stringify!($t)))
.map_err(|_| Error::UnexpectedType)
}
}
)*
Expand Down Expand Up @@ -158,7 +158,7 @@ impl Message for url::Url {
}

fn from_message(message: JsValue) -> Result<Self, Error> {
let str = message.as_string().ok_or(Error::ExpectedString)?;
let str = message.as_string().ok_or(Error::UnexpectedType)?;
url::Url::parse(&str).map_err(Error::InvalidUrl)
}
}
Loading