Finalize the API review (App-vNext#1528)

* Finalize the API review * kill mutant * Grammar
chegeapollo11 · Aug 31, 2023 · 5baee94 · 5baee94
1 parent a0be561
commit 5baee94
Show file tree

Hide file tree

Showing 53 changed files with 198 additions and 205 deletions.
diff --git a/bench/Polly.Core.Benchmarks/CreationBenchmark.cs b/bench/Polly.Core.Benchmarks/CreationBenchmark.cs
@@ -18,7 +18,7 @@ public static void Fallback_V8()
         new ResiliencePipelineBuilder<string>()
             .AddFallback(new()
             {
-                FallbackAction = _ => Outcome.FromResultAsTask("fallback")
+                FallbackAction = _ => Outcome.FromResultAsValueTask("fallback")
             })
             .Build();
     }

diff --git a/bench/Polly.Core.Benchmarks/PredicateBenchmark.cs b/bench/Polly.Core.Benchmarks/PredicateBenchmark.cs
@@ -14,11 +14,11 @@ public class PredicateBenchmark
     {
         ShouldHandle = args => args.Outcome switch
         {
-            { Result: { StatusCode: HttpStatusCode.InternalServerError } } => PredicateResult.True,
-            { Exception: HttpRequestException } => PredicateResult.True,
-            { Exception: IOException } => PredicateResult.True,
-            { Exception: InvalidOperationException } => PredicateResult.False,
-            _ => PredicateResult.False,
+            { Result: { StatusCode: HttpStatusCode.InternalServerError } } => PredicateResult.True(),
+            { Exception: HttpRequestException } => PredicateResult.True(),
+            { Exception: IOException } => PredicateResult.True(),
+            { Exception: InvalidOperationException } => PredicateResult.False(),
+            _ => PredicateResult.False(),
         }
     };
 

diff --git a/bench/Polly.Core.Benchmarks/ResiliencePipelineBenchmark.cs b/bench/Polly.Core.Benchmarks/ResiliencePipelineBenchmark.cs
@@ -10,7 +10,7 @@ public class ResiliencePipelineBenchmark
     public async ValueTask ExecuteOutcomeAsync()
     {
         var context = ResilienceContextPool.Shared.Get();
-        await ResiliencePipeline.Empty.ExecuteOutcomeAsync((_, _) => Outcome.FromResultAsTask("dummy"), context, "state").ConfigureAwait(false);
+        await ResiliencePipeline.Empty.ExecuteOutcomeAsync((_, _) => Outcome.FromResultAsValueTask("dummy"), context, "state").ConfigureAwait(false);
         ResilienceContextPool.Shared.Return(context);
     }
 

diff --git a/bench/Polly.Core.Benchmarks/TelemetryBenchmark.cs b/bench/Polly.Core.Benchmarks/TelemetryBenchmark.cs
@@ -33,7 +33,7 @@ public void Prepare()
     public async ValueTask Execute()
     {
         var context = ResilienceContextPool.Shared.Get();
-        await _pipeline!.ExecuteOutcomeAsync((_, _) => Outcome.FromResultAsTask("dummy"), context, "state").ConfigureAwait(false);
+        await _pipeline!.ExecuteOutcomeAsync((_, _) => Outcome.FromResultAsValueTask("dummy"), context, "state").ConfigureAwait(false);
         ResilienceContextPool.Shared.Return(context);
     }
 

diff --git a/bench/Polly.Core.Benchmarks/Utils/Helper.CircuitBreaker.cs b/bench/Polly.Core.Benchmarks/Utils/Helper.CircuitBreaker.cs
@@ -7,7 +7,7 @@ public static object CreateOpenedCircuitBreaker(PollyVersion version, bool handl
         var manualControl = new CircuitBreakerManualControl();
         var options = new CircuitBreakerStrategyOptions
         {
-            ShouldHandle = _ => PredicateResult.True,
+            ShouldHandle = _ => PredicateResult.True(),
             ManualControl = manualControl,
         };
 
@@ -54,9 +54,9 @@ public static object CreateCircuitBreaker(PollyVersion technology)
                     BreakDuration = TimeSpan.FromSeconds(5),
                     ShouldHandle = args => args.Outcome switch
                     {
-                        { Exception: InvalidOperationException } => PredicateResult.True,
-                        { Result: string result } when result == Failure => PredicateResult.True,
-                        _ => PredicateResult.False
+                        { Exception: InvalidOperationException } => PredicateResult.True(),
+                        { Result: string result } when result == Failure => PredicateResult.True(),
+                        _ => PredicateResult.False()
                     }
                 });
             }),

diff --git a/bench/Polly.Core.Benchmarks/Utils/Helper.Hedging.cs b/bench/Polly.Core.Benchmarks/Utils/Helper.Hedging.cs
@@ -13,7 +13,7 @@ public static ResiliencePipeline<string> CreateHedging()
             builder.AddHedging(new HedgingStrategyOptions<string>
             {
                 ShouldHandle = args => new ValueTask<bool>(args.Outcome.Result == Failure),
-                ActionGenerator = args => () => Outcome.FromResultAsTask("hedged response"),
+                ActionGenerator = args => () => Outcome.FromResultAsValueTask("hedged response"),
             });
         });
     }

diff --git a/bench/Polly.Core.Benchmarks/Utils/Helper.MultipleStrategies.cs b/bench/Polly.Core.Benchmarks/Utils/Helper.MultipleStrategies.cs
@@ -29,9 +29,9 @@ internal static partial class Helper
                     Delay = TimeSpan.FromSeconds(1),
                     ShouldHandle = args => args.Outcome switch
                     {
-                        { Exception: InvalidOperationException } => PredicateResult.True,
-                        { Result: string result } when result == Failure => PredicateResult.True,
-                        _ => PredicateResult.False
+                        { Exception: InvalidOperationException } => PredicateResult.True(),
+                        { Result: string result } when result == Failure => PredicateResult.True(),
+                        _ => PredicateResult.False()
                     }
                 })
                 .AddTimeout(TimeSpan.FromSeconds(1))
@@ -43,9 +43,9 @@ internal static partial class Helper
                     BreakDuration = TimeSpan.FromSeconds(5),
                     ShouldHandle = args => args.Outcome switch
                     {
-                        { Exception: InvalidOperationException } => PredicateResult.True,
-                        { Result: string result } when result == Failure => PredicateResult.True,
-                        _ => PredicateResult.False
+                        { Exception: InvalidOperationException } => PredicateResult.True(),
+                        { Result: string result } when result == Failure => PredicateResult.True(),
+                        _ => PredicateResult.False()
                     }
                 });
 
@@ -73,9 +73,9 @@ public static ResiliencePipeline CreateNonGenericStrategyPipeline(bool telemetry
                 Delay = TimeSpan.FromSeconds(1),
                 ShouldHandle = args => args.Outcome switch
                 {
-                    { Exception: InvalidOperationException } => PredicateResult.True,
-                    { Result: string result } when result == Failure => PredicateResult.True,
-                    _ => PredicateResult.False
+                    { Exception: InvalidOperationException } => PredicateResult.True(),
+                    { Result: string result } when result == Failure => PredicateResult.True(),
+                    _ => PredicateResult.False()
                 }
             })
             .AddTimeout(TimeSpan.FromSeconds(1))
@@ -87,9 +87,9 @@ public static ResiliencePipeline CreateNonGenericStrategyPipeline(bool telemetry
                 BreakDuration = TimeSpan.FromSeconds(5),
                 ShouldHandle = args => args.Outcome switch
                 {
-                    { Exception: InvalidOperationException } => PredicateResult.True,
-                    { Result: string result } when result == Failure => PredicateResult.True,
-                    _ => PredicateResult.False
+                    { Exception: InvalidOperationException } => PredicateResult.True(),
+                    { Result: string result } when result == Failure => PredicateResult.True(),
+                    _ => PredicateResult.False()
                 }
             });
 

diff --git a/bench/Polly.Core.Benchmarks/Utils/Helper.Retry.cs b/bench/Polly.Core.Benchmarks/Utils/Helper.Retry.cs
@@ -23,9 +23,9 @@ public static object CreateRetry(PollyVersion technology)
                     Delay = delay,
                     ShouldHandle = args => args.Outcome switch
                     {
-                        { Exception: InvalidOperationException } => PredicateResult.True,
-                        { Result: string result } when result == Failure => PredicateResult.True,
-                        _ => PredicateResult.False
+                        { Exception: InvalidOperationException } => PredicateResult.True(),
+                        { Result: string result } when result == Failure => PredicateResult.True(),
+                        _ => PredicateResult.False()
                     },
                     OnRetry = _ => default
                 });

