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/auth): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23487

Merged
merged 2 commits into from
Jan 23, 2025

Conversation

caseylove
Copy link
Contributor

@caseylove caseylove commented Jan 23, 2025

Description

Summary by CodeRabbit

  • Refactor

    • Updated codec import from github.com/cosmos/cosmos-sdk to cosmossdk.io/core across multiple files
    • Modified method signatures to use new codec.Codec type
    • Added cdc field to table struct for improved serialization
  • Chores

    • Migrated codec dependency to a newer core library
    • Maintained existing functionality during library transition

@caseylove caseylove requested a review from a team as a code owner January 23, 2025 13:49
Copy link
Contributor

coderabbitai bot commented Jan 23, 2025

📝 Walkthrough

Walkthrough

This pull request updates the codec import across multiple files in the x/group/internal/orm package, transitioning from github.com/cosmos/cosmos-sdk/codec to cosmossdk.io/core/codec. The changes involve modifying import statements and method signatures to use the new codec implementation. The core functionality of the ORM (Object-Relational Mapping) remains unchanged, with the primary modification being the codec dependency source.

Changes

File Change Summary
x/group/internal/orm/auto_uint64.go Updated codec import and method signature for NewAutoUInt64Table
x/group/internal/orm/example_test.go Replaced codec import path
x/group/internal/orm/primary_key.go Updated codec import and NewPrimaryKeyTable method signature
x/group/internal/orm/table.go Added cdc codec.Codec field to table struct, updated codec import

Possibly related PRs

Suggested labels

C:x/auth, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • lucaslopezf

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 18a8252 and 9148148.

📒 Files selected for processing (4)
  • x/group/internal/orm/auto_uint64.go (1 hunks)
  • x/group/internal/orm/example_test.go (1 hunks)
  • x/group/internal/orm/primary_key.go (1 hunks)
  • x/group/internal/orm/table.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • x/group/internal/orm/example_test.go
🧰 Additional context used
📓 Path-based instructions (3)
x/group/internal/orm/primary_key.go (1)

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

x/group/internal/orm/auto_uint64.go (1)

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

x/group/internal/orm/table.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: Summary
🔇 Additional comments (4)
x/group/internal/orm/auto_uint64.go (1)

7-7: LGTM: Import path updated correctly.

The codec import path has been updated to use cosmossdk.io/core/codec while maintaining the same functionality.

x/group/internal/orm/primary_key.go (1)

7-7: LGTM: Import path updated correctly.

The codec import path has been updated to use cosmossdk.io/core/codec while maintaining the same functionality.

x/group/internal/orm/table.go (2)

10-10: LGTM: Import path updated correctly.

The codec import path has been updated to use cosmossdk.io/core/codec while maintaining the same functionality.


Line range hint 32-45: Verify codec usage in table struct.

The codec field has been properly added to the table struct and is initialized correctly in the newTable function. Let's verify that all codec usages in the codebase are consistent with this change.

✅ Verification successful

Codec usage in table struct is properly integrated

The codec field has been correctly added to the table struct and is properly initialized in the newTable constructor. The usage is consistent with the codebase patterns and well-tested. Since the table struct is private, there are no migration concerns.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all codec usages in the codebase to ensure consistency

# Search for codec usage patterns
echo "Searching for codec usage patterns..."
rg -p "codec\." --type go

# Search for any remaining old import paths
echo "Checking for any remaining old codec imports..."
rg -p "github.com/cosmos/cosmos-sdk/codec" --type go

Length of output: 67244

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@aljo242 aljo242 added this pull request to the merge queue Jan 23, 2025
Merged via the queue into cosmos:main with commit 1253ee5 Jan 23, 2025
70 of 73 checks passed
@caseylove caseylove deleted the chore/codec-x-group branch January 27, 2025 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants