Add describeWorkflow method in Client (#184)

Co-authored-by: Kaili Zhu <kzhu@indeed.com>

Author: zklgame

src/main/java/io/iworkflow/core/Client.java

@@ -7,6 +7,7 @@
 import io.iworkflow.gen.models.SearchAttributeValueType;
 import io.iworkflow.gen.models.StateCompletionOutput;
 import io.iworkflow.gen.models.WorkflowGetDataObjectsResponse;
+import io.iworkflow.gen.models.WorkflowGetResponse;
 import io.iworkflow.gen.models.WorkflowGetSearchAttributesResponse;
 import io.iworkflow.gen.models.WorkflowSearchRequest;
 import io.iworkflow.gen.models.WorkflowSearchResponse;
@@ -569,6 +570,23 @@ public Map<String, Object> getWorkflowSearchAttributes(
         return doGetWorkflowSearchAttributes(workflowClass, workflowId, workflowRunId, attributeKeys);
     }
 
+    /**
+     * Describe a workflow to get its info.
+     * If the workflow does not exist, throw the WORKFLOW_NOT_EXISTS_SUB_STATUS exception.
+     *
+     * @param workflowId    required
+     * @param workflowRunId optional
+     * @return the workflow's info
+     */
+    public WorkflowInfo describeWorkflow(
+            final String workflowId,
+            final String workflowRunId) {
+        final WorkflowGetResponse response = unregisteredClient.getWorkflow(workflowId, workflowRunId, false);
+        return WorkflowInfo.builder()
+                .workflowStatus(response.getWorkflowStatus())
+                .build();
+    }
+
     public Map<String, Object> getAllSearchAttributes(
             final Class<? extends ObjectWorkflow> workflowClass,
             final String workflowId,

src/main/java/io/iworkflow/core/UnregisteredClient.java

@@ -403,6 +403,31 @@ public WorkflowGetDataObjectsResponse getAnyWorkflowDataObjects(
         return getAnyWorkflowDataObjects(workflowId, workflowRunId, attributeKeys, false);
     }
 
+    /**
+     * Get a workflow's status and results(if completed & requested).
+     * If the workflow does not exist, throw the WORKFLOW_NOT_EXISTS_SUB_STATUS exception.
+     *
+     * @param workflowId    required
+     * @param workflowRunId optional
+     * @param needsResults  result will be returned if this is true and workflow is completed
+     * @return the workflow's status and results
+     */
+    public WorkflowGetResponse getWorkflow(
+            final String workflowId,
+            final String workflowRunId,
+            final Boolean needsResults) {
+        try {
+            return defaultApi.apiV1WorkflowGetPost(
+                    new WorkflowGetRequest()
+                            .workflowId(workflowId)
+                            .workflowRunId(workflowRunId)
+                            .needsResults(needsResults)
+            );
+        } catch (final FeignException.FeignClientException exp) {
+            throw IwfHttpException.fromFeignException(clientOptions.getObjectEncoder(), exp);
+        }
+    }
+
     public WorkflowGetDataObjectsResponse getAnyWorkflowDataObjects(
             final String workflowId,
             final String workflowRunId,

src/main/java/io/iworkflow/core/WorkflowInfo.java

@@ -0,0 +1,13 @@
+package io.iworkflow.core;
+
+import io.iworkflow.gen.models.WorkflowStatus;
+import org.immutables.value.Value;
+
+@Value.Immutable
+public abstract class WorkflowInfo {
+    public abstract WorkflowStatus getWorkflowStatus();
+
+    public static ImmutableWorkflowInfo.Builder builder() {
+        return ImmutableWorkflowInfo.builder();
+    }
+}

src/test/java/io/iworkflow/integ/BasicTest.java

@@ -7,11 +7,13 @@
 import io.iworkflow.core.ImmutableWorkflowOptions;
 import io.iworkflow.core.UnregisteredWorkflowOptions;
 import io.iworkflow.core.WorkflowDefinitionException;
+import io.iworkflow.core.WorkflowInfo;
 import io.iworkflow.core.WorkflowOptions;
 import io.iworkflow.gen.models.Context;
 import io.iworkflow.gen.models.ErrorSubStatus;
 import io.iworkflow.gen.models.IDReusePolicy;
 import io.iworkflow.gen.models.WorkflowConfig;
+import io.iworkflow.gen.models.WorkflowStatus;
 import io.iworkflow.integ.basic.BasicWorkflow;
 import io.iworkflow.integ.basic.EmptyInputWorkflow;
 import io.iworkflow.integ.basic.EmptyInputWorkflowState1;
@@ -125,4 +127,27 @@ public void testWorkflowConfigOverride() throws InterruptedException {
         final Integer output = client.getSimpleWorkflowResultWithWait(Integer.class, wfId);
         Assertions.assertEquals(input + 2, output);
     }
+
+    @Test
+    public void testGetWorkflowStatusWhenNoExistingWorkflow() {
+        final Client client = new Client(WorkflowRegistry.registry, ClientOptions.localDefault);
+        final String wfId = "wf-get-workflow-status-test-id" + System.currentTimeMillis() / 1000;
+
+        try {
+            client.describeWorkflow(wfId, "");
+        } catch (final ClientSideException e) {
+            Assertions.assertEquals(ErrorSubStatus.WORKFLOW_NOT_EXISTS_SUB_STATUS, e.getErrorSubStatus());
+            Assertions.assertEquals(400, e.getStatusCode());
+        }
+    }
+
+    @Test
+    public void testGetWorkflowStatusWhenWorkflowIsRunning() {
+        final Client client = new Client(WorkflowRegistry.registry, ClientOptions.localDefault);
+        final String wfId = "wf-get-workflow-status-running-test-id" + System.currentTimeMillis() / 1000;
+
+        client.startWorkflow(BasicWorkflow.class, wfId, 10, null, null);
+        final WorkflowInfo workflowInfo = client.describeWorkflow(wfId, "");
+        Assertions.assertEquals(WorkflowStatus.RUNNING, workflowInfo.getWorkflowStatus());
+    }
 }