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

refactor(auth): Remove IterateAccounts method from x/auth keeper #19363

Merged
merged 3 commits into from
Feb 6, 2024

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Feb 6, 2024

Description

Removes IterateAccounts + GetAllAccounts methods from the AccountKeeper interface and Keeper. So when we add x/accounts support we do not need to merge x/accounts and auth accounts together.


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

  • Refactor

    • Enhanced error handling for account export and initialization processes.
    • Simplified account iteration logic by removing and refactoring specific methods for efficiency and reliability.
  • Tests

    • Improved test coverage by introducing error checks in account initialization and iteration tests.
  • Chores

    • Streamlined the account keeper interface by removing redundant methods across multiple modules, aligning with the new iteration approach.

@testinginprod testinginprod requested a review from a team as a code owner February 6, 2024 14:32
Copy link
Contributor

coderabbitai bot commented Feb 6, 2024

Warning

Rate Limit Exceeded

@testinginprod has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 24 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 Files that changed from the base of the PR and between 85920f3 and 5cadab5.

Walkthrough

The changes focus on enhancing error handling and account iteration within the authentication module. The refactoring involves replacing GetAllAccounts with IterateAccounts using Walk internally for iterating over accounts. Error handling improvements were made in functions related to genesis state initialization and export, ensuring better error management for a more robust codebase.

Changes

File(s) Change Summary
x/auth/keeper/account.go,
x/auth/keeper/keeper_test.go
Refactored GetAllAccounts to use IterateAccounts with Walk.
x/auth/keeper/genesis.go,
x/auth/module.go
Added error handling in InitGenesis and ExportGenesis functions for AccountKeeper.
x/auth/keeper/keeper.go,
x/bank/types/expected_keepers.go,
x/genutil/types/expected_keepers.go,
x/staking/types/expected_keepers.go
Removed IterateAccounts method from the AccountKeeper interface in various packages.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between c91660e and d9af3bf.
Files selected for processing (9)
  • tests/integration/gov/genesis_test.go (1 hunks)
  • x/auth/keeper/account.go (2 hunks)
  • x/auth/keeper/genesis.go (3 hunks)
  • x/auth/keeper/keeper.go (1 hunks)
  • x/auth/keeper/keeper_test.go (4 hunks)
  • x/auth/module.go (1 hunks)
  • x/bank/types/expected_keepers.go (1 hunks)
  • x/genutil/types/expected_keepers.go (1 hunks)
  • x/staking/types/expected_keepers.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • x/auth/keeper/keeper.go

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.

can we get an api breaking changelog in x/auth/changelog please?

@testinginprod
Copy link
Contributor Author

can we get an api breaking changelog in x/auth/changelog please?

Will add, was testing CI for failures since I get nothing locally but a lot of things break on CI .. :\

@testinginprod testinginprod mentioned this pull request Feb 6, 2024
44 tasks
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between d9af3bf and 85920f3.
Files selected for processing (1)
  • x/slashing/types/expected_keepers.go (1 hunks)
Additional comments: 4
x/slashing/types/expected_keepers.go (4)
  • 15-20: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [12-14]

The AccountKeeper interface no longer includes IterateAccounts, aligning with the PR's objective to streamline account iteration. Ensure all implementations and usages of AccountKeeper across the Cosmos SDK are updated to reflect this change.

  • 15-20: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [15-49]

The remaining methods in AccountKeeper and BankKeeper interfaces are unaffected by the removal of IterateAccounts. Confirm that the removal does not impact the logic or functionality of these methods indirectly, especially in modules that might have relied on account iteration for certain operations.

  • 15-20: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [50-92]

The StakingKeeper interface remains unchanged in this file. Verify that the removal of IterateAccounts from AccountKeeper does not affect any staking-related operations, particularly those that might involve account information or iteration indirectly.

  • 15-20: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [93-109]

The StakingHooks interface is also unaffected directly by the removal of IterateAccounts. However, ensure that any logic within the staking module that might have depended on account iteration through AccountKeeper is reviewed and updated as necessary.

@testinginprod testinginprod added this pull request to the merge queue Feb 6, 2024
Merged via the queue into main with commit e604e54 Feb 6, 2024
66 of 67 checks passed
@testinginprod testinginprod deleted the tip/auth/remove_iterate_accounts branch February 6, 2024 23:33
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.

3 participants