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(store/v2): flaky TestDenomMetadata integration test. #23184

Merged
merged 3 commits into from
Jan 7, 2025

Conversation

TropicalDog17
Copy link
Contributor

@TropicalDog17 TropicalDog17 commented Jan 5, 2025

Description

Might closes #22736


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

  • Bug Fixes
    • Improved error handling for database iterator closing mechanism
    • Added safety check to prevent potential runtime errors when closing database iterators

Copy link
Contributor

coderabbitai bot commented Jan 5, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a modification to the Close method in the pebbleDBIterator struct within the store/v2/db/pebbledb.go file. The change adds a nil check to prevent potential runtime panics when attempting to close an iterator with a nil source. This enhancement improves error handling by ensuring that the method can safely handle cases where the iterator's source is not initialized.

Changes

File Change Summary
store/v2/db/pebbledb.go Added nil check in Close() method of pebbleDBIterator to prevent nil pointer dereference

Assessment against linked issues

Objective Addressed Explanation
Resolve flaky integration v2 test [#22736]

Suggested Labels

C:x/bank, C:server/v2

Suggested Reviewers

  • kocubinski
  • testinginprod
  • julienrbrt
  • tac0turtle

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 07d5168 and 7ee2b28.

📒 Files selected for processing (1)
  • store/v2/db/pebbledb.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
store/v2/db/pebbledb.go (1)

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

🔇 Additional comments (1)
store/v2/db/pebbledb.go (1)

231-233: Prevents nil pointer dereference and allows safe repeated calls to Close().

This check ensures that calling Close() on an iterator with a nil source won't lead to a panic, making the method more robust in scenarios where it might be invoked multiple times or after the underlying resource is already released.


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.

@TropicalDog17 TropicalDog17 changed the title fix(v2/bank): flaky TestDenomMetadata integration test. fix(v2/store): flaky TestDenomMetadata integration test. Jan 5, 2025
@TropicalDog17
Copy link
Contributor Author

/cc @julienrbrt

@julienrbrt julienrbrt changed the title fix(v2/store): flaky TestDenomMetadata integration test. fix(store/v2): flaky TestDenomMetadata integration test. Jan 6, 2025
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.

Calling close multiple times shouldn't panic that makes sense. However, should it error? cc @kocubinski

@tac0turtle tac0turtle enabled auto-merge January 7, 2025 10:38
@tac0turtle tac0turtle added this pull request to the merge queue Jan 7, 2025
Merged via the queue into cosmos:main with commit ead1b1c Jan 7, 2025
67 of 70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flaky integration v2 test
4 participants