fix:feat: support for Jackson 2.19.0

manusa · manusa · commit 2f090aae3036 · 2025-06-09T14:13:06.000+02:00
Signed-off-by: Marc Nuri &lt;marc@marcnuri.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 ## CHANGELOG
 
+### 6.14.0 (TBD)
+* Fix #7107: Jackson 2.19.0+ support
+
+#### _**Note**_: Breaking changes
+* Fix #7107: This release is not backwards-compatible with previous versions of Jackson, you'll need to use Jackson 2.19.0 in your project for a correct behavior of the Kubernetes Client.
+
 ### 6.13.5 (2025-01-18)
 
 #### Bugs
diff --git a/crd-generator/api-v2/src/main/java/io/fabric8/crdv2/generator/AbstractJsonSchema.java b/crd-generator/api-v2/src/main/java/io/fabric8/crdv2/generator/AbstractJsonSchema.java
@@ -310,8 +310,11 @@ private T resolveObject(LinkedHashMap<String, String> visited, InternalSchemaSwa
         visited = new LinkedHashMap<>();
       }
 
-      BeanProperty beanProperty = gos.beanProperties.get(property.getKey());
+      final BeanProperty beanProperty = gos.beanProperties.get(property.getKey());
       Utils.checkNotNull(beanProperty, "CRD generation works only with bean properties");
+      if (beanProperty.getAnnotation(JsonIgnore.class) != null) {
+        continue;
+      }
 
       JsonSchema propertySchema = property.getValue();
       PropertyMetadata propertyMetadata = new PropertyMetadata(propertySchema, beanProperty);
diff --git a/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/example/complex/k8s/ObjectMeta.java b/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/example/complex/k8s/ObjectMeta.java
@@ -221,6 +221,7 @@ public void setUid(String uid) {
   }
 
   @JsonAnyGetter
+  @JsonIgnore
   public Map<String, Object> getAdditionalProperties() {
     return this.additionalProperties;
   }
diff --git a/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/example/complex/k8s/ServiceSpec.java b/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/example/complex/k8s/ServiceSpec.java
@@ -276,6 +276,7 @@ public void setType(String type) {
   }
 
   @JsonAnyGetter
+  @JsonIgnore
   public Map<String, Object> getAdditionalProperties() {
     return this.additionalProperties;
   }
diff --git a/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/example/complex/k8s/StatefulSetSpec.java b/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/example/complex/k8s/StatefulSetSpec.java
@@ -115,6 +115,7 @@ public void setServiceName(String serviceName) {
   }
 
   @JsonAnyGetter
+  @JsonIgnore
   public Map<String, Object> getAdditionalProperties() {
     return this.additionalProperties;
   }
diff --git a/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/generator/v1/JsonSchemaTest.java b/crd-generator/api-v2/src/test/java/io/fabric8/crdv2/generator/v1/JsonSchemaTest.java
@@ -325,6 +325,7 @@ public static class PreserveUnknown {
     private Map<String, Object> values = new HashMap<>();
 
     @JsonAnyGetter
+    @JsonIgnore
     public Map<String, Object> getAdditionalProperties() {
       return this.values;
     }
diff --git a/crd-generator/test/src/test/java/io/fabric8/crd/generator/approvaltests/complex/k8s/ObjectMeta.java b/crd-generator/test/src/test/java/io/fabric8/crd/generator/approvaltests/complex/k8s/ObjectMeta.java
@@ -221,6 +221,7 @@ public void setUid(String uid) {
   }
 
   @JsonAnyGetter
+  @JsonIgnore
   public Map<String, Object> getAdditionalProperties() {
     return this.additionalProperties;
   }
diff --git a/crd-generator/test/src/test/java/io/fabric8/crd/generator/approvaltests/complex/k8s/ServiceSpec.java b/crd-generator/test/src/test/java/io/fabric8/crd/generator/approvaltests/complex/k8s/ServiceSpec.java
@@ -275,6 +275,7 @@ public void setType(String type) {
   }
 
   @JsonAnyGetter
+  @JsonIgnore
   public Map<String, Object> getAdditionalProperties() {
     return this.additionalProperties;
   }
diff --git a/crd-generator/test/src/test/java/io/fabric8/crd/generator/approvaltests/complex/k8s/StatefulSetSpec.java b/crd-generator/test/src/test/java/io/fabric8/crd/generator/approvaltests/complex/k8s/StatefulSetSpec.java
@@ -115,6 +115,7 @@ public void setServiceName(String serviceName) {
   }
 
   @JsonAnyGetter
+  @JsonIgnore
   public Map<String, Object> getAdditionalProperties() {
     return this.additionalProperties;
   }
diff --git a/kubernetes-model-generator/kubernetes-model-common/src/main/java/io/fabric8/kubernetes/model/jackson/SettableBeanPropertyDelegate.java b/kubernetes-model-generator/kubernetes-model-common/src/main/java/io/fabric8/kubernetes/model/jackson/SettableBeanPropertyDelegate.java
@@ -27,6 +27,7 @@
 import com.fasterxml.jackson.databind.exc.MismatchedInputException;
 import com.fasterxml.jackson.databind.introspect.ObjectIdInfo;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor;
+import com.fasterxml.jackson.databind.util.NameTransformer;
 
 import java.io.IOException;
 import java.lang.annotation.Annotation;
@@ -147,6 +148,14 @@ public SettableBeanProperty withSimpleName(String simpleName) {
     return _with(delegate.withSimpleName(simpleName));
   }
 
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public SettableBeanProperty unwrapped(NameTransformer unwrapper) {
+    return _with(delegate.unwrapped(unwrapper));
+  }
+
   /**
    * {@inheritDoc}
    */
diff --git a/kubernetes-model-generator/kubernetes-model-common/src/main/java/io/fabric8/kubernetes/model/jackson/UnmatchedFieldTypeModule.java b/kubernetes-model-generator/kubernetes-model-common/src/main/java/io/fabric8/kubernetes/model/jackson/UnmatchedFieldTypeModule.java
@@ -20,10 +20,14 @@
 import com.fasterxml.jackson.databind.SerializationConfig;
 import com.fasterxml.jackson.databind.deser.BeanDeserializerBuilder;
 import com.fasterxml.jackson.databind.deser.BeanDeserializerModifier;
+import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
 import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;
 import com.fasterxml.jackson.databind.ser.BeanSerializerBuilder;
 import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
 
+import java.lang.reflect.Member;
+import java.util.List;
 import java.util.stream.Collectors;
 
 /**
@@ -61,13 +65,40 @@ public BeanDeserializerBuilder updateBuilder(DeserializationConfig config, BeanD
       }
     });
     setSerializerModifier(new BeanSerializerModifier() {
+      /**
+       * Customizes property writers used during serialization.
+       *
+       * This method wraps standard property writers in a delegate that can suppress serialization
+       * of fields that may be overridden by values in the map returned by {@code @JsonAnyGetter}.
+       *
+       * The property corresponding to the {@code @JsonAnyGetter} method itself is left unmodified
+       * to avoid interfering with Jackson’s internal handling via {@link com.fasterxml.jackson.databind.ser.AnyGetterWriter}.
+       *
+       * This mechanism ensures that if a field is both explicitly declared and also present in the
+       * any-getter map, only the value from the any-getter is serialized, avoiding duplication or conflicts.
+       */
       @Override
       public BeanSerializerBuilder updateBuilder(SerializationConfig config, BeanDescription beanDesc,
           BeanSerializerBuilder builder) {
-        builder.setProperties(builder.getProperties().stream()
-            .map(p -> new BeanPropertyWriterDelegate(p, builder.getBeanDescription().findAnyGetter(),
-                UnmatchedFieldTypeModule.this::isLogWarnings))
-            .collect(Collectors.toList()));
+        AnnotatedMember anyGetter = beanDesc.findAnyGetter();
+        Member anyGetterMember = (anyGetter != null) ? anyGetter.getMember() : null;
+
+        // Wrap each property writer unless it's the any-getter (handled by Jackson separately)
+        List<BeanPropertyWriter> customWriters = builder.getProperties().stream()
+            .map(writer -> {
+              if (isAnyGetterWriter(writer, anyGetterMember)) {
+                // Skipping wrapping for any-getter to avoid interfering with Jackson's internal handling
+                return writer;
+              }
+              // Wrap normal field writers with delegate to handle overrides and logging
+              return new BeanPropertyWriterDelegate(
+                  writer,
+                  anyGetter,
+                  UnmatchedFieldTypeModule.this::isLogWarnings);
+            })
+            .collect(Collectors.toList());
+
+        builder.setProperties(customWriters);
         return builder;
       }
     });
