Add Keys() and DeleteKeys()

Author: rthellend

autocertcache/cache.go

@@ -26,6 +26,7 @@ package autocertcache
 import (
 	"context"
 	"encoding/base64"
+	"sort"
 
 	"github.com/c2FmZQ/storage"
 	"golang.org/x/crypto/acme/autocert"
@@ -97,3 +98,35 @@ func (c *Cache) Delete(_ context.Context, key string) error {
 	delete(cc.Entries, key)
 	return commit(true, nil)
 }
+
+// DeleteKeys deletes a list of cached entries.
+func (c *Cache) DeleteKeys(_ context.Context, keys []string) error {
+	c.storage.Logger().Debugf("Cache.DeleteKeys(%q)", keys)
+	var cc cacheContent
+	commit, err := c.storage.OpenForUpdate(c.fileName, &cc)
+	if err != nil {
+		return err
+	}
+	if cc.Entries == nil {
+		cc.Entries = make(map[string]string)
+	}
+	for _, key := range keys {
+		delete(cc.Entries, key)
+	}
+	return commit(true, nil)
+}
+
+// Keys returns all the cache keys.
+func (c *Cache) Keys(_ context.Context) ([]string, error) {
+	c.storage.Logger().Debug("Cache.Keys()")
+	var cc cacheContent
+	if err := c.storage.ReadDataFile(c.fileName, &cc); err != nil {
+		return nil, err
+	}
+	keys := make([]string, 0, len(cc.Entries))
+	for k := range cc.Entries {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+	return keys, nil
+}

autocertcache/cache_test.go

@@ -42,19 +42,34 @@ func TestCache(t *testing.T) {
 	defer mk.Wipe()
 	cache := autocertcache.New("autocert", storage.New(t.TempDir(), mk))
 
+	if v, err := cache.Keys(ctx); err != nil || len(v) != 0 {
+		t.Errorf("cache.Keys() = %q, %v, want [], nil", v, err)
+	}
 	if v, err := cache.Get(ctx, "foo"); err != autocert.ErrCacheMiss || v != nil {
 		t.Errorf("cache.Get(foo) = %v, %v, want nil, ErrCacheMiss", v, err)
 	}
 	if err := cache.Put(ctx, "foo", []byte("bar")); err != nil {
 		t.Errorf("cache.Put(foo, bar) = %v", err)
 	}
+	if err := cache.Put(ctx, "bar", []byte("baz")); err != nil {
+		t.Errorf("cache.Put(bar, baz) = %v", err)
+	}
 	if v, err := cache.Get(ctx, "foo"); err != nil || string(v) != "bar" {
 		t.Errorf("cache.Get(foo) = %q, %v, want bar, nil", v, err)
 	}
+	if v, err := cache.Keys(ctx); err != nil || len(v) != 2 || v[0] != "bar" || v[1] != "foo" {
+		t.Errorf("cache.Keys() = %q, %v, want [bar foo], nil", v, err)
+	}
 	if err := cache.Delete(ctx, "foo"); err != nil {
 		t.Errorf("cache.Delete(foo) = %v", err)
 	}
 	if v, err := cache.Get(ctx, "foo"); err != autocert.ErrCacheMiss || v != nil {
 		t.Errorf("cache.Get(foo) = %v, %v, want nil, ErrCacheMiss", v, err)
 	}
+	if err := cache.DeleteKeys(ctx, []string{"bar"}); err != nil {
+		t.Errorf("cache.DeleteKeys([bar]) = %v", err)
+	}
+	if v, err := cache.Get(ctx, "bar"); err != autocert.ErrCacheMiss || v != nil {
+		t.Errorf("cache.Get(bar) = %v, %v, want nil, ErrCacheMiss", v, err)
+	}
 }

go.mod

@@ -2,10 +2,10 @@ module github.com/c2FmZQ/storage
 
 go 1.20
 
-require golang.org/x/crypto v0.14.0
+require golang.org/x/crypto v0.16.0
 
 require (
-	golang.org/x/net v0.17.0 // indirect
-	golang.org/x/sys v0.13.0 // indirect
-	golang.org/x/text v0.13.0 // indirect
+	golang.org/x/net v0.19.0 // indirect
+	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 )

go.sum

@@ -2,15 +2,23 @@ golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA=
 golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio=
 golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc=
 golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
+golang.org/x/crypto v0.16.0 h1:mMMrFzRSCF0GvB7Ne27XVtVAaXLrPmgPC7/v0tkwHaY=
+golang.org/x/crypto v0.16.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
 golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50=
 golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
 golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
 golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
+golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
+golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
 golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
 golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
 golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
+golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4=
 golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
 golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
 golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=