Skip to content

Add support for WithEvents to ConcurrentLfuBuilder #797

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
bitfaster merged 10 commits into from
May 3, 2026
Merged

Add support for WithEvents to ConcurrentLfuBuilder #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
263e2b2
outline
May 1, 2026
cb8609a
single fast LFU
May 1, 2026
de473ca
Fix FastConcurrentLfu to report time policies and fix TestScheduler
Copilot May 1, 2026
cf07c7c
basic builder tests
May 1, 2026
850d414
fix soak seteup
May 1, 2026
50901ae
verify builder types
May 1, 2026
d5d2559
test FastConcurrentLfu variants
May 1, 2026
e6cb032
increase test coverage
May 2, 2026
cbe8a7e
Merge branch 'main' into users/alexpeck/lfubuilderevents
bitfaster May 2, 2026
ff64791
Merge branch 'main' into users/alexpeck/lfubuilderevents
bitfaster May 2, 2026
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
98 changes: 95 additions & 3 deletions BitFaster.Caching.UnitTests/Lfu/ConcurrentLfuBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,11 @@ public void TestScheduler()
{
ICache<int, int> lfu = new ConcurrentLfuBuilder<int, int>()
.WithScheduler(new NullScheduler())
.WithEvents()
.Build();

var clfu = lfu as ConcurrentLfu<int, int>;
clfu.Scheduler.Should().BeOfType<NullScheduler>();
clfu!.Scheduler.Should().BeOfType<NullScheduler>();
}

[Fact]
Expand All @@ -52,20 +53,92 @@ public void TestComparer()
lfu.TryGet("A", out var value).Should().BeTrue();
}

[Fact]
public void TestWithEvents()
{
ICache<string, int> lfu = new ConcurrentLfuBuilder<string, int>()
.WithEvents()
.Build();

lfu.Should().BeAssignableTo<ConcurrentLfu<string, int>>();

lfu.Events.HasValue.Should().BeTrue();
}

[Fact]
public void TestExpireAfterAccess()
{
ICache<string, int> expireAfterAccess = new ConcurrentLfuBuilder<string, int>()
.WithExpireAfterAccess(TimeSpan.FromSeconds(1))
.Build();

expireAfterAccess.Should().BeAssignableTo<FastConcurrentLfu<string, int, TimeOrderNode<string, int>, ExpireAfterPolicy<string, int, NoEventPolicy<string, int>>>>();

expireAfterAccess.Policy.ExpireAfterAccess.HasValue.Should().BeTrue();
expireAfterAccess.Policy.ExpireAfterAccess.Value.TimeToLive.Should().Be(TimeSpan.FromSeconds(1));
expireAfterAccess.Policy.ExpireAfterWrite.HasValue.Should().BeFalse();
expireAfterAccess.Policy.ExpireAfter.HasValue.Should().BeFalse();

expireAfterAccess.Events.HasValue.Should().BeFalse();
}

[Fact]
public void TestExpireAfterReadAndExpireAfterWriteThrows()
public void TestExpireAfterAccessWithEvents()
{
ICache<string, int> expireAfterAccess = new ConcurrentLfuBuilder<string, int>()
.WithExpireAfterAccess(TimeSpan.FromSeconds(1))
.WithEvents()
.Build();

expireAfterAccess.Should().BeAssignableTo<ConcurrentTLfu<string, int>>();

expireAfterAccess.Policy.ExpireAfterAccess.HasValue.Should().BeTrue();
expireAfterAccess.Policy.ExpireAfterAccess.Value.TimeToLive.Should().Be(TimeSpan.FromSeconds(1));
expireAfterAccess.Policy.ExpireAfterWrite.HasValue.Should().BeFalse();
expireAfterAccess.Policy.ExpireAfter.HasValue.Should().BeFalse();

expireAfterAccess.Events.HasValue.Should().BeTrue();
}

[Fact]
public void TestExpireAfterWrite()
{
ICache<string, int> expireAfterWrite = new ConcurrentLfuBuilder<string, int>()
.WithExpireAfterWrite(TimeSpan.FromSeconds(1))
.Build();

expireAfterWrite.Should().BeAssignableTo<FastConcurrentLfu<string, int, TimeOrderNode<string, int>, ExpireAfterPolicy<string, int, NoEventPolicy<string, int>>>>();

expireAfterWrite.Policy.ExpireAfterWrite.HasValue.Should().BeTrue();
expireAfterWrite.Policy.ExpireAfterWrite.Value.TimeToLive.Should().Be(TimeSpan.FromSeconds(1));

expireAfterWrite.Policy.ExpireAfterAccess.HasValue.Should().BeFalse();
expireAfterWrite.Policy.ExpireAfter.HasValue.Should().BeFalse();

expireAfterWrite.Events.HasValue.Should().BeFalse();
}

