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

feat(x/authz): add limits to grant pruning and enable message to aid manually #18737

Merged
merged 6 commits into from
Dec 15, 2023

Conversation

julienrbrt
Copy link
Member

Description

A-3

Replicates #18047 for x/authz.


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

@julienrbrt julienrbrt marked this pull request as ready for review December 14, 2023 15:14
@julienrbrt julienrbrt requested a review from a team as a code owner December 14, 2023 15:14
Copy link
Contributor

coderabbitai bot commented Dec 14, 2023

Walkthrough

The Cosmos authz module has been updated to introduce a new feature for pruning expired grants. This includes a new PruneExpiredGrants RPC method, related message types, and updates to existing functions to handle a limit on the number of grants pruned per operation. The keeper logic, module behavior, and test cases have been updated accordingly. A new message type, MsgPruneExpiredGrants, is also added for maintenance purposes to automate the cleanup process.

Changes

Files Change Summary
api/cosmos/authz/v1beta1/event.pulsar.go
proto/cosmos/authz/v1beta1/event.proto
Added EventPruneExpiredGrants, updated EventGrant and EventRevoke with version information in comments.
proto/cosmos/authz/v1beta1/tx.proto Introduced new RPC method PruneExpiredGrants and related message types since x/authz v1.0.0.
x/authz/CHANGELOG.md
x/authz/README.md
x/authz/module/abci.go
Documented the pruning limit of 200 grants per BeginBlock and the new MsgPruneExpiredGrants message that prunes 75 expired grants. Updated BeginBlocker function to handle the pruning limit.
x/authz/keeper/keeper.go
x/authz/keeper/keeper_test.go
Modified DequeueAndDeleteExpiredGrants function to accept a limit parameter and updated tests to reflect this change.
x/authz/keeper/msg_server.go
x/authz/keeper/msg_server_test.go
Added new PruneExpiredGrants method to the Keeper type and related test scenarios.
x/authz/module/autocli.go Added new "PruneExpiredGrants" RPC method to AutoCLIOptions.

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 X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

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

x/authz/module/abci.go Show resolved Hide resolved
x/authz/README.md Show resolved Hide resolved
x/authz/keeper/msg_server.go Outdated Show resolved Hide resolved
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

LGTM! I just have 1 question

x/authz/keeper/msg_server.go Show resolved Hide resolved
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

utACK

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

LGTM

@julienrbrt julienrbrt enabled auto-merge December 15, 2023 17:48
Comment on lines +127 to +128
sdkCtx := sdk.UnwrapSDKContext(ctx)
_ = sdkCtx.EventManager().EmitTypedEvent(&authz.EventPruneExpiredGrants{Pruner: msg.Pruner})
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider checking for errors when emitting events with EmitTypedEvent. Even though it's not common for this function to return an error, handling the error can be important for auditing and debugging purposes, ensuring that all events are emitted successfully or that failures are noted.

sdkCtx := sdk.UnwrapSDKContext(ctx)
if err := sdkCtx.EventManager().EmitTypedEvent(&authz.EventPruneExpiredGrants{Pruner: msg.Pruner}); err != nil {
    return nil, err
}

@julienrbrt julienrbrt added this pull request to the merge queue Dec 15, 2023
Merged via the queue into main with commit 0ba62db Dec 15, 2023
59 of 60 checks passed
@julienrbrt julienrbrt deleted the julien/authz branch December 15, 2023 17:57
MSalopek added a commit to informalsystems/cosmos-sdk that referenced this pull request Jan 31, 2024
This is a partial backport of cosmos#18737.

Txs and events were not migrated.

AutoCLI was not migrated because it does not exist on v47.
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.

4 participants