Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce OutcomeResilienceStrategy and drop some internals #1330

Merged
merged 4 commits into from
Jun 20, 2023
Merged

Introduce OutcomeResilienceStrategy and drop some internals #1330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e58672
Introduce OutcomeResilienceStrategy
martintmk Jun 20, 2023
5e1b605
fixes and PR feedback
martintmk Jun 20, 2023
a44ba44
code coverage fixes
martintmk Jun 20, 2023
3d7838c
Fixes
martintmk Jun 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions ...acts/results/Polly.Core.Benchmarks.MultipleStrategiesBenchmark-report-github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ Job=MediumRun Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=2 WarmupCount=10

```
| Method | Mean | Error | StdDev | Ratio | RatioSD | Gen0 | Allocated | Alloc Ratio |
|------------------------------------- |---------:|----------:|----------:|------:|--------:|-------:|----------:|------------:|
| ExecuteStrategyPipeline_V7 | 2.220 μs | 0.0164 μs | 0.0236 μs | 1.00 | 0.00 | 0.1106 | 2824 B | 1.00 |
| ExecuteStrategyPipeline_V8 | 1.901 μs | 0.0089 μs | 0.0127 μs | 0.86 | 0.01 | - | 40 B | 0.01 |
| ExecuteStrategyPipeline_Telemetry_V8 | 2.947 μs | 0.0077 μs | 0.0115 μs | 1.33 | 0.02 | - | 40 B | 0.01 |
| Method | Mean | Error | StdDev | Ratio | Gen0 | Allocated | Alloc Ratio |
|-------------------------------------- |---------:|----------:|----------:|------:|-------:|----------:|------------:|
| ExecuteStrategyPipeline_V7 | 2.349 μs | 0.0232 μs | 0.0318 μs | 1.00 | 0.1106 | 2824 B | 1.00 |
| ExecuteStrategyPipeline_V8 | 1.968 μs | 0.0104 μs | 0.0149 μs | 0.84 | - | 40 B | 0.01 |
| ExecuteStrategyPipeline_Telemetry_V8 | 3.014 μs | 0.0137 μs | 0.0204 μs | 1.28 | - | 40 B | 0.01 |
| ExecuteStrategyPipeline_NonGeneric_V8 | 2.188 μs | 0.0107 μs | 0.0156 μs | 0.93 | - | 40 B | 0.01 |
14 changes: 7 additions & 7 deletions ...kDotNet.Artifacts/results/Polly.Core.Benchmarks.RetryBenchmark-report-github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
``` ini

BenchmarkDotNet=v0.13.5, OS=Windows 11 (10.0.22621.1702/22H2/2022Update/SunValley2)
BenchmarkDotNet=v0.13.5, OS=Windows 11 (10.0.22621.1848/22H2/2022Update/SunValley2)
Intel Core i9-10885H CPU 2.40GHz, 1 CPU, 16 logical and 8 physical cores
.NET SDK=7.0.203
[Host] : .NET 7.0.5 (7.0.523.17405), X64 RyuJIT AVX2
.NET SDK=7.0.304
[Host] : .NET 7.0.7 (7.0.723.27404), X64 RyuJIT AVX2

Job=MediumRun Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=2 WarmupCount=10

