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.

Sign up for GitHub

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

Jump to bottom

refactor(x/accounts): Skip Importing Unregistered Genesis Account Types #20053

Merged
merged 1 commit into from
Apr 16, 2024
Merged

refactor(x/accounts): Skip Importing Unregistered Genesis Account Types #20053

merged 1 commit into from
Apr 16, 2024

Conversation

meetrick
Copy link
Contributor

@meetrick meetrick commented Apr 16, 2024 •
edited by coderabbitai bot
Loading

Description

Skip Importing Unregistered Genesis Account Types in x/accounts/genesis.go

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the account import process to verify account types before importing, ensuring reliability and preventing errors.

@meetrick
refactor(x/accounts): Skip Importing Unregistered Genesis Account Types
e1669cd 
Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick meetrick requested a review from a team as a code owner April 16, 2024 03:01
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 16, 2024 •
edited
Loading

Walkthrough

Walkthrough

The update introduces a validation step in the ImportState method to ensure that the account type exists before proceeding with the import. Additionally, a new test case has been added to verify that an error is properly triggered when attempting to import an account with a non-existent type. This enhancement aims to improve the robustness of the account import process by preventing invalid data entries.

Changes

Files Summary of Changes
x/accounts/genesis.go Added a check to verify account type existence in the ImportState method.
x/accounts/genesis_test.go Added import of v1 "cosmossdk.io/x/accounts/v1" and a new test TestImportAccountError to assert error conditions for non-existent account type.
Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 4ed8c84 and e1669cd.
Files selected for processing (2)
  • x/accounts/genesis.go (1 hunks)
  • x/accounts/genesis_test.go (2 hunks)
Additional Context Used
Path-based Instructions (2)
x/accounts/genesis_test.go (2)

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

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

x/accounts/genesis.go (1)

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

Additional comments not posted (3)
x/accounts/genesis_test.go (2)

11-11: Import of new package v1 "cosmossdk.io/x/accounts/v1" is noted.

53-76: The new test function TestImportAccountError is well-structured and effectively tests the new validation logic in the importAccount method by simulating the import of a GenesisAccount with a non-existent account type. The assertions for error presence and specific error message content are appropriate and ensure that the error handling behaves as expected.

x/accounts/genesis.go (1)

83-88: The addition of a validation check for the account type in the importAccount method is a crucial improvement. This check ensures that only registered account types are processed, which aligns with the PR's objectives to enhance robustness and prevent errors during the genesis import process. The error message provided is clear and informative, aiding in debugging and user understanding.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@meetrick
Copy link
Contributor Author

meetrick commented Apr 16, 2024 •
edited
Loading

@julienrbrt I've submitted a new PR because the previous one(#20022) had a failing test due to inaccurate reasons and a base change. I'd appreciate it if you could review it. Thanks!

@julienrbrt julienrbrt added this pull request to the merge queue Apr 16, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 16, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Apr 16, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 16, 2024
@meetrick
Copy link
Contributor Author

@julienrbrt @sontrinh16
SonarCloud seems to be causing me to be removed from the merge queue, is there anything I can do to fix this?

@julienrbrt julienrbrt added this pull request to the merge queue Apr 16, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 16, 2024
@julienrbrt
Copy link
Member

@julienrbrt @sontrinh16

SonarCloud seems to be causing me to be removed from the merge queue, is there anything I can do to fix this?

It's not that, sonarcloud is disabled for external contributors and it isn't a required job.

@julienrbrt
Copy link
Member

julienrbrt commented Apr 16, 2024 •
edited
Loading

@julienrbrt @sontrinh16

SonarCloud seems to be causing me to be removed from the merge queue, is there anything I can do to fix this?

It's not that, sonarcloud is disabled for external contributors and it isn't a required job.

EDIT: mmh you are right, but that's not a step we have. Very weird. Maybe merge main.

@meetrick
Copy link
Contributor Author

meetrick commented Apr 16, 2024 •
edited
Loading

@julienrbrt @sontrinh16
SonarCloud seems to be causing me to be removed from the merge queue, is there anything I can do to fix this?

It's not that, sonarcloud is disabled for external contributors and it isn't a required job.

EDIT: mmh you are right, but that's not a step we have. Very weird. Maybe merge main.

That means there's nothing more I can do about it. I thought there might be something else I needed to do. Thanks
I'd appreciate it if you could put it back in the merge queue after some time, hopefully it's a temporary issue.

@sontrinh16 sontrinh16 added this pull request to the merge queue Apr 16, 2024
Merged via the queue into cosmos:main with commit 2301e5e Apr 16, 2024
59 of 60 checks passed
alpe added a commit that referenced this pull request Apr 17, 2024
@alpe
Merge branch 'main' into alex/system_tests_wip
af4ee9c 
* main:
  build(deps): Bump github.com/pelletier/go-toml/v2 from 2.2.0 to 2.2.1 in /tools/confix (#20052)
  build(deps): Bump cosmossdk.io/api from 0.7.3 to 0.7.4 (#20063)
  fix: secp256r1 json missing quotes (#20060)
  fix(x/accounts): remove double execute (#20065)
  refactor(x/accounts): Skip Importing Unregistered Genesis Account Types (#20053)
  refactor(x/simulation)!: remove accounts string (#20056)
  fix(baseapp): don't share global gas meter in tx execution (#19616)
  feat(x/accounts): use router service from env (#20003)
  refactor(x): remove Address.String() (#20048)
@meetrick meetrick deleted the 20240416 branch September 26, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sontrinh16 sontrinh16 sontrinh16 approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

Assignees

@julienrbrt julienrbrt

@sontrinh16 sontrinh16

Labels
C:x/accounts
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@meetrick @julienrbrt @sontrinh16