public override async Task GetStatisticsWithZeroPermitCount()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 100,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 50,
Window = TimeSpan.Zero,
SegmentsPerWindow = 3,
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 SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 3,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
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();
Assert.True(limiter.TryReplenish());
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task DisposeAsyncReleasesQueuedAcquires()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 3,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(1);
var wait1 = limiter.AcquireAsync(1);
var wait2 = limiter.AcquireAsync(1);
var wait3 = limiter.AcquireAsync(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.AttemptAcquire(1));
await Assert.ThrowsAsync<ObjectDisposedException>(() => limiter.AcquireAsync(1).AsTask());
}
public override async Task GetStatisticsHasCorrectValues()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 100,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 50,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var stats = limiter.GetStatistics();
Assert.Equal(100, stats.CurrentAvailablePermits);
Assert.Equal(0, stats.CurrentQueuedCount);
Assert.Equal(0, stats.TotalFailedLeases);
Assert.Equal(0, stats.TotalSuccessfulLeases);
var lease1 = limiter.AttemptAcquire(60);
stats = limiter.GetStatistics();
Assert.Equal(40, stats.CurrentAvailablePermits);
Assert.Equal(0, stats.CurrentQueuedCount);
Assert.Equal(0, stats.TotalFailedLeases);
Assert.Equal(1, stats.TotalSuccessfulLeases);
var lease2Task = limiter.AcquireAsync(50);
stats = limiter.GetStatistics();
Assert.Equal(40, stats.CurrentAvailablePermits);
Assert.Equal(50, stats.CurrentQueuedCount);
Assert.Equal(0, stats.TotalFailedLeases);
Assert.Equal(1, stats.TotalSuccessfulLeases);
limiter.TryReplenish();
var lease3 = await limiter.AcquireAsync(1);
Assert.False(lease3.IsAcquired);
stats = limiter.GetStatistics();
Assert.Equal(40, stats.CurrentAvailablePermits);
Assert.Equal(50, stats.CurrentQueuedCount);
Assert.Equal(1, stats.TotalFailedLeases);
Assert.Equal(1, stats.TotalSuccessfulLeases);
var lease4 = limiter.AttemptAcquire(100);
Assert.False(lease4.IsAcquired);
stats = limiter.GetStatistics();
Assert.Equal(40, stats.CurrentAvailablePermits);
Assert.Equal(50, stats.CurrentQueuedCount);
Assert.Equal(2, stats.TotalFailedLeases);
Assert.Equal(1, stats.TotalSuccessfulLeases);
limiter.TryReplenish();
await lease2Task;
stats = limiter.GetStatistics();
Assert.Equal(50, stats.CurrentAvailablePermits);
Assert.Equal(0, stats.CurrentQueuedCount);
Assert.Equal(2, stats.TotalFailedLeases);
Assert.Equal(2, stats.TotalSuccessfulLeases);
}
public override async Task CancelUpdatesQueueLimit()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(2);
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();
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
Assert.Equal(1, limiter.GetStatistics().CurrentAvailablePermits);
}
public override async Task CanAcquireResourcesWithAcquireAsyncWithQueuedItemsIfNewestFirst()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
SegmentsPerWindow = 3,
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();
Assert.True(limiter.TryReplenish());
Assert.False(wait.IsCompleted);
Assert.True(limiter.TryReplenish());
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task LargeAcquiresAndQueuesDoNotIntegerOverflow()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = int.MaxValue,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = int.MaxValue,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(int.MaxValue);
Assert.True(lease.IsAcquired);
// Fill queue
var wait = limiter.AcquireAsync(3);
Assert.False(wait.IsCompleted);
var wait2 = limiter.AcquireAsync(int.MaxValue);
Assert.False(wait2.IsCompleted);
var lease1 = await wait;
Assert.False(lease1.IsAcquired);
limiter.TryReplenish();
limiter.TryReplenish();
var lease2 = await wait2;
Assert.True(lease2.IsAcquired);
}
public override async Task QueueAvailableAfterQueueLimitHitAndResources_BecomeAvailable()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 3,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
SegmentsPerWindow = 3,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(2);
var wait = limiter.AcquireAsync(2);
var failedLease = await limiter.AcquireAsync(2);
Assert.False(failedLease.IsAcquired);
limiter.TryReplenish();
limiter.TryReplenish();
Assert.False(wait.IsCompleted);
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
wait = limiter.AcquireAsync(2);
Assert.False(wait.IsCompleted);
limiter.TryReplenish();
limiter.TryReplenish();
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task DropsRequestedLeaseIfPermitCountGreaterThanQueueLimitAndNoAvailability_NewestFirst()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
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();
limiter.TryReplenish();
lease = await wait;
Assert.True(lease.IsAcquired);
}
public override async Task DropsMultipleOldestWhenQueuingMoreThanLimit_NewestFirst()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(2);
Assert.True(lease.IsAcquired);
var wait = limiter.AcquireAsync(1);
Assert.False(wait.IsCompleted);
var wait2 = limiter.AcquireAsync(1);
Assert.False(wait2.IsCompleted);
var wait3 = limiter.AcquireAsync(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);
}
public override void AcquireZero_WithoutAvailability()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 1,
AutoReplenishment = false
});
using var lease = limiter.AttemptAcquire(1);
Assert.True(lease.IsAcquired);
var lease2 = limiter.AttemptAcquire(0);
Assert.False(lease2.IsAcquired);
lease2.Dispose();
}
public override void ThrowsWhenAcquiringLessThanZero()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 1,
AutoReplenishment = false
});
Assert.Throws<ArgumentOutOfRangeException>(() => limiter.AttemptAcquire(-1));
}
public override void MetadataNamesContainsAllMetadata()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 1,
AutoReplenishment = false
});
using var lease = limiter.AttemptAcquire(1);
Assert.Collection(lease.MetadataNames, metadataName => Assert.Equal(metadataName, MetadataName.RetryAfter.Name));
}
public override void NoMetadataOnAcquiredLease()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
using var lease = limiter.AttemptAcquire(1);
Assert.False(lease.TryGetMetadata(MetadataName.RetryAfter, out _));
}
public override void CanAcquireResource()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire();
Assert.True(lease.IsAcquired);
Assert.False(limiter.AttemptAcquire().IsAcquired);
lease.Dispose();
Assert.False(limiter.AttemptAcquire().IsAcquired);
Assert.True(limiter.TryReplenish());
Assert.True(limiter.TryReplenish());
Assert.True(limiter.AttemptAcquire().IsAcquired);
}
public override void NullIdleDurationWhenActive()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = TimeSpan.FromMilliseconds(2),
SegmentsPerWindow = 1,
AutoReplenishment = false
});
limiter.AttemptAcquire(1);
Assert.Null(limiter.IdleDuration);
}
public override void IdleDurationUpdatesWhenChangingFromActive()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
limiter.AttemptAcquire(1);
limiter.TryReplenish();
limiter.TryReplenish();
Assert.NotNull(limiter.IdleDuration);
}
public override async Task FailsWhenQueuingMoreThanLimit_OldestFirst()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
using var lease = limiter.AttemptAcquire(1);
var wait = limiter.AcquireAsync(1);
var failedLease = await limiter.AcquireAsync(1);
Assert.False(failedLease.IsAcquired);
}
public async Task AutoReplenish_ReplenishesCounters()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.FromMilliseconds(1000),
SegmentsPerWindow = 2,
AutoReplenishment = true
});
Assert.Equal(2, limiter.GetStatistics().CurrentAvailablePermits);
limiter.AttemptAcquire(2);
var lease = await limiter.AcquireAsync(1);
Assert.True(lease.IsAcquired);
}
public override async Task CanFillQueueWithNewestFirstAfterCancelingQueuedRequestWithAnotherQueuedRequest()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 2,
QueueProcessingOrder = QueueProcessingOrder.NewestFirst,
QueueLimit = 2,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var lease = limiter.AttemptAcquire(2);
Assert.True(lease.IsAcquired);
var cts = new CancellationTokenSource();
var wait = limiter.AcquireAsync(1, cts.Token);
// Add another item to queue, will be completed as failed later when we queue another item
var wait2 = limiter.AcquireAsync(1);
Assert.False(wait.IsCompleted);
cts.Cancel();
var ex = await Assert.ThrowsAsync<TaskCanceledException>(() => wait.AsTask());
Assert.Equal(cts.Token, ex.CancellationToken);
lease.Dispose();
limiter.TryReplenish();
var wait3 = limiter.AcquireAsync(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 void GetStatisticsReturnsNewInstances()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
AutoReplenishment = false
});
var stats = limiter.GetStatistics();
Assert.Equal(1, stats.CurrentAvailablePermits);
var lease = limiter.AttemptAcquire(1);
var stats2 = limiter.GetStatistics();
Assert.NotSame(stats, stats2);
Assert.Equal(1, stats.CurrentAvailablePermits);
Assert.Equal(0, stats2.CurrentAvailablePermits);
}
public override async Task CanDisposeAfterCancelingQueuedRequest()
{
var limiter = new SlidingWindowRateLimiter(new SlidingWindowRateLimiterOptions
{
PermitLimit = 1,
QueueProcessingOrder = QueueProcessingOrder.OldestFirst,
QueueLimit = 1,
Window = TimeSpan.Zero,
SegmentsPerWindow = 2,
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();
}
