fixup! feat(indexer): Add a tx and tx receipt cache

Author: Yawning

conf/config.go

@@ -25,6 +25,7 @@ type Config struct {
 	IndexingStart uint64 `koanf:"indexing_start"`
 
 	Log      *LogConfig      `koanf:"log"`
+	Cache    *CacheConfig    `koanf:"cache"`
 	Database *DatabaseConfig `koanf:"database"`
 	Gateway  *GatewayConfig  `koanf:"gateway"`
 }
@@ -74,6 +75,16 @@ func (cfg *LogConfig) Validate() error {
 	return level.Set(cfg.Level)
 }
 
+// CacheConfig contains the cache configuration.
+type CacheConfig struct {
+	// BlockSize is the size of the block cache in BLOCKS.
+	BlockSize uint64 `koanf:"block_size"`
+	// TxSize is the size of the transaction cache in bytes.
+	TxSize uint64 `koanf:"tx_size"`
+	// TxReceiptSize is the size of the transaction receipt cache in bytes.
+	TxReceiptSize uint64 `koanf:"tx_receipt_size"`
+}
+
 // DatabaseConfig is the postgresql database configuration.
 type DatabaseConfig struct {
 	Host         string `koanf:"host"`

conf/server.yml

@@ -8,6 +8,11 @@ log:
   level: debug
   format: json
 
+cache:
+  block_size: 1024
+  tx_size: 1073741824
+  tx_receipt_size: 1073741824
+
 database:
   host: "127.0.0.1"
   port: 5432

conf/tests.yml

@@ -5,6 +5,11 @@ log:
   level: debug
   format: json
 
+cache:
+  block_size: 10
+  tx_size: 10485760
+  tx_receipt_size: 10485760
+
 database:
   host: "127.0.0.1"
   port: 5432

indexer/backend_cache.go

@@ -12,6 +12,7 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/roothash/api/block"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/client"
 
+	"github.com/oasisprotocol/emerald-web3-gateway/conf"
 	"github.com/oasisprotocol/emerald-web3-gateway/db/model"
 	"github.com/oasisprotocol/emerald-web3-gateway/storage"
 )
