durable task scheduler auth extension support #362

YunchuWang · 2025-01-09T02:31:59Z

This pull request introduces a new set of Azure extensions for the Durable Task Framework, including project setup, implementation of core classes and methods, and unit tests. The most important changes include adding new projects to the solution, defining the core classes and methods for Azure integration, and creating unit tests to ensure the functionality of the new extensions.

Project Setup:

Added new projects Extensions and Azure to the solution Microsoft.DurableTask.sln and configured their build settings. [1] [2] [3]

Core Implementation:

Created the Azure.csproj file to define the Azure extensions project, including dependencies and target frameworks.
Implemented the DurableTaskSchedulerConnectionString class to parse and manage connection strings for the Durable Task Scheduler service.
Added DurableTaskSchedulerExtensions class with methods to configure Durable Task Worker and Client to use the Durable Task Scheduler service.
Defined DurableTaskSchedulerOptions class to encapsulate configuration options for the Durable Task Scheduler.

Unit Tests:

Created unit tests in DurableTaskSchedulerConnectionStringTests.cs to validate the parsing and handling of connection strings.

save initial

cgillum

Looking great! I added some comments.

src/Extensions/Azure/DurableTaskSchedulerConnectionString.cs

src/Extensions/Azure/DurableTaskSchedulerOptions.cs

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

cgillum · 2025-01-09T03:35:41Z

@jviau would you mind taking a look at this as well?

The main feedback I'm interested in from you is the package name/organization. The idea behind this PR is to introduce a mechanism for configuring the gRPC channels to work with the Durable Task Scheduler (DTS). This includes setting up the appropriate auth and some other service-specific headers (like the task hub name). I figured this might be the right time to introduce an "Extensions" concept and make "Azure" the extension consumers should use for talking to DTS. There could be others in the future. WDYT?

This reverts commit 131c575.

jviau · 2025-01-09T18:56:06Z

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

+
+    static GrpcChannel GetGrpcChannelForOptions(DurableTaskSchedulerOptions options)
+    {
+        if (string.IsNullOrEmpty(options.EndpointAddress))


We have a set of helper methods for this, Check.Argument(...)

jviau · 2025-01-09T18:57:13Z

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

+
+        if (!endpoint.Contains("://"))
+        {
+            endpoint = $"https://{endpoint}";


Is performing this kind of manipulation standard practice? Asking because I wonder if users would be confused by https:// being appended?

Not sure what the best practice is, but we did this because a ton of people were making mistakes in terms of whether or not to include the https:// prefix, so we decided to just support both.

Understood. I wonder if we can move the manipulation to the options object, so it will prepend the https:// in the setter of Endpoint.

jviau · 2025-01-09T19:06:40Z

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

+        return new ArgumentException(message: $"Required option '{optionName}' was not provided.");
+    }
+
+    sealed class TokenCache(TokenCredential credential, TokenRequestContext context, TimeSpan margin)


Did you look into Azure.Identity library to see if they already do token caching?

I found this: maybe you can copy and adapt it for usage here: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/src/Pipeline/BearerTokenAuthenticationPolicy.cs#L219

jviau · 2025-01-09T19:28:49Z

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

+        builder.UseGrpc(GetGrpcChannelForOptions(options));
+    }
+
+    static GrpcChannel GetGrpcChannelForOptions(DurableTaskSchedulerOptions options)


Small suggestion: I like putting options-projecting methods like this on the options object itself (as internal).

jviau · 2025-01-09T19:31:50Z

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

+
+        string resourceId = options.ResourceId ?? "https://durabletask.io";
+        int processId = Environment.ProcessId;
+        string workerId = options.WorkerId ?? $"{Environment.MachineName},{processId},{Guid.NewGuid():N}";


Is there any formality to worker ID creation? Also, I recommend putting this default-logic into the options object.

No formality yet. We expect to iterate on this over time.

jviau · 2025-01-09T19:35:14Z

Microsoft.DurableTask.sln

+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure", "src\Extensions\Azure\Azure.csproj", "{662BF73D-A4DD-4910-8625-7C12F1ACDBEC}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Extensions.Azure.Tests", "test\Extensions.Azure.Tests\Extensions.Azure.Tests.csproj", "{DBB5DB4E-A1B0-4C86-A233-213789C46929}"


Mirror src layout in test please. So, this project should be in test/Extensions/Azure.Tests.csproj

jviau · 2025-01-09T19:41:10Z

src/Extensions/Azure/Azure.csproj

+
+  <ItemGroup>
+    <PackageReference Include="Azure.Identity" Version="1.13.1" />
+    <PackageReference Include="Grpc.Net.Client" Version="2.67.0" />


