Be more lenient when deserializing error parameters (#1085)

Be more lenient when deserializing error parameters

Author: LouisCaubet

errors/src/main/java/com/palantir/conjure/java/api/errors/SerializableError.java

@@ -18,10 +18,15 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.palantir.logsafe.Arg;
 import com.palantir.logsafe.exceptions.SafeIllegalStateException;
+import java.io.IOException;
 import java.io.Serializable;
 import java.util.Map;
 import java.util.Objects;
@@ -82,6 +87,7 @@ public String errorInstanceId() {
     }
 
     /** A set of parameters that further explain the error. */
+    @JsonDeserialize(contentUsing = ParameterDeserializer.class)
     public abstract Map<String, String> parameters();
 
     /**
@@ -129,4 +135,18 @@ public static final class Builder extends ImmutableSerializableError.Builder {}
     public static Builder builder() {
         return new Builder();
     }
+
+    static final class ParameterDeserializer extends JsonDeserializer<String> {
+
+        @Override
+        public String deserialize(JsonParser parser, DeserializationContext _ctxt) throws IOException {
+            JsonNode node = parser.readValueAsTree();
+            String textValue = node.textValue();
+            if (textValue != null) {
+                return textValue;
+            } else {
+                return node.toString();
+            }
+        }
+    }
 }

errors/src/test/java/com/palantir/conjure/java/api/errors/SerializableErrorTest.java

@@ -193,6 +193,61 @@ public void testDeserializationFailsWhenNeitherErrorNameNorMessageIsSet() {
                 .hasNoArgs();
     }
 
+    @Test
+    public void testDeserializeWithJsonObjectParameter() throws Exception {
+        String serialized = "{\"errorCode\":\"PERMISSION_DENIED\",\"errorName\":\"Product:SomethingBroke\","
+                + "\"parameters\":{\"key\":{\"nested\": \"value\"}}}";
+        assertThat(deserialize(serialized))
+                .isEqualTo(SerializableError.builder()
+                        .from(ERROR)
+                        .putParameters("key", "{\"nested\":\"value\"}")
+                        .build());
+    }
+
+    @Test
+    public void testDeserializeWithJsonArrayParameter() throws Exception {
+        String serialized = "{\"errorCode\":\"PERMISSION_DENIED\",\"errorName\":\"Product:SomethingBroke\","
+                + "\"parameters\":{\"key\":[\"nested\"]}}";
+        assertThat(deserialize(serialized))
+                .isEqualTo(SerializableError.builder()
+                        .from(ERROR)
+                        .putParameters("key", "[\"nested\"]")
+                        .build());
+    }
+
+    @Test
+    public void testDeserializeWithJsonBooleanParameter() throws Exception {
+        String serialized = "{\"errorCode\":\"PERMISSION_DENIED\",\"errorName\":\"Product:SomethingBroke\","
+                + "\"parameters\":{\"key\":true}}";
+        assertThat(deserialize(serialized))
+                .isEqualTo(SerializableError.builder()
+                        .from(ERROR)
+                        .putParameters("key", "true")
+                        .build());
+    }
+
+    @Test
+    public void testDeserializeWithJsonNumberParameter() throws Exception {
+        String serialized = "{\"errorCode\":\"PERMISSION_DENIED\",\"errorName\":\"Product:SomethingBroke\","
+                + "\"parameters\":{\"key\":1.1}}";
+        assertThat(deserialize(serialized))
+                .isEqualTo(SerializableError.builder()
+                        .from(ERROR)
+                        .putParameters("key", "1.1")
+                        .build());
+    }
+
+    @Test
+    public void testDeserializeWithJsonStringParameter() throws Exception {
+        String serialized = "{\"errorCode\":\"PERMISSION_DENIED\",\"errorName\":\"Product:SomethingBroke\","
+                + "\"parameters\":{\"key\":\"value\"}}";
+        assertThat(deserialize(serialized))
+                .isEqualTo(SerializableError.builder()
+                        .from(ERROR)
+                        .putParameters("key", "value")
+                        .build());
+    }
+
     private static SerializableError deserialize(String serialized) throws IOException {
         return mapper.readValue(serialized, SerializableError.class);
     }