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 upgrade handler for v5.1 #1864

Merged
merged 4 commits into from
Jul 9, 2024
Merged

Conversation

vincentwschau
Copy link
Contributor

@vincentwschau vincentwschau commented Jul 5, 2024

Changelist

Front-port from release/protocol/v5.1.x, adding upgrade handler so upgrade path of v5.0.x to v5.1.x is clear. Removed tests.

Test Plan

N/A, tested in release/protocol/v5.1.x

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
    • Added support for app version 5.1.0, including a new upgrade handler for migrations and logging.
  • Chores
    • Updated pre-upgrade testing scripts and configurations to reflect version 5.1.0-rc2.

(cherry picked from commit 7aa0952)

# Conflicts:
#	protocol/app/upgrades.go
#	protocol/testing/containertest/containertest.sh
#	protocol/testing/containertest/preupgrade_genesis.json
#	protocol/testing/containertest/testnet.go
Copy link
Contributor

coderabbitai bot commented Jul 5, 2024

Walkthrough

The changes introduce a new version upgrade to version 5.1.0 for the protocol's application. This update includes setting a constant for the upgrade name, implementing an upgrade handler function for migrations and logging, and updating the pre-upgrade script and genesis configuration to reflect this new version.

Changes

File Path Change Summary
protocol/app/upgrades/v5.1.0/constants.go Define UpgradeName constant as "v5.1.0" and initialize Upgrade variable.
protocol/app/upgrades/v5.1.0/upgrade.go Introduce CreateUpgradeHandler function for handling upgrades.
protocol/.../containertest/containertest.sh Update PREUPGRADE_VERSION variable to "v5.1.0-rc2".
protocol/.../containertest/preupgrade_genesis.json Update app_version field in genesis file to "5.1.0-rc2".

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Upgrader as Upgrader
    participant ModuleManager as Module Manager
    participant Logger as Logger

    User->>Upgrader: Start Upgrade to v5.1.0
    Upgrader->>ModuleManager: Run Migrations
    ModuleManager-->>Upgrader: Migration Completed
    Upgrader->>Logger: Log Upgrade Information
    Logger-->>Upgrader: Information Logged
    Upgrader-->>User: Upgrade Completed Successfully
Loading

Poem

Amid the lines of code so bright,
A version change brought new light,
Upgrades named, handlers made,
In the world of bytes, we embrace the trade.
From genesis to script, all set right,
For v5.1.0, we take flight!
🐇✨


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

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 ae0bf05 and d3ad359.

Files selected for processing (4)
  • protocol/app/upgrades/v5.1.0/constants.go (1 hunks)
  • protocol/app/upgrades/v5.1.0/upgrade.go (1 hunks)
  • protocol/testing/containertest/containertest.sh (1 hunks)
  • protocol/testing/containertest/preupgrade_genesis.json (1 hunks)
Files skipped from review due to trivial changes (3)
  • protocol/app/upgrades/v5.1.0/constants.go
  • protocol/testing/containertest/containertest.sh
  • protocol/testing/containertest/preupgrade_genesis.json
Additional comments not posted (3)
protocol/app/upgrades/v5.1.0/upgrade.go (3)

1-10: LGTM!

The package declaration and imports are appropriate and necessary for the functionality provided.


12-15: LGTM!

The function signature and parameters are clear and appropriate for the upgrade handler functionality.


16-20: LGTM!

The function implementation correctly unwraps the SDK context, logs the upgrade information, and runs migrations.

@@ -7,7 +7,7 @@ set -eo pipefail
source "./genesis.sh"

CHAIN_ID="localdydxprotocol"
PREUPGRADE_VERSION="v5.0.2"
PREUPGRADE_VERSION="v5.1.0-rc1"
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: here and below, use v5.1.0-rc2?

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 d3ad359 and 606e252.

Files selected for processing (2)
  • protocol/testing/containertest/containertest.sh (1 hunks)
  • protocol/testing/containertest/preupgrade_genesis.json (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • protocol/testing/containertest/containertest.sh
  • protocol/testing/containertest/preupgrade_genesis.json

@vincentwschau vincentwschau merged commit 546616f into main Jul 9, 2024
18 checks passed
@vincentwschau vincentwschau deleted the vincentc/front-port-v5-1-handler branch July 9, 2024 16:46
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