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

add v7 upgrade handler #2106

Merged
merged 6 commits into from
Aug 19, 2024
Merged

add v7 upgrade handler #2106

merged 6 commits into from
Aug 19, 2024

Conversation

affanv14
Copy link
Contributor

@affanv14 affanv14 commented Aug 19, 2024

Changelist

Adds v7 upgrade handler + test setup

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Introduced upgrade handlers for version 7.0.0, enhancing the upgrade process.
    • Added a new package for version 7.0.0, defining upgrade constants and structures.
  • Bug Fixes

    • Updated logic to prevent duplicate upgrade handler registrations.
  • Tests

    • Implemented a comprehensive testing framework for the state upgrade process, ensuring functionality during transitions.
  • Documentation

    • Updated version numbers to reflect the transition from v6.0.0 to v7.0.0, indicating significant improvements and changes.

@affanv14 affanv14 requested a review from a team as a code owner August 19, 2024 16:31
Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Walkthrough

The changes signify a major upgrade from version 6.0.0 to 7.0.0 of the application's upgrade system. Key enhancements include the addition of new upgrade handlers, constants, and comprehensive testing files, all aimed at refining the migration processes and bolstering system integrity. These updates optimize the upgrade mechanism and establish a solid testing framework to ensure consistent functionality across versions.

Changes

File Path Change Summary
protocol/app/upgrades.go Updated import statements and logic to reference v7_0_0.
protocol/app/upgrades/v7.0.0/* Introduced new constants and upgrade handlers for version 7.0.0.
protocol/testing/version/* Updated version numbers to reflect major increments (v6.0.0, v7.0.0).
protocol/app/upgrades/v7.0.0/upgrade_container_test.go Added comprehensive tests for version 7.0.0 upgrade process.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant UpgradeHandler
    participant ModuleManager
    participant Configurator

    App->>UpgradeHandler: Request Upgrade
    UpgradeHandler->>ModuleManager: Run Migrations
    ModuleManager->>Configurator: Apply Configurations
    Configurator-->>ModuleManager: Configuration Complete
    ModuleManager-->>UpgradeHandler: Migrations Completed
    UpgradeHandler-->>App: Upgrade Successful
Loading

🐇 Hop, hop, here we go,
Upgrading to version 7, oh so slow!
With handlers and tests, we leap with glee,
A smoother path for you and me!
Upgrades in place, let's take a chance,
In this code world, we’ll happily dance! 🌟


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

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: 0

Outside diff range, codebase verification and nitpick comments (2)
protocol/app/upgrades/v7.0.0/upgrade_container_test.go (2)

22-38: LGTM! Consider adding detailed test logic.

The test setup for the state upgrade is well-structured. However, consider adding specific test logic in preUpgradeChecks and postUpgradeChecks to verify the upgrade handler's functionality.


40-50: Add specific logic to pre and post-upgrade checks.

The preUpgradeChecks and postUpgradeChecks functions currently contain placeholder comments. Consider implementing specific checks to validate the state before and after the upgrade.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba3492b and 267e0e3.

Files selected for processing (6)
  • protocol/app/upgrades.go (2 hunks)
  • protocol/app/upgrades/v7.0.0/constants.go (1 hunks)
  • protocol/app/upgrades/v7.0.0/upgrade.go (1 hunks)
  • protocol/app/upgrades/v7.0.0/upgrade_container_test.go (1 hunks)
  • protocol/testing/version/VERSION_CURRENT (1 hunks)
  • protocol/testing/version/VERSION_PREUPGRADE (1 hunks)
Files skipped from review due to trivial changes (2)
  • protocol/testing/version/VERSION_CURRENT
  • protocol/testing/version/VERSION_PREUPGRADE
Additional comments not posted (3)
protocol/app/upgrades/v7.0.0/constants.go (1)

7-13: LGTM!

The constants and upgrade struct are correctly defined for version 7.0.0.

protocol/app/upgrades/v7.0.0/upgrade.go (1)

12-19: LGTM!

The upgrade handler for v7.0.0 is correctly implemented to run migrations using the module manager.

protocol/app/upgrades.go (1)

Line range hint 6-30: LGTM!

The integration of the v7.0.0 upgrade into the upgrade handlers is correctly implemented, ensuring no duplicate handlers are registered.

@affanv14 affanv14 force-pushed the affan/v7-upgrade-test branch from e9650d7 to 7b88950 Compare August 19, 2024 19:55
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 267e0e3 and 7b88950.

Files selected for processing (7)
  • protocol/app/upgrades.go (2 hunks)
  • protocol/app/upgrades/v7.0.0/constants.go (1 hunks)
  • protocol/app/upgrades/v7.0.0/upgrade.go (1 hunks)
  • protocol/app/upgrades/v7.0.0/upgrade_container_test.go (1 hunks)
  • protocol/testing/version/VERSION_CURRENT (1 hunks)
  • protocol/testing/version/VERSION_FULL_NAME_PREUPGRADE (1 hunks)
  • protocol/testing/version/VERSION_PREUPGRADE (1 hunks)
Files skipped from review as they are similar to previous changes (6)
  • protocol/app/upgrades.go
  • protocol/app/upgrades/v7.0.0/constants.go
  • protocol/app/upgrades/v7.0.0/upgrade.go
  • protocol/app/upgrades/v7.0.0/upgrade_container_test.go
  • protocol/testing/version/VERSION_CURRENT
  • protocol/testing/version/VERSION_PREUPGRADE
Additional comments not posted (1)
protocol/testing/version/VERSION_FULL_NAME_PREUPGRADE (1)

1-1: Version Update to v6.0.0-dev999.

The version update from v5.2.0 to v6.0.0-dev999 suggests significant changes, possibly including breaking changes or major improvements. This aligns with the introduction of the v7 upgrade handler. Ensure that all dependencies and documentation are updated accordingly.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7b88950 and 5c60198.

Files selected for processing (3)
  • protocol/app/upgrades.go (2 hunks)
  • protocol/app/upgrades/v7.0.0/upgrade.go (1 hunks)
  • protocol/app/upgrades/v7.0.0/upgrade_container_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • protocol/app/upgrades.go
  • protocol/app/upgrades/v7.0.0/upgrade.go
  • protocol/app/upgrades/v7.0.0/upgrade_container_test.go

@affanv14 affanv14 merged commit fedf6e4 into main Aug 19, 2024
22 checks passed
@affanv14 affanv14 deleted the affan/v7-upgrade-test branch August 19, 2024 22:00
@roy-dydx
Copy link
Contributor

@Mergifyio backport release/protocol/v6.x

Copy link
Contributor

mergify bot commented Aug 20, 2024

backport release/protocol/v6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Aug 20, 2024
(cherry picked from commit fedf6e4)

# Conflicts:
#	protocol/testing/version/VERSION_CURRENT
#	protocol/testing/version/VERSION_FULL_NAME_PREUPGRADE
#	protocol/testing/version/VERSION_PREUPGRADE
@mergify mergify bot mentioned this pull request Aug 20, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants