add quickstart for JS

Signed-off-by: kaibocai <kaibocai@microsoft.com> clean up Signed-off-by: kaibocai <kaibocai@microsoft.com> update .gitignore fix .gitignore Signed-off-by: kaibocai <kaibocai@microsoft.com>
dapr · Feb 16, 2024 · 2d7b401 · 2d7b401
1 parent ec1e515
commit 2d7b401
Show file tree

Hide file tree

Showing 10 changed files with 3,157 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,7 @@ release.properties
 mvnw
 packages
 **/__pycache__/
+**/dist/
 
 # IDE generated files and directories
 *.iml

diff --git a/workflows/javascript/sdk/README.md b/workflows/javascript/sdk/README.md
@@ -0,0 +1,146 @@
+# Dapr workflows
+
+In this quickstart, you'll create a simple console application to demonstrate Dapr's workflow programming model and the workflow management API. The console app starts and manages the lifecycle of a workflow that stores and retrieves data in a state store.
+
+This quickstart includes one project:
+
+- JavaScript console app `order-processor` 
+
+The quickstart contains 1 workflow to simulate purchasing items from a store, and 5 unique activities within the workflow. These 5 activities are as follows:
+
+- notifyActivity: This activity utilizes a logger to print out messages throughout the workflow. These messages notify the user when there is insufficient inventory, their payment couldn't be processed, and more.
+- reserveInventoryActivity: This activity checks the state store to ensure that there is enough inventory present for purchase.
+- requestApprovalActivity: This activity requests approval for orders over a certain threshold
+- processPaymentActivity: This activity is responsible for processing and authorizing the payment.
+- updateInventoryActivity: This activity updates the state store with the new remaining inventory value.
+
+### Run the order processor workflow with multi-app-run
+
+1. Open a new terminal window and navigate to `order-processor` directory: 
+
+<!-- STEP
+name: build order-process app
+-->
+
+```bash
+cd ./javascript/sdk
+npm install
+npm run build
+cd ..
+```
+
+<!-- END_STEP -->
+2. Run the console app with Dapr: 
+
+<!-- STEP
+name: Run order-processor service
+expected_stdout_lines:
+  - '== APP - there are now 90 item1 in stock'
+  - '== APP - processed successfully!'
+expected_stderr_lines:
+output_match_mode: substring
+background: true
+sleep: 15
+timeout_seconds: 120
+-->
+
+```bash
+dapr run -f .
+```
+
+<!-- END_STEP -->
+
+3. Expected output
+
+
+```
+== APP - workflowApp == == APP == Orchestration scheduled with ID: 0c332155-1e02-453a-a333-28cfc7777642
+== APP - workflowApp == == APP == Waiting 30 seconds for instance 0c332155-1e02-453a-a333-28cfc7777642 to complete...
+== APP - workflowApp == == APP == Received "Orchestrator Request" work item with instance id '0c332155-1e02-453a-a333-28cfc7777642'
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Rebuilding local state with 0 history event...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Processing 2 new history event(s): [ORCHESTRATORSTARTED=1, EXECUTIONSTARTED=1]
+== APP - workflowApp == == APP == Processing order 0c332155-1e02-453a-a333-28cfc7777642...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Waiting for 1 task(s) and 0 event(s) to complete...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Returning 1 action(s)
+== APP - workflowApp == == APP == Received "Activity Request" work item
+== APP - workflowApp == == APP == Received order 0c332155-1e02-453a-a333-28cfc7777642 for 10 item1 at a total cost of 100
+== APP - workflowApp == == APP == Activity notifyActivity completed with output undefined (0 chars)
+== APP - workflowApp == == APP == Received "Orchestrator Request" work item with instance id '0c332155-1e02-453a-a333-28cfc7777642'
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Rebuilding local state with 3 history event...
+== APP - workflowApp == == APP == Processing order 0c332155-1e02-453a-a333-28cfc7777642...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Processing 2 new history event(s): [ORCHESTRATORSTARTED=1, TASKCOMPLETED=1]
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Waiting for 1 task(s) and 0 event(s) to complete...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Returning 1 action(s)
+== APP - workflowApp == == APP == Received "Activity Request" work item
+== APP - workflowApp == == APP == Reserving inventory for 0c332155-1e02-453a-a333-28cfc7777642 of 10 item1
+== APP - workflowApp == == APP == 2024-02-16T03:15:59.498Z INFO [HTTPClient, HTTPClient] Sidecar Started
+== APP - workflowApp == == APP == There are 100 item1 in stock
+== APP - workflowApp == == APP == Activity reserveInventoryActivity completed with output {"success":true,"inventoryItem":{"perItemCost":100,"quantity":100,"itemName":"item1"}} (86 chars)
+== APP - workflowApp == == APP == Received "Orchestrator Request" work item with instance id '0c332155-1e02-453a-a333-28cfc7777642'
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Rebuilding local state with 6 history event...
+== APP - workflowApp == == APP == Processing order 0c332155-1e02-453a-a333-28cfc7777642...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Processing 2 new history event(s): [ORCHESTRATORSTARTED=1, TASKCOMPLETED=1]
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Waiting for 1 task(s) and 0 event(s) to complete...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Returning 1 action(s)
+== APP - workflowApp == == APP == Received "Activity Request" work item
+== APP - workflowApp == == APP == Processing payment for order item1
+== APP - workflowApp == == APP == Payment of 100 for 10 item1 processed successfully
+== APP - workflowApp == == APP == Activity processPaymentActivity completed with output true (4 chars)
+== APP - workflowApp == == APP == Received "Orchestrator Request" work item with instance id '0c332155-1e02-453a-a333-28cfc7777642'
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Rebuilding local state with 9 history event...
+== APP - workflowApp == == APP == Processing order 0c332155-1e02-453a-a333-28cfc7777642...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Processing 2 new history event(s): [ORCHESTRATORSTARTED=1, TASKCOMPLETED=1]
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Waiting for 1 task(s) and 0 event(s) to complete...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Returning 1 action(s)
+== APP - workflowApp == == APP == Received "Activity Request" work item
+== APP - workflowApp == == APP == Updating inventory for 0c332155-1e02-453a-a333-28cfc7777642 of 10 item1
+== APP - workflowApp == == APP == Inventory updated for 0c332155-1e02-453a-a333-28cfc7777642, there are now 90 item1 in stock
+== APP - workflowApp == == APP == Activity updateInventoryActivity completed with output {"success":true,"inventoryItem":{"perItemCost":100,"quantity":90,"itemName":"item1"}} (85 chars)
+== APP - workflowApp == == APP == Received "Orchestrator Request" work item with instance id '0c332155-1e02-453a-a333-28cfc7777642'
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Rebuilding local state with 12 history event...
+== APP - workflowApp == == APP == Processing order 0c332155-1e02-453a-a333-28cfc7777642...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Processing 2 new history event(s): [ORCHESTRATORSTARTED=1, TASKCOMPLETED=1]
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Waiting for 1 task(s) and 0 event(s) to complete...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Returning 1 action(s)
+== APP - workflowApp == == APP == Received "Activity Request" work item
+== APP - workflowApp == == APP == order 0c332155-1e02-453a-a333-28cfc7777642 processed successfully!
+== APP - workflowApp == == APP == Activity notifyActivity completed with output undefined (0 chars)
+== APP - workflowApp == == APP == Received "Orchestrator Request" work item with instance id '0c332155-1e02-453a-a333-28cfc7777642'
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Rebuilding local state with 15 history event...
+== APP - workflowApp == == APP == Processing order 0c332155-1e02-453a-a333-28cfc7777642...
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Processing 2 new history event(s): [ORCHESTRATORSTARTED=1, TASKCOMPLETED=1]
+== APP - workflowApp == == APP == Order 0c332155-1e02-453a-a333-28cfc7777642 processed successfully!
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Orchestration completed with status COMPLETED
+== APP - workflowApp == == APP == 0c332155-1e02-453a-a333-28cfc7777642: Returning 1 action(s)
+== APP - workflowApp == time="2024-02-15T21:15:59.5589687-06:00" level=info msg="0c332155-1e02-453a-a333-28cfc7777642: 'orderProcessingWorkflow' completed with a COMPLETED status." app_id=activity-sequence-workflow instance=kaibocai-devbox scope=wfengine.backend type=log ver=1.12.4
+== APP - workflowApp == == APP == Instance 0c332155-1e02-453a-a333-28cfc7777642 completed
+```
+
+### View workflow output with Zipkin
+
+For a more detailed view of the workflow activities (duration, progress etc.), try using Zipkin.
+
+1. Launch Zipkin container - The [openzipkin/zipkin](https://hub.docker.com/r/openzipkin/zipkin/) docker container is launched on running `dapr init`. Check to make sure the container is running. If it's not, launch the Zipkin docker container with the following command.
+
+```bash
+docker run -d -p 9411:9411 openzipkin/zipkin
+```
+
+2. View Traces in Zipkin UI - In your browser go to http://localhost:9411 to view the workflow trace spans in the Zipkin web UI. The order-processor workflow should be viewable with the following output in the Zipkin web UI. 
+
+<img src="img/workflow-trace-spans-zipkin.png">
+
+### What happened? 
+
+When you ran `dapr run --app-id activity-sequence-workflow --app-protocol grpc --dapr-grpc-port 50001 --components-path ../../components npm run start:order-process`
+
+1. A unique order ID for the workflow is generated (in the above example, `0c332155-1e02-453a-a333-28cfc7777642`) and the workflow is scheduled.
+2. The `notifyActivity` workflow activity sends a notification saying an order for 10 cars has been received.
+3. The `reserveInventoryActivity` workflow activity checks the inventory data, determines if you can supply the ordered item, and responds with the number of cars in stock.
+4. Your workflow starts and notifies you of its status.
+5. The `requestApprovalActivity` workflow activity requests approval for order `0c332155-1e02-453a-a333-28cfc7777642`
+6. The `processPaymentActivity` workflow activity begins processing payment for order `0c332155-1e02-453a-a333-28cfc7777642` and confirms if successful.
+7. The `updateInventoryActivity` workflow activity updates the inventory with the current available cars after the order has been processed.
+8. The `notifyActivity` workflow activity sends a notification saying that order `0c332155-1e02-453a-a333-28cfc7777642` has completed and processed.
+9. The workflow terminates as completed and processed.
+
diff --git a/workflows/javascript/sdk/dapr.yaml b/workflows/javascript/sdk/dapr.yaml
@@ -0,0 +1,7 @@
+version: 1
+common:
+  resourcesPath: ../../components
+apps:
+  - appID: workflowApp
+    appDirPath: ./order-processor/
+    command: ["npm", "run", "start:dapr:order-process"]
diff --git a/workflows/javascript/sdk/makefile b/workflows/javascript/sdk/makefile
@@ -0,0 +1,2 @@
+include ../../../docker.mk
+include ../../../validate.mk
diff --git a/workflows/javascript/sdk/order-processor/model.ts b/workflows/javascript/sdk/order-processor/model.ts
@@ -0,0 +1,107 @@
+export class OrderPayload {
+    itemName: string;
+    totalCost: number;
+    quantity: number;
+
+    constructor(itemName: string, totalCost: number, quantity: number) {
+        this.itemName = itemName;
+        this.totalCost = totalCost;
+        this.quantity = quantity;
+    }
+
+    toJson(): string {
+        return `{"itemName": "${this.itemName}", "quantity": ${this.quantity}, "totalCost": ${this.totalCost}}`;
+    }
+
+    toString(): string {
+        return `OrderPayload(name=${this.itemName}, totalCost=${this.totalCost}, quantity=${this.quantity})`;
+    }
+}
+
+export class InventoryItem {
+    itemName: string;
+    perItemCost: number;
+    quantity: number;
+
+    constructor(itemName: string, perItemCost: number, quantity: number) {
+        this.itemName = itemName;
+        this.perItemCost = perItemCost;
+        this.quantity = quantity;
+    }
+
+    toString(): string {
+        return `InventoryItem(itemName=${this.itemName}, perItemCost=${this.perItemCost}, quantity=${this.quantity})`;
+    }
+}
+
+export class InventoryRequest {
+    requestId: string;
+    itemName: string;
+    quantity: number;
+
+    constructor(requestId: string, itemName: string, quantity: number) {
+        this.requestId = requestId;
+        this.itemName = itemName;
+        this.quantity = quantity;
+    }
+
+    toString(): string {
+        return `InventoryRequest(requestId=${this.requestId}, itemName=${this.itemName}, quantity=${this.quantity})`;
+    }
+}
+
+export class InventoryResult {
+    success: boolean;
+    inventoryItem?: InventoryItem;
+
+    constructor(success: boolean, inventoryItem: InventoryItem | undefined) {
+        this.success = success;
+        this.inventoryItem = inventoryItem;
+    }
+
+    toString(): string {
+        return `InventoryResult(success=${this.success}, inventoryItem=${this.inventoryItem})`;
+    }
+}
+
+export class OrderPaymentRequest {
+    requestId: string;
+    itemBeingPurchased: string;
+    amount: number;
+    quantity: number;
+
+    constructor(requestId: string, itemBeingPurchased: string, amount: number, quantity: number) {
+        this.requestId = requestId;
+        this.itemBeingPurchased = itemBeingPurchased;
+        this.amount = amount;
+        this.quantity = quantity;
+    }
+
+    toString(): string {
+        return `PaymentRequest(requestId=${this.requestId}, itemBeingPurchased=${this.itemBeingPurchased}, amount=${this.amount}, quantity=${this.quantity})`;
+    }
+}
+
+export class ApprovalRequired {
+    approval: boolean;
+
+    constructor(approval: boolean) {
+        this.approval = approval;
+    }
+
+    toString(): string {
+        return `ApprovalRequired(approval=${this.approval})`;
+    }
+}
+
+export class OrderNotification {
+    message: string;
+
+    constructor(message: string) {
+        this.message = message;
+    }
+
+    toString(): string {
+        return `Notification(message=${this.message})`;
+    }
+}
diff --git a/workflows/javascript/sdk/order-processor/orderProcessingWorkflow.ts b/workflows/javascript/sdk/order-processor/orderProcessingWorkflow.ts
@@ -0,0 +1,119 @@
+import { WorkflowActivityContext, WorkflowContext, TWorkflow, DaprClient } from "@dapr/dapr-dev";
+import { InventoryItem, InventoryRequest, InventoryResult, OrderNotification, OrderPayload, OrderPaymentRequest } from "./model";
+
+const daprClient = new DaprClient();
+const storeName = "statestore";
+
+// Defines Notify Activity. This is used by the workflow to send out a notification
+export const notifyActivity = async (_: WorkflowActivityContext, orderNotification: OrderNotification) => {
+  console.log(orderNotification.message);
+  return;
+};
+
+//Defines Verify Inventory Activity. This is used by the workflow to verify if inventory is available for the order
+export const reserveInventoryActivity = async (_: WorkflowActivityContext, inventoryRequest: InventoryRequest) => {
+  console.log(`Reserving inventory for ${inventoryRequest.requestId} of ${inventoryRequest.quantity} ${inventoryRequest.itemName}`);
+  const result = await daprClient.state.get(storeName, inventoryRequest.itemName);
+  if (result == undefined || result == null) {
+    return new InventoryResult(false, undefined);
+  }
+  const inventoryItem = result as InventoryItem;
+  console.log(`There are ${inventoryItem.quantity} ${inventoryItem.itemName} in stock`);
+
+  if (inventoryItem.quantity >= inventoryRequest.quantity) {
+    return new InventoryResult(true, inventoryItem)
+  }
+  return new InventoryResult(false, undefined);
+}
+
+export const requestApprovalActivity = async (_: WorkflowActivityContext, orderPayLoad: OrderPayload) => {
+  console.log(`Requesting approval for order ${orderPayLoad.itemName}`);
+  return true;
+}
+
+export const processPaymentActivity = async (_: WorkflowActivityContext, orderPaymentRequest: OrderPaymentRequest) => {
+  console.log(`Processing payment for order ${orderPaymentRequest.itemBeingPurchased}`);
+  console.log(`Payment of ${orderPaymentRequest.amount} for ${orderPaymentRequest.quantity} ${orderPaymentRequest.itemBeingPurchased} processed successfully`);
+  return true;
+}
+
+export const updateInventoryActivity = async (_: WorkflowActivityContext, inventoryRequest: InventoryRequest) => {
+  console.log(`Updating inventory for ${inventoryRequest.requestId} of ${inventoryRequest.quantity} ${inventoryRequest.itemName}`);
+  const result = await daprClient.state.get(storeName, inventoryRequest.itemName);
+  if (result == undefined || result == null) {
+    return new InventoryResult(false, undefined);
+  }
+  const inventoryItem = result as InventoryItem;
+  inventoryItem.quantity = inventoryItem.quantity - inventoryRequest.quantity;
+  if (inventoryItem.quantity < 0) {
+    console.log(`Insufficient inventory for ${inventoryRequest.requestId} of ${inventoryRequest.quantity} ${inventoryRequest.itemName}`);
+    return new InventoryResult(false, undefined);
+  }
+  await daprClient.state.save(storeName, [
+    {
+      key: inventoryRequest.itemName,
+      value: inventoryItem,
+    }
+  ]);
+  console.log(`Inventory updated for ${inventoryRequest.requestId}, there are now ${inventoryItem.quantity} ${inventoryItem.itemName} in stock`);
+  return new InventoryResult(true, inventoryItem);
+}
+
+export const orderProcessingWorkflow: TWorkflow = async function* (ctx: WorkflowContext, orderPayLoad: OrderPayload): any {
+  const orderId = ctx.getWorkflowInstanceId();
+  console.log(`Processing order ${orderId}...`);
+
+  const orderNotification: OrderNotification = {
+    message: `Received order ${orderId} for ${orderPayLoad.quantity} ${orderPayLoad.itemName} at a total cost of ${orderPayLoad.totalCost}`,
+  };
+  yield ctx.callActivity(notifyActivity, orderNotification);
+
+  const inventoryRequest = new InventoryRequest(orderId, orderPayLoad.itemName, orderPayLoad.quantity);
+  const inventoryResult = yield ctx.callActivity(reserveInventoryActivity, inventoryRequest);
+
+  if (!inventoryResult.success) {
+    const orderNotification: OrderNotification = {
+      message: `Insufficient inventory for order ${orderId}`,
+    };
+    yield ctx.callActivity(notifyActivity, orderNotification);
+    return;
+  }
+
+  if (orderPayLoad.totalCost > 5000) {
+    const approvalResult = yield ctx.callActivity(requestApprovalActivity, orderPayLoad);
+    if (!approvalResult) {
+      const orderNotification: OrderNotification = {
+        message: `Order ${orderId} approval denied`,
+      };
+      yield ctx.callActivity(notifyActivity, orderNotification);
+      return;
+    }
+  }
+
+  const orderPaymentRequest = new OrderPaymentRequest(orderId, orderPayLoad.itemName, orderPayLoad.totalCost, orderPayLoad.quantity);
+  const paymentResult = yield ctx.callActivity(processPaymentActivity, orderPaymentRequest);
+
+  if (!paymentResult) {
+    const orderNotification: OrderNotification = {
+      message: `Payment for order ${orderId} failed`,
+    };
+    yield ctx.callActivity(notifyActivity, orderNotification);
+    return;
+  }
+
+  const updatedResult = yield ctx.callActivity(updateInventoryActivity, inventoryRequest);
+  if (!updatedResult.success) {
+    const orderNotification: OrderNotification = {
+      message: `Failed to update inventory for order ${orderId}`,
+    };
+    yield ctx.callActivity(notifyActivity, orderNotification);
+    return;
+  }
+
+  const orderCompletedNotification: OrderNotification = {
+    message: `order ${orderId} processed successfully!`,
+  };
+  yield ctx.callActivity(notifyActivity, orderCompletedNotification);
+
+  console.log(`Order ${orderId} processed successfully!`);
+}