There is also a package Grpc.Net.ClientFactory which adds constructing grpc clients via DI. Have you evaluated if that is applicable here? I think one of the major benefits to it is how the underlying HttpClient is managed. Not saying it is mandatory, but want to make sure it is evaluated and either adopted or ruled out.

jviau · 2025-01-09T19:46:02Z

src/Extensions/Azure/DurableTaskSchedulerOptions.cs

+    /// Gets or sets the resource ID of the Durable Task Scheduler resource.
+    /// The default value is https://durabletask.io.
+    /// </summary>
+    public string? ResourceId { get; set; }


Is this needed, or can it be parsed from EndpointAddress?

How will this work in other clouds?

This is not part of the endpoint address. We could include it as part of the connection string, but I'm not sure yet whether/when we'll need to make this generally configurable. I suggest we not worry about this until we're actually ready to test other clouds.

Oh it isn't part of the address? So endpoints aren't of the form {my-resource}.{region}.durabletask.io?

No - this is an OAuth 2.0 resource ID. It represents the entire DTS service owned by us. It's not a customer-owned scheduler resource.

jviau · 2025-01-09T20:02:48Z

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

+    {
+        DurableTaskSchedulerOptions options = new(endpointAddress, taskHubName, credential);
+
+        configure?.Invoke(options);


This class should leverage options configuration instead of directly calling configure?.Invoke.

IE:

builder.Services.Configure(builder.Name, configure);

You will then need to make some adjustments to UseGrpc call:

// method body if (configure is not null) { builder.Services.Configure(builder.Name, configure); // from above, to configure this options object } builder.Services.TryAddEnumerable( ServiceDescription.Singleton<IConfigureOptions<GrpcDurableTaskWorkerOptions>, ConfigureGrpcChannel>()); builder.UseGrpc(_ => { }); // empty callback as the line above does the work. This call is to get the build target registered. // end method body // helper internal class class ConfigureGrpcChannel(IOptionsMonitor<DurableTaskSchedulerOptions> schedulerOptions) : IConfigureNamedOptions<GrpcDurableTaskWorkerOptions> { public void Configure(GrpcDurableTaskWorkerOptions options) => this.Configure(Options.DefaultName, options); public void Configure(string name, GrpcDurableTaskWorkerOptions options) { DurableTaskSchedulerOptions source = schedulerOptions.Get(name); options.Channel = source.CreateChannel(); // method added to options object. } }

The benefit here is now users can call chain and they can use options configuration directly.

Want to also mention that this is an important change. It will allow for more flexible configuration of this, such as consuming configuration from more varied sources (such as Azure AppConfiguration). With this, an advanced user could write the following code:

builder.Services.AddOptions<DurableTaskSchedulerOptions>(builder.Name) .Configure<IConfiguration>((options, config) => options.Endpoint = config["SomeConfigKeyThatHasMyEndpoint"]);

jviau · 2025-01-09T20:04:54Z

src/Extensions/Azure/DurableTaskSchedulerOptions.cs

+    /// <summary>
+    /// Initializes a new instance of the <see cref="DurableTaskSchedulerOptions"/> class.
+    /// </summary>
+    internal DurableTaskSchedulerOptions(string endpointAddress, string taskHubName, TokenCredential? credential = null)


To follow options pattern, this will need a parameterless constructor. You can leverage options validation to ensure all required fields are set.

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options?view=aspnetcore-9.0#options-validation

durable task scheduler auth extension

fc053ec

save initial

cgillum reviewed Jan 9, 2025

View reviewed changes

YunchuWang added 14 commits January 8, 2025 22:46

support local conn with no auth and via http

6f1d2bc

be consistent with azuremanaged targetversion

51e39bd

clean

6987f1b

namespace

e162815

fix

e19de44

fix

3a6dc52

doc

65dfb85

ppl

29445a0

remove

e63f12a

test proj to sln

5c72ee7

fix warning

c6e42c5

remove dup

6a66aaa

fix

131c575

Revert "fix"

65fa607

This reverts commit 131c575.

YunchuWang requested a review from cgillum January 9, 2025 10:05

jviau reviewed Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

durable task scheduler auth extension support #362

durable task scheduler auth extension support #362

YunchuWang commented Jan 9, 2025

cgillum left a comment

cgillum commented Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

cgillum Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

cgillum Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

cgillum Jan 9, 2025

jviau Jan 9, 2025

cgillum Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

jviau Jan 9, 2025

durable task scheduler auth extension support #362

Are you sure you want to change the base?

durable task scheduler auth extension support #362

Conversation

YunchuWang commented Jan 9, 2025

Project Setup:

Core Implementation:

Unit Tests:

cgillum left a comment

Choose a reason for hiding this comment

cgillum commented Jan 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment