make context a first class citizen

Author: mycrEEpy

mempot.go

@@ -9,11 +9,9 @@ import (
 
 // Config allows to alter the configuration of a Cache.
 //
-// Context is by default an empty background context.
 // DefaultTTL is by default 15 minutes.
 // CleanupInterval is by default 5 minutes.
 type Config struct {
-	Context         context.Context
 	DefaultTTL      time.Duration
 	CleanupInterval time.Duration
 }
@@ -23,11 +21,9 @@ type Cache[K comparable, T any] struct {
 	mut  sync.RWMutex
 	data map[K]Item[T]
 
+	ctx             context.Context
 	defaultTTL      time.Duration
 	cleanupInterval time.Duration
-
-	ctx    context.Context
-	cancel context.CancelFunc
 }
 
 // Item is a unit of typed data which can be cached and has an expiration as Unix epoch.
@@ -42,19 +38,14 @@ func (i *Item[T]) Expired() bool {
 }
 
 // NewCache create a new Cache instance with K as key and T as data.
-func NewCache[K comparable, T any](cfg Config) *Cache[K, T] {
+func NewCache[K comparable, T any](ctx context.Context, cfg Config) *Cache[K, T] {
 	c := &Cache[K, T]{
 		data:            make(map[K]Item[T]),
+		ctx:             ctx,
 		defaultTTL:      time.Minute * 15,
 		cleanupInterval: time.Minute * 5,
 	}
 
-	c.ctx, c.cancel = context.WithCancel(context.Background())
-
-	if cfg.Context != nil {
-		c.ctx = cfg.Context
-	}
-
 	if cfg.DefaultTTL > 0 {
 		c.defaultTTL = cfg.DefaultTTL
 	}
@@ -135,12 +126,6 @@ func (c *Cache[K, T]) Reset() {
 	c.mut.Unlock()
 }
 
-// Cancel will cancel the default Context of the Cache which stops the cleanup ticker.
-// This only has an effect when the Cache has not been created with a custom context.
-func (c *Cache[K, T]) Cancel() {
-	c.cancel()
-}
-
 func (c *Cache[K, T]) cleanup() {
 	ticker := time.NewTicker(c.cleanupInterval)
 

mempot_test.go

@@ -13,8 +13,7 @@ const data = "bar"
 func TestCache(t *testing.T) {
 	ctx, cancel := context.WithCancel(context.Background())
 
-	cache := NewCache[string, string](Config{
-		Context:         ctx,
+	cache := NewCache[string, string](ctx, Config{
 		DefaultTTL:      30 * time.Second,
 		CleanupInterval: 4 * time.Second,
 	})
@@ -69,7 +68,6 @@ func TestCache(t *testing.T) {
 	}
 
 	cancel()
-	cache.Cancel()
 
 	time.Sleep(1 * time.Second)
 }