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

perf: Speedup one JSON unmarshal #8398

Merged
merged 2 commits into from
Jun 17, 2024
Merged

Conversation

ValarDragon
Copy link
Member

Speedup one JSON unmarshal being hit in production codepath

@ValarDragon ValarDragon added V:state/compatible/backport State machine compatible PR, should be backported A:backport/v25.x backport patches to v25.x branch labels Jun 17, 2024
Copy link
Contributor

coderabbitai bot commented Jun 17, 2024

Walkthrough

In this update, the codebase for ibc_module.go was optimized by replacing the use of a more complex transfertypes.FungibleTokenPacketData with a simpler receiverParser struct to validate receiver addresses. Additionally, JSON unmarshalling overhead is reduced, improving performance. The CHANGELOG.md was also updated to reflect these enhancements and other adjustments like the throttle timeout change for version v25.0.3.

Changes

File Change Summary
x/ibc-rate-limit/ibc_module.go Removed transfertypes import; introduced receiverParser struct; updated validation logic
CHANGELOG.md Added notes about JSON unmarshalling improvement (PR #8398) and throttle timeout change (PR #8329)

Poem

In code's vast sea, a shift so grand,
Validation now with a lighter hand.
Throttles refined, in change's embrace,
Performance tuned, we found our pace.
A rabbit's joy, in lines of lore,
🐇 Hopping forward, forevermore! 🚀


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 39ac9d9 and 969adc0.

Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Additional context used
Markdownlint
CHANGELOG.md

1075-1075: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1087-1087: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1096-1096: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1101-1101: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1153-1153: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


414-414: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading


677-677: null (MD034, no-bare-urls)
Bare URL used


735-735: null (MD034, no-bare-urls)
Bare URL used


1316-1316: null (MD042, no-empty-links)
No empty links

Additional comments not posted (1)
CHANGELOG.md (1)

55-56: The entry for pull request #8398 correctly documents the reduction in JSON unmarshalling overhead in IBC packet logic.


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.

@ValarDragon ValarDragon merged commit 837b58c into main Jun 17, 2024
1 check passed
@ValarDragon ValarDragon deleted the dev/speedup_one_json_unmarshal branch June 17, 2024 15:17
mergify bot pushed a commit that referenced this pull request Jun 17, 2024
* Speedup one JSON unmarshal

* Update changelog

(cherry picked from commit 837b58c)

# Conflicts:
#	x/ibc-rate-limit/ibc_module.go
@coderabbitai coderabbitai bot mentioned this pull request Oct 8, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v25.x backport patches to v25.x branch V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant