Skip to content

Commit dcf1f9f

Browse files
alicejgibbonsalicejgibbons
committed
HTTP csharp jobs quickstart
Signed-off-by: Alice Gibbons <[email protected]>
1 parent b8ef1c0 commit dcf1f9f

10 files changed

+425
-0
lines changed

‎jobs/csharp/http/README.md

+181
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# Dapr Jobs API (HTTP Client)
2+
3+
In this quickstart, you'll schedule, get, and delete a job using Dapr's Job API. This API is responsible for scheduling and running jobs at a specific time or interval.
4+
5+
Visit [this](https://docs.dapr.io/developing-applications/building-blocks/jobs/) link for more information about Dapr and the Jobs API.
6+
7+
> **Note:** This example leverages HTTP requests only. If you are looking for the example using the Dapr Client SDK (recommended) [click here](../sdk/).
8+
9+
This quickstart includes two apps:
10+
11+
- Jobs Scheduler, responsible for scheduling, retrieving and deleting jobs.
12+
- Jobs Service, responsible for handling the triggered jobs.
13+
14+
## Run all apps with multi-app run template file
15+
16+
This section shows how to run both applications at once using [multi-app run template files](https://docs.dapr.io/developing-applications/local-development/multi-app-dapr-run/multi-app-overview/) with `dapr run -f .`. This enables to you test the interactions between multiple applications and will `schedule`, `run`, `get`, and `delete` jobs within a single process.
17+
18+
1. Build the apps:
19+
20+
<!-- STEP
21+
name: Build dependencies for job-service
22+
sleep: 1
23+
-->
24+
25+
```bash
26+
cd ./job-service
27+
dotnet build
28+
```
29+
30+
<!-- END_STEP -->
31+
32+
<!-- STEP
33+
name: Build dependencies for job-scheduler
34+
sleep: 1
35+
-->
36+
37+
```bash
38+
cd ./job-scheduler
39+
dotnet build
40+
```
41+
42+
<!-- END_STEP -->
43+
44+
2. Run the multi app run template:
45+
46+
<!-- STEP
47+
name: Run multi app run template
48+
expected_stdout_lines:
49+
- '== APP - job-scheduler == Job Scheduled: R2-D2'
50+
- '== APP - job-scheduler == Job Scheduled: C-3PO'
51+
- '== APP - job-service == Received job request...'
52+
- '== APP - job-service == Starting droid: R2-D2'
53+
- '== APP - job-service == Executing maintenance job: Oil Change'
54+
- '== APP - job-service == Received job request...'
55+
- '== APP - job-service == Starting droid: C-3PO'
56+
- '== APP - job-service == Executing maintenance job: Limb Calibration'
57+
expected_stderr_lines:
58+
output_match_mode: substring
59+
match_order: none
60+
background: false
61+
sleep: 60
62+
timeout_seconds: 120
63+
-->
64+
65+
```bash
66+
dapr run -f .
67+
```
68+
69+
The terminal console output should look similar to this, where:
70+
71+
- The `R2-D2` job is being scheduled.
72+
- The `R2-D2` job is being retrieved.
73+
- The `C-3PO` job is being scheduled.
74+
- The `C-3PO` job is being retrieved.
75+
- The `R2-D2` job is being executed after 15 seconds.
76+
- The `C-3PO` job is being executed after 20 seconds.
77+
78+
```text
79+
== APP - job-scheduler == Job Scheduled: R2-D2
80+
== APP - job-scheduler == Job details: {"name":"R2-D2", "dueTime":"15s", "data":{"@type":"type.googleapis.com/google.protobuf.Value", "value":{"Value":"R2-D2:Oil Change"}}}
81+
== APP - job-scheduler == Job Scheduled: C-3PO
82+
== APP - job-scheduler == Job details: {"name":"C-3PO", "dueTime":"20s", "data":{"@type":"type.googleapis.com/google.protobuf.Value", "value":{"Value":"C-3PO:Limb Calibration"}}}
83+
== APP - job-service == Received job request...
84+
== APP - job-service == Starting droid: R2-D2
85+
== APP - job-service == Executing maintenance job: Oil Change
86+
```
87+
88+
After 20 seconds, the terminal output should present the `C-3PO` job being processed:
89+
90+
```text
91+
== APP - job-service == Received job request...
92+
== APP - job-service == Starting droid: C-3PO
93+
== APP - job-service == Executing maintenance job: Limb Calibration
94+
```
95+
96+
<!-- END_STEP -->
97+
98+
## Run apps individually
99+
100+
### Schedule Jobs
101+
102+
1. Open a terminal and run the `job-service` app. Build the dependencies if you haven't already.
103+
104+
```bash
105+
cd ./job-service
106+
dotnet build
107+
```
108+
109+
```bash
110+
dapr run --app-id job-service --app-port 6200 --dapr-http-port 6280 -- dotnet run
111+
```
112+
113+
2. In a new terminal window, schedule the `R2-D2` Job using the Jobs API.
114+
115+
```bash
116+
curl -X POST \
117+
http://localhost:6280/v1.0-alpha1/jobs/r2-d2 \
118+
-H "Content-Type: application/json" \
119+
-d '{
120+
"data": {
121+
"Value": "R2-D2:Oil Change"
122+
},
123+
"dueTime": "2s"
124+
}'
125+
```
126+
127+
In the `job-service` terminal window, the output should be:
128+
129+
```text
130+
== APP - job-app == Received job request...
131+
== APP - job-app == Starting droid: R2-D2
132+
== APP - job-app == Executing maintenance job: Oil Change
133+
```
134+
135+
3. On the same terminal window, schedule the `C-3PO` Job using the Jobs API.
136+
137+
```bash
138+
curl -X POST \
139+
http://localhost:6280/v1.0-alpha1/jobs/c-3po \
140+
-H "Content-Type: application/json" \
141+
-d '{
142+
"data": {
143+
"Value": "C-3PO:Limb Calibration"
144+
},
145+
"dueTime": "30s"
146+
}'
147+
```
148+
149+
### Get a scheduled job
150+
151+
1. On the same terminal window, run the command below to get the recently scheduled `C-3PO` job.
152+
153+
```bash
154+
curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"
155+
```
156+
157+
You should see the following:
158+
159+
```text
160+
{"name":"c-3po", "dueTime":"30s", "data":{"@type":"type.googleapis.com/google.protobuf.Value", "value":{"Value":"C-3PO:Limb Calibration"}}
161+
```
162+
163+
### Delete a scheduled job
164+
165+
1. On the same terminal window, run the command below to deleted the recently scheduled `C-3PO` job.
166+
167+
```bash
168+
curl -X DELETE http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"
169+
```
170+
171+
2. Run the command below to attempt to retrieve the deleted job:
172+
173+
```bash
174+
curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"
175+
```
176+
177+
In the `job-service` terminal window, the output should be similar to the following:
178+
179+
```text
180+
ERRO[0568] Error getting job c-3po due to: rpc error: code = Unknown desc = job not found: c-3po instance=local scope=dapr.api type=log ver=1.15.0
181+
```

‎jobs/csharp/http/dapr.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 1
2+
apps:
3+
- appDirPath: ./job-service/
4+
appID: job-service
5+
appPort: 6200
6+
daprHTTPPort: 6280
7+
schedulerHostAddress: localhost
8+
command: ["dotnet", "run"]
9+
- appDirPath: ./job-scheduler/
10+
appID: job-scheduler
11+
appPort: 6300
12+
daprHTTPPort: 6380
13+
command: ["dotnet", "run"]

‎jobs/csharp/http/job-scheduler/Program.cs

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
using System;
2+
using System.Net.Http;
3+
using System.Text;
4+
using System.Text.Json;
5+
using System.Threading.Tasks;
6+
7+
// Job request bodies
8+
var c3poJobBody = new
9+
{
10+
data = new { Value = "C-3PO:Limb Calibration" },
11+
dueTime = "20s"
12+
};
13+
14+
var r2d2JobBody = new
15+
{
16+
data = new { Value = "R2-D2:Oil Change" },
17+
dueTime = "15s"
18+
};
19+
20+
var daprHost = Environment.GetEnvironmentVariable("DAPR_HOST") ?? "http://localhost";
21+
var schedulerDaprHttpPort = "6280";
22+
23+
var httpClient = new HttpClient();
24+
25+
await Task.Delay(5000); // Wait for job-service to start
26+
27+
try
28+
{
29+
// Schedule R2-D2 job
30+
await ScheduleJob("R2-D2", r2d2JobBody);
31+
await Task.Delay(5000);
32+
// Get R2-D2 job details
33+
await GetJobDetails("R2-D2");
34+
35+
// Schedule C-3PO job
36+
await ScheduleJob("C-3PO", c3poJobBody);
37+
await Task.Delay(5000);
38+
// Get C-3PO job details
39+
await GetJobDetails("C-3PO");
40+
41+
await Task.Delay(30000); // Allow time for jobs to complete
42+
}
43+
catch (Exception ex)
44+
{
45+
Console.Error.WriteLine($"Error: {ex.Message}");
46+
Environment.Exit(1);
47+
}
48+
49+
async Task ScheduleJob(string jobName, object jobBody)
50+
{
51+
var reqURL = $"{daprHost}:{schedulerDaprHttpPort}/v1.0-alpha1/jobs/{jobName}";
52+
var jsonBody = JsonSerializer.Serialize(jobBody);
53+
var content = new StringContent(jsonBody, Encoding.UTF8, "application/json");
54+
55+
var response = await httpClient.PostAsync(reqURL, content);
56+
57+
if (response.StatusCode != System.Net.HttpStatusCode.NoContent)
58+
{
59+
throw new Exception($"Failed to register job event handler. Status code: {response.StatusCode}");
60+
}
61+
62+
Console.WriteLine($"Job Scheduled: {jobName}");
63+
}
64+
65+
async Task GetJobDetails(string jobName)
66+
{
67+
var reqURL = $"{daprHost}:{schedulerDaprHttpPort}/v1.0-alpha1/jobs/{jobName}";
68+
69+
var response = await httpClient.GetAsync(reqURL);
70+
71+
if (!response.IsSuccessStatusCode)
72+
{
73+
throw new Exception($"HTTP error! Status: {response.StatusCode}");
74+
}
75+
76+
var jobDetails = await response.Content.ReadAsStringAsync();
77+
Console.WriteLine($"Job details: {jobDetails}");
78+
}

‎jobs/csharp/http/job-scheduler/jobs-scheduler.csproj

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<OutputType>Exe</OutputType>
5+
<TargetFramework>net8.0</TargetFramework>
6+
<RootNamespace>jobs_scheduler</RootNamespace>
7+
<ImplicitUsings>enable</ImplicitUsings>
8+
<Nullable>enable</Nullable>
9+
</PropertyGroup>
10+
11+
</Project>

‎jobs/csharp/http/job-service/Program.cs

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
using Microsoft.AspNetCore.Builder;
2+
using Microsoft.AspNetCore.Hosting;
3+
using Microsoft.AspNetCore.Http.Json;
4+
using Microsoft.Extensions.DependencyInjection;
5+
using Microsoft.Extensions.Hosting;
6+
using System.Text.Json;
7+
8+
var builder = WebApplication.CreateBuilder(args);
9+
10+
builder.Services.Configure<JsonOptions>(options =>
11+
{
12+
options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
13+
});
14+
15+
var app = builder.Build();
16+
var appPort = Environment.GetEnvironmentVariable("APP_PORT") ?? "6200";
17+
18+
//Job handler route
19+
app.MapPost("/job/{*path}", async (HttpRequest request, HttpResponse response) =>
20+
{
21+
Console.WriteLine("Received job request...");
22+
23+
try
24+
{
25+
// Parse the incoming JSON body
26+
var jobData = await JsonSerializer.DeserializeAsync<JobData>(request.Body);
27+
if (jobData == null || string.IsNullOrEmpty(jobData.Value))
28+
{
29+
throw new Exception("Invalid job data. 'value' field is required.");
30+
}
31+
32+
// Creating Droid Job from decoded value
33+
var droidJob = SetDroidJob(jobData.Value);
34+
Console.WriteLine($"Starting droid: {droidJob.Droid}");
35+
Console.WriteLine($"Executing maintenance job: {droidJob.Task}");
36+
response.StatusCode = 200;
37+
}
38+
catch (Exception ex)
39+
{
40+
Console.Error.WriteLine($"Error processing job: {ex.Message}");
41+
response.StatusCode = 400; // Bad Request
42+
var errorResponse = new { error = $"Error processing request: {ex.Message}" };
43+
await response.WriteAsJsonAsync(errorResponse);
44+
}
45+
});
46+
47+
// Start the server
48+
app.Run($"http://localhost:{appPort}");
49+
50+
static DroidJob SetDroidJob(string droidStr)
51+
{
52+
var parts = droidStr.Split(":");
53+
if (parts.Length != 2)
54+
{
55+
throw new Exception("Invalid droid job format. Expected format: 'Droid:Task'");
56+
}
57+
58+
return new DroidJob
59+
{
60+
Droid = parts[0],
61+
Task = parts[1]
62+
};
63+
}
64+
65+
// Classes for request and response models
66+
public class JobData
67+
{
68+
public string? Value { get; set; }
69+
}
70+
71+
public class DroidJob
72+
{
73+
public string? Droid { get; set; }
74+
public string? Task { get; set; }
75+
}

0 commit comments

Comments
 (0)