Callback for the EOS UID cache to retry user fetch for failed keys on…

… expiry (#2266)
cs3org · Nov 17, 2021 · e10bce6 · e10bce6
1 parent 33deec9
commit e10bce6
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/changelog/unreleased/eos-uid-cache-expire-cb.md b/changelog/unreleased/eos-uid-cache-expire-cb.md
@@ -0,0 +1,3 @@
+Enhancement: Callback for the EOS UID cache to retry fetch for failed keys
+
+https://github.com/cs3org/reva/pull/2266
diff --git a/pkg/storage/utils/eosfs/eosfs.go b/pkg/storage/utils/eosfs/eosfs.go
@@ -31,6 +31,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/ReneKroon/ttlcache/v2"
 	"github.com/bluele/gcache"
 	grouppb "github.com/cs3org/go-cs3apis/cs3/identity/group/v1beta1"
 	userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
@@ -140,7 +141,7 @@ type eosfs struct {
 	conf           *Config
 	chunkHandler   *chunking.ChunkHandler
 	singleUserAuth eosclient.Authorization
-	userIDCache    gcache.Cache
+	userIDCache    *ttlcache.Cache
 	tokenCache     gcache.Cache
 }
 
@@ -205,10 +206,19 @@ func NewEOSFS(c *Config) (storage.FS, error) {
 		c:            eosClient,
 		conf:         c,
 		chunkHandler: chunking.NewChunkHandler(c.CacheDirectory),
-		userIDCache:  gcache.New(c.UserIDCacheSize).LFU().Build(),
+		userIDCache:  ttlcache.NewCache(),
 		tokenCache:   gcache.New(c.UserIDCacheSize).LFU().Build(),
 	}
 
+	eosfs.userIDCache.SetCacheSizeLimit(c.UserIDCacheSize)
+	eosfs.userIDCache.SetExpirationReasonCallback(func(key string, reason ttlcache.EvictionReason, value interface{}) {
+		// We only set those keys with TTL which we weren't able to retrieve the last time
+		// For those keys, try to contact the userprovider service again when they expire
+		if reason == ttlcache.Expired {
+			_, _ = eosfs.getUserIDGateway(context.Background(), key)
+		}
+	})
+
 	go eosfs.userIDcacheWarmup()
 
 	return eosfs, nil
@@ -1751,6 +1761,7 @@ func (fs *eosfs) convert(ctx context.Context, eosFileInfo *eosclient.FileInfo) (
 		Size:          size,
 		PermissionSet: fs.permissionSet(ctx, eosFileInfo, owner),
 		Checksum:      &xs,
+		Type:          getResourceType(eosFileInfo.IsDir),
 		Mtime: &types.Timestamp{
 			Seconds: eosFileInfo.MTimeSec,
 			Nanos:   eosFileInfo.MTimeNanos,
@@ -1775,7 +1786,6 @@ func (fs *eosfs) convert(ctx context.Context, eosFileInfo *eosclient.FileInfo) (
 		}
 	}
 
-	info.Type = getResourceType(eosFileInfo.IsDir)
 	return info, nil
 }
 
@@ -1811,11 +1821,11 @@ func (fs *eosfs) getUIDGateway(ctx context.Context, u *userpb.UserId) (eosclient
 		UserId: u,
 	})
 	if err != nil {
-		_ = fs.userIDCache.SetWithExpire(u.OpaqueId, &userpb.User{}, 12*time.Hour)
+		_ = fs.userIDCache.SetWithTTL(u.OpaqueId, &userpb.User{}, 12*time.Hour)
 		return eosclient.Authorization{}, errors.Wrap(err, "eosfs: error getting user")
 	}
 	if getUserResp.Status.Code != rpc.Code_CODE_OK {
-		_ = fs.userIDCache.SetWithExpire(u.OpaqueId, &userpb.User{}, 12*time.Hour)
+		_ = fs.userIDCache.SetWithTTL(u.OpaqueId, &userpb.User{}, 12*time.Hour)
 		return eosclient.Authorization{}, status.NewErrorFromCode(getUserResp.Status.Code, "eosfs")
 	}
 
@@ -1847,13 +1857,13 @@ func (fs *eosfs) getUserIDGateway(ctx context.Context, uid string) (*userpb.User
 	if err != nil {
 		// Insert an empty object in the cache so that we don't make another call
 		// for a specific amount of time
-		_ = fs.userIDCache.SetWithExpire(uid, &userpb.UserId{}, 12*time.Hour)
+		_ = fs.userIDCache.SetWithTTL(uid, &userpb.UserId{}, 12*time.Hour)
 		return nil, errors.Wrap(err, "eosfs: error getting user")
 	}
 	if getUserResp.Status.Code != rpc.Code_CODE_OK {
 		// Insert an empty object in the cache so that we don't make another call
 		// for a specific amount of time
-		_ = fs.userIDCache.SetWithExpire(uid, &userpb.UserId{}, 12*time.Hour)
+		_ = fs.userIDCache.SetWithTTL(uid, &userpb.UserId{}, 12*time.Hour)
 		return nil, status.NewErrorFromCode(getUserResp.Status.Code, "eosfs")
 	}