@@ -378,22 +379,37 @@ func (cb *cachingBackend) onRejectOrEvictBlock(
 func newCachingBackend(
 	ctx context.Context,
 	backend Backend,
+	cfg *conf.CacheConfig,
 ) (Backend, error) {
 	const (
-		blockCacheSize   = 1024               // In blocks.
-		txCacheSize      = 1024 * 1024 * 1024 // In bytes.
-		receiptCacheSize = txCacheSize        // In bytes.
-		bufferItems      = 64                 // Per documentation
+		defaultBlockCacheSize   = 1024               // In blocks
+		defaultTxCacheSize      = 1024 * 1024 * 1024 // In bytes
+		defaultReceiptCacheSize = defaultTxCacheSize // In bytes
+
+		bufferItems = 64 // Per documentation
 	)
 
+	if cfg == nil {
+		cfg = new(conf.CacheConfig)
+	}
+	if cfg.BlockSize == 0 {
+		cfg.BlockSize = defaultBlockCacheSize
+	}
+	if cfg.TxSize == 0 {
+		cfg.TxSize = defaultTxCacheSize
+	}
+	if cfg.TxReceiptSize == 0 {
+		cfg.TxReceiptSize = defaultReceiptCacheSize
+	}
+
 	cb := &cachingBackend{
 		inner: backend,
 	}
 
 	// Block cache (by block number aka round), accounting in blocks.
 	blockByNumber, err := ristretto.NewCache(&ristretto.Config{
-		NumCounters:        blockCacheSize * 10, // 10x MaxCost
-		MaxCost:            blockCacheSize,
+		NumCounters:        int64(cfg.BlockSize * 10), // 10x MaxCost
+		MaxCost:            int64(cfg.BlockSize),
 		BufferItems:        bufferItems,
 		OnEvict:            cb.onRejectOrEvictBlock,
 		OnReject:           cb.onRejectOrEvictBlock,
@@ -406,8 +422,8 @@ func newCachingBackend(
 
 	// Transaction cache (by transaction hash in hex), accounting in bytes.
 	txByHashHex, err := ristretto.NewCache(&ristretto.Config{
-		NumCounters: txCacheSize * 10,
-		MaxCost:     txCacheSize,
+		NumCounters: int64(cfg.TxSize * 10),
+		MaxCost:     int64(cfg.TxSize),
 		BufferItems: bufferItems,
 	})
 	if err != nil {
@@ -417,8 +433,8 @@ func newCachingBackend(
 
 	// Transaction receipt cache (by transaction hash in hex), accounting in bytes.
 	receiptByTxHashHex, err := ristretto.NewCache(&ristretto.Config{
-		NumCounters: receiptCacheSize * 10,
-		MaxCost:     receiptCacheSize,
+		NumCounters: int64(cfg.TxReceiptSize * 10),
+		MaxCost:     int64(cfg.TxReceiptSize),
 		BufferItems: bufferItems,
 	})
 	if err != nil {
@@ -431,7 +447,7 @@ func newCachingBackend(
 	// Try to initialize the last indexed/retained rounds.  Failures
 	// are ok.
 	cb.lastIndexedRound, _ = backend.QueryLastIndexedRound(ctx)
-	if cb.lastRetainedRound, _ = backend.QueryLastRetainedRound(ctx); cb.lastRetainedRound != 0 {
+	if cb.lastRetainedRound, err = backend.QueryLastRetainedRound(ctx); err == nil {
 		cb.lastRetainedRoundValid = 1
 	}
 

indexer/indexer.go

@@ -13,6 +13,7 @@ import (
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/client"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/modules/core"
 
+	"github.com/oasisprotocol/emerald-web3-gateway/conf"
 	"github.com/oasisprotocol/emerald-web3-gateway/storage"
 )
 
@@ -313,9 +314,10 @@ func New(
 	enablePruning bool,
 	pruningStep uint64,
 	indexingStart uint64,
+	cacheCfg *conf.CacheConfig,
 ) (*Service, Backend, error) {
 	ctx, cancelCtx := context.WithCancel(ctxBackend)
-	cachingBackend, err := newCachingBackend(ctx, backend)
+	cachingBackend, err := newCachingBackend(ctx, backend, cacheCfg)
 	if err != nil {
 		cancelCtx()
 		return nil, nil, err

main.go

@@ -215,7 +215,7 @@ func runRoot() error {
 		return err
 	}
 	backend := indexer.NewIndexBackend(runtimeID, db, subBackend)
-	indx, backend, err := indexer.New(ctx, backend, rc, runtimeID, db, cfg.EnablePruning, cfg.PruningStep, cfg.IndexingStart)
+	indx, backend, err := indexer.New(ctx, backend, rc, runtimeID, db, cfg.EnablePruning, cfg.PruningStep, cfg.IndexingStart, cfg.Cache)
 	if err != nil {
 		logger.Error("failed to create indexer", err)
 		return err

tests/rpc/utils.go

@@ -149,7 +149,7 @@ func Setup() error {
 		return err
 	}
 	backend := indexer.NewIndexBackend(runtimeID, db, subBackend)
-	indx, backend, err := indexer.New(ctx, backend, rc, runtimeID, db, tests.TestsConfig.EnablePruning, tests.TestsConfig.PruningStep, tests.TestsConfig.IndexingStart)
+	indx, backend, err := indexer.New(ctx, backend, rc, runtimeID, db, tests.TestsConfig.EnablePruning, tests.TestsConfig.PruningStep, tests.TestsConfig.IndexingStart, tests.TestsConfig.Cache)
 	if err != nil {
 		return err
 	}