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(server/v2): inject latest height when not provide in grpc query #23483

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Jan 23, 2025

Description

Closes: #23481


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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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
    • Optimized query method execution order in the consensus handling logic
    • Adjusted gRPC query processing sequence to improve potential performance

The changes focus on internal query processing mechanics without altering the core functionality or public interfaces of the system.

@mmsqe mmsqe requested a review from a team as a code owner January 23, 2025 04:25
Copy link
Contributor

coderabbitai bot commented Jan 23, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the Query method in the server/v2/cometbft/abci.go file, specifically changing the placement of the maybeRunGRPCQuery call. The change moves the gRPC query handling logic before the height check, potentially addressing an issue with querying the most recent height when the height is set to 0. The overall structure and functionality of the method remain consistent, with only the order of operations being adjusted.

Changes

File Change Summary
server/v2/cometbft/abci.go Reordered maybeRunGRPCQuery call to precede height check in the Query method

Assessment against linked issues

Objective Addressed Explanation
Fix ABCI Query with height: 0 not returning most recent height [#23481]

Possibly related PRs

Suggested labels

C:server/v2, C:server/v2 cometbft, backport/v0.52.x

Suggested reviewers

  • facundomedica
  • sontrinh16
  • julienrbrt
  • tac0turtle
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added C:server/v2 Issues related to server/v2 C:server/v2 cometbft labels Jan 23, 2025
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

🧹 Nitpick comments (1)
server/v2/cometbft/abci.go (1)

187-191: Consider adding error handling for gRPC response.

While the placement is correct, we should handle potential errors in the gRPC response before proceeding with other query paths.

 	resp, isGRPC, err := c.maybeRunGRPCQuery(ctx, req)
 	if isGRPC {
+		if err != nil {
+			return queryResult(err, c.cfg.AppTomlConfig.Trace), nil
+		}
 		return resp, err
 	}

Also applies to: 192-224

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3860b2b and 33da8a2.

📒 Files selected for processing (1)
  • server/v2/cometbft/abci.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
server/v2/cometbft/abci.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: Summary
🔇 Additional comments (2)
server/v2/cometbft/abci.go (2)

187-191: LGTM! The placement of maybeRunGRPCQuery is correct.

Moving the gRPC query handling before other logic ensures that gRPC queries get the latest height injection benefit.


187-191: Verify error handling in upstream gRPC clients.

The change in query height injection behavior might affect upstream clients that explicitly set height to 0 expecting different behavior.

Also applies to: 192-224

✅ Verification successful

No evidence of upstream gRPC clients relying on height=0 behavior

After thorough analysis of the codebase, no actual gRPC client implementations were found that explicitly set height to 0 or use WithHeight(0). The only height=0 usage found is in app export functionality, which is unrelated to gRPC queries.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for gRPC client code that might be affected by the height injection change
rg -l 'WithHeight\(0\)' || rg -l '\.Height\s*=\s*0'

Length of output: 1168


Script:

#!/bin/bash
# Search for actual client usage of height=0 in queries
# Exclude generated files and focus on test/client code
rg -g '!*.pb.go' -g '!*.pulsar.go' 'WithHeight\(0\)|\.Height\s*=\s*0' -A 3 -B 3

Length of output: 369

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.

Ok, i see, appmanager was supposed to do it:

_, queryState, err = a.db.StateLatest()
, so it did return the right value, however resp.Height was left not updated.

@julienrbrt julienrbrt added this pull request to the merge queue Jan 23, 2025
Merged via the queue into cosmos:main with commit 9fdcd6d Jan 23, 2025
70 of 75 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:server/v2 cometbft C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: ABCI Query to CometRPC with height: 0 does not query most recent height
2 participants