From 34a51ed38ba067c880a8bb8e608efc774d757799 Mon Sep 17 00:00:00 2001
From: Leonard Lyubich <leonard@nspcc.ru>
Date: Thu, 4 Mar 2021 12:26:47 +0300
Subject: [PATCH] [#419] cmd/node: Cache containers read from sidechain

Implement LRU cache for values read from the network. Implement LRU cache of
containers read from sidechain. Use it as a container storage in neofs-node
app. Current cache size is set to 100, TTL is 30s (constants).

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
---
 cmd/neofs-node/cache.go     | 110 ++++++++++++++++++++++++++++++++++++
 cmd/neofs-node/container.go |   2 +-
 2 files changed, 111 insertions(+), 1 deletion(-)
 create mode 100644 cmd/neofs-node/cache.go

diff --git a/cmd/neofs-node/cache.go b/cmd/neofs-node/cache.go
new file mode 100644
index 00000000..a888ed95
--- /dev/null
+++ b/cmd/neofs-node/cache.go
@@ -0,0 +1,110 @@
+package main
+
+import (
+	"sync"
+	"time"
+
+	lru "github.com/hashicorp/golang-lru"
+	containerSDK "github.com/nspcc-dev/neofs-api-go/pkg/container"
+	"github.com/nspcc-dev/neofs-node/pkg/core/container"
+)
+
+type netValueReader func(interface{}) (interface{}, error)
+
+type valueWithTime struct {
+	v interface{}
+	t time.Time
+}
+
+// entity that provides TTL cache interface.
+type ttlNetCache struct {
+	mtx sync.Mutex
+
+	ttl time.Duration
+
+	sz int
+
+	cache *lru.Cache
+
+	netRdr netValueReader
+}
+
+// complicates netValueReader with TTL caching mechanism.
+func newNetworkTTLCache(sz int, ttl time.Duration, netRdr netValueReader) *ttlNetCache {
+	cache, err := lru.New(sz)
+	fatalOnErr(err)
+
+	return &ttlNetCache{
+		ttl:    ttl,
+		sz:     sz,
+		cache:  cache,
+		netRdr: netRdr,
+	}
+}
+
+// reads value by the key.
+//
+// updates the value from the network on cache miss or by TTL.
+//
+// returned value should not be modified.
+func (c *ttlNetCache) get(key interface{}) (interface{}, error) {
+	c.mtx.Lock()
+	defer c.mtx.Unlock()
+
+	val, ok := c.cache.Peek(key)
+	if ok {
+		valWithTime := val.(*valueWithTime)
+
+		if time.Since(valWithTime.t) < c.ttl {
+			valWithTime.t = time.Now()
+			return valWithTime.v, nil
+		}
+
+		c.cache.Remove(key)
+	}
+
+	val, err := c.netRdr(key)
+	if err != nil {
+		return nil, err
+	}
+
+	c.cache.Add(key, &valueWithTime{
+		v: val,
+		t: time.Now(),
+	})
+
+	return val, nil
+}
+
+// wrapper over TTL cache of values read from the network
+// that implements container storage.
+type ttlContainerStorage ttlNetCache
+
+func newCachedContainerStorage(v container.Source) container.Source {
+	const (
+		containerCacheSize = 100
+		containerCacheTTL  = 30 * time.Second
+	)
+
+	lruCnrCache := newNetworkTTLCache(containerCacheSize, containerCacheTTL, func(key interface{}) (interface{}, error) {
+		cid := containerSDK.NewID()
+
+		err := cid.Parse(key.(string))
+		if err != nil {
+			return nil, err
+		}
+
+		return v.Get(cid)
+	})
+
+	return (*ttlContainerStorage)(lruCnrCache)
+}
+
+func (s *ttlContainerStorage) Get(cid *containerSDK.ID) (*containerSDK.Container, error) {
+	val, err := (*ttlNetCache)(s).get(cid.String())
+	if err != nil {
+		return nil, err
+	}
+
+	return val.(*containerSDK.Container), nil
+}
diff --git a/cmd/neofs-node/container.go b/cmd/neofs-node/container.go
index 891212fe..5d217f3c 100644
--- a/cmd/neofs-node/container.go
+++ b/cmd/neofs-node/container.go
@@ -53,7 +53,7 @@ func initContainerService(c *cfg) {
 	wrap, err := wrapper.New(cnrClient)
 	fatalOnErr(err)
 
-	c.cfgObject.cnrStorage = wrap // use RPC node as source of containers
+	c.cfgObject.cnrStorage = newCachedContainerStorage(wrap) // use RPC node as source of containers (with caching)
 	c.cfgObject.cnrClient = wrap
 
 	localMetrics := &localStorageLoad{