issue 58 - NUMBER_INT should be specified when deserializing LocalDate as EpochDays (#142)

Fix #58 NUMBER_INT should be specified when deserializing LocalDate as EpochDays (unless lenient)

Author: kupci

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/InstantDeserializer.java

@@ -164,7 +164,10 @@ protected InstantDeserializer<T> withDateFormat(DateTimeFormatter dtf) {
     protected InstantDeserializer<T> withLeniency(Boolean leniency) {
         return this;
     }
-    
+
+    @Override
+    protected InstantDeserializer<T> withShape(JsonFormat.Shape shape) { return this; }
+
     @SuppressWarnings("unchecked")
     @Override
     public T deserialize(JsonParser parser, DeserializationContext context) throws IOException

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/JSR310DateTimeDeserializerBase.java

@@ -7,6 +7,7 @@
 
 import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonFormat.Feature;
+import com.fasterxml.jackson.annotation.JsonFormat.Shape;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
 import com.fasterxml.jackson.databind.BeanProperty;
@@ -39,10 +40,24 @@ public abstract class JSR310DateTimeDeserializerBase<T>
      */
     protected final boolean _isLenient;
 
+    /**
+     * Setting that indicates the {@Link JsonFormat.Shape} specified for this deserializer
+     * as a {@link JsonFormat.Shape} annotation on property or class, or due to per-type
+     * "config override", or from global settings:
+     * If Shape is NUMBER_INT, the input value is considered to be epoch days. If not a
+     * NUMBER_INT, and the deserializer was not specified with the leniency setting of true,
+     * then an exception will be thrown.
+     * @see [jackson-modules-java8#58] for more info
+     *
+     * @since 2.11
+     */
+    protected final Shape _shape;
+
     protected JSR310DateTimeDeserializerBase(Class<T> supportedType, DateTimeFormatter f) {
         super(supportedType);
         _formatter = f;
         _isLenient = true;
+        _shape = null;
     }
 
     /**
@@ -53,6 +68,7 @@ protected JSR310DateTimeDeserializerBase(JSR310DateTimeDeserializerBase<T> base,
         super(base);
         _formatter = f;
         _isLenient = base._isLenient;
+        _shape = base._shape;
     }
 
     /**
@@ -63,15 +79,34 @@ protected JSR310DateTimeDeserializerBase(JSR310DateTimeDeserializerBase<T> base,
         super(base);
         _formatter = base._formatter;
         _isLenient = !Boolean.FALSE.equals(leniency);
+        _shape = base._shape;
+    }
+
+    /**
+     * @since 2.11
+     */
+    protected JSR310DateTimeDeserializerBase(JSR310DateTimeDeserializerBase<T> base,
+                                             Shape shape) {
+        super(base);
+        _formatter = base._formatter;
+        _shape = shape;
+        _isLenient = base._isLenient;
     }
 
+
     protected abstract JSR310DateTimeDeserializerBase<T> withDateFormat(DateTimeFormatter dtf);
 
     /**
      * @since 2.10
      */
     protected abstract JSR310DateTimeDeserializerBase<T> withLeniency(Boolean leniency);
 
+    /**
+     * @since 2.11
+     */
+    protected abstract JSR310DateTimeDeserializerBase<T> withShape(Shape shape);
+
+
     @Override
     public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
             BeanProperty property) throws JsonMappingException
@@ -107,6 +142,12 @@ public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
                     deser = deser.withLeniency(leniency);
                 }
             }
+            //Issue #58: For LocalDate deserializers we need to configure the formatter with
+            //a shape picked up from JsonFormat annotation, to decide if the value is EpochSeconds
+            JsonFormat.Shape shape = format.getShape();
+            if (shape != null && shape != _shape) {
+                deser = deser.withShape(shape);
+            }
             // any use for TimeZone?
         }
         return deser;

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/LocalDateDeserializer.java