[Fact]
public void TestExpireAfterWriteWithEvents()
{
ICache<string, int> expireAfterWrite = new ConcurrentLfuBuilder<string, int>()
.WithExpireAfterWrite(TimeSpan.FromSeconds(1))
.WithEvents()
.Build();

expireAfterWrite.Should().BeAssignableTo<ConcurrentTLfu<string, int>>();

expireAfterWrite.Policy.ExpireAfterWrite.HasValue.Should().BeTrue();
expireAfterWrite.Policy.ExpireAfterWrite.Value.TimeToLive.Should().Be(TimeSpan.FromSeconds(1));

expireAfterWrite.Policy.ExpireAfterAccess.HasValue.Should().BeFalse();
expireAfterWrite.Policy.ExpireAfter.HasValue.Should().BeFalse();

expireAfterWrite.Events.HasValue.Should().BeTrue();
}

[Fact]
public void TestExpireAfterAccessAndExpireAfterWriteThrows()
{
var builder = new ConcurrentLfuBuilder<string, int>()
.WithExpireAfterAccess(TimeSpan.FromSeconds(1))
Expand All @@ -82,6 +155,24 @@ public void TestExpireAfter()
.WithExpireAfter(new TestExpiryCalculator<string, int>((k, v) => Duration.FromMinutes(5)))
.Build();

expireAfter.Should().BeAssignableTo<FastConcurrentLfu<string, int, TimeOrderNode<string, int>, ExpireAfterPolicy<string, int, NoEventPolicy<string, int>>>>();

expireAfter.Policy.ExpireAfter.HasValue.Should().BeTrue();

expireAfter.Policy.ExpireAfterAccess.HasValue.Should().BeFalse();
expireAfter.Policy.ExpireAfterWrite.HasValue.Should().BeFalse();
}

[Fact]
public void TestExpireAfterWithEvents()
{
ICache<string, int> expireAfter = new ConcurrentLfuBuilder<string, int>()
.WithExpireAfter(new TestExpiryCalculator<string, int>((k, v) => Duration.FromMinutes(5)))
.WithEvents()
.Build();

expireAfter.Should().BeAssignableTo<ConcurrentTLfu<string, int>>();

expireAfter.Policy.ExpireAfter.HasValue.Should().BeTrue();

expireAfter.Policy.ExpireAfterAccess.HasValue.Should().BeFalse();
Expand All @@ -96,13 +187,14 @@ public void TestAsyncExpireAfter()
.WithExpireAfter(new TestExpiryCalculator<string, int>((k, v) => Duration.FromMinutes(5)))
.Build();

expireAfter.Should().BeAssignableTo<FastConcurrentLfu<string, int, TimeOrderNode<string, int>, ExpireAfterPolicy<string, int, NoEventPolicy<string, int>>>>();

expireAfter.Policy.ExpireAfter.HasValue.Should().BeTrue();

expireAfter.Policy.ExpireAfterAccess.HasValue.Should().BeFalse();
expireAfter.Policy.ExpireAfterWrite.HasValue.Should().BeFalse();
}


[Fact]
public void TestExpireAfterWriteAndExpireAfterThrows()
{
Expand Down
2 changes: 1 addition & 1 deletion BitFaster.Caching.UnitTests/Lfu/ConcurrentLfuSoakTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ private void Checker(ICache<int, Guid> cache, CancellationTokenSource source)
private ConcurrentLfu<int, string> CreateWithBackgroundScheduler()
{
var scheduler = new BackgroundThreadScheduler();
return new ConcurrentLfuBuilder<int, string>().WithCapacity(9).WithScheduler(scheduler).Build() as ConcurrentLfu<int, string>;
return new ConcurrentLfuBuilder<int, string>().WithCapacity(9).WithEvents().WithScheduler(scheduler).Build() as ConcurrentLfu<int, string>;
}

private ConcurrentLfu<string, string> CreateStringWithBackgroundScheduler()
Expand Down
13 changes: 13 additions & 0 deletions BitFaster.Caching.UnitTests/Lfu/ConcurrentLfuTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -831,6 +831,19 @@ private void LogLru()
#endif
}

#if DEBUG
[Fact]
public void FormatLfuReturnsExpectedString()
{
cache.GetOrAdd(1, k => k);
cache.GetOrAdd(2, k => k);

cache.DoMaintenance();

cache.FormatLfuString().Should().Be("W [2] Protected [] Probation [1]");
}
#endif

[Fact]
public void WhenItemIsRemovedRemovedEventIsFired()
{
Expand Down
Loading
Loading