Merge branch 'main' into philliphoff-orchestration-tracing

Author: philliphoff

CHANGELOG.md

@@ -2,13 +2,27 @@
 
 ## (Unreleased)
 
-- Add New Property Properties to TaskOrchestrationContext by @nytian in [#415](https://github.com/microsoft/durabletask-dotnet/pull/415)
-- Add automatic retry on gateway timeout in `GrpcDurableTaskClient.WaitForInstanceCompletionAsync` in [#412](https://github.com/microsoft/durabletask-dotnet/pull/412))
-- Add specific logging for NotFound error on worker connection by @halspang in ([#413](https://github.com/microsoft/durabletask-dotnet/pull/413))
-- Add user agent header to gRPC called in ([#417](https://github.com/microsoft/durabletask-dotnet/pull/417))
+- Expose gRPC retry options in Azure Managed extensions ([#447](https://github.com/microsoft/durabletask-dotnet/pull/447))
+
+## v1.12.0
+
+- Activity tag support ([#426](https://github.com/microsoft/durabletask-dotnet/pull/426))
+- Adding Analyzer to build and release ([#444](https://github.com/microsoft/durabletask-dotnet/pull/444))
+- Add ability to filter orchestrations at worker ([#443](https://github.com/microsoft/durabletask-dotnet/pull/443))
+- Removing breaking change for TaskOptions ([#446](https://github.com/microsoft/durabletask-dotnet/pull/446))
+
+## v1.11.0
+
+- Add New Property Properties to TaskOrchestrationContext ([#415](https://github.com/microsoft/durabletask-dotnet/pull/415))
+- Add automatic retry on gateway timeout in `GrpcDurableTaskClient.WaitForInstanceCompletionAsync` ([#412](https://github.com/microsoft/durabletask-dotnet/pull/412))
+- Add specific logging for NotFound error on worker connection ([#413](https://github.com/microsoft/durabletask-dotnet/pull/413))
+- Add user agent header to gRPC called ([#417](https://github.com/microsoft/durabletask-dotnet/pull/417))
 - Enrich User-Agent Header in gRPC Metadata to indicate Client or Worker as caller ([#421](https://github.com/microsoft/durabletask-dotnet/pull/421))
+- Change DTS user agent metadata to avoid overlap with gRPC user agent ([#423](https://github.com/microsoft/durabletask-dotnet/pull/423))
 - Add extension methods for registering entities by type ([#427](https://github.com/microsoft/durabletask-dotnet/pull/427))
 - Add TaskVersion and utilize it for version overrides when starting orchestrations ([#416](https://github.com/microsoft/durabletask-dotnet/pull/416))
+- Update sub-orchestration default versioning ([#437](https://github.com/microsoft/durabletask-dotnet/pull/437))
+- Distributed Tracing for Entities (Isolated) ([#404](https://github.com/microsoft/durabletask-dotnet/pull/404))
 
 ## v1.10.0
 

eng/targets/Release.props

@@ -17,7 +17,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>1.11.0</VersionPrefix>
+    <VersionPrefix>1.12.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
   </PropertyGroup>
 

src/Abstractions/TaskOptions.cs

@@ -14,9 +14,9 @@ public record TaskOptions
     /// Initializes a new instance of the <see cref="TaskOptions"/> class.
     /// </summary>
     /// <param name="retry">The task retry options.</param>
-    public TaskOptions(TaskRetryOptions? retry = null)
+    public TaskOptions(TaskRetryOptions? retry)
+        : this(retry, null)
     {
-        this.Retry = retry;
     }
 
     /// <summary>

src/Analyzers/AnalyzerReleases.Shipped.md

@@ -1,3 +1,22 @@
 ; Shipped analyzer releases
-; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
+; https://github.com/dotnet/roslyn/blob/main/src/RoslynAnalyzers/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
 
+## Release 0.1.0
+
+### New Rules
+
+Rule ID | Category | Severity | Notes
+--------|----------|----------|-------
+DURABLE0001 | Orchestration | Warning | DateTimeOrchestrationAnalyzer
+DURABLE0002 | Orchestration | Warning | GuidOrchestrationAnalyzer
+DURABLE0003 | Orchestration | Warning | DelayOrchestrationAnalyzer
+DURABLE0004 | Orchestration | Warning | ThreadTaskOrchestrationAnalyzer
+DURABLE0005 | Orchestration | Warning | IOOrchestrationAnalyzer
+DURABLE0006 | Orchestration | Warning | EnvironmentOrchestrationAnalyzer
+DURABLE0007 | Orchestration | Warning | CancellationTokenOrchestrationAnalyzer
+DURABLE0008 | Orchestration | Warning | OtherBindingsOrchestrationAnalyzer
+DURABLE1001 | Attribute Binding | Error | OrchestrationTriggerBindingAnalyzer
+DURABLE1002 | Attribute Binding | Error | DurableClientBindingAnalyzer
+DURABLE1003 | Attribute Binding | Error | EntityTriggerBindingAnalyzer
+DURABLE2001 | Activity | Warning | MatchingInputOutputTypeActivityAnalyzer
+DURABLE2002 | Activity | Warning | MatchingInputOutputTypeActivityAnalyzer

src/Analyzers/AnalyzerReleases.Unshipped.md

@@ -1,20 +1,2 @@
 ; Unshipped analyzer release
-; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
-
-### New Rules
-
-Rule ID | Category | Severity | Notes
---------|----------|----------|-------
-DURABLE0001 | Orchestration | Warning | DateTimeOrchestrationAnalyzer
-DURABLE0002 | Orchestration | Warning | GuidOrchestrationAnalyzer
-DURABLE0003 | Orchestration | Warning | DelayOrchestrationAnalyzer
-DURABLE0004 | Orchestration | Warning | ThreadTaskOrchestrationAnalyzer
-DURABLE0005 | Orchestration | Warning | IOOrchestrationAnalyzer
-DURABLE0006 | Orchestration | Warning | EnvironmentOrchestrationAnalyzer
-DURABLE0007 | Orchestration | Warning | CancellationTokenOrchestrationAnalyzer
-DURABLE0008 | Orchestration | Warning | OtherBindingsOrchestrationAnalyzer
-DURABLE1001 | Attribute Binding | Error | OrchestrationTriggerBindingAnalyzer
-DURABLE1002 | Attribute Binding | Error | DurableClientBindingAnalyzer
-DURABLE1003 | Attribute Binding | Error | EntityTriggerBindingAnalyzer
-DURABLE2001 | Activity | Warning | MatchingInputOutputTypeActivityAnalyzer
-DURABLE2002 | Activity | Warning | MatchingInputOutputTypeActivityAnalyzer
+; https://github.com/dotnet/roslyn/blob/main/src/RoslynAnalyzers/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md

src/Analyzers/Analyzers.csproj

@@ -11,13 +11,13 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>0.0.1</VersionPrefix>
-    <VersionSuffix>preview.1</VersionSuffix>
+    <VersionPrefix>0.1.0</VersionPrefix>
+    <VersionSuffix></VersionSuffix>
     <PackageDescription>.NET Analyzers for the Durable Task SDK.</PackageDescription>
     <NeutralLanguage>en</NeutralLanguage>
     <IncludeBuildOutput>false</IncludeBuildOutput> <!-- Do not include the analyzer as a lib dependency -->
     <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
-    <IsPackable>false</IsPackable> <!-- Do not publish it until it is ready to release -->
+    <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>

src/Client/AzureManaged/DurableTaskSchedulerClientOptions.cs

@@ -6,8 +6,8 @@
 using Azure.Identity;
 using Grpc.Core;
 using Grpc.Net.Client;
-using Microsoft.DurableTask;
 using Microsoft.DurableTask.Client;
+using GrpcConfig = Grpc.Net.Client.Configuration;
 
 namespace Microsoft.DurableTask;
 
@@ -46,6 +46,11 @@ public class DurableTaskSchedulerClientOptions
     /// </summary>
     public bool AllowInsecureCredentials { get; set; }
 
+    /// <summary>
+    /// Gets or sets the options that determine how and when calls made to the scheduler will be retried.
+    /// </summary>
+    public ClientRetryOptions? RetryOptions { get; set; }
+
     /// <summary>
     /// Creates a new instance of <see cref="DurableTaskSchedulerClientOptions"/> from a connection string.
     /// </summary>
@@ -109,6 +114,45 @@ this.Credential is not null
                 metadata.Add("Authorization", $"Bearer {token.Token}");
             });
 
+        GrpcConfig.ServiceConfig? serviceConfig = GrpcRetryPolicyDefaults.DefaultServiceConfig;
+        if (this.RetryOptions != null)
+        {
+            GrpcConfig.RetryPolicy retryPolicy = new GrpcConfig.RetryPolicy
+            {
+                MaxAttempts = this.RetryOptions.MaxRetries ?? GrpcRetryPolicyDefaults.DefaultMaxAttempts,
+                InitialBackoff = TimeSpan.FromMilliseconds(this.RetryOptions.InitialBackoffMs ?? GrpcRetryPolicyDefaults.DefaultInitialBackoffMs),
+                MaxBackoff = TimeSpan.FromMilliseconds(this.RetryOptions.MaxBackoffMs ?? GrpcRetryPolicyDefaults.DefaultMaxBackoffMs),
+                BackoffMultiplier = this.RetryOptions.BackoffMultiplier ?? GrpcRetryPolicyDefaults.DefaultBackoffMultiplier,
+                RetryableStatusCodes = { StatusCode.Unavailable }, // Always retry on Unavailable.
+            };
+
+            if (this.RetryOptions.RetryableStatusCodes != null)
+            {
+                foreach (StatusCode statusCode in this.RetryOptions.RetryableStatusCodes)
+                {
+                    // Added by default, don't need to have it added twice.
+                    if (statusCode == StatusCode.Unavailable)
+                    {
+                        continue;
+                    }
+
+                    retryPolicy.RetryableStatusCodes.Add(statusCode);
+                }
+            }
+
+            GrpcConfig.MethodConfig methodConfig = new GrpcConfig.MethodConfig
+            {
+                // MethodName.Default applies this retry policy configuration to all gRPC methods on the channel.
+                Names = { GrpcConfig.MethodName.Default },
+                RetryPolicy = retryPolicy,
+            };
+
+            serviceConfig = new GrpcConfig.ServiceConfig
+            {
+                MethodConfigs = { methodConfig },
+            };
+        }
+
         // Production will use HTTPS, but local testing will use HTTP
         ChannelCredentials channelCreds = endpoint.StartsWith("https://", StringComparison.OrdinalIgnoreCase) ?
             ChannelCredentials.SecureSsl :
@@ -117,7 +161,7 @@ this.Credential is not null
         {
             Credentials = ChannelCredentials.Create(channelCreds, managedBackendCreds),
             UnsafeUseInsecureChannelCallCredentials = this.AllowInsecureCredentials,
-            ServiceConfig = GrpcRetryPolicyDefaults.DefaultServiceConfig,
+            ServiceConfig = serviceConfig,
         });
     }
 
@@ -173,4 +217,35 @@ this.Credential is not null
                     nameof(connectionString));
         }
     }
+
+    /// <summary>
+    /// Options used to configure retries used when making calls to the Scheduler.
+    /// </summary>
+    public class ClientRetryOptions
+    {
+        /// <summary>
+        /// Gets or sets the maximum number of times a call should be retried.
+        /// </summary>
+        public int? MaxRetries { get; set; }
+
+        /// <summary>
+        /// Gets or sets the initial backoff in milliseconds.
+        /// </summary>
+        public int? InitialBackoffMs { get; set; }
+
+        /// <summary>
+        /// Gets or sets the maximum backoff in milliseconds.
+        /// </summary>
+        public int? MaxBackoffMs { get; set; }
+
+        /// <summary>
+        /// Gets or sets the backoff multiplier for exponential backoff.
+        /// </summary>
+        public double? BackoffMultiplier { get; set; }
+
+        /// <summary>
+        /// Gets or sets the list of status codes that can be retried.
+        /// </summary>
+        public IList<StatusCode>? RetryableStatusCodes { get; set; }
+    }
 }

src/Shared/Shared.csproj

@@ -17,6 +17,7 @@
     <PackageReference Include="Microsoft.Azure.DurableTask.Core" />
     <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" />
     <PackageReference Include="Microsoft.Extensions.Hosting" />
+    <PackageReference Include="System.Text.Json"/>
   </ItemGroup>
 
 </Project>

src/Worker/Core/DependencyInjection/DurableTaskWorkerBuilderExtensions.cs

@@ -109,4 +109,32 @@ public static IDurableTaskWorkerBuilder UseVersioning(this IDurableTaskWorkerBui
         });
         return builder;
     }
+
+    /// <summary>
+    /// Adds an orchestration filter to the specified <see cref="IDurableTaskWorkerBuilder"/>.
+    /// </summary>
+    /// <param name="builder">The builder to set the builder target for.</param>
+    /// <typeparam name="TOrchestrationFilter">The implementation of a <see cref="IOrchestrationFilter"/> that will be bound.</typeparam>
+    /// <returns>The same <see cref="IDurableTaskWorkerBuilder"/> instance, allowing for method chaining.</returns>
+    [Obsolete("Experimental")]
+    public static IDurableTaskWorkerBuilder UseOrchestrationFilter<TOrchestrationFilter>(this IDurableTaskWorkerBuilder builder) where TOrchestrationFilter : class, IOrchestrationFilter
+    {
+        Check.NotNull(builder);
+        builder.Services.AddSingleton<IOrchestrationFilter, TOrchestrationFilter>();
+        return builder;
+    }
+
+    /// <summary>
+    /// Adds an orchestration filter to the specified <see cref="IDurableTaskWorkerBuilder"/>.
+    /// </summary>
+    /// <param name="builder">The builder to set the builder target for.</param>
+    /// <param name="filter">The instance of an <see cref="IOrchestrationFilter"/> to use.</param>
+    /// <returns>The same <see cref="IDurableTaskWorkerBuilder"/> instance, allowing for method chaining.</returns>
+    [Obsolete("Experimental")]
+    public static IDurableTaskWorkerBuilder UseOrchestrationFilter(this IDurableTaskWorkerBuilder builder, IOrchestrationFilter filter)
+    {
+        Check.NotNull(builder);
+        builder.Services.AddSingleton(filter);
+        return builder;
+    }
 }

src/Worker/Core/DurableTaskWorkerOptions.cs

@@ -145,6 +145,12 @@ public DataConverter DataConverter
     /// </summary>
     public bool IsVersioningSet { get; internal set; }
 
+    /// <summary>
+    /// Gets or sets a callback function that determines whether an orchestration should be accepted for work.
+    /// </summary>
+    [Obsolete("Experimental")]
+    public IOrchestrationFilter? OrchestrationFilter { get; set; }
+
     /// <summary>
     /// Gets a value indicating whether <see cref="DataConverter" /> was explicitly set or not.
     /// </summary>
@@ -156,6 +162,7 @@ public DataConverter DataConverter
     /// </remarks>
     internal bool DataConverterExplicitlySet { get; private set; }
 
+
     /// <summary>
     /// Applies these option values to another.
     /// </summary>
@@ -169,6 +176,7 @@ internal void ApplyTo(DurableTaskWorkerOptions other)
             other.MaximumTimerInterval = this.MaximumTimerInterval;
             other.EnableEntitySupport = this.EnableEntitySupport;
             other.Versioning = this.Versioning;
+            other.OrchestrationFilter = this.OrchestrationFilter;
         }
     }