[api] add cache for ReadContract/State() #2827

dustinxie · 2021-10-04T23:57:18Z

No description provided.

codecov · 2021-10-05T02:40:52Z

Codecov Report

Merging #2827 (2b1424c) into master (7d9bf96) will increase coverage by 0.10%.
The diff coverage is 63.93%.

@@            Coverage Diff             @@
##           master    #2827      +/-   ##
==========================================
+ Coverage   58.31%   58.42%   +0.10%     
==========================================
  Files         245      246       +1     
  Lines       22514    22571      +57     
==========================================
+ Hits        13129    13187      +58     
+ Misses       7714     7705       -9     
- Partials     1671     1679       +8

Impacted Files	Coverage Δ
api/api.go	`65.92% <50.00%> (+1.72%)`	⬆️
api/read_cache.go	`77.41% <77.41%> (ø)`
pkg/routine/recurringtask.go	`92.59% <0.00%> (-7.41%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7d9bf96...2b1424c. Read the comment docs.

CoderZhi · 2021-10-05T04:48:54Z

api/api.go

+ key := height + string(methodName)
+ for _, v := range arguments {
+ key += string(v)
+ }


the key may not be unique in this way. A better way is using json or protobuf.

fixed in latest push

CoderZhi · 2021-10-05T04:52:20Z

api/read_cache.go

+}
+
+// Put writes according to key
+func (rc *ReadCache) Put(ns, key string, value []byte) {


what's ns for?

ns is contract address, key is calldata

next will invalidate per contract address (contracts that are called in new block) in the read cache

https://github.com/iotexproject/iotex-core/pull/2827/files#diff-bf98d5fab5bcfabded9769069e7318683f549ec91cff84c5f87a9ae3a3ca3d8dR1036 it is not contract address

how can you tell which contract is modified in a block? how complicated will that be?

for readState, that is protocol's name, for ReadContract, that is contract's address

not too complicated, either check all executions in new block, or check all receipts

CoderZhi · 2021-10-05T04:52:43Z

api/read_cache.go

+ d, ok := bin.get(key)
+ if ok {
+ rc.hit++
+ log.L().Info("API cache hit", zap.Int("total", rc.total), zap.Int("hit", rc.hit))


use Info() to monitor the hit-rate for a while once this is rolled out, can turn off later

raullenchai · 2021-10-06T02:26:04Z

api/api.go

+ if d, ok := api.readCache.Get(sc.Contract() + string(sc.Data())); ok {
+ res := iotexapi.ReadContractResponse{}
+ if err := proto.Unmarshal(d, &res); err != nil {
+ return nil, status.Error(codes.Internal, err.Error())


this is not expected, should log.err here in case it happens

in this case, it may be better to fall back to original routine.

raullenchai · 2021-10-06T02:29:06Z

api/api.go

 Data: hex.EncodeToString(retval),
 Receipt: receipt.ConvertToReceiptPb(),
- }, nil
+ }
+ d, _ := proto.Marshal(&res)


raullenchai · 2021-10-06T02:32:22Z

api/read_cache.go

+
+// Clear clears the cache
+func (rc *ReadCache) Clear() {
+ rc.bins = nil


CoderZhi · 2021-10-06T03:18:19Z

api/api.go

+ if d, ok := api.readCache.Get(sc.Contract() + string(sc.Data())); ok {
+ res := iotexapi.ReadContractResponse{}
+ if err := proto.Unmarshal(d, &res); err != nil {
+ return nil, status.Error(codes.Internal, err.Error())


in this case, it may be better to fall back to original routine.

CoderZhi · 2021-10-06T03:24:18Z

api/read_cache.go

+}
+
+// Get reads according to key
+func (rc *ReadCache) Get(key string) ([]byte, bool) {


will key length cause efficiency problem? if so, we may hash it

* [reward] extend foundation bonus (#2785) * Add unit tests to cover the functions in action/signedaction.go (#2824) * limit the pagination size for all API calls to 5000 -- 2781 (#2800) Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> * remove unnecessary WithFeatureCtx() (#2823) * fix ioctl accountDelete test (#2825) * [ioctl] display chainID and encoding (#2820) * bump Go to 1.17 (#2784) * [api] add cache for ReadContract/State() (#2827) Co-authored-by: dustinxie <dahuaxie@gmail.com> Co-authored-by: dayuanc <34013965+dayuanc@users.noreply.github.com> Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> Co-authored-by: Haaai <55118568+Liuhaai@users.noreply.github.com> Co-authored-by: dustinxie <dahuaxie@gmail.com> Co-authored-by: dayuanc <34013965+dayuanc@users.noreply.github.com> Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> Co-authored-by: Haaai <55118568+Liuhaai@users.noreply.github.com>

* saving, switch to linux * tracing grpc api * saving, switch to linux * tracing grpc api * update tracer.go for test * small change * fix comments * Squashed commit of the following: commit 77a5a15 Author: dustinxie <dahuaxie@gmail.com> Date: Tue Oct 5 23:34:52 2021 -0700 [api] add cache for ReadContract/State() (#2827) commit 7d9bf96 Author: Haaai <55118568+Liuhaai@users.noreply.github.com> Date: Tue Oct 5 17:31:37 2021 -0700 bump Go to 1.17 (#2784) commit 09ef379 Author: dustinxie <dahuaxie@gmail.com> Date: Tue Oct 5 16:46:49 2021 -0700 [ioctl] display chainID and encoding (#2820) commit c2eab8d Author: Haaai <55118568+Liuhaai@users.noreply.github.com> Date: Tue Oct 5 15:45:45 2021 -0700 fix ioctl accountDelete test (#2825) commit 9489b57 Author: dustinxie <dahuaxie@gmail.com> Date: Tue Oct 5 15:14:31 2021 -0700 remove unnecessary WithFeatureCtx() (#2823) commit 3933ae9 Author: dayuanc <34013965+dayuanc@users.noreply.github.com> Date: Tue Oct 5 07:40:32 2021 -0700 limit the pagination size for all API calls to 5000 -- 2781 (#2800) Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> commit 88d273d Author: dayuanc <34013965+dayuanc@users.noreply.github.com> Date: Mon Oct 4 10:51:54 2021 -0700 Add unit tests to cover the functions in action/signedaction.go (#2824) commit ebe895c Author: dustinxie <dahuaxie@gmail.com> Date: Thu Sep 30 15:32:52 2021 -0700 [reward] extend foundation bonus (#2785) commit baa0a92 Author: CoderZhi <thecoderzhi@gmail.com> Date: Tue Sep 28 14:09:44 2021 -0700 Fix codecov (#2813) commit 84f06d3 Author: dayuanc <34013965+dayuanc@users.noreply.github.com> Date: Tue Sep 28 12:17:47 2021 -0700 reduce unnecessary logs for mainnet (#2808) * downgrade some unnecessary error and info logs * fix comments Co-authored-by: Raullen Chai <raullenchai@gmail.com> commit a245185 Author: dustinxie <dahuaxie@gmail.com> Date: Mon Sep 27 15:27:59 2021 -0700 [evm] panic in AccessList API (#2816) commit 8eec1b7 Author: dustinxie <dahuaxie@gmail.com> Date: Mon Sep 27 11:01:34 2021 -0700 set Jutland to activate at 10-11-2021 3pm PDT (#2812) Co-authored-by: Raullen Chai <raullenchai@gmail.com> commit e89be88 Author: CoderZhi <thecoderzhi@gmail.com> Date: Sat Sep 25 22:51:54 2021 -0700 set target height (#2807) Co-authored-by: dustinxie <dahuaxie@gmail.com> commit dba4993 Author: CoderZhi <thecoderzhi@gmail.com> Date: Thu Sep 23 11:44:26 2021 -0700 change commit block failure log level to error (#2810) commit 0459a1f Author: mas walker <handsome.void@gmail.com> Date: Wed Sep 22 20:18:23 2021 +0800 unbound feature and version/height (#2768) * unbound feature and version/height Co-authored-by: Raullen Chai <raullenchai@gmail.com> commit c1cea44 Author: millken <millken@gmail.com> Date: Tue Sep 21 06:31:57 2021 +0800 update circleci config, using golang 1.16.6 #2789 (#2791) Co-authored-by: dustinxie <dahuaxie@gmail.com> commit f245109 Author: Dustin Xie <dahuaxie@gmail.com> Date: Mon Sep 20 09:54:38 2021 -0700 [evm] enable opCall fix at Jutland height commit 3eea5b7 Author: Dustin Xie <dahuaxie@gmail.com> Date: Mon Sep 20 12:11:36 2021 -0700 [evm] fix datacopy.json for TestIstanbul commit 0641db0 Author: CoderZhi <thecoderzhi@gmail.com> Date: Fri Sep 17 14:37:28 2021 -0700 [evm] fix snapshot bug (#2802) * fix snapshot bug * add unit test Co-authored-by: Raullen Chai <raullenchai@gmail.com> commit e0683e8 Author: Haaai <55118568+Liuhaai@users.noreply.github.com> Date: Sat Sep 18 01:34:12 2021 +0800 add datacopy contract test (#2788) * add datacopy test * modify contract * remove debug log * update testdata * add attack bytecode * update datacopy.json * correct code format * remove printStore() in datacopy.sol * update contract test data Co-authored-by: dustinxie <dahuaxie@gmail.com> commit 44e0a68 Author: Haaai <55118568+Liuhaai@users.noreply.github.com> Date: Fri Sep 17 15:31:29 2021 +0800 Allow ioctl to show the list of actions for an account (#2750) * [ioctl] allow ioctl to show the list of actions for an account commit d10dabe Author: Haaai <55118568+Liuhaai@users.noreply.github.com> Date: Fri Sep 17 12:08:33 2021 +0800 [api] fix gas estimation calc bug (#2786) * fixed gas estimation bug in api.go * Tracing (#2) * [reward] extend foundation bonus (#2785) * Add unit tests to cover the functions in action/signedaction.go (#2824) * limit the pagination size for all API calls to 5000 -- 2781 (#2800) Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> * remove unnecessary WithFeatureCtx() (#2823) * fix ioctl accountDelete test (#2825) * [ioctl] display chainID and encoding (#2820) * bump Go to 1.17 (#2784) * [api] add cache for ReadContract/State() (#2827) Co-authored-by: dustinxie <dahuaxie@gmail.com> Co-authored-by: dayuanc <34013965+dayuanc@users.noreply.github.com> Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> Co-authored-by: Haaai <55118568+Liuhaai@users.noreply.github.com> Co-authored-by: Raullen Chai <raullenchai@gmail.com> Co-authored-by: dustinxie <dahuaxie@gmail.com> Co-authored-by: dayuanc <34013965+dayuanc@users.noreply.github.com> Co-authored-by: dayuanc <wentaicui@WENTAIs-MacBook-Pro.local> Co-authored-by: CoderZhi <thecoderzhi@gmail.com> Co-authored-by: Haaai <55118568+Liuhaai@users.noreply.github.com>

dustinxie requested a review from a team as a code owner October 4, 2021 23:57

dustinxie force-pushed the master branch 2 times, most recently from 465c0be to b59f347 Compare October 5, 2021 02:18

CoderZhi reviewed Oct 5, 2021

View reviewed changes

dustinxie force-pushed the master branch 5 times, most recently from f2d2dff to 646496e Compare October 6, 2021 01:07

raullenchai approved these changes Oct 6, 2021

View reviewed changes

dustinxie added 2 commits October 5, 2021 20:11

[api] add cache for ReadState()

e9ba22d

address comment

066d639

dustinxie force-pushed the master branch from 646496e to 066d639 Compare October 6, 2021 03:13

CoderZhi reviewed Oct 6, 2021

View reviewed changes

address comment 2

2b1424c

CoderZhi approved these changes Oct 6, 2021

View reviewed changes

dustinxie merged commit 77a5a15 into iotexproject:master Oct 6, 2021

dustinxie linked an issue Oct 6, 2021 that may be closed by this pull request

Cache for ReadContract() #2826

Closed

dustinxie removed a link to an issue Oct 6, 2021

Cache for ReadContract() #2826

Closed

dustinxie linked an issue Oct 6, 2021 that may be closed by this pull request

Cache for ReadContract() #2826

Closed

dustinxie added a commit that referenced this pull request Oct 9, 2021

[api] add cache for ReadContract/State() (#2827)

aab31d8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[api] add cache for ReadContract/State() #2827

[api] add cache for ReadContract/State() #2827

dustinxie commented Oct 4, 2021

codecov bot commented Oct 5, 2021 •

edited

Loading

CoderZhi Oct 5, 2021

dustinxie Oct 5, 2021

CoderZhi Oct 5, 2021

dustinxie Oct 5, 2021

CoderZhi Oct 5, 2021

dustinxie Oct 5, 2021

CoderZhi Oct 5, 2021

dustinxie Oct 5, 2021

raullenchai Oct 6, 2021

CoderZhi Oct 6, 2021

raullenchai Oct 6, 2021

raullenchai Oct 6, 2021

CoderZhi Oct 6, 2021

CoderZhi Oct 6, 2021

[api] add cache for ReadContract/State() #2827

[api] add cache for ReadContract/State() #2827

Conversation

dustinxie commented Oct 4, 2021

codecov bot commented Oct 5, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 5, 2021 •

edited

Loading