@@ -115,4 +146,22 @@ public static void removeInTemplate() {
     IN_TEMPLATE.remove();
   }
 
+  /**
+   * Checks whether the given {@link BeanPropertyWriter} corresponds to the method annotated with {@code @JsonAnyGetter}.
+   *
+   * This is used to identify and exclude the any-getter property from custom wrapping,
+   * since Jackson handles it separately via {@link com.fasterxml.jackson.databind.ser.AnyGetterWriter}.
+   *
+   * @param writer the property writer to examine
+   * @param anyGetterMember the reflective member (method or field) marked with {@code @JsonAnyGetter}, if available
+   * @return {@code true} if the writer represents the any-getter property; {@code false} otherwise
+   */
+  private static boolean isAnyGetterWriter(BeanPropertyWriter writer, Member anyGetterMember) {
+    if (writer == null || anyGetterMember == null) {
+      return false;
+    }
+    AnnotatedMember annotated = writer.getMember();
+    Member member = (annotated != null) ? annotated.getMember() : null;
+    return member != null && member.equals(anyGetterMember);
+  }
 }
diff --git a/pom.xml b/pom.xml
@@ -95,7 +95,7 @@
     <okhttp.bundle.version>3.12.1_1</okhttp.bundle.version>
     <okio.version>1.17.6</okio.version>
     <okio.bundle.version>1.15.0_1</okio.bundle.version>
-    <jackson.version>2.17.1</jackson.version>
+    <jackson.version>2.19.0</jackson.version>
     <jetty.version>11.0.21</jetty.version>
     <maven-core.version>3.9.7</maven-core.version>
     <maven-plugin-annotations.version>3.13.0</maven-plugin-annotations.version>
@@ -127,8 +127,8 @@
     <slf4j.version>2.0.13</slf4j.version>
     <log4j.version>2.23.1</log4j.version>
     <lombok.version>1.18.32</lombok.version>
-    <snakeyaml.version>2.7</snakeyaml.version>
-    <snakeyaml.bundle.version>2.2</snakeyaml.bundle.version> <!-- Transitive Jackson -->
+    <snakeyaml.version>2.9</snakeyaml.version>
+    <snakeyaml.bundle.version>2.4</snakeyaml.bundle.version> <!-- Transitive Jackson -->
     <bouncycastle.version>1.78.1</bouncycastle.version>
     <bc-fips.version>1.0.2.5</bc-fips.version>
     <bcpkix-fips.version>1.0.7</bcpkix-fips.version>

Original file line number	Diff line number	Diff line change
`@@ -221,6 +221,7 @@ public void setUid(String uid) {`
`221`	`221`	`}`
`222`	`222`
`223`	`223`	`@JsonAnyGetter`
	`224`	`+ @JsonIgnore`
`224`	`225`	`public Map<String, Object> getAdditionalProperties() {`
`225`	`226`	`return this.additionalProperties;`
`226`	`227`	`}`
Original file line number	Diff line number	Diff line change
`@@ -276,6 +276,7 @@ public void setType(String type) {`
`276`	`276`	`}`
`277`	`277`
`278`	`278`	`@JsonAnyGetter`
	`279`	`+ @JsonIgnore`
`279`	`280`	`public Map<String, Object> getAdditionalProperties() {`
`280`	`281`	`return this.additionalProperties;`
`281`	`282`	`}`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@ public void setServiceName(String serviceName) {`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`@JsonAnyGetter`
	`118`	`+ @JsonIgnore`
`118`	`119`	`public Map<String, Object> getAdditionalProperties() {`
`119`	`120`	`return this.additionalProperties;`
`120`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -325,6 +325,7 @@ public static class PreserveUnknown {`
`325`	`325`	`private Map<String, Object> values = new HashMap<>();`
`326`	`326`
`327`	`327`	`@JsonAnyGetter`
	`328`	`+ @JsonIgnore`
`328`	`329`	`public Map<String, Object> getAdditionalProperties() {`
`329`	`330`	`return this.values;`
`330`	`331`	`}`
Original file line number	Diff line number	Diff line change
`@@ -275,6 +275,7 @@ public void setType(String type) {`
`275`	`275`	`}`
`276`	`276`
`277`	`277`	`@JsonAnyGetter`
	`278`	`+ @JsonIgnore`
`278`	`279`	`public Map<String, Object> getAdditionalProperties() {`
`279`	`280`	`return this.additionalProperties;`
`280`	`281`	`}`