Skip to content
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

Jump to bottom

feat(biome_deserialize_derive): adding a rest attribute #2757

Merged
merged 6 commits into from
May 15, 2024
Merged

feat(biome_deserialize_derive): adding a rest attribute #2757

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e250dd8
Adding a flatten attribute to deserialize derive
NicholasLYang May 7, 2024
ae242f2
- Changed from flatten to rest.
NicholasLYang May 9, 2024
515d2e0
PR feedback
NicholasLYang May 13, 2024
e064ddb
Minor fixes. Exclude rest field from deserialization
NicholasLYang May 13, 2024
c149797
Don't bail when failing to deserialize an extra field
NicholasLYang May 14, 2024
d926190
Add documentation
NicholasLYang May 14, 2024
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
80 changes: 64 additions & 16 deletions crates/biome_deserialize_macros/src/deserializable_derive.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ impl DeriveInput {
}
Data::Struct(data) => {
if data.fields.iter().all(|field| field.ident.is_some()) {
let mut rest_field = None;
let fields = data
.fields
.into_iter()
Expand All @@ -84,6 +85,16 @@ impl DeriveInput {
.rename
.unwrap_or_else(|| Case::Camel.convert(&ident.to_string()));

if rest_field.is_some() && attrs.rest {
abort!(
ident,
"Cannot have multiple fields with #[deserializable(rest)]"
)
}
if attrs.rest {
rest_field = Some(ident.clone());
}

DeserializableFieldData {
bail_on_error: attrs.bail_on_error,
deprecated: attrs.deprecated,
Expand All @@ -97,8 +108,18 @@ impl DeriveInput {
})
.collect();

if rest_field.is_some()
&& matches!(attrs.unknown_fields, Some(UnknownFields::Deny))
{
abort!(
rest_field.unwrap(),
"Cannot have a field with #[deserializable(rest)] and #[deserializable(unknown_fields = \"deny\")]"
)
}

DeserializableData::Struct(DeserializableStructData {
fields,
rest_field,
with_validator: attrs.with_validator,
unknown_fields: attrs.unknown_fields.unwrap_or_default(),
})
Expand Down Expand Up @@ -151,6 +172,7 @@ pub struct DeserializableNewtypeData {
#[derive(Debug)]
pub struct DeserializableStructData {
fields: Vec<DeserializableFieldData>,
rest_field: Option<Ident>,
with_validator: bool,
unknown_fields: UnknownFields,
}
Expand Down Expand Up @@ -415,25 +437,49 @@ fn generate_deserializable_struct(
} else {
validator
};
let unknown_key_handler = match data.unknown_fields {
UnknownFields::Warn | UnknownFields::Deny => {
let with_customseverity = if data.unknown_fields == UnknownFields::Warn {
quote! { .with_custom_severity(biome_diagnostics::Severity::Warning) }
} else {
quote! {}
};
quote! {
unknown_key => {
const ALLOWED_KEYS: &[&str] = &[#(#allowed_keys),*];
diagnostics.push(DeserializationDiagnostic::new_unknown_key(
unknown_key,
key.range(),
ALLOWED_KEYS,
)#with_customseverity)
let unknown_key_handler = if data.rest_field.is_some() {
quote! {
unknown_key => {
let key_text = Text::deserialize(&key, "", diagnostics)?;
let value = Deserializable::deserialize(&value, key_text.text(), diagnostics)?;
unknown_fields.push((key_text, value));
NicholasLYang marked this conversation as resolved.
Show resolved Hide resolved
}
}
} else {
match data.unknown_fields {
UnknownFields::Warn | UnknownFields::Deny => {
let with_customseverity = if data.unknown_fields == UnknownFields::Warn {
quote! { .with_custom_severity(biome_diagnostics::Severity::Warning) }
} else {
quote! {}
};
quote! {
unknown_key => {
const ALLOWED_KEYS: &[&str] = &[#(#allowed_keys),*];
diagnostics.push(DeserializationDiagnostic::new_unknown_key(
unknown_key,
key.range(),
ALLOWED_KEYS,
)#with_customseverity)
}
}
}
UnknownFields::Allow => quote! { _ => {} },
}
UnknownFields::Allow => quote! { _ => {} },
};

let (unknown_fields_initializer, collect_unknown_fields) = if let Some(field) = data.rest_field
{
(
quote! {
let mut unknown_fields = vec![];
},
quote! {
result.#field = unknown_fields.into_iter().collect();
},
)
} else {
(quote! {}, quote! {})
};

let tuple_type = generate_generics_tuple(&generics);
Expand Down Expand Up @@ -463,6 +509,7 @@ fn generate_deserializable_struct(
) -> Option<Self::Output> {
use biome_deserialize::{Deserializable, DeserializationDiagnostic, Text};
let mut result: Self::Output = Self::Output::default();
#unknown_fields_initializer
for (key, value) in members.flatten() {
let Some(key_text) = Text::deserialize(&key, "", diagnostics) else {
continue;
Expand All @@ -473,6 +520,7 @@ fn generate_deserializable_struct(
}
}
#validator
#collect_unknown_fields
Some(result)
}
}
Expand Down
5 changes: 5 additions & 0 deletions crates/biome_deserialize_macros/src/deserializable_derive/struct_field_attrs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ pub struct StructFieldAttrs {

/// Optional validation function to be called on the field value.
pub validate: Option<Path>,

/// Uses the field as a catch-all for unknown entries in the map
pub rest: bool,
}

#[derive(Clone, Debug, Eq, PartialEq)]
Expand Down Expand Up @@ -62,6 +65,8 @@ impl TryFrom<&Vec<Attribute>> for StructFieldAttrs {
opts.passthrough_name = true;
} else if path.is_ident("bail_on_error") {
opts.bail_on_error = true;
} else if path.is_ident("rest") {
opts.rest = true;
} else {
let path_str = path.to_token_stream().to_string();
return Err(Error::new(
Expand Down