Support suppressed property when deserializing Throwable (FasterXML#3179)

klaasdellschaft · web-flow · commit a05e2cb80b56 · 2021-06-30T16:30:59.000-07:00
Implement #31767: support `suppressed` property when deserializing Throwable
diff --git a/src/main/java/com/fasterxml/jackson/databind/deser/std/ThrowableDeserializer.java b/src/main/java/com/fasterxml/jackson/databind/deser/std/ThrowableDeserializer.java
@@ -19,6 +19,7 @@ public class ThrowableDeserializer
     private static final long serialVersionUID = 1L;
 
     protected final static String PROP_NAME_MESSAGE = "message";
+    protected final static String PROP_NAME_SUPPRESSED = "suppressed";
 
     /*
     /************************************************************
@@ -82,6 +83,7 @@ public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) t
         
         Object throwable = null;
         Object[] pending = null;
+        Throwable[] suppressed = null;
         int pendingIx = 0;
 
         for (; !p.hasToken(JsonToken.END_OBJECT); p.nextToken()) {
@@ -109,17 +111,17 @@ public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) t
             if (isMessage) {
                 if (hasStringCreator) {
                     throwable = _valueInstantiator.createFromString(ctxt, p.getValueAsString());
-                    // any pending values?
-                    if (pending != null) {
-                        for (int i = 0, len = pendingIx; i < len; i += 2) {
-                            prop = (SettableBeanProperty)pending[i];
-                            prop.set(throwable, pending[i+1]);
-                        }
-                        pending = null;
-                    }
                     continue;
                 }
             }
+
+            // Maybe it's "suppressed"?
+            final boolean isSuppressed = PROP_NAME_SUPPRESSED.equals(propName);
+            if (isSuppressed) {
+                suppressed = ctxt.readValue(p, Throwable[].class);
+                continue;
+            }
+
             // Things marked as ignorable should not be passed to any setter
             if ((_ignorableProps != null) && _ignorableProps.contains(propName)) {
                 p.skipChildren();
@@ -148,14 +150,24 @@ public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) t
             } else {
                 throwable = _valueInstantiator.createUsingDefault(ctxt);
             }
-            // any pending values?
-            if (pending != null) {
-                for (int i = 0, len = pendingIx; i < len; i += 2) {
-                    SettableBeanProperty prop = (SettableBeanProperty)pending[i];
-                    prop.set(throwable, pending[i+1]);
-                }
+        }
+
+        // any pending values?
+        if (pending != null) {
+            for (int i = 0, len = pendingIx; i < len; i += 2) {
+                SettableBeanProperty prop = (SettableBeanProperty)pending[i];
+                prop.set(throwable, pending[i+1]);
             }
         }
+
+        // any suppressed exceptions?
+        if (suppressed != null && throwable instanceof Throwable) {
+            Throwable t = (Throwable) throwable;
+            for (Throwable s : suppressed) {
+                t.addSuppressed(s);
+            }
+        }
+
         return throwable;
     }
 }
diff --git a/src/test/java/com/fasterxml/jackson/databind/exc/ExceptionDeserializationTest.java b/src/test/java/com/fasterxml/jackson/databind/exc/ExceptionDeserializationTest.java
@@ -6,6 +6,9 @@
 import com.fasterxml.jackson.annotation.*;
 
 import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.databind.jsontype.BasicPolymorphicTypeValidator;
+import com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator;
 
 /**
  * Unit tests for verifying that simple exceptions can be deserialized.
@@ -20,7 +23,7 @@ static class MyException extends Exception
 
         protected String myMessage;
         protected HashMap<String,Object> stuff = new HashMap<String, Object>();
-        
+
         @JsonCreator
         MyException(@JsonProperty("message") String msg, @JsonProperty("value") int v)
         {
@@ -30,7 +33,7 @@ static class MyException extends Exception
         }
 
         public int getValue() { return value; }
-        
+
         public String getFoo() { return "bar"; }
 
         @JsonAnySetter public void setter(String key, Object value)
@@ -52,7 +55,7 @@ static class MyNoArgException extends Exception
      */
 
     private final ObjectMapper MAPPER = new ObjectMapper();
-    
+
     public void testIOException() throws IOException
     {
         IOException ioe = new IOException("TEST");
@@ -96,9 +99,10 @@ public void testJDK7SuppressionProperty() throws IOException
         Exception exc = MAPPER.readValue("{\"suppressed\":[]}", IOException.class);
         assertNotNull(exc);
     }
-    
+
     // [databind#381]
-    public void testSingleValueArrayDeserialization() throws Exception {
+    public void testSingleValueArrayDeserialization() throws Exception
+    {
         final ObjectMapper mapper = new ObjectMapper();
         mapper.enable(DeserializationFeature.UNWRAP_SINGLE_VALUE_ARRAYS);
         final IOException exp;
@@ -108,13 +112,72 @@ public void testSingleValueArrayDeserialization() throws Exception {
             exp = internal;
         }
         final String value = "[" + mapper.writeValueAsString(exp) + "]";
-        
+
         final IOException cloned = mapper.readValue(value, IOException.class);
-        assertEquals(exp.getMessage(), cloned.getMessage());    
-        
-        assertEquals(exp.getStackTrace().length, cloned.getStackTrace().length);
-        for (int i = 0; i < exp.getStackTrace().length; i ++) {
-            _assertEquality(i, exp.getStackTrace()[i], cloned.getStackTrace()[i]);
+        assertEquals(exp.getMessage(), cloned.getMessage());
+
+        _assertEquality(exp.getStackTrace(), cloned.getStackTrace());
+    }
+
+    public void testExceptionCauseDeserialization() throws IOException
+    {
+        ObjectMapper mapper = new ObjectMapper();
+
+        final IOException exp = new IOException("the outer exception", new Throwable("the cause"));
+
+        final String value = mapper.writeValueAsString(exp);
+        final IOException act = mapper.readValue(value, IOException.class);
+
+        assertNotNull(act.getCause());
+        assertEquals(exp.getCause().getMessage(), act.getCause().getMessage());
+        _assertEquality(exp.getCause().getStackTrace(), act.getCause().getStackTrace());
+    }
+
+
+    public void testSuppressedGenericThrowableDeserialization() throws IOException
+    {
+        ObjectMapper mapper = new ObjectMapper();
+
+        final IOException exp = new IOException("the outer exception");
+        exp.addSuppressed(new Throwable("the suppressed exception"));
+
+        final String value = mapper.writeValueAsString(exp);
+        final IOException act = mapper.readValue(value, IOException.class);
+
+        assertNotNull(act.getSuppressed());
+        assertEquals(1, act.getSuppressed().length);
+        assertEquals(exp.getSuppressed()[0].getMessage(), act.getSuppressed()[0].getMessage());
+        _assertEquality(exp.getSuppressed()[0].getStackTrace(), act.getSuppressed()[0].getStackTrace());
+    }
+
+    public void testSuppressedTypedExceptionDeserialization() throws IOException
+    {
+        PolymorphicTypeValidator typeValidator = BasicPolymorphicTypeValidator.builder()
+                .allowIfSubTypeIsArray()
+                .allowIfSubType(Throwable.class)
+                .build();
+
+        ObjectMapper mapper = JsonMapper.builder()
+                .activateDefaultTyping(typeValidator, ObjectMapper.DefaultTyping.NON_FINAL)
+                .build();
+
+        final IOException exp = new IOException("the outer exception");
+        exp.addSuppressed(new IllegalArgumentException("the suppressed exception"));
+
+        final String value = mapper.writeValueAsString(exp);
+        final IOException act = mapper.readValue(value, IOException.class);
+
+        assertNotNull(act.getSuppressed());
+        assertEquals(1, act.getSuppressed().length);
+        assertEquals(IllegalArgumentException.class, act.getSuppressed()[0].getClass());
+        assertEquals(exp.getSuppressed()[0].getMessage(), act.getSuppressed()[0].getMessage());
+        _assertEquality(exp.getSuppressed()[0].getStackTrace(), act.getSuppressed()[0].getStackTrace());
+    }
+
+    private void _assertEquality(StackTraceElement[] exp, StackTraceElement[] act) {
+        assertEquals(exp.length, act.length);
+        for (int i = 0; i < exp.length; i++) {
+            _assertEquality(i, exp[i], act[i]);
         }
     }
 
@@ -145,15 +208,15 @@ protected void _assertEquality(int ix, String prop,
     public void testSingleValueArrayDeserializationException() throws Exception {
         final ObjectMapper mapper = new ObjectMapper();
         mapper.disable(DeserializationFeature.UNWRAP_SINGLE_VALUE_ARRAYS);
-        
+
         final IOException exp;
         try {
             throw new IOException("testing");
         } catch (IOException internal) {
             exp = internal;
         }
         final String value = "[" + mapper.writeValueAsString(exp) + "]";
-        
+
         try {
             mapper.readValue(value, IOException.class);
             fail("Exception not thrown when attempting to deserialize an IOException wrapped in a single value array with UNWRAP_SINGLE_VALUE_ARRAYS disabled");
