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 missing SDK 0.47 upgrade items #323

Merged
merged 2 commits into from
Oct 29, 2024
Merged

Add missing SDK 0.47 upgrade items #323

merged 2 commits into from
Oct 29, 2024

Conversation

cbrit
Copy link
Member

@cbrit cbrit commented Oct 29, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced upgrade handling for the SommelierApp, improving module management during upgrades.
    • Integrated parameter migration for the consensus module in the upgrade process.
  • Bug Fixes

    • Removed unnecessary event emissions related to message types in cork scheduling and publisher/subscriber intents, streamlining event management.
  • Refactor

    • Updated method signatures to accommodate new parameters for better upgrade handling.

@cbrit cbrit requested a review from zmanian October 29, 2024 14:47
Copy link

coderabbitai bot commented Oct 29, 2024

Walkthrough

The changes introduced in this pull request involve enhancements to the upgrade handling and module management within the SommelierApp. Key modifications include the addition of new modules during the v8 upgrade process and updates to the CreateUpgradeHandler function to accommodate parameter migration for the x/consensus module. Additionally, event emissions related to message types have been removed from various methods in the msg_server.go files, streamlining the event handling process while preserving core functionalities.

Changes

File Change Summary
app/app.go - Added modules: consensusparamtypes.ModuleName, crisistypes.ModuleName to store upgrades during v8 upgrade process.
- Updated setupUpgradeHandlers to include baseAppLegacySS from ParamsKeeper subspace for better parameter management.
app/upgrades/v8/upgrades.go - Updated CreateUpgradeHandler method signature to include baseAppLegacySS and consensusParamsKeeper.
- Added parameter migration for the x/consensus module within the upgrade handling process.
x/cork/keeper/msg_server.go - Removed event emission for sdk.EventTypeMessage in the ScheduleCork method, focusing on corktypes.EventTypeCork instead while maintaining existing logic and response structure.
x/pubsub/keeper/msg_server.go - Removed event emission for sdk.EventTypeMessage across multiple methods (AddPublisherIntent, AddSubscriberIntent, etc.), simplifying event emissions to focus on specific event types related to publisher and subscriber actions while retaining error handling and core functionality.

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

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

@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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 86d4c4f and 442e5b8.

📒 Files selected for processing (4)
  • app/app.go (2 hunks)
  • app/upgrades/v8/upgrades.go (1 hunks)
  • x/cork/keeper/msg_server.go (0 hunks)
  • x/pubsub/keeper/msg_server.go (0 hunks)
💤 Files with no reviewable changes (2)
  • x/cork/keeper/msg_server.go
  • x/pubsub/keeper/msg_server.go
🔇 Additional comments (4)
app/upgrades/v8/upgrades.go (2)

4-4: LGTM: Required imports added correctly

The new imports are necessary for the consensus parameter migration functionality.

Also applies to: 7-8


15-16: Verify all callers of CreateUpgradeHandler

The function signature change is correct for SDK 0.47 upgrade requirements. However, this is a breaking change that requires verification of all callers.

✅ Verification successful

The search results show that CreateUpgradeHandler is called in app/app.go with all the required new parameters (baseAppLegacySS and consensusParamsKeeper). The function is also defined in multiple upgrade versions (v4-v8), but this is expected as each version has its own independent implementation with different parameter requirements based on the upgrade needs.

Breaking change is properly handled

The caller in app/app.go has been correctly updated to pass the new parameters required by the v8 upgrade handler. Other upgrade handlers (v4-v7) are independent implementations and don't need modifications.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find all callers of CreateUpgradeHandler to ensure they've been updated
# with the new parameters

# Search for function calls to CreateUpgradeHandler
rg -A 5 "CreateUpgradeHandler\(" 

Length of output: 2215

app/app.go (2)

1041-1042: LGTM! Verify upgrade handler implementation.

The changes to the upgrade handler setup are correct for SDK 0.47:

  • Added baseAppLegacySS for parameter migration
  • Added ConsensusParamsKeeper for x/consensus module

Let's verify the upgrade handler implementation:

#!/bin/bash
# Description: Verify that the upgrade handler is properly implemented

# Test: Check the upgrade handler implementation
rg -A 10 "CreateUpgradeHandler" app/upgrades/v8/upgrades.go

Also applies to: 1049-1050


1027-1031: LGTM! Verify module initialization.

The addition of new modules in the store upgrades looks correct:

  • consensusparamtypes and crisistypes are standard additions for SDK 0.47
  • addressestypes is properly included alongside the SDK modules

Let's verify the module initialization:

✅ Verification successful

Modules are properly initialized and integrated

The verification shows that all three modules (addressestypes, consensusparamtypes, and crisistypes) are correctly:

  • Imported and declared
  • Have their keepers properly initialized
  • Are registered in the module manager
  • Have their store keys set up
  • Have their params subspaces configured

The addition of these modules in the store upgrades is consistent with their integration in the rest of the application.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the new modules are properly initialized in the InitGenesis order

# Test: Check if the modules are included in InitGenesis order
rg -A 5 "SetOrderInitGenesis" app/app.go

Length of output: 656


Script:

#!/bin/bash
# Let's try a different approach to verify module initialization

# Check for module initialization patterns in app.go
rg -B 2 -A 5 "InitGenesis" app/app.go

# Also check for module manager setup
rg -B 2 -A 10 "NewManager" app/app.go

# Check if these modules are registered in the module manager
rg "addresses|consensusparam|crisis" app/app.go

Length of output: 3713

Comment on lines +21 to +22
// new x/consensus module params migration
baseapp.MigrateParams(ctx, baseAppLegacySS, consensusParamsKeeper)
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding error handling for parameter migration

While the parameter migration is correctly implemented, consider handling potential errors from MigrateParams to ensure a more robust upgrade process.

 // new x/consensus module params migration
-baseapp.MigrateParams(ctx, baseAppLegacySS, consensusParamsKeeper)
+if err := baseapp.MigrateParams(ctx, baseAppLegacySS, consensusParamsKeeper); err != nil {
+    return nil, fmt.Errorf("failed to migrate consensus params: %w", err)
+}

Committable suggestion was skipped due to low confidence.

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.

1 participant