feat(common): Enable bytecheck for missing structs (#7465)

Author: kwonoj

crates/swc_common/src/comments.rs

@@ -546,6 +546,8 @@ impl SingleThreadedComments {
     any(feature = "rkyv-impl"),
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv-impl", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv-impl", archive_attr(repr(C)))]
 pub struct Comment {
     pub kind: CommentKind,
     pub span: Span,
@@ -564,6 +566,7 @@ impl Spanned for Comment {
     any(feature = "rkyv-impl"),
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv-impl", archive(check_bytes))]
 pub enum CommentKind {
     Line,
     Block,

crates/swc_common/src/plugin/serialized.rs

@@ -80,7 +80,7 @@ impl PluginSerializedBytes {
      * Internal fn to constructs an instance from raw bytes ptr.
      */
     #[tracing::instrument(level = "info", skip_all)]
-    fn from_raw_ptr(
+    pub fn from_raw_ptr(
         raw_allocated_ptr: *const u8,
         raw_allocated_ptr_len: usize,
     ) -> PluginSerializedBytes {
@@ -114,27 +114,6 @@ impl PluginSerializedBytes {
     }
 }
 
-/// Simple wrapper around constructing PluginSerializedBytes from raw
-/// ptr to call deserialize to support common workflow on both of runtime
-/// (host / plugin) to instantiate a struct from allocated / copied ptr.
-///
-/// # Safety
-/// This is naturally unsafe by constructing bytes slice from raw ptr.
-#[tracing::instrument(level = "info", skip_all)]
-pub unsafe fn deserialize_from_ptr<W>(
-    raw_allocated_ptr: *const u8,
-    raw_allocated_ptr_len: u32,
-) -> Result<VersionedSerializable<W>, Error>
-where
-    W: rkyv::Archive,
-    W::Archived: rkyv::Deserialize<W, rkyv::de::deserializers::SharedDeserializeMap>,
-{
-    let serialized =
-        PluginSerializedBytes::from_raw_ptr(raw_allocated_ptr, raw_allocated_ptr_len as usize);
-
-    serialized.deserialize()
-}
-
 /// A wrapper type for the structures to be passed into plugins
 /// serializes the contained value out-of-line so that newer
 /// versions can be viewed as the older version.

crates/swc_common/src/syntax_pos/hygiene.rs

@@ -196,14 +196,15 @@ impl Mark {
         }
 
         // Deserialize result, assign / return values as needed.
-        let context: MutableMarkContext = unsafe {
-            crate::plugin::serialized::deserialize_from_ptr(
+        let context: MutableMarkContext =
+            crate::plugin::serialized::PluginSerializedBytes::from_raw_ptr(
                 ptr,
                 len.try_into().expect("Should able to convert ptr length"),
             )
+            .deserialize()
             .expect("Should able to deserialize")
-            .into_inner()
-        };
+            .into_inner();
+
         self = Mark::from_u32(context.0);
 
         return context.2 != 0;
@@ -237,14 +238,14 @@ impl Mark {
             __mark_least_ancestor(a.0, b.0, ptr as _);
         }
 
-        let context: MutableMarkContext = unsafe {
-            crate::plugin::serialized::deserialize_from_ptr(
+        let context: MutableMarkContext =
+            crate::plugin::serialized::PluginSerializedBytes::from_raw_ptr(
                 ptr,
                 len.try_into().expect("Should able to convert ptr length"),
             )
+            .deserialize()
             .expect("Should able to deserialize")
-            .into_inner()
-        };
+            .into_inner();
         a = Mark::from_u32(context.0);
         b = Mark::from_u32(context.1);
 
@@ -435,14 +436,14 @@ impl SyntaxContext {
             __syntax_context_remove_mark_proxy(self.0, ptr as _);
         }
 
-        let context: MutableMarkContext = unsafe {
-            crate::plugin::serialized::deserialize_from_ptr(
+        let context: MutableMarkContext =
+            crate::plugin::serialized::PluginSerializedBytes::from_raw_ptr(
                 ptr,
                 len.try_into().expect("Should able to convert ptr length"),
             )
+            .deserialize()
             .expect("Should able to deserialize")
-            .into_inner()
-        };
+            .into_inner();
 
         *self = SyntaxContext(context.0);
 

crates/swc_css_ast/src/at_rule.rs

@@ -436,6 +436,8 @@ pub struct MediaFeatureBoolean {
     feature = "rkyv",
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 #[cfg_attr(
     feature = "rkyv",
     archive(bound(
@@ -764,6 +766,8 @@ pub struct SizeFeatureBoolean {
     feature = "rkyv",
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 #[cfg_attr(
     feature = "rkyv",
     archive(bound(

crates/swc_css_ast/src/selector.rs

@@ -131,6 +131,8 @@ pub struct Combinator {
         deserialize = "__D: rkyv::de::SharedDeserializeRegistry"
     ))
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 pub enum CombinatorValue {
     /// ` `
     Descendant,
@@ -264,6 +266,8 @@ pub struct AttributeSelector {
     feature = "rkyv",
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 #[cfg_attr(
     feature = "rkyv",
     archive(bound(

crates/swc_css_ast/src/token.rs

@@ -31,13 +31,17 @@ impl Take for TokenAndSpan {
     any(feature = "rkyv-impl"),
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv-impl", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv-impl", archive_attr(repr(C)))]
 pub struct UrlKeyValue(pub Atom, pub Atom);
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Is, EqIgnoreSpan)]
 #[cfg_attr(
     feature = "rkyv",
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 #[cfg_attr(
     feature = "rkyv",
     archive(bound(
@@ -59,6 +63,8 @@ pub enum NumberType {
     feature = "rkyv",
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(C)))]
 #[cfg_attr(feature = "serde-impl", derive(Serialize, Deserialize))]
 pub struct DimensionToken {
     pub value: f64,
@@ -76,6 +82,8 @@ pub struct DimensionToken {
     feature = "rkyv",
     derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 #[cfg_attr(
     feature = "rkyv",
     archive(bound(

crates/swc_css_ast/src/value.rs

@@ -127,6 +127,8 @@ impl EqIgnoreSpan for Str {
         deserialize = "__D: rkyv::de::SharedDeserializeRegistry"
     ))
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 pub enum DelimiterValue {
     /// `,`
     Comma,
@@ -406,6 +408,8 @@ pub struct Ratio {
         deserialize = "__D: rkyv::de::SharedDeserializeRegistry"
     ))
 )]
+#[cfg_attr(feature = "rkyv", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv", archive_attr(repr(u32)))]
 pub enum BinOp {
     /// `+`
     Add,
@@ -514,6 +518,8 @@ pub struct CalcOperator {
         deserialize = "__D: rkyv::de::SharedDeserializeRegistry"
     ))
 )]
+#[cfg_attr(feature = "rkyv-impl", archive(check_bytes))]
+#[cfg_attr(feature = "rkyv-impl", archive_attr(repr(u32)))]
 pub enum CalcOperatorType {
     /// `+`
     Add,

crates/swc_plugin_macro/src/lib.rs

@@ -130,7 +130,7 @@ fn handle_func(func: ItemFn, ast_type: Ident) -> TokenStream {
             unresolved_mark: u32, should_enable_comments_proxy: i32) -> u32 {
             // Reconstruct `Program` & config string from serialized program
             // Host (SWC) should allocate memory, copy bytes and pass ptr to plugin.
-            let program = unsafe { swc_core::common::plugin::serialized::deserialize_from_ptr(ast_ptr, ast_ptr_len) };
+            let program = swc_core::common::plugin::serialized::PluginSerializedBytes::from_raw_ptr(ast_ptr, ast_ptr_len.try_into().expect("Should able to convert ptr length")).deserialize();
             if program.is_err() {
                 let err = swc_core::common::plugin::serialized::PluginError::Deserialize("Failed to deserialize program received from host".to_string());
                 return construct_error_ptr(err);

crates/swc_plugin_proxy/src/memory_interop/read_returned_result_from_host.rs

@@ -1,6 +1,6 @@
 #[cfg_attr(not(target_arch = "wasm32"), allow(unused))]
 #[cfg(any(feature = "__plugin_rt", feature = "__plugin_mode"))]
-use swc_common::plugin::serialized::{deserialize_from_ptr, PluginSerializedBytes};
+use swc_common::plugin::serialized::PluginSerializedBytes;
 
 /// A struct to exchange allocated data between memory spaces.
 #[cfg_attr(
@@ -62,16 +62,17 @@ where
     }
 
     // Return reconstructted AllocatedBytesPtr to reveal ptr to the allocated bytes
-    Some(unsafe {
-        deserialize_from_ptr(
+    Some(
+        PluginSerializedBytes::from_raw_ptr(
             serialized_allocated_bytes_raw_ptr,
             serialized_allocated_bytes_raw_ptr_size
                 .try_into()
                 .expect("Should able to convert ptr length"),
         )
+        .deserialize()
         .expect("Should able to deserialize AllocatedBytesPtr")
-        .into_inner()
-    })
+        .into_inner(),
+    )
 }
 
 #[cfg(not(feature = "__rkyv"))]
@@ -95,10 +96,14 @@ where
 
     // Using AllocatedBytesPtr's value, reconstruct actual return value
     allocated_returned_value_ptr.map(|allocated_returned_value_ptr| unsafe {
-        deserialize_from_ptr(
+        PluginSerializedBytes::from_raw_ptr(
             allocated_returned_value_ptr.0 as _,
-            allocated_returned_value_ptr.1,
+            allocated_returned_value_ptr
+                .1
+                .try_into()
+                .expect("Should able to convert ptr length"),
         )
+        .deserialize()
         .expect("Returned value should be serializable")
         .into_inner()
     })