chore(stackable-versioned): Error if nested is used without experimental flag

Author: Techassi

crates/stackable-versioned-macros/src/attrs/item/field.rs

@@ -1,4 +1,4 @@
-use darling::{FromField, Result, util::Flag};
+use darling::{Error, FromField, Result, util::Flag};
 use syn::{Attribute, Ident};
 
 use crate::{attrs::item::CommonItemAttributes, codegen::VersionDefinition, utils::FieldIdent};
@@ -64,4 +64,15 @@ impl FieldAttributes {
     pub fn validate_versions(&self, versions: &[VersionDefinition]) -> Result<()> {
         self.common.validate_versions(versions)
     }
+
+    pub fn validate_nested_flag(&self, experimental_conversion_tracking: bool) -> Result<()> {
+        if self.nested.is_present() && !experimental_conversion_tracking {
+            return Err(
+                Error::custom("the `nested` argument can only be used if the module-level `experimental_conversion_tracking` flag is set")
+                    .with_span(&self.nested.span())
+            );
+        }
+
+        Ok(())
+    }
 }

crates/stackable-versioned-macros/src/codegen/container/struct/conversion.rs

@@ -144,13 +144,7 @@ impl Struct {
             self.fields
                 .iter()
                 .filter_map(|f| {
-                    f.generate_for_from_impl(
-                        direction,
-                        version,
-                        next_version,
-                        from_struct_ident,
-                        mod_gen_ctx,
-                    )
+                    f.generate_for_from_impl(direction, version, next_version, from_struct_ident)
                 })
                 .collect()
         };

crates/stackable-versioned-macros/src/codegen/container/struct/mod.rs

@@ -21,12 +21,17 @@ mod conversion;
 mod merge;
 
 impl Container {
-    pub fn new_struct(item_struct: ItemStruct, versions: &[VersionDefinition]) -> Result<Self> {
+    pub fn new_struct(
+        item_struct: ItemStruct,
+        versions: &[VersionDefinition],
+        experimental_conversion_tracking: bool,
+    ) -> Result<Self> {
         let attributes = ContainerAttributes::from_attributes(&item_struct.attrs)?;
 
         let mut versioned_fields = Vec::new();
         for field in item_struct.fields {
-            let mut versioned_field = VersionedField::new(field, versions)?;
+            let mut versioned_field =
+                VersionedField::new(field, versions, experimental_conversion_tracking)?;
             versioned_field.insert_container_versions(versions);
             versioned_fields.push(versioned_field);
         }
@@ -469,13 +474,7 @@ impl Struct {
             self.fields
                 .iter()
                 .filter_map(|f| {
-                    f.generate_for_from_impl(
-                        direction,
-                        version,
-                        next_version,
-                        from_struct_ident,
-                        mod_gen_ctx,
-                    )
+                    f.generate_for_from_impl(direction, version, next_version, from_struct_ident)
                 })
                 .collect()
         };

crates/stackable-versioned-macros/src/codegen/item/field.rs

@@ -26,9 +26,14 @@ pub struct VersionedField {
 }
 
 impl VersionedField {
-    pub fn new(field: Field, versions: &[VersionDefinition]) -> Result<Self> {
+    pub fn new(
+        field: Field,
+        versions: &[VersionDefinition],
+        experimental_conversion_tracking: bool,
+    ) -> Result<Self> {
         let field_attributes = FieldAttributes::from_field(&field)?;
         field_attributes.validate_versions(versions)?;
+        field_attributes.validate_nested_flag(experimental_conversion_tracking)?;
 
         let ident = field
             .ident
@@ -151,13 +156,7 @@ impl VersionedField {
         version: &VersionDefinition,
         next_version: &VersionDefinition,
         from_struct_ident: &IdentString,
-        mod_gen_ctx: ModuleGenerationContext<'_>,
     ) -> Option<TokenStream> {
-        let experimental_conversion_tracking = mod_gen_ctx
-            .kubernetes_options
-            .experimental_conversion_tracking
-            .is_present();
-
         match &self.changes {
             Some(changes) => {
                 let next_change = changes.get_expect(&next_version.inner);
@@ -196,7 +195,7 @@ impl VersionedField {
                             }),
                             // Default .into() call using From impls.
                             None => {
-                                if self.nested && experimental_conversion_tracking {
+                                if self.nested {
                                     let json_path_ident = format_ident!(
                                         "__sv_{ident}_path",
                                         ident = to_ident.as_ident()
@@ -217,7 +216,7 @@ impl VersionedField {
                                 #from_ident: #downgrade_fn(#from_struct_ident.#to_ident),
                             }),
                             None => {
-                                if self.nested && experimental_conversion_tracking {
+                                if self.nested {
                                     let json_path_ident = format_ident!(
                                         "__sv_{ident}_path",
                                         ident = from_ident.as_ident()
@@ -243,7 +242,7 @@ impl VersionedField {
                         // in some edge cases.
                         match direction {
                             Direction::Upgrade => {
-                                if self.nested && experimental_conversion_tracking {
+                                if self.nested {
                                     let json_path_ident = format_ident!(
                                         "__sv_{ident}_path",
                                         ident = next_field_ident.as_ident()
@@ -268,7 +267,7 @@ impl VersionedField {
             None => {
                 let field_ident = &*self.ident;
 
-                if self.nested && experimental_conversion_tracking {
+                if self.nested {
                     let json_path_ident =
                         format_ident!("__sv_{ident}_path", ident = field_ident.as_ident());
 

crates/stackable-versioned-macros/src/codegen/module.rs

@@ -60,9 +60,17 @@ impl Module {
                     };
                 }
                 Item::Struct(item_struct) => {
-                    if let Some(container) =
-                        errors.handle(Container::new_struct(item_struct, &versions))
-                    {
+                    let experimental_conversion_tracking = module_attributes
+                        .options
+                        .kubernetes
+                        .experimental_conversion_tracking
+                        .is_present();
+
+                    if let Some(container) = errors.handle(Container::new_struct(
+                        item_struct,
+                        &versions,
+                        experimental_conversion_tracking,
+                    )) {
                         containers.push(container);
                     }
                 }