Initial integration of Durable Task Scheduler (i.e. emulator) #9294

philliphoff · 2025-05-13T21:42:25Z

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #8926

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire-docs issue:
    - dotnet/docs-aspire#3400
- No

philliphoff · 2025-05-13T22:23:09Z

Looks like I need to get a couple packages into the Azure DevOps feeds:

Microsoft.DurableTask.Client.AzureManaged
Microsoft.DurableTask.Worker.AzureManaged

davidfowl · 2025-05-14T08:14:23Z

src/Aspire.Hosting.Azure.Functions/DurableTask/QueryParameterReference.cs

+        return WebUtility.UrlEncode(value);
+    }
+
+    string IManifestExpressionProvider.ValueExpression => WebUtility.UrlEncode(_reference.ValueExpression);


This is #3117

Good to know! Will be happy to drop this implementation when there's a common solution.

davidfowl · 2025-05-22T07:20:05Z

playground/DurableTask/DurableTask.Scheduler.WebApi/Program.cs

+
+var app = builder.Build();
+
+app.MapPost("/create", async ([FromBody] EchoValue value, [FromServices] DurableTaskClient durableTaskClient) =>


It magically knows!

Suggested change

app.MapPost("/create", async ([FromBody] EchoValue value, [FromServices] DurableTaskClient durableTaskClient) =>

app.MapPost("/create", async (EchoValue value, DurableTaskClient durableTaskClient) =>

davidfowl · 2025-05-22T07:20:25Z

playground/DurableTask/DurableTask.Scheduler.WebApi/Program.cs

+        clientBuilder.UseDurableTaskScheduler(
+            builder.Configuration.GetConnectionString("taskhub") ?? throw new InvalidOperationException("Scheduler connection string not configured."),
+            options =>
+            {
+                options.AllowInsecureCredentials = true;
+            });


Should we build a client integration?

...yes? It's complicated because consuming applications can be either DTS "clients" or "workers" (and sometimes both), and there are separate SDKs for each which means multiple client integrations. Also, there are two sets of SDKs that apps can use (and you might consider another scenario a third) which further expands the matrix.

I'd say we should start with client integrations for the "modern" SDK, worker first and then client, as the former is the most common. Then, if there's demand, look at integrations for the "older" SDKs. That said, any client integrations would be follow up PRs.

davidfowl · 2025-05-29T20:20:50Z

playground/DurableTask/DurableTask.Scheduler.ExternalAppHost/Program.cs

+
+var scheduler =
+    builder.AddDurableTaskScheduler("scheduler")
+           .RunAsExisting(builder.AddParameter("scheduler-connection-string"));


Why is this in the sample?

The intent was to have examples that demonstrate the two main DTS scenarios: use of the DTS emulator and use of an existing DTS instance.

One thing I'm having a hard time understanding is the deployment story here. Is this an azure resource as well?

Yes, DTS is an Azure resource (though I'm not intending to support deployment in this initial pass). I did a little experimenting with the Bicep base resource type that other Azure resources are built upon, but they rely on Azure provisioning libraries that do not exist, yet, for DTS.

So this model is going to be:
AddAzureDurableTaskScheudler().RunAsEmulator() yes?

davidfowl · 2025-05-29T20:21:53Z

src/Aspire.Hosting.Azure.Functions/DurableTask/IResourceWithDashboard.cs

+
+namespace Aspire.Hosting.Azure;
+
+interface IResourceWithDashboard : IResource


style nit:

Suggested change

interface IResourceWithDashboard : IResource

internal interface IResourceWithDashboard : IResource

Also, do we need this? This naming is very generic and only used by one resource.

It's used by both DTS resources, where each implements in a slightly different manner. I've updated the name to be DTS specific.

davidfowl · 2025-05-29T20:22:59Z

src/Aspire.Hosting.Azure.Functions/DurableTask/DurableTaskSchedulerExtensions.cs

+        builder
+            .WithEndpoint(name: DurableTaskConstants.Scheduler.Emulator.Endpoints.Worker, scheme: "http", targetPort: 8080)
+            .WithEndpoint(name: DurableTaskConstants.Scheduler.Emulator.Endpoints.Dashboard, scheme: "http", targetPort: 8082)
+            .WithAnnotation(


WithEnvironment?

Missed that overload; updated.

Also WithHttpEndpoint. Do we also need to add health checks?

Updated that, too. I suppose health checks for the emulator could be useful, though I need to look at the API and examples. I'd be inclined to leave that as a separate, follow up PR.

src/Aspire.Hosting.Azure.Functions/DurableTask/DurableTaskSchedulerResource.cs

Signed-off-by: Phillip Hoff <phillip@orst.edu>

davidfowl · 2025-05-30T04:42:51Z

playground/DurableTask/DurableTask.Scheduler.AppHost/Program.cs

+           .RunAsEmulator(
+                options =>
+                {
+                    options.WithDynamicTaskHubs();


Why is this explicit call needed?

Just as a demonstration of configuring options on the emulator. (Not every Aspire application will want to use dynamic task hub names.)

Signed-off-by: Phillip Hoff <phillip@orst.edu>

philliphoff added 3 commits May 12, 2025 13:38

Port integration and samples.

6b698ba

Include remainder.

6cdadb2

Pull in unit/integration test.

1b7b410

github-actions bot added the area-integrations Issues pertaining to Aspire Integrations packages label May 13, 2025

Merge branch 'main' into philliphoff-durable-task-scheduler

ae5c3c2

philliphoff mentioned this pull request May 13, 2025

[New article]: New Durable Task Scheduler integration dotnet/docs-aspire#3400

Open

Update docs.

c436f52

davidfowl reviewed May 14, 2025

View reviewed changes

philliphoff added 4 commits May 14, 2025 20:12

Add comment re: existing issue.

7fbbbfd

Eliminate ParameterOrValue type.

7be4aaa

Merge branch 'main' into philliphoff-durable-task-scheduler

0bcf482

Update new solution file with playground projects.

97bd8b2

davidfowl reviewed May 22, 2025

View reviewed changes

davidfowl reviewed May 29, 2025

View reviewed changes

src/Aspire.Hosting.Azure.Functions/DurableTask/DurableTaskSchedulerResource.cs Outdated Show resolved Hide resolved

philliphoff added 6 commits May 29, 2025 13:38

Remove slash that breaks dotnet build.

2bdb505

Merge branch 'main' into philliphoff-durable-task-scheduler

ac9bbe1

Refactoring of surrogate resource initialization and sample fixups.

9eb2b7b

Mark internal types as internal.

c3338d2

Simplify IResourceWithDashboard.

6434fed

Rename dashboard interface.

a7e6a23

Signed-off-by: Phillip Hoff <phillip@orst.edu>

davidfowl reviewed May 30, 2025

View reviewed changes

Use simpler form of WithHttpEndpoint().

76c6941

Signed-off-by: Phillip Hoff <phillip@orst.edu>


		var app = builder.Build();

		app.MapPost("/create", async ([FromBody] EchoValue value, [FromServices] DurableTaskClient durableTaskClient) =>

	app.MapPost("/create", async ([FromBody] EchoValue value, [FromServices] DurableTaskClient durableTaskClient) =>
	app.MapPost("/create", async (EchoValue value, DurableTaskClient durableTaskClient) =>


		namespace Aspire.Hosting.Azure;

		interface IResourceWithDashboard : IResource

	interface IResourceWithDashboard : IResource
	internal interface IResourceWithDashboard : IResource

Initial integration of Durable Task Scheduler (i.e. emulator) #9294

Are you sure you want to change the base?

Initial integration of Durable Task Scheduler (i.e. emulator) #9294

Uh oh!

Conversation

philliphoff commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

philliphoff commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

philliphoff May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

philliphoff commented May 13, 2025 •

edited

Loading

philliphoff commented May 13, 2025 •

edited

Loading

philliphoff May 29, 2025 •

edited

Loading