mirror of https://github.com/dapr/quickstarts.git
142 lines
6.0 KiB
Markdown
142 lines
6.0 KiB
Markdown
# Combined Workflow Patterns
|
|
|
|
This tutorial demonstrates how several workflow patterns can be combined in a single, more realistic, workflow. Some of the workflow activities are using other Dapr APIs, such as state management, service invocation, and Pub/Sub.
|
|
|
|
## Inspect the code
|
|
|
|
The demo consist of two applications:
|
|
|
|
- `WorkflowApp` is the main application that orchestrates an order process in the `OrderWorkflow`.
|
|
- `ShippingApp` is a supporting service that is being called by the `OrderWorkflow`.
|
|
|
|
The `OrderWorkflow` combines task chaining, fan-out/fan-in, and waiting for external event patterns. The workflow contains a number of activities for order processing including checking inventory, register shipment, process payment and more with a final order status being returned with the results of the order. It uses compensating logic in case the shipment fails to get registered and the customer needs to be reimbursed for the payment.
|
|
|
|
```mermaid
|
|
graph LR
|
|
SW((Start
|
|
Workflow))
|
|
EW((End
|
|
Workflow))
|
|
subgraph OrderWorkflow
|
|
direction LR
|
|
CHKI[Check inventory]
|
|
CHKD[Check shipping
|
|
destination]
|
|
IF1{Success?}
|
|
PAY[Process
|
|
payment]
|
|
UPD[Update
|
|
inventory]
|
|
REG[Register
|
|
shipment]
|
|
WAIT[Wait for
|
|
confirmation]
|
|
IF2{Success?}
|
|
RI[Reimburse
|
|
customer]
|
|
end
|
|
subgraph Shipping
|
|
direction LR
|
|
REG2[registerShipment]
|
|
CHKD2[checkDestination]
|
|
end
|
|
SW --> CHKI
|
|
SW --> CHKD <--> CHKD2
|
|
CHKI --> IF1
|
|
CHKD --> IF1
|
|
IF1 --> PAY
|
|
PAY --> UPD
|
|
UPD --> REG -.->|pub/sub| REG2
|
|
REG2 -.->|pub/sub| WAIT
|
|
REG --> WAIT
|
|
WAIT --> IF2
|
|
IF2 -->|Yes| EW
|
|
IF2 -->|No| RI
|
|
RI --> EW
|
|
```
|
|
|
|
## Run the tutorial
|
|
|
|
1. Use a terminal to navigate to the `tutorials/workflow/csharp/combined-patterns` folder.
|
|
2. Build the projects using the .NET CLI.
|
|
|
|
```bash
|
|
dotnet build ./WorkflowApp/
|
|
dotnet build ./ShippingApp/
|
|
```
|
|
|
|
3. Use the Dapr CLI to run the Dapr Multi-App run file. This starts both applications `order-workflow` and `shipping` with the Dapr components in the [resources](./resources) folder.
|
|
|
|
<!-- STEP
|
|
name: Run multi app run template
|
|
expected_stdout_lines:
|
|
- 'Started Dapr with app id "order-workflow"'
|
|
- 'Started Dapr with app id "shipping"'
|
|
expected_stderr_lines:
|
|
working_dir: .
|
|
output_match_mode: substring
|
|
background: true
|
|
sleep: 15
|
|
timeout_seconds: 30
|
|
-->
|
|
```bash
|
|
dapr run -f .
|
|
```
|
|
<!-- END_STEP -->
|
|
|
|
4. Use the POST request in the [`order-workflow.http`](./order-workflow.http) file to start the workflow, or use this cURL command:
|
|
|
|
```bash
|
|
curl -i --request POST \
|
|
--url http://localhost:5260/start \
|
|
--header 'content-type: application/json' \
|
|
--data '{"id": "b0d38481-5547-411e-ae7b-255761cce17a","orderItem" : {"productId": "RBD001","productName": "Rubber Duck","quantity": 10,"totalPrice": 15.00},"customerInfo" : {"id" : "Customer1","country" : "The Netherlands"}}'
|
|
```
|
|
|
|
The input for the workflow is an `Order` object:
|
|
|
|
```json
|
|
{
|
|
"id": "{{orderId}}",
|
|
"orderItem" : {
|
|
"productId": "RBD001",
|
|
"productName": "Rubber Duck",
|
|
"quantity": 10,
|
|
"totalPrice": 15.00
|
|
},
|
|
"customerInfo" : {
|
|
"id" : "Customer1",
|
|
"country" : "The Netherlands"
|
|
}
|
|
}
|
|
```
|
|
|
|
The app logs should come from both services executing all activities as follows:
|
|
|
|
```text
|
|
== APP - order-workflow == CheckInventory: Received input: OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }.
|
|
== APP - order-workflow == CheckShippingDestination: Received input: Order { Id = 06d49c54-bf65-427b-90d1-730987e96e61, OrderItem = OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }, CustomerInfo = CustomerInfo { Id = Customer1, Country = The Netherlands } }.
|
|
== APP - shipping == checkDestination: Received input: Order { Id = 06d49c54-bf65-427b-90d1-730987e96e61, OrderItem = OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }, CustomerInfo = CustomerInfo { Id = Customer1, Country = The Netherlands } }.
|
|
== APP - order-workflow == ProcessPayment: Received input: Order { Id = 06d49c54-bf65-427b-90d1-730987e96e61, OrderItem = OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }, CustomerInfo = CustomerInfo { Id = Customer1, Country = The Netherlands } }.
|
|
== APP - order-workflow == UpdateInventory: Received input: OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }.
|
|
== APP - order-workflow == RegisterShipment: Received input: Order { Id = 06d49c54-bf65-427b-90d1-730987e96e61, OrderItem = OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }, CustomerInfo = CustomerInfo { Id = Customer1, Country = The Netherlands } }.
|
|
== APP - shipping == registerShipment: Received input: Order { Id = 06d49c54-bf65-427b-90d1-730987e96e61, OrderItem = OrderItem { ProductId = RBD001, ProductName = Rubber Duck, Quantity = 10, TotalPrice = 15.00 }, CustomerInfo = CustomerInfo { Id = Customer1, Country = The Netherlands } }.
|
|
== APP - order-workflow == Shipment registered for order ShipmentRegistrationStatus { OrderId = 06d49c54-bf65-427b-90d1-730987e96e61, IsSuccess = True, Message = }
|
|
```
|
|
|
|
5. Use the GET request in the [`order-workflow.http`](./order-workflow.http) file to get the status of the workflow, or use this cURL command:
|
|
|
|
```bash
|
|
curl --request GET --url http://localhost:3560/v1.0/workflows/dapr/06d49c54-bf65-427b-90d1-730987e96e61
|
|
```
|
|
|
|
The expected serialized output of the workflow is:
|
|
|
|
```txt
|
|
{\"IsSuccess\":true,\"Message\":\"Order 06d49c54-bf65-427b-90d1-730987e96e61 processed successfully.\"}"
|
|
```
|
|
|
|
*The Order ID is generated when making the request and is different each time.*
|
|
|
|
6. Stop the Dapr Multi-App run process by pressing `Ctrl+C`.
|