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: decouple comet from modules #21382

Merged
merged 20 commits into from
Sep 11, 2024
Merged

refactor: decouple comet from modules #21382

merged 20 commits into from
Sep 11, 2024

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Aug 22, 2024

Description

Figure already did for gov, so let just clean up other module as well, i'll make different PR for gov audit


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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

  • New Features

    • Removed deprecated historical information querying functionalities from the staking module.
    • Introduced a new GenesisValidator struct for improved validator data representation.
  • Bug Fixes

    • Streamlined mock client implementations for testing, enhancing clarity and efficiency.
  • Documentation

    • Updated dependency declarations in go.mod files to clarify indirect dependencies.
  • Refactor

    • Simplified event handling in the group module's test suite.
    • Enhanced the test suite setup by removing unnecessary dependencies and improving mock client interactions.

Copy link
Contributor

coderabbitai bot commented Aug 22, 2024

Walkthrough

Walkthrough

The changes involve the removal of deprecated features related to historical information querying in the staking module, including associated types, methods, and tests. The ExportAppStateAndValidators function has been modified to enhance validator data representation. Additionally, several mock client implementations have been updated for improved testing capabilities. Dependency management has been refined across multiple modules, indicating a shift towards indirect dependencies for certain packages.

Changes

Files Change Summary
api/cosmos/staking/v1beta1/query.pulsar.go Removed QueryHistoricalInfoRequest and QueryHistoricalInfoResponse types and their methods.
simapp/export.go Modified ExportAppStateAndValidators to return a slice of cmttypes.GenesisValidator.
tests/integration/staking/keeper/grpc_query_test.go Removed TestGRPCQueryHistoricalInfo test for deprecated endpoint.
testutil/cli/cmt_mocks.go Renamed NewMockCometRPCWithValue to NewMockCometRPCWithResponseQueryValue; added new struct and methods for transaction search.
x/accounts/cli/cli_test.go Updated mock client instantiation to use new method for better response handling.
x/auth/ante/testutil_test.go Changed mock client instantiation method for improved response structure.
x/bank/go.mod Added // indirect comment to cometbft dependency.
x/feegrant/go.mod Added // indirect comment to cometbft dependencies.
x/gov/go.mod Added // indirect comment to cometbft dependency.
x/group/go.mod Removed direct dependencies on cometbft and added them to indirect require block.
x/staking/genesis.go Introduced new GenesisValidator struct and updated WriteValidators function.
x/staking/keeper/grpc_query.go Removed HistoricalInfo function from Querier struct.
x/staking/proto/cosmos/staking/v1beta1/query.proto Removed HistoricalInfo RPC method and associated message types.
x/staking/proto/cosmos/staking/v1beta1/staking.proto Removed HistoricalInfo and ValidatorUpdates message definitions.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant StakingModule
    participant SimApp
    participant MockRPC

    Client->>StakingModule: Request for validator info
    StakingModule->>SimApp: Call ExportAppStateAndValidators
    SimApp->>MockRPC: Use NewMockCometRPCWithResponseQueryValue
    MockRPC-->>SimApp: Return validator data
    SimApp-->>StakingModule: Return processed validators
    StakingModule-->>Client: Send validator info response
Loading

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cbe12da and 3011f8a.

Files selected for processing (2)
  • types/genesis.go (1 hunks)
  • x/genutil/client/cli/gentx_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/genutil/client/cli/gentx_test.go
Additional context used
Path-based instructions (1)
types/genesis.go (1)

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

Additional comments not posted (1)
types/genesis.go (1)

5-10: LGTM!

The GenesisValidator struct follows the Uber Go Style Guide:

  • Struct name is in CamelCase format.
  • Field names are in CamelCase format.
  • Field types are specified.
  • Struct is well-documented with a clear purpose.

The code changes are approved.


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.
    • @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 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.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Aug 23, 2024
@sontrinh16 sontrinh16 changed the title refactor(x/gov): audit gov module refactor: decouple comet from modules Aug 27, 2024
@sontrinh16 sontrinh16 marked this pull request as ready for review September 7, 2024 16:03
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: 0

Outside diff range and nitpick comments (1)
x/auth/ante/testutil_test.go (1)

119-119: Changes to the test suite setup look good!

The modifications to the WithClient method's argument and the removal of the abci import suggest a shift in the mock client setup and a move towards reducing direct dependencies.

These changes likely affect the behavior of the tests by altering the expected response structure. It would be helpful to understand the rationale behind these changes and any additional context.

Could you please provide some insights into the motivation behind these changes and how they impact the overall test suite? This will help maintain a clear understanding of the test setup for future reference.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ae68ee1 and cbe12da.

Files selected for processing (6)
  • x/auth/ante/testutil_test.go (2 hunks)
  • x/bank/go.mod (1 hunks)
  • x/feegrant/go.mod (2 hunks)
  • x/gov/go.mod (1 hunks)
  • x/group/go.mod (2 hunks)
  • x/staking/go.mod (1 hunks)
Files skipped from review due to trivial changes (3)
  • x/feegrant/go.mod
  • x/gov/go.mod
  • x/staking/go.mod
Files skipped from review as they are similar to previous changes (2)
  • x/bank/go.mod
  • x/group/go.mod
Additional context used
Path-based instructions (1)
x/auth/ante/testutil_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"

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.

love the cleanup

@sontrinh16 sontrinh16 added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit 1d4ecd5 Sep 11, 2024
80 of 81 checks passed
@sontrinh16 sontrinh16 deleted the son/gov_audit branch September 11, 2024 09:29
mergify bot pushed a commit that referenced this pull request Sep 11, 2024
(cherry picked from commit 1d4ecd5)

# Conflicts:
#	api/cosmos/staking/v1beta1/query.pulsar.go
#	api/cosmos/staking/v1beta1/query_grpc.pb.go
#	api/cosmos/staking/v1beta1/staking.pulsar.go
#	x/feegrant/go.mod
#	x/group/go.mod
#	x/staking/go.mod
@julienrbrt
Copy link
Member

julienrbrt commented Sep 11, 2024

We actually need to revert the proto breakage here, due to the breakage in api.
We should just mark them as deprecated from 0.54

@sontrinh16
Copy link
Member Author

We actually need to revert the proto breakage here, due to the breakage in api. We should just mark them as deprecated from 0.54

gotcha i'll add it back

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