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: bump cosmos-sdk - expedite proposals support #1970

Merged
merged 4 commits into from
Jun 20, 2024

Conversation

MSalopek
Copy link
Contributor

@MSalopek MSalopek commented Jun 17, 2024

Please go to the Preview tab and select the appropriate sub-template:

  • Production code - for types fix, feat, and refactor.
  • Docs - for documentation changes.
  • Others - for changes that do not affect production code.

Summary by CodeRabbit

  • New Features

    • Introduced an expedited voting period of "10 seconds" in multiple test configurations.
  • Bug Fixes

    • Updated proposal submission functions to include an additional parameter for expedited proposals.
  • Dependency Updates

    • Upgraded github.com/cosmos/cosmos-sdk from v0.47.12 to v0.47.16-ics-lsm.
  • Tests

    • Adjusted test cases to align with the new expedited proposal parameter.
    • Enhanced TestGovKeeper interface with a new expedited parameter for proposal submission.

Copy link
Contributor

coderabbitai bot commented Jun 17, 2024

Walkthrough

Walkthrough

The updates primarily revolve around introducing an additional boolean parameter, false, to the NewMsgSubmitProposal and SubmitProposal function calls across various files. This enhancement ensures that the proposal creation functions can handle expedited voting scenarios. Additionally, there are updates to configuration settings, particularly the addition of an expedited_voting_period parameter in the e2e testing configurations, and version updates for the github.com/cosmos/cosmos-sdk dependency.

Changes

Files Change Summary
app/consumer-democracy/ante/forbidden_proposals_ante_test.go Added false as an additional argument to the NewMsgSubmitProposal function calls for newLegacyParamChangeProposalMsg and newParamChangeProposalMsg.
go.mod Updated github.com/cosmos/cosmos-sdk version from v0.47.12 to v0.47.16-ics-lsm.
tests/e2e/config.go Added expedited_voting_period set to "10s" in the app_state.gov.params section for multiple test configurations.
tests/integration/democracy.go Updated submitProposalWithDepositAndVote function to include an additional false argument in govKeeper.SubmitProposal calls.
testutil/integration/interfaces.go Modified the SubmitProposal method in the TestGovKeeper interface to include an expedited bool parameter.
x/ccv/provider/client/proposal_handler.go Added an additional boolean parameter false to the NewMsgSubmitProposal function call in the proposal_handler.go file.
x/ccv/provider/keeper/hooks.go The functions in Hooks struct were updated to return an error type.
x/ccv/provider/keeper/hooks_test.go Updated test functions to include an additional false parameter when calling specific functions.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ec6ea32 and 95fcd94.

Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
Files selected for processing (8)
  • app/consumer-democracy/ante/forbidden_proposals_ante_test.go (1 hunks)
  • go.mod (1 hunks)
  • tests/e2e/config.go (4 hunks)
  • tests/integration/democracy.go (1 hunks)
  • testutil/integration/interfaces.go (1 hunks)
  • x/ccv/provider/client/proposal_handler.go (4 hunks)
  • x/ccv/provider/keeper/hooks.go (1 hunks)
  • x/ccv/provider/keeper/hooks_test.go (2 hunks)
Files skipped from review due to trivial changes (2)
  • go.mod
  • x/ccv/provider/keeper/hooks.go
Additional context used
Path-based instructions (6)
app/consumer-democracy/ante/forbidden_proposals_ante_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/ccv/provider/keeper/hooks_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"

testutil/integration/interfaces.go (1)

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

tests/integration/democracy.go (2)

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


Pattern tests/integration/*: "Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request"

x/ccv/provider/client/proposal_handler.go (1)

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

tests/e2e/config.go (2)

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


Pattern tests/e2e/*: "Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (14)
app/consumer-democracy/ante/forbidden_proposals_ante_test.go (2)

190-190: LGTM! Ensure that the new expedited parameter is consistently set to false as intended across all relevant tests.


195-195: LGTM! Consistency in setting the expedited parameter to false is maintained.

x/ccv/provider/keeper/hooks_test.go (2)

111-111: LGTM! The inclusion of the expedited parameter with a consistent value of false aligns with the PR's objectives.


206-206: LGTM! Consistency in setting the expedited parameter to false is maintained.

testutil/integration/interfaces.go (1)

159-159: LGTM! The addition of the expedited parameter in the SubmitProposal method is correctly implemented and aligns with the PR's objectives.

tests/integration/democracy.go (1)

236-236: LGTM! The inclusion of the expedited parameter with a consistent value of false aligns with the PR's objectives.

x/ccv/provider/client/proposal_handler.go (4)

110-110: The addition of the expedited parameter in NewMsgSubmitProposal aligns with the new requirements for supporting expedited proposals. Ensure that this new parameter is documented and tested appropriately.


166-166: The consistent use of the expedited parameter in NewMsgSubmitProposal across different proposal types helps maintain uniformity. It's important to verify this change integrates well with the broader system where these proposals are processed.


230-230: As with other proposal types, the addition of the expedited parameter here is consistent. Continue to ensure that all parts of the system that handle these proposals are updated to accommodate this new parameter.


287-287: The addition of the expedited parameter here ensures that all types of proposals can be expedited if necessary. It's crucial to test this functionality thoroughly to ensure it behaves as expected under various scenarios.

tests/e2e/config.go (4)

376-376: The addition of expedited voting period in the SlashThrottleTestConfig is consistent with the PR's objectives to support expedited proposals. Ensure this setting is appropriately tested for its impact on governance.


647-648: The expedited voting period addition in MultiConsumerTestConfig should be tested across multiple consumer chains to ensure that the governance changes propagate correctly.


708-709: In ChangeoverTestConfig, the expedited voting period has been added. This is crucial for testing how governance changes are handled during a chain changeover. It's important to ensure that this configuration does not disrupt the changeover process.


525-525: The expedited voting period setting in the DefaultTestConfig is correctly implemented. Verify that the new configuration works as expected in the default testing scenario.


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 as 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.

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.

@github-actions github-actions bot added C:Testing Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler labels Jun 17, 2024
@MSalopek MSalopek changed the base branch from release/v4.2.x-lsm to release/v4.3.x-lsm June 20, 2024 12:23
@MSalopek MSalopek force-pushed the masa/gov-expedited-v47-interfaces branch from a333255 to 74dcf6e Compare June 20, 2024 12:28
@MSalopek MSalopek marked this pull request as ready for review June 20, 2024 12:35
@MSalopek MSalopek requested a review from a team as a code owner June 20, 2024 12:35
@MSalopek MSalopek changed the title deps: bump cosmos-sdk - expedite proposals support feat: bump cosmos-sdk - expedite proposals support Jun 20, 2024
@MSalopek MSalopek merged commit 1c6d11f into release/v4.3.x-lsm Jun 20, 2024
16 of 18 checks passed
@MSalopek MSalopek deleted the masa/gov-expedited-v47-interfaces branch June 20, 2024 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Testing Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants