fix(baseapp): fulfil all header.Info fields in test helpers context #23014
Conversation
damiannolan
requested review from
facundomedica,
aaronc,
testinginprod,
kocubinski and
a team
as code owners
📝 WalkthroughWalkthroughThe pull request modifies the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
| @@ -64,11 +65,15 @@ func (app *BaseApp) NewContext(isCheckTx bool) sdk.Context { | |||
| } | |||
|
|
|||
| func (app *BaseApp) NewUncachedContext(isCheckTx bool, header cmtproto.Header) sdk.Context { | |||
| cmtHeader, _ := cmttypes.HeaderFromProto(&header) | |||
There was a problem hiding this comment.
I think its fine to discard error here. If you pass a bad header that's your own fault imo.
Calling cmtHeader.Hash() on nil will produce nil - https://github.com/cometbft/cometbft/blob/main/types/block.go#L447-L449
|
Let me know if you want me to replicate in |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
baseapp/test_helpers.go (1)
72-76: LGTM: Proper population of header.Info fieldsThe changes properly populate all required fields from the converted header, which addresses the issue of random test failures mentioned in the PR objectives. The fields are populated in a logical order and include all necessary information:
- AppHash
- Hash (computed)
- ChainID
- Height
- Time
Consider adding a comment explaining why we need to convert the header:
// Convert to cmttypes.Header to access computed fields like Hash() cmtHeader, err := cmttypes.HeaderFromProto(&header)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
baseapp/test_helpers.go(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
baseapp/test_helpers.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (1)
baseapp/test_helpers.go (1)
5-5: LGTM: Import statement follows conventions
The new import for cmttypes is properly placed and follows the Go conventions.
julienrbrt
added
the
backport/v0.52.x
…backport #23014) (#23016) Co-authored-by: Damian Nolan <[email protected]>
Description
Just passing through... noticed along my ways.
I think its best to fulfil all fields here in
header.Info. It can cause random failures for tests which rely on theNewUncachedContext()func.I was migrating code to use services and as it still unwraps context for underlying fields we can run into some scenarios where
header.Infohas empty/unset fields.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.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
New Features
Bug Fixes