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.

Sign up for GitHub

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

Jump to bottom

feat(baseapp)!: Indicate pruning with "not found" rather than "invalid request" #19993

Merged
merged 1 commit into from
Apr 10, 2024
Merged

feat(baseapp)!: Indicate pruning with "not found" rather than "invalid request" #19993

merged 1 commit into from
Apr 10, 2024

Conversation

gibson042
Copy link
Contributor

@gibson042 gibson042 commented Apr 9, 2024 •
edited
Loading

Description

Closes: #19992

Updates baseapp.go to respond to queries with a "not found" error code rather than "invalid request" when the specified height has been pruned.

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 (but please confirm that "API Breaking Changes" is in fact correct)
  • 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 (but more tailored testing would be better)
  • 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

@gibson042 gibson042 requested a review from a team as a code owner April 9, 2024 19:31
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 9, 2024 •
edited
Loading

Walkthrough

Walkthrough

The modification in the abci.go file addresses an error handling refinement by changing the error type from ErrInvalidRequest to ErrNotFound in the CreateQueryContext function. This alteration aims to provide more accurate error feedback for queries to pruned heights, enhancing the clarity of error responses for users and developers.

Changes

File(s) Change Summary
baseapp/abci.go Updated error type from ErrInvalidRequest to ErrNotFound in CreateQueryContext function.

Assessment against linked issues

Objective Addressed Explanation
Correct error code for querying pruned heights (#19992) ✅

Possibly related issues

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.

coderabbitai[bot]
coderabbitai bot reviewed Apr 9, 2024
View reviewed changes
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: 1

baseapp/abci.go
@@ -1242,7 +1242,7 @@ func (app *BaseApp) CreateQueryContext(height int64, prove bool) (sdk.Context, e
if err != nil {
return sdk.Context{},
errorsmod.Wrapf(
sdkerrors.ErrInvalidRequest,
sdkerrors.ErrNotFound,
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure comprehensive testing around the new error handling logic, particularly for queries targeting pruned heights. This is essential to verify that the ErrNotFound error is returned as expected under various scenarios, including edge cases.

Would you like assistance in creating or enhancing tests to cover this new logic?

@gibson042 gibson042 force-pushed the gh-19992-pruned-height-error-code branch from b40e7af to 221bb9c Compare April 9, 2024 19:45
julienrbrt
julienrbrt approved these changes Apr 10, 2024
View reviewed changes
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.

ACK.

@tac0turtle tac0turtle added this pull request to the merge queue Apr 10, 2024
Merged via the queue into cosmos:main with commit 4c446f8 Apr 10, 2024
61 of 62 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tac0turtle tac0turtle tac0turtle approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

@likhita-809 likhita-809 likhita-809 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: Querying a pruned height returns a generic error code
4 participants
@gibson042 @tac0turtle @julienrbrt @likhita-809