optim: shallow copy block header in Context #19966
Conversation
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.
WalkthroughThe recent update involves optimizing the server's handling of Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Review Status
Configuration used: .coderabbit.yml
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"
types/context.go
Outdated
| // 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 |
There was a problem hiding this comment.
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.
| // 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 |
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
BlockHeaderby shallow copy, enhancing data handling integrity.