Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrennanConroy merged 2 commits into from
Sep 26, 2022
Merged

Disallow TimeSpan.Zero in rate limiters #75496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc6dedc
Disallow TimeSpan.Zero in rate limiters
BrennanConroy Sep 13, 2022
22b71fd
fb
BrennanConroy Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
<data name="ReplenishmentLimitTooHigh" xml:space="preserve">
<value>Over 49 days is not supported.</value>
</data>
<data name="ShouldBeGreaterThan0" xml:space="preserve">
<value>{0} must be set to a value greater than 0.</value>
</data>
<data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
<value>{0} must be set to a value greater than or equal to 0.</value>
</data>
<data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
<value>{0} must be set to a value greater than TimeSpan.Zero.</value>
</data>
</root>
4 changes: 2 additions & 2 deletions ...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
}
if (options.PermitLimit <= 0)
{
throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
}
if (options.QueueLimit < 0)
{
throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
}

_options = new ConcurrencyLimiterOptions
Expand Down
8 changes: 4 additions & 4 deletions ...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
}
if (options.PermitLimit <= 0)
{
throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
}
if (options.QueueLimit < 0)
{
throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
}
if (options.Window < TimeSpan.Zero)
if (options.Window <= TimeSpan.Zero)
{
throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
}

_options = new FixedWindowRateLimiterOptions
Expand Down
3 changes: 1 addition & 2 deletions ...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
{
/// <summary>
/// Specifies the time window that takes in the requests.
/// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
/// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
/// </summary>
/// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
public TimeSpan Window { get; set; } = TimeSpan.Zero;

/// <summary>
Expand Down
14 changes: 9 additions & 5 deletions ...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
{
throw new ArgumentNullException(nameof(options));
}
if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
if (options.PermitLimit <= 0)
{
throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
}
if (options.SegmentsPerWindow <= 0)
{
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
}
if (options.QueueLimit < 0)
{
throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
}
if (options.Window < TimeSpan.Zero)
if (options.Window <= TimeSpan.Zero)
{
throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
}

_options = new SlidingWindowRateLimiterOptions
Expand Down
3 changes: 1 addition & 2 deletions ...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
{
/// <summary>
/// Specifies the minimum period between replenishments.
/// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
/// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
/// </summary>
/// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
public TimeSpan Window { get; set; } = TimeSpan.Zero;

/// <summary>
Expand Down
14 changes: 9 additions & 5 deletions ...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
{
throw new ArgumentNullException(nameof(options));
}
if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
if (options.TokenLimit <= 0)
{
throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
}
if (options.TokensPerPeriod <= 0)
{
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
}
if (options.QueueLimit < 0)
{
throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
}
if (options.ReplenishmentPeriod < TimeSpan.Zero)
if (options.ReplenishmentPeriod <= TimeSpan.Zero)
{
throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
}

_options = new TokenBucketRateLimiterOptions
Expand Down
3 changes: 1 addition & 2 deletions ...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
{
/// <summary>
/// Specifies the minimum period between replenishments.
/// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
/// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
/// </summary>
/// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
[Fact]
public override void InvalidOptionsThrows()
{
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
{
PermitLimit = -1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1
}));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down
17 changes: 13 additions & 4 deletions src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
[Fact]
public override void InvalidOptionsThrows()
{
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
Window = TimeSpan.FromMinutes(2),
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
Window = TimeSpan.FromMinutes(2),
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
Window = TimeSpan.MinValue,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
Window = TimeSpan.FromMinutes(-2),
AutoReplenishment = false,
}));
AssertExtensions.Throws<ArgumentException>("options",
() => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false,
}));
}

[Fact]
Expand Down
20 changes: 15 additions & 5 deletions src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
[Fact]
public override void InvalidOptionsThrows()
{
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
SegmentsPerWindow = 1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
SegmentsPerWindow = 1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
SegmentsPerWindow = -1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
SegmentsPerWindow = 1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
SegmentsPerWindow = 1,
AutoReplenishment = false
}));
AssertExtensions.Throws<ArgumentException>("options",
() => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 1,
AutoReplenishment = false
}));
}

[Fact]
Expand Down
20 changes: 15 additions & 5 deletions src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
[Fact]
public override void InvalidOptionsThrows()
{
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
{
TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
TokensPerPeriod = 1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
{
TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
TokensPerPeriod = 1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
{
TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
TokensPerPeriod = -1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
{
TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
TokensPerPeriod = 1,
AutoReplenishment = false
}));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
() => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
{
TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
TokensPerPeriod = 1,
AutoReplenishment = false
}));
AssertExtensions.Throws<ArgumentException>("options",
() => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
{
TokenLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
ReplenishmentPeriod = TimeSpan.Zero,
TokensPerPeriod = 1,
AutoReplenishment = false
}));
}

[Fact]
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Disallow TimeSpan.Zero in rate limiters#75496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BrennanConroy
merged 2 commits into

from

Sep 26, 2022
 Merged


Disallow TimeSpan.Zero in rate limiters
#75496
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dc6dedc

Disallow TimeSpan.Zero in rate limiters


BrennanConroy Sep 13, 2022
22b71fd

fb


BrennanConroy Sep 22, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
src/libraries/System.Threading.RateLimiting/src/Resources/Strings.resx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,4 +126,13 @@
 <data name="ReplenishmentLimitTooHigh" xml:space="preserve">
 <value>Over 49 days is not supported.</value>
 </data>
 <data name="ShouldBeGreaterThan0" xml:space="preserve">
 <value>{0} must be set to a value greater than 0.</value>
 </data>
 <data name="ShouldBeGreaterThanOrEqual0" xml:space="preserve">
 <value>{0} must be set to a value greater than or equal to 0.</value>
 </data>
 <data name="ShouldBeGreaterThanTimeSpan0" xml:space="preserve">
 <value>{0} must be set to a value greater than TimeSpan.Zero.</value>
 </data>
</root>

4 changes: 2 additions & 2 deletions
...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,11 +47,11 @@ public ConcurrencyLimiter(ConcurrencyLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }

 _options = new ConcurrencyLimiterOptions
Expand Down

8 changes: 4 additions & 4 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,15 +53,15 @@ public FixedWindowRateLimiter(FixedWindowRateLimiterOptions options)
 }
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"{nameof(options.PermitLimit)} must be set to a value greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new FixedWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class FixedWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the time window that takes in the requests.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="FixedWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,17 +55,21 @@ public SlidingWindowRateLimiter(SlidingWindowRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.PermitLimit <= 0 || options.SegmentsPerWindow <= 0)
 if (options.PermitLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.PermitLimit)} and {nameof(options.SegmentsPerWindow)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.PermitLimit)), nameof(options));
 }
 if (options.SegmentsPerWindow <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.SegmentsPerWindow)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.Window < TimeSpan.Zero)
 if (options.Window <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.Window)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.Window)), nameof(options));
 }

 _options = new SlidingWindowRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...reading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class SlidingWindowRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="SlidingWindowRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan Window { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

14 changes: 9 additions & 5 deletions
...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,17 +53,21 @@ public TokenBucketRateLimiter(TokenBucketRateLimiterOptions options)
 {
 throw new ArgumentNullException(nameof(options));
 }
 if (options.TokenLimit <= 0 || options.TokensPerPeriod <= 0)
 if (options.TokenLimit <= 0)
 {
 throw new ArgumentException($"Both {nameof(options.TokenLimit)} and {nameof(options.TokensPerPeriod)} must be set to values greater than 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokenLimit)), nameof(options));
 }
 if (options.TokensPerPeriod <= 0)
 {
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThan0, nameof(options.TokensPerPeriod)), nameof(options));
 }
 if (options.QueueLimit < 0)
 {
 throw new ArgumentException($"{nameof(options.QueueLimit)} must be set to a value greater than or equal to 0.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanOrEqual0, nameof(options.QueueLimit)), nameof(options));
 }
 if (options.ReplenishmentPeriod < TimeSpan.Zero)
 if (options.ReplenishmentPeriod <= TimeSpan.Zero)
 {
 throw new ArgumentException($"{nameof(options.ReplenishmentPeriod)} must be set to a value greater than or equal to TimeSpan.Zero.", nameof(options));
 throw new ArgumentException(SR.Format(SR.ShouldBeGreaterThanTimeSpan0, nameof(options.ReplenishmentPeriod)), nameof(options));
 }

 _options = new TokenBucketRateLimiterOptions
Expand Down

3 changes: 1 addition & 2 deletions
...Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiterOptions.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,8 @@ public sealed class TokenBucketRateLimiterOptions
 {
 /// <summary>
 /// Specifies the minimum period between replenishments.
 /// Must be set to a value >= <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// Must be set to a value greater than <see cref="TimeSpan.Zero" /> by the time these options are passed to the constructor of <see cref="TokenBucketRateLimiter"/>.
 /// </summary>
 /// <remarks><see cref="TimeSpan.Zero"/> means the limiter will never replenish.</remarks>
 public TimeSpan ReplenishmentPeriod { get; set; } = TimeSpan.Zero;

 /// <summary>
Expand Down

4 changes: 2 additions & 2 deletions
src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,13 @@ public class ConcurrencyLimiterTests : BaseRateLimiterTests
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = -1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1
 }));
Assert.Throws<ArgumentException>(() => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
AssertExtensions.Throws<ArgumentException>("options", () => new ConcurrencyLimiter(new ConcurrencyLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
Expand Down

17 changes: 13 additions & 4 deletions
src/libraries/System.Threading.RateLimiting/tests/FixedWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -44,7 +44,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -53,7 +53,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(2),
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -62,7 +62,7 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.MinValue,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -71,6 +71,15 @@ public override void InvalidOptionsThrows()
 Window = TimeSpan.FromMinutes(-2),
 AutoReplenishment = false,
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 AutoReplenishment = false,
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/SlidingWindowRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
 {
 PermitLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 Window = TimeSpan.Zero,
 SegmentsPerWindow = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down

20 changes: 15 additions & 5 deletions
src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ public override void CanAcquireResource()
 [Fact]
 public override void InvalidOptionsThrows()
 {
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = -1,
Expand All@@ -47,7 +47,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -57,7 +57,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -67,7 +67,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = -1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -77,7 +77,7 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
Assert.Throws<ArgumentException>(
AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
Expand All@@ -87,6 +87,16 @@ public override void InvalidOptionsThrows()
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 AssertExtensions.Throws<ArgumentException>("options",
 () => new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions
 {
 TokenLimit = 1,
 QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
 QueueLimit = 1,
 ReplenishmentPeriod = TimeSpan.Zero,
 TokensPerPeriod = 1,
 AutoReplenishment = false
 }));
 }

 [Fact]
Expand Down