https://github.com/diagrid-labs/santa-claus-workflow
Find out how Santa is using Dapr Workflow to orchestrate the tasks involved for preparing Christmas gifts.
https://github.com/diagrid-labs/santa-claus-workflow
dapr dapr-workflow dotnet microservices workflow
Last synced: 4 months ago
JSON representation
Find out how Santa is using Dapr Workflow to orchestrate the tasks involved for preparing Christmas gifts.
- Host: GitHub
- URL: https://github.com/diagrid-labs/santa-claus-workflow
- Owner: diagrid-labs
- License: apache-2.0
- Created: 2023-12-10T18:41:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-17T15:06:59.000Z (over 1 year ago)
- Last Synced: 2025-01-19T05:12:15.460Z (5 months ago)
- Topics: dapr, dapr-workflow, dotnet, microservices, workflow
- Language: C#
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Santa Claus Workflow
> This demo is created for [Festive Tech Calendar 2023](https://festivetechcalendar.com/).
Santa Claus is using [Dapr](https://dapr.io/) to ensure everyone gets their Christmas gift on time. He has a large team of elves who are responsible for different tasks such as making toys, wrapping gifts, and loading the sleigh. Each task is an activity that can be executed by one or more elves. Santa needs to coordinate the activities of all the elves in a reliable and efficient way.
That's where [Dapr Workflow](https://docs.dapr.io/developing-applications/building-blocks/workflow/workflow-overview/) comes in. Santa defines his workflow in code (he prefers C#, but Python or Java can also be used) where he specifies the sequence of the activities. Dapr Workflow takes care of the orchestration logic, fault tolerance, and scalability of the workflow, so Santa can focus on the business logic and is assured of optimal elf efficiency.
## Workflow overview
This diagram shows an overview of the various workflows and activities that Santa is using to orchestrate the activities of his elves.
```mermaid
graph TD;
subgraph SantaClausWorkflow
Start((Start:\n list of wishes))
CW[Start ChristmasWishWorkflow]
subgraph ChristmasWishWorkflow
NNA[NaughtyOrNiceActivity]
RWA[RegisterWishActivity]
AWA[AssignWorkbenchActivity]
Choose{ChooseWorkflow\nbased on GiftType}
BW[BookWorkflow]
WW[WoodenToyWorkflow]
CEAW[CatalystEarlyAccessWorkflow]
WA[WrapActivity]
PGA[PutGiftInSleighActivity]
end
Deliver[DeliverGiftsActivity]
End((End))
end
Start-->|For each wish in the list|CW;
CW-->NNA
NNA-->|Is nice|RWA
NNA-->|Is naughty|End
RWA-->AWA
AWA-->Choose
Choose-->|GiftType=book|BW;
Choose-->|GiftType=wooden toy|WW;
Choose-->|GiftType=Catalyst early access|CEAW;
BW-->WA
WW-->WA
CEAW-->WA
WA-->PGA
PGA-->Deliver
Deliver-->End
```
These are the workflows Santa is using:
- [SantaClausWorkflow](./SantaClausWorkflow/Workflows/SantaClausWorkflow.cs): The main workflow that takes an array of wishes and starts a child workflow (ChristmasWishWorkflow) for each of the wishes.
- [ChristmasWishWorkflow](./SantaClausWorkflow/Workflows/ChristmasWishWorkflow.cs): This workflow contains activities to check if the person is naughty or nice, and if they are nice, a gift is selected and registered for that person. Based on the type of gift, another child workflow (BookWorkflow, WoodenToyWorkflow, CatalystEarlyAccessWorkflow) is started to make the gift. Once that child workflow is finished, activities are called to wrap the gift and load it into the sleigh.
- [BookWorkflow](./SantaClausWorkflow/Workflows/BookWorkflow.cs): This workflow contains activities to prepare a book as a gift.
- [WoodenToyWorkflow](./SantaClausWorkflow/Workflows/WoodenToyWorkflow.cs): This workflow contains activities to build a wooden toy. It calls activities to lookup the parts, assemble the parts, and paint the toy.
- [CatalystEarlyAccessWorkflow](./SantaClausWorkflow/Workflows/CatalystEarlyAccessWorkflow.cs): This workflow contains one activity that returns a link to get early access to Diagrid Catalyst, so they can make complex architectures simple, reliable and secure with APIs that connect to their existing infrastructure and work with their existing code.
Click to expand the BookWorkflow diagram
```mermaid
graph TD;
Start((Start))-->DetermineBookContentActivity
subgraph fan-out/fan-in for each part in the book
WritePageActivity
end
DetermineBookContentActivity-->WritePageActivity
WritePageActivity-->BindBookActivity
BindBookActivity-->End((End))
```
Click to expand the WoodenToyWorkflow diagram
```mermaid
graph TD;
Start((Start))-->LookupPartsActivity
subgraph fan-out/fan-in for each part of the toy
CollectPartActivity
end
LookupPartsActivity-->CollectPartActivity
CollectPartActivity-->AssembleToyActivity
AssembleToyActivity-->PaintToyActivity
PaintToyActivity-->End((End))
```
Click to expand the CatalystEarlyAccessWorkflow diagram
```mermaid
graph TD;
Start((Start))-->CatalystEarlyAccessActivity
CatalystEarlyAccessActivity-->End((End))
```
## Prerequisites
1. [.NET 7 SDK](https://dotnet.microsoft.com/download/dotnet/7.0)
2. [Docker Desktop](https://www.docker.com/products/docker-desktop/)
3. [Dapr CLI](https://docs.dapr.io/getting-started/install-dapr-cli/)
- Ensure that you're using v1.12 (or higher) of the Dapr runtime and the CLI.
4. A REST client, such as [cURL](https://curl.se/), or the VSCode [REST client extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
## Running the solution locally
To run the SantaWorkflow:
1. Build the solution:
```bash
dotnet build
```
2. Use the Dapr CLI to run the web app with the workflows (ensure that Docker is running):
```bash
dapr run -f .
```
3. Use the HTTP endpoints in the [local-workflow-test.http](./local-workflow-tests.http) file to start the workflow and check the status.
**Start the workflow:**
```http
@app_url=http://localhost:5065
// @name startRequest
POST {{app_url}}/start
Content-Type: application/json
[
{
"Name" : "Alex",
"GiftType" : "WoodenToy"
},
{
"Name" : "Rene",
"GiftType" : "Book"
},
{
"Name" : "Robin",
"GiftType" : "CatalystEarlyAccess"
}
]
```
**Get the workflow status:**
```http
@dapr_url=http://localhost:3500
@instanceId={{startRequest.response.body.*}}
GET {{dapr_url}}/v1.0-beta1/workflows/dapr/{{instanceId}}
```