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

feat(baseapp): Abort OE in PrepareProposal (Upstream dydx) #22287

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 16, 2024

Description

upstream dydxprotocol@38e40ba


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

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

Summary by CodeRabbit

  • New Features

    • Enhanced handling of optimistic execution during proposal preparation and processing.
    • Improved state management to prevent conflicts during concurrent operations.
  • Bug Fixes

    • Implemented abort logic for ongoing optimistic executions to ensure integrity during proposal lifecycle.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 16, 2024
Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

📝 Walkthrough

Walkthrough

The changes in the pull request focus on the baseapp package, specifically modifying the baseapp/abci.go file. The updates introduce logic to manage optimistic execution during the PrepareProposal and ProcessProposal methods. This includes aborting ongoing optimistic executions before proceeding with new proposals, resetting context states, and implementing checks in the FinalizeBlock method to ensure proper state management. These modifications aim to enhance the robustness of state handling during concurrent operations.

Changes

File Change Summary
baseapp/abci.go - Added optimistic execution abort logic in PrepareProposal and ProcessProposal methods.
- Updated FinalizeBlock to include checks for optimistic execution and state resets if execution is aborted.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant BaseApp
    participant OptimisticExec

    Client->>BaseApp: PrepareProposal()
    BaseApp->>OptimisticExec: Abort() (if optimistic execution running)
    BaseApp->>Client: Proposal prepared

    Client->>BaseApp: ProcessProposal()
    BaseApp->>OptimisticExec: Abort() (if proposal height exceeds)
    BaseApp->>Client: Proposal processed

    BaseApp->>BaseApp: FinalizeBlock()
    BaseApp->>OptimisticExec: Wait for execution result
    alt Execution aborted
        BaseApp->>BaseApp: Reset state
    end
Loading

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
🪧 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 resolve resolve all the CodeRabbit review comments.
  • @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.

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.

Copy link
Contributor

@julienrbrt your pull request is missing a changelog!

Comment on lines 409 to +415
return nil, errors.New("PrepareProposal handler not set")
}

// Abort any running OE so it cannot overlap with `PrepareProposal`. This could happen if optimistic
// `internalFinalizeBlock` from previous round takes a long time, but consensus has moved on to next round.
// Overlap is undesirable, since `internalFinalizeBlock` and `PrepareProoposal` could share access to
// in-memory structs depending on application implementation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change potentially affects state.

Call sequence:

(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).PrepareProposal (baseapp/abci.go:407)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
baseapp/abci.go (1)

414-414: Correct typo in comment: 'PrepareProoposal' should be 'PrepareProposal'

There is a typo in the comment at line 414. The function name PrepareProoposal should be corrected to PrepareProposal.

Apply this diff to fix the typo:

-	// Overlap is undesirable, since `internalFinalizeBlock` and `PrepareProoposal` could share access to
+	// Overlap is undesirable, since `internalFinalizeBlock` and `PrepareProposal` could share access to
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 553e110 and 607a8e6.

📒 Files selected for processing (1)
  • baseapp/abci.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
baseapp/abci.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

baseapp/abci.go Show resolved Hide resolved
@julienrbrt julienrbrt added this pull request to the merge queue Oct 17, 2024
Merged via the queue into main with commit 11698aa Oct 17, 2024
81 of 82 checks passed
@julienrbrt julienrbrt deleted the dydx-oe branch October 17, 2024 13:15
mergify bot pushed a commit that referenced this pull request Oct 17, 2024
Co-authored-by: Teddy Ding <teddy@dydx.exchange>
(cherry picked from commit 11698aa)
julienrbrt added a commit that referenced this pull request Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants