yihuang commented 3 months ago

Solution:

disable the memiavl cache if block-stm is enabled

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

[ ] Have you read the CONTRIBUTING.md?
[ ] Does your PR follow the C4 patch requirements?
[ ] Have you rebased your work on top of the latest master?
[ ] Have you checked your code compiles? (make)
[ ] Have you included tests for any non-trivial functionality?
[ ] Have you checked your code passes the unit tests? (make test)
[ ] Have you checked your code formatting is correct? (go fmt)
[ ] Have you checked your basic code style is fine? (golangci-lint run)
[ ] If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
[ ] If your changes affect the client infrastructure, have you run the integration test?
[ ] If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
[ ] If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
[ ] If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

New Features
- Updated caching behavior to improve performance and memory usage, particularly when using the block state machine feature.
- Enhanced configurability of memory IAVL store with a new cache size parameter.
Bug Fixes
- Resolved potential concurrency issues by adjusting cache handling based on the execution model.
Documentation
- Added entries in the CHANGELOG.md to document significant changes in caching behavior and configurations.

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes made enhance the configuration and control flow of the application's caching behavior, particularly in relation to the new block state machine (block-stm) feature. The modifications ensure that caching is disabled when block-stm is enabled, improving concurrency handling and memory management. Key functions were updated to accept parameters for better configurability, leading to a more robust and maintainable application architecture.

Changes

Files	Change Summary
CHANGELOG.md	Added a note about disabling the memory IAVL cache when the block-stm feature is enabled, highlighting implications for performance and memory usage.
app/app.go	Modified the `New` function to introduce `blockSTMEnabled`, preventing concurrency issues by conditionally enabling the memory IAVL cache. Updated control flow for address cache configuration for clarity.
store/setup.go	Altered `SetupMemIAVL` function signature to include a new `cacheSize` parameter, enhancing configurability for the memory IAVL store setup. Set `CacheSize` directly from the new parameter.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant BlockSTM
    participant MemoryIAVL

    App->>BlockSTM: Check if block-stm is enabled
    BlockSTM-->>App: Return blockSTMEnabled status
    App->>MemoryIAVL: Setup with cacheSize based on blockSTMEnabled
    alt if blockSTMEnabled is false
        MemoryIAVL-->>App: Enable caching
    else
        MemoryIAVL-->>App: Disable caching
    end

Poem

In the garden where logic grows,
A rabbit hops where the code flows,
With caching changes, we leap and bound,
Block-stm enabled, new paths are found.
Memory dances, settings refined,
In this code warren, joy's intertwined! 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 36.12%. Comparing base (b4cb3ed) to head (8f94fc1).

Files	Patch %	Lines
store/setup.go	0.00%	2 Missing :warning:

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1547/graphs/tree.svg?width=650&height=150&src=pr&token=92w0Dz1Coj&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain)](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1547?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain) ```diff @@ Coverage Diff @@ ## main #1547 +/- ## =========================================== + Coverage 15.24% 36.12% +20.88% =========================================== Files 67 97 +30 Lines 4874 7725 +2851 =========================================== + Hits 743 2791 +2048 - Misses 4037 4585 +548 - Partials 94 349 +255 ``` | [Files](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1547?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain) | Coverage Δ | | |---|---|---| | [store/setup.go](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1547?src=pr&el=tree&filepath=store%2Fsetup.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain#diff-c3RvcmUvc2V0dXAuZ28=) | `0.00% <0.00%> (ø)` | | ... and [46 files with indirect coverage changes](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1547/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain)

crypto-org-chain / cronos

Problem: memiavl cache not compatible with block-stm #1547