Support ContentId in rbx_reflector and rbx_xml (#455)

rojo-rbx · Oct 10, 2024 · 7d8482e · 7d8482e
1 parent a9252ac
commit 7d8482e
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 15 deletions.
diff --git a/rbx_reflector/src/cli/generate.rs b/rbx_reflector/src/cli/generate.rs
@@ -300,7 +300,7 @@ fn variant_type_from_str(type_name: &str) -> Option<VariantType> {
         "Color3" => VariantType::Color3,
         "Color3uint8" => VariantType::Color3uint8,
         "ColorSequence" => VariantType::ColorSequence,
-        "Content" => VariantType::Content,
+        "ContentId" => VariantType::Content,
         "Faces" => VariantType::Faces,
         "Font" => VariantType::Font,
         "Instance" => VariantType::Ref,

diff --git a/rbx_xml/CHANGELOG.md b/rbx_xml/CHANGELOG.md
@@ -1,6 +1,9 @@
 # rbx_xml Changelog
 
 ## Unreleased
+* `Content` data now serializes with `ContentId`, reflecting Roblox's changes. ([#455])
+
+[#455]: https://github.com/rojo-rbx/rbx-dom/pull/455
 
 ## 0.13.5 (2024-08-22)
 * Updated rbx-dom dependencies

diff --git a/rbx_xml/src/tests/snapshots/rbx_xml__tests__formatting__serialized.snap b/rbx_xml/src/tests/snapshots/rbx_xml__tests__formatting__serialized.snap
@@ -1,5 +1,6 @@
 ---
 source: rbx_xml/src/tests/formatting.rs
+assertion_line: 174
 expression: ser_str
 ---
 <roblox version="4">
@@ -31,13 +32,13 @@ expression: ser_str
         <B>125600</B>
       </Color3>
       <ColorSequence name="TestColorSequence">0 0 0.5 1 0 1 1 0.5 0 0 </ColorSequence>
-      <Content name="TestContent1">
+      <ContentId name="TestContent1">
         <url>Wow!</url>
-      </Content>
-      <Content name="TestContent2">
+      </ContentId>
+      <ContentId name="TestContent2">
         <null>
         </null>
-      </Content>
+      </ContentId>
     </Properties>
     <Item class="TestClass" referent="1">
       <Properties>

diff --git a/rbx_xml/src/types/content.rs b/rbx_xml/src/types/content.rs
@@ -9,11 +9,11 @@ use crate::{
     serializer_core::{XmlEventWriter, XmlWriteEvent},
 };
 
-// A Content type is serialized as either:
+// A ContentId type is serialized as either:
 // <null></null>, which indicates an empty content value
 // <url>something</url>, where 'something' is a URL to use for content.
 impl XmlType for Content {
-    const XML_TAG_NAME: &'static str = "Content";
+    const XML_TAG_NAME: &'static str = "ContentId";
 
     fn write_xml<W: Write>(&self, writer: &mut XmlEventWriter<W>) -> Result<(), EncodeError> {
         // FIXME: Content should have a method for this
@@ -66,6 +66,28 @@ impl XmlType for Content {
     }
 }
 
+/// In release 645, Roblox changed `Content` to serialize as `ContentId`.
+/// However, we still need to deserialize older models, so we have to support
+/// `Content`.
+///
+/// This may need to be replaced in the future if Roblox implements a new
+/// `Content` type, but right now they haven't.
+#[derive(Debug, PartialEq, Eq)]
+pub struct ContentDummy(pub Content);
+
+impl XmlType for ContentDummy {
+    const XML_TAG_NAME: &'static str = "Content";
+
+    fn write_xml<W: Write>(&self, _writer: &mut XmlEventWriter<W>) -> Result<(), EncodeError> {
+        panic!("Content values are only read, never written.");
+    }
+
+    fn read_xml<R: Read>(reader: &mut XmlEventReader<R>) -> Result<Self, DecodeError> {
+        // We just want to use the same deserializer as ContentId
+        Content::read_xml(reader).map(ContentDummy)
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
@@ -86,9 +108,9 @@ mod test {
     fn deserialize_content_url() {
         test_util::test_xml_deserialize(
             r#"
-                <Content name="something">
+                <ContentId name="something">
                     <url>Some URL</url>
-                </Content>
+                </ContentId>
             "#,
             &Content::from("Some URL"),
         );
@@ -98,9 +120,9 @@ mod test {
     fn deserialize_content_null() {
         test_util::test_xml_deserialize(
             r#"
-                <Content name="something">
+                <ContentId name="something">
                     <null></null>
-                </Content>
+                </ContentId>
             "#,
             &Content::new(),
         );
@@ -110,9 +132,9 @@ mod test {
     fn serialize_content_url() {
         test_util::test_xml_serialize(
             r#"
-                <Content name="foo">
+                <ContentId name="foo">
                     <url>Some URL</url>
-                </Content>
+                </ContentId>
             "#,
             &Content::from("Some URL"),
         );
@@ -122,9 +144,9 @@ mod test {
     fn serialize_content_null() {
         test_util::test_xml_serialize(
             r#"
-                <Content name="foo">
+                <ContentId name="foo">
                     <null></null>
-                </Content>
+                </ContentId>
             "#,
             &Content::new(),
         );

diff --git a/rbx_xml/src/types/mod.rs b/rbx_xml/src/types/mod.rs
@@ -83,6 +83,10 @@ macro_rules! declare_rbx_types {
                     let value = self::strings::ProtectedStringDummy::read_outer_xml(reader)?;
                     Ok(Some(Variant::String(value.0)))
                 },
+                self::content::ContentDummy::XML_TAG_NAME => {
+                    let value = self::content::ContentDummy::read_outer_xml(reader)?;
+                    Ok(Some(Variant::Content(value.0)))
+                }
 
                 self::referent::XML_TAG_NAME => Ok(Some(Variant::Ref(read_ref(reader, instance_id, property_name, state)?))),
                 self::shared_string::XML_TAG_NAME => read_shared_string(reader, instance_id, property_name, state).map(Some),