Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(poolmanager): only write to cache in finalize execution mode #9332

Merged
merged 4 commits into from
Mar 27, 2025

Conversation

ValarDragon
Copy link
Member

Prevents the cache from being written to during other execution modes like CheckTx, which can lead to inconsistent state during transaction processing. The cache should only be populated during the final execution phase.

Prevents the cache from being written to during other execution modes like CheckTx, which can lead to inconsistent state during transaction processing. The cache should only be populated during the final execution phase.
@ValarDragon ValarDragon added V:state/compatible/backport State machine compatible PR, should be backported A:backport/v28.x backport patches to v28.x branch A:backport/v29.x backport patches to v8.x branch labels Mar 26, 2025
Copy link
Contributor

coderabbitai bot commented Mar 26, 2025

Walkthrough

The pull request introduces changes to the pool manager's logic, focusing on cache management and testing. It updates the CHANGELOG.md to note a bug fix stating that cache writes occur only during the finalize execution mode. A new method, getPoolRouteRaw, is added to the Keeper struct in create_pool.go, altering how the pool type is retrieved. Additionally, the test structure in create_pool_test.go is restructured to accommodate multiple execution modes while maintaining core functionality.

Changes

File(s) Change Summary
CHANGELOG.md Added an entry in the "Unreleased" section describing bug fix [#9332] to write to cache only during finalize execution mode.
x/poolmanager/create_pool.go Added method getPoolRouteRaw for retrieving ModuleRoute based on poolId. Modified GetPoolType to utilize getPoolRouteRaw. Updated GetPoolModule to conditionally write to cache based on execution mode.
x/poolmanager/create_pool_test.go Restructured TestCreatePool to support multiple execution modes with a nested loop. Moved CosmWasm pool setup outside the loop and updated pool ID validation logic.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Client
    participant PM as GetPoolModule
    participant Cache as CacheSystem

    Caller->>PM: Call GetPoolModule(context)
    activate PM
    PM->>PM: Check if execution mode is sdk.ExecModeFinalize
    alt Execution mode is finalize
        PM->>Cache: Write poolModuleCacheValue to cache
    else Not finalize
        PM-->>Caller: Skip cache write
    end
    deactivate PM
    PM-->>Caller: Return pool module
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 226835d and 1ae7f12.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: go (01)
  • GitHub Check: go (00)
  • GitHub Check: go (02)
  • GitHub Check: go (03)
  • GitHub Check: e2e
  • GitHub Check: Summary

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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.

PaddyMc
PaddyMc previously approved these changes Mar 26, 2025
- Add getPoolRouteRaw helper to directly get pool route from storage
- Modify GetPoolType to not rely on the cache via GetPoolModule
- Update tests to verify behavior in both Check and Finalize execution modes
- Fix test setup to ensure consistent state across execution modes
@PaddyMc PaddyMc dismissed their stale review March 26, 2025 12:35

approve by accident

@ValarDragon ValarDragon merged commit 140a57d into main Mar 27, 2025
1 check passed
@ValarDragon ValarDragon deleted the dev/fix_cache_writing_in_mempool branch March 27, 2025 02:47
mergify bot pushed a commit that referenced this pull request Mar 27, 2025
* fix(poolmanager): only write to cache in finalize execution mode

Prevents the cache from being written to during other execution modes like CheckTx, which can lead to inconsistent state during transaction processing. The cache should only be populated during the final execution phase.

* docs: add changelog entry for PR #9332

* fix(poolmanager): refactor GetPoolType to directly use state storage

- Add getPoolRouteRaw helper to directly get pool route from storage
- Modify GetPoolType to not rely on the cache via GetPoolModule
- Update tests to verify behavior in both Check and Finalize execution modes
- Fix test setup to ensure consistent state across execution modes

---------

Co-authored-by: ghost <paddymchale@hotmail.com>
(cherry picked from commit 140a57d)
mergify bot pushed a commit that referenced this pull request Mar 27, 2025
* fix(poolmanager): only write to cache in finalize execution mode

Prevents the cache from being written to during other execution modes like CheckTx, which can lead to inconsistent state during transaction processing. The cache should only be populated during the final execution phase.

* docs: add changelog entry for PR #9332

* fix(poolmanager): refactor GetPoolType to directly use state storage

- Add getPoolRouteRaw helper to directly get pool route from storage
- Modify GetPoolType to not rely on the cache via GetPoolModule
- Update tests to verify behavior in both Check and Finalize execution modes
- Fix test setup to ensure consistent state across execution modes

---------

Co-authored-by: ghost <paddymchale@hotmail.com>
(cherry picked from commit 140a57d)
PaddyMc pushed a commit that referenced this pull request Mar 27, 2025
…) (#9337)

* fix(poolmanager): only write to cache in finalize execution mode

Prevents the cache from being written to during other execution modes like CheckTx, which can lead to inconsistent state during transaction processing. The cache should only be populated during the final execution phase.

* docs: add changelog entry for PR #9332

* fix(poolmanager): refactor GetPoolType to directly use state storage

- Add getPoolRouteRaw helper to directly get pool route from storage
- Modify GetPoolType to not rely on the cache via GetPoolModule
- Update tests to verify behavior in both Check and Finalize execution modes
- Fix test setup to ensure consistent state across execution modes

---------

Co-authored-by: ghost <paddymchale@hotmail.com>
(cherry picked from commit 140a57d)

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
PaddyMc pushed a commit that referenced this pull request Mar 27, 2025
…) (#9338)

* fix(poolmanager): only write to cache in finalize execution mode

Prevents the cache from being written to during other execution modes like CheckTx, which can lead to inconsistent state during transaction processing. The cache should only be populated during the final execution phase.

* docs: add changelog entry for PR #9332

* fix(poolmanager): refactor GetPoolType to directly use state storage

- Add getPoolRouteRaw helper to directly get pool route from storage
- Modify GetPoolType to not rely on the cache via GetPoolModule
- Update tests to verify behavior in both Check and Finalize execution modes
- Fix test setup to ensure consistent state across execution modes

---------

Co-authored-by: ghost <paddymchale@hotmail.com>
(cherry picked from commit 140a57d)

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v28.x backport patches to v28.x branch A:backport/v29.x backport patches to v8.x branch C:x/poolmanager V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants