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.

Sign up for GitHub

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

Jump to bottom

refactor(v7.4.x): performance improvements for update client in ante #6306

Merged
merged 7 commits into from
May 21, 2024
Merged

refactor(v7.4.x): performance improvements for update client in ante #6306

merged 7 commits into from
May 21, 2024

Conversation

damiannolan
Copy link
Member

Description

Ignore Misbehaviour types for solomachine and tendermint clients when calling UpdateState.

ref: #6232

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

@damiannolan
imp: add updateClientCheckTx to redunant relayer ante decorator (#6279)
fbef450 
* imp: add checkTxUpdateClient to redunant relayer ante decorator

* chore: update godoc and duplicate imports

* test: add coverage for checkTxUpdateClient func

* chore: rename ante func to updateClientCheckTx
@damiannolan
refactor: ignore misbehaviour types for UpdateState in ante handler
3a37e0e
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 14, 2024 •
edited

Important

Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

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

damiannolan
damiannolan commented May 14, 2024
View reviewed changes
modules/core/ante/ante.go Outdated
Comment on lines 124 to 133
// NOTE: the folowing avoids panics in ante handler client updates for ibc-go v7.4.x
// without state machine breaking changes within light client modules.
switch clientMsg.(type) {
case *solomachine.Misbehaviour:
// ignore solomachine misbehaviour for update state in ante
case *tendermint.Misbehaviour:
// ignore tendermint misbehaviour for update state in ante
default:
heights := clientState.UpdateState(ctx, rrd.k.Codec(), clientStore, clientMsg)
ctx.Logger().With("module", "x/"+exported.ModuleName).Debug("ante ibc client update", "consensusHeights", heights)
Copy link
Member Author

Choose a reason for hiding this comment

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

Better to explicitly ignore types that will panic rather than try to target types that will not?

Wasm clients should work against v7.x also, but they contain a single ClientMessage type with opaque bytes. Localhost isn't a concern here, and ignore clientMsg anyways.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yea, I think it's likely better to target types we know it is safe to ignore. This feels like an okay stop gap solution for a single release line

@damiannolan damiannolan changed the title refactor: performance improvements for update client in ante refactor(v7.4.x): performance improvements for update client in ante May 14, 2024
@damiannolan damiannolan marked this pull request as ready for review May 14, 2024 08:26
colin-axner
colin-axner approved these changes May 14, 2024
View reviewed changes
Copy link
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

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

Nice fix! ACK, but would be nice with test cases that would normally trigger the panic

modules/core/ante/ante.go Show resolved Hide resolved
@damiannolan damiannolan added the priority PRs that need prompt reviews label May 15, 2024
@colin-axner colin-axner requested a review from chatton May 20, 2024 13:54
@colin-axner colin-axner self-assigned this May 21, 2024
@colin-axner colin-axner marked this pull request as draft May 21, 2024 10:11
@colin-axner colin-axner removed their assignment May 21, 2024
@colin-axner colin-axner marked this pull request as ready for review May 21, 2024 10:12
chatton
chatton approved these changes May 21, 2024
View reviewed changes
Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM! looks good to merge once the linter errors are fixed.

@colin-axner colin-axner merged commit ee842be into release/v7.4.x May 21, 2024
14 checks passed
@colin-axner colin-axner deleted the dmian/update-client-checktx branch May 21, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colin-axner colin-axner colin-axner approved these changes

@chatton chatton chatton approved these changes

@AdityaSripal AdityaSripal Awaiting requested review from AdityaSripal AdityaSripal is a code owner

@crodriguezvega crodriguezvega Awaiting requested review from crodriguezvega crodriguezvega is a code owner

@DimitrisJim DimitrisJim Awaiting requested review from DimitrisJim

@charleenfei charleenfei Awaiting requested review from charleenfei

Assignees
No one assigned
Labels
priority PRs that need prompt reviews
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@damiannolan @chatton @colin-axner