Update dapr workflow example to be quickstart

examples/src/main/java/io/dapr/examples/workflows/README.md

@@ -4,12 +4,16 @@ In this example, we'll use Dapr to test workflow features.
 
 Visit [the Workflow documentation landing page](https://docs.dapr.io/developing-applications/building-blocks/workflow) for more information.
 
-This example contains the follow classes:
+This example contains the two parts :
+
+1. WorkflowConsoleApp
+
+  It utilizes the workflow SDK as well as the workflow management API for starting workflows instances. The main WorkflowConsoleApp.java file contains the main setup of the app, including the registration of the workflow and workflow activities. The workflow definition is found in the workflows package and the workflow activity definitions are found in the activities package. All the models used by workflow activities are in models package.
+
+2. WorkflowClient
+
+  It scheduales an instance of the OrderProcessingWorkflow (defined in the console package), starts it, and waits for the workflow result and output. 
 
-* DemoWorkflow: An example of a Dapr Workflow.
-* DemoWorkflowClient: This application will start workflows using Dapr.
-* DemoWorkflowWorker: An application that registers a workflow to the Dapr workflow runtime engine. It also executes the workflow instance.
-
 ## Pre-requisites
 
 * [Dapr and Dapr Cli](https://docs.dapr.io/getting-started/install-dapr/).
@@ -43,36 +47,44 @@ cd examples
 
 ### Running the demo Workflow worker
 
-The first Java class to consider is `DemoWorkflowWorker`. Its job is to register an implementation of `DemoWorkflow` in the Dapr's workflow runtime engine. In `DemoWorkflowWorker.java` file, you will find the `DemoWorkflowWorker` class and the `main` method. See the code snippet below:
+The first Java class to consider is `WorkflowConsoleApp`. Its job is to register an implementation of `OrderProcessingWorkflow` in the Dapr's workflow runtime engine. In `WorkflowConsoleApp.java` file, you will find the `WorkflowConsoleApp` class and the `main` method. See the code snippet below:
 
 ```java
-public class DemoWorkflowWorker {
-
+public class WorkflowConsoleApp {
   public static void main(String[] args) throws Exception {
-    // Register the Workflow with the runtime.
-    WorkflowRuntime.getInstance().registerWorkflow(DemoWorkflow.class);
-    System.out.println("Start workflow runtime");
-    WorkflowRuntime.getInstance().startAndBlock();
+    WorkflowRuntimeBuilder builder = new WorkflowRuntimeBuilder().registerWorkflow(OrderProcessingWorkflow.class);
+    builder.registerActivity(NotifyActivity.class);
+    builder.registerActivity(ProcessPaymentActivity.class);
+    builder.registerActivity(RequestApprovalActivity.class);
+    builder.registerActivity(ReserveInventoryActivity.class);
+    builder.registerActivity(UpdateInventoryActivity.class);
+
+    // Build and then start the workflow runtime pulling and executing tasks
+    try (WorkflowRuntime runtime = builder.build()) {
+      System.out.println("Start workflow runtime");
+      runtime.start();
+    }
+
     System.exit(0);
   }
 }
 ```
 
-This application uses `WorkflowRuntime.getInstance().registerWorkflow()` in order to register `DemoWorkflow` as a Workflow in the Dapr Workflow runtime.
+This application uses WorkflowRuntimeBuilder class to build up Dapr workflow runtime. `registerWorkflow()` method is used to register `OrderProcessingWorkflow` as a Workflow in the Dapr Workflow runtime, and `registerActivity()` method is used to register all the activities in `OrderProcessingWorkflow`.
 
-`WorkflowRuntime.getInstance().start()` method will build and start the engine within the Dapr workflow runtime.
+`runtime.start()` method will start the engine within the Dapr workflow runtime.
 
-Now, execute the following script in order to run DemoWorkflowWorker:
+Now, execute the following script in order to run WorkflowConsoleApp:
 ```sh
-dapr run --app-id demoworkflowworker --resources-path ./components/workflows --dapr-grpc-port 50001 -- java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.workflows.DemoWorkflowWorker
+dapr run --app-id WorkflowConsoleApp --resources-path ./components/workflows --dapr-grpc-port 50001 -- java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.workflows.console.WorkflowConsoleApp
 ```
 
 ### Running the Workflow client
 
-The `DemoWorkflowClient` starts instances of workflows that have been registered with Dapr.
+The `WorkflowClient` starts instances of OrderProcessingWorkflow that had been registered with Dapr.
 
-With the DemoWorkflowWorker running, use the follow command to start the workflow with the DemoWorkflowClient:
+With the WorkflowConsoleApp running, use the follow command to start the workflow with the WorkflowClient:
 
 ```sh
-java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.workflows.DemoWorkflowClient
+java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.workflows.client.WorkflowClient
 ```

examples/src/main/java/io/dapr/examples/workflows/client/WorkflowClient.java

@@ -0,0 +1,51 @@
+package io.dapr.examples.workflows.client;
+
+import java.time.Duration;
+import java.util.concurrent.TimeoutException;
+import io.dapr.examples.workflows.console.models.OrderPayload;
+import io.dapr.examples.workflows.console.workflows.OrderProcessingWorkflow;
+import io.dapr.workflows.client.DaprWorkflowClient;
+import io.dapr.workflows.client.WorkflowInstanceStatus;
+
+public class WorkflowClient {
+
+  public static void main(String[] args) throws InterruptedException {
+    DaprWorkflowClient client = new DaprWorkflowClient();
+    try (client) {
+      testWorkflow(client);
+    }
+  }
+
+  private static void testWorkflow(DaprWorkflowClient client) {
+    // schedule Workflow to order two intel i7 13900KS CPUs
+    OrderPayload order = new OrderPayload();
+    order.setName("intel-i7-13900KS");
+    order.setTotalCost(9000);
+    order.setQuantity(2);
+    String instanceId = client.scheduleNewWorkflow(OrderProcessingWorkflow.class, order);
+    System.out.printf("scheduled new workflow instance of OrderProcessingWorkflow with instance ID: %s%n",
+        instanceId);
+
+    try {
+      client.waitForInstanceStart(instanceId, Duration.ofSeconds(10), false);
+      System.out.printf("workflow instance %s started%n", instanceId);
+    } catch (TimeoutException e) {
+      System.out.printf("workflow instance %s did not start within 10 seconds%n", instanceId);
+      return;
+    }
+
+    try {
+      WorkflowInstanceStatus workflowStatus = client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(30),
+          true);
+      if (workflowStatus != null) {
+        System.out.printf("workflow instance %s completed, out is: %s %n", instanceId,
+            workflowStatus.getSerializedOutput());
+      } else {
+        System.out.printf("workflow instance %s not found%n", instanceId);
+      }
+    } catch (TimeoutException e) {
+      System.out.printf("workflow instance %s did not complete within 30 seconds%n", instanceId);
+    }
+  }
+
+}

examples/src/main/java/io/dapr/examples/workflows/DemoWorkflowWorker.java → examples/src/main/java/io/dapr/examples/workflows/console/WorkflowConsoleApp.java

@@ -11,26 +11,33 @@
 limitations under the License.
 */
 
-package io.dapr.examples.workflows;
+package io.dapr.examples.workflows.console;
 
+import io.dapr.examples.workflows.console.activities.NotifyActivity;
+import io.dapr.examples.workflows.console.activities.ProcessPaymentActivity;
+import io.dapr.examples.workflows.console.activities.RequestApprovalActivity;
+import io.dapr.examples.workflows.console.activities.ReserveInventoryActivity;
+import io.dapr.examples.workflows.console.activities.UpdateInventoryActivity;
+import io.dapr.examples.workflows.console.workflows.OrderProcessingWorkflow;
 import io.dapr.workflows.runtime.WorkflowRuntime;
 import io.dapr.workflows.runtime.WorkflowRuntimeBuilder;
 
-/**
- * For setup instructions, see the README.
- */
-public class DemoWorkflowWorker {
+public class WorkflowConsoleApp {
 
   /**
-   * The main method of this app.
+   * The main method of this console app.
    *
    * @param args The port the app will listen on.
    * @throws Exception An Exception.
    */
   public static void main(String[] args) throws Exception {
-    // Register the Workflow with the builder.
-    WorkflowRuntimeBuilder builder = new WorkflowRuntimeBuilder().registerWorkflow(DemoWorkflow.class);
-    builder.registerActivity(DemoWorkflowActivity.class);
+    // Register the OrderProcessingWorkflow and its activities with the builder.
+    WorkflowRuntimeBuilder builder = new WorkflowRuntimeBuilder().registerWorkflow(OrderProcessingWorkflow.class);
+    builder.registerActivity(NotifyActivity.class);
+    builder.registerActivity(ProcessPaymentActivity.class);
+    builder.registerActivity(RequestApprovalActivity.class);
+    builder.registerActivity(ReserveInventoryActivity.class);
+    builder.registerActivity(UpdateInventoryActivity.class);
 
     // Build and then start the workflow runtime pulling and executing tasks
     try (WorkflowRuntime runtime = builder.build()) {

examples/src/main/java/io/dapr/examples/workflows/console/activities/NotifyActivity.java

@@ -0,0 +1,21 @@
+package io.dapr.examples.workflows.console.activities;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.dapr.examples.workflows.console.models.Notification;
+import io.dapr.workflows.runtime.WorkflowActivity;
+import io.dapr.workflows.runtime.WorkflowActivityContext;
+
+public class NotifyActivity implements WorkflowActivity {
+  private static Logger logger = LoggerFactory.getLogger(NotifyActivity.class);
+
+  @Override
+  public Object run(WorkflowActivityContext ctx) {
+    Notification notification = ctx.getInput(Notification.class);
+    logger.info(notification.getMessage());
+
+    return "";
+  }
+
+}

examples/src/main/java/io/dapr/examples/workflows/console/activities/ProcessPaymentActivity.java

@@ -0,0 +1,29 @@
+package io.dapr.examples.workflows.console.activities;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.dapr.examples.workflows.console.models.PaymentRequest;
+import io.dapr.workflows.runtime.WorkflowActivity;
+import io.dapr.workflows.runtime.WorkflowActivityContext;
+
+public class ProcessPaymentActivity implements WorkflowActivity {
+  private static Logger logger = LoggerFactory.getLogger(ProcessPaymentActivity.class);
+
+  @Override
+  public Object run(WorkflowActivityContext ctx) {
+    PaymentRequest req = ctx.getInput(PaymentRequest.class);
+    logger.info("Processing payment: {} for {} {} at ${}",
+        req.getRequestId(), req.getAmount(), req.getItemName(), req.getCurrency());
+
+    // Simulate slow processing
+    try {
+      Thread.sleep(7 * 1000);
+    } catch (InterruptedException e) {
+    }
+    logger.info("Payment for request ID '{}' processed successfully", req.getRequestId());
+
+    return true;
+  }
+
+}

examples/src/main/java/io/dapr/examples/workflows/console/activities/RequestApprovalActivity.java

@@ -0,0 +1,24 @@
+package io.dapr.examples.workflows.console.activities;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.dapr.examples.workflows.console.models.ApprovalResult;
+import io.dapr.examples.workflows.console.models.OrderPayload;
+import io.dapr.workflows.runtime.WorkflowActivity;
+import io.dapr.workflows.runtime.WorkflowActivityContext;
+
+public class RequestApprovalActivity implements WorkflowActivity {
+  private static Logger logger = LoggerFactory.getLogger(RequestApprovalActivity.class);
+
+  @Override
+  public Object run(WorkflowActivityContext ctx) {
+    OrderPayload order = ctx.getInput(OrderPayload.class);
+    logger.info("Requesting approval for order: {}", order);
+
+    // hard code to Approved in example
+    logger.info("Approved requesting approval for order: {}", order);
+    return ApprovalResult.Approved;
+  }
+
+}

examples/src/main/java/io/dapr/examples/workflows/console/activities/ReserveInventoryActivity.java

@@ -0,0 +1,54 @@
+package io.dapr.examples.workflows.console.activities;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.dapr.examples.workflows.console.models.InventoryItem;
+import io.dapr.examples.workflows.console.models.InventoryRequest;
+import io.dapr.examples.workflows.console.models.InventoryResult;
+import io.dapr.workflows.runtime.WorkflowActivity;
+import io.dapr.workflows.runtime.WorkflowActivityContext;
+
+public class ReserveInventoryActivity implements WorkflowActivity {
+  private static Logger logger = LoggerFactory.getLogger(ReserveInventoryActivity.class);
+
+  @Override
+  public Object run(WorkflowActivityContext ctx) {
+    InventoryRequest inventoryRequest = ctx.getInput(InventoryRequest.class);
+    logger.info("Reserving inventory for order '{}' of {} {}",
+        inventoryRequest.getRequestId(), inventoryRequest.getQuantity(), inventoryRequest.getItemName());
+
+    // hard code that we have some inventory in this example
+    // TBD: use DaprClient to query state store for inventory
+    InventoryItem item = new InventoryItem();
+    item.setName(inventoryRequest.getItemName());
+    item.setQuantity(10);
+    item.setPerItemCost(10);
+    logger.info("There are {} {} available for purchase",
+        item.getQuantity(), item.getName());
+
+    // See if there're enough items to purchase
+    if (item.getQuantity() >= inventoryRequest.getQuantity()) {
+      // Simulate slow processing
+      try {
+        Thread.sleep(2 * 1000);
+      } catch (InterruptedException e) {
+      }
+      logger.info("Reserved inventory for order '{}' of {} {}",
+          inventoryRequest.getRequestId(), inventoryRequest.getQuantity(), inventoryRequest.getItemName());
+      InventoryResult inventoryResult = new InventoryResult();
+      inventoryResult.setSuccess(true);
+      inventoryResult.setOrderPayload(item);
+      return inventoryResult;
+    }
+
+    // Not enough items.
+    logger.info("Not enough items to reserve inventory for order '{}' of {} {}",
+        inventoryRequest.getRequestId(), inventoryRequest.getQuantity(), inventoryRequest.getItemName());
+    InventoryResult inventoryResult = new InventoryResult();
+    inventoryResult.setSuccess(false);
+    inventoryResult.setOrderPayload(item);
+    return inventoryResult;
+  }
+
+}

examples/src/main/java/io/dapr/examples/workflows/console/activities/UpdateInventoryActivity.java

@@ -0,0 +1,34 @@
+package io.dapr.examples.workflows.console.activities;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.dapr.examples.workflows.console.models.InventoryRequest;
+import io.dapr.examples.workflows.console.models.InventoryResult;
+import io.dapr.workflows.runtime.WorkflowActivity;
+import io.dapr.workflows.runtime.WorkflowActivityContext;
+
+public class UpdateInventoryActivity implements WorkflowActivity {
+  private static Logger logger = LoggerFactory.getLogger(UpdateInventoryActivity.class);
+
+  @Override
+  public Object run(WorkflowActivityContext ctx) {
+    InventoryRequest inventoryRequest = ctx.getInput(InventoryRequest.class);
+    logger.info("Updating inventory for order '{}' of {} {}",
+        inventoryRequest.getRequestId(), inventoryRequest.getQuantity(), inventoryRequest.getItemName());
+
+    // hard code that we updated inventory in this example
+    // TBD: use DaprClient to update state store for inventory
+    // Simulate slow processing
+    try {
+      Thread.sleep(2 * 1000);
+    } catch (InterruptedException e) {
+    }
+    logger.info("Updated inventory for order '{}' of {} {}",
+        inventoryRequest.getRequestId(), inventoryRequest.getQuantity(), inventoryRequest.getItemName());
+    InventoryResult inventoryResult = new InventoryResult();
+    inventoryResult.setSuccess(true);
+    return inventoryResult;
+  }
+
+}

examples/src/main/java/io/dapr/examples/workflows/console/models/ApprovalResult.java

@@ -0,0 +1,7 @@
+package io.dapr.examples.workflows.console.models;
+
+public enum ApprovalResult {
+  Unspecified,
+  Approved,
+  Rejected
+}

examples/src/main/java/io/dapr/examples/workflows/console/models/InventoryItem.java

@@ -0,0 +1,36 @@
+package io.dapr.examples.workflows.console.models;
+
+public class InventoryItem {
+  private String name;
+  private double perItemCost;
+  private int quantity;
+
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
+  public double getPerItemCost() {
+    return perItemCost;
+  }
+
+  public void setPerItemCost(double perItemCost) {
+    this.perItemCost = perItemCost;
+  }
+
+  public int getQuantity() {
+    return quantity;
+  }
+
+  public void setQuantity(int quantity) {
+    this.quantity = quantity;
+  }
+
+  @Override
+  public String toString() {
+    return "InventoryItem [name=" + name + ", perItemCost=" + perItemCost + ", quantity=" + quantity + "]";
+  }
+}