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

fix!: address minor bugs during main upgrade to SDK v50 #2067

Merged
merged 3 commits into from
Jul 19, 2024

Conversation

sainoe
Copy link
Contributor

@sainoe sainoe commented Jul 19, 2024

This PR addresses minor bugs introduced by the main PR upgrade to SDK v50, consisting of a lost one-liner in StopConsumerChain() and a broken e2e-test.

Description

Closes: #XXXX


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
  • Added ! to the type prefix if the change is state-machine breaking
  • Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
  • Targeted the correct branch (see PR Targeting)
  • Provided a link to the relevant issue or specification
  • Followed the guidelines for building SDK modules
  • Included the necessary unit and integration tests
  • Added a changelog entry to CHANGELOG.md
  • Included comments for documenting Go code
  • Updated the relevant documentation or specification
  • Reviewed "Files changed" and left comments if necessary
  • Confirmed all CI checks have passed
  • If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

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 ! the type prefix if the change is state-machine breaking
  • confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage

Summary by CodeRabbit

  • New Features
    • Introduced a new configuration parameter for expedited voting periods in testing.
    • Enhanced the cleanup process in the consumer chain shutdown logic.
  • Bug Fixes
    • Adjusted the return order of client frozen height values for better clarity.
  • Tests
    • Improved test coverage with additional assertions to ensure correct behavior after stopping the consumer chain.
    • Refactored tests for better readability and maintainability.

@sainoe sainoe requested a review from a team as a code owner July 19, 2024 08:19
Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Walkthrough

Walkthrough

This set of changes enhances the testing and operational capabilities of a consumer chain system. Key modifications include the introduction of an expedited voting period in the test configuration, a reordering of return values in a state retrieval function, the addition of assertions in unit tests for better validation, and improvements to the consumer chain stop process by cleaning up equivocation evidence.

Changes

Files Change Summary
tests/e2e/config.go Added expedited_voting_period to ConsumerMisbehaviourTestConfig for testing expedited voting scenarios.
tests/e2e/state.go Changed return order in GetClientFrozenHeight function from (revHeight, revNumber) to (revNumber, revHeight) affecting the semantic interpretation.
testutil/keeper/unit_test_helpers.go Enhanced TestProviderStateIsCleanedAfterConsumerChainIsStopped with a new assertion to check minimum height for equivocation evidence is zero.
x/ccv/provider/keeper/proposal.go Added a call to DeleteEquivocationEvidenceMinHeight in StopConsumerChain to improve cleanup during consumer chain shutdown.
x/ccv/provider/keeper/proposal_test.go Introduced consumerCID variable for readability in TestStopConsumerChain and updated setup to set the minimum equivocation height for the consumer chain.

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 Configuration 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 Jul 19, 2024
@sainoe sainoe changed the title fix!: address minor bugs during main upgrade to v50 fix!: address minor bugs during main upgrade to SDK v50 Jul 19, 2024
Copy link
Contributor

@MSalopek MSalopek left a comment

Choose a reason for hiding this comment

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

LGTM

@sainoe sainoe added this pull request to the merge queue Jul 19, 2024
Merged via the queue into main with commit 5c65a15 Jul 19, 2024
18 of 19 checks passed
@sainoe sainoe deleted the sainoe/main-upgrade-v50-fix branch July 19, 2024 09:30
mergify bot pushed a commit that referenced this pull request Jul 19, 2024
* fix consumer misb e2e test and mistakenly removed line during main upgrade to v50

* update UT

* godoc

(cherry picked from commit 5c65a15)
MSalopek pushed a commit that referenced this pull request Jul 19, 2024
…) (#2069)

fix!: address minor bugs during main upgrade to SDK v50 (#2067)

* fix consumer misb e2e test and mistakenly removed line during main upgrade to v50

* update UT

* godoc

(cherry picked from commit 5c65a15)

Co-authored-by: Simon Noetzlin <[email protected]>
insumity pushed a commit that referenced this pull request Jul 23, 2024
* fix consumer misb e2e test and mistakenly removed line during main upgrade to v50

* update UT

* godoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v5.2.x 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.

3 participants