@@ -24,6 +24,7 @@
 import java.time.ZoneOffset;
 import java.time.format.DateTimeFormatter;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.DeserializationFeature;
@@ -63,6 +64,13 @@ protected LocalDateDeserializer(LocalDateDeserializer base, Boolean leniency) {
         super(base, leniency);
     }
 
+    /**
+     * Since 2.11
+     */
+    protected LocalDateDeserializer(LocalDateDeserializer base, JsonFormat.Shape shape) {
+        super(base, shape);
+    }
+
     @Override
     protected LocalDateDeserializer withDateFormat(DateTimeFormatter dtf) {
         return new LocalDateDeserializer(this, dtf);
@@ -73,6 +81,9 @@ protected LocalDateDeserializer withLeniency(Boolean leniency) {
         return new LocalDateDeserializer(this, leniency);
     }
 
+    @Override
+    protected LocalDateDeserializer withShape(JsonFormat.Shape shape) { return new LocalDateDeserializer(this, shape); }
+
     @Override
     public LocalDate deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {
@@ -136,10 +147,11 @@ public LocalDate deserialize(JsonParser parser, DeserializationContext context)
         }
         // 06-Jan-2018, tatu: Is this actually safe? Do users expect such coercion?
         if (parser.hasToken(JsonToken.VALUE_NUMBER_INT)) {
-            if (!isLenient()) {
-                return _failForNotLenient(parser, context, JsonToken.VALUE_STRING);
+            // issue 58 - also check for NUMBER_INT, which needs to be specified when serializing.
+            if (_shape == JsonFormat.Shape.NUMBER_INT || isLenient()) {
+                return LocalDate.ofEpochDay(parser.getLongValue());
             }
-            return LocalDate.ofEpochDay(parser.getLongValue());
+            return _failForNotLenient(parser, context, JsonToken.VALUE_STRING);
         }
         return _handleUnexpectedToken(context, parser, "Expected array or string.");
     }

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/LocalDateTimeDeserializer.java

@@ -23,6 +23,7 @@
 import java.time.ZoneOffset;
 import java.time.format.DateTimeFormatter;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
 import com.fasterxml.jackson.core.JsonTokenId;
@@ -69,6 +70,9 @@ protected LocalDateTimeDeserializer withLeniency(Boolean leniency) {
         return new LocalDateTimeDeserializer(this, leniency);
     }
 
+    @Override
+    protected LocalDateTimeDeserializer withShape(JsonFormat.Shape shape) { return this; }
+
     @Override
     public LocalDateTime deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/LocalTimeDeserializer.java

@@ -21,6 +21,7 @@
 import java.time.LocalTime;
 import java.time.format.DateTimeFormatter;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
 import com.fasterxml.jackson.databind.DeserializationContext;
@@ -58,6 +59,9 @@ protected LocalTimeDeserializer withLeniency(Boolean leniency) {
         return this;
     }
 
+    @Override
+    protected LocalTimeDeserializer withShape(JsonFormat.Shape shape) { return this; }
+
     @Override
     public LocalTime deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/MonthDayDeserializer.java

@@ -5,6 +5,7 @@
 import java.time.MonthDay;
 import java.time.format.DateTimeFormatter;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
 import com.fasterxml.jackson.databind.DeserializationContext;
@@ -34,6 +35,9 @@ protected MonthDayDeserializer withLeniency(Boolean leniency) {
         return this;
     }
 
+    @Override
+    protected MonthDayDeserializer withShape(JsonFormat.Shape shape) { return this; }
+
     @Override
     public MonthDay deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/OffsetTimeDeserializer.java

@@ -22,6 +22,7 @@
 import java.time.ZoneOffset;
 import java.time.format.DateTimeFormatter;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.databind.*;
 
@@ -55,6 +56,9 @@ protected OffsetTimeDeserializer withLeniency(Boolean leniency) {
         return this;
     }
 
+    @Override
+    protected OffsetTimeDeserializer withShape(JsonFormat.Shape shape) { return this; }
+
     @Override
     public OffsetTime deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/YearDeserializer.java

@@ -16,6 +16,7 @@
 
 package com.fasterxml.jackson.datatype.jsr310.deser;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
 import com.fasterxml.jackson.databind.DeserializationContext;
@@ -56,6 +57,9 @@ protected YearDeserializer withLeniency(Boolean leniency) {
         return this;
     }
 
+    @Override
+    protected YearDeserializer withShape(JsonFormat.Shape shape) { return this; }
+
     @Override
     public Year deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {

datetime/src/main/java/com/fasterxml/jackson/datatype/jsr310/deser/YearMonthDeserializer.java

@@ -21,6 +21,7 @@
 import java.time.YearMonth;
 import java.time.format.DateTimeFormatter;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.DeserializationFeature;
@@ -59,6 +60,9 @@ protected YearMonthDeserializer withLeniency(Boolean leniency) {
         return this;
     }
 
+    @Override
+    protected YearMonthDeserializer withShape(JsonFormat.Shape shape) { return this; }
+
     @Override
     public YearMonth deserialize(JsonParser parser, DeserializationContext context) throws IOException
     {

datetime/src/test/java/com/fasterxml/jackson/datatype/jsr310/deser/LocalDateDeserTest.java

@@ -45,7 +45,15 @@ final static class Wrapper {
         public Wrapper() { }
         public Wrapper(LocalDate v) { value = v; }
     }
-    
+
+    final static class ShapeWrapper {
+        @JsonFormat(shape=JsonFormat.Shape.NUMBER_INT)
+        public LocalDate date;
+
+        public ShapeWrapper() { }
+        public ShapeWrapper(LocalDate v) { date = v; }
+    }
+
     /*
     /**********************************************************
     /* Deserialization from Int array representation
@@ -341,6 +349,53 @@ public void testDeserializationCaseInsensitiveDisabled_InvalidDate() throws Thro
         }
     }
 
+    /*
+    /**********************************************************************
+    /*
+     * Tests for issue 58 - NUMBER_INT should be specified when deserializing
+     * LocalDate as EpochDays
+     */
+    /**********************************************************************
+    */
+    @Test
+    public void testLenientDeserializeFromNumberInt() throws Exception {
+        ObjectMapper mapper = newMapper();
+        mapper.configOverride(LocalDate.class)
+                        .setFormat(JsonFormat.Value.forShape(JsonFormat.Shape.NUMBER_INT));
+
+        assertEquals("The value is not correct.", LocalDate.of(1970, Month.MAY, 04),
+                mapper.readValue("123", LocalDate.class));
+    }
+
+    @Test
+    public void testStrictDeserializeFromNumberInt() throws Exception
+    {
+        ObjectMapper mapper = newMapper();
+        mapper.configOverride(LocalDate.class)
+                .setFormat(JsonFormat.Value.forLeniency(false));
+
+        ShapeWrapper w = mapper.readValue("{\"date\":123}", ShapeWrapper.class);
+        LocalDate localDate = w.date;
+
+        assertEquals("The value is not correct.", LocalDate.of(1970, Month.MAY, 04),
+                localDate);
+    }
+
+    @Test(expected = MismatchedInputException.class)
+    public void testStrictDeserializeFromString() throws Exception
+    {
+        ObjectMapper mapper = newMapper();
+        mapper.configOverride(LocalDate.class)
+                .setFormat(JsonFormat.Value.forLeniency(false));
+
+        mapper.readValue("{\"value\":123}", Wrapper.class);
+    }
+
+    /*
+    /**********************************************************************
+    /* Helper methods
+    /**********************************************************************
+    */
     private void expectFailure(ObjectReader reader, String json) throws Throwable {
         try {
             reader.readValue(aposToQuotes(json));