diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry.Testers/EonaCat.SmartRetry.Testers.csproj b/EonaCat.SmartRetry/EonaCat.SmartRetry.Testers/EonaCat.SmartRetry.Testers.csproj new file mode 100644 index 0000000..39096e4 --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry.Testers/EonaCat.SmartRetry.Testers.csproj @@ -0,0 +1,14 @@ + + + + Exe + net10.0 + enable + enable + + + + + + + diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry.Testers/Program.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry.Testers/Program.cs new file mode 100644 index 0000000..8abb458 --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry.Testers/Program.cs @@ -0,0 +1,38 @@ +using EonaCat.SmartRetry; + +// This file is part of the EonaCat project(s) which is released under the Apache License. +// See the LICENSE file or go to https://EonaCat.com/License for full license details. + +class Program +{ + static async Task Main() + { + var policy = SmartRetryPolicy.Policy() + .Handle() + .Retry(5) + .WithExponentialBackoff(1, 2) + .WithJitter(0.2) + .WithCircuitBreaker(failureThreshold: 3, openDuration: TimeSpan.FromSeconds(10)) + .WithFallbackAsync(async () => + { + Console.WriteLine("Executing fallback..."); + await Task.Delay(50); + + // fallback value + return 42; + }) + .OnRetry((attempt, ex) => Console.WriteLine($"Retry {attempt}: {ex.Message}")) + .OnCircuitOpen(() => Console.WriteLine("Circuit breaker opened")) + .OnCircuitClose(() => Console.WriteLine("Circuit breaker closed")); + + int result = await policy.ExecuteAsync(async (ct) => + { + Console.WriteLine("Attempting operation..."); + await Task.Delay(50, ct); + throw new TimeoutException("Simulated failure"); + }); + + Console.WriteLine($"Result: {result}"); + + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry.slnx b/EonaCat.SmartRetry/EonaCat.SmartRetry.slnx new file mode 100644 index 0000000..7e552eb --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry.slnx @@ -0,0 +1,4 @@ + + + + diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/BackoffStrategyType.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/BackoffStrategyType.cs new file mode 100644 index 0000000..5fe5f47 --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/BackoffStrategyType.cs @@ -0,0 +1,12 @@ +namespace EonaCat.SmartRetry +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public enum BackoffStrategyType + { + Exponential, + Linear, + Custom + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/CircuitBreaker.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/CircuitBreaker.cs new file mode 100644 index 0000000..f3d9f15 --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/CircuitBreaker.cs @@ -0,0 +1,61 @@ +using System; + +namespace EonaCat.SmartRetry +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public class CircuitBreaker + { + private readonly int _failureThreshold; + private readonly TimeSpan _openDuration; + private int _failureCount = 0; + private DateTime _lastFailureTime = DateTime.MinValue; + + public CircuitBreakerState State { get; private set; } = CircuitBreakerState.Closed; + + public Action OnOpen { get; set; } + public Action OnClose { get; set; } + + public CircuitBreaker(int failureThreshold = 5, TimeSpan? openDuration = null) + { + _failureThreshold = failureThreshold; + _openDuration = openDuration ?? TimeSpan.FromSeconds(30); + } + + public bool CanExecute() + { + if (State == CircuitBreakerState.Open) + { + if ((DateTime.Now - _lastFailureTime) >= _openDuration) + { + State = CircuitBreakerState.HalfOpen; + return true; + } + return false; + } + return true; + } + + public void OnSuccess() + { + _failureCount = 0; + if (State != CircuitBreakerState.Closed) + { + State = CircuitBreakerState.Closed; + OnClose?.Invoke(); + } + } + + public void OnFailure() + { + _failureCount++; + _lastFailureTime = DateTime.Now; + if (_failureCount >= _failureThreshold) + { + State = CircuitBreakerState.Open; + OnOpen?.Invoke(); + } + } + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/CircuitBreakerState.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/CircuitBreakerState.cs new file mode 100644 index 0000000..0a834a1 --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/CircuitBreakerState.cs @@ -0,0 +1,12 @@ +namespace EonaCat.SmartRetry +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public enum CircuitBreakerState + { + Closed, + Open, + HalfOpen + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/EonaCat.SmartRetry.csproj b/EonaCat.SmartRetry/EonaCat.SmartRetry/EonaCat.SmartRetry.csproj new file mode 100644 index 0000000..3abc64c --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/EonaCat.SmartRetry.csproj @@ -0,0 +1,38 @@ + + + + netstandard2.1 + enable + latest + True + EonaCat.SmartRetry + EonaCat.SmartRetry + EonaCat (Jeroen Saey) + EonaCat + Powerful and flexible .NET library for building resilient applications. + EonaCat (Jeroen Saey) + https://git.saey.me/EonaCat/EonaCat.SmartRetry + icon.png + readme.md + https://git.saey.me/EonaCat/EonaCat.SmartRetry + git + retry;smart;resilient;EonaCat;Jeroen;Saey;power;circuitbreaker;circuit;breaker;auto;fallback + LICENSE + + + + + True + \ + + + True + \ + + + True + \ + + + + diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/ISmartRetryPolicy.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/ISmartRetryPolicy.cs new file mode 100644 index 0000000..604c69f --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/ISmartRetryPolicy.cs @@ -0,0 +1,32 @@ +using System; +using System.Threading; +using System.Threading.Tasks; + +namespace EonaCat.SmartRetry +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public interface ISmartRetryPolicy + { + ISmartRetryPolicy Handle() where TException : Exception; + ISmartRetryPolicy Retry(int retryCount); + ISmartRetryPolicy WithExponentialBackoff(double initialDelaySeconds = 1.0, double multiplier = 2.0); + ISmartRetryPolicy WithLinearBackoff(double delaySeconds = 1.0); + ISmartRetryPolicy WithCustomBackoff(Func delayProvider); + ISmartRetryPolicy WithJitter(double maxPercentage = 0.3); + ISmartRetryPolicy WithCircuitBreaker(int failureThreshold = 5, TimeSpan? openDuration = null); + ISmartRetryPolicy WithFallback(Func fallbackAction); + ISmartRetryPolicy WithFallbackAsync(Func> fallbackAction); + ISmartRetryPolicy OnRetry(Action onRetry); + ISmartRetryPolicy OnRetryAsync(Func onRetryAsync); + ISmartRetryPolicy OnCircuitOpen(Action onOpen); + ISmartRetryPolicy OnCircuitClose(Action onClose); + ISmartRetryPolicy RetryIf(Func shouldRetry); + ISmartRetryPolicy WithMaxRetryDuration(TimeSpan maxDuration); + + Task ExecuteAsync(Func> action, CancellationToken token = default); + Task ExecuteAsync(Func> action); + T Execute(Func action); + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/RetryFailedException.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/RetryFailedException.cs new file mode 100644 index 0000000..24afbef --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/RetryFailedException.cs @@ -0,0 +1,14 @@ +using System; + +namespace EonaCat.SmartRetry.Exceptions +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public class RetryFailedException : Exception + { + public RetryFailedException(string message, Exception innerException) + : base(message, innerException) + { } + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/RetryStrategy.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/RetryStrategy.cs new file mode 100644 index 0000000..e66c355 --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/RetryStrategy.cs @@ -0,0 +1,18 @@ +using System; + +namespace EonaCat.SmartRetry +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public class RetryStrategy + { + public int MaxRetries { get; set; } = 3; + public double InitialDelaySeconds { get; set; } = 1.0; + public double BackoffMultiplier { get; set; } = 2.0; + public BackoffStrategyType BackoffType { get; set; } = BackoffStrategyType.Exponential; + public Func CustomDelayProvider { get; set; } + public double JitterMaxPercentage { get; set; } = 0.0; + public TimeSpan? MaxRetryDuration { get; set; } + } +} diff --git a/EonaCat.SmartRetry/EonaCat.SmartRetry/SmartRetryPolicy.cs b/EonaCat.SmartRetry/EonaCat.SmartRetry/SmartRetryPolicy.cs new file mode 100644 index 0000000..2fb137d --- /dev/null +++ b/EonaCat.SmartRetry/EonaCat.SmartRetry/SmartRetryPolicy.cs @@ -0,0 +1,206 @@ +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using EonaCat.SmartRetry.Exceptions; + +namespace EonaCat.SmartRetry +{ + // This file is part of the EonaCat project(s) which is released under the Apache License. + // See the LICENSE file or go to https://EonaCat.com/License for full license details. + + public class SmartRetryPolicy : ISmartRetryPolicy + { + private readonly List _handledExceptions = new(); + private readonly RetryStrategy _strategy = new(); + private CircuitBreaker _circuitBreaker; + private Delegate _fallback; + private Delegate _fallbackAsync; + private Func _onRetryAsync; + private Action _onRetry; + private Func _retryCondition; + private readonly Random _jitterGenerator = new(); + + public Action OnCircuitOpenAction { get; set; } + public Action OnCircuitCloseAction { get; set; } + + public static ISmartRetryPolicy Policy() => new SmartRetryPolicy(); + + public ISmartRetryPolicy Handle() where TException : Exception + { + _handledExceptions.Add(typeof(TException)); + return this; + } + + public ISmartRetryPolicy Retry(int retryCount) + { + _strategy.MaxRetries = retryCount; + return this; + } + + public ISmartRetryPolicy WithExponentialBackoff(double initialDelaySeconds = 1.0, double multiplier = 2.0) + { + _strategy.BackoffType = BackoffStrategyType.Exponential; + _strategy.InitialDelaySeconds = initialDelaySeconds; + _strategy.BackoffMultiplier = multiplier; + return this; + } + + public ISmartRetryPolicy WithLinearBackoff(double delaySeconds = 1.0) + { + _strategy.BackoffType = BackoffStrategyType.Linear; + _strategy.InitialDelaySeconds = delaySeconds; + return this; + } + + public ISmartRetryPolicy WithCustomBackoff(Func delayProvider) + { + _strategy.BackoffType = BackoffStrategyType.Custom; + _strategy.CustomDelayProvider = delayProvider; + return this; + } + + public ISmartRetryPolicy WithJitter(double maxPercentage = 0.3) + { + _strategy.JitterMaxPercentage = maxPercentage; + return this; + } + + public ISmartRetryPolicy WithCircuitBreaker(int failureThreshold = 5, TimeSpan? openDuration = null) + { + _circuitBreaker = new CircuitBreaker(failureThreshold, openDuration) + { + OnOpen = () => OnCircuitOpenAction?.Invoke(), + OnClose = () => OnCircuitCloseAction?.Invoke() + }; + return this; + } + + public ISmartRetryPolicy WithFallback(Func fallbackAction) + { + _fallback = fallbackAction; + return this; + } + + public ISmartRetryPolicy WithFallbackAsync(Func> fallbackAction) + { + _fallbackAsync = fallbackAction; + return this; + } + + public ISmartRetryPolicy OnRetry(Action onRetry) + { + _onRetry = onRetry; + return this; + } + + public ISmartRetryPolicy OnRetryAsync(Func onRetryAsync) + { + _onRetryAsync = onRetryAsync; + return this; + } + + public ISmartRetryPolicy OnCircuitOpen(Action onOpen) + { + OnCircuitOpenAction = onOpen; + return this; + } + + public ISmartRetryPolicy OnCircuitClose(Action onClose) + { + OnCircuitCloseAction = onClose; + return this; + } + + public ISmartRetryPolicy RetryIf(Func shouldRetry) + { + _retryCondition = result => shouldRetry((T)result); + return this; + } + + public ISmartRetryPolicy WithMaxRetryDuration(TimeSpan maxDuration) + { + _strategy.MaxRetryDuration = maxDuration; + return this; + } + + private async Task DelayWithBackoffAndJitter(int attempt) + { + double delay = _strategy.BackoffType switch + { + BackoffStrategyType.Linear => _strategy.InitialDelaySeconds, + BackoffStrategyType.Exponential => _strategy.InitialDelaySeconds * Math.Pow(_strategy.BackoffMultiplier, attempt - 1), + BackoffStrategyType.Custom => _strategy.CustomDelayProvider?.Invoke(attempt) ?? 0, + _ => 0 + }; + + double jitter = _strategy.JitterMaxPercentage * delay * _jitterGenerator.NextDouble(); + await Task.Delay(TimeSpan.FromSeconds(delay + jitter)); + } + + private async Task ExecuteFallbackAsync() + { + if (_fallbackAsync != null) + { + return await ((Func>)_fallbackAsync)(); + } + + if (_fallback != null) + { + return ((Func)_fallback)(); + } + + throw new RetryFailedException("All retries failed and no fallback defined.", null); + } + + public async Task ExecuteAsync(Func> action, CancellationToken token = default) + { + int attempt = 0; + DateTime startTime = DateTime.Now; + + while (true) + { + if (_circuitBreaker != null && !_circuitBreaker.CanExecute()) + return await ExecuteFallbackAsync(); + + try + { + var result = await action(token); + + if (_retryCondition != null && _retryCondition(result)) + throw new RetryFailedException("Retry condition met.", null); + + _circuitBreaker?.OnSuccess(); + return result; + } + catch (Exception ex) when (_handledExceptions.Contains(ex.GetType())) + { + attempt++; + _circuitBreaker?.OnFailure(); + + _onRetry?.Invoke(attempt, ex); + if (_onRetryAsync != null) + await _onRetryAsync(attempt, ex); + + if (_strategy.MaxRetryDuration.HasValue && (DateTime.Now - startTime) >= _strategy.MaxRetryDuration) + return await ExecuteFallbackAsync(); + + if (attempt > _strategy.MaxRetries) + return await ExecuteFallbackAsync(); + + await DelayWithBackoffAndJitter(attempt); + } + } + } + + public async Task ExecuteAsync(Func> action) + { + return await ExecuteAsync(ct => action(), CancellationToken.None); + } + + public T Execute(Func action) + { + return ExecuteAsync(() => Task.FromResult(action())).GetAwaiter().GetResult(); + } + } +} diff --git a/LICENSE b/LICENSE index 386c7ef..ab37379 100644 --- a/LICENSE +++ b/LICENSE @@ -1,73 +1,204 @@ -Apache License -Version 2.0, January 2004 -http://www.apache.org/licenses/ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + https://EonaCat.com/license/ -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + OF SOFTWARE BY EONACAT (JEROEN SAEY) -1. Definitions. + 1. Definitions. -"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. -"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. -"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. -"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. -"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. -"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. -"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). -"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. -"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." -"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. -2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. -3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. -4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: - (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and - (b) You must cause any modified files to carry prominent notices stating that You changed the files; and + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and - (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and - (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. - You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. -5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. -6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. -7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. -8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. -9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. -END OF TERMS AND CONDITIONS + END OF TERMS AND CONDITIONS -APPENDIX: How to apply the Apache License to your work. + APPENDIX: How to apply the Apache License to your work. -To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. -Copyright 2025 EonaCat + Copyright [yyyy] [name of copyright owner] -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at -http://www.apache.org/licenses/LICENSE-2.0 + http://www.apache.org/licenses/LICENSE-2.0 -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 47360ff..800e366 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,125 @@ # EonaCat.SmartRetry -EonaCat.SmartRetry \ No newline at end of file +[![NuGet](https://img.shields.io/nuget/v/EonaCat.SmartRetry)](https://www.nuget.org/packages/EonaCat.SmartRetry) + +`EonaCat.SmartRetry` is a powerful and flexible .NET library for building resilient applications. + +It provides **retry policies**, **circuit breakers**, **fallbacks**, **jittered backoff**, **async/sync support**, and more + +--- + +## Features + +- Retry on **exceptions** or **result conditions** +- Configurable **retry count** and **max retry duration** +- **Exponential**, **linear**, or **custom backoff** strategies +- **Jitter** support to prevent thundering herd +- **Circuit breaker** with open, half-open, and closed states +- **Sync and async fallback actions** +- Retry **with cancellation tokens** +- Logging and async callbacks for retries and circuit breaker events +- Thread-safe for **multi-threaded operations** +- Named policies for reusable resilience configurations + +--- + +## Installation + +Install via NuGet: + +```bash +dotnet add package EonaCat.SmartRetry +``` + +Or via Package Manager: +```csharp +Install-Package EonaCat.SmartRetry +``` + +# Usage Examples +## Basic Retry with Fallback + +```csharp +using EonaCat.SmartRetry; + +var policy = SmartRetryPolicy.Policy() + .Handle() + .Retry(3) + .WithExponentialBackoff(1, 2) + .WithFallbackAsync(async () => + { + Console.WriteLine("Executing fallback..."); + await Task.Delay(50); + + // fallback value + return 42; + }); + +int result = await policy.ExecuteAsync(async () => +{ + Console.WriteLine("Attempting operation..."); + await Task.Delay(50); + throw new TimeoutException("Simulated failure"); +}); + +// Outputs: 42 +Console.WriteLine($"Result: {result}"); +``` + + +## Retry with Circuit Breaker, Jitter, and Logging + +```csharp +var policy = SmartRetryPolicy.Policy() + .Handle() + .Retry(5) + .WithExponentialBackoff(1, 2) + .WithJitter(0.2) + .WithCircuitBreaker(failureThreshold: 3, openDuration: TimeSpan.FromSeconds(10)) + .WithFallbackAsync(async () => + { + Console.WriteLine("Executing fallback..."); + await Task.Delay(50); + return -1; + }) + .OnRetry((attempt, ex) => Console.WriteLine($"Retry {attempt}: {ex.Message}")) + .OnCircuitOpen(() => Console.WriteLine("Circuit breaker opened")) + .OnCircuitClose(() => Console.WriteLine("Circuit breaker closed")); + +int result = await policy.ExecuteAsync(async (ct) => +{ + Console.WriteLine("Attempting operation..."); + await Task.Delay(50, ct); + throw new TimeoutException("Simulated failure"); +}); + +Console.WriteLine($"Result: {result}"); + +``` + +## Retry Based on Result Condition +```csharp +var policy = SmartRetryPolicy.Policy() + .RetryIf(value => value < 0) // retry if result is negative + .Retry(3) + .WithLinearBackoff(0.5) + .WithFallback(() => 0); + +int result = policy.Execute(() => +{ + Console.WriteLine("Returning -1 to trigger retry..."); + return -1; +}); + +// Outputs: 0 (fallback) +Console.WriteLine($"Result: {result}"); + +``` + +# Advanced Features + +* Max Retry Duration: Stop retrying after a total duration. +* CancellationToken Support: Cancel retry loops gracefully. +* Custom Backoff Functions: Provide your own delay logic. +* Async Logging Hooks: Integrate with metrics or monitoring systems. +* Named Policies: Standardize retry/circuit-breaker behavior across your app. \ No newline at end of file diff --git a/icon.png b/icon.png new file mode 100644 index 0000000..0595b89 Binary files /dev/null and b/icon.png differ