fix(cache): make in-memory backend Close-able so Shutdown stops its cleaner

cache.Shutdown only called Close() on an io.Closer, which only the Redis
backend (CacheWrapper) satisfied -- the in-memory Cache's Shutdown
(cancels ctx, stopping its cleanupRoutine background ticker) was never
reached, so that goroutine leaked until process exit (and with the
default set-up, and whenever Redis is unreachable and EnableCache falls
back to memory).

Add Close() error to Cache (calls Shutdown, idempotent, leaves the
cache usable) so cache.Shutdown handles both backends symmetrically.
Update Shutdown doc; add test TestMemoryCacheClose_IdempotentAndStillUsable.
This commit is contained in:
2026-08-13 11:36:52 +01:00
parent d410fb3c7e
commit df2f80f55f
3 changed files with 38 additions and 1 deletions
+1 -1
View File
@@ -169,7 +169,7 @@ func EnableCache(cfg *CacheConfig) {
}
// Shutdown closes the underlying cache client if it owns external resources
// (the Redis connection pool). No-op for in-memory caches.
// (the Redis connection pool, or the in-memory cleanup goroutine).
func Shutdown() {
if config != nil && config.Client != nil {
if closer, ok := config.Client.(io.Closer); ok {
+9
View File
@@ -108,6 +108,15 @@ func (c *Cache) Shutdown() {
}
}
// Close implements io.Closer so the cache layer (cache.Shutdown) can stop the
// cleanup goroutine for the in-memory backend, matching the Redis backend
// which closes its connection pool. Idempotent: cancelling the context does
// not render the cache unusable, it only stops the background cleaner.
func (c *Cache) Close() error {
c.Shutdown()
return nil
}
func (c *Cache) Set(key string, value []byte, ttl time.Duration) {
// Calculate the memory size of this entry
entrySize := int64(len(key) + len(value) + approxEntryOverhead)
+28
View File
@@ -1,6 +1,7 @@
package libpack_cache_memory
import (
"io"
"sync"
"testing"
"time"
@@ -146,3 +147,30 @@ func TestMemoryCacheConcurrentSetSameNewKey_CounterNotDoubled(t *testing.T) {
t.Fatal("key should be retrievable after Set")
}
}
func TestMemoryCacheClose_IdempotentAndStillUsable(t *testing.T) {
// Compile-time guard: the memory backend must satisfy io.Closer so
// cache.Shutdown() can stop its cleanup goroutine (it otherwise leaks
// the background timer until process exit), matching the Redis backend.
var _ io.Closer = (*Cache)(nil)
cache := New(DefaultTestExpiration)
cache.Set("key", []byte("value"), DefaultTestExpiration)
// Close is idempotent: it only cancels the background cleaner.
if err := cache.Close(); err != nil {
t.Fatalf("first Close: %v", err)
}
if err := cache.Close(); err != nil {
t.Fatalf("second Close: %v", err)
}
// Stopping the cleaner must not render the cache unusable.
if _, ok := cache.Get("key"); !ok {
t.Fatal("entry should survive Close; Close only stops the background cleaner")
}
cache.Set("key2", []byte("v2"), DefaultTestExpiration)
if _, ok := cache.Get("key2"); !ok {
t.Fatal("cache should remain writable after Close")
}
}