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

fix: Set headerInfo in context on setState #19338

Merged
merged 2 commits into from
Feb 3, 2024

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Feb 2, 2024

Description

Add header info to context in setState, so it's available more consistently (it wasn't available on checkTx). The only missing field is Hash which we don't always have.


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

  • Bug Fixes
    • Fixed a bug related to pointer usage in logs in OE goroutines and the DefaultProposalHandler function.
  • Refactor
    • Enhanced internal state management in the app for better performance and reliability.

@facundomedica facundomedica requested a review from a team as a code owner February 2, 2024 17:35
Copy link
Contributor

coderabbitai bot commented Feb 2, 2024

Walkthrough

Walkthrough

The modification involves enhancing the BaseApp structure within a blockchain application framework. It introduces a new import to leverage the cosmossdk.io/core/header package and refines the setState method. The method's parameter name is changed for clarity, and a new structure, headerInfo, is initialized with critical blockchain metadata (height, time, chain ID, and app hash) to update the baseState context more effectively with the latest header information. Additionally, a bug fix in the baseapp module (#19338) addresses issues related to pointer usage in logs and corrects the behavior of the DefaultProposalHandler.

Changes

File Change Summary
baseapp/baseapp.go Introduced import for cosmossdk.io/core/header. Updated setState method to use h parameter and initialize headerInfo with blockchain metadata for context update. Bug fix (#19338) ensures HeaderInfo is set in context, fixing pointer usage in logs and improving DefaultProposalHandler.

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 comments 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

This comment has been minimized.

@@ -78,6 +78,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i

### Bug Fixes

* (baseapp) [#19338](https://github.com/cosmos/cosmos-sdk/pull/19338) Set HeaderInfo in context when calling `setState`.
Copy link
Contributor

Choose a reason for hiding this comment

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

The changelog entry for PR #19338 correctly links to the PR and succinctly describes the change. However, it lacks detail on the impact of the change or the problem it solves. While this is acceptable for a changelog, ensuring that entries provide enough context for understanding the significance of the change without needing to visit the PR could enhance clarity.

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Feb 3, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm

@facundomedica facundomedica added this pull request to the merge queue Feb 3, 2024
Merged via the queue into main with commit d353f11 Feb 3, 2024
58 of 61 checks passed
@facundomedica facundomedica deleted the facu/add-headerinfo-setsate branch February 3, 2024 14:50
mergify bot pushed a commit that referenced this pull request Feb 3, 2024
(cherry picked from commit d353f11)

# Conflicts:
#	CHANGELOG.md
#	baseapp/baseapp.go
facundomedica added a commit that referenced this pull request Feb 5, 2024
Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
Co-authored-by: Facundo <facundomedica@gmail.com>
@julienrbrt julienrbrt mentioned this pull request Feb 6, 2024
12 tasks
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants