Skip to content

[RateLimiting] Dequeue items when queuing with NewestFirst #63377

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 3 commits into from
Jan 19, 2022
Merged

[RateLimiting] Dequeue items when queuing with NewestFirst #63377

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d942fc
[RateLimiting] Dequeue items when queuing with NewestFirst
BrennanConroy Jan 4, 2022
a28e8cf
feedback
BrennanConroy Jan 12, 2022
ec09b15
int overflow
BrennanConroy Jan 18, 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
17 changes: 16 additions & 1 deletion ...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,22 @@ protected override ValueTask<RateLimitLease> WaitAsyncCore(int permitCount, Canc
// Don't queue if queue limit reached
if (_queueCount + permitCount > _options.QueueLimit)
{
return new ValueTask<RateLimitLease>(QueueLimitLease);
if (_options.QueueProcessingOrder == QueueProcessingOrder.NewestFirst)
{
// remove oldest items from queue until there is space for the newest request
do
{
RequestRegistration oldestRequest = _queue.DequeueHead();
_queueCount -= oldestRequest.Count;
Debug.Assert(_queueCount >= 0);
oldestRequest.Tcs.TrySetResult(FailedLease);
}
while (_queueCount + permitCount > _options.QueueLimit);
}
else
{
return new ValueTask<RateLimitLease>(QueueLimitLease);
}
}

TaskCompletionSource<RateLimitLease> tcs = new TaskCompletionSource<RateLimitLease>(TaskCreationOptions.RunContinuationsAsynchronously);
Expand Down
17 changes: 16 additions & 1 deletion ...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,22 @@ protected override ValueTask<RateLimitLease> WaitAsyncCore(int tokenCount, Cance
// Don't queue if queue limit reached
if (_queueCount + tokenCount > _options.QueueLimit)
{
return new ValueTask<RateLimitLease>(CreateFailedTokenLease(tokenCount));
if (_options.QueueProcessingOrder == QueueProcessingOrder.NewestFirst)
{
// remove oldest items from queue until there is space for the newest acquisition request
do
{
RequestRegistration oldestRequest = _queue.DequeueHead();
_queueCount -= oldestRequest.Count;
Debug.Assert(_queueCount >= 0);
oldestRequest.Tcs.TrySetResult(FailedLease);
}
while (_queueCount + tokenCount > _options.QueueLimit);
}
else
{
return new ValueTask<RateLimitLease>(CreateFailedTokenLease(tokenCount));
}
}

TaskCompletionSource<RateLimitLease> tcs = new TaskCompletionSource<RateLimitLease>(TaskCreationOptions.RunContinuationsAsynchronously);
Expand Down
8 changes: 7 additions & 1 deletion src/libraries/System.Threading.RateLimiting/tests/BaseRateLimiterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,13 @@ public abstract class BaseRateLimiterTests
public abstract Task CanAcquireResourceAsync_QueuesAndGrabsNewest();

[Fact]
public abstract Task FailsWhenQueuingMoreThanLimit();
public abstract Task FailsWhenQueuingMoreThanLimit_OldestFirst();

[Fact]
public abstract Task DropsOldestWhenQueuingMoreThanLimit_NewestFirst();

[Fact]
public abstract Task DropsMultipleOldestWhenQueuingMoreThanLimit_NewestFirst();

[Fact]
public abstract Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable();
Expand Down
50 changes: 47 additions & 3 deletions src/libraries/System.Threading.RateLimiting/tests/ConcurrencyLimiterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ public override async Task CanAcquireResourceAsync_QueuesAndGrabsNewest()
}

[Fact]
public override async Task FailsWhenQueuingMoreThanLimit()
public override async Task FailsWhenQueuingMoreThanLimit_OldestFirst()
{
var limiter = new ConcurrencyLimiter(new ConcurrencyLimiterOptions(1, QueueProcessingOrder.NewestFirst, 1));
var limiter = new ConcurrencyLimiter(new ConcurrencyLimiterOptions(1, QueueProcessingOrder.OldestFirst, 1));
using var lease = limiter.Acquire(1);
var wait = limiter.WaitAsync(1);

Expand All @@ -105,11 +105,55 @@ public override async Task FailsWhenQueuingMoreThanLimit()
}

[Fact]
public override async Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable()
public override async Task DropsOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new ConcurrencyLimiter(new ConcurrencyLimiterOptions(1, QueueProcessingOrder.NewestFirst, 1));
var lease = limiter.Acquire(1);
var wait = limiter.WaitAsync(1);
Assert.False(wait.IsCompleted);

var wait2 = limiter.WaitAsync(1);
var lease1 = await wait;
Assert.False(lease1.IsAcquired);
Assert.False(wait2.IsCompleted);

lease.Dispose();

lease = await wait2;
Assert.True(lease.IsAcquired);
}

[Fact]
public override async Task DropsMultipleOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new ConcurrencyLimiter(new ConcurrencyLimiterOptions(2, QueueProcessingOrder.NewestFirst, 2));
var lease = limiter.Acquire(2);
Assert.True(lease.IsAcquired);
var wait = limiter.WaitAsync(1);
Assert.False(wait.IsCompleted);

var wait2 = limiter.WaitAsync(1);
Assert.False(wait2.IsCompleted);

var wait3 = limiter.WaitAsync(2);
var lease1 = await wait;
var lease2 = await wait2;
Assert.False(lease1.IsAcquired);
Assert.False(lease2.IsAcquired);
Assert.False(wait3.IsCompleted);

lease.Dispose();

lease = await wait3;
Assert.True(lease.IsAcquired);
}

[Fact]
public override async Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable()
{
var limiter = new ConcurrencyLimiter(new ConcurrencyLimiterOptions(1, QueueProcessingOrder.OldestFirst, 1));
var lease = limiter.Acquire(1);
var wait = limiter.WaitAsync(1);

var failedLease = await limiter.WaitAsync(1);
Assert.False(failedLease.IsAcquired);
Expand Down
53 changes: 50 additions & 3 deletions src/libraries/System.Threading.RateLimiting/tests/TokenBucketRateLimiterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ public override async Task CanAcquireResourceAsync_QueuesAndGrabsNewest()
}

[Fact]
public override async Task FailsWhenQueuingMoreThanLimit()
public override async Task FailsWhenQueuingMoreThanLimit_OldestFirst()
{
var limiter = new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions(1, QueueProcessingOrder.NewestFirst, 1,
var limiter = new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 1,
TimeSpan.Zero, 1, autoReplenishment: false));
using var lease = limiter.Acquire(1);
var wait = limiter.WaitAsync(1);
Expand All @@ -125,9 +125,56 @@ public override async Task FailsWhenQueuingMoreThanLimit()
}

[Fact]
public override async Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable()
public override async Task DropsOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions(1, QueueProcessingOrder.NewestFirst, 1,
TimeSpan.Zero, 1, autoReplenishment: false));
var lease = limiter.Acquire(1);
var wait = limiter.WaitAsync(1);
Assert.False(wait.IsCompleted);

var wait2 = limiter.WaitAsync(1);
var lease1 = await wait;
Assert.False(lease1.IsAcquired);
Assert.False(wait2.IsCompleted);

limiter.TryReplenish();

lease = await wait2;
Assert.True(lease.IsAcquired);
}

[Fact]
public override async Task DropsMultipleOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions(2, QueueProcessingOrder.NewestFirst, 2,
TimeSpan.Zero, 1, autoReplenishment: false));
var lease = limiter.Acquire(2);
Assert.True(lease.IsAcquired);
var wait = limiter.WaitAsync(1);
Assert.False(wait.IsCompleted);

var wait2 = limiter.WaitAsync(1);
Assert.False(wait2.IsCompleted);

var wait3 = limiter.WaitAsync(2);
var lease1 = await wait;
var lease2 = await wait2;
Assert.False(lease1.IsAcquired);
Assert.False(lease2.IsAcquired);
Assert.False(wait3.IsCompleted);

limiter.TryReplenish();
limiter.TryReplenish();

lease = await wait3;
Assert.True(lease.IsAcquired);
}

[Fact]
public override async Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable()
{
var limiter = new TokenBucketRateLimiter(new TokenBucketRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 1,
TimeSpan.Zero, 1, autoReplenishment: false));
var lease = limiter.Acquire(1);
var wait = limiter.WaitAsync(1);
Expand Down