ThreeMammals#1712 Migrate to Polly 8.0

RaynaldM · Oct 13, 2023 · a815a58 · a815a58
1 parent b4265a4
commit a815a58
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 32 deletions.
diff --git a/src/Ocelot.Provider.Polly/CircuitBreaker.cs b/src/Ocelot.Provider.Polly/CircuitBreaker.cs
@@ -4,16 +4,11 @@ namespace Ocelot.Provider.Polly
 {
     public class CircuitBreaker
     {
-        private readonly List<IAsyncPolicy> _policies = new();
-
         public CircuitBreaker(params IAsyncPolicy[] policies)
         {
-            foreach (var policy in policies.Where(p => p != null))
-            {
-                _policies.Add(policy);
-            }
+            Policies = policies.Where(p => p != null).ToArray();
         }
 
-        public IAsyncPolicy[] Policies => _policies.ToArray();
+        public IAsyncPolicy[] Policies { get; }
     }
 }
diff --git a/src/Ocelot.Provider.Polly/Ocelot.Provider.Polly.csproj b/src/Ocelot.Provider.Polly/Ocelot.Provider.Polly.csproj
@@ -34,7 +34,7 @@
     <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Polly" Version="7.2.3" />
+    <PackageReference Include="Polly" Version="8.0.0" />
   </ItemGroup>
   <ItemGroup>
     <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.0.0" />

diff --git a/src/Ocelot.Provider.Polly/OcelotBuilderExtensions.cs b/src/Ocelot.Provider.Polly/OcelotBuilderExtensions.cs
@@ -1,11 +1,18 @@
-using Microsoft.Extensions.DependencyInjection;
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+using Polly.CircuitBreaker;
+using Polly.Timeout;
+
+using Microsoft.Extensions.DependencyInjection;
+
 using Ocelot.Configuration;
 using Ocelot.DependencyInjection;
 using Ocelot.Errors;
 using Ocelot.Logging;
 using Ocelot.Requester;
-using Polly.CircuitBreaker;
-using Polly.Timeout;
 
 namespace Ocelot.Provider.Polly
 {

diff --git a/src/Ocelot.Provider.Polly/PollyCircuitBreakingDelegatingHandler.cs b/src/Ocelot.Provider.Polly/PollyCircuitBreakingDelegatingHandler.cs
@@ -1,5 +1,11 @@
+using System.Linq;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+
 using Ocelot.Logging;
 using Ocelot.Provider.Polly.Interfaces;
+
 using Polly;
 using Polly.CircuitBreaker;
 
@@ -28,7 +34,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
                     return await base.SendAsync(request, cancellationToken);
                 }
 
-                IAsyncPolicy policy = policies.Length > 1
+                var policy = policies.Length > 1
                     ? Policy.WrapAsync(policies)
                     : policies[0];
 

diff --git a/src/Ocelot.Provider.Polly/PollyQoSProvider.cs b/src/Ocelot.Provider.Polly/PollyQoSProvider.cs
@@ -1,6 +1,10 @@
+using System;
+using System.Net.Http;
+
 using Ocelot.Configuration;
 using Ocelot.Logging;
 using Ocelot.Provider.Polly.Interfaces;
+
 using Polly;
 using Polly.CircuitBreaker;
 using Polly.Timeout;
@@ -9,28 +13,18 @@ namespace Ocelot.Provider.Polly
 {
     public class PollyQoSProvider : IPollyQoSProvider
     {
-        private readonly AsyncCircuitBreakerPolicy _circuitBreakerPolicy;
-        private readonly AsyncTimeoutPolicy _timeoutPolicy;
-        private readonly IOcelotLogger _logger;
-
-        public PollyQoSProvider(AsyncCircuitBreakerPolicy circuitBreakerPolicy, AsyncTimeoutPolicy timeoutPolicy, IOcelotLogger logger)
-        {
-            _circuitBreakerPolicy = circuitBreakerPolicy;
-            _timeoutPolicy = timeoutPolicy;
-            _logger = logger;
-        }
-
         public PollyQoSProvider(DownstreamRoute route, IOcelotLoggerFactory loggerFactory)
         {
-            _logger = loggerFactory.CreateLogger<PollyQoSProvider>();
+            AsyncCircuitBreakerPolicy circuitBreakerPolicy;
+            var logger = loggerFactory.CreateLogger<PollyQoSProvider>();
 
             _ = Enum.TryParse(route.QosOptions.TimeoutStrategy, out TimeoutStrategy strategy);
 
-            _timeoutPolicy = Policy.TimeoutAsync(TimeSpan.FromMilliseconds(route.QosOptions.TimeoutValue), strategy);
+            var timeoutPolicy = Policy.TimeoutAsync(TimeSpan.FromMilliseconds(route.QosOptions.TimeoutValue), strategy);
 
             if (route.QosOptions.ExceptionsAllowedBeforeBreaking > 0)
             {
-                _circuitBreakerPolicy = Policy
+                circuitBreakerPolicy = Policy
                     .Handle<HttpRequestException>()
                     .Or<TimeoutRejectedException>()
                     .Or<TimeoutException>()
@@ -39,25 +33,30 @@ public PollyQoSProvider(DownstreamRoute route, IOcelotLoggerFactory loggerFactor
                         durationOfBreak: TimeSpan.FromMilliseconds(route.QosOptions.DurationOfBreak),
                         onBreak: (ex, breakDelay) =>
                         {
-                            _logger.LogError(
+                            logger.LogError(
                                 ".Breaker logging: Breaking the circuit for " + breakDelay.TotalMilliseconds + "ms!", ex);
                         },
                         onReset: () =>
                         {
-                            _logger.LogDebug(".Breaker logging: Call ok! Closed the circuit again.");
+                            logger.LogDebug(".Breaker logging: Call ok! Closed the circuit again.");
                         },
                         onHalfOpen: () =>
                         {
-                            _logger.LogDebug(".Breaker logging: Half-open; next call is a trial.");
+                            logger.LogDebug(".Breaker logging: Half-open; next call is a trial.");
                         }
                     );
             }
             else
             {
-                _circuitBreakerPolicy = null;
+                circuitBreakerPolicy = null;
             }
 
-            CircuitBreaker = new CircuitBreaker(_circuitBreakerPolicy, _timeoutPolicy);
+            CircuitBreaker = new CircuitBreaker(circuitBreakerPolicy, timeoutPolicy);
+        }
+
+        [Obsolete("do not use: it does nothing")]
+        public PollyQoSProvider(AsyncCircuitBreakerPolicy circuitBreakerPolicy, AsyncTimeoutPolicy timeoutPolicy, IOcelotLogger logger)
+        {
         }
 
         public CircuitBreaker CircuitBreaker { get; }

diff --git a/test/Ocelot.UnitTests/Ocelot.UnitTests.csproj b/test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
@@ -88,7 +88,7 @@
 		<PackageReference Include="CacheManager.Core" Version="2.0.0-beta-1629" />
 		<PackageReference Include="CacheManager.Microsoft.Extensions.Configuration" Version="2.0.0-beta-1629" />
 		<PackageReference Include="CacheManager.Microsoft.Extensions.Logging" Version="2.0.0-beta-1629" />
-		<PackageReference Include="Polly" Version="7.2.3" />
+		<PackageReference Include="Polly" Version="8.0.0" />
 		<PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.0.0" />
 	</ItemGroup>
 </Project>