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

Fix: deserialize DynamicEnum using index #12464

Merged
merged 9 commits into from
Mar 14, 2024
Merged

Fix: deserialize DynamicEnum using index #12464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
956eb1e
test: add failing `should_reserialize` test
mrchantey Mar 13, 2024
a4a5980
Add regression test comment
mrchantey Mar 13, 2024
ac6ee8a
fix: use DynamicEnum::set_variant_with_index
mrchantey Mar 13, 2024
88c8f31
test: add `DynamicEnum` reserialize test
mrchantey Mar 13, 2024
c15f4bc
test: deduplicate code with setup function `get_my_struct()`
mrchantey Mar 13, 2024
b97b7de
test: use `MyStruct` for `should_reserialize`
mrchantey Mar 13, 2024
b93a63a
test: remove `bevy_scene` regression test
mrchantey Mar 13, 2024
2119bb8
test: use serde `alias` instead of `rename`
mrchantey Mar 14, 2024
b6cd9d2
test: deduplicate identical MyStruct declarations
mrchantey Mar 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
109 changes: 37 additions & 72 deletions crates/bevy_reflect/src/serde/de.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,8 +753,12 @@ impl<'a, 'de> Visitor<'de> for EnumVisitor<'a> {
)?
.into(),
};

dynamic_enum.set_variant(variant_info.name(), value);
let variant_name = variant_info.name();
let variant_index = self
.enum_info
.index_of(variant_name)
.expect("variant should exist");
dynamic_enum.set_variant_with_index(variant_index, variant_name, value);
Ok(dynamic_enum)
}
}
Expand Down Expand Up @@ -1058,7 +1062,7 @@ mod tests {
use bevy_utils::HashMap;

use crate as bevy_reflect;
use crate::serde::{TypedReflectDeserializer, UntypedReflectDeserializer};
use crate::serde::{ReflectSerializer, TypedReflectDeserializer, UntypedReflectDeserializer};
use crate::{DynamicEnum, FromReflect, Reflect, ReflectDeserialize, TypeRegistry};

#[derive(Reflect, Debug, PartialEq)]
Expand Down Expand Up @@ -1116,7 +1120,7 @@ mod tests {
#[reflect(Deserialize)]
struct CustomDeserialize {
value: usize,
#[serde(rename = "renamed")]
#[serde(alias = "renamed")]
inner_struct: SomeDeserializableStruct,
}

Expand Down Expand Up @@ -1166,12 +1170,11 @@ mod tests {
registry
}

#[test]
fn should_deserialize() {
fn get_my_struct() -> MyStruct {
let mut map = HashMap::new();
map.insert(64, 32);

let expected = MyStruct {
MyStruct {
primitive_value: 123,
option_value: Some(String::from("Hello world!")),
option_value_complex: Some(SomeStruct { foo: 123 }),
Expand All @@ -1198,7 +1201,13 @@ mod tests {
value: 100,
inner_struct: SomeDeserializableStruct { foo: 101 },
},
};
}
}

#[test]
fn should_deserialize() {
let expected = get_my_struct();
let registry = get_registry();

let input = r#"{
"bevy_reflect::serde::de::tests::MyStruct": (
Expand Down Expand Up @@ -1243,7 +1252,6 @@ mod tests {
),
}"#;

let registry = get_registry();
let reflect_deserializer = UntypedReflectDeserializer::new(&registry);
let mut ron_deserializer = ron::de::Deserializer::from_str(input).unwrap();
let dynamic_output = reflect_deserializer
Expand Down Expand Up @@ -1425,40 +1433,28 @@ mod tests {
assert!(expected.reflect_partial_eq(output.as_ref()).unwrap());
}

// Regression test for https://github.com/bevyengine/bevy/issues/12462
#[test]
fn should_deserialize_non_self_describing_binary() {
let mut map = HashMap::new();
map.insert(64, 32);
fn should_reserialize() {
let registry = get_registry();
let input1 = get_my_struct();

let expected = MyStruct {
primitive_value: 123,
option_value: Some(String::from("Hello world!")),
option_value_complex: Some(SomeStruct { foo: 123 }),
tuple_value: (PI, 1337),
list_value: vec![-2, -1, 0, 1, 2],
array_value: [-2, -1, 0, 1, 2],
map_value: map,
struct_value: SomeStruct { foo: 999999999 },
tuple_struct_value: SomeTupleStruct(String::from("Tuple Struct")),
unit_struct: SomeUnitStruct,
unit_enum: SomeEnum::Unit,
newtype_enum: SomeEnum::NewType(123),
tuple_enum: SomeEnum::Tuple(1.23, 3.21),
struct_enum: SomeEnum::Struct {
foo: String::from("Struct variant value"),
},
ignored_struct: SomeIgnoredStruct { ignored: 0 },
ignored_tuple_struct: SomeIgnoredTupleStruct(0),
ignored_struct_variant: SomeIgnoredEnum::Struct {
foo: String::default(),
},
ignored_tuple_variant: SomeIgnoredEnum::Tuple(0.0, 0.0),
custom_deserialize: CustomDeserialize {
value: 100,
inner_struct: SomeDeserializableStruct { foo: 101 },
},
};
let serializer1 = ReflectSerializer::new(&input1, &registry);
let serialized1 = ron::ser::to_string(&serializer1).unwrap();

let mut deserializer = ron::de::Deserializer::from_str(&serialized1).unwrap();
let reflect_deserializer = UntypedReflectDeserializer::new(&registry);
let input2 = reflect_deserializer.deserialize(&mut deserializer).unwrap();

let serializer2 = ReflectSerializer::new(&*input2, &registry);
let serialized2 = ron::ser::to_string(&serializer2).unwrap();

assert_eq!(serialized1, serialized2);
}

#[test]
fn should_deserialize_non_self_describing_binary() {
let expected = get_my_struct();
let registry = get_registry();

let input = vec![
Expand Down Expand Up @@ -1490,38 +1486,7 @@ mod tests {

#[test]
fn should_deserialize_self_describing_binary() {
let mut map = HashMap::new();
map.insert(64, 32);

let expected = MyStruct {
primitive_value: 123,
option_value: Some(String::from("Hello world!")),
option_value_complex: Some(SomeStruct { foo: 123 }),
tuple_value: (PI, 1337),
list_value: vec![-2, -1, 0, 1, 2],
array_value: [-2, -1, 0, 1, 2],
map_value: map,
struct_value: SomeStruct { foo: 999999999 },
tuple_struct_value: SomeTupleStruct(String::from("Tuple Struct")),
unit_struct: SomeUnitStruct,
unit_enum: SomeEnum::Unit,
newtype_enum: SomeEnum::NewType(123),
tuple_enum: SomeEnum::Tuple(1.23, 3.21),
struct_enum: SomeEnum::Struct {
foo: String::from("Struct variant value"),
},
ignored_struct: SomeIgnoredStruct { ignored: 0 },
ignored_tuple_struct: SomeIgnoredTupleStruct(0),
ignored_struct_variant: SomeIgnoredEnum::Struct {
foo: String::default(),
},
ignored_tuple_variant: SomeIgnoredEnum::Tuple(0.0, 0.0),
custom_deserialize: CustomDeserialize {
value: 100,
inner_struct: SomeDeserializableStruct { foo: 101 },
},
};

let expected = get_my_struct();
let registry = get_registry();

let input = vec![
Expand Down
79 changes: 10 additions & 69 deletions crates/bevy_reflect/src/serde/ser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,12 +574,10 @@ mod tests {
registry
}

#[test]
fn should_serialize() {
fn get_my_struct() -> MyStruct {
let mut map = HashMap::new();
map.insert(64, 32);

let input = MyStruct {
MyStruct {
primitive_value: 123,
option_value: Some(String::from("Hello world!")),
option_value_complex: Some(SomeStruct { foo: 123 }),
Expand All @@ -606,9 +604,14 @@ mod tests {
value: 100,
inner_struct: SomeSerializableStruct { foo: 101 },
},
};
}
}

#[test]
fn should_serialize() {
let input = get_my_struct();
let registry = get_registry();

let serializer = ReflectSerializer::new(&input, &registry);

let config = PrettyConfig::default()
Expand Down Expand Up @@ -776,38 +779,7 @@ mod tests {

#[test]
fn should_serialize_non_self_describing_binary() {
let mut map = HashMap::new();
map.insert(64, 32);

let input = MyStruct {
primitive_value: 123,
option_value: Some(String::from("Hello world!")),
option_value_complex: Some(SomeStruct { foo: 123 }),
tuple_value: (PI, 1337),
list_value: vec![-2, -1, 0, 1, 2],
array_value: [-2, -1, 0, 1, 2],
map_value: map,
struct_value: SomeStruct { foo: 999999999 },
tuple_struct_value: SomeTupleStruct(String::from("Tuple Struct")),
unit_struct: SomeUnitStruct,
unit_enum: SomeEnum::Unit,
newtype_enum: SomeEnum::NewType(123),
tuple_enum: SomeEnum::Tuple(1.23, 3.21),
struct_enum: SomeEnum::Struct {
foo: String::from("Struct variant value"),
},
ignored_struct: SomeIgnoredStruct { ignored: 123 },
ignored_tuple_struct: SomeIgnoredTupleStruct(123),
ignored_struct_variant: SomeIgnoredEnum::Struct {
foo: String::from("Struct Variant"),
},
ignored_tuple_variant: SomeIgnoredEnum::Tuple(1.23, 3.45),
custom_serialize: CustomSerialize {
value: 100,
inner_struct: SomeSerializableStruct { foo: 101 },
},
};

let input = get_my_struct();
let registry = get_registry();

let serializer = ReflectSerializer::new(&input, &registry);
Expand All @@ -834,38 +806,7 @@ mod tests {

#[test]
fn should_serialize_self_describing_binary() {
let mut map = HashMap::new();
map.insert(64, 32);

let input = MyStruct {
primitive_value: 123,
option_value: Some(String::from("Hello world!")),
option_value_complex: Some(SomeStruct { foo: 123 }),
tuple_value: (PI, 1337),
list_value: vec![-2, -1, 0, 1, 2],
array_value: [-2, -1, 0, 1, 2],
map_value: map,
struct_value: SomeStruct { foo: 999999999 },
tuple_struct_value: SomeTupleStruct(String::from("Tuple Struct")),
unit_struct: SomeUnitStruct,
unit_enum: SomeEnum::Unit,
newtype_enum: SomeEnum::NewType(123),
tuple_enum: SomeEnum::Tuple(1.23, 3.21),
struct_enum: SomeEnum::Struct {
foo: String::from("Struct variant value"),
},
ignored_struct: SomeIgnoredStruct { ignored: 123 },
ignored_tuple_struct: SomeIgnoredTupleStruct(123),
ignored_struct_variant: SomeIgnoredEnum::Struct {
foo: String::from("Struct Variant"),
},
ignored_tuple_variant: SomeIgnoredEnum::Tuple(1.23, 3.45),
custom_serialize: CustomSerialize {
value: 100,
inner_struct: SomeSerializableStruct { foo: 101 },
},
};

let input = get_my_struct();
let registry = get_registry();

let serializer = ReflectSerializer::new(&input, &registry);
Expand Down