Add cache to stf context

[hieuvubk]

Description

Closes: #19223

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

• Add object cache to stf context

• get, set, remove of items affects cache

• add tests

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

• [ ] confirmed the correct type prefix in the PR title
• [ ] confirmed all author checklist items have been addressed
• [ ] reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

[coderabbitai[bot]]

[!IMPORTANT]

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[hieuvubk]

I have initialized the empty cache for ctx with each DeliverBlock. ctx.Cache will be updated during block execution (via the applyCache function).

One problem I'm facing is that the cache is only written by item.Set. Imagine a block that only executes Get functions (cache is empty so optimization is meaningless).

What if we modified the item.Get() function a bit? If the item is present but not in the cache, save it to the cache for later use

wdut? @tac0turtle

[tac0turtle]

What if we modified the item.Get() function a bit? If the item is present but not in the cache, save it to the cache for later use

wdut? @tac0turtle

Yea this is needed!!

[hieuvubk]

What if we modified the item.Get() function a bit? If the item is present but not in the cache, save it to the cache for later use wdut? @tac0turtle

Yea this is needed!!

Adjusted in 29eb7d2

[tac0turtle]

I have very limited context on the new stf but I am bit worried about dirty reads in the caching approach. I could not find where state is reverted when a CacheMultiStore is discarded. Also the cache seems to be reused via applyContextCache by different methods. But I may got that wrong.

I found caching very hard to get right in the past. Especially on the app level. There should be caching on the store level already. It would be good to see some bechmarks how much another cache adds on the app level to this. Ideally, caches come with configuration options so that people can trade memory for cpu and some metrics that show internals like usage size and hit rate.

Thanks for reviewing. I agree this is hard. The idea here is to cache decoded values. You are right there are caches at the store level and within the database. We have found for certain items decoding is a large overhead and done many times during a block. This is meant to reduce this

[tac0turtle]

closing this as we are upstreaming server modular to main and should add a quick adr on the design