Fix #3217 (XMLGregorianCalendar, polymorphic serialization)

Author: cowtowncoder

release-notes/CREDITS-2.x

@@ -1366,6 +1366,10 @@ Nick Benoit (nick-benoit14@github)
   * Proposed #3193: Add `MapperFeature.APPLY_DEFAULT_VALUES`, initially for Scala module
    (2.13.0)
 
+Xinzhe Yang (xinzheyang@github)
+  * Reported #3217: `XMLGregorianCalendar` doesn't work with default typing
+   (2.13.0)
+
 Kenneth Jorgensen (kennethjor@github)
   * Requested #3238: Add PropertyNamingStrategies.UpperSnakeCaseStrategy
     (and UPPER_SNAKE_CASE constant)

release-notes/VERSION-2.x

@@ -58,6 +58,8 @@ Project: jackson-databind
  (contributed by Klaas D)
 #3193: Add `MapperFeature.APPLY_DEFAULT_VALUES`, initially for Scala module
  (suggested by Nick B)
+#3217: `XMLGregorianCalendar` doesn't work with default typing
+ (reported by Xinzhe Y)
 #3238: Add PropertyNamingStrategies.UpperSnakeCaseStrategy (and UPPER_SNAKE_CASE constant)
  (requested by Kenneth J)
  (contributed by Tanvesh)

src/main/java/com/fasterxml/jackson/databind/ext/CoreXMLSerializers.java

@@ -8,6 +8,7 @@
 import javax.xml.namespace.QName;
 
 import com.fasterxml.jackson.core.*;
+import com.fasterxml.jackson.core.type.WritableTypeId;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
@@ -78,10 +79,22 @@ public void serialize(XMLGregorianCalendar value, JsonGenerator gen, SerializerP
         }
 
         @Override
-        public void serializeWithType(XMLGregorianCalendar value, JsonGenerator gen, SerializerProvider provider,
+        public void serializeWithType(XMLGregorianCalendar value, JsonGenerator g, SerializerProvider provider,
                 TypeSerializer typeSer) throws IOException
         {
-            _delegate.serializeWithType(_convert(value), gen, provider, typeSer);
+            // 16-Aug-2021, tatu: as per [databind#3217] we cannot simply delegate
+            //    as that would produce wrong Type Id altogether. So redefine
+            //    implementation from `StdScalarSerializer`
+//            _delegate.serializeWithType(_convert(value), gen, provider, typeSer);
+
+            // Need not really be string; just indicates "scalar of some kind"
+            // (and so numeric timestamp is fine as well):
+            WritableTypeId typeIdDef = typeSer.writeTypePrefix(g,
+                    // important! Pass value AND type to use
+                    typeSer.typeId(value, XMLGregorianCalendar.class, JsonToken.VALUE_STRING));
+            // note: serialize() will convert to delegate value
+            serialize(value, g, provider);
+            typeSer.writeTypeSuffix(g, typeIdDef);
         }
 
         @Override

src/main/java/com/fasterxml/jackson/databind/ser/std/StdDelegatingSerializer.java

@@ -172,9 +172,8 @@ public void serialize(Object value, JsonGenerator gen, SerializerProvider provid
     public void serializeWithType(Object value, JsonGenerator gen, SerializerProvider provider,
             TypeSerializer typeSer) throws IOException
     {
-        /* 03-Oct-2012, tatu: This is actually unlikely to work ok... but for now,
-         *    let's give it a chance?
-         */
+        // 03-Oct-2012, tatu: This is actually unlikely to work ok... but for now,
+        //    let's give it a chance?
         Object delegateValue = convertValue(value);
         JsonSerializer<Object> ser = _delegateSerializer;
         if (ser == null) {

src/test/java/com/fasterxml/jackson/databind/ext/MiscJavaXMLTypesReadWriteTest.java

@@ -4,6 +4,7 @@
 import javax.xml.namespace.QName;
 
 import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.testutil.NoCheckSubTypeValidator;
 import com.fasterxml.jackson.databind.type.TypeFactory;
 
 /**
@@ -17,24 +18,29 @@ public class MiscJavaXMLTypesReadWriteTest
 {
     private final ObjectMapper MAPPER = newJsonMapper();
 
+    private final ObjectMapper POLY_MAPPER = jsonMapperBuilder()
+            .activateDefaultTyping(NoCheckSubTypeValidator.instance,
+                    ObjectMapper.DefaultTyping.NON_FINAL)
+            .build();
+
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Serializer tests
-    /**********************************************************
+    /**********************************************************************
      */
 
     public void testQNameSer() throws Exception
     {
         QName qn = new QName("http://abc", "tag", "prefix");
-        assertEquals(q(qn.toString()), serializeAsString(qn));
+        assertEquals(q(qn.toString()), MAPPER.writeValueAsString(qn));
     }
 
     public void testDurationSer() throws Exception
     {
         DatatypeFactory dtf = DatatypeFactory.newInstance();
         // arbitrary value
         Duration dur = dtf.newDurationDayTime(false, 15, 19, 58, 1);
-        assertEquals(q(dur.toString()), serializeAsString(dur));
+        assertEquals(q(dur.toString()), MAPPER.writeValueAsString(dur));
     }
 
     public void testXMLGregorianCalendarSerAndDeser() throws Exception
@@ -76,13 +82,13 @@ private String removeZ(String dateStr) {
         }
         return dateStr;
     }
-    
+
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Deserializer tests
-    /**********************************************************
+    /**********************************************************************
      */
-    
+
     // First things first: must be able to load the deserializers...
     public void testDeserializerLoading()
     {
@@ -101,7 +107,7 @@ public void testQNameDeser() throws Exception
                      qn, MAPPER.readValue(q(qstr), QName.class));
     }
 
-    public void testCalendarDeser() throws Exception
+    public void testXMLGregorianCalendarDeser() throws Exception
     {
         DatatypeFactory dtf = DatatypeFactory.newInstance();
         XMLGregorianCalendar cal = dtf.newXMLGregorianCalendar
@@ -120,4 +126,23 @@ public void testDurationDeser() throws Exception
         assertEquals("Should deserialize to equal Duration ('"+exp+"')", dur,
                 MAPPER.readValue(q(exp), Duration.class));
     }
+
+    /*
+    /**********************************************************************
+    /* Polymorphic handling tests
+    /**********************************************************************
+     */
+
+
+    public void testPolymorphicXMLGregorianCalendar() throws Exception
+    {
+        XMLGregorianCalendar cal = DatatypeFactory.newInstance().newXMLGregorianCalendar
+                (1974, 10, 10, 18, 15, 17, 123, 0);
+        String json = POLY_MAPPER.writeValueAsString(cal);
+        Object result = POLY_MAPPER.readValue(json, Object.class);
+        if (!(result instanceof XMLGregorianCalendar)) {
+            fail("Expected a `XMLGregorianCalendar`, got: "+result.getClass());
+        }
+        assertEquals(cal, result);
+    }
 }