storage/client: Remove consensus block cache

Author: ptrus

.changelog/1107.internal.md

@@ -0,0 +1,5 @@
+storage/client: Remove consensus block cache
+
+The API currently uses an in-memory cache for a single endpoint,
+while no caching is applied to other cases. This somewhat arbitrary
+choice stems from historical decisions without clear justification.

.golangci.yaml

@@ -32,7 +32,6 @@ linters:
             - github.com/oasisprotocol/metadata-registry-tools
             - github.com/akrylysov/pogreb
             - github.com/cockroachdb/apd
-            - github.com/dgraph-io/ristretto
             - github.com/ethereum/go-ethereum
             - github.com/go-chi/chi/v5
             - github.com/go-kit/log

go.mod

@@ -176,7 +176,6 @@ require (
 	github.com/akrylysov/pogreb v0.10.2
 	github.com/cockroachdb/apd v1.1.0
 	github.com/cometbft/cometbft v0.37.15
-	github.com/dgraph-io/ristretto v1.0.0
 	github.com/oapi-codegen/oapi-codegen/v2 v2.4.1
 	github.com/oapi-codegen/runtime v1.1.1
 	github.com/oasisprotocol/curve25519-voi v0.0.0-20230904125328-1f23a7beb09a

go.sum

@@ -158,8 +158,6 @@ github.com/decred/dcrd/dcrec/secp256k1/v4 v4.3.0 h1:rpfIENRNNilwHwZeG5+P150SMrnN
 github.com/decred/dcrd/dcrec/secp256k1/v4 v4.3.0/go.mod h1:v57UDF4pDQJcEfFUCRop3lJL149eHGSe9Jvczhzjo/0=
 github.com/dgraph-io/badger/v4 v4.5.1 h1:7DCIXrQjo1LKmM96YD+hLVJ2EEsyyoWxJfpdd56HLps=
 github.com/dgraph-io/badger/v4 v4.5.1/go.mod h1:qn3Be0j3TfV4kPbVoK0arXCD1/nr1ftth6sbL5jxdoA=
-github.com/dgraph-io/ristretto v1.0.0 h1:SYG07bONKMlFDUYu5pEu3DGAh8c2OFNzKm6G9J4Si84=
-github.com/dgraph-io/ristretto v1.0.0/go.mod h1:jTi2FiYEhQ1NsMmA7DeBykizjOuY88NhKBkepyu1jPc=
 github.com/dgraph-io/ristretto/v2 v2.1.0 h1:59LjpOJLNDULHh8MC4UaegN52lC4JnO2dITsie/Pa8I=
 github.com/dgraph-io/ristretto/v2 v2.1.0/go.mod h1:uejeqfYXpUomfse0+lO+13ATz4TypQYLJZzBSAemuB4=
 github.com/dgryski/go-farm v0.0.0-20200201041132-a6ae2369ad13 h1:fAjc9m62+UWV/WAFKLNi6ZS0675eEUC9y3AlwSbQu1Y=

storage/client/client.go

@@ -14,7 +14,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/dgraph-io/ristretto"
 	"github.com/ethereum/go-ethereum/accounts/abi"
 	ethCommon "github.com/ethereum/go-ethereum/common"
 	"github.com/jackc/pgx/v5"
@@ -42,8 +41,6 @@ import (
 )
 
 const (
-	blockCost = 1
-
 	defaultMaxTotalCount = 1000
 
 	// The maximum number of items that can be provided for name filters.
@@ -66,8 +63,6 @@ type StorageClient struct {
 	disableCirculatingSupply    bool
 	circulatingSupplyExclusions []apiTypes.Address
 
-	blockCache *ristretto.Cache[int64, *Block]
-
 	logger *log.Logger
 }
 
@@ -118,21 +113,6 @@ func NewStorageClient(
 	networkConfig *oasisConfig.Network,
 	l *log.Logger,
 ) (*StorageClient, error) {
-	// The API currently uses an in-memory block cache for a specific endpoint and no other cases.
-	// This somewhat arbitrary choice seems to have been made historically.
-	// Instead, we should review common queries and responses to implement a more consistent and general caching strategy.
-	// https://github.com/oasisprotocol/nexus/issues/887
-	blockCache, err := ristretto.NewCache(&ristretto.Config[int64, *Block]{
-		NumCounters:        1024 * 10,
-		MaxCost:            1024,
-		BufferItems:        64,
-		IgnoreInternalCost: true,
-	})
-	if err != nil {
-		l.Error("api client: failed to create block cache: %w", err)
-		return nil, err
-	}
-
 	// Parse the provided custom EVM token ordering config into a suitable format for the EVM token query.
 	// Per runtime list of token addresses.
 	evmTokensCustomOrderAddresses := make(map[common.Runtime][]*apiTypes.StakingAddress)
@@ -179,7 +159,6 @@ func NewStorageClient(
 		evmTokensCustomOrderGroups,
 		cfg.DisableCirculatingSupplyEndpoint,
 		circulatingSupplyExclusions,
-		blockCache,
 		l,
 	}, nil
 }
@@ -426,17 +405,7 @@ func entityInfoFromRow(r entityInfoRow) apiTypes.EntityInfo {
 // Blocks returns a list of consensus blocks.
 func (c *StorageClient) Blocks(ctx context.Context, r apiTypes.GetConsensusBlocksParams, height *int64) (*BlockList, error) {
 	if height != nil {
-		// Querying a single block by height, check cache.
-		// XXX: This cache is somewhat arbitrary and likely not very useful in practice.
-		// It has been kept for now to avoid regressions: https://github.com/oasisprotocol/nexus/issues/887
-		block, ok := c.blockCache.Get(*height)
-		if ok {
-			return &BlockList{
-				Blocks: []Block{*block},
-			}, nil
-		}
-
-		// Otherwise continue with the query below.
+		// Querying a single block by height, configure query parameters.
 		r.From = height
 		r.To = height
 		r.Limit = common.Ptr(uint64(1))
@@ -500,11 +469,6 @@ func (c *StorageClient) Blocks(ctx context.Context, r apiTypes.GetConsensusBlock
 		bs.Blocks = append(bs.Blocks, b)
 	}
 
-	// Cache the block if we queried a single block.
-	if height != nil && len(bs.Blocks) > 0 {
-		c.blockCache.Set(*height, &bs.Blocks[0], blockCost)
-	}
-
 	return &bs, nil
 }