✨ handle job errors separately from API errors (#150)

Author: ianardee

src/main/java/com/mindee/http/MindeeHttpApi.java

@@ -147,6 +147,18 @@ public <DocT extends Inference> AsyncPredictResponse<DocT> documentQueueGet(
       String rawResponse = readRawResponse(responseEntity);
       AsyncPredictResponse<DocT> mappedResponse = mapper.readValue(rawResponse, type);
       mappedResponse.setRawResponse(rawResponse);
+      if (
+          mappedResponse.getJob() != null
+          && mappedResponse.getJob().getError() != null
+          && mappedResponse.getJob().getError().getCode() != null
+      ) {
+        throw new MindeeHttpException(
+          500,
+          mappedResponse.getJob().getError().getMessage(),
+          mappedResponse.getJob().getError().getDetails().toString(),
+          mappedResponse.getJob().getError().getCode()
+        );
+      }
       return mappedResponse;
     } catch (IOException err) {
       throw new MindeeException(err.getMessage(), err);

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

@@ -16,7 +16,7 @@
 public class ApiRequest {
 
   /**
-   * Represent an error information from the API response.
+   * Information about an error that occurred during the API request.
    */
   @JsonProperty("error")
   private Error error;

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

@@ -14,7 +14,7 @@
 @EqualsAndHashCode
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class Cropper {
-  /*
+  /**
    * List of positions within the image.
    */
   @JsonProperty("cropping")

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

@@ -5,7 +5,7 @@
 import lombok.Getter;
 
 /**
- * Represent an error information from the API response.
+ * Error information from an API response.
  */
 @Getter
 @JsonIgnoreProperties(ignoreUnknown = true)

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

@@ -12,7 +12,7 @@
 @EqualsAndHashCode
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class Extras {
-  /*
+  /**
    * Cropping result.
    */
   @JsonProperty("cropper")

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

@@ -28,27 +28,36 @@
 @NoArgsConstructor
 public class Job {
 
-  /*
+  /**
    * The time at which the job finished
    */
   @JsonProperty("available_at")
   @JsonDeserialize(using = LocalDateTimeDeserializer.class)
   private LocalDateTime availableAt;
-  /*
+
+  /**
    * Identifier for the job
    */
   private String id;
-  /*
+
+  /**
    * The time at which the job started
    */
   @JsonProperty("issued_at")
   @JsonDeserialize(using = LocalDateTimeDeserializer.class)
   private LocalDateTime issuedAt;
-  /*
+
+  /**
    * Job Status
    */
   private String status;
 
+  /**
+   * Information about an error that occurred during the job processing.
+   */
+  @JsonProperty("error")
+  private Error error;
+
   /**
    * Private Deserializer for LocalDateTime
    */

src/test/java/com/mindee/MindeeClientTest.java

@@ -285,7 +285,7 @@ void givenAnAsyncDoc_whenEnqueued_shouldInvokeApiCorrectly() throws IOException
     File file = new File("src/test/resources/file_types/pdf/blank_1.pdf");
     LocalInputSource localInputSource = new LocalInputSource(file);
 
-    Job job = new Job(LocalDateTime.now(),"someid",LocalDateTime.now(),"Completed");
+    Job job = new Job(LocalDateTime.now(), "someid", LocalDateTime.now(), "Completed", null);
     AsyncPredictResponse predictResponse = new AsyncPredictResponse();
     predictResponse.setDocument(new Document<>());
     predictResponse.setApiRequest(null);
@@ -325,7 +325,7 @@ void givenAnAsyncDoc_whenEnqueuedNoParams_shouldInvokeApiCorrectly() throws IOEx
     File file = new File("src/test/resources/file_types/pdf/blank_1.pdf");
     LocalInputSource localInputSource = new LocalInputSource(file);
 
-    Job job = new Job(LocalDateTime.now(),"someid",LocalDateTime.now(),"Completed");
+    Job job = new Job(LocalDateTime.now(), "someid", LocalDateTime.now(), "Completed", null);
     AsyncPredictResponse predictResponse = new AsyncPredictResponse();
     predictResponse.setDocument(new Document<>());
     predictResponse.setApiRequest(null);
@@ -361,7 +361,7 @@ void givenAnAsyncDoc_whenEnqueuedNoParams_shouldInvokeApiCorrectly() throws IOEx
   @Test
   void givenAnAsyncUrl_whenEnqueued_shouldInvokeApiCorrectly() throws IOException {
 
-    Job job = new Job(LocalDateTime.now(),"someid",LocalDateTime.now(),"completed");
+    Job job = new Job(LocalDateTime.now(), "someid", LocalDateTime.now(), "completed", null);
     AsyncPredictResponse predictResponse = new AsyncPredictResponse();
     predictResponse.setDocument(new Document<>());
     predictResponse.setApiRequest(null);

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

@@ -40,10 +40,7 @@ void whenAsyncPost_returnsErrorForbidden_mustBeDeserialized() throws IOException
     Assertions.assertNotNull(response);
     Assertions.assertEquals("failure", response.getApiRequest().getStatus());
     Assertions.assertEquals(403, response.getApiRequest().getStatusCode());
-    Assertions.assertNull(response.getJob().getStatus());
-    Assertions.assertEquals("2023-01-01T00:00", response.getJob().getIssuedAt().toString());
-    Assertions.assertNull(response.getJob().getAvailableAt());
-    Assertions.assertFalse(response.getDocument().isPresent());
+    Assertions.assertNull(response.getJob());
   }
 
   @Test
@@ -87,4 +84,18 @@ void whenAsyncGet_returnsCompleted_mustBeDeserialized() throws IOException {
     Assertions.assertEquals(2, response.getDocumentObj().getNPages());
   }
 
+  @Test
+  void whenAsyncGet_returnsJobFailed_mustBeDeserialized() throws IOException {
+    AsyncPredictResponse<InvoiceSplitterV1> response = loadAsyncResponse(
+      "src/test/resources/async/get_failed_job_error.json"
+    );
+    Assertions.assertNotNull(response);
+    Assertions.assertEquals("success", response.getApiRequest().getStatus());
+    Assertions.assertEquals(200, response.getApiRequest().getStatusCode());
+    Assertions.assertEquals("failed", response.getJob().getStatus());
+    Assertions.assertEquals("ServerError", response.getJob().getError().getCode());
+    Assertions.assertEquals("2024-02-20T10:31:06.878599", response.getJob().getIssuedAt().toString());
+    Assertions.assertEquals("2024-02-20T10:31:06.878599", response.getJob().getAvailableAt().toString());
+    Assertions.assertFalse(response.getDocument().isPresent());
+  }
 }