diff --git a/crates/stackable-versioned-macros/src/codegen/container/struct/conversion.rs b/crates/stackable-versioned-macros/src/codegen/container/struct/conversion.rs index 4ff9cdc79..a87d8fbcd 100644 --- a/crates/stackable-versioned-macros/src/codegen/container/struct/conversion.rs +++ b/crates/stackable-versioned-macros/src/codegen/container/struct/conversion.rs @@ -568,6 +568,11 @@ impl Struct { let automatically_derived = mod_gen_ctx.automatically_derived_attr(); + let changed_values_is_empty = format!( + "{versioned_path}::ChangedValues::is_empty", + versioned_path = path_to_string(versioned_path) + ); + // TODO (@Techassi): Validate that users don't specify the status we generate let status = spec_gen_ctx .kubernetes_arguments @@ -592,6 +597,10 @@ impl Struct { )] #[serde(rename_all = "camelCase")] pub struct #status_ident { + // Objects created directly in the storage version never pass through the conversion + // webhook, so their status doesn't contain any changed values. The field must therefore + // not be required, otherwise operators fail to patch the status of such objects. + #[serde(default, skip_serializing_if = #changed_values_is_empty)] pub changed_values: #versioned_path::ChangedValues, #status diff --git a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking.rs.snap b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking.rs.snap index 184c23e94..9bfcd2b7e 100644 --- a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking.rs.snap +++ b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking.rs.snap @@ -518,6 +518,10 @@ fn FooSpec_roundtrip_up_down() { )] #[serde(rename_all = "camelCase")] pub struct FooStatusWithChangedValues { + #[serde( + default, + skip_serializing_if = "::stackable_versioned::ChangedValues::is_empty" + )] pub changed_values: ::stackable_versioned::ChangedValues, #[serde(flatten)] pub status: FooStatus, diff --git a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_enum.rs.snap b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_enum.rs.snap index 7f3ee6976..01c4517ce 100644 --- a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_enum.rs.snap +++ b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_enum.rs.snap @@ -575,6 +575,10 @@ fn FooSpec_roundtrip_up_down() { )] #[serde(rename_all = "camelCase")] pub struct FooStatusWithChangedValues { + #[serde( + default, + skip_serializing_if = "::stackable_versioned::ChangedValues::is_empty" + )] pub changed_values: ::stackable_versioned::ChangedValues, } #[automatically_derived] diff --git a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_generics.rs.snap b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_generics.rs.snap index b1b1a3fe2..b6e5dea90 100644 --- a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_generics.rs.snap +++ b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_generics.rs.snap @@ -653,6 +653,10 @@ fn FooSpec_roundtrip_up_down() { )] #[serde(rename_all = "camelCase")] pub struct FooStatusWithChangedValues { + #[serde( + default, + skip_serializing_if = "::stackable_versioned::ChangedValues::is_empty" + )] pub changed_values: ::stackable_versioned::ChangedValues, #[serde(flatten)] pub status: FooStatus, diff --git a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_removed.rs.snap b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_removed.rs.snap index 56ab42611..c10d687f3 100644 --- a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_removed.rs.snap +++ b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_removed.rs.snap @@ -616,6 +616,10 @@ fn FooSpec_roundtrip_up_down() { )] #[serde(rename_all = "camelCase")] pub struct FooStatusWithChangedValues { + #[serde( + default, + skip_serializing_if = "::stackable_versioned::ChangedValues::is_empty" + )] pub changed_values: ::stackable_versioned::ChangedValues, } #[automatically_derived] diff --git a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_type_change.rs.snap b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_type_change.rs.snap index be4d24f63..562022e31 100644 --- a/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_type_change.rs.snap +++ b/crates/stackable-versioned-macros/tests/snapshots/stackable_versioned_macros__snapshots__pass@conversion_tracking_type_change.rs.snap @@ -575,6 +575,10 @@ fn FooSpec_roundtrip_up_down() { )] #[serde(rename_all = "camelCase")] pub struct FooStatusWithChangedValues { + #[serde( + default, + skip_serializing_if = "::stackable_versioned::ChangedValues::is_empty" + )] pub changed_values: ::stackable_versioned::ChangedValues, } #[automatically_derived] diff --git a/crates/stackable-versioned/CHANGELOG.md b/crates/stackable-versioned/CHANGELOG.md index 5b57df47f..70f620f03 100644 --- a/crates/stackable-versioned/CHANGELOG.md +++ b/crates/stackable-versioned/CHANGELOG.md @@ -10,7 +10,16 @@ All notable changes to this project will be documented in this file. Removed fields are not tracked when `experimental_conversion_tracking` is enabled yet. It doesn't support enum variants either for now ([#1324]). +### Fixed + +- The `changedValues` field of the generated tracking status is no longer required and isn't + serialized when empty. Previously, patching the status of objects created directly in the storage + version failed, as they never pass through the conversion webhook ([#1325]). + We also reduced "clutter" in the CR's status by only serializing tracking information into the status + in case something was actually tracked. + [#1324]: https://github.com/stackabletech/operator-rs/pull/1324 +[#1325]: https://github.com/stackabletech/operator-rs/pull/1325 ## [0.14.0] - 2026-11-03 diff --git a/crates/stackable-versioned/src/lib.rs b/crates/stackable-versioned/src/lib.rs index af25a47ec..128061328 100644 --- a/crates/stackable-versioned/src/lib.rs +++ b/crates/stackable-versioned/src/lib.rs @@ -90,21 +90,28 @@ pub trait TrackingStatus { // NOTE (@Techassi): This struct represents a rough first draft of how tracking values across // CRD versions can be achieved. It might change down the line. -// FIXME (@Techassi): Ideally we don't serialize empty maps. Further, we shouldn't serialize the -// changedValues field in the status, if there it is empty. This currently "pollutes" the status -// with empty JSON objects. +// /// Contains changed values during upgrades and downgrades of CRDs. #[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize, schemars::JsonSchema)] pub struct ChangedValues { /// List of values needed when downgrading to a particular version. + #[serde(default, skip_serializing_if = "BTreeMap::is_empty")] pub downgrades: BTreeMap>, /// List of values needed when upgrading to a particular version. + #[serde(default, skip_serializing_if = "BTreeMap::is_empty")] pub upgrades: BTreeMap>, // TODO (@Techassi): Add a version indicator here if we ever decide to change the tracking // mechanism. } +impl ChangedValues { + /// Returns `true` if neither downgrades nor upgrades contain tracked, changed values. + pub fn is_empty(&self) -> bool { + self.downgrades.is_empty() && self.upgrades.is_empty() + } +} + /// Contains a changed value for a single field of the CRD. #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)] #[serde(rename_all = "camelCase")] diff --git a/crates/stackable-versioned/tests/inputs/roundtrip/person_v3.json b/crates/stackable-versioned/tests/inputs/roundtrip/person_v3.json index acdc2a7ec..3773f2ca1 100644 --- a/crates/stackable-versioned/tests/inputs/roundtrip/person_v3.json +++ b/crates/stackable-versioned/tests/inputs/roundtrip/person_v3.json @@ -26,11 +26,7 @@ } }, "status": { - "alive": true, - "changedValues": { - "downgrades": {}, - "upgrades": {} - } + "alive": true } } ] diff --git a/crates/stackable-versioned/tests/roundtrip.rs b/crates/stackable-versioned/tests/roundtrip.rs index d27aa96c4..5ac2a9c20 100644 --- a/crates/stackable-versioned/tests/roundtrip.rs +++ b/crates/stackable-versioned/tests/roundtrip.rs @@ -9,10 +9,6 @@ mod person; fn person_v3_v1alpha1_v3() { glob!("./inputs/roundtrip", "*.json", |path| { // Convert from v3 to v1alpha1 - // NOTE (@Techassi): It should be noted that the input conversion review - // contains a status with empty changedValues to be able to assert_eq - // the objects at the end. As mentioned in the actual macro code, we - // should avoid "polluting" the status if it is empty. let (request_v1alpha1, response_v1alpha1) = person::convert_via_file(path); let response = response_v1alpha1 .response diff --git a/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v1alpha1.json.snap b/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v1alpha1.json.snap index 3c1fded15..7cddfd9c5 100644 --- a/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v1alpha1.json.snap +++ b/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v1alpha1.json.snap @@ -45,7 +45,6 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "status": { "alive": true, "changedValues": { - "downgrades": {}, "upgrades": { "v1alpha2": [ { @@ -82,7 +81,6 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "status": { "alive": true, "changedValues": { - "downgrades": {}, "upgrades": { "v1alpha2": [ { @@ -125,7 +123,6 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "status": { "alive": true, "changedValues": { - "downgrades": {}, "upgrades": { "v1alpha2": [ { @@ -174,7 +171,6 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "status": { "alive": true, "changedValues": { - "downgrades": {}, "upgrades": { "v1alpha2": [ { diff --git a/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v3.json.snap b/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v3.json.snap index 5c1e6459c..6ec3ae402 100644 --- a/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v3.json.snap +++ b/crates/stackable-versioned/tests/snapshots/conversions__pass@persons_to_v3.json.snap @@ -34,11 +34,7 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "username": "jdoe" }, "status": { - "alive": true, - "changedValues": { - "downgrades": {}, - "upgrades": {} - } + "alive": true } }, { @@ -62,11 +58,7 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "username": "jdoe" }, "status": { - "alive": true, - "changedValues": { - "downgrades": {}, - "upgrades": {} - } + "alive": true } }, { @@ -90,11 +82,7 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "username": "jdoe" }, "status": { - "alive": true, - "changedValues": { - "downgrades": {}, - "upgrades": {} - } + "alive": true } }, { @@ -118,11 +106,7 @@ input_file: crates/stackable-versioned/tests/inputs/conversions/pass/persons_to_ "username": "jdoe" }, "status": { - "alive": true, - "changedValues": { - "downgrades": {}, - "upgrades": {} - } + "alive": true } }, { diff --git a/crates/stackable-versioned/tests/status.rs b/crates/stackable-versioned/tests/status.rs new file mode 100644 index 000000000..5e3e9ad89 --- /dev/null +++ b/crates/stackable-versioned/tests/status.rs @@ -0,0 +1,41 @@ +use serde_json::json; + +use crate::person::{Person, PersonStatusWithChangedValues, PersonVersion}; + +mod person; + +// Objects created directly in the storage version never pass through the conversion webhook, so +// their status doesn't contain any changed values. Operators must still be able to patch and read +// the status of such objects. +#[test] +fn status_does_not_require_changed_values() { + let merged_crd = Person::merged_crd(PersonVersion::V2).expect("the CRDs must be mergeable"); + + for version in merged_crd.spec.versions { + let status_schema = version + .schema + .and_then(|schema| schema.open_api_v3_schema) + .and_then(|schema| schema.properties) + .and_then(|mut properties| properties.remove("status")) + .expect("the CRD must contain a status schema"); + + assert!( + !status_schema + .required + .unwrap_or_default() + .contains(&"changedValues".to_owned()), + "changedValues must not be required in the status of version {version}", + version = version.name + ); + } + + let status: PersonStatusWithChangedValues = serde_json::from_value(json!({ "alive": false })) + .expect("the status must deserialize without changedValues"); + assert!(status.changed_values.is_empty()); + + // Empty changed values are not serialized + assert_eq!( + serde_json::to_value(&status).expect("the status must serialize"), + json!({ "alive": false }) + ); +}