Adopt Polly V8 in Microsoft.Extensions.Http.Resilience

Author: martintmk

bench/Libraries/Microsoft.Extensions.Http.Resilience.PerformanceTests/HttpClientFactory.cs

@@ -61,7 +61,7 @@ public static ServiceProvider InitializeServiceProvider(HedgingClientType client
     private static IServiceCollection AddHedging(this IServiceCollection services, HedgingClientType clientType)
     {
         var clientBuilder = services.AddHttpClient(clientType.ToString(), client => client.Timeout = Timeout.InfiniteTimeSpan);
-        var hedgingBuilder = clientBuilder.AddStandardHedgingHandler().SelectPipelineByAuthority(SimpleClassifications.PublicData);
+        var hedgingBuilder = clientBuilder.AddStandardHedgingHandler().SelectStrategyByAuthority(SimpleClassifications.PublicData);
         _ = clientBuilder.AddHttpMessageHandler<NoRemoteCallHandler>();
 
         int routes = clientType.HasFlag(HedgingClientType.ManyRoutes) ? 50 : 2;

eng/Packages/General.props

@@ -34,10 +34,10 @@
     <PackageVersion Include="OpenTelemetry" Version="1.4.0" />
     <PackageVersion Include="Polly.Contrib.Simmy" Version="0.3.0" />
     <PackageVersion Include="Polly.Contrib.WaitAndRetry" Version="1.1.1" />
-    <PackageVersion Include="Polly" Version="8.0.0-alpha.1" />
-    <PackageVersion Include="Polly.Core" Version="8.0.0-alpha.1" />
-    <PackageVersion Include="Polly.Extensions" Version="8.0.0-alpha.1" />
-    <PackageVersion Include="Polly.RateLimiting" Version="8.0.0-alpha.1" />
+    <PackageVersion Include="Polly" Version="8.0.0-alpha.3" />
+    <PackageVersion Include="Polly.Core" Version="8.0.0-alpha.3" />
+    <PackageVersion Include="Polly.Extensions" Version="8.0.0-alpha.3" />
+    <PackageVersion Include="Polly.RateLimiting" Version="8.0.0-alpha.3" />
     <PackageVersion Include="protobuf-net" Version="3.0.101" />
     <PackageVersion Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
     <PackageVersion Include="System.CommandLine.NamingConventionBinder" Version="2.0.0-beta4.22272.1" />

src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/HttpClientFaultInjectionExtensions.cs

@@ -10,8 +10,8 @@
 using Microsoft.Extensions.Http.Resilience.FaultInjection.Internal;
 using Microsoft.Extensions.Options;
 using Microsoft.Extensions.Resilience.FaultInjection;
-using Microsoft.Extensions.Resilience.Internal;
 using Microsoft.Shared.Diagnostics;
+using Polly;
 
 namespace Microsoft.Extensions.Http.Resilience.FaultInjection;
 
@@ -205,18 +205,17 @@ public static IHttpClientBuilder AddWeightedFaultInjectionPolicyHandlers(this IH
 
     private static IHttpClientBuilder AddChaosMessageHandler(this IHttpClientBuilder httpClientBuilder)
     {
-        _ = httpClientBuilder
-            .AddResilienceHandler("chaos")
-            .AddPolicy((pipelineBuilder, services) =>
-            {
-                var chaosPolicyFactory = services.GetRequiredService<IChaosPolicyFactory>();
-                var httpClientChaosPolicyFactory = services.GetRequiredService<IHttpClientChaosPolicyFactory>();
-                _ = pipelineBuilder
-                    .AddPolicy(httpClientChaosPolicyFactory.CreateHttpResponsePolicy())
-                    .AddPolicy(chaosPolicyFactory.CreateExceptionPolicy())
-                    .AddPolicy(chaosPolicyFactory.CreateLatencyPolicy<HttpResponseMessage>());
-            });
+        return httpClientBuilder.AddHttpMessageHandler(serviceProvider =>
+        {
+            var chaosPolicyFactory = serviceProvider.GetRequiredService<IChaosPolicyFactory>();
+            var httpClientChaosPolicyFactory = serviceProvider.GetRequiredService<IHttpClientChaosPolicyFactory>();
 
-        return httpClientBuilder;
+            var policy = Policy.WrapAsync(
+                chaosPolicyFactory.CreateLatencyPolicy<HttpResponseMessage>(),
+                chaosPolicyFactory.CreateExceptionPolicy().AsAsyncPolicy<HttpResponseMessage>(),
+                httpClientChaosPolicyFactory.CreateHttpResponsePolicy());
+
+            return new PolicyHttpMessageHandler(policy);
+        });
     }
 }

src/Libraries/Microsoft.Extensions.Http.Resilience/FaultInjection/PolicyContextExtensions.cs

@@ -9,7 +9,7 @@
 namespace Microsoft.Extensions.Http.Resilience.FaultInjection;
 
 /// <summary>
-/// Provides extension methods for <see cref="Polly.Context"/>.
+/// Provides extension methods for <see cref="Context"/>.
 /// </summary>
 [Experimental]
 public static class PolicyContextExtensions

src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HedgingEndpointOptions.cs

@@ -3,50 +3,58 @@
 
 using System;
 using System.ComponentModel.DataAnnotations;
+using Microsoft.Extensions.Http.Resilience.Internal.Validators;
 using Microsoft.Extensions.Options.Validation;
-using Microsoft.Extensions.Resilience.Options;
+using Polly.Timeout;
 
 namespace Microsoft.Extensions.Http.Resilience;
 
 /// <summary>
-/// Options for resilient pipeline of policies assigned to a particular endpoint. It is using three chained layers in this order (from the outermost to the innermost):
-/// Bulkhead -> Circuit Breaker -> Attempt Timeout.
+/// Options for the pipeline of resilience strategies assigned to a particular endpoint.
 /// </summary>
+/// <remarks>
+/// It is using three chained layers in this order (from the outermost to the innermost): Bulkhead -> Circuit Breaker -> Attempt Timeout.
+/// </remarks>
 public class HedgingEndpointOptions
 {
-    private static readonly TimeSpan _timeoutInterval = TimeSpan.FromSeconds(10);
-
     /// <summary>
     /// Gets or sets the bulkhead options for the endpoint.
     /// </summary>
     /// <remarks>
-    /// By default it is initialized with a unique instance of <see cref="HttpBulkheadPolicyOptions"/> using default properties values.
+    /// By default it is initialized with a unique instance of <see cref="HttpRateLimiterStrategyOptions"/> using default properties values.
     /// </remarks>
     [Required]
     [ValidateObjectMembers]
-    public HttpBulkheadPolicyOptions BulkheadOptions { get; set; } = new();
+    public HttpRateLimiterStrategyOptions RateLimiterOptions { get; set; } = new HttpRateLimiterStrategyOptions
+    {
+        StrategyName = StandardHedgingStrategyNames.RateLimiter
+    };
 
     /// <summary>
     /// Gets or sets the circuit breaker options for the endpoint.
     /// </summary>
     /// <remarks>
-    /// By default it is initialized with a unique instance of <see cref="HttpCircuitBreakerPolicyOptions"/> using default properties values.
+    /// By default it is initialized with a unique instance of <see cref="HttpCircuitBreakerStrategyOptions"/> using default properties values.
     /// </remarks>
     [Required]
     [ValidateObjectMembers]
-    public HttpCircuitBreakerPolicyOptions CircuitBreakerOptions { get; set; } = new();
+    public HttpCircuitBreakerStrategyOptions CircuitBreakerOptions { get; set; } = new HttpCircuitBreakerStrategyOptions
+    {
+        StrategyName = StandardHedgingStrategyNames.CircuitBreaker
+    };
 
     /// <summary>
-    /// Gets or sets the options for the timeout policy applied per each request attempt.
+    /// Gets or sets the options for the timeout resilience strategy applied per each request attempt.
     /// </summary>
     /// <remarks>
-    /// By default it is initialized with a unique instance of <see cref="HttpTimeoutPolicyOptions"/>
-    /// using a custom <see cref="TimeoutPolicyOptions.TimeoutInterval"/> of 10 seconds.
+    /// By default it is initialized with a unique instance of <see cref="HttpTimeoutStrategyOptions"/>
+    /// using a custom <see cref="TimeoutStrategyOptions.Timeout"/> of 10 seconds.
     /// </remarks>
     [Required]
     [ValidateObjectMembers]
-    public HttpTimeoutPolicyOptions TimeoutOptions { get; set; } = new()
+    public HttpTimeoutStrategyOptions TimeoutOptions { get; set; } = new()
     {
-        TimeoutInterval = _timeoutInterval,
+        Timeout = TimeSpan.FromSeconds(10),
+        StrategyName = StandardHedgingStrategyNames.AttemptTimeout
     };
 }

src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpClientBuilderExtensions.Hedging.cs

@@ -2,22 +2,24 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
-using System.Net.Http;
 using Microsoft.Extensions.Compliance.Classification;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Http.Resilience.Internal;
-using Microsoft.Extensions.Http.Resilience.Internal.Routing;
 using Microsoft.Extensions.Http.Resilience.Internal.Validators;
 using Microsoft.Extensions.Http.Resilience.Routing.Internal;
-using Microsoft.Extensions.Resilience.Internal;
+using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options.Validation;
 using Microsoft.Shared.Diagnostics;
+using Polly;
 
 namespace Microsoft.Extensions.Http.Resilience;
 
 public static partial class HttpClientBuilderExtensions
 {
+    internal const string StandardInnerHandlerPostfix = "standard-hedging-endpoint";
+
     private const string StandardHandlerPostfix = "standard-hedging";
-    private const string StandardInnerHandlerPostfix = "standard-hedging-endpoint";
 
     /// <summary>
     /// Adds a standard hedging handler which wraps the execution of the request with a standard hedging mechanism.
@@ -28,12 +30,14 @@ public static partial class HttpClientBuilderExtensions
     /// A <see cref="IStandardHedgingHandlerBuilder"/> builder that can be used to configure the standard hedging behavior.
     /// </returns>
     /// <remarks>
-    /// The standard hedging uses a pipeline pool of circuit breakers to ensure that unhealthy endpoints are not hedged against.
+    /// The standard hedging uses a pool of circuit breakers to ensure that unhealthy endpoints are not hedged against.
     /// By default, the selection from pool is based on the URL Authority (scheme + host + port).
-    ///
-    /// It is recommended that you configure the way the pipelines are selected by calling 'SelectPipelineByAuthority' extensions on top of returned <see cref="IStandardHedgingHandlerBuilder"/>.
-    ///
-    /// See <see cref="HttpStandardHedgingResilienceOptions"/> for more details about the policies inside the pipeline.
+    /// It is recommended that you configure the way the strategies are selected by calling
+    /// <see cref="StandardHedgingHandlerBuilderExtensions.SelectStrategyByAuthority(IStandardHedgingHandlerBuilder, DataClassification)"/>
+    /// extensions.
+    /// <para>
+    /// See <see cref="HttpStandardHedgingResilienceOptions"/> for more details about the used resilience strategies.
+    /// </para>
     /// </remarks>
     public static IStandardHedgingHandlerBuilder AddStandardHedgingHandler(this IHttpClientBuilder builder, Action<IRoutingStrategyBuilder> configure)
     {
@@ -55,45 +59,86 @@ public static IStandardHedgingHandlerBuilder AddStandardHedgingHandler(this IHtt
     /// A <see cref="IStandardHedgingHandlerBuilder"/> builder that can be used to configure the standard hedging behavior.
     /// </returns>
     /// <remarks>
-    /// The standard hedging uses a pipeline pool of circuit breakers to ensure that unhealthy endpoints are not hedged against.
+    /// The standard hedging uses a pool of circuit breakers to ensure that unhealthy endpoints are not hedged against.
     /// By default, the selection from pool is based on the URL Authority (scheme + host + port).
-    ///
-    /// It is recommended that you configure the way the pipelines are selected by calling 'SelectPipelineByAuthority' extensions on top of returned <see cref="IStandardHedgingHandlerBuilder"/>.
-    ///
-    /// See <see cref="HttpStandardHedgingResilienceOptions"/> for more details about the policies inside the pipeline.
+    /// It is recommended that you configure the way the strategies are selected by calling
+    /// <see cref="StandardHedgingHandlerBuilderExtensions.SelectStrategyByAuthority(IStandardHedgingHandlerBuilder, DataClassification)"/>
+    /// extensions.
+    /// <para>
+    /// See <see cref="HttpStandardHedgingResilienceOptions"/> for more details about the used resilience strategies.
+    /// </para>
     /// </remarks>
     public static IStandardHedgingHandlerBuilder AddStandardHedgingHandler(this IHttpClientBuilder builder)
     {
         _ = Throw.IfNull(builder);
 
         var optionsName = builder.Name;
         var routingBuilder = new RoutingStrategyBuilder(builder.Name, builder.Services);
-        _ = builder.Services.AddRequestCloner();
+        builder.Services.TryAddSingleton<IRequestCloner, RequestCloner>();
+        _ = builder.Services.AddValidatedOptions<HttpStandardHedgingResilienceOptions, HttpStandardHedgingResilienceOptionsValidator>(optionsName);
+        _ = builder.Services.AddValidatedOptions<HttpStandardHedgingResilienceOptions, HttpStandardHedgingResilienceOptionsCustomValidator>(optionsName);
+        _ = builder.Services.PostConfigure<HttpStandardHedgingResilienceOptions>(optionsName, options =>
+        {
+            options.HedgingOptions.HedgingActionGenerator = args =>
+            {
+                if (!args.PrimaryContext.Properties.TryGetValue(ResilienceKeys.RequestSnapshot, out var snapshot))
+                {
+                    Throw.InvalidOperationException("Request message snapshot is not attached to the resilience context.");
+                }
+
+                if (!args.PrimaryContext.Properties.TryGetValue(ResilienceKeys.RoutingStrategy, out var routingStrategy))
+                {
+                    Throw.InvalidOperationException("Routing strategy is not attached to the resilience context.");
+                }
+
+                if (!routingStrategy.TryGetNextRoute(out var route))
+                {
+                    // no routes left, stop hedging
+                    return null;
+                }
+
+                var requestMessage = snapshot.Create().ReplaceHost(route);
+
+                // replace the request message
+                args.ActionContext.Properties.Set(ResilienceKeys.RequestMessage, requestMessage);
+
+                return () => args.Callback(args.ActionContext);
+            };
+        });
 
         // configure outer handler
-        var outerHandler = builder.AddResilienceHandler(StandardHandlerPostfix);
-        _ = outerHandler
-            .AddRoutingPolicy(serviceProvider => serviceProvider.GetRoutingFactory(routingBuilder.Name))
-            .AddRequestMessageSnapshotPolicy()
-            .AddPolicy<HttpResponseMessage, HttpStandardHedgingResilienceOptions, HttpStandardHedgingResilienceOptionsCustomValidator>(
-                optionsName,
-                options => { },
-                (builder, options, _) => builder
-                    .AddTimeoutPolicy(StandardHedgingPolicyNames.TotalRequestTimeout, options.TotalRequestTimeoutOptions)
-                    .AddHedgingPolicy(StandardHedgingPolicyNames.Hedging, CreateHedgedTaskProvider(outerHandler.PipelineName), options.HedgingOptions));
+        var outerHandler = builder.AddResilienceHandler(StandardHandlerPostfix, (builder, context) =>
+        {
+            var options = context.GetOptions<HttpStandardHedgingResilienceOptions>(optionsName);
+            context.EnableReloads<HttpStandardHedgingResilienceOptions>(optionsName);
+
+            _ = builder
+                .AddStrategy(new RoutingStrategy(context.ServiceProvider.GetRoutingFactory(routingBuilder.Name)))
+                .AddStrategy(new RequestMessageSnapshotStrategy(context.ServiceProvider.GetRequiredService<IRequestCloner>()))
+                .AddTimeout(options.TotalRequestTimeoutOptions)
+                .AddHedging(options.HedgingOptions);
+        });
 
         // configure inner handler
-        var innerBuilder = builder.AddResilienceHandler(StandardInnerHandlerPostfix);
-        _ = innerBuilder
-            .SelectPipelineByAuthority(new DataClassification("FIXME", 1))
-            .AddPolicy<HttpResponseMessage, HttpStandardHedgingResilienceOptions, HttpStandardHedgingResilienceOptionsValidator>(
-                optionsName,
-                options => { },
-                (builder, options, _) => builder
-                    .AddBulkheadPolicy(StandardHedgingPolicyNames.Bulkhead, options.EndpointOptions.BulkheadOptions)
-                    .AddCircuitBreakerPolicy(StandardHedgingPolicyNames.CircuitBreaker, options.EndpointOptions.CircuitBreakerOptions)
-                    .AddTimeoutPolicy(StandardHedgingPolicyNames.AttemptTimeout, options.EndpointOptions.TimeoutOptions));
-
-        return new StandardHedgingHandlerBuilder(builder.Name, builder.Services, routingBuilder, innerBuilder);
+        var innerBuilder = builder.AddResilienceHandler(
+            StandardInnerHandlerPostfix,
+            (builder, context) =>
+            {
+                var options = context.GetOptions<HttpStandardHedgingResilienceOptions>(optionsName);
+                context.EnableReloads<HttpStandardHedgingResilienceOptions>(optionsName);
+
+                _ = builder
+                    .AddRateLimiter(options.EndpointOptions.RateLimiterOptions)
+                    .AddAdvancedCircuitBreaker(options.EndpointOptions.CircuitBreakerOptions)
+                    .AddTimeout(options.EndpointOptions.TimeoutOptions);
+            })
+            .SelectStrategyByAuthority(DataClassification.Unknown);
+
+        return new StandardHedgingHandlerBuilder(builder.Name, builder.Services, routingBuilder);
     }
+
+    private record StandardHedgingHandlerBuilder(
+        string Name,
+        IServiceCollection Services,
+        IRoutingStrategyBuilder RoutingStrategyBuilder) : IStandardHedgingHandlerBuilder;
 }

src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpClientBuilderExtensions.cs

@@ -2,7 +2,9 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using System.Net.Http;
 using Microsoft.Shared.Diagnostics;
+using Polly;
 using Polly.CircuitBreaker;
 
 namespace Microsoft.Extensions.Http.Resilience;
@@ -26,4 +28,14 @@ _ when HttpClientResiliencePredicates.IsTransientHttpException(exception) => tru
             _ => false,
         };
     };
+
+    /// <summary>
+    /// Determines whether an outcome should be treated by hedging as a transient failure.
+    /// </summary>
+    public static readonly Predicate<Outcome<HttpResponseMessage>> IsTransientHttpOutcome = outcome => outcome switch
+    {
+        { Result: { } response } when HttpClientResiliencePredicates.IsTransientHttpFailure(response) => true,
+        { Exception: { } exception } when IsTransientHttpException(exception) => true,
+        _ => false,
+    };
 }