fix: add support for Java Time types for Element properties (#17105)

Allows POJOs with Java Time members to be serialized as Element JSON properties.

To avoid breaking changes, the Object mapper WRITE_DATES_AS_TIMESTAMPS feature
is left as default, so some types such as LocalTime, LocaDate and LocalDateTime
are serialized as arrays of numbers, as documented in Jackson JavaTimeModule.

Fixes #13317

Author: mcollovati

flow-server/pom.xml

@@ -96,6 +96,11 @@
             <artifactId>jackson-databind</artifactId>
             <version>${jackson.databind.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
 
         <!-- Jsoup for BootstrapHandler, Template, ... -->
         <dependency>

flow-server/src/main/java/com/vaadin/flow/internal/JsonUtils.java

@@ -33,6 +33,7 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
 import elemental.json.Json;
 import elemental.json.JsonArray;
@@ -57,6 +58,10 @@ public final class JsonUtils {
 
     private static final ObjectMapper objectMapper = new ObjectMapper();
 
+    static {
+        objectMapper.registerModule(new JavaTimeModule());
+    }
+
     /**
      * Collects a stream of JSON values to a JSON array.
      *

flow-server/src/test/java/com/vaadin/flow/dom/ElementTest.java

@@ -7,9 +7,16 @@
 import java.lang.reflect.Modifier;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.time.Duration;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -20,6 +27,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Collectors;
+import java.util.stream.DoubleStream;
 
 import net.jcip.annotations.NotThreadSafe;
 import org.junit.Assert;
@@ -33,6 +41,7 @@
 import com.vaadin.flow.component.internal.UIInternals.JavaScriptInvocation;
 import com.vaadin.flow.component.page.PendingJavaScriptResult;
 import com.vaadin.flow.dom.impl.BasicElementStateProvider;
+import com.vaadin.flow.internal.JsonUtils;
 import com.vaadin.flow.internal.NullOwner;
 import com.vaadin.flow.internal.StateNode;
 import com.vaadin.flow.internal.nodefeature.ComponentMapping;
@@ -553,6 +562,24 @@ public double getDbl() {
         }
     }
 
+    public static class BeanWithTemporalFields {
+
+        public LocalTime localTime = LocalTime.of(10, 23, 55);
+
+        public LocalDate localDate = LocalDate.of(2023, 6, 26);
+
+        public LocalDateTime localDateTime = localDate.atTime(localTime);
+
+        public java.sql.Date sqlDate = java.sql.Date.valueOf(localDate);
+
+        public Date date = new Date(sqlDate.getTime());
+
+        public ZonedDateTime zonedDateTime = ZonedDateTime.of(localDateTime,
+                ZoneId.of("Europe/Rome"));
+
+        public Duration duration = Duration.ofSeconds(10);
+    }
+
     @Test
     public void propertyRawValues() {
         Element element = ElementFactory.createDiv();
@@ -633,6 +660,33 @@ public void propertyNames() {
         Assert.assertEquals(0, element.getPropertyNames().count());
     }
 
+    @Test
+    public void setProperty_javaTimeObject() {
+        BeanWithTemporalFields bean = new BeanWithTemporalFields();
+        Element element = ElementFactory.createDiv();
+
+        element.setPropertyBean("bean", bean);
+        JsonObject json = (JsonObject) element.getPropertyRaw("bean");
+
+        Assert.assertTrue("LocalTime not serialized as expected",
+                JsonUtils.jsonEquals(createNumberArray(10, 23, 55),
+                        json.getArray("localTime")));
+        Assert.assertTrue("LocalDate not serialized as expected",
+                JsonUtils.jsonEquals(createNumberArray(2023, 6, 26),
+                        json.getArray("localDate")));
+        Assert.assertTrue("LocalDateTime not serialized as expected",
+                JsonUtils.jsonEquals(createNumberArray(2023, 6, 26, 10, 23, 55),
+                        json.getArray("localDateTime")));
+        Assert.assertEquals("ZonedDateTime not serialized as expected",
+                bean.zonedDateTime.toEpochSecond(),
+                json.getNumber("zonedDateTime"), 0);
+        Assert.assertEquals("ZonedDateTime not serialized as expected",
+                bean.sqlDate.getTime(), json.getNumber("sqlDate"), 0);
+        Assert.assertEquals("ZonedDateTime not serialized as expected",
+                bean.date.getTime(), json.getNumber("date"), 0);
+        Assert.assertEquals(10.0, json.getNumber("duration"), 0);
+    }
+
     private static Element createPropertyAssertElement(Object value) {
         Element element = ElementFactory.createDiv();
 
@@ -2534,4 +2588,10 @@ private void assertEquals(JavaScriptInvocation expected,
                 actual.getParameters().toArray());
 
     }
+
+    private static JsonArray createNumberArray(double... items) {
+        return DoubleStream.of(items).mapToObj(Json::create)
+                .collect(JsonUtils.asArray());
+    }
+
 }

flow-server/src/test/java/com/vaadin/flow/internal/JsonUtilsTest.java

@@ -15,8 +15,15 @@
  */
 package com.vaadin.flow.internal;
 
+import java.time.Duration;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -117,6 +124,11 @@ private static JsonArray createTestArray2() {
                 .collect(JsonUtils.asArray());
     }
 
+    private static JsonArray createNumberArray(double... items) {
+        return DoubleStream.of(items).mapToObj(Json::create)
+                .collect(JsonUtils.asArray());
+    }
+
     @Test
     public void collectEmptyStream() {
         Stream<JsonValue> jsonValueStream = Stream.empty();
@@ -276,6 +288,24 @@ public String getChildValue() {
         }
     }
 
+    public static class BeanWithTemporalFields {
+
+        public LocalTime localTime = LocalTime.of(10, 23, 55);
+
+        public LocalDate localDate = LocalDate.of(2023, 6, 26);
+
+        public LocalDateTime localDateTime = localDate.atTime(localTime);
+
+        public java.sql.Date sqlDate = java.sql.Date.valueOf(localDate);
+
+        public Date date = new Date(sqlDate.getTime());
+
+        public ZonedDateTime zonedDateTime = ZonedDateTime.of(localDateTime,
+                ZoneId.of("Europe/Rome"));
+
+        public Duration duration = Duration.ofSeconds(10);
+    }
+
     public static class ListAndMapBean {
         private Map<String, Integer> integerMap = new HashMap<>();
         private Map<String, ChildBean> childBeanMap = new HashMap<>();
@@ -335,6 +365,30 @@ public void nestedBeanToJson() {
         Assert.assertEquals("child", child.getString("childValue"));
     }
 
+    @Test
+    public void beanWithTimeFields() {
+        BeanWithTemporalFields bean = new BeanWithTemporalFields();
+        JsonObject json = JsonUtils.beanToJson(bean);
+
+        Assert.assertTrue("LocalTime not serialized as expected",
+                JsonUtils.jsonEquals(createNumberArray(10, 23, 55),
+                        json.getArray("localTime")));
+        Assert.assertTrue("LocalDate not serialized as expected",
+                JsonUtils.jsonEquals(createNumberArray(2023, 6, 26),
+                        json.getArray("localDate")));
+        Assert.assertTrue("LocalDateTime not serialized as expected",
+                JsonUtils.jsonEquals(createNumberArray(2023, 6, 26, 10, 23, 55),
+                        json.getArray("localDateTime")));
+        Assert.assertEquals("ZonedDateTime not serialized as expected",
+                bean.zonedDateTime.toEpochSecond(),
+                json.getNumber("zonedDateTime"), 0);
+        Assert.assertEquals("ZonedDateTime not serialized as expected",
+                bean.sqlDate.getTime(), json.getNumber("sqlDate"), 0);
+        Assert.assertEquals("ZonedDateTime not serialized as expected",
+                bean.date.getTime(), json.getNumber("date"), 0);
+        Assert.assertEquals(10.0, json.getNumber("duration"), 0);
+    }
+
     @Test
     public void nullChildBean() {
         ParentBean bean = new ParentBean();