diff --git a/bench/Polly.Core.Benchmarks/Utils/Helper.cs b/bench/Polly.Core.Benchmarks/Utils/Helper.cs
@@ -15,7 +15,7 @@ public static async ValueTask ExecuteAsync(this object obj, PollyVersion version
                 var context = ResilienceContextPool.Shared.Get();
 
                 await ((ResiliencePipeline<string>)obj).ExecuteOutcomeAsync(
-                    static (_, _) => Outcome.FromResultAsTask("dummy"),
+                    static (_, _) => Outcome.FromResultAsValueTask("dummy"),
                     context,
                     string.Empty).ConfigureAwait(false);
 

diff --git a/src/Polly.Core/CircuitBreaker/Controller/CircuitStateController.cs b/src/Polly.Core/CircuitBreaker/Controller/CircuitStateController.cs
@@ -298,9 +298,9 @@ private void SetLastHandledOutcome_NeedsLock(Outcome<T> outcome)
         {
             _breakingException = new BrokenCircuitException(BrokenCircuitException.DefaultMessage, exception);
         }
-        else if (outcome.TryGetResult(out var result))
+        else
         {
-            _breakingException = new BrokenCircuitException<T>(BrokenCircuitException.DefaultMessage, result!);
+            _breakingException = new BrokenCircuitException(BrokenCircuitException.DefaultMessage);
         }
     }
 

diff --git a/src/Polly.Core/Outcome.TResult.cs b/src/Polly.Core/Outcome.TResult.cs
@@ -56,7 +56,7 @@ internal Outcome(ExceptionDispatchInfo exceptionDispatchInfo)
     /// <remarks>
     /// If the operation produced a result, this method does nothing. The thrown exception maintains its original stack trace.
     /// </remarks>
-    public void EnsureSuccess() => ExceptionDispatchInfo?.Throw();
+    public void ThrowIfException() => ExceptionDispatchInfo?.Throw();
 
     /// <summary>
     /// Tries to get the result, if available.

diff --git a/src/Polly.Core/Outcome.cs b/src/Polly.Core/Outcome.cs
@@ -19,7 +19,7 @@ public static class Outcome
     /// <typeparam name="TResult">The type of the result.</typeparam>
     /// <param name="value">The result value.</param>
     /// <returns>A completed <see cref="ValueTask{TResult}"/> that produces <see cref="Outcome{TResult}"/>.</returns>
-    public static ValueTask<Outcome<TResult>> FromResultAsTask<TResult>(TResult value) => new(FromResult(value));
+    public static ValueTask<Outcome<TResult>> FromResultAsValueTask<TResult>(TResult value) => new(FromResult(value));
 
     /// <summary>
     /// Returns a <see cref="Outcome{TResult}"/> with the given <paramref name="exception"/>.
@@ -42,7 +42,7 @@ public static Outcome<TResult> FromException<TResult>(Exception exception)
     /// <param name="exception">The exception.</param>
     /// <returns>A completed <see cref="ValueTask{TResult}"/> that produces <see cref="Outcome{TResult}"/>.</returns>
     /// <exception cref="ArgumentNullException">Thrown when <paramref name="exception"/> is <see langword="null"/>.</exception>
-    public static ValueTask<Outcome<TResult>> FromExceptionAsTask<TResult>(Exception exception)
+    public static ValueTask<Outcome<TResult>> FromExceptionAsValueTask<TResult>(Exception exception)
     {
         Guard.NotNull(exception);
 

diff --git a/src/Polly.Core/PredicateResult.cs b/src/Polly.Core/PredicateResult.cs
@@ -6,12 +6,14 @@ namespace Polly;
 public static class PredicateResult
 {
     /// <summary>
-    /// Gets a finished <see cref="ValueTask{TResult}"/> that returns <see langword="true"/> value.
+    /// Returns a finished <see cref="ValueTask{TResult}"/> that returns <see langword="true"/> value.
     /// </summary>
-    public static ValueTask<bool> True => new(true);
+    /// <returns>A new instance of finished <see cref="ValueTask{TResult}"/>.</returns>
+    public static ValueTask<bool> True() => new(true);
 
     /// <summary>
-    /// Gets a finished <see cref="ValueTask{TResult}"/> that returns <see langword="false"/> value.
+    /// Returns a finished <see cref="ValueTask{TResult}"/> that returns <see langword="false"/> value.
     /// </summary>
-    public static ValueTask<bool> False => new(false);
+    /// <returns>A new instance of finished <see cref="ValueTask{TResult}"/>.</returns>
+    public static ValueTask<bool> False() => new(false);
 }
diff --git a/src/Polly.Core/PublicAPI.Unshipped.txt b/src/Polly.Core/PublicAPI.Unshipped.txt
@@ -15,11 +15,6 @@ Polly.CircuitBreaker.BrokenCircuitException
 Polly.CircuitBreaker.BrokenCircuitException.BrokenCircuitException() -> void
 Polly.CircuitBreaker.BrokenCircuitException.BrokenCircuitException(string! message) -> void
 Polly.CircuitBreaker.BrokenCircuitException.BrokenCircuitException(string! message, System.Exception! inner) -> void
-Polly.CircuitBreaker.BrokenCircuitException<TResult>
-Polly.CircuitBreaker.BrokenCircuitException<TResult>.BrokenCircuitException(string! message, System.Exception! inner, TResult result) -> void
-Polly.CircuitBreaker.BrokenCircuitException<TResult>.BrokenCircuitException(string! message, TResult result) -> void
-Polly.CircuitBreaker.BrokenCircuitException<TResult>.BrokenCircuitException(TResult result) -> void
-Polly.CircuitBreaker.BrokenCircuitException<TResult>.Result.get -> TResult
 Polly.CircuitBreaker.CircuitBreakerManualControl
 Polly.CircuitBreaker.CircuitBreakerManualControl.CircuitBreakerManualControl() -> void
 Polly.CircuitBreaker.CircuitBreakerManualControl.CircuitBreakerManualControl(bool isIsolated) -> void
@@ -158,10 +153,10 @@ Polly.HedgingResiliencePipelineBuilderExtensions
 Polly.LegacySupport
 Polly.Outcome
 Polly.Outcome<TResult>
-Polly.Outcome<TResult>.EnsureSuccess() -> void
 Polly.Outcome<TResult>.Exception.get -> System.Exception?
 Polly.Outcome<TResult>.Outcome() -> void
 Polly.Outcome<TResult>.Result.get -> TResult?
+Polly.Outcome<TResult>.ThrowIfException() -> void
 Polly.PredicateBuilder
 Polly.PredicateBuilder.PredicateBuilder() -> void
 Polly.PredicateBuilder<TResult>
@@ -296,10 +291,9 @@ Polly.Retry.OnRetryArguments<TResult>.RetryDelay.get -> System.TimeSpan
 Polly.Retry.RetryDelayGeneratorArguments<TResult>
 Polly.Retry.RetryDelayGeneratorArguments<TResult>.AttemptNumber.get -> int
 Polly.Retry.RetryDelayGeneratorArguments<TResult>.Context.get -> Polly.ResilienceContext!
-Polly.Retry.RetryDelayGeneratorArguments<TResult>.DelayHint.get -> System.TimeSpan
 Polly.Retry.RetryDelayGeneratorArguments<TResult>.Outcome.get -> Polly.Outcome<TResult>
 Polly.Retry.RetryDelayGeneratorArguments<TResult>.RetryDelayGeneratorArguments() -> void
-Polly.Retry.RetryDelayGeneratorArguments<TResult>.RetryDelayGeneratorArguments(Polly.ResilienceContext! context, Polly.Outcome<TResult> outcome, int attemptNumber, System.TimeSpan delayHint) -> void
+Polly.Retry.RetryDelayGeneratorArguments<TResult>.RetryDelayGeneratorArguments(Polly.ResilienceContext! context, Polly.Outcome<TResult> outcome, int attemptNumber) -> void
 Polly.Retry.RetryPredicateArguments<TResult>
 Polly.Retry.RetryPredicateArguments<TResult>.AttemptNumber.get -> int
 Polly.Retry.RetryPredicateArguments<TResult>.Context.get -> Polly.ResilienceContext!
@@ -313,7 +307,7 @@ Polly.Retry.RetryStrategyOptions<TResult>.BackoffType.get -> Polly.DelayBackoffT
 Polly.Retry.RetryStrategyOptions<TResult>.BackoffType.set -> void
 Polly.Retry.RetryStrategyOptions<TResult>.Delay.get -> System.TimeSpan
 Polly.Retry.RetryStrategyOptions<TResult>.Delay.set -> void
-Polly.Retry.RetryStrategyOptions<TResult>.DelayGenerator.get -> System.Func<Polly.Retry.RetryDelayGeneratorArguments<TResult>, System.Threading.Tasks.ValueTask<System.TimeSpan>>?
+Polly.Retry.RetryStrategyOptions<TResult>.DelayGenerator.get -> System.Func<Polly.Retry.RetryDelayGeneratorArguments<TResult>, System.Threading.Tasks.ValueTask<System.TimeSpan?>>?
 Polly.Retry.RetryStrategyOptions<TResult>.DelayGenerator.set -> void
 Polly.Retry.RetryStrategyOptions<TResult>.MaxRetryAttempts.get -> int
 Polly.Retry.RetryStrategyOptions<TResult>.MaxRetryAttempts.set -> void
@@ -403,15 +397,15 @@ static Polly.FallbackResiliencePipelineBuilderExtensions.AddFallback<TResult>(th
 static Polly.HedgingResiliencePipelineBuilderExtensions.AddHedging<TResult>(this Polly.ResiliencePipelineBuilder<TResult>! builder, Polly.Hedging.HedgingStrategyOptions<TResult>! options) -> Polly.ResiliencePipelineBuilder<TResult>!
 static Polly.LegacySupport.SetProperties(this Polly.ResilienceProperties! resilienceProperties, System.Collections.Generic.IDictionary<string!, object?>! properties, out System.Collections.Generic.IDictionary<string!, object?>! oldProperties) -> void
 static Polly.Outcome.FromException<TResult>(System.Exception! exception) -> Polly.Outcome<TResult>
-static Polly.Outcome.FromExceptionAsTask<TResult>(System.Exception! exception) -> System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>
+static Polly.Outcome.FromExceptionAsValueTask<TResult>(System.Exception! exception) -> System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>
 static Polly.Outcome.FromResult<TResult>(TResult? value) -> Polly.Outcome<TResult>
-static Polly.Outcome.FromResultAsTask<TResult>(TResult value) -> System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>
+static Polly.Outcome.FromResultAsValueTask<TResult>(TResult value) -> System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>
 static Polly.PredicateBuilder<TResult>.implicit operator System.Func<Polly.CircuitBreaker.CircuitBreakerPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!(Polly.PredicateBuilder<TResult>! builder) -> System.Func<Polly.CircuitBreaker.CircuitBreakerPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!
 static Polly.PredicateBuilder<TResult>.implicit operator System.Func<Polly.Fallback.FallbackPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!(Polly.PredicateBuilder<TResult>! builder) -> System.Func<Polly.Fallback.FallbackPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!
 static Polly.PredicateBuilder<TResult>.implicit operator System.Func<Polly.Hedging.HedgingPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!(Polly.PredicateBuilder<TResult>! builder) -> System.Func<Polly.Hedging.HedgingPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!
 static Polly.PredicateBuilder<TResult>.implicit operator System.Func<Polly.Retry.RetryPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!(Polly.PredicateBuilder<TResult>! builder) -> System.Func<Polly.Retry.RetryPredicateArguments<TResult>, System.Threading.Tasks.ValueTask<bool>>!
-static Polly.PredicateResult.False.get -> System.Threading.Tasks.ValueTask<bool>
-static Polly.PredicateResult.True.get -> System.Threading.Tasks.ValueTask<bool>
+static Polly.PredicateResult.False() -> System.Threading.Tasks.ValueTask<bool>
+static Polly.PredicateResult.True() -> System.Threading.Tasks.ValueTask<bool>
 static Polly.ResilienceContextPool.Shared.get -> Polly.ResilienceContextPool!
 static Polly.ResiliencePipelineBuilderExtensions.AddPipeline<TBuilder>(this TBuilder! builder, Polly.ResiliencePipeline! pipeline) -> TBuilder!
 static Polly.ResiliencePipelineBuilderExtensions.AddPipeline<TResult>(this Polly.ResiliencePipelineBuilder<TResult>! builder, Polly.ResiliencePipeline<TResult>! pipeline) -> Polly.ResiliencePipelineBuilder<TResult>!

diff --git a/src/Polly.Core/README.md b/src/Polly.Core/README.md
@@ -226,10 +226,10 @@ new ResiliencePipelineBuilder()
     {
         ShouldRetry = args => args switch
         {
-            { Exception: InvalidOperationException } => PredicateResult.True,
-            { Result: string result } when result == Failure => PredicateResult.True,
-            { Result: int result } when result == -1 => PredicateResult.True,
-            _ => PredicateResult.False
+            { Exception: InvalidOperationException } => PredicateResult.True(),
+            { Result: string result } when result == Failure => PredicateResult.True(),
+            { Result: int result } when result == -1 => PredicateResult.True(),
+            _ => PredicateResult.False()
         },
     })
     .Build();
@@ -243,9 +243,9 @@ new ResiliencePipelineBuilder()
     {
         ShouldRetry = args => args switch
         {
-            { Exception: InvalidOperationException } => PredicateResult.True,
-            { Result: result } when result == Failure => PredicateResult.True,
-            _ => PredicateResult.False
+            { Exception: InvalidOperationException } => PredicateResult.True(),
+            { Result: result } when result == Failure => PredicateResult.True(),
+            _ => PredicateResult.False()
         },
     })
     .Build();