Added .NET client for new Dapr Jobs API support

README.md

@@ -46,6 +46,7 @@ This repo builds the following packages:
 - Dapr.Actors.AspNetCore
 - Dapr.Extensions.Configuration
 - Dapr.Workflow
+- Dapr.Jobs
 
 ### Prerequisites
 

all.sln

@@ -118,6 +118,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dapr.E2E.Test.Actors.Genera
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Cryptography", "examples\Client\Cryptography\Cryptography.csproj", "{C74FBA78-13E8-407F-A173-4555AEE41FF3}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dapr.Jobs", "src\Dapr.Jobs\Dapr.Jobs.csproj", "{D34F9326-8D8C-43C4-975B-7201A9C97E6E}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dapr.Jobs.Test", "test\Dapr.Jobs.Test\Dapr.Jobs.Test.csproj", "{EDEE625E-6815-40E1-935F-35129771A0F8}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -290,6 +294,14 @@ Global
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D34F9326-8D8C-43C4-975B-7201A9C97E6E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D34F9326-8D8C-43C4-975B-7201A9C97E6E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D34F9326-8D8C-43C4-975B-7201A9C97E6E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D34F9326-8D8C-43C4-975B-7201A9C97E6E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{EDEE625E-6815-40E1-935F-35129771A0F8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{EDEE625E-6815-40E1-935F-35129771A0F8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{EDEE625E-6815-40E1-935F-35129771A0F8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{EDEE625E-6815-40E1-935F-35129771A0F8}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -343,6 +355,8 @@ Global
 		{AF89083D-4715-42E6-93E9-38497D12A8A6} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 		{B5CDB0DC-B26D-48F1-B934-FE5C1C991940} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 		{C74FBA78-13E8-407F-A173-4555AEE41FF3} = {A7F41094-8648-446B-AECD-DCC2CC871F73}
+		{D34F9326-8D8C-43C4-975B-7201A9C97E6E} = {27C5D71D-0721-4221-9286-B94AB07B58CF}
+		{EDEE625E-6815-40E1-935F-35129771A0F8} = {DD020B34-460F-455F-8D17-CF4A949F100B}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {65220BF2-EAE1-4CB2-AA58-EBE80768CB40}

src/Dapr.Jobs/AssemblyInfo.cs

@@ -0,0 +1,16 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 The Dapr Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Dapr.Jobs.Test, PublicKey=0024000004800000940000000602000000240000525341310004000001000100b1f597635c44597fcecb493e2b1327033b29b1a98ac956a1a538664b68f87d45fbaada0438a15a6265e62864947cc067d8da3a7d93c5eb2fcbb850e396c8684dba74ea477d82a1bbb18932c0efb30b64ff1677f85ae833818707ac8b49ad8062ca01d2c89d8ab1843ae73e8ba9649cd28666b539444dcdee3639f95e2a099bb2" )]

src/Dapr.Jobs/Dapr.Jobs.csproj

@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+      <TargetFrameworks>net6;net7;net8</TargetFrameworks>
+      <ImplicitUsings>enable</ImplicitUsings>
+      <Nullable>enable</Nullable>
+      <PackageId>Dapr.Jobs</PackageId>
+      <Title>Dapr Jobs Authoring SDK</Title>
+      <Description>Dapr Jobs SDK for scheduling jobs and tasks with Dapr</Description>
+      <VersionPrefix>0.1.0</VersionPrefix>
+      <VersionSuffix>alpha</VersionSuffix>
+  </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.*"/>
+        <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.*"/>
+    </ItemGroup>
+
+  <ItemGroup>
+    <Compile Include="..\Shared\DaprDefaults.cs" Link="DaprDefaults.cs" />
+  </ItemGroup>
+
+</Project>

src/Dapr.Jobs/DaprJobsClient.cs

@@ -0,0 +1,106 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 The Dapr Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+using System.Net;
+using System.Net.Http.Json;
+
+namespace Dapr.Jobs;
+
+/// <summary>
+/// Defines client operations for managing Dapr jobs.
+/// </summary>
+public class DaprJobsClient
+{
+    private readonly HttpClient httpClient;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DaprJobsClient"/> class.
+    /// </summary>
+    /// <param name="httpClient">The <see cref="HttpClient"/> used to communicate with the Dapr sidecar.</param>
+    public DaprJobsClient(HttpClient httpClient)
+    {
+        this.httpClient = httpClient;
+    }
+
+    /// <summary>
+    /// Schedules a job with a name.
+    /// </summary>
+    /// <param name="name">The name of the job being scheduled.</param>
+    /// <param name="jsonSerializableData">A string value providing any related content. Content is returned when the reminder expires.</param>
+    /// <param name="dueTime">Specifies the time after which this job is invoked.</param>
+    public async Task ScheduleJobAsync(string name, object jsonSerializableData, TimeSpan dueTime)
+    {
+        ArgumentNullException.ThrowIfNull(name, nameof(name));
+        ArgumentNullException.ThrowIfNull(jsonSerializableData, nameof(jsonSerializableData));
+        ArgumentNullException.ThrowIfNull(dueTime, nameof(dueTime));
+
+        var options =
+            new ScheduleJobOptions(new ScheduleJobInnerOptions(jsonSerializableData, dueTime.ToDurationString()));
+
+        var response = await httpClient.PostAsJsonAsync($"/{name}", options);
+
+        switch (response.StatusCode)
+        {
+            case HttpStatusCode.BadRequest:
+                throw new MalformedJobException(response);
+            case HttpStatusCode.InternalServerError:
+                throw new DaprJobsServiceException(response);
+            default:
+                return;
+        }
+    }
+
+    /// <summary>
+    /// Gets a job from its name.
+    /// </summary>
+    /// <param name="name">The name of the scheduled job being retrieved.</param>
+    /// <returns>The job data.</returns>
+    public async Task<string> GetJobDataAsync(string name)
+    {
+        ArgumentNullException.ThrowIfNull(name, nameof(name));
+
+        var response = await httpClient.GetAsync($"/{name}");
+
+        switch (response.StatusCode)
+        {
+            case HttpStatusCode.BadRequest:
+                throw new MalformedJobException(response);
+            case HttpStatusCode.InternalServerError:
+                throw new DaprJobsServiceException(response);
+            default:
+                return await response.Content.ReadAsStringAsync();
+        }
+    }
+
+    /// <summary>
+    /// Deletes a named job.
+    /// </summary>
+    /// <param name="name">The name of the job being deleted.</param>
+    /// <returns></returns>
+    public async Task DeleteJobAsync(string name)
+    {
+        ArgumentNullException.ThrowIfNull(name, nameof(name));
+
+        var response = await httpClient.DeleteAsync($"/{name}");
+
+        switch (response.StatusCode)
+        {
+            case HttpStatusCode.BadRequest:
+                throw new MalformedJobException(response);
+            case HttpStatusCode.InternalServerError:
+                throw new DaprJobsServiceException(response);
+            default:
+                return;
+        }
+    }
+}

src/Dapr.Jobs/DaprJobsServiceException.cs

@@ -0,0 +1,38 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 The Dapr Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+namespace Dapr.Jobs;
+
+/// <summary>
+/// The exception type thrown when an exception is encountered using the Dapr Jobs service.
+/// </summary>
+[Serializable]
+public class DaprJobsServiceException : Exception
+{
+    /// <summary>
+    /// Initializes a new <see cref="DaprJobsServiceException"/> for a non-successful HTTP request.
+    /// </summary>
+    /// <param name="response"></param>
+    public DaprJobsServiceException(HttpResponseMessage? response) : base(FormatExceptionForFailedRequest())
+    {
+        Response = response;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="HttpResponseMessage"/> of the request that failed. Will be <c>null</c> if the
+    /// failure was not related to an HTTP request or preventing the response from being received.
+    /// </summary>
+    public HttpResponseMessage? Response { get; }
+
+    private static string FormatExceptionForFailedRequest() => "An exception occurred while interacting with the Jobs API";
+}

src/Dapr.Jobs/JobsServiceCollectionExtensions.cs

@@ -0,0 +1,50 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 The Dapr Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Dapr.Jobs;
+
+/// <summary>
+/// Contains extension methods for using Dapr Jobs with dependency injection.
+/// </summary>
+public static class JobsServiceCollectionExtensions
+{
+    /// <summary>
+    /// Adds Dapr Jobs support to the service collection.
+    /// </summary>
+    /// <param name="serviceCollection">The <see cref="IServiceCollection"/>.</param>
+    public static IServiceCollection AddDaprJobs(this IServiceCollection serviceCollection)
+    {
+        ArgumentNullException.ThrowIfNull(serviceCollection, nameof(serviceCollection));
+
+        serviceCollection.AddHttpClient<DaprJobsClient>(httpClient =>
+        {
+            var jobsHttpEndpoint = new Uri($"{DaprDefaults.GetDefaultHttpEndpoint()}/v1.0-alpha1/jobs/");
+            if (jobsHttpEndpoint.Scheme != "http" && jobsHttpEndpoint.Scheme != "https")
+                throw new InvalidOperationException("The HTTP endpoint must use http or https");
+
+            httpClient.BaseAddress = jobsHttpEndpoint;
+            httpClient.DefaultRequestHeaders.Accept.Add(
+                new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
+
+            var daprApiToken = DaprDefaults.GetDefaultDaprApiToken();
+            if (!string.IsNullOrEmpty(daprApiToken))
+            {
+                httpClient.DefaultRequestHeaders.Add("dapr-api-token", daprApiToken);
+            }
+        });
+
+        return serviceCollection;
+    }
+}

src/Dapr.Jobs/MalformedJobException.cs

@@ -0,0 +1,38 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 The Dapr Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+namespace Dapr.Jobs;
+
+/// <summary>
+/// The exception type thrown when an malformed request is made to the Dapr Jobs service.
+/// </summary>
+[Serializable]
+public class MalformedJobException : Exception
+{
+    /// <summary>
+    /// Initializes a new <see cref="DaprJobsServiceException"/> for a non-successful HTTP request.
+    /// </summary>
+    /// <param name="response"></param>
+    public MalformedJobException(HttpResponseMessage? response) : base(FormatExceptionForFailedRequest())
+    {
+        Response = response;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="HttpResponseMessage"/> of the request that failed. Will be <c>null</c> if the
+    /// failure was not related to an HTTP request or preventing the response from being received.
+    /// </summary>
+    public HttpResponseMessage? Response { get; }
+
+    private static string FormatExceptionForFailedRequest() => "The request made to the Jobs API was malformed";
+}

src/Dapr.Jobs/ScheduleJobOptions.cs

@@ -0,0 +1,31 @@
+// ------------------------------------------------------------------------
+// Copyright 2024 The Dapr Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//     http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ------------------------------------------------------------------------
+
+using System.Text.Json.Serialization;
+
+namespace Dapr.Jobs;
+
+/// <summary>
+/// The options used to schedule a new job.
+/// </summary>
+/// <param name="JobData">The internal job options.</param>
+internal record ScheduleJobOptions([property: JsonPropertyName("job")] ScheduleJobInnerOptions JobData);
+
+/// <summary>
+/// The payload used to schedule a new job.
+/// </summary>
+/// <param name="JsonSerializableData">The JSON serializable data payload.</param>
+/// <param name="DueTime">The </param>
+internal record ScheduleJobInnerOptions(
+    [property: JsonPropertyName("data")] object JsonSerializableData, 
+    [property: JsonPropertyName("dueTime")] string DueTime);