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

optim: shallow copy block header in Context #19966

Merged
merged 5 commits into from
Apr 10, 2024
Merged

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Apr 5, 2024

the proto clone introduce significant memory allocations in our profiling, because the method is called multiple times for each transaction, and the deep clone seems unnesserary, the header is a plain struct without pointers inside (unless one that's in time.Time), a shallow value copy seems good enough.

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

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

  • Refactor
    • Updated the server module to return BlockHeader by shallow copy, enhancing data handling integrity.

the proto clone introduce significant memory allocations in our
profiling, because the method is called multiple times for each
transaction, and the deep clone seems unnesserary, the header is a plain
struct without pointers inside (unless one that's in time.Time), a shallow value copy seems good enough.
@yihuang yihuang requested a review from a team as a code owner April 5, 2024 07:44
Copy link
Contributor

coderabbitai bot commented Apr 5, 2024

Walkthrough

The recent update involves optimizing the server's handling of BlockHeader by returning it via shallow copy in the server context. This change aims to enhance efficiency by eliminating unnecessary cloning processes.

Changes

Files Change Summary
CHANGELOG.md, types/.../context.go Updated server module in CHANGELOG.md for BlockHeader return via shallow copy. Simplified BlockHeader method in context.go to directly return c.header, removing an import statement and cloning steps.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

CHANGELOG.md Outdated Show resolved Hide resolved
types/context.go Outdated Show resolved Hide resolved
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: 2

Review Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 558c950 and 20ee641.
Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • types/context.go (2 hunks)
Additional Context Used
Path-based Instructions (2)
types/context.go (1)

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

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

CHANGELOG.md Outdated Show resolved Hide resolved
types/context.go Outdated
Comment on lines 93 to 95
// BlockHeader returns the header is returned by value.
func (c Context) BlockHeader() cmtproto.Header {
msg := proto.Clone(&c.header).(*cmtproto.Header)
return *msg
return c.header
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding a comment explaining why a shallow copy is sufficient for BlockHeader.

func (c Context) BlockHeader() cmtproto.Header {
+  // Returning a shallow copy as block headers are largely composed of value types.
  return c.header
}

A brief comment here can help future maintainers understand the rationale behind this optimization, especially since the change from deep cloning to shallow copying could have implications on how the returned data is used.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
// BlockHeader returns the header is returned by value.
func (c Context) BlockHeader() cmtproto.Header {
msg := proto.Clone(&c.header).(*cmtproto.Header)
return *msg
return c.header
// BlockHeader returns the header is returned by value.
func (c Context) BlockHeader() cmtproto.Header {
// Returning a shallow copy as block headers are largely composed of value types.
return c.header

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

Review Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 20ee641 and 851bed5.
Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md

@tac0turtle tac0turtle added this pull request to the merge queue Apr 10, 2024
Merged via the queue into cosmos:main with commit a6f3fbf Apr 10, 2024
55 of 58 checks passed
@yihuang yihuang deleted the small-optim branch April 10, 2024 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants