Simmy v8

src/Polly.Core/Outcome.TResult.cs

@@ -15,7 +15,13 @@ namespace Polly;
 public readonly struct Outcome<TResult>
 {
     internal Outcome(Exception exception)
-        : this() => ExceptionDispatchInfo = ExceptionDispatchInfo.Capture(Guard.NotNull(exception));
+        : this()
+    {
+        if (exception != null)
+        {
+            ExceptionDispatchInfo = ExceptionDispatchInfo.Capture(exception);
+        }
+    }
 
     internal Outcome(TResult? result)
         : this() => Result = result;

src/Polly.Core/PublicAPI.Unshipped.txt

@@ -316,6 +316,77 @@ Polly.Retry.RetryStrategyOptions<TResult>.ShouldHandle.set -> void
 Polly.Retry.RetryStrategyOptions<TResult>.UseJitter.get -> bool
 Polly.Retry.RetryStrategyOptions<TResult>.UseJitter.set -> void
 Polly.RetryCompositeStrategyBuilderExtensions
+Polly.Simmy.Behavior.BehaviorCompositeStrategyBuilderExtensions
+Polly.Simmy.Behavior.BehaviorStrategyOptions
+Polly.Simmy.Behavior.BehaviorStrategyOptions.Behavior.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask>!
+Polly.Simmy.Behavior.BehaviorStrategyOptions.Behavior.set -> void
+Polly.Simmy.Behavior.BehaviorStrategyOptions.BehaviorStrategyOptions() -> void
+Polly.Simmy.Behavior.BehaviorStrategyOptions.OnBehaviorInjected.get -> System.Func<Polly.Simmy.Behavior.OnBehaviorInjectedArguments, System.Threading.Tasks.ValueTask>?
+Polly.Simmy.Behavior.BehaviorStrategyOptions.OnBehaviorInjected.set -> void
+Polly.Simmy.Behavior.OnBehaviorInjectedArguments
+Polly.Simmy.Behavior.OnBehaviorInjectedArguments.Context.get -> Polly.ResilienceContext!
+Polly.Simmy.Behavior.OnBehaviorInjectedArguments.Context.init -> void
+Polly.Simmy.Behavior.OnBehaviorInjectedArguments.OnBehaviorInjectedArguments() -> void
+Polly.Simmy.Behavior.OnBehaviorInjectedArguments.OnBehaviorInjectedArguments(Polly.ResilienceContext! Context) -> void
+Polly.Simmy.Latency.LatencyCompositeStrategyBuilderExtensions
+Polly.Simmy.Latency.LatencyStrategyOptions
+Polly.Simmy.Latency.LatencyStrategyOptions.Latency.get -> System.TimeSpan?
+Polly.Simmy.Latency.LatencyStrategyOptions.Latency.set -> void
+Polly.Simmy.Latency.LatencyStrategyOptions.LatencyGenerator.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<System.TimeSpan>>!
+Polly.Simmy.Latency.LatencyStrategyOptions.LatencyGenerator.set -> void
+Polly.Simmy.Latency.LatencyStrategyOptions.LatencyStrategyOptions() -> void
+Polly.Simmy.Latency.LatencyStrategyOptions.OnDelayed.get -> System.Func<Polly.Simmy.Latency.OnDelayedArguments, System.Threading.Tasks.ValueTask>?
+Polly.Simmy.Latency.LatencyStrategyOptions.OnDelayed.set -> void
+Polly.Simmy.Latency.OnDelayedArguments
+Polly.Simmy.Latency.OnDelayedArguments.Context.get -> Polly.ResilienceContext!
+Polly.Simmy.Latency.OnDelayedArguments.Context.init -> void
+Polly.Simmy.Latency.OnDelayedArguments.Latency.get -> System.TimeSpan
+Polly.Simmy.Latency.OnDelayedArguments.Latency.init -> void
+Polly.Simmy.Latency.OnDelayedArguments.OnDelayedArguments() -> void
+Polly.Simmy.Latency.OnDelayedArguments.OnDelayedArguments(Polly.ResilienceContext! Context, System.TimeSpan Latency) -> void
+Polly.Simmy.MonkeyStrategy
+Polly.Simmy.MonkeyStrategy.EnabledGenerator.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<bool>>!
+Polly.Simmy.MonkeyStrategy.InjectionRateGenerator.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<double>>!
+Polly.Simmy.MonkeyStrategy.MonkeyStrategy(Polly.Simmy.MonkeyStrategyOptions! options) -> void
+Polly.Simmy.MonkeyStrategy.ShouldInject(Polly.ResilienceContext! context) -> System.Threading.Tasks.ValueTask<bool>
+Polly.Simmy.MonkeyStrategy<T>
+Polly.Simmy.MonkeyStrategy<T>.ExecuteAsync<TResult, TState>(System.Func<Polly.ResilienceContext!, TState, System.Threading.Tasks.ValueTask<TResult>>! callback, Polly.ResilienceContext! context, TState state) -> System.Threading.Tasks.ValueTask<TResult>
+Polly.Simmy.MonkeyStrategy<T>.ExecuteAsync<TResult, TState>(System.Func<TState, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<TResult>>! callback, TState state, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<TResult>
+Polly.Simmy.MonkeyStrategy<T>.ExecuteAsync<TResult>(System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<TResult>>! callback, Polly.ResilienceContext! context) -> System.Threading.Tasks.ValueTask<TResult>
+Polly.Simmy.MonkeyStrategy<T>.ExecuteAsync<TResult>(System.Func<System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<TResult>>! callback, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<TResult>
+Polly.Simmy.MonkeyStrategy<T>.ExecuteOutcomeAsync<TResult, TState>(System.Func<Polly.ResilienceContext!, TState, System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>>! callback, Polly.ResilienceContext! context, TState state) -> System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>
+Polly.Simmy.MonkeyStrategyOptions
+Polly.Simmy.MonkeyStrategyOptions.MonkeyStrategyOptions() -> void
+Polly.Simmy.MonkeyStrategyOptions<TResult>
+Polly.Simmy.MonkeyStrategyOptions<TResult>.Enabled.get -> bool?
+Polly.Simmy.MonkeyStrategyOptions<TResult>.Enabled.set -> void
+Polly.Simmy.MonkeyStrategyOptions<TResult>.EnabledGenerator.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<bool>>!
+Polly.Simmy.MonkeyStrategyOptions<TResult>.EnabledGenerator.set -> void
+Polly.Simmy.MonkeyStrategyOptions<TResult>.InjectionRate.get -> double?
+Polly.Simmy.MonkeyStrategyOptions<TResult>.InjectionRate.set -> void
+Polly.Simmy.MonkeyStrategyOptions<TResult>.InjectionRateGenerator.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<double>>!
+Polly.Simmy.MonkeyStrategyOptions<TResult>.InjectionRateGenerator.set -> void
+Polly.Simmy.MonkeyStrategyOptions<TResult>.MonkeyStrategyOptions() -> void
+Polly.Simmy.MonkeyStrategyOptions<TResult>.Randomizer.get -> System.Func<double>!
+Polly.Simmy.MonkeyStrategyOptions<TResult>.Randomizer.set -> void
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>.Context.get -> Polly.ResilienceContext!
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>.Context.init -> void
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>.OnOutcomeInjectedArguments() -> void
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>.OnOutcomeInjectedArguments(Polly.ResilienceContext! Context, Polly.Outcome<TResult> Outcome) -> void
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>.Outcome.get -> Polly.Outcome<TResult>
+Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>.Outcome.init -> void
+Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions
+Polly.Simmy.Outcomes.OutcomeStrategyOptions
+Polly.Simmy.Outcomes.OutcomeStrategyOptions.OutcomeStrategyOptions() -> void
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.OnOutcomeInjected.get -> System.Func<Polly.Simmy.Outcomes.OnOutcomeInjectedArguments<TResult>, System.Threading.Tasks.ValueTask>?
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.OnOutcomeInjected.set -> void
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.Outcome.get -> Polly.Outcome<TResult>
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.Outcome.set -> void
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.OutcomeGenerator.get -> System.Func<Polly.ResilienceContext!, System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>>!
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.OutcomeGenerator.set -> void
+Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>.OutcomeStrategyOptions() -> void
 Polly.StrategyBuilderContext
 Polly.StrategyBuilderContext.BuilderInstanceName.get -> string?
 Polly.StrategyBuilderContext.BuilderName.get -> string?
@@ -404,6 +475,19 @@ static Polly.ResiliencePropertyKey<TValue>.operator !=(Polly.ResiliencePropertyK
 static Polly.ResiliencePropertyKey<TValue>.operator ==(Polly.ResiliencePropertyKey<TValue> left, Polly.ResiliencePropertyKey<TValue> right) -> bool
 static Polly.RetryCompositeStrategyBuilderExtensions.AddRetry(this Polly.CompositeStrategyBuilder! builder, Polly.Retry.RetryStrategyOptions! options) -> Polly.CompositeStrategyBuilder!
 static Polly.RetryCompositeStrategyBuilderExtensions.AddRetry<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, Polly.Retry.RetryStrategyOptions<TResult>! options) -> Polly.CompositeStrategyBuilder<TResult>!
+static Polly.Simmy.Behavior.BehaviorCompositeStrategyBuilderExtensions.AddBehavior<TBuilder>(this TBuilder! builder, bool enabled, double injectionRate, System.Func<System.Threading.Tasks.ValueTask>! behavior) -> TBuilder!
+static Polly.Simmy.Behavior.BehaviorCompositeStrategyBuilderExtensions.AddBehavior<TBuilder>(this TBuilder! builder, Polly.Simmy.Behavior.BehaviorStrategyOptions! options) -> TBuilder!
+static Polly.Simmy.Latency.LatencyCompositeStrategyBuilderExtensions.AddLatency<TBuilder>(this TBuilder! builder, bool enabled, double injectionRate, System.TimeSpan delay) -> TBuilder!
+static Polly.Simmy.Latency.LatencyCompositeStrategyBuilderExtensions.AddLatency<TBuilder>(this TBuilder! builder, Polly.Simmy.Latency.LatencyStrategyOptions! options) -> TBuilder!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddFault(this Polly.CompositeStrategyBuilder! builder, bool enabled, double injectionRate, System.Exception! fault) -> Polly.CompositeStrategyBuilder!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddFault(this Polly.CompositeStrategyBuilder! builder, bool enabled, double injectionRate, System.Func<System.Threading.Tasks.ValueTask<Polly.Outcome<System.Exception!>>>! faultGenerator) -> Polly.CompositeStrategyBuilder!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddFault(this Polly.CompositeStrategyBuilder! builder, Polly.Simmy.Outcomes.OutcomeStrategyOptions<System.Exception!>! options) -> Polly.CompositeStrategyBuilder!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddFault<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, bool enabled, double injectionRate, System.Exception! fault) -> Polly.CompositeStrategyBuilder<TResult>!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddFault<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, bool enabled, double injectionRate, System.Func<System.Threading.Tasks.ValueTask<Polly.Outcome<System.Exception!>>>! faultGenerator) -> Polly.CompositeStrategyBuilder<TResult>!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddFault<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, Polly.Simmy.Outcomes.OutcomeStrategyOptions<System.Exception!>! options) -> Polly.CompositeStrategyBuilder<TResult>!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddResult<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, bool enabled, double injectionRate, System.Func<System.Threading.Tasks.ValueTask<Polly.Outcome<TResult>>>! outcomeGenerator) -> Polly.CompositeStrategyBuilder<TResult>!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddResult<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, bool enabled, double injectionRate, TResult result) -> Polly.CompositeStrategyBuilder<TResult>!
+static Polly.Simmy.Outcomes.OutcomeCompositeStrategyBuilderExtensions.AddResult<TResult>(this Polly.CompositeStrategyBuilder<TResult>! builder, Polly.Simmy.Outcomes.OutcomeStrategyOptions<TResult>! options) -> Polly.CompositeStrategyBuilder<TResult>!
 static Polly.TimeoutCompositeStrategyBuilderExtensions.AddTimeout<TBuilder>(this TBuilder! builder, Polly.Timeout.TimeoutStrategyOptions! options) -> TBuilder!
 static Polly.TimeoutCompositeStrategyBuilderExtensions.AddTimeout<TBuilder>(this TBuilder! builder, System.TimeSpan timeout) -> TBuilder!
 static Polly.Utils.LegacySupport.SetProperties(this Polly.ResilienceProperties! resilienceProperties, System.Collections.Generic.IDictionary<string!, object?>! properties, out System.Collections.Generic.IDictionary<string!, object?>! oldProperties) -> void

src/Polly.Core/Simmy/Behavior/BehaviorChaosStrategy.cs

@@ -0,0 +1,51 @@
+using Polly.Telemetry;
+
+namespace Polly.Simmy.Behavior;
+
+internal sealed class BehaviorChaosStrategy : MonkeyStrategy
+{
+    private readonly ResilienceStrategyTelemetry _telemetry;
+
+    public BehaviorChaosStrategy(
+        BehaviorStrategyOptions options,
+        ResilienceStrategyTelemetry telemetry)
+        : base(options)
+    {
+        Guard.NotNull(telemetry);
+        Guard.NotNull(options.Behavior);
+
+        _telemetry = telemetry;
+        OnBehaviorInjected = options.OnBehaviorInjected;
+        Behavior = options.Behavior;
+    }
+
+    public Func<OnBehaviorInjectedArguments, ValueTask>? OnBehaviorInjected { get; }
+
+    public Func<ResilienceContext, ValueTask> Behavior { get; }
+
+    protected internal override async ValueTask<Outcome<TResult>> ExecuteCore<TResult, TState>(
+        Func<ResilienceContext, TState, ValueTask<Outcome<TResult>>> callback, ResilienceContext context, TState state)
+    {
+        try
+        {
+            if (await ShouldInject(context).ConfigureAwait(context.ContinueOnCapturedContext))
+            {
+                await Behavior(context).ConfigureAwait(context.ContinueOnCapturedContext);
+
+                var args = new OnBehaviorInjectedArguments(context);
+                _telemetry.Report(new(ResilienceEventSeverity.Warning, BehaviorConstants.OnBehaviorInjectedEvent), context, args);
+
+                if (OnBehaviorInjected is not null)
+                {
+                    await OnBehaviorInjected(args).ConfigureAwait(context.ContinueOnCapturedContext);
+                }
+            }
+
+            return await ExecuteCallbackSafeAsync(callback, context, state).ConfigureAwait(context.ContinueOnCapturedContext);
+        }
+        catch (OperationCanceledException e)
+        {
+            return new Outcome<TResult>(e);
+        }
+    }
+}

src/Polly.Core/Simmy/Behavior/BehaviorCompositeStrategyBuilderExtensions.cs

@@ -0,0 +1,58 @@
+using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Polly.Simmy.Behavior;
+
+/// <summary>
+/// Extension methods for adding custom behaviors to a <see cref="CompositeStrategyBuilder"/>.
+/// </summary>
+public static class BehaviorCompositeStrategyBuilderExtensions
+
+{
+    /// <summary>
+    /// Adds a latency chaos strategy to the builder.
+    /// </summary>
+    /// <typeparam name="TBuilder">The builder type.</typeparam>
+    /// <param name="builder">The builder instance.</param>
+    /// <param name="enabled">A value that indicates whether or not the chaos strategy is enabled for a given execution.</param>
+    /// <param name="injectionRate">The injection rate for a given execution, which the value should be between [0, 1].</param>
+    /// <param name="behavior">The behavior to be injected.</param>
+    /// <returns>The same builder instance.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="builder"/> is <see langword="null"/>.</exception>
+    /// <exception cref="ValidationException">Thrown when the options produced from the arguments are invalid.</exception>
+    public static TBuilder AddBehavior<TBuilder>(this TBuilder builder, bool enabled, double injectionRate, Func<ValueTask> behavior)
+        where TBuilder : CompositeStrategyBuilderBase
+    {
+        Guard.NotNull(builder);
+
+        return builder.AddBehavior(new BehaviorStrategyOptions
+        {
+            Enabled = enabled,
+            InjectionRate = injectionRate,
+            Behavior = (_) => behavior()
+        });
+    }
+
+    /// <summary>
+    /// Adds a behavior chaos strategy to the builder.
+    /// </summary>
+    /// <typeparam name="TBuilder">The builder type.</typeparam>
+    /// <param name="builder">The builder instance.</param>
+    /// <param name="options">The behavior options.</param>
+    /// <returns>The same builder instance.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="builder"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
+    /// <exception cref="ValidationException">Thrown when <paramref name="options"/> are invalid.</exception>
+    [UnconditionalSuppressMessage(
+        "Trimming",
+        "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code",
+        Justification = "All options members preserved.")]
+    public static TBuilder AddBehavior<TBuilder>(this TBuilder builder, BehaviorStrategyOptions options)
+        where TBuilder : CompositeStrategyBuilderBase
+    {
+        Guard.NotNull(builder);
+        Guard.NotNull(options);
+
+        builder.AddStrategy(context => new BehaviorChaosStrategy(options, context.Telemetry), options);
+        return builder;
+    }
+}

src/Polly.Core/Simmy/Behavior/BehaviorConstants.cs

@@ -0,0 +1,6 @@
+namespace Polly.Simmy.Behavior;
+
+internal static class BehaviorConstants
+{
+    public const string OnBehaviorInjectedEvent = "OnBehaviorInjected";
+}

src/Polly.Core/Simmy/Behavior/BehaviorStrategyOptions.cs

@@ -0,0 +1,28 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace Polly.Simmy.Behavior;
+
+#pragma warning disable CS8618 // Required members are not initialized in constructor since this is a DTO, default value is null
+
+/// <summary>
+/// Represents the options for the Behavior chaos strategy.
+/// </summary>
+public class BehaviorStrategyOptions : MonkeyStrategyOptions
+{
+    /// <summary>
+    /// Gets or sets the delegate that's raised when the custom behavior is injected.
+    /// </summary>
+    /// <remarks>
+    /// Defaults to <see langword="null"/>.
+    /// </remarks>
+    public Func<OnBehaviorInjectedArguments, ValueTask>? OnBehaviorInjected { get; set; }
+
+    /// <summary>
+    /// Gets or sets the custom behavior that is going to be injected for a given execution.
+    /// </summary>
+    /// <remarks>
+    /// Defaults to <see langword="null"/>.
+    /// </remarks>
+    [Required]
+    public Func<ResilienceContext, ValueTask> Behavior { get; set; }
+}

src/Polly.Core/Simmy/Behavior/OnBehaviorInjectedArguments.cs

@@ -0,0 +1,7 @@
+namespace Polly.Simmy.Behavior;
+
+/// <summary>
+/// Arguments used by the behavior chaos strategy to notify that a custom behavior was injected.
+/// </summary>
+/// <param name="Context">The context associated with the execution of a user-provided callback.</param>
+public readonly record struct OnBehaviorInjectedArguments(ResilienceContext Context);