API: Cache Responses

[anarcher]

No description provided.

[spikeekips]

I can fill the missing description of this issue :)

• Most of API relies on storage, we need to reduce the usage of storage

This is checklist.

• BlockXX records should be cached; except BlockAccount
• Caching BlockAccount records and it's expiration can be 1s for considering very frequent requests
• 404 also should be cached, but it's expiration can be 1s or 2s
• Cache server can be embedded as memory type
• Cache should support external cache server like 'memcached', 'redis', or 'AWS elastic cache', etc.

[kfangw]

IMO, Redis would be satisfying the requirements.
On the Redis, It is very easy to use and set the TTL.

[spikeekips]

@kfangw Yes, redis will be good. There are some libraries for various kind of the existing cache system, https://github.com/avelino/awesome-go .

[anarcher]

The cache responses are handled by URL-based? If it is, how about CacheMiddleware?

[anarcher]

• https://github.com/coocood/freecache
• https://github.com/karlseguin/ccache
• https://github.com/allegro/bigcache
• https://github.com/hashicorp/golang-lru

[spikeekips]

@anarcher: The cache responses are handled by URL-based? If it is, how about CacheMiddleware?

It will be good, if we can manage different cache policy by handler, as I described BlockAccount should be managed differrently.

[anarcher]

cacheMiddleware := cache.NewMiddleware(
   cache.Option{
       Adapter: "mem",
       AdapterOption: "max=1000,expire=2s",
       MatchURLPrefix : "/v1/api/account", 
   },
   cache.Option{
       Adapter: "redis",
       AdapterOption: "endpoint=127.0.0.1:11211,max=1000",
       MatchURLPrefix : "/", 
   },...
}

[anarcher]

import "boscoin.io/sebak/lib/network/http/cache"
adapter := cache.NewMemAdapter(10000)
cached  := cache.New(
    cache.WithExpire(1 *time.Second),
    cache.WithAdpater(adapter),
    cache.WithStatusCode(200), // infinite
    cache.WithStatusCode(201,10 * time.Minute), 
    cache.WithStatusCode(404,3 * time.Minute),
    cache.WithMethods("GET","HEAD"),
)
nr.network.AddHandler(
    apiHandler.HandlerURLPattern(api.GetTransactionOperationsHandlerPattern),
    cached.Middleware(apiHandler.GetOperationsByTxHashHandler),
).Methods("GET", "OPTIONS")

@spikeekips @Geod24 @Charleslee522 I would like to prefer this approach for cache response.
What do think?

[Geod24]

@anarcher :

• What's the unit of 10000 (line 2) ?
• Expire at 1s is very low, isn't it ?
• What are the two status codes for ?

Other than that, it looks pretty expressive 👍

[anarcher]

• What's the unit of 10000 (line 2) ?
  Yes, max item limit.

• Expire at 1s is very low, isn't it ?
  It's an example or sample. and reference it

Caching BlockAccount records and it's expiration can be 1s for considering very frequent requests

• What are the two status codes for ?
  Reference it :

404 also should be cached, but it's expiration can be 1s or 2s

[Geod24]

IMHO, LRU+ observer based eviction is better performance than time-based

I agree with this, and I think it's also more correct.
This this, I expect that the expiration can be fairly high (hours).

[anarcher]

I agree with this, and I think it's also more correct.
This this, I expect that the expiration can be fairly high (hours).

I would like to do time expire based. (Not observer)

[Geod24]

I would like to do time expire based.

What changed your mind ? Also, what is the strategy to avoid serving stale data ?

[anarcher]

Caching BlockAccount records and it's expiration can be 1s for considering very frequent requests