Introduce Timeout Strategy (#1079)

eng/Test.targets

@@ -5,6 +5,11 @@
     <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Using Include="FluentAssertions"/>
+    <Using Include="Xunit"/>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="coverlet.msbuild" PrivateAssets="all" />
     <PackageReference Include="FluentAssertions" />

eng/analyzers/Library.globalconfig

@@ -2937,7 +2937,7 @@ dotnet_diagnostic.S1659.severity = warning
 # Category : Minor Code Smell
 # Help Link: https://rules.sonarsource.com/csharp/RSPEC-1694
 # Tags     : C#, MainSourceScope
-dotnet_diagnostic.S1694.severity = warning
+dotnet_diagnostic.S1694.severity = suggestion
 
 # Title    : NullReferenceException should not be caught
 # Category : Major Code Smell

eng/analyzers/Test.globalconfig

@@ -351,7 +351,7 @@ dotnet_diagnostic.CA1062.severity = none
 # Category : Design
 # Help Link: https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1063
 # Tags     : PortedFromFxCop, Telemetry, EnabledRuleInAggressiveMode
-dotnet_diagnostic.CA1063.severity = warning
+dotnet_diagnostic.CA1063.severity = none
 
 # Title    : Exceptions should be public
 # Category : Design
@@ -713,7 +713,7 @@ dotnet_diagnostic.CA1815.severity = none
 # Category : Usage
 # Help Link: https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1816
 # Tags     : PortedFromFxCop, Telemetry, EnabledRuleInAggressiveMode
-dotnet_diagnostic.CA1816.severity = warning
+dotnet_diagnostic.CA1816.severity = none
 
 # Title    : Properties should not return arrays
 # Category : Performance

src/Polly.Core.Tests/Builder/ResilienceStrategyBuilderContextTests.cs

@@ -1,7 +1,5 @@
-using FluentAssertions;
 using Polly.Builder;
 using Polly.Telemetry;
-using Xunit;
 
 namespace Polly.Core.Tests.Builder;
 

src/Polly.Core.Tests/Builder/ResilienceStrategyBuilderOptionsTests.cs

@@ -1,8 +1,6 @@
-using FluentAssertions;
 using Polly.Builder;
 using Polly.Telemetry;
 using Polly.Utils;
-using Xunit;
 
 namespace Polly.Core.Tests.Builder;
 

src/Polly.Core.Tests/Builder/ResilienceStrategyBuilderTests.cs

@@ -1,11 +1,7 @@
-using System;
 using System.ComponentModel.DataAnnotations;
-using FluentAssertions;
 using Moq;
 using Polly.Builder;
-using Polly.Core.Tests.Utils;
 using Polly.Telemetry;
-using Xunit;
 
 namespace Polly.Core.Tests.Builder;
 

src/Polly.Core.Tests/Builder/ResilienceStrategyOptionsTests.cs

@@ -1,6 +1,4 @@
-using FluentAssertions;
 using Polly.Builder;
-using Xunit;
 
 namespace Polly.Core.Tests.Builder;
 

src/Polly.Core.Tests/Builder/ResilienceStrategyPipelineTests.cs

@@ -1,8 +1,4 @@
-using System;
-using FluentAssertions;
 using Polly.Builder;
-using Polly.Core.Tests.Utils;
-using Xunit;
 
 namespace Polly.Core.Tests.Builder;
 

src/Polly.Core.Tests/ExecutionRejectedExceptionTests.cs

@@ -0,0 +1,23 @@
+namespace Polly.Core.Tests.Timeout;
+
+public class ExecutionRejectedExceptionTests
+{
+    [Fact]
+    public void Ctor_Ok()
+    {
+        new CustomException().Message.Should().Be("Exception of type 'Polly.Core.Tests.Timeout.ExecutionRejectedExceptionTests+CustomException' was thrown.");
+        new CustomException("Dummy").Message.Should().Be("Dummy");
+    }
+
+    private class CustomException : ExecutionRejectedException
+    {
+        public CustomException()
+        {
+        }
+
+        public CustomException(string message)
+            : base(message)
+        {
+        }
+    }
+}

src/Polly.Core.Tests/NullResilienceStrategyTests.cs

@@ -1,6 +1,3 @@
-using FluentAssertions;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 public class NullResilienceStrategyTests

src/Polly.Core.Tests/Polly.Core.Tests.csproj

@@ -7,11 +7,15 @@
     <Nullable>enable</Nullable>
     <SkipPollyUsings>true</SkipPollyUsings>
     <Threshold>100</Threshold>
-    <NoWarn>$(NoWarn);SA1600</NoWarn>
+    <NoWarn>$(NoWarn);SA1600;SA1204</NoWarn>
     <Include>[Polly.Core]*</Include>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Polly.Core\Polly.Core.csproj" />
   </ItemGroup>
+
+  <ItemGroup>
+    <Using Include="Polly.Core.Tests.Utils"/>
+  </ItemGroup>
 </Project>

src/Polly.Core.Tests/ResilienceContextTests.cs

@@ -1,6 +1,3 @@
-using FluentAssertions;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 public class ResilienceContextTests

src/Polly.Core.Tests/ResiliencePropertiesTests.cs

@@ -1,7 +1,3 @@
-using System;
-using FluentAssertions;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 public class ResiliencePropertiesTests

src/Polly.Core.Tests/ResiliencePropertyKeyTests.cs

@@ -1,7 +1,3 @@
-using System;
-using FluentAssertions;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 public class ResiliencePropertyKeyTests

src/Polly.Core.Tests/ResilienceStrategyTests.Async.Task.cs

@@ -1,7 +1,3 @@
-using FluentAssertions;
-using Polly.Core.Tests.Utils;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously

src/Polly.Core.Tests/ResilienceStrategyTests.Async.TaskT.cs

@@ -1,7 +1,3 @@
-using FluentAssertions;
-using Polly.Core.Tests.Utils;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously

src/Polly.Core.Tests/ResilienceStrategyTests.Async.ValueTask.cs

@@ -1,7 +1,3 @@
-using FluentAssertions;
-using Polly.Core.Tests.Utils;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously

src/Polly.Core.Tests/ResilienceStrategyTests.Async.ValueTaskT.cs

@@ -1,7 +1,3 @@
-using FluentAssertions;
-using Polly.Core.Tests.Utils;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously

src/Polly.Core.Tests/ResilienceStrategyTests.Sync.cs

@@ -1,8 +1,3 @@
-using System.Threading.Tasks;
-using FluentAssertions;
-using Polly.Core.Tests.Utils;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 public partial class ResilienceStrategyTests

src/Polly.Core.Tests/ResilienceStrategyTests.SyncT.cs

@@ -1,7 +1,3 @@
-using FluentAssertions;
-using Polly.Core.Tests.Utils;
-using Xunit;
-
 namespace Polly.Core.Tests;
 
 public partial class ResilienceStrategyTests

src/Polly.Core.Tests/ResilienceStrategyTests.cs

@@ -1,5 +1,3 @@
-using FluentAssertions;
-
 namespace Polly.Core.Tests;
 
 public partial class ResilienceStrategyTests

src/Polly.Core.Tests/Telemetry/NullResilienceTelemetryFactoryTests.cs

@@ -1,6 +1,4 @@
-using FluentAssertions;
 using Polly.Telemetry;
-using Xunit;
 
 namespace Polly.Core.Tests.Telemetry;
 

src/Polly.Core.Tests/Telemetry/NullResilienceTelemetryTests.cs

@@ -1,7 +1,4 @@
-using System;
-using FluentAssertions;
 using Polly.Telemetry;
-using Xunit;
 
 namespace Polly.Core.Tests.Telemetry;
 

src/Polly.Core.Tests/Timeout/OnTimeoutEventTests.cs

@@ -0,0 +1,64 @@
+using Polly.Timeout;
+
+namespace Polly.Core.Tests.Timeout;
+
+public class OnTimeoutEventTests
+{
+    [Fact]
+    public async Task Add_EnsureOrdering()
+    {
+        var ev = new OnTimeoutEvent();
+        List<int> raisedEvents = new List<int>();
+
+        ev.Add(() => raisedEvents.Add(1));
+        ev.Add(args => raisedEvents.Add(2));
+        ev.Add(args => { raisedEvents.Add(3); return default; });
+
+        var handler = ev.CreateHandler()!;
+
+        await handler(TimeoutTestUtils.OnTimeoutArguments());
+
+        raisedEvents.Should().HaveCount(3);
+        raisedEvents.Should().BeInAscendingOrder();
+    }
+
+    [Fact]
+    public void Add_EnsureValidation()
+    {
+        var ev = new OnTimeoutEvent();
+
+        Assert.Throws<ArgumentNullException>(() => ev.Add((Action)null!));
+        Assert.Throws<ArgumentNullException>(() => ev.Add((Action<OnTimeoutArguments>)null!));
+        Assert.Throws<ArgumentNullException>(() => ev.Add(null!));
+    }
+
+    [InlineData(1)]
+    [InlineData(2)]
+    [InlineData(100)]
+    [Theory]
+    public async Task CreateHandler_Ok(int count)
+    {
+        var ev = new OnTimeoutEvent();
+        var events = new List<int>();
+
+        for (int i = 0; i < count; i++)
+        {
+            ev.Add(() => events.Add(i));
+        }
+
+        await ev.CreateHandler()!(TimeoutTestUtils.OnTimeoutArguments());
+
+        events.Should().HaveCount(count);
+        events.Should().BeInAscendingOrder();
+    }
+
+    [Fact]
+    public void CreateHandler_NoEvents_Null()
+    {
+        var ev = new OnTimeoutEvent();
+
+        var handler = ev.CreateHandler();
+
+        handler.Should().BeNull();
+    }
+}

src/Polly.Core.Tests/Timeout/TimeoutAttributeTests.cs

@@ -0,0 +1,13 @@
+using System.ComponentModel.DataAnnotations;
+using Polly.Timeout;
+
+namespace Polly.Core.Tests.Timeout;
+
+public class TimeoutAttributeTests
+{
+    [Fact]
+    public void IsValid_Object_True()
+    {
+        new TimeoutAttribute().IsValid(new object()).Should().BeTrue();
+    }
+}

src/Polly.Core.Tests/Timeout/TimeoutConstantsTests.cs

@@ -0,0 +1,13 @@
+using Polly.Timeout;
+
+namespace Polly.Core.Tests.Timeout;
+
+public class TimeoutConstantsTests
+{
+    [Fact]
+    public void EnsureDefaultValues()
+    {
+        TimeoutConstants.OnTimeoutEvent.Should().Be("OnTimeout");
+        TimeoutConstants.StrategyType.Should().Be("Timeout");
+    }
+}

src/Polly.Core.Tests/Timeout/TimeoutGeneratorTests.cs

@@ -0,0 +1,49 @@
+using Polly.Timeout;
+
+namespace Polly.Core.Tests.Timeout;
+
+public class TimeoutGeneratorTests
+{
+    [Fact]
+    public void Default_EnsureCorrectValue()
+    {
+        var generator = new TimeoutGenerator();
+
+        generator.CreateHandler().Should().BeNull();
+    }
+
+    [Fact]
+    public async Task SetTimeout_Callback_Ok()
+    {
+        var generator = new TimeoutGenerator();
+        var delay = TimeSpan.FromSeconds(1);
+
+        generator.SetTimeout(args => delay);
+
+        var actualDelay = await generator.CreateHandler()!(TimeoutTestUtils.TimeoutGeneratorArguments());
+
+        actualDelay.Should().Be(delay);
+    }
+
+    [Fact]
+    public async Task SetTimeout_AsyncCallback_Ok()
+    {
+        var generator = new TimeoutGenerator();
+        var delay = TimeSpan.FromSeconds(1);
+
+        generator.SetTimeout(args => new ValueTask<TimeSpan>(delay));
+
+        var actualDelay = await generator.CreateHandler()!(TimeoutTestUtils.TimeoutGeneratorArguments());
+
+        actualDelay.Should().Be(delay);
+    }
+
+    [Fact]
+    public void ArgValidation_EnsureThrows()
+    {
+        var generator = new TimeoutGenerator();
+
+        Assert.Throws<ArgumentNullException>(() => generator.SetTimeout((Func<TimeoutGeneratorArguments, TimeSpan>)null!));
+        Assert.Throws<ArgumentNullException>(() => generator.SetTimeout((Func<TimeoutGeneratorArguments, ValueTask<TimeSpan>>)null!));
+    }
+}