refactor(plugin): Switch plugin abi to flexible serialization (#11198)

**Description:**

This is a follow up to #11100,
which will result in plugin abi break.

It currently passes the plugin tests, but I still need to do some code
and configuration cleanup, and add a regression test.

<img width="2053" height="336" alt="plugin tests"
src="https://github.com/user-attachments/assets/868b2ae8-105c-44ad-8d18-641a2dd33c9f"
/>

**BREAKING CHANGE:**

Since we switched serialization schemes, this will result in breaking
changes on the plugin ABI and api.

---------

Co-authored-by: Donny/강동윤 <[email protected]>
Co-authored-by: Donny/강동윤 <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

Cargo.lock

@@ -1,6 +1,6 @@
 use syn::{spanned::Spanned, Data, DeriveInput};
 
-use super::{is_unknown, is_with, EnumType};
+use super::{is_ignore, is_unknown, is_with, EnumType};
 
 pub fn expand(DeriveInput { ident, data, .. }: DeriveInput) -> syn::ItemImpl {
     match data {
@@ -23,9 +23,11 @@ pub fn expand(DeriveInput { ident, data, .. }: DeriveInput) -> syn::ItemImpl {
                 .zip(names.iter())
                 .map(|(field, field_name)| -> syn::Stmt {
                     let ty = &field.ty;
-                    let value: syn::Expr = match is_with(&field.attrs) {
-                        Some(with_type) => syn::parse_quote!(<#with_type<#ty> as cbor4ii::core::dec::Decode<'_>>::decode(reader)?.0),
-                        None => syn::parse_quote!(<#ty as cbor4ii::core::dec::Decode<'_>>::decode(reader)?)
+                    let value: syn::Expr = match (is_with(&field.attrs), is_ignore(&field.attrs)) {
+                        (Some(with_type), false) => syn::parse_quote!(<#with_type<#ty> as cbor4ii::core::dec::Decode<'_>>::decode(reader)?.0),
+                        (None, false) => syn::parse_quote!(<#ty as cbor4ii::core::dec::Decode<'_>>::decode(reader)?),
+                        (None, true) => syn::parse_quote!(<#ty as Default>::default()),
+                        (Some(_), true) => panic!("Cannot use both #[encoding(with)] and #[encoding(ignore)] attributes on the same field")
                     };
 
                     syn::parse_quote!{
@@ -124,7 +126,7 @@ pub fn expand(DeriveInput { ident, data, .. }: DeriveInput) -> syn::ItemImpl {
                                 syn::parse_quote! {
                                     tag => {
                                         let tag: u32 = tag.try_into().map_err(|_| cbor4ii::core::error::DecodeError::CastOverflow {
-                                             name: &"tag",
+                                             name: &"unknown-tag",
                                         })?;
                                         let val = <#val_ty as cbor4ii::core::dec::Decode<'_>>::decode(reader)?;
                                         #ident::#name(tag, val)
@@ -236,10 +238,10 @@ pub fn expand(DeriveInput { ident, data, .. }: DeriveInput) -> syn::ItemImpl {
                 Some(arm) => arm,
                 None => {
                     syn::parse_quote! {
-                        _ => {
-                            let err = cbor4ii::core::error::DecodeError::Mismatch {
+                        tag => {
+                            let err = cbor4ii::core::error::DecodeError::Custom {
                                  name: &stringify!(#ident),
-                                 found: 0
+                                 num: tag as u32
                             };
                             return Err(err);
                         }

crates/ast_node/src/encoding/decode.rs

@@ -1,6 +1,6 @@
 use syn::{spanned::Spanned, Data, DeriveInput};
 
-use super::{is_unknown, is_with, EnumType};
+use super::{is_ignore, is_unknown, is_with, EnumType};
 
 pub fn expand(DeriveInput { ident, data, .. }: DeriveInput) -> syn::ItemImpl {
     match data {
@@ -9,6 +9,7 @@ pub fn expand(DeriveInput { ident, data, .. }: DeriveInput) -> syn::ItemImpl {
                 .fields
                 .iter()
                 .enumerate()
+                .filter(|(_, field)| !is_ignore(&field.attrs))
                 .map(|(idx, field)| -> syn::Stmt {
                     let fieldpath: syn::ExprField = match field.ident.as_ref() {
                         Some(name) => syn::parse_quote!(self.#name),

crates/ast_node/src/encoding/encode.rs

@@ -43,3 +43,17 @@ fn is_with(attrs: &[syn::Attribute]) -> Option<syn::Path> {
             with_type
         })
 }
+
+fn is_ignore(attrs: &[syn::Attribute]) -> bool {
+    attrs
+        .iter()
+        .filter(|attr| attr.path().is_ident("encoding"))
+        .any(|attr| {
+            let mut has_ignore = false;
+            let _ = attr.parse_nested_meta(|meta| {
+                has_ignore |= meta.path.is_ident("ignore");
+                Ok(())
+            });
+            has_ignore
+        })
+}

crates/ast_node/src/encoding/mod.rs

@@ -31,7 +31,7 @@ isolated-dts = ["swc_typescript"]
 node = ["napi", "napi-derive", "swc_compiler_base/node"]
 plugin = [
   "swc_plugin_runner/ecma",
-  "swc_plugin_runner/rkyv-impl",
+  "swc_plugin_runner/encoding-impl",
   "swc_plugin_proxy/plugin-rt",
   "tokio",
 ]

crates/swc/Cargo.toml

@@ -191,6 +191,11 @@ swc_core = {{ version = "{swc_core_version}", features = ["ecma_plugin_transform
 # Alias to build actual plugin binary for the specified target.
 build-wasip1 = "build --target wasm32-wasip1"
 build-wasm32 = "build --target wasm32-unknown-unknown"
+
+[target.'cfg(target_arch = "wasm32")']
+rustflags = [
+  "--cfg=swc_ast_unknown"
+]
 "#
             .as_bytes(),
         )

crates/swc_cli_impl/src/commands/plugin.rs

@@ -19,7 +19,7 @@ bench = false
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(swc_ast_unknown)'] }
 
 [features]
-__plugin         = []
+__plugin         = ["encoding-impl"]
 __plugin_mode    = []
 __plugin_rt      = []
 concurrent       = ["parking_lot"]

crates/swc_common/Cargo.toml

@@ -636,6 +636,7 @@ impl SingleThreadedComments {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(feature = "encoding-impl", derive(crate::Encode, crate::Decode))]
 pub struct Comment {
     pub kind: CommentKind,
     pub span: Span,
@@ -656,6 +657,7 @@ impl Spanned for Comment {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(u32))]
+#[cfg_attr(feature = "encoding-impl", derive(crate::Encode, crate::Decode))]
 pub enum CommentKind {
     Line = 0,
     Block = 1,

crates/swc_common/src/comments.rs

@@ -24,6 +24,10 @@ use crate::syntax_pos::{MultiSpan, Span};
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub struct Message(pub String, pub Style);
 
 #[must_use]
@@ -38,6 +42,10 @@ pub struct Message(pub String, pub Style);
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 /// Represents a diagnostic message with its level, message, unique identifier,
 /// span, children, and suggestions.
 pub struct Diagnostic {
@@ -47,6 +55,10 @@ pub struct Diagnostic {
     pub message: Vec<Message>,
     /// A unique identifier for the diagnostic, which can be used to look up
     /// more information
+    #[cfg_attr(
+        feature = "encoding-impl",
+        encoding(with = "cbor4ii::core::types::Maybe")
+    )]
     pub code: Option<DiagnosticId>,
     /// The span of the source code where the diagnostic is located
     pub span: MultiSpan,
@@ -67,6 +79,10 @@ pub struct Diagnostic {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(u32))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub enum DiagnosticId {
     Error(String),
     Lint(String),
@@ -84,10 +100,18 @@ pub enum DiagnosticId {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub struct SubDiagnostic {
     pub level: Level,
     pub message: Vec<Message>,
     pub span: MultiSpan,
+    #[cfg_attr(
+        feature = "encoding-impl",
+        encoding(with = "cbor4ii::core::types::Maybe")
+    )]
     pub render_span: Option<MultiSpan>,
 }
 

crates/swc_common/src/errors/diagnostic.rs

@@ -54,6 +54,10 @@ mod styled_buffer;
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(u32))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub enum Applicability {
     MachineApplicable,
     HasPlaceholders,
@@ -72,6 +76,10 @@ pub enum Applicability {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub struct CodeSuggestion {
     /// Each substitute can have multiple variants due to multiple
     /// applicable suggestions
@@ -125,6 +133,10 @@ pub struct CodeSuggestion {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub struct Substitution {
     pub parts: Vec<SubstitutionPart>,
 }
@@ -140,6 +152,10 @@ pub struct Substitution {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(C))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub struct SubstitutionPart {
     pub span: Span,
     pub snippet: String,
@@ -901,6 +917,10 @@ impl Handler {
 )]
 #[cfg_attr(feature = "rkyv-impl", derive(bytecheck::CheckBytes))]
 #[cfg_attr(feature = "rkyv-impl", repr(u32))]
+#[cfg_attr(
+    feature = "encoding-impl",
+    derive(::ast_node::Encode, ::ast_node::Decode)
+)]
 pub enum Level {
     Bug,
     Fatal,