Engine.SmartRetry 1.0.0

📦 SmartRetry

SmartRetry is a lightweight, extensible retry mechanism for .NET, designed to handle transient faults with support for exponential backoff and jitter strategies.
Ideal for HTTP calls, database retries, and other retryable operations.

🚀 Features

• ✅ Retry execution with custom logic
• 🔁 Exponential backoff & jitter support
• ⚙️ Configurable via RetryOptions
• 💉 Clean Dependency Injection (DI) integration
• 🧪 Unit & integration tested
• 🛡️ Follows SOLID design principles

📦 Installation

Install via NuGet:

dotnet add package SmartRetry

⚡ Getting Started

1. Register in Program.cs

builder.Services.AddSmartRetry(); // Registers SmartRetry services

💉 Inject & Use the Retry Executor

You can inject IRetryExecutor into your service or controller:

public class MyService
{
    private readonly IRetryExecutor _executor;

    public MyService(IRetryExecutor executor)
    {
        _executor = executor;
    }

    public async Task CallExternalServiceAsync()
    {
        await _executor.ExecuteAsync(
            async () =>
            {
                await httpClient.GetAsync("https://api.example.com");
            });
    }
}

⚙️ Custom Retry Options

You can customize retry behavior using RetryOptions:

var options = new RetryOptions
{
    MaxRetries = 5,
    BaseDelayMs = 200,
    ShouldRetryOnException = ex => ex is TimeoutException || ex is HttpRequestException
};

await _executor.ExecuteAsync(
    async () => await httpClient.GetAsync("https://api.example.com"),
    options: options
);

🔁 Backoff & Jitter Strategy

Built-in backoff strategies include:

• Exponential backoff
• Full jitter / equal jitter

You can implement your own by extending IBackoffStrategy.

🧪 Running Tests

Run Unit & Integration Tests with Coverage

dotnet test --collect:"XPlat Code Coverage"

The test results will be stored in a subfolder of /TestResults/.

📊 Generate Code Coverage Report

Use tools like ReportGenerator:

reportgenerator -reports:**/coverage.cobertura.xml -targetdir:coverage-report

Then open coverage-report/index.html in your browser to view results.

🔍 SonarQube Integration

Optional support for SonarQube:

dotnet sonarscanner begin /k:"SmartRetry" /d:sonar.login="your_token"
dotnet build
dotnet test --collect:"XPlat Code Coverage"
dotnet sonarscanner end /d:sonar.login="your_token"

📁 Project Structure

SmartRetry/
│
├── Abstractions/         # Interfaces like IRetryStrategy, IBackoffStrategy
├── Models/               # RetryOptions, RetryFailedException
├── Strategies/           # Built-in retry/backoff strategies
├── SmartRetry.csproj     # Main library
│
├── SmartRetry.Test/              # Unit tests
├── SmartRetry.IntegrationTests/  # Integration tests

🤝 Contributing

Feel free to submit issues or pull requests. All contributions are welcome and appreciated!

📄 License

This project is licensed under the MIT License.