```
| Method | Mean | Error | StdDev | Median | Ratio | RatioSD | Gen0 | Allocated | Alloc Ratio |
|---------------- |---------:|---------:|---------:|---------:|------:|--------:|-------:|----------:|------------:|
| ExecuteRetry_V7 | 264.2 ns | 10.80 ns | 15.83 ns | 255.3 ns | 1.00 | 0.00 | 0.0658 | 552 B | 1.00 |
| ExecuteRetry_V8 | 244.7 ns | 7.75 ns | 10.61 ns | 244.1 ns | 0.93 | 0.05 | - | - | 0.00 |
| Method | Mean | Error | StdDev | Ratio | RatioSD | Gen0 | Allocated | Alloc Ratio |
|---------------- |---------:|--------:|--------:|------:|--------:|-------:|----------:|------------:|
| ExecuteRetry_V7 | 210.9 ns | 4.37 ns | 6.27 ns | 1.00 | 0.00 | 0.0658 | 552 B | 1.00 |
| ExecuteRetry_V8 | 224.1 ns | 2.34 ns | 3.43 ns | 1.06 | 0.04 | - | - | 0.00 |
15 changes: 15 additions & 0 deletions bench/Polly.Core.Benchmarks/MultipleStrategiesBenchmark.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ public class MultipleStrategiesBenchmark
private object? _strategyV7;
private object? _strategyV8;
private object? _strategyTelemetryV8;
private ResilienceStrategy? _nonGeneric;

[GlobalSetup]
public void Setup()
Expand All @@ -16,6 +17,7 @@ public void Setup()
_strategyV7 = Helper.CreateStrategyPipeline(PollyVersion.V7, false);
_strategyV8 = Helper.CreateStrategyPipeline(PollyVersion.V8, false);
_strategyTelemetryV8 = Helper.CreateStrategyPipeline(PollyVersion.V8, true);
_nonGeneric = Helper.CreateNonGenericStrategyPipeline();
}

[GlobalCleanup]
Expand All @@ -29,4 +31,17 @@ public void Setup()

[Benchmark]
public ValueTask ExecuteStrategyPipeline_Telemetry_V8() => _strategyTelemetryV8!.ExecuteAsync(PollyVersion.V8);

[Benchmark]
public async ValueTask ExecuteStrategyPipeline_NonGeneric_V8()
{
var context = ResilienceContext.Get();

await _nonGeneric!.ExecuteOutcomeAsync(
static (_, _) => new ValueTask<Outcome<string>>(new Outcome<string>("dummy")),
context,
string.Empty).ConfigureAwait(false);

ResilienceContext.Return(context);
}
}
55 changes: 50 additions & 5 deletions bench/Polly.Core.Benchmarks/Utils/Helper.MultipleStrategies.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,18 @@ internal static partial class Helper
PermitLimit = 10
})
.AddTimeout(TimeSpan.FromSeconds(10))
.AddRetry(
predicate => predicate.Handle<InvalidOperationException>().HandleResult(Failure),
RetryBackoffType.Constant,
3,
TimeSpan.FromSeconds(1))
.AddRetry(new()
{
BackoffType = RetryBackoffType.Constant,
RetryCount = 3,
BaseDelay = TimeSpan.FromSeconds(1),
ShouldHandle = args => args switch
{
{ Exception: InvalidOperationException } => PredicateResult.True,
{ Result: var result } when result == Failure => PredicateResult.True,
_ => PredicateResult.False
}
})
.AddTimeout(TimeSpan.FromSeconds(1))
.AddAdvancedCircuitBreaker(new()
{
Expand All @@ -49,4 +56,42 @@ internal static partial class Helper
}),
_ => throw new NotSupportedException()
};

public static ResilienceStrategy CreateNonGenericStrategyPipeline()
{
return new ResilienceStrategyBuilder()
.AddConcurrencyLimiter(new ConcurrencyLimiterOptions
{
QueueLimit = 10,
PermitLimit = 10
})
.AddTimeout(TimeSpan.FromSeconds(10))
.AddRetry(new()
{
BackoffType = RetryBackoffType.Constant,
RetryCount = 3,
BaseDelay = TimeSpan.FromSeconds(1),
ShouldHandle = args => args switch
{
{ Exception: InvalidOperationException } => PredicateResult.True,
{ Result: string result } when result == Failure => PredicateResult.True,
_ => PredicateResult.False
}
})
.AddTimeout(TimeSpan.FromSeconds(1))
.AddAdvancedCircuitBreaker(new()
{
FailureThreshold = 0.5,
SamplingDuration = TimeSpan.FromSeconds(30),
MinimumThroughput = 10,
BreakDuration = TimeSpan.FromSeconds(5),
ShouldHandle = args => args switch
{
{ Exception: InvalidOperationException } => PredicateResult.True,
{ Result: string result } when result == Failure => PredicateResult.True,
_ => PredicateResult.False
}
})
.Build();
}
}
25 changes: 12 additions & 13 deletions src/Polly.Core/CircuitBreaker/CircuitBreakerResilienceStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
namespace Polly.CircuitBreaker;

internal sealed class CircuitBreakerResilienceStrategy : ResilienceStrategy
internal sealed class CircuitBreakerResilienceStrategy<T> : OutcomeResilienceStrategy<T>
{
private readonly PredicateInvoker<CircuitBreakerPredicateArguments> _handler;
private readonly CircuitStateController _controller;
private readonly Func<OutcomeArguments<T, CircuitBreakerPredicateArguments>, ValueTask<bool>> _handler;
private readonly CircuitStateController<T> _controller;

public CircuitBreakerResilienceStrategy(
PredicateInvoker<CircuitBreakerPredicateArguments> handler,
CircuitStateController controller,
Func<OutcomeArguments<T, CircuitBreakerPredicateArguments>, ValueTask<bool>> handler,
CircuitStateController<T> controller,
CircuitBreakerStateProvider? stateProvider,
CircuitBreakerManualControl? manualControl)
CircuitBreakerManualControl? manualControl,
bool isGeneric)
: base(isGeneric)
{
_handler = handler;
_controller = controller;
Expand All @@ -21,20 +23,17 @@ public CircuitBreakerResilienceStrategy(
_controller.Dispose);
}

protected internal override async ValueTask<Outcome<TResult>> ExecuteCoreAsync<TResult, TState>(
Func<ResilienceContext, TState, ValueTask<Outcome<TResult>>> callback,
ResilienceContext context,
TState state)
protected override async ValueTask<Outcome<T>> ExecuteCallbackAsync<TState>(Func<ResilienceContext, TState, ValueTask<Outcome<T>>> callback, ResilienceContext context, TState state)
{
if (await _controller.OnActionPreExecuteAsync<TResult>(context).ConfigureAwait(context.ContinueOnCapturedContext) is Outcome<TResult> outcome)
if (await _controller.OnActionPreExecuteAsync(context).ConfigureAwait(context.ContinueOnCapturedContext) is Outcome<T> outcome)
{
return outcome;
}

outcome = await ExecuteCallbackSafeAsync(callback, context, state).ConfigureAwait(context.ContinueOnCapturedContext);

var args = new OutcomeArguments<TResult, CircuitBreakerPredicateArguments>(context, outcome, new CircuitBreakerPredicateArguments());
if (await _handler.HandleAsync(args).ConfigureAwait(context.ContinueOnCapturedContext))
var args = new OutcomeArguments<T, CircuitBreakerPredicateArguments>(context, outcome, new CircuitBreakerPredicateArguments());
if (await _handler(args).ConfigureAwait(context.ContinueOnCapturedContext))
{
await _controller.OnActionFailureAsync(outcome, context).ConfigureAwait(context.ContinueOnCapturedContext);
}
Expand Down
18 changes: 11 additions & 7 deletions src/Polly.Core/CircuitBreaker/CircuitBreakerResilienceStrategyBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,22 +121,26 @@ private static TBuilder AddSimpleCircuitBreakerCore<TBuilder, TResult>(this TBui
return builder.AddStrategy(context => CreateStrategy(context, options, new ConsecutiveFailuresCircuitBehavior(options.FailureThreshold)), options);
}

internal static CircuitBreakerResilienceStrategy CreateStrategy<TResult>(ResilienceStrategyBuilderContext context, CircuitBreakerStrategyOptions<TResult> options, CircuitBehavior behavior)
internal static CircuitBreakerResilienceStrategy<TResult> CreateStrategy<TResult>(
ResilienceStrategyBuilderContext context,
CircuitBreakerStrategyOptions<TResult> options,
CircuitBehavior behavior)
{
var controller = new CircuitStateController(
var controller = new CircuitStateController<TResult>(
options.BreakDuration,
context.CreateInvoker(options.OnOpened),
context.CreateInvoker(options.OnClosed),
options.OnOpened,
options.OnClosed,
options.OnHalfOpened,
behavior,
context.TimeProvider,
context.Telemetry);

return new CircuitBreakerResilienceStrategy(
context.CreateInvoker(options.ShouldHandle)!,
return new CircuitBreakerResilienceStrategy<TResult>(
options.ShouldHandle!,
controller,
options.StateProvider,
options.ManualControl);
options.ManualControl,
context.IsGenericBuilder);
}
}

Loading