feat: pricing & metadata caching #51
Conversation
|
|
||
| expect(result).toBeUndefined(); | ||
| expect(mockCache.set).not.toHaveBeenCalled(); | ||
| }); |
There was a problem hiding this comment.
Another case you might want to include as a spec: what happens when the provider fails? Should the caching proxy re-throw the error?
no, is always data from the past that isn't supposed to change |
| const metadataProvider = new IpfsProvider(env.IPFS_GATEWAYS_URL, logger); | ||
| const metadataRepository = new KyselyMetadataCache(kyselyDatabase, env.DATABASE_SCHEMA); | ||
| const _metadataProvider = new IpfsProvider(env.IPFS_GATEWAYS_URL, logger); | ||
| const metadataProvider = new CachingMetadataProvider( |
There was a problem hiding this comment.
it might be good to name _metadataProvider more specific to differentiate it from metadataProvider--maybe ipfsProvider, ipfsInstance?
| * If not found in cache, fetches from the underlying provider and caches the result before returning. | ||
| * Cache failures (both reads and writes) are logged but do not prevent the provider from functioning. | ||
| */ | ||
| export class CachingPricingProvider implements IPricingProvider { |
There was a problem hiding this comment.
can this data ever become stale? do we need TTL/eviction logic?
There was a problem hiding this comment.
no, is always data from the past that isn't supposed to change
|
|
||
| export type PriceCacheKey = { tokenCode: TokenCode; timestampMs: number }; | ||
|
|
||
| export class KyselyPricingCache implements ICache<PriceCacheKey, TokenPrice> { |
| @@ -0,0 +1,67 @@ | |||
| import { ICache, PriceCacheKey } from "@grants-stack-indexer/repository"; | |||
| import { ILogger, TokenCode } from "@grants-stack-indexer/shared"; | |||
There was a problem hiding this comment.
it doesn't have to be in this PR but probably we should rename tokencode to tokensymbol, they are different things (and I've never heard of token code used to describe a symbol like "ETH")
There was a problem hiding this comment.
could be, TokenCode is just a way to identify token generically (ie. not tied to the ID on a pricing provider like Coingecko) or to the symbol (since many tokens can have the same symbol), but in this case we decided to pick the token symbol as TokenCode but could be anything else. what name do you suggest?
There was a problem hiding this comment.
Ahh gotcha, I think that name is good then
🤖 Linear
Closes GIT-218 GIT-219 GIT-220
Description
We create two repositories for pricing and metadata that will act as
cache(note: is not the usual cache for fast retrieval that works in a Redis way, but instead is a layer that provides a significant improvement when reindexing so we don't fetch data again)Checklist before requesting a review