Skip to content

RateLimiting: add typed builder/guard tests and external limiter lifetime test#2711

Merged
martincostello merged 2 commits intoApp-vNext:mainfrom
mohammed-saalim:tests/ratelimiter-additional-cases
Aug 29, 2025
Merged

RateLimiting: add typed builder/guard tests and external limiter lifetime test#2711
martincostello merged 2 commits intoApp-vNext:mainfrom
mohammed-saalim:tests/ratelimiter-additional-cases

Conversation

@mohammed-saalim
Copy link
Contributor

The issue or feature being addressed

Add small, focused unit tests for RateLimiting to increase coverage. No product code changes.

Details on the issue fix or feature implementation

  • Typed builder:
    • ResiliencePipelineBuilder<int>().AddConcurrencyLimiter(...).Build() produces RateLimiterResilienceStrategy.
  • Guard/validation:
    • Null limiter/options throw ArgumentNullException.
    • Invalid options (null DefaultRateLimiterOptions) throw ValidationException.
  • Lifetime:
    • External RateLimiter passed to .AddRateLimiter(limiter) is NOT disposed when a ResiliencePipelineRegistry is disposed.

Files added

  • test/Polly.RateLimiting.Tests/RateLimiterResiliencePipelineBuilderExtensions_TypedAndNullTests.cs
  • test/Polly.RateLimiting.Tests/RateLimiterExternalLimiterLifetimeTests.cs

Notes

  • No changes to product code or central package versions.
  • All target frameworks passed locally (net9.0, net8.0, net481).

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

@martincostello
Copy link
Member

What missing coverage is this change adding exactly? The code coverage score is 100% for the library and it also has a mutation score of 100.

Those number suggest there's no missing tests.

@mohammed-saalim
Copy link
Contributor Author

@martincostello Thanks for the review! You’re right that coverage and mutation scores are already 100%. These tests aren’t to raise the percentage, but to lock in a few behavioral contracts:
External limiter lifetime: when a user passes a limiter into AddRateLimiter(limiter), disposing a ResiliencePipelineRegistry should not dispose that external limiter. This scenario wasn’t explicitly covered.
Typed builder wiring: ResiliencePipelineBuilder().AddConcurrencyLimiter(...) composes a RateLimiterResilienceStrategy for typed pipelines. This typed path wasn’t asserted.
Null-argument guards: explicit ArgumentNullException checks for the builder extension overloads (minor clarity; I can drop if you prefer).
If you’d like, I can fold these into the existing RateLimiterResiliencePipelineBuilderExtensionsTests and remove anything you consider redundant. Happy to keep only the external-limiter lifetime and typed-builder wiring tests if that’s your preference.

@mohammed-saalim
Copy link
Contributor Author

Moved the tests into RateLimiterResiliencePipelineBuilderExtensionsTests.cs as requested and removed the two standalone files. All TFMs pass locally (net9.0, net8.0, net481). Ready for another look. See PR #2711. @martincostello

@codecov
Copy link

codecov bot commented Aug 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.12%. Comparing base (f52f37f) to head (476818d).
⚠️ Report is 26 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2711      +/-   ##
==========================================
- Coverage   96.23%   96.12%   -0.11%     
==========================================
  Files         311      309       -2     
  Lines        7322     7118     -204     
  Branches     1012     1008       -4     
==========================================
- Hits         7046     6842     -204     
  Misses        222      222              
  Partials       54       54              
Flag Coverage Δ
linux 96.12% <ø> (-0.11%) ⬇️
macos 96.12% <ø> (-0.11%) ⬇️
windows 96.11% <ø> (-0.11%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@martincostello martincostello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@martincostello martincostello merged commit 8ba1e3b into App-vNext:main Aug 29, 2025
26 of 27 checks passed
This was referenced Sep 26, 2025
PhilipWoulfe pushed a commit to PhilipWoulfe/F1Competition that referenced this pull request Mar 2, 2026
[//]: # (dependabot-start)
⚠️  **Dependabot is rebasing this PR** ⚠️ 

Rebasing might not happen immediately, so don't worry if this takes some
time.

Note: if you make any changes to this PR yourself, they will take
precedence over the rebase.

---

[//]: # (dependabot-end)

Updated [Polly](https://github.com/App-vNext/Polly) from 8.5.2 to 8.6.5.

<details>
<summary>Release notes</summary>

_Sourced from [Polly's
releases](https://github.com/App-vNext/Polly/releases)._

## 8.6.5

## What's Changed

* Extend NuGet package validation by @​martincostello in
App-vNext/Polly#2762
* Suppress S2094 warning by @​martincostello in
App-vNext/Polly#2765
* Refactor cake script by @​martincostello in
App-vNext/Polly#2769
* Pass timeout to `TimeoutRejectedException` by @​martincostello in
App-vNext/Polly#2827

**Full Changelog**:
App-vNext/Polly@8.6.4...8.6.5


## 8.6.4

## What's Changed

* Fix after-release and update CHANGELOG by @​martincostello in
App-vNext/Polly#2714
* Use collection expressions by @​martincostello in
App-vNext/Polly#2715
* Fix flaky mutants by @​martincostello in
App-vNext/Polly#2717
* fix documentation for ExecuteOutcomeAsync by @​carvex21 in
App-vNext/Polly#2710
* Bump MartinCostello.WaitForNuGetPackage by @​martincostello in
App-vNext/Polly#2721
* Bump sign tool by @​martincostello in
App-vNext/Polly#2722
* xunit v3 preparation by @​martincostello in
App-vNext/Polly#2723
* Add summary NuGet badges by @​martincostello in
App-vNext/Polly#2724
* Delete actionlint config by @​martincostello in
App-vNext/Polly#2730
* RateLimiting: add typed builder/guard tests and external limiter
lifetime test by @​mohammed-saalim in
App-vNext/Polly#2711
* Update Dependabot auto-merge conditions by @​martincostello in
App-vNext/Polly#2736
* Bump NuGet packages by @​martincostello in
App-vNext/Polly#2738
* Bump dotnet-stryker to 4.8.1 by @​martincostello in
App-vNext/Polly#2739
* Simplify code by @​martincostello in
App-vNext/Polly#2740
* Update zizmor by @​martincostello in
App-vNext/Polly#2746
* Use NuGet Trusted Publishing by @​martincostello in
App-vNext/Polly#2751
* Respect override for PipelineExecuting and PipelineExecuted by
@​peter-csala in App-vNext/Polly#2752

## New Contributors

* @​carvex21 made their first contribution in
App-vNext/Polly#2710
* @​mohammed-saalim made their first contribution in
App-vNext/Polly#2711

**Full Changelog**:
App-vNext/Polly@8.6.3...8.6.4


## 8.6.3

## What's Changed

* Add release notes configuration by @​martincostello in
App-vNext/Polly#2678
* Simplify release workflow by @​martincostello in
App-vNext/Polly#2679
* Sign-off commits by @​martincostello in
App-vNext/Polly#2694
* Add GitHub sponsorship by @​martincostello in
App-vNext/Polly#2695
* Refactor project dependencies by @​martincostello in
App-vNext/Polly#2696
* Add zizmor by @​martincostello in
App-vNext/Polly#2698
* Update benchmarks by @​martincostello in
App-vNext/Polly#2712
* Reduce async overhead by @​pentp in
App-vNext/Polly#2664
* Update benchmarks by @​martincostello in
App-vNext/Polly#2713

## New Contributors

* @​pentp made their first contribution in
App-vNext/Polly#2664

**Full Changelog**:
App-vNext/Polly@8.6.2...8.6.3


## 8.6.2

## What's Changed

* Performance tweaks by @​martincostello in
App-vNext/Polly#2667
* Update dependencies by @​martincostello in
App-vNext/Polly#2668
* Update benchmark results by @​martincostello in
App-vNext/Polly#2669

## New Contributors

* @​pentp made their first contribution in
App-vNext/Polly#2667

**Full Changelog**:
App-vNext/Polly@8.6.1...8.6.2


## 8.6.1

## What's Changed

* Fix integer overflow in `BulkheadSemaphoreFactory` by @​ahusseini in
App-vNext/Polly#2638
* Generate SBOM by @​martincostello in
App-vNext/Polly#2640
* Attest artifacts by @​martincostello in
App-vNext/Polly#2647

## New Contributors

* @​ahusseini made their first contribution in
App-vNext/Polly#2638

**Full Changelog**:
App-vNext/Polly@8.6.0...8.6.1

## 8.6.0

## What's Changed

* Bump Stryker by @​martincostello in
App-vNext/Polly#2476
* Fix chaos example issue and enrich notes & diagram by @​caigen in
App-vNext/Polly#2482
* Add diagram for the main chaos page sample by @​peter-csala in
App-vNext/Polly#2484
* Fix broken CI by @​martincostello in
App-vNext/Polly#2497
* Remove .NET 6 SDK by @​martincostello in
App-vNext/Polly#2501
* Use Stryker Mutator Dashboard by @​martincostello in
App-vNext/Polly#2500
* Fix Polly.Testing mutations by @​martincostello in
App-vNext/Polly#2503
* Lint PowerShell scripts by @​martincostello in
App-vNext/Polly#2504
* Improve Polly coverage by @​martincostello in
App-vNext/Polly#2505
* Improve mutation score by @​martincostello in
App-vNext/Polly#2506
* Run CodeQL for GitHub Actions by @​martincostello in
App-vNext/Polly#2498
* Add missing mutations by @​martincostello in
App-vNext/Polly#2508
* Remove dotnet tool restore by @​martincostello in
App-vNext/Polly#2513
* Add missing coverage by @​martincostello in
App-vNext/Polly#2514
* Improve mutation test perf by @​slang25 in
App-vNext/Polly#2520
* Improve coverage by @​martincostello in
App-vNext/Polly#2526
* Remove System.Text.Json reference by @​martincostello in
App-vNext/Polly#2532
* Fix test summary reliability by @​martincostello in
App-vNext/Polly#2543
* Use AuthenticodeLint by @​martincostello in
App-vNext/Polly#2553
* Use actions/create-github-app-token by @​martincostello in
App-vNext/Polly#2572
* Fix Retry strategy ShouldHandle in example code by @​marcrocny in
App-vNext/Polly#2527
* Tweak docs formatting by @​martincostello in
App-vNext/Polly#2575
* Dispose registry which contains rate limiters by @​peter-csala in
App-vNext/Polly#2578
* Improve mutation tests performance by ensuring solution file isn't
discovered by @​slang25 in App-vNext/Polly#2589
* Update LICENSE metadata by @​martincostello in
App-vNext/Polly#2590
* Add HTTP client integration samples by @​peter-csala in
App-vNext/Polly#2587
* Dedupe links by @​martincostello in
App-vNext/Polly#2592
* Add test analytics by @​martincostello in
App-vNext/Polly#2593
* Add note about context/state mix-ups by @​martincostello in
App-vNext/Polly#2598
* Emit annotation for packages by @​martincostello in
App-vNext/Polly#2601
* Add `AttemptNumber` to `HedgingPredicateArguments` by @​peter-csala in
App-vNext/Polly#2603
* .NET 10 preparation by @​martincostello in
App-vNext/Polly#2620
* Migrate to slnx by @​martincostello in
App-vNext/Polly#2623
* Fix `OnRetryArguments` comments by @​lchaoer in
App-vNext/Polly#2627
* Fix package signing by @​martincostello in
App-vNext/Polly#2631

## New Contributors

* @​caigen made their first contribution in
App-vNext/Polly#2482
* @​slang25 made their first contribution in
App-vNext/Polly#2520
* @​marcrocny made their first contribution in
App-vNext/Polly#2527
* @​lchaoer made their first contribution in
App-vNext/Polly#2627

**Full Changelog**:
App-vNext/Polly@8.5.2...8.6.0

Commits viewable in [compare
view](App-vNext/Polly@8.5.2...8.6.5).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Polly&package-manager=nuget&previous-version=8.5.2&new-version=8.6.5)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants