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

statedb revert to snapshot for ignored batches #1742

Merged
merged 2 commits into from
Jan 16, 2024

Conversation

tudor-malene
Copy link
Collaborator

Why this change is needed

  • revert any statedb changes performed by the sequencer speculatively when it turns out the batch will not get published

What changes were made as part of this PR

  • revert to a snapshot

PR checks pre-merging

Please indicate below by ticking the checkbox that you have read and performed the required
PR checks

  • PR checks reviewed and performed

Copy link

coderabbitai bot commented Jan 11, 2024

Walkthrough

The changes involve an update to the ComputeBatch function within the batch execution component of a Go-based enclave system. The update introduces conditional logic to handle unexpected state database (stateDB) mutations. If a snapshot (snap) is active, the system will now revert any unintended changes to ensure the integrity of the database state.

Changes

File Path Change Summary
.../components/batch_executor.go Modified ComputeBatch to revert stateDB mutations based on snap condition.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between cdc02eb and a47eeff.
Files selected for processing (1)
  • go/enclave/components/batch_executor.go (2 hunks)
Additional comments: 3
go/enclave/components/batch_executor.go (3)
  • 175-175: The assignment of snap from stateDB.Snapshot() has been modified to use short variable declaration (:=). This is a standard Go idiom for variable declaration and initialization, and it is correctly used here.

  • 225-228: The addition of the conditional block to revert the stateDB to a previous snapshot is a critical change. It's important to ensure that the snapshot ID (snap) is correctly managed and that the RevertToSnapshot method is called appropriately. The condition if snap > 0 suggests that a snapshot ID greater than 0 is considered valid. This logic assumes that Snapshot() method never returns a non-positive value for a valid snapshot, which should be verified.

  • 222-231: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-374]

The rest of the batch_executor.go file should be reviewed to ensure that the changes integrate well with the existing code and do not introduce any regressions or new issues. This includes checking for proper error handling, concurrency issues with the new snapshot logic, and ensuring that the snapshot ID is managed consistently throughout the code.

@StefanIliev545
Copy link
Contributor

This is broken - copyBatch.Header.Root = stateDB.IntermediateRoot(false) will finalize the journal which is used to revert and thus the call will panic.

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a47eeff and 0f3dd64.
Files selected for processing (1)
  • go/enclave/components/batch_executor.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • go/enclave/components/batch_executor.go

@tudor-malene
Copy link
Collaborator Author

This is broken - copyBatch.Header.Root = stateDB.IntermediateRoot(false) will finalize the journal which is used to revert and thus the call will panic.

@StefanIliev545 , pls have a look now

Copy link
Contributor

@StefanIliev545 StefanIliev545 left a comment

Choose a reason for hiding this comment

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

LGTM

@tudor-malene tudor-malene merged commit bdce4a8 into main Jan 16, 2024
2 checks passed
@tudor-malene tudor-malene deleted the tudor/reinstate_revert_on_empty_batch branch January 16, 2024 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants