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.

Sign up for GitHub

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

Jump to bottom

feat: allow no migration of commitment #20181

Merged
merged 6 commits into from May 3, 2024
Merged

feat: allow no migration of commitment #20181

merged 6 commits into from May 3, 2024

Conversation

cool-develope
Copy link
Contributor

@cool-develope cool-develope commented Apr 24, 2024 •
edited by coderabbitai bot

Description

Closes: #20179

If want to keep the iavl v0/v1 as the state commitment, just parse nil to the migration manager.

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

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 migration management to support scenarios without a state commitment, improving robustness in data handling.

  • Bug Fixes

    • Adjusted key type handling in the restoration process to enhance error management and data assignment integrity.

  • Refactor

    • Modified the internal logic for updating state commitments to ensure accurate data representation post-migration.

@cool-develope cool-develope requested a review from a team as a code owner April 24, 2024 21:55
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 24, 2024 •
edited

Walkthrough

Walkthrough

The recent modifications aim to enhance the handling and flexibility of state commitments across various components. Changes include switching storeKey type, improving error management, and adding conditional operations based on stateCommitment presence. These updates ensure more robust and adaptable code behavior, especially in scenarios involving state migration and commitment management.

Changes

File Path Change Summary
.../commitment/store.go Switched storeKey from string to []byte, affecting its usage in the Restore method.
.../migration/manager.go Added imports, modified methods to handle stateCommitment being nil, and improved logic for migration and sync operations.
.../migration/manager_test.go Updated test setup and test functions to accommodate testing with and without a commit store.
.../root/store.go Updated logic in the writeSC method to handle new state commitment data from the migration manager.

Assessment against linked issues

Objective Addressed Explanation
Add an option to avoid commitment migration for using iavl/v0 or v1 as a commitment layer ✅
Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between f7e3518 and ff933d4.
Files selected for processing (4)
  • store/v2/commitment/store.go (3 hunks)
  • store/v2/migration/manager.go (6 hunks)
  • store/v2/migration/manager_test.go (2 hunks)
  • store/v2/root/store.go (1 hunks)
Additional Context Used
Path-based Instructions (4)
store/v2/migration/manager_test.go (2)

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

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

store/v2/migration/manager.go (1)

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

store/v2/commitment/store.go (1)

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

store/v2/root/store.go (1)

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

Additional comments not posted (9)
store/v2/migration/manager_test.go (2)

Line range hint 21-54: Ensure the setupMigrationManager function handles nil commit store correctly.

This function now correctly handles scenarios where noCommitStore is true by setting newCommitStore to nil. This is crucial for testing the behavior of the migration manager when no state commitment is desired.

60-112: Review the test logic in TestMigrateState.

The test covers both scenarios where the commit store is present and absent. This is essential for ensuring that the migration manager behaves as expected in both cases. The use of require.NoError and require.Nil appropriately checks for errors and expected nil values, ensuring robust testing.

store/v2/migration/manager.go (4)

56-56: Clarify the handling of nil state commitments in the constructor.

The constructor now explicitly allows for a nil state commitment, which is a critical feature for enabling optional migration. This change aligns with the PR's goal to allow skipping the migration process.

114-158: Ensure correct handling of state commitment during migration.

The migration logic now correctly handles cases where the state commitment is nil. If the state commitment is present, it restores from the migration stream; otherwise, it consumes the stream to restore the state storage. This is crucial for ensuring that the system can operate without a state commitment if configured to do so.

237-243: Verify the changeset writing and committing logic.

The logic to write and commit changesets to the state commitment when it is not nil is correctly implemented. This ensures that changes are appropriately persisted during the migration process.

264-266: Check the closure of the migration manager.

The Close method now correctly handles the end of the migration process by notifying the snapshots manager. This is essential for cleaning up and finalizing the migration process.

store/v2/commitment/store.go (2)

Line range hint 383-437: Ensure correct restoration logic in the Restore method.

The Restore method now correctly handles the restoration process, including error handling and committing the importer. This is crucial for ensuring data integrity during state restoration.

437-441: Check the handling of state changes during restoration.

The method correctly handles state changes by adding them to the chStorage channel. This ensures that state changes are correctly propagated during the restoration process.

store/v2/root/store.go (1)

398-401: Verify the handling of new state commitments after migration.

The logic to handle new state commitments after migration is correctly implemented. This ensures that the store can seamlessly transition to using the new state commitment once migration is completed.

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

@github-actions GitHub Actions
Copy link
Contributor

@cool-develope your pull request is missing a changelog!

@cool-develope cool-develope changed the title no migration of commitment feat: allow no migration of commitment Apr 24, 2024
tac0turtle
tac0turtle reviewed Apr 29, 2024
View reviewed changes
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

could we get a test case on this

tac0turtle
tac0turtle approved these changes May 2, 2024
View reviewed changes
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

approving but we are still missing a test with a commitment store, right now there is only a test without the store

@cool-develope
Copy link
Contributor Author

approving but we are still missing a test with a commitment store, right now there is only a test without the store

yes, there is only minimum covered test case now, we will add more tests in e2e tests. @sontrinh16

@cool-develope cool-develope reopened this May 3, 2024
@cool-develope cool-develope added this pull request to the merge queue May 3, 2024
Merged via the queue into main with commit 14f3ca0 May 3, 2024
109 of 119 checks passed
@cool-develope cool-develope deleted the store/20179_migrate branch May 3, 2024 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@sontrinh16 sontrinh16 sontrinh16 approved these changes

Assignees

@tac0turtle tac0turtle

@sontrinh16 sontrinh16

Labels
C:Store
Projects
None yet
Milestone
No milestone
3 participants
@cool-develope @tac0turtle @sontrinh16