[Off-chain] feat: in-memory query cache(s)

[bryanchriswhite]

Summary

Adds the QueryCache[T any] and HistoricalQueryCache[T any] interfaces, InMemoryCache[T any] implementation, configurations, and options functions.

---
title: Legend
---

classDiagram-v2

class GenericInterface__T__any {
    <<interface>>
    GenericMethod() T
}

class Implemenetation {
    ExportedField FieldType
    unexportedField FieldType
}

Implemenetation --|> GenericInterface__T__any: implements

%% class Embedder__T__any {
%%     <<interface>>
%%     GenericInterface[T]
%% }

%% Embedder__T__any ..|> GenericInterface__T__any: embeds

Loading

---
title: Caches
---

classDiagram-v2


class KeyValueCache__T__any {
    <<interface>>
    Get(key string) (value T, isCached bool)
    Set(key string, value T) (err error)
    Delete(key string)
    Clear()
}

class HistoricalKeyValueCache__T__any {
    <<interface>>
    GetLatestVersion(key string) (value T, isCached bool)
    GetVersion(key string, version int64) (value T, isCached bool)
    SetVersion(key string, value T, version int64) (err error)
}

class keyValueCache__T__any:::cacheImpl
keyValueCache__T__any --|> KeyValueCache__T__any

class historicalKeyValueCache__T__any
historicalKeyValueCache__T__any --|> HistoricalKeyValueCache__T__any

Loading

Issue

• [Off-Chain] ModuleParamsClient & Historical Params #543

Type of change

Select one or more from the following:

• New feature, functionality or library
• Consensus breaking; add the consensus-breaking label if so. See [Infra] Automatically add the consensus-breaking label #791 for details
• Bug fix
• Code health or cleanup
• Documentation
• Other (specify)

Testing

• Documentation: make docusaurus_start; only needed if you make doc changes
• Unit Tests: make go_develop_and_test
• LocalNet E2E Tests: make test_e2e
• DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

• I have tested my changes using the available tooling
• I have commented my code
• I have performed a self-review of my own code; both comments & source code
• I create and reference any new tickets, if applicable
• I have left TODOs throughout the codebase, if applicable

[Olshansk]

@bryanchriswhite I did a superficial review but did not dive into the validation of the business logic line-by-line.

Is there any section where you'd want another pair of 👀 ?

[Olshansk]

Love the iteration. Thanks @bryanchriswhite!

Left a few new comments, a few replies to older threads, but it should be g2g after the next round 🙌

[red-0ne]

Great caching design.

Left some comments but did not tend to pkg/client/query/cache/memory_test.go yet. Which I'll do right after this one.

[red-0ne]

This shape is easier to read and reason about 👍

I left some comments but should be trivial to address.

[Olshansk]

Just realized I never published my review from yesterday :(

[Olshansk]

@bryanchriswhite I did a "show changes since your last review" and it seems like all the files have changed?

Either way, lmk when this is ready for a re-review.

[bryanchriswhite]

@bryanchriswhite I did a "show changes since your last review" and it seems like all the files have changed?

Either way, lmk when this is ready for a re-review.

Sorry about that, this is likely the result of file renaming/reorganization. The cache now lives at pkg/cache, rather than pkg/client/query/cache. While its initial usage may be in the query clients, the cache pkg itself doesn't have any dependency or coupling to the query client pkg.

[bryanchriswhite]

Additionally, based on prior feedback and the continued iteration here, I've refactored GetVersion() to ONLY return the specific version requested, and added a new GetVersionLTE() method which implements the previous behavior:

	// GetVersionLTE retrieves the value at the nearest version <= maxVersion.
	// It returns true if a value meeting the version criteria for the given
	// key is cached, false otherwise.
	GetVersionLTE(key string, maxVersion int64) (T, bool)

[red-0ne]

Love the shape it took 🔥

Thanks for your patience iterating over it.

[Olshansk]

Love the final shape of this!

[bryanchriswhite]

PLEASE DO NOT DELETE THIS BRANCH UNTIL DOWNSTREAM PRS HAVE BEEN REBASED