Merge branch '2.14' into tatu/2.14/3394-any-setter-jsonnode

cowtowncoder · cowtowncoder · commit 804f4e3fe503 · 2022-08-01T15:36:50.000-07:00
diff --git a/release-notes/VERSION-2.x b/release-notes/VERSION-2.x
@@ -48,6 +48,7 @@ Project: jackson-databind
 #3530: Change LRUMap to just evict one entry when maxEntries reached
  (contributed by @pjfanning)
 #3535: Replace `JsonNode.with()` with `JsonNode.withObject()`
+#3559: Support `null`-valued `Map` fields with "any setter"
 
 2.13.4 (not yet released)
 
diff --git a/src/main/java/com/fasterxml/jackson/databind/JsonMappingException.java b/src/main/java/com/fasterxml/jackson/databind/JsonMappingException.java
@@ -294,21 +294,26 @@ public static JsonMappingException from(JsonGenerator g, String msg, Throwable p
      * @since 2.7
      */
     public static JsonMappingException from(DeserializationContext ctxt, String msg) {
-        return new JsonMappingException(ctxt.getParser(), msg);
+        return new JsonMappingException(_parser(ctxt), msg);
     }
 
     /**
      * @since 2.7
      */
     public static JsonMappingException from(DeserializationContext ctxt, String msg, Throwable t) {
-        return new JsonMappingException(ctxt.getParser(), msg, t);
+        return new JsonMappingException(_parser(ctxt), msg, t);
+    }
+
+    // @since 2.14
+    private static JsonParser _parser(DeserializationContext ctxt) {
+        return (ctxt == null) ? null : ctxt.getParser();
     }
 
     /**
      * @since 2.7
      */
     public static JsonMappingException from(SerializerProvider ctxt, String msg) {
-        return new JsonMappingException(ctxt.getGenerator(), msg);
+        return new JsonMappingException(_generator(ctxt), msg);
     }
 
     /**
@@ -318,7 +323,12 @@ public static JsonMappingException from(SerializerProvider ctxt, String msg, Thr
         /* 17-Aug-2015, tatu: As per [databind#903] this is bit problematic as
          *   SerializerProvider instance does not currently hold on to generator...
          */
-        return new JsonMappingException(ctxt.getGenerator(), msg, problem);
+        return new JsonMappingException(_generator(ctxt), msg, problem);
+    }
+
+    // @since 2.14
+    private static JsonGenerator _generator(SerializerProvider ctxt) {
+        return (ctxt == null) ? null : ctxt.getGenerator();
     }
     
     /**
diff --git a/src/main/java/com/fasterxml/jackson/databind/deser/SettableAnyProperty.java b/src/main/java/com/fasterxml/jackson/databind/deser/SettableAnyProperty.java
@@ -1,10 +1,12 @@
 package com.fasterxml.jackson.databind.deser;
 
 import java.io.IOException;
+import java.util.LinkedHashMap;
 import java.util.Map;
 
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.deser.impl.JDKValueInstantiators;
 import com.fasterxml.jackson.databind.deser.impl.ReadableObjectId.Referring;
 import com.fasterxml.jackson.databind.introspect.AnnotatedField;
 import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
@@ -154,24 +156,46 @@ public void set(Object instance, Object propName, Object value) throws IOExcepti
             if (_setterIsField) {
                 AnnotatedField field = (AnnotatedField) _setter;
                 Map<Object,Object> val = (Map<Object,Object>) field.getValue(instance);
-                /* 01-Jun-2016, tatu: At this point it is not quite clear what to do if
-                 *    field is `null` -- we cannot necessarily count on zero-args
-                 *    constructor except for a small set of types, so for now just
-                 *    ignore if null. May need to figure out something better in future.
-                 */
-                if (val != null) {
-                    // add the property key and value
-                    val.put(propName, value);
+                // 01-Aug-2022, tatu: [databind#3559] Will try to create and assign an
+                //    instance.
+                if (val == null) {
+                    val = _createAndSetMap(null, field, instance, propName);
                 }
+                // add the property key and value
+                val.put(propName, value);
             } else {
                 // note: cannot use 'setValue()' due to taking 2 args
                 ((AnnotatedMethod) _setter).callOnWith(instance, propName, value);
             }
+        } catch (IOException e) {
+            throw e;
         } catch (Exception e) {
             _throwAsIOE(e, propName, value);
         }
     }
 
+    @SuppressWarnings("unchecked")
+    protected Map<Object, Object> _createAndSetMap(DeserializationContext ctxt, AnnotatedField field,
+            Object instance, Object propName)
+        throws IOException
+    {
+        Class<?> mapType = field.getRawType();
+        // Ideally would be resolved to a concrete type but if not:
+        if (mapType == Map.class) {
+            mapType = LinkedHashMap.class;
+        }
+        // We know that DeserializationContext not actually required:
+        ValueInstantiator vi = JDKValueInstantiators.findStdValueInstantiator(null, mapType);
+        if (vi == null) {
+            throw JsonMappingException.from(ctxt, String.format(
+                    "Cannot create an instance of %s for use as \"any-setter\" '%s'",
+                    ClassUtil.nameOf(mapType), _property.getName()));
+        }
+        Map<Object,Object> map = (Map<Object,Object>) vi.createUsingDefault(ctxt);
+        field.setValue(instance, map);
+        return map;
+    }
+
     /*
     /**********************************************************
     /* Helper methods
@@ -188,7 +212,7 @@ protected void _throwAsIOE(Exception e, Object propName, Object value)
     {
         if (e instanceof IllegalArgumentException) {
             String actType = ClassUtil.classNameOf(value);
-            StringBuilder msg = new StringBuilder("Problem deserializing \"any\" property '").append(propName);
+            StringBuilder msg = new StringBuilder("Problem deserializing \"any-property\" '").append(propName);
             msg.append("' of class "+getClassName()+" (expected type: ").append(_type);
             msg.append("; actual type: ").append(actType).append(")");
             String origMsg = ClassUtil.exceptionMessage(e);
diff --git a/src/test/java/com/fasterxml/jackson/databind/deser/AnySetterTest.java b/src/test/java/com/fasterxml/jackson/databind/deser/AnySetterTest.java
@@ -163,14 +163,22 @@ static class JsonAnySetterOnNullMap {
         public int id;
 
         @JsonAnySetter
-        protected HashMap<String, String> other;
+        protected Map<String, String> other;
 
         @JsonAnyGetter
         public Map<String, String> any() {
             return other;
         }
     }
 
+    @SuppressWarnings("serial")
+    static class CustomMap extends LinkedHashMap<String, String> { }
+
+    static class JsonAnySetterOnCustomNullMap {
+        @JsonAnySetter
+        public CustomMap other;
+    }
+
     static class MyGeneric<T>
     {
         private String staticallyMappedProperty;
@@ -346,18 +354,31 @@ public void testPolymorphic() throws Exception
     }
 
     public void testJsonAnySetterOnMap() throws Exception {
-        JsonAnySetterOnMap result = MAPPER.readValue("{\"id\":2,\"name\":\"Joe\", \"city\":\"New Jersey\"}",
-                JsonAnySetterOnMap.class);
-        assertEquals(2, result.id);
-        assertEquals("Joe", result.other.get("name"));
-        assertEquals("New Jersey", result.other.get("city"));
+		JsonAnySetterOnMap result = MAPPER.readValue("{\"id\":2,\"name\":\"Joe\", \"city\":\"New Jersey\"}",
+		        JsonAnySetterOnMap.class);
+		assertEquals(2, result.id);
+		assertEquals("Joe", result.other.get("name"));
+		assertEquals("New Jersey", result.other.get("city"));
     }
 
     public void testJsonAnySetterOnNullMap() throws Exception {
-        JsonAnySetterOnNullMap result = MAPPER.readValue("{\"id\":2,\"name\":\"Joe\", \"city\":\"New Jersey\"}",
+        final String DOC = a2q("{'id':2,'name':'Joe', 'city':'New Jersey'}");
+        JsonAnySetterOnNullMap result = MAPPER.readValue(DOC,
                 JsonAnySetterOnNullMap.class);
         assertEquals(2, result.id);
-        assertNull(result.other);
+        // 01-Aug-2022, tatu: As per [databind#3559] should "just work"...
+        assertNotNull(result.other);
+        assertEquals("Joe", result.other.get("name"));
+        assertEquals("New Jersey", result.other.get("city"));
+
+        // But not with unknown "special" maps
+        try {
+            MAPPER.readValue(DOC, JsonAnySetterOnCustomNullMap.class);
+            fail("Should not pass");
+        } catch (DatabindException e) {
+            verifyException(e, "Cannot create an instance of");
+            verifyException(e, "for use as \"any-setter\" 'other'");
+        }
     }
 
     final static String UNWRAPPED_JSON_349 = a2q(
