Skip to content

Commit

Permalink
InMemoryCacheClient should filter out expired items from count and items
Browse files Browse the repository at this point in the history
  • Loading branch information
@ejsmith
ejsmith committed Feb 9, 2025
1 parent bee5d09 commit 426011b
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions src/Foundatio/Caching/InMemoryCacheClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public InMemoryCacheClient(InMemoryCacheClientOptions options = null)
public InMemoryCacheClient(Builder<InMemoryCacheClientOptionsBuilder, InMemoryCacheClientOptions> config)
: this(config(new InMemoryCacheClientOptionsBuilder()).Build()) { }

public int Count => _memory.Count;
public int Count => _memory.Count(i => !i.Value.IsExpired);
public int? MaxItems => _maxItems;
public long Calls => _writes + _hits + _misses;
public long Writes => _writes;
Expand All @@ -67,7 +67,7 @@ public void ResetStats()
_misses = 0;
}

public AsyncEvent<ItemExpiredEventArgs> ItemExpired { get; } = new AsyncEvent<ItemExpiredEventArgs>();
public AsyncEvent<ItemExpiredEventArgs> ItemExpired { get; } = new();

private void OnItemExpired(string key, bool sendNotification = true)
{
Expand All @@ -92,6 +92,7 @@ public ICollection<string> Keys
get
{
return _memory.ToArray()
.Where(kvp => !kvp.Value.IsExpired)
.OrderBy(kvp => kvp.Value.LastAccessTicks)
.ThenBy(kvp => kvp.Value.InstanceNumber)
.Select(kvp => kvp.Key)
Expand All @@ -104,6 +105,7 @@ public ICollection<KeyValuePair<string, object>> Items
get
{
return _memory.ToArray()
.Where(kvp => !kvp.Value.IsExpired)
.OrderBy(kvp => kvp.Value.LastAccessTicks)
.ThenBy(kvp => kvp.Value.InstanceNumber)
.Select(kvp => new KeyValuePair<string, object>(kvp.Key, kvp.Value))
Expand Down Expand Up @@ -202,11 +204,11 @@ public Task<int> RemoveByPrefixAsync(string prefix)
internal void RemoveExpiredKey(string key, bool sendNotification = true)
{
// Consideration: We could reduce the amount of calls to this by updating ExpiresAt and only having maintenance remove keys.
if (_memory.TryGetValue(key, out var existingEntry) && existingEntry.ExpiresAt < _timeProvider.GetUtcNow())
if (_memory.TryGetValue(key, out var existingEntry) && existingEntry.IsExpired)
{
if (_memory.TryRemove(key, out var removedEntry))
{
if (removedEntry.ExpiresAt >= _timeProvider.GetUtcNow())
if (!removedEntry.IsExpired)
throw new Exception("Removed item was not expired");

_logger.LogDebug("Removing expired cache entry {Key}", key);
Expand All @@ -226,7 +228,7 @@ public Task<CacheValue<T>> GetAsync<T>(string key)
return Task.FromResult(CacheValue<T>.NoValue);
}

if (existingEntry.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime)
if (existingEntry.IsExpired)
{
Interlocked.Increment(ref _misses);
return Task.FromResult(CacheValue<T>.NoValue);
Expand Down Expand Up @@ -488,7 +490,7 @@ public async Task<long> ListAddAsync<T>(string key, IEnumerable<T> values, TimeS

if (values is string stringValue)
{
var items = new HashSet<string>(new[] { stringValue });
var items = new HashSet<string>([stringValue]);
var entry = new CacheEntry(items, expiresAt, _timeProvider, _shouldClone);
_memory.AddOrUpdate(key, entry, (existingKey, existingEntry) =>
{
Expand Down Expand Up @@ -551,7 +553,7 @@ public Task<long> ListRemoveAsync<T>(string key, IEnumerable<T> values, TimeSpan

if (values is string stringValue)
{
var items = new HashSet<string>(new[] { stringValue });
var items = new HashSet<string>([stringValue]);
_memory.TryUpdate(key, (existingKey, existingEntry) =>
{
if (existingEntry.Value is ICollection<string> { Count: > 0 } collection)
Expand Down Expand Up @@ -614,7 +616,7 @@ private async Task<bool> SetInternalAsync(string key, CacheEntry entry, bool add
if (String.IsNullOrEmpty(key))
throw new ArgumentNullException(nameof(key), "SetInternalAsync: Key cannot be null or empty");

if (entry.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime)
if (entry.IsExpired)
{
RemoveExpiredKey(key);
return false;
Expand All @@ -632,7 +634,7 @@ private async Task<bool> SetInternalAsync(string key, CacheEntry entry, bool add
wasUpdated = false;

// check to see if existing entry is expired
if (existingEntry.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime)
if (existingEntry.IsExpired)
{
if (isTraceLogLevelEnabled)
_logger.LogTrace("Attempting to replacing expired cache key: {Key}", existingKey);
Expand Down Expand Up @@ -812,7 +814,7 @@ public Task<bool> ExistsAsync(string key)
return Task.FromResult(false);
}

if (existingEntry.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime)
if (existingEntry.IsExpired)
{
Interlocked.Increment(ref _misses);
return Task.FromResult(false);
Expand All @@ -833,7 +835,7 @@ public Task<bool> ExistsAsync(string key)
return Task.FromResult<TimeSpan?>(null);
}

if (existingEntry.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime || existingEntry.ExpiresAt == DateTime.MaxValue)
if (existingEntry.IsExpired || existingEntry.ExpiresAt == DateTime.MaxValue)
{
Interlocked.Increment(ref _misses);
return Task.FromResult<TimeSpan?>(null);
Expand Down Expand Up @@ -892,7 +894,7 @@ private async Task CompactAsync()
(string Key, long LastAccessTicks, long InstanceNumber) oldest = (null, Int64.MaxValue, 0);
foreach (var kvp in _memory)
{
bool isExpired = kvp.Value.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime;
bool isExpired = kvp.Value.IsExpired;
if (isExpired ||
kvp.Value.LastAccessTicks < oldest.LastAccessTicks ||
(kvp.Value.LastAccessTicks == oldest.LastAccessTicks && kvp.Value.InstanceNumber < oldest.InstanceNumber))
Expand All @@ -907,7 +909,7 @@ private async Task CompactAsync()

_logger.LogDebug("Removing cache entry {Key} due to cache exceeding max item count limit", oldest);
_memory.TryRemove(oldest.Key, out var cacheEntry);
if (cacheEntry != null && cacheEntry.ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime)
if (cacheEntry is { IsExpired: true })
expiredKey = oldest.Key;
}

Expand Down Expand Up @@ -972,6 +974,7 @@ public CacheEntry(object value, DateTime expiresAt, TimeProvider timeProvider, b

internal long InstanceNumber { get; private set; }
internal DateTime ExpiresAt { get; set; }
internal bool IsExpired => ExpiresAt < _timeProvider.GetUtcNow().UtcDateTime;
internal long LastAccessTicks { get; private set; }
internal long LastModifiedTicks { get; private set; }
#if DEBUG
Expand Down

0 comments on commit 426011b

Please sign in to comment.