public override async Task DropsRequestedLeaseIfPermitCountGreaterThanQueueLimitAndNoAvailability_NewestFirst()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(2);
Assert.True(lease.IsAcquired);
// Fill queue
var wait = limiter.AcquireAsync(1);
Assert.False(wait.IsCompleted);
var lease1 = await limiter.AcquireAsync(2);
Assert.False(lease1.IsAcquired);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
var wait = limiter.AcquireAsync(1);
var failedLease = await limiter.AcquireAsync(1);
Assert.False(failedLease.IsAcquired);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
wait = limiter.AcquireAsync(1);
Assert.False(wait.IsCompleted);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task DropsOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
var wait = limiter.AcquireAsync(1);
Assert.False(wait.IsCompleted);
var wait2 = limiter.AcquireAsync(1);
var lease1 = await wait;
Assert.False(lease1.IsAcquired);
Assert.False(wait2.IsCompleted);
limiter.TryReplenish();
lease = await wait2;
Assert.True(lease.IsAcquired);
}
public override async Task LargeAcquiresAndQueuesDoNotIntegerOverflow()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(int.MaxValue, QueueProcessingOrder.NewestFirst, int.MaxValue,
TimeSpan.Zero, autoReplenishment: false));
var lease = limiter.Acquire(int.MaxValue);
Assert.True(lease.IsAcquired);
// Fill queue
var wait = limiter.WaitAsync(3);
Assert.False(wait.IsCompleted);
var wait2 = limiter.WaitAsync(int.MaxValue);
Assert.False(wait2.IsCompleted);
var lease1 = await wait;
Assert.False(lease1.IsAcquired);
limiter.TryReplenish();
var lease2 = await wait2;
Assert.True(lease2.IsAcquired);
}
public override async Task CanAcquireResourceAsync_QueuesAndGrabsNewest()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(2, QueueProcessingOrder.NewestFirst, 3,
TimeSpan.FromMinutes(0), autoReplenishment: false));
var lease = await limiter.WaitAsync(2);
Assert.True(lease.IsAcquired);
var wait1 = limiter.WaitAsync(2);
var wait2 = limiter.WaitAsync();
Assert.False(wait1.IsCompleted);
Assert.False(wait2.IsCompleted);
lease.Dispose();
Assert.True(limiter.TryReplenish());
// second queued item completes first with NewestFirst
lease = await wait2;
Assert.True(lease.IsAcquired);
Assert.False(wait1.IsCompleted);
lease.Dispose();
Assert.Equal(1, limiter.GetAvailablePermits());
Assert.True(limiter.TryReplenish());
lease = await wait1;
Assert.True(lease.IsAcquired);
}
public override void ThrowsWhenAcquiringLessThanZero()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.NewestFirst, 1,
TimeSpan.Zero, autoReplenishment: false));
Assert.Throws <ArgumentOutOfRangeException>(() => limiter.Acquire(-1));
}
public override async Task CannotAcquireResourcesWithWaitAsyncWithQueuedItemsIfOldestFirst()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(2, QueueProcessingOrder.OldestFirst, 3,
TimeSpan.Zero, autoReplenishment: false));
var lease = limiter.Acquire(1);
Assert.True(lease.IsAcquired);
var wait = limiter.WaitAsync(2);
var wait2 = limiter.WaitAsync(1);
Assert.False(wait.IsCompleted);
Assert.False(wait2.IsCompleted);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
Assert.False(wait2.IsCompleted);
limiter.TryReplenish();
lease = await wait2;
Assert.True(lease.IsAcquired);
}
public override async Task GetStatisticsWithZeroPermitCount()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 100,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 50,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(0);
Assert.True(lease.IsAcquired);
Assert.Equal(1, limiter.GetStatistics().TotalSuccessfulLeases);
Assert.Equal(100, limiter.GetStatistics().CurrentAvailablePermits);
lease = await limiter.AcquireAsync(0);
Assert.True(lease.IsAcquired);
Assert.Equal(2, limiter.GetStatistics().TotalSuccessfulLeases);
Assert.Equal(100, limiter.GetStatistics().CurrentAvailablePermits);
lease = limiter.AttemptAcquire(100);
Assert.True(lease.IsAcquired);
Assert.Equal(3, limiter.GetStatistics().TotalSuccessfulLeases);
Assert.Equal(0, limiter.GetStatistics().CurrentAvailablePermits);
var lease2 = limiter.AttemptAcquire(0);
Assert.False(lease2.IsAcquired);
Assert.Equal(3, limiter.GetStatistics().TotalSuccessfulLeases);
Assert.Equal(1, limiter.GetStatistics().TotalFailedLeases);
Assert.Equal(0, limiter.GetStatistics().CurrentAvailablePermits);
}
public override async Task CannotAcquireResourcesWithAcquireWithQueuedItemsIfOldestFirst()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 3,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
Assert.True(lease.IsAcquired);
var wait = limiter.AcquireAsync(2);
Assert.False(wait.IsCompleted);
lease = limiter.AttemptAcquire(1);
Assert.False(lease.IsAcquired);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public void ReplenishingRateLimiterPropertiesHaveCorrectValues()
{
var replenishPeriod = TimeSpan.FromMinutes(1);
using ReplenishingRateLimiter limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = replenishPeriod,
AutoReplenishment = true
});
Assert.True(limiter.IsAutoReplenishing);
Assert.Equal(replenishPeriod, limiter.ReplenishmentPeriod);
replenishPeriod = TimeSpan.FromSeconds(2);
using ReplenishingRateLimiter limiter2 = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = replenishPeriod,
AutoReplenishment = false
});
Assert.False(limiter2.IsAutoReplenishing);
Assert.Equal(replenishPeriod, limiter2.ReplenishmentPeriod);
}
public override async Task CanAcquireResourcesWithAcquireAsyncWithQueuedItemsIfNewestFirst()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
Assert.True(lease.IsAcquired);
var wait = limiter.AcquireAsync(2);
Assert.False(wait.IsCompleted);
Assert.Equal(1, limiter.GetStatistics().CurrentAvailablePermits);
lease = await limiter.AcquireAsync(1);
Assert.True(lease.IsAcquired);
Assert.False(wait.IsCompleted);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task CanAcquireResourceAsync_QueuesAndGrabsOldest()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = await limiter.AcquireAsync();
Assert.True(lease.IsAcquired);
var wait1 = limiter.AcquireAsync();
var wait2 = limiter.AcquireAsync();
Assert.False(wait1.IsCompleted);
Assert.False(wait2.IsCompleted);
lease.Dispose();
Assert.True(limiter.TryReplenish());
lease = await wait1;
Assert.True(lease.IsAcquired);
Assert.False(wait2.IsCompleted);
lease.Dispose();
Assert.Equal(0, limiter.GetStatistics().CurrentAvailablePermits);
Assert.True(limiter.TryReplenish());
lease = await wait2;
Assert.True(lease.IsAcquired);
}
public async Task RetryMetadataOnFailedWaitAsync()
{
var options = new FixedWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.FromSeconds(20),
AutoReplenishment = false
};
var limiter = new FixedWindowRateLimiter(options);
using var lease = limiter.AttemptAcquire(2);
var failedLease = await limiter.AcquireAsync(2);
Assert.False(failedLease.IsAcquired);
Assert.True(failedLease.TryGetMetadata(MetadataName.RetryAfter.Name, out var metadata));
var metaDataTime = Assert.IsType <TimeSpan>(metadata);
Assert.Equal(options.Window.Ticks, metaDataTime.Ticks);
Assert.True(failedLease.TryGetMetadata(MetadataName.RetryAfter, out var typedMetadata));
Assert.Equal(options.Window.Ticks, typedMetadata.Ticks);
Assert.Collection(failedLease.MetadataNames, item => item.Equals(MetadataName.RetryAfter.Name));
}
public override async Task CancelUpdatesQueueLimit()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
Assert.True(lease.IsAcquired);
var cts = new CancellationTokenSource();
var wait = limiter.AcquireAsync(1, cts.Token);
cts.Cancel();
var ex = await Assert.ThrowsAsync <TaskCanceledException>(() => wait.AsTask());
Assert.Equal(cts.Token, ex.CancellationToken);
wait = limiter.AcquireAsync(1);
Assert.False(wait.IsCompleted);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task CanCancelAcquireAsyncBeforeQueuing()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
Assert.True(lease.IsAcquired);
var cts = new CancellationTokenSource();
cts.Cancel();
var ex = await Assert.ThrowsAsync <TaskCanceledException>(() => limiter.AcquireAsync(1, cts.Token).AsTask());
Assert.Equal(cts.Token, ex.CancellationToken);
lease.Dispose();
Assert.True(limiter.TryReplenish());
Assert.Equal(1, limiter.GetStatistics().CurrentAvailablePermits);
}
public override async Task CanDequeueMultipleResourcesAtOnce()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
using var lease = await limiter.AcquireAsync(2);
Assert.True(lease.IsAcquired);
var wait1 = limiter.AcquireAsync(1);
var wait2 = limiter.AcquireAsync(1);
Assert.False(wait1.IsCompleted);
Assert.False(wait2.IsCompleted);
lease.Dispose();
Assert.True(limiter.TryReplenish());
var lease1 = await wait1;
var lease2 = await wait2;
Assert.True(lease1.IsAcquired);
Assert.True(lease2.IsAcquired);
}
public override async Task DropsMultipleOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(2, QueueProcessingOrder.NewestFirst, 2,
TimeSpan.Zero, 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();
lease = await wait3;
Assert.True(lease.IsAcquired);
}
public override async Task CanFillQueueWithNewestFirstAfterCancelingQueuedRequestWithAnotherQueuedRequest()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(2, QueueProcessingOrder.NewestFirst, 2,
TimeSpan.Zero, autoReplenishment: false));
var lease = limiter.Acquire(2);
Assert.True(lease.IsAcquired);
var cts = new CancellationTokenSource();
var wait = limiter.WaitAsync(1, cts.Token);
// Add another item to queue, will be completed as failed later when we queue another item
var wait2 = limiter.WaitAsync(1);
Assert.False(wait.IsCompleted);
cts.Cancel();
var ex = await Assert.ThrowsAsync <TaskCanceledException>(() => wait.AsTask());
Assert.Equal(cts.Token, ex.CancellationToken);
lease.Dispose();
var wait3 = limiter.WaitAsync(2);
Assert.False(wait3.IsCompleted);
// will be kicked by wait3 because we're using NewestFirst
lease = await wait2;
Assert.False(lease.IsAcquired);
limiter.TryReplenish();
lease = await wait3;
Assert.True(lease.IsAcquired);
}
public override async Task CanDisposeAfterCancelingQueuedRequest()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
Assert.True(lease.IsAcquired);
var cts = new CancellationTokenSource();
var wait = limiter.AcquireAsync(1, cts.Token);
cts.Cancel();
var ex = await Assert.ThrowsAsync <TaskCanceledException>(() => wait.AsTask());
Assert.Equal(cts.Token, ex.CancellationToken);
// Make sure dispose doesn't have any side-effects when dealing with a canceled queued item
limiter.Dispose();
}
public override async Task CanAcquireResourceAsync_QueuesAndGrabsOldest()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 2,
TimeSpan.Zero, autoReplenishment: false));
var lease = await limiter.WaitAsync();
Assert.True(lease.IsAcquired);
var wait1 = limiter.WaitAsync();
var wait2 = limiter.WaitAsync();
Assert.False(wait1.IsCompleted);
Assert.False(wait2.IsCompleted);
lease.Dispose();
Assert.True(limiter.TryReplenish());
lease = await wait1;
Assert.True(lease.IsAcquired);
Assert.False(wait2.IsCompleted);
lease.Dispose();
Assert.Equal(0, limiter.GetAvailablePermits());
Assert.True(limiter.TryReplenish());
lease = await wait2;
Assert.True(lease.IsAcquired);
}
public override async Task DisposeAsyncReleasesQueuedAcquires()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 3,
TimeSpan.Zero, autoReplenishment: false));
var lease = limiter.Acquire(1);
var wait1 = limiter.WaitAsync(1);
var wait2 = limiter.WaitAsync(1);
var wait3 = limiter.WaitAsync(1);
Assert.False(wait1.IsCompleted);
Assert.False(wait2.IsCompleted);
Assert.False(wait3.IsCompleted);
await limiter.DisposeAsync();
lease = await wait1;
Assert.False(lease.IsAcquired);
lease = await wait2;
Assert.False(lease.IsAcquired);
lease = await wait3;
Assert.False(lease.IsAcquired);
// Throws after disposal
Assert.Throws <ObjectDisposedException>(() => limiter.Acquire(1));
await Assert.ThrowsAsync <ObjectDisposedException>(() => limiter.WaitAsync(1).AsTask());
}
public override void MetadataNamesContainsAllMetadata()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 1,
TimeSpan.Zero, autoReplenishment: false));
using var lease = limiter.Acquire(1);
Assert.Collection(lease.MetadataNames, metadataName => Assert.Equal(metadataName, MetadataName.RetryAfter.Name));
}
public override void NoMetadataOnAcquiredLease()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 1,
TimeSpan.Zero, autoReplenishment: false));
using var lease = limiter.Acquire(1);
Assert.False(lease.TryGetMetadata(MetadataName.RetryAfter, out _));
}
public override void AcquireZero_WithAvailability()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.NewestFirst, 1,
TimeSpan.Zero, autoReplenishment: false));
using var lease = limiter.Acquire(0);
Assert.True(lease.IsAcquired);
}
public override void NullIdleDurationWhenActive()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 2,
TimeSpan.FromMilliseconds(2), autoReplenishment: false));
limiter.Acquire(1);
Assert.Null(limiter.IdleDuration);
}
public void TryReplenishWithAutoReplenish_ReturnsFalse()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(2, QueueProcessingOrder.OldestFirst, 1,
TimeSpan.FromSeconds(1), autoReplenishment: true));
Assert.Equal(2, limiter.GetAvailablePermits());
Assert.False(limiter.TryReplenish());
Assert.Equal(2, limiter.GetAvailablePermits());
}
public override void IdleDurationUpdatesWhenChangingFromActive()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 2,
TimeSpan.Zero, autoReplenishment: false));
limiter.Acquire(1);
limiter.TryReplenish();
Assert.NotNull(limiter.IdleDuration);
}
public override async Task IdleDurationUpdatesWhenIdle()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(1, QueueProcessingOrder.OldestFirst, 2,
TimeSpan.FromMilliseconds(2), autoReplenishment: false));
Assert.NotNull(limiter.IdleDuration);
var previousDuration = limiter.IdleDuration;
await Task.Delay(15);
Assert.True(previousDuration < limiter.IdleDuration);
}
public override async Task ThrowsWhenWaitingForLessThanZero()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
AutoReplenishment = false
});
await Assert.ThrowsAsync <ArgumentOutOfRangeException>(async() => await limiter.AcquireAsync(-1));
}
public async Task AutoReplenish_ReplenishesCounters()
{
var limiter = new FixedWindowRateLimiter(new FixedWindowRateLimiterOptions(2, QueueProcessingOrder.OldestFirst, 1,
TimeSpan.FromMilliseconds(1000), autoReplenishment: true));
Assert.Equal(2, limiter.GetAvailablePermits());
limiter.Acquire(2);
var lease = await limiter.WaitAsync(1);
Assert.True(lease.IsAcquired);
}
