🐛! Details property in Error become an object because it can handle both string and object

Author: Kvindee

src/main/java/com/mindee/parsing/common/Error.java

@@ -16,7 +16,7 @@ public class Error {
    * Details about it.
    */
   @JsonProperty("details")
-  private String details;
+  private ErrorDetails details;
   /**
    * More precise information about the current error.
    */

src/main/java/com/mindee/parsing/common/ErrorDetails.java

@@ -0,0 +1,29 @@
+package com.mindee.parsing.common;
+
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import lombok.Getter;
+
+/**
+ * Represent error details.
+ */
+@Getter
+@JsonIgnoreProperties(ignoreUnknown = true)
+@JsonDeserialize(using = ErrorDetailsDeserializer.class)
+public class ErrorDetails {
+
+  /**
+   * More precise information about the current error.
+   */
+  private final String value;
+
+  public ErrorDetails(String details) {
+    this.value = details;
+  }
+
+  @Override
+  public String toString() {
+    return this.value;
+  }
+}

src/main/java/com/mindee/parsing/common/ErrorDetailsDeserializer.java

@@ -0,0 +1,39 @@
+package com.mindee.parsing.common;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+
+import java.io.IOException;
+import java.io.NotSerializableException;
+
+public class ErrorDetailsDeserializer extends StdDeserializer<ErrorDetails> {
+
+  public ErrorDetailsDeserializer(Class<?> vc) {
+    super(vc);
+  }
+
+  public ErrorDetailsDeserializer() {
+    this(null);
+  }
+
+  @Override
+  public ErrorDetails deserialize(JsonParser jsonParser,
+    DeserializationContext deserializationContext) throws IOException {
+
+    JsonNode node = jsonParser.getCodec().readTree(jsonParser);
+    String details;
+
+    if(node.isObject())
+    {
+      details = node.toString();
+    } else if (node.isTextual()) {
+      details = node.textValue();
+    } else {
+      throw new NotSerializableException();
+    }
+
+    return new ErrorDetails(details);
+  }
+}

src/test/java/com/mindee/http/MindeeHttpApiTest.java

@@ -4,6 +4,7 @@
 import com.mindee.MindeeSettings;
 import com.mindee.parsing.common.Document;
 import com.mindee.parsing.invoice.InvoiceV4Inference;
+import com.mindee.utils.MindeeException;
 import junit.framework.TestCase;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
@@ -60,4 +61,27 @@ void givenAResponseFromTheEndpoint_whenDeserialized_mustHaveValidSummary()
     Assertions.assertNotNull(document);
     Assertions.assertEquals(expectedSummary, actualSummary);
   }
+
+  @Test
+  void givenError_withDetailNodeAsAnObject_mustThrowMindeeException()
+    throws IOException {
+
+    String url = String.format("http://localhost:%s", mockWebServer.getPort());
+    Path path = Paths.get("src/test/resources/data/errors/with_object_response_in_detail.json");
+    mockWebServer.enqueue(new MockResponse()
+      .setResponseCode(400)
+      .setBody(new String(Files.readAllBytes(path))));
+
+    File file = new File("src/test/resources/data/invoice/invoice.pdf");
+    MindeeHttpApi client = new MindeeHttpApi(new MindeeSettings("abc", url));
+
+    Assertions.assertThrows(
+      MindeeException.class,
+      () -> client.predict(
+        InvoiceV4Inference.class,
+        ParseParameter.builder()
+          .file(Files.readAllBytes(file.toPath()))
+          .fileName(file.getName())
+          .build()));
+  }
 }

src/test/java/com/mindee/parsing/common/ErrorTest.java

@@ -0,0 +1,44 @@
+package com.mindee.parsing.common;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import junit.framework.TestCase;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+import java.io.IOException;
+
+public class ErrorTest extends TestCase {
+
+  @Test
+  void given_details_as_object_mustBeDeserialized() throws IOException {
+
+    ObjectMapper objectMapper = new ObjectMapper();
+    objectMapper.findAndRegisterModules();
+
+    Error error = objectMapper.readValue(
+      new File("src/test/resources/data/errors/with_object_response_in_detail.json"),
+      Error.class);
+
+    Assertions.assertNotNull(error);
+    Assertions.assertNotNull(error.getDetails());
+    Assertions.assertEquals(
+      "{\"document\":[\"error message\"]}",
+      error.getDetails().toString());
+  }
+
+  @Test
+  void given_details_as_string_mustBeDeserialized() throws IOException {
+
+    ObjectMapper objectMapper = new ObjectMapper();
+    objectMapper.findAndRegisterModules();
+
+    Error error = objectMapper.readValue(
+      new File("src/test/resources/data/errors/with_string_response_in_detail.json"),
+      Error.class);
+
+    Assertions.assertNotNull(error);
+    Assertions.assertNotNull(error.getDetails());
+    Assertions.assertEquals("error message", error.getDetails().toString());
+  }
+}