Skip to content
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.

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

Deleted entries should not be removed by expire eviction #219

Merged
merged 1 commit into from
May 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
61 changes: 61 additions & 0 deletions bigcache_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,67 @@ func TestOnRemoveFilter(t *testing.T) {
assertEqual(t, true, onRemoveInvoked)
}

func TestOnRemoveFilterExpired(t *testing.T) {
// t.Parallel()

// given
clock := mockedClock{value: 0}
onRemoveDeleted, onRemoveExpired := false, false
var err error
onRemove := func(key string, entry []byte, reason RemoveReason) {
switch reason {

case Deleted:
onRemoveDeleted = true
case Expired:
onRemoveExpired = true

}
}
c := Config{
Shards: 1,
LifeWindow: 3 * time.Second,
CleanWindow: 0,
MaxEntriesInWindow: 10,
MaxEntrySize: 256,
OnRemoveWithReason: onRemove,
}

cache, err := newBigCache(c, &clock)
assertEqual(t, err, nil)

// case 1: key is deleted AFTER expire
// when
onRemoveDeleted, onRemoveExpired = false, false
clock.set(0)

cache.Set("key", []byte("value"))
clock.set(5)
cache.cleanUp(uint64(clock.epoch()))

err = cache.Delete("key")

// then
assertEqual(t, err, ErrEntryNotFound)
assertEqual(t, false, onRemoveDeleted)
assertEqual(t, true, onRemoveExpired)

// case 1: key is deleted BEFORE expire
// when
onRemoveDeleted, onRemoveExpired = false, false
clock.set(0)

cache.Set("key2", []byte("value2"))
err = cache.Delete("key2")
clock.set(5)
cache.cleanUp(uint64(clock.epoch()))
// then

assertEqual(t, err, nil)
assertEqual(t, true, onRemoveDeleted)
assertEqual(t, false, onRemoveExpired)
}

func TestOnRemoveGetEntryStats(t *testing.T) {
t.Parallel()

Expand Down
4 changes: 4 additions & 0 deletions shard.go
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,10 @@ func (s *cacheShard) removeOldestEntry(reason RemoveReason) error {
oldest, err := s.entries.Pop()
if err == nil {
hash := readHashFromEntry(oldest)
if hash == 0 {
// entry has been explicitly deleted with resetKeyFromEntry, ignore
return nil
}
delete(s.hashmap, hash)
s.onRemove(oldest, reason)
if s.statsEnabled {
Expand Down