refactor!: use Jackson 3 for chart config serialization (#8024)

* refactor Charts to use Jackson 3

* update spreadsheet chart test

* cleanup tests

Author: sissbruecker

vaadin-charts-flow-parent/vaadin-charts-flow-integration-tests/src/main/java/com/vaadin/flow/component/charts/examples/AbstractChartExample.java

@@ -17,16 +17,17 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreType;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.PropertyAccessor;
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
 import com.vaadin.flow.component.Component;
 import com.vaadin.flow.component.ComponentEvent;
 import com.vaadin.flow.component.UI;
 import com.vaadin.flow.component.charts.Chart;
 import com.vaadin.flow.component.html.Div;
 import com.vaadin.flow.server.Command;
 
+import tools.jackson.core.JacksonException;
+import tools.jackson.databind.SerializationFeature;
+import tools.jackson.databind.json.JsonMapper;
+
 /**
  * Abstract class for all chart examples.
  */
@@ -42,19 +43,22 @@ protected void showNotification(String message) {
     }
 
     protected String createEventString(ComponentEvent<Chart> event) {
-        ObjectMapper mapper = new ObjectMapper()
-                .setSerializationInclusion(JsonInclude.Include.NON_NULL)
+        JsonMapper mapper = JsonMapper.builder()
+                .changeDefaultPropertyInclusion(handler -> handler
+                        .withValueInclusion(JsonInclude.Include.NON_NULL))
                 .disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
                 .enable(SerializationFeature.INDENT_OUTPUT)
-                .setVisibility(PropertyAccessor.ALL,
-                        JsonAutoDetect.Visibility.NONE)
-                .setVisibility(PropertyAccessor.FIELD,
-                        JsonAutoDetect.Visibility.ANY)
-                .addMixIn(Command.class, JacksonMixinForIgnoreCommand.class);
+                .changeDefaultVisibility(handler -> handler
+                        .withVisibility(PropertyAccessor.ALL,
+                                JsonAutoDetect.Visibility.NONE)
+                        .withVisibility(PropertyAccessor.FIELD,
+                                JsonAutoDetect.Visibility.ANY))
+                .addMixIn(Command.class, JacksonMixinForIgnoreCommand.class)
+                .build();
 
         try {
             return mapper.writeValueAsString(event);
-        } catch (JsonProcessingException e) {
+        } catch (JacksonException e) {
             e.printStackTrace(); // NOSONAR
             return "";
         }

vaadin-charts-flow-parent/vaadin-charts-flow-integration-tests/src/main/java/com/vaadin/flow/component/charts/examples/timeline/util/StockPrices.java

@@ -8,13 +8,12 @@
  */
 package com.vaadin.flow.component.charts.examples.timeline.util;
 
-import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
+import tools.jackson.databind.ObjectMapper;
 
 public class StockPrices {
 
@@ -180,16 +179,11 @@ private static List<OhlcData> readOhlcData(String filename) {
     }
 
     private static JsonData readJsonDataFrom(String filename) {
-        try {
-            ObjectMapper mapper = new ObjectMapper();
-            return mapper.readValue(
-                    new InputStreamReader(
-                            StockPrices.class.getResourceAsStream(filename)),
-                    JsonData.class);
-
-        } catch (IOException e) {
-            throw new RuntimeException("Cannot read data from " + filename, e);
-        }
+        ObjectMapper mapper = new ObjectMapper();
+        return mapper.readValue(
+                new InputStreamReader(
+                        StockPrices.class.getResourceAsStream(filename)),
+                JsonData.class);
     }
 
 }

vaadin-charts-flow-parent/vaadin-charts-flow-svg-generator/src/test/java/com/vaadin/flow/component/charts/export/StockPrices.java

@@ -17,7 +17,7 @@
 import java.util.Collections;
 import java.util.List;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
+import tools.jackson.databind.ObjectMapper;
 
 public class StockPrices {
 

vaadin-charts-flow-parent/vaadin-charts-flow/pom.xml

@@ -12,6 +12,7 @@
     <description>Vaadin Charts</description>
     <properties>
         <osgi.bundle.license>https://vaadin.com/commercial-license-and-service-terms</osgi.bundle.license>
+        <jackson.version>3.0.0-rc9</jackson.version>
     </properties>
     <dependencies>
         <dependency>
@@ -43,6 +44,11 @@
             <artifactId>slf4j-simple</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>tools.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/Labels.java

@@ -8,10 +8,11 @@
  */
 package com.vaadin.flow.component.charts.model;
 
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.vaadin.flow.component.charts.model.serializers.LabelsRotationSerializer;
 import com.vaadin.flow.component.charts.model.style.Style;
 
+import tools.jackson.databind.annotation.JsonSerialize;
+
 public class Labels extends AbstractConfigurationObject {
 
     private HorizontalAlign align;

vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/serializers/AbstractSeriesBeanSerializer.java

@@ -8,13 +8,12 @@
  */
 package com.vaadin.flow.component.charts.model.serializers;
 
-import java.io.IOException;
-
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
 import com.vaadin.flow.component.charts.model.AbstractSeries;
 import com.vaadin.flow.component.charts.model.PlotOptionsSeries;
 
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.SerializationContext;
+
 /**
  * Custom bean serializer for {@link AbstractSeries} that adds the type field.
  * We need to use a bean serializer so that annotations work.
@@ -31,18 +30,17 @@ public Class<AbstractSeries> getBeanClass() {
     @Override
     public void serialize(AbstractSeries bean,
             BeanSerializerDelegator<AbstractSeries> serializer,
-            JsonGenerator jgen, SerializerProvider provider)
-            throws IOException {
+            JsonGenerator jgen, SerializationContext context) {
         AbstractSeries series = bean;
 
         jgen.writeStartObject();
 
         // write other fields as per normal serialization rules
-        serializer.serializeFields(bean, jgen, provider);
+        serializer.serializeProperties(bean, jgen, context);
 
         if (series.getPlotOptions() != null
                 && !(bean.getPlotOptions() instanceof PlotOptionsSeries)) {
-            jgen.writeObjectField("type",
+            jgen.writePOJOProperty("type",
                     series.getPlotOptions().getChartType());
         }
 

vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/serializers/AxisListSerializer.java

@@ -8,36 +8,33 @@
  */
 package com.vaadin.flow.component.charts.model.serializers;
 
-import java.io.IOException;
-
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.JsonSerializer;
-import com.fasterxml.jackson.databind.Module;
-import com.fasterxml.jackson.databind.SerializerProvider;
-import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.vaadin.flow.component.charts.model.AxisList;
 
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.JacksonModule;
+import tools.jackson.databind.SerializationContext;
+import tools.jackson.databind.ValueSerializer;
+import tools.jackson.databind.module.SimpleModule;
+
 /**
  * Serializer for {@link AxisList}
  *
  */
-public class AxisListSerializer extends JsonSerializer<AxisList> {
+public class AxisListSerializer extends ValueSerializer<AxisList> {
 
-    public static Module getModule() {
+    public static JacksonModule getModule() {
         SimpleModule module = new SimpleModule();
         module.addSerializer(AxisList.class, new AxisListSerializer());
         return module;
     }
 
     @Override
     public void serialize(AxisList value, JsonGenerator gen,
-            SerializerProvider serializers)
-            throws IOException, JsonProcessingException {
+            SerializationContext context) {
         if (value != null && value.getNumberOfAxes() == 1) {
-            gen.writeObject(value.getAxis(0));
+            gen.writePOJO(value.getAxis(0));
         } else if (value != null) {
-            gen.writeObject(value.getAxes());
+            gen.writePOJO(value.getAxes());
         }
     }
 }

vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/serializers/AxisTitleBeanSerializer.java

@@ -8,12 +8,11 @@
  */
 package com.vaadin.flow.component.charts.model.serializers;
 
-import java.io.IOException;
-
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
 import com.vaadin.flow.component.charts.model.AxisTitle;
 
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.SerializationContext;
+
 /**
  * Serializer for {@link com.vaadin.flow.component.charts.model.AxisTitle}.
  *
@@ -29,14 +28,14 @@ public Class<AxisTitle> getBeanClass() {
     @Override
     public void serialize(AxisTitle bean,
             BeanSerializerDelegator<AxisTitle> serializer, JsonGenerator jgen,
-            SerializerProvider provider) throws IOException {
+            SerializationContext context) {
         jgen.writeStartObject();
 
         if (bean != null && bean.getText() == null) {
-            jgen.writeNullField("text");
+            jgen.writeNullProperty("text");
         } else {
             // write fields as per normal serialization rules
-            serializer.serializeFields(bean, jgen, provider);
+            serializer.serializeProperties(bean, jgen, context);
         }
 
         jgen.writeEndObject();

vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/serializers/BeanSerializationDelegate.java

@@ -8,11 +8,9 @@
  */
 package com.vaadin.flow.component.charts.model.serializers;
 
-import java.io.IOException;
-
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
-import com.fasterxml.jackson.databind.ser.std.BeanSerializerBase;
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.SerializationContext;
+import tools.jackson.databind.ser.bean.BeanSerializerBase;
 
 /**
  * Abstract class for bean serializers. It is called by
@@ -26,5 +24,5 @@ public abstract class BeanSerializationDelegate<T> {
 
     public abstract void serialize(T bean,
             BeanSerializerDelegator<T> serializer, JsonGenerator jgen,
-            SerializerProvider provider) throws IOException;
+            SerializationContext context);
 }

vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/serializers/BeanSerializerDelegator.java

@@ -8,16 +8,17 @@
  */
 package com.vaadin.flow.component.charts.model.serializers;
 
-import java.io.IOException;
 import java.util.Set;
 
-import com.fasterxml.jackson.core.JsonGenerationException;
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
-import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;
-import com.fasterxml.jackson.databind.ser.impl.BeanAsArraySerializer;
-import com.fasterxml.jackson.databind.ser.impl.ObjectIdWriter;
-import com.fasterxml.jackson.databind.ser.std.BeanSerializerBase;
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.databind.SerializationContext;
+import tools.jackson.databind.ValueSerializer;
+import tools.jackson.databind.ser.BeanPropertyWriter;
+import tools.jackson.databind.ser.bean.BeanAsArraySerializer;
+import tools.jackson.databind.ser.bean.BeanSerializerBase;
+import tools.jackson.databind.ser.bean.UnwrappingBeanSerializer;
+import tools.jackson.databind.ser.impl.ObjectIdWriter;
+import tools.jackson.databind.util.NameTransformer;
 
 /**
  * Delegates serialization calls to the given instance of
@@ -39,11 +40,6 @@ public BeanSerializerDelegator(BeanSerializerBase source,
         super(source, objectIdWriter);
     }
 
-    public BeanSerializerDelegator(BeanSerializerBase source,
-            String[] toIgnore) {
-        super(source, toIgnore);
-    }
-
     public BeanSerializerDelegator(BeanSerializerBase source, Object filterId) {
         super(source, null, filterId);
     }
@@ -61,11 +57,6 @@ public BeanSerializerBase withObjectIdWriter(
         return new BeanSerializerDelegator(this, objectIdWriter);
     }
 
-    @Override
-    protected BeanSerializerBase withIgnorals(Set<String> toIgnore) {
-        return new BeanSerializerDelegator(this, toIgnore);
-    }
-
     @Override
     protected BeanSerializerBase withByNameInclusion(Set<String> set,
             Set<String> set1) {
@@ -87,23 +78,28 @@ protected BeanSerializerBase withProperties(
     @Override
     protected BeanSerializerBase asArraySerializer() {
         // copied from BeanSerializer
-        if ((_objectIdWriter == null) && (_propertyFilterId == null)) {
-            return new BeanAsArraySerializer(this);
+        if (canCreateArraySerializer()) {
+            return BeanAsArraySerializer.construct(this);
         }
         return this;
     }
 
     @Override
     public void serialize(Object bean, JsonGenerator jgen,
-            SerializerProvider provider) throws IOException {
+            SerializationContext provider) {
         delegate.serialize(delegate.getBeanClass().cast(bean), this, jgen,
                 provider);
     }
 
     @Override
-    public void serializeFields(Object bean, JsonGenerator jgen,
-            SerializerProvider provider)
-            throws IOException, JsonGenerationException {
-        super.serializeFields(bean, jgen, provider);
+    public ValueSerializer<Object> unwrappingSerializer(
+            NameTransformer unwrapper) {
+        // copied from BeanSerializer
+        return new UnwrappingBeanSerializer(this, unwrapper);
+    }
+
+    public void serializeProperties(Object bean, JsonGenerator jgen,
+            SerializationContext provider) {
+        super._serializeProperties(bean, jgen, provider);
     }
 }