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

chore(x/slashing,x/protocolpool): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23291

Closed

Conversation

caseylove
Copy link
Contributor

@caseylove caseylove commented Jan 10, 2025

Description

Partially addresses #23253

Summary by CodeRabbit

  • Refactor

    • Updated codec import paths from github.com/cosmos/cosmos-sdk/codec to cosmossdk.io/core/codec
    • Improved error handling in JSON marshaling and unmarshaling processes
    • Enhanced error checking in migration functions for protocol pool and slashing modules
  • Chores

    • Replaced MustMarshalJSON and MustUnmarshal with explicit error handling approaches
    • Maintained existing method signatures while improving error management

@caseylove caseylove requested review from raynaudoe, lucaslopezf, a team and alpe as code owners January 10, 2025 03:13
Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Warning

Rate limit exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 23 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 613a64a and 829097f.

📒 Files selected for processing (2)
  • x/protocolpool/module.go (2 hunks)
  • x/slashing/migrations/v4/migrate.go (3 hunks)
📝 Walkthrough

Walkthrough

The pull request introduces modifications to two files in the Cosmos SDK, focusing on codec import updates and error handling improvements. The changes primarily involve replacing the codec import from github.com/cosmos/cosmos-sdk/codec to cosmossdk.io/core/codec and enhancing JSON marshaling and unmarshaling error handling. The modifications ensure more explicit error management by replacing MustMarshal and MustUnmarshal methods with explicit error checking and panicking approaches.

Changes

File Change Summary
x/protocolpool/module.go - Updated codec import from cosmos-sdk/codec to cosmossdk.io/core/codec
- Modified DefaultGenesis() to include explicit JSON marshaling error handling
x/slashing/migrations/v4/migrate.go - Updated codec import from cosmos-sdk/codec to cosmossdk.io/core/codec
- Enhanced error handling in iterateValidatorSigningInfos() and iterateValidatorMissedBlockBitArray() with explicit error checking

Possibly related PRs

Suggested labels

backport/v0.52.x

Suggested reviewers

  • tac0turtle
  • lucaslopezf
  • aljo242

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>, please review it.
    • 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@caseylove caseylove changed the title chore(x/slashing,x/protocolpool): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec chore(x/slashing,x/protocolpool): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec Jan 10, 2025
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: 2

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 517839b and 613a64a.

📒 Files selected for processing (2)
  • x/protocolpool/module.go (2 hunks)
  • x/slashing/migrations/v4/migrate.go (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
x/protocolpool/module.go (1)

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

x/slashing/migrations/v4/migrate.go (1)

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

🪛 golangci-lint (1.62.2)
x/protocolpool/module.go

16-16: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

x/slashing/migrations/v4/migrate.go

14-14: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

🪛 GitHub Actions: Lint
x/protocolpool/module.go

[error] 11-11: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order


[error] 16-16: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: tests (03)
  • GitHub Check: tests (02)
  • GitHub Check: tests (01)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-system-v2
  • GitHub Check: test-integration
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: Summary
🔇 Additional comments (2)
x/protocolpool/module.go (1)

83-87: LGTM! Improved error handling in DefaultGenesis.

The change from MustMarshalJSON to explicit error handling with MarshalJSON provides better error context when marshaling fails.

x/slashing/migrations/v4/migrate.go (1)

77-79: LGTM! Improved error handling in unmarshal operations.

The change from MustUnmarshal to explicit error handling with Unmarshal provides better error context when unmarshaling fails.

Also applies to: 102-104

@@ -13,8 +13,8 @@ import (
"cosmossdk.io/x/protocolpool/keeper"
"cosmossdk.io/x/protocolpool/types"

"cosmossdk.io/core/codec"
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Reorder imports in the cosmossdk.io group

The import cosmossdk.io/core/codec should be grouped with other cosmossdk.io/core imports. Move it before the cosmossdk.io/x imports to maintain alphabetical ordering within its group:

import (
	"context"
	"encoding/json"
	"fmt"

	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
	"google.golang.org/grpc"

	"cosmossdk.io/core/appmodule"
	"cosmossdk.io/core/codec"
	"cosmossdk.io/core/registry"
	"cosmossdk.io/x/protocolpool/keeper"
	"cosmossdk.io/x/protocolpool/types"

	"github.com/cosmos/cosmos-sdk/client"
	"github.com/cosmos/cosmos-sdk/types/module"
)
🔗 Analysis chain

Fix import ordering according to project guidelines.

The import statement needs to be reordered according to the project's import grouping rules:

  1. Standard library
  2. Third-party
  3. First-party (cosmossdk.io)
  4. Local packages
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify import ordering rules across the codebase
gci diff --skip-generated -s standard -s default -s "prefix(cosmossdk.io)" -s "prefix(github.com/cosmos/cosmos-sdk)" x/protocolpool/module.go

Length of output: 237


Script:

#!/bin/bash
# Get the import block to analyze ordering
rg -U "import \($" -A 20 x/protocolpool/module.go

Length of output: 543

🧰 Tools
🪛 golangci-lint (1.62.2)

16-16: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

🪛 GitHub Actions: Lint

[error] 16-16: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

@@ -11,7 +11,7 @@ import (
storetypes "cosmossdk.io/store/types"
"cosmossdk.io/x/slashing/types"

"github.com/cosmos/cosmos-sdk/codec"
"cosmossdk.io/core/codec"
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Imports need to be reorganized for consistency

The imports should be grouped in the following order:

  1. Standard library imports ("context")
  2. Third-party imports (bitset, gogoproto)
  3. cosmossdk.io imports (core, errors, store, slashing)
  4. cosmos-sdk imports
🔗 Analysis chain

Fix import ordering according to project guidelines.

The import statement needs to be reordered according to the project's import grouping rules:

  1. Standard library
  2. Third-party
  3. First-party (cosmossdk.io)
  4. Local packages
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify import ordering rules across the codebase
gci diff --skip-generated -s standard -s default -s "prefix(cosmossdk.io)" -s "prefix(github.com/cosmos/cosmos-sdk)" x/slashing/migrations/v4/migrate.go

Length of output: 248


Script:

#!/bin/bash
# Get imports section from the file and similar migration files
echo "=== Current file imports ==="
rg -U "^import \($" -A 20 "x/slashing/migrations/v4/migrate.go"

echo -e "\n=== Other migration files imports for comparison ==="
fd "migrate.go" --exec rg -U "^import \($" -A 20 {} \;

Length of output: 5483

🧰 Tools
🪛 golangci-lint (1.62.2)

14-14: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

ACK!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 10, 2025
@julienrbrt
Copy link
Member

To merge into #23313

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/protocolpool C:x/slashing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants