apply pull request suggestions

Signed-off-by: Matheus Cruz <[email protected]>

Author: mcruzdev

examples/src/main/java/io/dapr/examples/workflows/chain/DemoChainClient.java

@@ -16,7 +16,7 @@
 import io.dapr.examples.workflows.utils.PropertyUtils;
 import io.dapr.examples.workflows.utils.RetryUtils;
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowState;
 
 import java.time.Duration;
 import java.util.concurrent.TimeoutException;
@@ -34,10 +34,10 @@ public static void main(String[] args) {
           Duration.ofSeconds(60));
 
       System.out.printf("Started a new chaining model workflow with instance ID: %s%n", instanceId);
-      WorkflowInstanceStatus workflowInstanceStatus =
+      WorkflowState workflowState =
           client.waitForWorkflowCompletion(instanceId, null, true);
 
-      String result = workflowInstanceStatus.readOutputAs(String.class);
+      String result = workflowState.readOutputAs(String.class);
       System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
     } catch (TimeoutException | InterruptedException e) {
       throw new RuntimeException(e);

examples/src/main/java/io/dapr/examples/workflows/childworkflow/DemoChildWorkerflowClient.java

@@ -15,7 +15,7 @@
 
 import io.dapr.examples.workflows.utils.PropertyUtils;
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowState;
 
 import java.util.concurrent.TimeoutException;
 
@@ -30,10 +30,10 @@ public static void main(String[] args) {
     try (DaprWorkflowClient client = new DaprWorkflowClient(PropertyUtils.getProperties(args))) {
       String instanceId = client.scheduleNewWorkflow(DemoWorkflow.class);
       System.out.printf("Started a new child-workflow model workflow with instance ID: %s%n", instanceId);
-      WorkflowInstanceStatus workflowInstanceStatus =
+      WorkflowState workflowState =
           client.waitForWorkflowCompletion(instanceId, null, true);
 
-      String result = workflowInstanceStatus.readOutputAs(String.class);
+      String result = workflowState.readOutputAs(String.class);
       System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
 
     } catch (TimeoutException | InterruptedException e) {

examples/src/main/java/io/dapr/examples/workflows/compensation/BookTripClient.java

@@ -16,7 +16,7 @@
 import io.dapr.examples.workflows.utils.PropertyUtils;
 import io.dapr.examples.workflows.utils.RetryUtils;
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowState;
 
 import java.time.Duration;
 import java.util.concurrent.TimeoutException;
@@ -27,7 +27,7 @@ public static void main(String[] args) {
             String instanceId = RetryUtils.callWithRetry(() -> client.scheduleNewWorkflow(BookTripWorkflow.class), Duration.ofSeconds(60));
             System.out.printf("Started a new trip booking workflow with instance ID: %s%n", instanceId);
 
-            WorkflowInstanceStatus status = client.waitForWorkflowCompletion(instanceId, Duration.ofMinutes(30), true);
+            WorkflowState status = client.waitForWorkflowCompletion(instanceId, Duration.ofMinutes(30), true);
             System.out.printf("Workflow instance with ID: %s completed with status: %s%n", instanceId, status);
             System.out.printf("Workflow output: %s%n", status.getSerializedOutput());
         } catch (TimeoutException | InterruptedException e) {

examples/src/main/java/io/dapr/examples/workflows/faninout/DemoFanInOutClient.java

@@ -16,7 +16,7 @@
 import io.dapr.examples.workflows.utils.PropertyUtils;
 import io.dapr.examples.workflows.utils.RetryUtils;
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowState;
 
 import java.time.Duration;
 import java.util.Arrays;
@@ -48,12 +48,12 @@ public static void main(String[] args) throws InterruptedException {
       System.out.printf("Started a new fan out/fan in model workflow with instance ID: %s%n", instanceId);
 
       // Block until the orchestration completes. Then print the final status, which includes the output.
-      WorkflowInstanceStatus workflowInstanceStatus = client.waitForWorkflowCompletion(
+      WorkflowState workflowState = client.waitForWorkflowCompletion(
           instanceId,
           Duration.ofSeconds(30),
           true);
       System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId,
-          workflowInstanceStatus.readOutputAs(int.class));
+          workflowState.readOutputAs(int.class));
     } catch (TimeoutException e) {
       throw new RuntimeException(e);
     }

examples/src/main/java/io/dapr/examples/workflows/multiapp/MultiAppWorkflowClient.java

@@ -14,7 +14,7 @@
 package io.dapr.examples.workflows.multiapp;
 
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowState;
 
 import java.util.concurrent.TimeoutException;
 
@@ -48,7 +48,7 @@ public static void main(String[] args) {
 
       // Wait for the workflow to complete
       System.out.println("Waiting for workflow completion...");
-      WorkflowInstanceStatus workflowInstanceStatus = 
+      WorkflowState workflowInstanceStatus =
           client.waitForWorkflowCompletion(instanceId, null, true);
 
       // Get the result

examples/src/main/java/io/dapr/examples/workflows/suspendresume/DemoSuspendResumeClient.java

@@ -17,7 +17,7 @@
 import io.dapr.examples.workflows.utils.PropertyUtils;
 import io.dapr.examples.workflows.utils.RetryUtils;
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowState;
 
 import java.time.Duration;
 import java.util.concurrent.TimeoutException;
@@ -38,7 +38,7 @@ public static void main(String[] args) {
       System.out.printf("Suspending Workflow Instance: %s%n", instanceId );
       client.suspendWorkflow(instanceId, "suspending workflow instance.");
 
-      WorkflowInstanceStatus instanceState = client.getWorkflowState(instanceId, false);
+      WorkflowState instanceState = client.getWorkflowState(instanceId, false);
       assert instanceState != null;
       System.out.printf("Workflow Instance Status: %s%n", instanceState.getRuntimeStatus().name() );
 

sdk-tests/src/test/java/io/dapr/it/testcontainers/workflows/DaprWorkflowsIT.java

@@ -20,8 +20,8 @@
 import io.dapr.testcontainers.DaprContainer;
 import io.dapr.testcontainers.DaprLogLevel;
 import io.dapr.workflows.client.DaprWorkflowClient;
-import io.dapr.workflows.client.WorkflowInstanceStatus;
 import io.dapr.workflows.client.WorkflowRuntimeStatus;
+import io.dapr.workflows.client.WorkflowState;
 import io.dapr.workflows.runtime.WorkflowRuntime;
 import io.dapr.workflows.runtime.WorkflowRuntimeBuilder;
 import org.junit.jupiter.api.BeforeEach;
@@ -108,7 +108,7 @@ public void testWorkflows() throws Exception {
     workflowClient.raiseEvent(instanceId, "MoveForward", payload);
 
     Duration timeout = Duration.ofSeconds(10);
-    WorkflowInstanceStatus workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);
+    WorkflowState workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);
 
     assertNotNull(workflowStatus);
 
@@ -129,7 +129,7 @@ public void testSuspendAndResumeWorkflows() throws Exception {
     workflowClient.suspendWorkflow(instanceId, "testing suspend.");
 
 
-    WorkflowInstanceStatus instanceState = workflowClient.getWorkflowState(instanceId, false);
+    WorkflowState instanceState = workflowClient.getWorkflowState(instanceId, false);
     assertNotNull(instanceState);
     assertEquals(WorkflowRuntimeStatus.SUSPENDED, instanceState.getRuntimeStatus());
 
@@ -157,7 +157,7 @@ public void testNamedActivitiesWorkflows() throws Exception {
     workflowClient.waitForWorkflowStart(instanceId, Duration.ofSeconds(10), false);
 
     Duration timeout = Duration.ofSeconds(10);
-    WorkflowInstanceStatus workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);
+    WorkflowState workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);
 
     assertNotNull(workflowStatus);
 
@@ -181,7 +181,7 @@ public void testExecutionKeyWorkflows() throws Exception {
     workflowClient.waitForWorkflowStart(instanceId, Duration.ofSeconds(100), false);
 
     Duration timeout = Duration.ofSeconds(1000);
-    WorkflowInstanceStatus workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);
+    WorkflowState workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);
 
     assertNotNull(workflowStatus);
 

sdk-workflows/src/main/java/io/dapr/workflows/client/DaprWorkflowClient.java

@@ -23,6 +23,7 @@
 import io.dapr.workflows.Workflow;
 import io.dapr.workflows.internal.ApiTokenClientInterceptor;
 import io.dapr.workflows.runtime.DefaultWorkflowInstanceStatus;
+import io.dapr.workflows.runtime.DefaultWorkflowState;
 import io.grpc.ClientInterceptor;
 import io.grpc.ManagedChannel;
 
@@ -184,10 +185,10 @@ public WorkflowInstanceStatus getInstanceState(String instanceId, boolean getInp
    * @return a metadata record that describes the workflow instance and it execution status, or a default instance
    */
   @Nullable
-  public WorkflowInstanceStatus getWorkflowState(String instanceId, boolean getInputsAndOutputs) {
+  public WorkflowState getWorkflowState(String instanceId, boolean getInputsAndOutputs) {
     OrchestrationMetadata metadata = this.innerClient.getInstanceMetadata(instanceId, getInputsAndOutputs);
 
-    return metadata == null ? null : new DefaultWorkflowInstanceStatus(metadata);
+    return metadata == null ? null : new DefaultWorkflowState(metadata);
   }
 
   /**
@@ -221,7 +222,7 @@ public WorkflowInstanceStatus waitForInstanceStart(String instanceId, Duration t
 
   /**
    * Waits for a workflow to start running and returns an
-   * {@link WorkflowInstanceStatus} object that contains metadata about the started
+   * {@link WorkflowState} object that contains metadata about the started
    * instance and optionally its input, output, and custom status payloads.
    *
    * <p>A "started" workflow instance is any instance not in the Pending state.
@@ -237,12 +238,12 @@ public WorkflowInstanceStatus waitForInstanceStart(String instanceId, Duration t
    * @throws TimeoutException when the workflow instance is not started within the specified amount of time
    */
   @Nullable
-  public WorkflowInstanceStatus waitForWorkflowStart(String instanceId, Duration timeout, boolean getInputsAndOutputs)
+  public DefaultWorkflowState waitForWorkflowStart(String instanceId, Duration timeout, boolean getInputsAndOutputs)
       throws TimeoutException {
 
     OrchestrationMetadata metadata = this.innerClient.waitForInstanceStart(instanceId, timeout, getInputsAndOutputs);
 
-    return metadata == null ? null : new DefaultWorkflowInstanceStatus(metadata);
+    return metadata == null ? null : new DefaultWorkflowState(metadata);
   }
 
   /**
@@ -277,7 +278,7 @@ public WorkflowInstanceStatus waitForInstanceCompletion(String instanceId, Durat
 
 
   /**
-   * Waits for an workflow to complete and returns an {@link WorkflowInstanceStatus} object that contains
+   * Waits for an workflow to complete and returns an {@link WorkflowState} object that contains
    * metadata about the completed instance.
    *
    * <p>A "completed" workflow instance is any instance in one of the terminal states. For example, the
@@ -296,12 +297,12 @@ public WorkflowInstanceStatus waitForInstanceCompletion(String instanceId, Durat
    * @throws TimeoutException when the workflow instance is not completed within the specified amount of time
    */
   @Nullable
-  public WorkflowInstanceStatus waitForWorkflowCompletion(String instanceId, Duration timeout,
+  public WorkflowState waitForWorkflowCompletion(String instanceId, Duration timeout,
                                                           boolean getInputsAndOutputs) throws TimeoutException {
 
     OrchestrationMetadata metadata = this.innerClient.waitForInstanceCompletion(instanceId, timeout,
         getInputsAndOutputs);
-    return metadata == null ? null : new DefaultWorkflowInstanceStatus(metadata);
+    return metadata == null ? null : new DefaultWorkflowState(metadata);
   }
 
   /**
@@ -320,7 +321,9 @@ public void raiseEvent(String workflowInstanceId, String eventName, Object event
    *
    * @param workflowInstanceId The unique ID of the workflow instance to purge.
    * @return Return true if the workflow state was found and purged successfully otherwise false.
+   * @deprecated Use {@link #purgeWorkflow(String)} instead.
    */
+  @Deprecated(forRemoval = true)
   public boolean purgeInstance(String workflowInstanceId) {
     PurgeResult result = this.innerClient.purgeInstance(workflowInstanceId);
 
@@ -331,6 +334,22 @@ public boolean purgeInstance(String workflowInstanceId) {
     return false;
   }
 
+  /**
+   * Purges workflow instance state from the workflow state store.
+   *
+   * @param workflowInstanceId The unique ID of the workflow instance to purge.
+   * @return Return true if the workflow state was found and purged successfully otherwise false.
+   */
+  public boolean purgeWorkflow(String workflowInstanceId) {
+    PurgeResult result = this.innerClient.purgeInstance(workflowInstanceId);
+
+    if (result != null) {
+      return result.getDeletedInstanceCount() > 0;
+    }
+
+    return false;
+  }
+
   /**
    * Closes the inner DurableTask client and shutdown the GRPC channel.
    */

sdk-workflows/src/main/java/io/dapr/workflows/client/WorkflowInstanceStatus.java

@@ -20,7 +20,9 @@
 /**
  * Represents a snapshot of a workflow instance's current state, including
  * metadata.
+ * @deprecated Use {@link WorkflowState} instead.
  */
+@Deprecated(forRemoval = true)
 public interface WorkflowInstanceStatus {
 
   /**