From eafc60aeefdd35f36cd0f8072665cd4c5402dce1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ianar=C3=A9=20S=C3=A9vi?= Date: Tue, 17 Nov 2026 18:59:22 +0100 Subject: [PATCH] :coffin: remove obsolete v1 workflows --- .betterleaks.toml | 8 ++ .betterleaksignore | 4 - docs/code_samples/workflow_execution.txt | 40 ------ src/main/java/com/mindee/v1/MindeeClient.java | 54 -------- .../java/com/mindee/v1/http/MindeeApiV1.java | 10 -- .../com/mindee/v1/http/MindeeHttpApiV1.java | 56 +------- .../java/com/mindee/v1/FakeMindeeApiV1.java | 9 -- .../com/mindee/v1/workflow/WorkflowIT.java | 21 --- .../com/mindee/v1/workflow/WorkflowTest.java | 120 ------------------ .../java/com/mindee/v2/product/SplitIT.java | 3 +- 10 files changed, 12 insertions(+), 313 deletions(-) create mode 100644 .betterleaks.toml delete mode 100644 docs/code_samples/workflow_execution.txt delete mode 100644 src/test/java/com/mindee/v1/workflow/WorkflowTest.java diff --git a/.betterleaks.toml b/.betterleaks.toml new file mode 100644 index 000000000..cb3c3f1f1 --- /dev/null +++ b/.betterleaks.toml @@ -0,0 +1,8 @@ +[extend] +useDefault = true + +[[allowlists]] +description = "Dummy HMAC secret used in LocalResponse unit tests" +condition = "AND" +paths = ['''^src/test/.*\.java$'''] +regexes = ['''ogNjY44MhvKPGTtVsI8zG82JqWQa68woYQH'''] diff --git a/.betterleaksignore b/.betterleaksignore index d450065dd..640517b2e 100644 --- a/.betterleaksignore +++ b/.betterleaksignore @@ -3,9 +3,5 @@ 50e7a1a5deade5f3ea4f4478211fc29eb36bba86:src/test/java/com/mindee/v2/http/MindeeHttpApiV2Test.java:generic-credential-uri:73 fce24ac9d3dabfdc2ba2cae55a7dd83bbdc32244:src/main/java/com/mindee/input/URLInputSource.java:generic-credential-uri:68 -c17d58ed662f09341863cf80360ad265a8a7077e:src/test/java/com/mindee/v2/parsing/LocalResponseTest.java:generic-api-key:19 -6c390b1b76954f1b42f4acce9e7540a25a39f406:src/test/java/com/mindee/v1/parsing/LocalResponseTest.java:generic-api-key:21 -30192fe5af49c977f9a2680c3b5f2f231a47ff80:src/test/java/com/mindee/input/LocalResponseV2Test.java:generic-api-key:19 503570dd1ca44074c7da2c7f1f060e6eac546ad7:.github/workflows/_publish-code.yml:generic-password:29 -8a437effa2694ed811c09ec4b88af45c5073cda3:src/test/java/com/mindee/input/LocalResponseTest.java:generic-api-key:15 40ebc5e3d6d28e92097f99505aa908df7e557f38:.github/workflows/maven-publish.yml:generic-password:22 diff --git a/docs/code_samples/workflow_execution.txt b/docs/code_samples/workflow_execution.txt deleted file mode 100644 index 719989855..000000000 --- a/docs/code_samples/workflow_execution.txt +++ /dev/null @@ -1,40 +0,0 @@ -import com.mindee.input.LocalInputSource; -import com.mindee.v1.MindeeClient; -import com.mindee.v1.parsing.common.WorkflowResponse; -import com.mindee.v1.product.generated.GeneratedV1; -import com.mindee.v1.http.MindeeHttpExceptionV1; -import java.io.IOException; - -public class SimpleMindeeClientV1 { - - public static void main(String[] args) throws IOException { - String apiKey = "my-api-key"; - String workflowId = "workflow-id"; - String filePath = "/path/to/the/file.ext"; - - // Init a new client - var mindeeClient = new MindeeClient(apiKey); - - // Load a file from disk - var inputSource = new LocalInputSource(filePath); - - // Send the file to a workflow - WorkflowResponse response = mindeeClient.executeWorkflow( - workflowId, - inputSource - ); - - // Alternatively: give an alias to the document - // WorkflowResponse response = mindeeClient.executeWorkflow( - // workflowId, - // inputSource, - // WorkflowOptions.builder().alias("my-alias").build() - // ); - - // Print the workflow ID. - System.out.println(response.getExecution().getId()); - - // Print the inference result. - // System.out.println(response.getExecution().getInference()); - } -} diff --git a/src/main/java/com/mindee/v1/MindeeClient.java b/src/main/java/com/mindee/v1/MindeeClient.java index 632786c76..83c4061b6 100644 --- a/src/main/java/com/mindee/v1/MindeeClient.java +++ b/src/main/java/com/mindee/v1/MindeeClient.java @@ -8,7 +8,6 @@ import com.mindee.pdf.PDFInputOperator; import com.mindee.v1.clientoptions.PollingOptions; import com.mindee.v1.clientoptions.PredictOptions; -import com.mindee.v1.clientoptions.WorkflowOptions; import com.mindee.v1.http.Endpoint; import com.mindee.v1.http.MindeeApiV1; import com.mindee.v1.http.MindeeHttpApiV1; @@ -16,7 +15,6 @@ import com.mindee.v1.parsing.common.AsyncPredictResponse; import com.mindee.v1.parsing.common.Inference; import com.mindee.v1.parsing.common.PredictResponse; -import com.mindee.v1.parsing.common.WorkflowResponse; import com.mindee.v1.product.generated.GeneratedV1; import java.io.IOException; import java.net.URL; @@ -476,58 +474,6 @@ private AsyncPredictResponse enqueueAndParse( ); } - /** - * Send a local file to a workflow execution. - * - * @param workflowId ID of the workflow to send the document to. - * @param localInputSource A local input source file. - * @param workflowOptions Options for the workflow execution. - * @return A workflow response. - * @throws IOException Throws if the file can't be accessed. - */ - public WorkflowResponse executeWorkflow( - String workflowId, - LocalInputSource localInputSource, - WorkflowOptions workflowOptions - ) throws IOException { - return this.mindeeApi - .executeWorkflowPost( - GeneratedV1.class, - workflowId, - RequestParameters - .builder() - .file(localInputSource.getFile()) - .fileName(localInputSource.getFilename()) - .workflowOptions(workflowOptions) - .build() - ); - } - - /** - * Send a local file to a workflow execution. - * - * @param workflowId ID of the workflow to send the document to. - * @param localInputSource A local input source file. - * @return A workflow response. - * @throws IOException Throws if the file can't be accessed. - */ - public WorkflowResponse executeWorkflow( - String workflowId, - LocalInputSource localInputSource - ) throws IOException { - return this.mindeeApi - .executeWorkflowPost( - GeneratedV1.class, - workflowId, - RequestParameters - .builder() - .file(localInputSource.getFile()) - .fileName(localInputSource.getFilename()) - .workflowOptions(WorkflowOptions.builder().build()) - .build() - ); - } - /** * Send a local file to a Standard prediction API and parse the results. * diff --git a/src/main/java/com/mindee/v1/http/MindeeApiV1.java b/src/main/java/com/mindee/v1/http/MindeeApiV1.java index 6858f0926..84da0c0d7 100644 --- a/src/main/java/com/mindee/v1/http/MindeeApiV1.java +++ b/src/main/java/com/mindee/v1/http/MindeeApiV1.java @@ -4,7 +4,6 @@ import com.mindee.v1.parsing.common.AsyncPredictResponse; import com.mindee.v1.parsing.common.Inference; import com.mindee.v1.parsing.common.PredictResponse; -import com.mindee.v1.parsing.common.WorkflowResponse; import java.io.IOException; /** @@ -38,13 +37,4 @@ public abstract PredictResponse predictPost( Endpoint endpoint, RequestParameters requestParameters ) throws IOException; - - /** - * Execute a workflow. - */ - public abstract WorkflowResponse executeWorkflowPost( - Class documentClass, - String workflowId, - RequestParameters requestParameters - ) throws IOException; } diff --git a/src/main/java/com/mindee/v1/http/MindeeHttpApiV1.java b/src/main/java/com/mindee/v1/http/MindeeHttpApiV1.java index 76cfecd36..712eff20e 100644 --- a/src/main/java/com/mindee/v1/http/MindeeHttpApiV1.java +++ b/src/main/java/com/mindee/v1/http/MindeeHttpApiV1.java @@ -11,7 +11,6 @@ import com.mindee.v1.parsing.common.ErrorDetails; import com.mindee.v1.parsing.common.Inference; import com.mindee.v1.parsing.common.PredictResponse; -import com.mindee.v1.parsing.common.WorkflowResponse; import java.io.IOException; import java.net.URISyntaxException; import java.net.URL; @@ -44,7 +43,7 @@ public final class MindeeHttpApiV1 extends MindeeApiV1 { private static final ObjectMapper mapper = JsonMapper.builder().findAndAddModules().build(); private final Function buildProductPredicBasetUrl = this::buildProductPredictBaseUrl; private final Function buildWorkflowPredictBaseUrl = this::buildWorkflowPredictBaseUrl; - private final Function buildWorkflowExecutionBaseUrl = this::buildWorkflowExecutionUrl; + /** * The MindeeSetting needed to make the api call. */ @@ -74,14 +73,9 @@ public final class MindeeHttpApiV1 extends MindeeApiV1 { * Only needs to be set if the api calls need to be directed through internal URLs. */ private final Function documentUrlFromEndpoint; - /** - * The function used to generate the Job status URL for workflow execution calls. - * Only needs to be set if the api calls need to be directed through internal URLs. - */ - private final Function workflowUrlFromId; public MindeeHttpApiV1(MindeeSettings mindeeSettings) { - this(mindeeSettings, null, null, null, null, null, null); + this(mindeeSettings, null, null, null, null, null); } @Builder @@ -91,7 +85,6 @@ private MindeeHttpApiV1( Function urlFromEndpoint, Function asyncUrlFromEndpoint, Function documentUrlFromEndpoint, - Function workflowUrlFromEndpoint, Function asyncUrlFromWorkflow ) { this.mindeeSettings = mindeeSettings; @@ -128,12 +121,6 @@ private MindeeHttpApiV1( this.documentUrlFromEndpoint = this.buildProductPredicBasetUrl .andThen((url) -> url.concat("/documents/queue/")); } - - if (workflowUrlFromEndpoint != null) { - this.workflowUrlFromId = workflowUrlFromEndpoint; - } else { - this.workflowUrlFromId = this.buildWorkflowExecutionBaseUrl; - } } /** @@ -260,41 +247,6 @@ public AsyncPredictResponse predictAsyncPost( } } - /** - * POST a prediction request for a workflow response. - */ - public WorkflowResponse executeWorkflowPost( - Class documentClass, - String workflowId, - RequestParameters requestParameters - ) throws IOException { - - String url = workflowUrlFromId.apply(workflowId); - HttpPost post = buildHttpPost(url, requestParameters); - - JavaType parametricType = mapper - .getTypeFactory() - .constructParametricType(WorkflowResponse.class, documentClass); - try (CloseableHttpClient httpClient = httpClientBuilder.build()) { - return httpClient.execute(post, response -> { - HttpEntity responseEntity = response.getEntity(); - int statusCode = response.getCode(); - if (isInvalidStatusCode(statusCode)) { - throw getHttpError(parametricType, response); - } - if (responseEntity.getContentLength() == 0) { - throw new MindeeException("Empty response from server."); - } - String rawResponse = readRawResponse(responseEntity); - WorkflowResponse mappedResponse = mapper.readValue(rawResponse, parametricType); - mappedResponse.setRawResponse(rawResponse); - return mappedResponse; - }); - } catch (IOException err) { - throw new MindeeException(err.getMessage(), err); - } - } - private MindeeHttpExceptionV1 getHttpError( JavaType parametricType, ClassicHttpResponse response @@ -344,10 +296,6 @@ private String buildWorkflowPredictBaseUrl(String workflowId) { return this.mindeeSettings.getBaseUrl() + "/workflows/" + workflowId; } - private String buildWorkflowExecutionUrl(String workflowId) { - return this.mindeeSettings.getBaseUrl() + "/workflows/" + workflowId + "/executions"; - } - private HttpPost buildHttpPost( String url, RequestParameters requestParameters diff --git a/src/test/java/com/mindee/v1/FakeMindeeApiV1.java b/src/test/java/com/mindee/v1/FakeMindeeApiV1.java index 6eb216b74..15c30631c 100644 --- a/src/test/java/com/mindee/v1/FakeMindeeApiV1.java +++ b/src/test/java/com/mindee/v1/FakeMindeeApiV1.java @@ -59,13 +59,4 @@ public PredictResponse predictPost( ) throws IOException { return (PredictResponse) predictResponse; } - - @Override - public WorkflowResponse executeWorkflowPost( - Class documentClass, - String workflowId, - RequestParameters requestParameters - ) throws IOException { - return (WorkflowResponse) workflowResponse; - } } diff --git a/src/test/java/com/mindee/v1/workflow/WorkflowIT.java b/src/test/java/com/mindee/v1/workflow/WorkflowIT.java index 18c17441c..c4670cd13 100644 --- a/src/test/java/com/mindee/v1/workflow/WorkflowIT.java +++ b/src/test/java/com/mindee/v1/workflow/WorkflowIT.java @@ -5,13 +5,8 @@ import com.mindee.input.LocalInputSource; import com.mindee.v1.MindeeClient; import com.mindee.v1.clientoptions.PredictOptions; -import com.mindee.v1.clientoptions.WorkflowOptions; import com.mindee.v1.parsing.common.AsyncPredictResponse; -import com.mindee.v1.parsing.common.Execution; -import com.mindee.v1.parsing.common.ExecutionPriority; -import com.mindee.v1.parsing.common.WorkflowResponse; import com.mindee.v1.product.financialdocument.FinancialDocumentV1; -import com.mindee.v1.product.generated.GeneratedV1; import java.io.IOException; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; @@ -37,22 +32,6 @@ static void clientSetUp() throws IOException { ); } - @Test - public void givenAWorkflowIdUploadShouldReturnACorrectWorkflowObject() throws IOException { - - WorkflowOptions options = WorkflowOptions - .builder() - .alias("java-" + currentDateTime) - .priority(ExecutionPriority.LOW) - .rag(true) - .build(); - WorkflowResponse response = client - .executeWorkflow(workflowId, financialDocumentInputSource, options); - Execution execution = response.getExecution(); - Assertions.assertEquals("low", execution.getPriority()); - Assertions.assertEquals("java-" + currentDateTime, execution.getFile().getAlias()); - } - @Test public void GivenAWorkflowIdPredictCustomShouldPollAndNotMatchRag() throws IOException, InterruptedException { diff --git a/src/test/java/com/mindee/v1/workflow/WorkflowTest.java b/src/test/java/com/mindee/v1/workflow/WorkflowTest.java deleted file mode 100644 index 68b623ffc..000000000 --- a/src/test/java/com/mindee/v1/workflow/WorkflowTest.java +++ /dev/null @@ -1,120 +0,0 @@ -package com.mindee.v1.workflow; - -import static com.mindee.TestingUtilities.getResourcePath; -import static com.mindee.TestingUtilities.getV1ResourcePath; - -import com.fasterxml.jackson.databind.ObjectMapper; -import com.mindee.input.LocalInputSource; -import com.mindee.v1.FakeMindeeApiV1; -import com.mindee.v1.MindeeClient; -import com.mindee.v1.parsing.common.Execution; -import com.mindee.v1.parsing.common.WorkflowResponse; -import com.mindee.v1.product.generated.GeneratedV1; -import java.io.IOException; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; - -public class WorkflowTest { - - private ObjectMapper objectMapper; - - @BeforeEach - public void setUp() { - objectMapper = new ObjectMapper(); - } - - @Test - void givenAWorkflowMockFileShouldReturnAValidWorkflowObject() throws IOException { - - var workflowResponse = new WorkflowResponse(); - workflowResponse.setExecution(new Execution<>()); - workflowResponse.setApiRequest(null); - - var mindeeClient = new MindeeClient(new FakeMindeeApiV1<>(workflowResponse)); - - WorkflowResponse response = mindeeClient - .executeWorkflow("", new LocalInputSource(getResourcePath("file_types/pdf/blank_1.pdf"))); - - Assertions.assertNotNull(response); - } - - @Test - void sendingADocumentToAnExecutionShouldDeserializeResponseCorrectly() throws IOException { - var workflowResponse = objectMapper - .readValue( - getV1ResourcePath("workflows/success.json").toFile(), - WorkflowResponse.Default.class - ); - var mindeeClient = new MindeeClient(new FakeMindeeApiV1<>(workflowResponse)); - - String workflowId = "07ebf237-ff27-4eee-b6a2-425df4a5cca6"; - var inputSource = new LocalInputSource( - getV1ResourcePath("products/financial_document/default_sample.jpg") - ); - - WorkflowResponse response = mindeeClient.executeWorkflow(workflowId, inputSource); - - Assertions.assertNotNull(response); - Assertions.assertNotNull(response.getApiRequest()); - Assertions.assertNull(response.getExecution().getBatchName()); - Assertions.assertNull(response.getExecution().getCreatedAt()); - Assertions.assertNull(response.getExecution().getFile().getAlias()); - Assertions.assertEquals("default_sample.jpg", response.getExecution().getFile().getName()); - Assertions - .assertEquals("8c75c035-e083-4e77-ba3b-7c3598bd1d8a", response.getExecution().getId()); - Assertions.assertNull(response.getExecution().getInference()); - Assertions.assertEquals("medium", response.getExecution().getPriority()); - Assertions.assertNull(response.getExecution().getReviewedAt()); - Assertions.assertNull(response.getExecution().getReviewedPrediction()); - Assertions.assertEquals("processing", response.getExecution().getStatus()); - Assertions.assertEquals("manual", response.getExecution().getType()); - Assertions - .assertEquals( - "2024-11-13T13:02:31.699190", - response.getExecution().getUploadedAt().toString() - ); - Assertions.assertEquals(workflowId, response.getExecution().getWorkflowId()); - } - - @Test - void sendingADocumentToAnExecutionWithPriorityAndAliasShouldDeserializeResponseCorrectly() throws IOException { - var workflowResponse = objectMapper - .readValue( - getV1ResourcePath("workflows/success_low_priority.json").toFile(), - WorkflowResponse.Default.class - ); - - var mindeeClient = new MindeeClient(new FakeMindeeApiV1<>(workflowResponse)); - - String workflowId = "07ebf237-ff27-4eee-b6a2-425df4a5cca6"; - var inputSource = new LocalInputSource( - getV1ResourcePath("products/financial_document/default_sample.jpg") - ); - - WorkflowResponse response = mindeeClient.executeWorkflow(workflowId, inputSource); - - Assertions.assertNotNull(response); - Assertions.assertNotNull(response.getApiRequest()); - Assertions.assertNull(response.getExecution().getBatchName()); - Assertions.assertNull(response.getExecution().getCreatedAt()); - Assertions - .assertEquals("low-priority-sample-test", response.getExecution().getFile().getAlias()); - Assertions.assertEquals("default_sample.jpg", response.getExecution().getFile().getName()); - Assertions - .assertEquals("b743e123-e18c-4b62-8a07-811a4f72afd3", response.getExecution().getId()); - Assertions.assertNull(response.getExecution().getInference()); - Assertions.assertEquals("low", response.getExecution().getPriority()); - Assertions.assertNull(response.getExecution().getReviewedAt()); - Assertions.assertNull(response.getExecution().getReviewedPrediction()); - Assertions.assertEquals("processing", response.getExecution().getStatus()); - Assertions.assertEquals("manual", response.getExecution().getType()); - Assertions - .assertEquals( - "2024-11-13T13:17:01.315179", - response.getExecution().getUploadedAt().toString() - ); - Assertions.assertEquals(workflowId, response.getExecution().getWorkflowId()); - } - -} diff --git a/src/test/java/com/mindee/v2/product/SplitIT.java b/src/test/java/com/mindee/v2/product/SplitIT.java index 3ed83bc36..f7cb72671 100644 --- a/src/test/java/com/mindee/v2/product/SplitIT.java +++ b/src/test/java/com/mindee/v2/product/SplitIT.java @@ -2,6 +2,7 @@ import static com.mindee.TestingUtilities.getResourcePath; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotNull; import com.mindee.input.LocalInputSource; @@ -62,6 +63,6 @@ void parseFile_emptyMultiPage_mustSucceed() throws IOException, InterruptedExcep var result = inference.getResult(); assertNotNull(result); - assertEquals(1, result.getSplits().size()); + assertFalse(result.getSplits().isEmpty()); } }